Honeycode

This page documents function available when using the Honeycode module, created with @service Honeycode.

Index

Documentation

Main.Honeycode.batch_create_table_rowsMethod
batch_create_table_rows(rows_to_create, table_id, workbook_id)
batch_create_table_rows(rows_to_create, table_id, workbook_id, params::Dict{String,<:Any})

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.

Arguments

  • rows_to_create: The list of rows to create at the end of the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request and the cells to create for that row. You need to specify at least one item in this list. Note that if one of the column ids in any of the rows in the request does not exist in the table, then the request fails and no updates are made to the table.
  • table_id: The ID of the table where the new rows are being added. If a table with the specified ID could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook where the new rows are being added. If a workbook with the specified ID could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The request token for performing the batch create operation. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the operation again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Main.Honeycode.batch_delete_table_rowsMethod
batch_delete_table_rows(row_ids, table_id, workbook_id)
batch_delete_table_rows(row_ids, table_id, workbook_id, params::Dict{String,<:Any})

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.

Arguments

  • row_ids: The list of row ids to delete from the table. You need to specify at least one row id in this list. Note that if one of the row ids provided in the request does not exist in the table, then the request fails and no rows are deleted from the table.
  • table_id: The ID of the table where the rows are being deleted. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook where the rows are being deleted. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The request token for performing the delete action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Main.Honeycode.batch_update_table_rowsMethod
batch_update_table_rows(rows_to_update, table_id, workbook_id)
batch_update_table_rows(rows_to_update, table_id, workbook_id, params::Dict{String,<:Any})

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 ("").

Arguments

  • rows_to_update: The list of rows to update in the table. Each item in this list needs to contain the row id to update along with the map of column id to cell values for each column in that row that needs to be updated. You need to specify at least one row in this list, and for each row, you need to specify at least one column to update. Note that if one of the row or column ids in the request does not exist in the table, then the request fails and no updates are made to the table.
  • table_id: The ID of the table where the rows are being updated. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook where the rows are being updated. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Main.Honeycode.batch_upsert_table_rowsMethod
batch_upsert_table_rows(rows_to_upsert, table_id, workbook_id)
batch_upsert_table_rows(rows_to_upsert, table_id, workbook_id, params::Dict{String,<:Any})

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 ("").

Arguments

  • rows_to_upsert: The list of rows to upsert in the table. Each item in this list needs to have a batch item id to uniquely identify the element in the request, a filter expression to find the rows to update for that element and the cell values to set for each column in the upserted rows. You need to specify at least one item in this list. Note that if one of the filter formulas in the request fails to evaluate because of an error or one of the column ids in any of the rows does not exist in the table, then the request fails and no updates are made to the table.
  • table_id: The ID of the table where the rows are being upserted. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook where the rows are being upserted. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Main.Honeycode.describe_table_data_import_jobMethod
describe_table_data_import_job(job_id, table_id, workbook_id)
describe_table_data_import_job(job_id, table_id, workbook_id, params::Dict{String,<:Any})

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

Arguments

  • job_id: The ID of the job that was returned by the StartTableDataImportJob request. If a job with the specified id could not be found, this API throws ResourceNotFoundException.
  • table_id: The ID of the table into which data was imported. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook into which data was imported. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
Main.Honeycode.get_screen_dataMethod
get_screen_data(app_id, screen_id, workbook_id)
get_screen_data(app_id, screen_id, workbook_id, params::Dict{String,<:Any})

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.

Arguments

  • app_id: The ID of the app that contains the screen.
  • screen_id: The ID of the screen.
  • workbook_id: The ID of the workbook that contains the screen.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100. This parameter is optional. If you don't specify this parameter, the default page size is 100.
  • "nextToken": This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
  • "variables": Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.
Main.Honeycode.invoke_screen_automationMethod
invoke_screen_automation(app_id, automation_id, screen_id, workbook_id)
invoke_screen_automation(app_id, automation_id, screen_id, workbook_id, params::Dict{String,<:Any})

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.

Arguments

  • app_id: The ID of the app that contains the screen automation.
  • automation_id: The ID of the automation action to be performed.
  • screen_id: The ID of the screen that contains the screen automation.
  • workbook_id: The ID of the workbook that contains the screen automation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientRequestToken": The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
  • "rowId": The row ID for the automation if the automation is defined inside a block with source or list.
  • "variables": Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.
Main.Honeycode.list_table_columnsMethod
list_table_columns(table_id, workbook_id)
list_table_columns(table_id, workbook_id, params::Dict{String,<:Any})

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

Arguments

  • table_id: The ID of the table whose columns are being retrieved. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook that contains the table whose columns are being retrieved. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
Main.Honeycode.list_table_rowsMethod
list_table_rows(table_id, workbook_id)
list_table_rows(table_id, workbook_id, params::Dict{String,<:Any})

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

Arguments

  • table_id: The ID of the table whose rows are being retrieved. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook that contains the table whose rows are being retrieved. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of rows to return in each page of the results.
  • "nextToken": This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
  • "rowIds": This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
Main.Honeycode.list_tablesMethod
list_tables(workbook_id)
list_tables(workbook_id, params::Dict{String,<:Any})

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

Arguments

  • workbook_id: The ID of the workbook whose tables are being retrieved. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of tables to return in each page of the results.
  • "nextToken": This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
Main.Honeycode.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

The ListTagsForResource API allows you to return a resource's tags.

Arguments

  • resource_arn: The resource's Amazon Resource Name (ARN).
Main.Honeycode.query_table_rowsMethod
query_table_rows(filter_formula, table_id, workbook_id)
query_table_rows(filter_formula, table_id, workbook_id, params::Dict{String,<:Any})

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

Arguments

  • filter_formula: An object that represents a filter formula along with the id of the context row under which the filter function needs to evaluate.
  • table_id: The ID of the table whose rows are being queried. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook whose table rows are being queried. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of rows to return in each page of the results.
  • "nextToken": This parameter is optional. If a nextToken is not specified, the API returns the first page of data. Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
Main.Honeycode.start_table_data_import_jobMethod
start_table_data_import_job(client_request_token, data_format, data_source, import_options, table_id, workbook_id)
start_table_data_import_job(client_request_token, data_format, data_source, import_options, table_id, workbook_id, params::Dict{String,<:Any})

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.

Arguments

  • client_request_token: The request token for performing the update action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will not perform the action again. Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
  • data_format: The format of the data that is being imported. Currently the only option supported is "DELIMITED_TEXT".
  • data_source: The source of the data that is being imported. The size of source must be no larger than 100 MB. Source must have no more than 100,000 cells and no more than 1,000 rows.
  • import_options: The options for customizing this import request.
  • table_id: The ID of the table where the rows are being imported. If a table with the specified id could not be found, this API throws ResourceNotFoundException.
  • workbook_id: The ID of the workbook where the rows are being imported. If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
Main.Honeycode.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

Arguments

  • resource_arn: The resource's Amazon Resource Name (ARN).
  • tags: A list of tags to apply to the resource.
Main.Honeycode.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.

Arguments

  • resource_arn: The resource's Amazon Resource Name (ARN).
  • tag_keys: A list of tag keys to remove from the resource.