com.amazonaws.services.honeycode

Interface AmazonHoneycode

All Known Subinterfaces:

AmazonHoneycodeAsync

All Known Implementing Classes:

AbstractAmazonHoneycode, AbstractAmazonHoneycodeAsync, AmazonHoneycodeAsyncClient, AmazonHoneycodeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonHoneycode

Interface for accessing Honeycode.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonHoneycode instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchCreateTableRowsResult	batchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest) The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.
BatchDeleteTableRowsResult	batchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest) The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.
BatchUpdateTableRowsResult	batchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest) The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.
BatchUpsertTableRowsResult	batchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest) The BatchUpsertTableRows API allows you to upsert one or more rows in a table.
DescribeTableDataImportJobResult	describeTableDataImportJob(DescribeTableDataImportJobRequest describeTableDataImportJobRequest) The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetScreenDataResult	getScreenData(GetScreenDataRequest getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
InvokeScreenAutomationResult	invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
ListTableColumnsResult	listTableColumns(ListTableColumnsRequest listTableColumnsRequest) The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
ListTableRowsResult	listTableRows(ListTableRowsRequest listTableRowsRequest) The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
ListTablesResult	listTables(ListTablesRequest listTablesRequest) The ListTables API allows you to retrieve a list of all the tables in a workbook.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) The ListTagsForResource API allows you to return a resource's tags.
QueryTableRowsResult	queryTableRows(QueryTableRowsRequest queryTableRowsRequest) The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartTableDataImportJobResult	startTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest) The StartTableDataImportJob API allows you to start an import job on a table.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) The TagResource API allows you to add tags to an ARN-able resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) The UntagResource API allows you to removes tags from an ARN-able resource.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchCreateTableRows

BatchCreateTableRowsResult batchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest)

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.

Parameters:

batchCreateTableRowsRequest -

Returns:

Result of the BatchCreateTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceQuotaExceededException - The request caused service quota to be breached.

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

batchDeleteTableRows

BatchDeleteTableRowsResult batchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest)

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.

Parameters:

batchDeleteTableRowsRequest -

Returns:

Result of the BatchDeleteTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

ServiceUnavailableException - Remote service is unreachable.

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

RequestTimeoutException - The request timed out.

ThrottlingException - Tps(transactions per second) rate reached.

See Also:

AWS API Documentation

batchUpdateTableRows

BatchUpdateTableRowsResult batchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest)

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

Parameters:

batchUpdateTableRowsRequest -

Returns:

Result of the BatchUpdateTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

ServiceUnavailableException - Remote service is unreachable.

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

RequestTimeoutException - The request timed out.

ThrottlingException - Tps(transactions per second) rate reached.

See Also:

AWS API Documentation

batchUpsertTableRows

BatchUpsertTableRowsResult batchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest)

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

Parameters:

batchUpsertTableRowsRequest -

Returns:

Result of the BatchUpsertTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceQuotaExceededException - The request caused service quota to be breached.

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

describeTableDataImportJob

DescribeTableDataImportJobResult describeTableDataImportJob(DescribeTableDataImportJobRequest describeTableDataImportJobRequest)

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

Parameters:

describeTableDataImportJobRequest -

Returns:

Result of the DescribeTableDataImportJob operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

RequestTimeoutException - The request timed out.

See Also:

AWS API Documentation

getScreenData

GetScreenDataResult getScreenData(GetScreenDataRequest getScreenDataRequest)

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.

Parameters:

getScreenDataRequest -

Returns:

Result of the GetScreenData operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

invokeScreenAutomation

InvokeScreenAutomationResult invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest)

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.

Parameters:

invokeScreenAutomationRequest -

Returns:

Result of the InvokeScreenAutomation operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

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

ThrottlingException - Tps(transactions per second) rate reached.

ServiceUnavailableException - Remote service is unreachable.

AutomationExecutionException - The automation execution did not end successfully.

AutomationExecutionTimeoutException - The automation execution timed out.

RequestTimeoutException - The request timed out.

ServiceQuotaExceededException - The request caused service quota to be breached.

See Also:

AWS API Documentation

listTableColumns

ListTableColumnsResult listTableColumns(ListTableColumnsRequest listTableColumnsRequest)

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

Parameters:

listTableColumnsRequest -

Returns:

Result of the ListTableColumns operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

listTableRows

ListTableRowsResult listTableRows(ListTableRowsRequest listTableRowsRequest)

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

Parameters:

listTableRowsRequest -

Returns:

Result of the ListTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

ServiceUnavailableException - Remote service is unreachable.

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

RequestTimeoutException - The request timed out.

ThrottlingException - Tps(transactions per second) rate reached.

See Also:

AWS API Documentation

listTables

ListTablesResult listTables(ListTablesRequest listTablesRequest)

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

Parameters:

listTablesRequest -

Returns:

Result of the ListTables operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

queryTableRows

QueryTableRowsResult queryTableRows(QueryTableRowsRequest queryTableRowsRequest)

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

Parameters:

queryTableRowsRequest -

Returns:

Result of the QueryTableRows operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

startTableDataImportJob

StartTableDataImportJobResult startTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest)

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.

Parameters:

startTableDataImportJobRequest -

Returns:

Result of the StartTableDataImportJob operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

RequestTimeoutException - The request timed out.

ServiceQuotaExceededException - The request caused service quota to be breached.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

AccessDeniedException - 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.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

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

ServiceUnavailableException - Remote service is unreachable.

ThrottlingException - Tps(transactions per second) rate reached.

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

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.