com.amazonaws.services.honeycode

Class AmazonHoneycodeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.honeycode.AmazonHoneycodeClient

All Implemented Interfaces:

AmazonHoneycode

Direct Known Subclasses:

AmazonHoneycodeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonHoneycodeClient
extends AmazonWebServiceClient
implements AmazonHoneycode

Client for accessing Honeycode. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.honeycode.AmazonHoneycode

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchCreateTableRowsResult	batchCreateTableRows(BatchCreateTableRowsRequest request) The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.
BatchDeleteTableRowsResult	batchDeleteTableRows(BatchDeleteTableRowsRequest request) The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.
BatchUpdateTableRowsResult	batchUpdateTableRows(BatchUpdateTableRowsRequest request) The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.
BatchUpsertTableRowsResult	batchUpsertTableRows(BatchUpsertTableRowsRequest request) The BatchUpsertTableRows API allows you to upsert one or more rows in a table.
static AmazonHoneycodeClientBuilder	builder()
DescribeTableDataImportJobResult	describeTableDataImportJob(DescribeTableDataImportJobRequest request) 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 request) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
InvokeScreenAutomationResult	invokeScreenAutomation(InvokeScreenAutomationRequest request) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
ListTableColumnsResult	listTableColumns(ListTableColumnsRequest request) The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
ListTableRowsResult	listTableRows(ListTableRowsRequest request) The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
ListTablesResult	listTables(ListTablesRequest request) The ListTables API allows you to retrieve a list of all the tables in a workbook.
QueryTableRowsResult	queryTableRows(QueryTableRowsRequest request) 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 request) The StartTableDataImportJob API allows you to start an import job on a table.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonHoneycodeClientBuilder builder()

batchCreateTableRows

public BatchCreateTableRowsResult batchCreateTableRows(BatchCreateTableRowsRequest request)

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.

Specified by:

batchCreateTableRows in interface AmazonHoneycode

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

public BatchDeleteTableRowsResult batchDeleteTableRows(BatchDeleteTableRowsRequest request)

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.

Specified by:

batchDeleteTableRows in interface AmazonHoneycode

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

public BatchUpdateTableRowsResult batchUpdateTableRows(BatchUpdateTableRowsRequest request)

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

Specified by:

batchUpdateTableRows in interface AmazonHoneycode

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

public BatchUpsertTableRowsResult batchUpsertTableRows(BatchUpsertTableRowsRequest request)

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

Specified by:

batchUpsertTableRows in interface AmazonHoneycode

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

public DescribeTableDataImportJobResult describeTableDataImportJob(DescribeTableDataImportJobRequest request)

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

Specified by:

describeTableDataImportJob in interface AmazonHoneycode

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.

See Also:

AWS API Documentation

getScreenData

public GetScreenDataResult getScreenData(GetScreenDataRequest request)

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.

Specified by:

getScreenData in interface AmazonHoneycode

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

public InvokeScreenAutomationResult invokeScreenAutomation(InvokeScreenAutomationRequest request)

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.

Specified by:

invokeScreenAutomation in interface AmazonHoneycode

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.

See Also:

AWS API Documentation

listTableColumns

public ListTableColumnsResult listTableColumns(ListTableColumnsRequest request)

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

Specified by:

listTableColumns in interface AmazonHoneycode

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

public ListTableRowsResult listTableRows(ListTableRowsRequest request)

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

Specified by:

listTableRows in interface AmazonHoneycode

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

public ListTablesResult listTables(ListTablesRequest request)

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

Specified by:

listTables in interface AmazonHoneycode

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

queryTableRows

public QueryTableRowsResult queryTableRows(QueryTableRowsRequest request)

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

Specified by:

queryTableRows in interface AmazonHoneycode

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

public StartTableDataImportJobResult startTableDataImportJob(StartTableDataImportJobRequest request)

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.

Specified by:

startTableDataImportJob in interface AmazonHoneycode

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonHoneycode

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonHoneycode

Overrides:

shutdown in class AmazonWebServiceClient