AWS.Honeycode (aws-elixir v0.8.0) View Source

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming.

Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

Link to this section Summary

Functions

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

The BatchUpsertTableRows API allows you to upsert one or more rows in a table.

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

The GetScreenData API allows retrieval of data from a screen in a Honeycode app.

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

The ListTables API allows you to retrieve a list of all the tables in a workbook.

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

The StartTableDataImportJob API allows you to start an import job on a table.

Link to this section Functions

Link to this function

batch_create_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.

The API allows you to specify the values to set in some or all of the columns in the new rows.

If a column is not explicitly set in a specific row, then the column level formula specified in the table will be applied to the new row. If there is no column level formula but the last row of the table has a formula, then that formula will be copied down to the new row. If there is no column level formula and no formula in the last row of the table, then that column will be left blank for the new rows.

Link to this function

batch_delete_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.

You need to specify the ids of the rows that you want to delete from the table.

Link to this function

batch_update_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.

You can specify the values to set in some or all of the columns in the table for the specified rows. If a column is not explicitly specified in a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Link to this function

batch_upsert_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The BatchUpsertTableRows API allows you to upsert one or more rows in a table.

The upsert operation takes a filter expression as input and evaluates it to find matching rows on the destination table. If matching rows are found, it will update the cells in the matching rows to new values specified in the request. If no matching rows are found, a new row is added at the end of the table and the cells in that row are set to the new values specified in the request.

You can specify the values to set in some or all of the columns in the table for the matching or newly appended rows. If a column is not explicitly specified for a particular row, then that column will not be updated for that row. To clear out the data in a specific cell, you need to set the value as an empty string ("").

Link to this function

describe_table_data_import_job(client, job_id, table_id, workbook_id, options \\ [])

View Source

The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.

Link to this function

get_screen_data(client, input, options \\ [])

View Source

The GetScreenData API allows retrieval of data from a screen in a Honeycode app.

The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

Link to this function

invoke_screen_automation(client, app_id, screen_automation_id, screen_id, workbook_id, input, options \\ [])

View Source

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.

The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

Link to this function

list_table_columns(client, table_id, workbook_id, next_token \\ nil, options \\ [])

View Source

The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.

Link to this function

list_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.

Link to this function

list_tables(client, workbook_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

The ListTables API allows you to retrieve a list of all the tables in a workbook.

Link to this function

query_table_rows(client, table_id, workbook_id, input, options \\ [])

View Source

The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.

Link to this function

start_table_data_import_job(client, destination_table_id, workbook_id, input, options \\ [])

View Source

The StartTableDataImportJob API allows you to start an import job on a table.

This API will only return the id of the job that was started. To find out the status of the import request, you need to call the DescribeTableDataImportJob API.