API version 2020-03-01 of the Amazon Honeycode SDK configuration.

Request is invalid. The message in the response contains details on why the request is invalid.

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the resource in the request.

The automation execution timed out.

The request caused service quota to be breached.

Tps(transactions per second) rate reached.

The automation execution did not end successfully.

The request timed out.

There were unexpected errors from the server.

Remote service is unreachable.

A Workbook, Table, App, Screen or Screen Automation was not found with the given ID.

An object that represents a single cell in a table.

See: newCell smart constructor.

Create a value of Cell with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rawValue:Cell', cell_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 "john.smith@example.com" 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 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.

$sel:format:Cell', cell_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.

$sel:formula:Cell', cell_formula - The formula contained in the cell. This field is empty if a cell does not have a formula.

$sel:formattedValue:Cell', cell_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.

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 "john.smith@example.com" 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 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.

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.

The formula contained in the cell. This field is empty if a cell does not have a formula.

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.

CellInput object contains the data needed to create or update cells in a table.

See: newCellInput smart constructor.

Create a value of CellInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:fact:CellInput', cellInput_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.

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.

Metadata for column in the table.

See: newColumnMetadata smart constructor.

Create a value of ColumnMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:ColumnMetadata', columnMetadata_name - The name of the column.

$sel:format:ColumnMetadata', columnMetadata_format - The format of the column.

The name of the column.

The format of the column.

Data needed to create a single row in a table as part of the BatchCreateTableRows request.

See: newCreateRowData smart constructor.

Create a value of CreateRowData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchItemId:CreateRowData', createRowData_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.

$sel:cellsToCreate:CreateRowData', createRowData_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.

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.

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.

The data in a particular data cell defined on the screen.

See: newDataItem smart constructor.

Create a value of DataItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rawValue:DataItem', dataItem_rawValue - The raw value of the data. e.g. jsmith@example.com

$sel:overrideFormat:DataItem', dataItem_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.

$sel:formattedValue:DataItem', dataItem_formattedValue - The formatted value of the data. e.g. John Smith.

The raw value of the data. e.g. jsmith@example.com

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.

The formatted value of the data. e.g. John Smith.

An object that contains the options relating to parsing delimited text as part of an import request.

See: newDelimitedTextImportOptions smart constructor.

Create a value of DelimitedTextImportOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ignoreEmptyRows:DelimitedTextImportOptions', delimitedTextImportOptions_ignoreEmptyRows - A parameter to indicate whether empty rows should be ignored or be included in the import.

$sel:hasHeaderRow:DelimitedTextImportOptions', delimitedTextImportOptions_hasHeaderRow - Indicates whether the input file has a header row at the top containing the column names.

$sel:dataCharacterEncoding:DelimitedTextImportOptions', delimitedTextImportOptions_dataCharacterEncoding - The encoding of the data in the input file.

$sel:delimiter:DelimitedTextImportOptions', delimitedTextImportOptions_delimiter - The delimiter to use for separating columns in a single row of the input.

A parameter to indicate whether empty rows should be ignored or be included in the import.

Indicates whether the input file has a header row at the top containing the column names.

The encoding of the data in the input file.

The delimiter to use for separating columns in a single row of the input.

An object that contains the options relating to the destination of the import request.

See: newDestinationOptions smart constructor.

Create a value of DestinationOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:columnMap:DestinationOptions', destinationOptions_columnMap - A map of the column id to the import properties for each column.

A map of the column id to the import properties for each column.

A single item in a batch that failed to perform the intended action because of an error preventing it from succeeding.

See: newFailedBatchItem smart constructor.

Create a value of FailedBatchItem with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:FailedBatchItem', failedBatchItem_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.

$sel:errorMessage:FailedBatchItem', failedBatchItem_errorMessage - The error message that indicates why the batch item failed.

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.

The error message that indicates why the batch item failed.

An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.

See: newFilter smart constructor.

Create a value of Filter with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contextRowId:Filter', filter_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.

$sel:formula:Filter', filter_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.

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.

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.

An object that has details about the source of the data that was submitted for import.

See: newImportDataSource smart constructor.