The Amazon Honeycode API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• Cell (p. 58)
• CellInput (p. 61)
• ColumnMetadata (p. 62)
• CreateRowData (p. 63)
• DataItem (p. 64)
• DelimitedTextImportOptions (p. 65)
• DestinationOptions (p. 66)
• FailedBatchItem (p. 67)
• Filter (p. 68)
• ImportDataSource (p. 69)
• ImportDataSourceConfig (p. 70)
• ImportJobSubmitter (p. 71)
• ImportOptions (p. 72)
• ResultRow (p. 73)
• ResultSet (p. 74)
• SourceDataColumnProperties (p. 75)
• Table (p. 76)
• TableColumn (p. 77)
• TableDataImportJobMetadata (p. 78)
• TableRow (p. 79)
• UpdateRowData (p. 80)
• UpsertRowData (p. 81)
• UpsertRowsResult (p. 83)
• VariableValue (p. 84)
Cell
Cell
An object that represents a single cell in a table.
Contents
format
The format of the cell. If this field is empty, then the format is either not specified in the workbook or the format is set to AUTO.
Type: String
Valid Values: AUTO | NUMBER | CURRENCY | DATE | TIME | DATE_TIME | PERCENTAGE | TEXT | ACCOUNTING | CONTACT | ROWLINK | ROWSET
Required: No formattedValue
The formatted value of the cell. This is the value that you see displayed in the cell in the UI.
Note that the formatted value of a cell is always represented as a string irrespective of the data that is stored in the cell. For example, if a cell contains a date, the formatted value of the cell is the string representation of the formatted date being shown in the cell in the UI. See details in the rawValue field below for how cells of different formats will have different raw and formatted values.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: [\s\S]*
Required: No formattedValues
A list of formatted values of the cell. This field is only returned when the cell is ROWSET format (aka multi-select or multi-record picklist). Values in the list are always represented as strings. The formattedValue field will be empty if this field is returned.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 220 items.
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: [\s\S]*
Required: No formula
The formula contained in the cell. This field is empty if a cell does not have a formula.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: ^=.*
Contents
Required: No rawValue
The raw value of the data contained in the cell. The raw value depends on the format of the data in the cell. However the attribute in the API return value is always a string containing the raw value.
Cells with format DATE, DATE_TIME or TIME have the raw value as a floating point number where the whole number represents the number of days since 1/1/1900 and the fractional part represents the fraction of the day since midnight. For example, a cell with date 11/3/2020 has the raw value
"44138". A cell with the time 9:00 AM has the raw value "0.375" and a cell with date/time value of 11/3/2020 9:00 AM has the raw value "44138.375". Notice that even though the raw value is a number in all three cases, it is still represented as a string.
Cells with format NUMBER, CURRENCY, PERCENTAGE and ACCOUNTING have the raw value of the data as the number representing the data being displayed. For example, the number 1.325 with two decimal places in the format will have it's raw value as "1.325" and formatted value as "1.33".
A currency value for $10 will have the raw value as "10" and formatted value as "$10.00". A value representing 20% with two decimal places in the format will have its raw value as "0.2" and the formatted value as "20.00%". An accounting value of -$25 will have "-25" as the raw value and "$
(25.00)" as the formatted value.
Cells with format TEXT will have the raw text as the raw value. For example, a cell with text "John Smith" will have "John Smith" as both the raw value and the formatted value.
Cells with format CONTACT will have the name of the contact as a formatted value and the email address of the contact as the raw value. For example, a contact for John Smith will have "John Smith" as the formatted value and "[email protected]" as the raw value.
Cells with format ROWLINK (aka picklist) will have the first column of the linked row as the formatted value and the row id of the linked row as the raw value. For example, a cell containing a picklist to a table that displays task status might have "Completed" as the formatted value and
"row:dfcefaee-5b37-4355-8f28-40c3e4ff5dd4/ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
Cells with format ROWSET (aka multi-select or multi-record picklist) will by default have the first column of each of the linked rows as the formatted value in the list, and the rowset id of the linked rows as the raw value. For example, a cell containing a multi-select picklist to a table that contains items might have "Item A", "Item B" in the formatted value list and "rows:b742c1f4-6cb0-4650-a845-35eb86fcc2bb/ [fdea123b-8f68-474a-aa8a-5ff87aa333af,6daf41f0-a138-4eee-89da-123086d36ecf]" as the raw value.
Cells with format ATTACHMENT will have the name of the attachment as the formatted value and the attachment id as the raw value. For example, a cell containing an attachment named "image.jpeg" will have "image.jpeg" as the formatted value and "attachment:ca432b2f-b8eb-431d-9fb5-cbe0342f9f03" as the raw value.
Cells with format AUTO or cells without any format that are auto-detected as one of the formats above will contain the raw and formatted values as mentioned above, based on the auto-detected formats. If there is no auto-detected format, the raw and formatted values will be the same as the data in the cell.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 32767.
Pattern: [\s\S]*
Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CellInput
CellInput
CellInput object contains the data needed to create or update cells in a table.
NoteCellInput object has only a facts field or a fact field, but not both. A 400 bad request will be thrown if both fact and facts field are present.
Contents
fact
Fact represents the data that is entered into a cell. This data can be free text or a formula. Formulas need to start with the equals (=) sign.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: [\s\S]*
Required: No facts
A list representing the values that are entered into a ROWSET cell. Facts list can have either only values or rowIDs, and rowIDs should from the same table.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 220 items.
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: [\s\S]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ColumnMetadata
ColumnMetadata
Metadata for column in the table.
Contents
format
The format of the column.
Type: String
Valid Values: AUTO | NUMBER | CURRENCY | DATE | TIME | DATE_TIME | PERCENTAGE | TEXT | ACCOUNTING | CONTACT | ROWLINK | ROWSET
Required: Yes name
The name of the column.
Type: String Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CreateRowData
CreateRowData
Data needed to create a single row in a table as part of the BatchCreateTableRows request.
Contents
batchItemId
An external identifier that represents the single row that is being created as part of the
BatchCreateTableRows request. This can be any string that you can use to identify the row in the request. The BatchCreateTableRows API puts the batch item id in the results to allow you to link data in the request to data in the results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^(?!\s*$).+
Required: Yes cellsToCreate
A map representing the cells to create in the new row. The key is the column id of the cell and the value is the CellInput object that represents the data to set in that cell.
Type: String to CellInput (p. 61) object map Map Entries: Maximum number of 100 items.
Key Length Constraints: Fixed length of 36.
Key Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DataItem
DataItem
The data in a particular data cell defined on the screen.
Contents
formattedValue
The formatted value of the data. e.g. John Smith.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: [\s\S]*
Required: No overrideFormat
The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table.
Type: String
Valid Values: AUTO | NUMBER | CURRENCY | DATE | TIME | DATE_TIME | PERCENTAGE | TEXT | ACCOUNTING | CONTACT | ROWLINK | ROWSET
Required: No rawValue
The raw value of the data. e.g. [email protected] Type: String
Length Constraints: Minimum length of 0. Maximum length of 32767.
Pattern: [\s\S]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DelimitedTextImportOptions
DelimitedTextImportOptions
An object that contains the options relating to parsing delimited text as part of an import request.
Contents
dataCharacterEncoding
The encoding of the data in the input file.
Type: String
Valid Values: UTF-8 | US-ASCII | ISO-8859-1 | UTF-16BE | UTF-16LE | UTF-16 Required: No
delimiter
The delimiter to use for separating columns in a single row of the input.
Type: String
Length Constraints: Fixed length of 1.
Pattern: ^[^\n\r\x00\x08\x0B\x0C\x0E\x1F]?$
Required: Yes hasHeaderRow
Indicates whether the input file has a header row at the top containing the column names.
Type: Boolean Required: No ignoreEmptyRows
A parameter to indicate whether empty rows should be ignored or be included in the import.
Type: Boolean Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DestinationOptions
DestinationOptions
An object that contains the options relating to the destination of the import request.
Contents
columnMap
A map of the column id to the import properties for each column.
Type: String to SourceDataColumnProperties (p. 75) object map Map Entries: Maximum number of 100 items.
Key Length Constraints: Fixed length of 36.
Key Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FailedBatchItem
FailedBatchItem
A single item in a batch that failed to perform the intended action because of an error preventing it from succeeding.
Contents
errorMessage
The error message that indicates why the batch item failed.
Type: String
Pattern: ^(?!\s*$).+
Required: Yes id
The id of the batch item that failed. This is the batch item id for the BatchCreateTableRows and BatchUpsertTableRows operations and the row id for the BatchUpdateTableRows and BatchDeleteTableRows operations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: ^(?!\s*$).+
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Filter
Filter
An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.
Contents
contextRowId
The optional contextRowId attribute can be used to specify the row id of the context row if the filter formula contains unqualified references to table columns and needs a context row to evaluate them successfully.
Type: String
Length Constraints: Fixed length of 77.
Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]{12}
Required: No formula
A formula representing a filter function that returns zero or more matching rows from a table. Valid formulas in this field return a list of rows from a table. The most common ways of writing a formula to return a list of rows are to use the FindRow() or Filter() functions. Any other formula that returns zero or more rows is also acceptable. For example, you can use a formula that points to a cell that contains a filter function.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern: ^=.*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ImportDataSource
ImportDataSource
An object that has details about the source of the data that was submitted for import.
Contents
dataSourceConfig
The configuration parameters for the data source of the import Type: ImportDataSourceConfig (p. 70) object
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ImportDataSourceConfig
ImportDataSourceConfig
An object that contains the configuration parameters for the data source of an import request.
Contents
dataSourceUrl
The URL from which source data will be downloaded for the import request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 8000.
Pattern: ^https:\/\/[^\n\r\x00\x08\x0B\x0C\x0E\x1F]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ImportJobSubmitter
ImportJobSubmitter
An object that contains the attributes of the submitter of the import job.
Contents
The email id of the submitter of the import job, if available.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 254.
Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
Required: No userArn
The AWS user ARN of the submitter of the import job, if available.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ImportOptions
ImportOptions
An object that contains the options specified by the sumitter of the import request.
Contents
delimitedTextOptions
Options relating to parsing delimited text. Required if dataFormat is DELIMITED_TEXT.
Type: DelimitedTextImportOptions (p. 65) object Required: No
destinationOptions
Options relating to the destination of the import request.
Type: DestinationOptions (p. 66) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResultRow
ResultRow
A single row in the ResultSet.
Contents
dataItems
List of all the data cells in a row.
Type: Array of DataItem (p. 64) objects Required: Yes
rowId
The ID for a particular row.
Type: String
Length Constraints: Fixed length of 77.
Pattern: row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]{12}
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResultSet
ResultSet
ResultSet contains the results of the request for a single block or list defined on the screen.
Contents
headers
List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.
For example, a task list that displays the task name, due date and assigned person might have headers [ { "name": "Task Name"}, {"name": "Due Date", "format": "DATE"}, {"name": "Assigned",
"format": "CONTACT"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.
Type: Array of ColumnMetadata (p. 62) objects Required: Yes
rows
List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.
Type: Array of ResultRow (p. 73) objects Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SourceDataColumnProperties
SourceDataColumnProperties
An object that contains the properties for importing data to a specific column in a table.
Contents
columnIndex
The index of the column in the input file.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Table
Table
An object representing the properties of a table in a workbook.
Contents
tableId
The id of the table.
Type: String
Length Constraints: Fixed length of 36.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Required: No tableName
The name of the table.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TableColumn
TableColumn
An object that contains attributes about a single column in a table
Contents
format
The column level format that is applied in the table. An empty value in this field means that the column format is the default value 'AUTO'.
Type: String
Valid Values: AUTO | NUMBER | CURRENCY | DATE | TIME | DATE_TIME | PERCENTAGE | TEXT | ACCOUNTING | CONTACT | ROWLINK | ROWSET
Required: No tableColumnId
The id of the column in the table.
Type: String
Length Constraints: Fixed length of 36.
Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Required: No tableColumnName
The name of the column in the table.
Type: String Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
TableDataImportJobMetadata
TableDataImportJobMetadata
The metadata associated with the table data import job that was submitted.
Contents
dataSource
The source of the data that was submitted for import.
Type: ImportDataSource (p. 69) object Required: Yes
importOptions
The options that was specified at the time of submitting the import request.
Type: ImportOptions (p. 72) object Required: Yes
submitter
Details about the submitter of the import request.
Type: ImportJobSubmitter (p. 71) object Required: Yes
submitTime
The timestamp when the job was submitted for import.
Type: Timestamp Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
For more information about using this API in one of the language-specific AWS SDKs, see the following: