Interface HoneycodeClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface HoneycodeClient extends AwsClient
Service client for accessing Honeycode. This can be created using the staticbuilder()method.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 Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default BatchCreateTableRowsResponsebatchCreateTableRows(Consumer<BatchCreateTableRowsRequest.Builder> batchCreateTableRowsRequest)The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.default BatchCreateTableRowsResponsebatchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest)The BatchCreateTableRows API allows you to create one or more rows at the end of a table in a workbook.default BatchDeleteTableRowsResponsebatchDeleteTableRows(Consumer<BatchDeleteTableRowsRequest.Builder> batchDeleteTableRowsRequest)The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.default BatchDeleteTableRowsResponsebatchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest)The BatchDeleteTableRows API allows you to delete one or more rows from a table in a workbook.default BatchUpdateTableRowsResponsebatchUpdateTableRows(Consumer<BatchUpdateTableRowsRequest.Builder> batchUpdateTableRowsRequest)The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.default BatchUpdateTableRowsResponsebatchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest)The BatchUpdateTableRows API allows you to update one or more rows in a table in a workbook.default BatchUpsertTableRowsResponsebatchUpsertTableRows(Consumer<BatchUpsertTableRowsRequest.Builder> batchUpsertTableRowsRequest)The BatchUpsertTableRows API allows you to upsert one or more rows in a table.default BatchUpsertTableRowsResponsebatchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest)The BatchUpsertTableRows API allows you to upsert one or more rows in a table.static HoneycodeClientBuilderbuilder()Create a builder that can be used to configure and create aHoneycodeClient.static HoneycodeClientcreate()Create aHoneycodeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DescribeTableDataImportJobResponsedescribeTableDataImportJob(Consumer<DescribeTableDataImportJobRequest.Builder> describeTableDataImportJobRequest)The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.default DescribeTableDataImportJobResponsedescribeTableDataImportJob(DescribeTableDataImportJobRequest describeTableDataImportJobRequest)The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.default GetScreenDataResponsegetScreenData(Consumer<GetScreenDataRequest.Builder> getScreenDataRequest)The GetScreenData API allows retrieval of data from a screen in a Honeycode app.default GetScreenDataResponsegetScreenData(GetScreenDataRequest getScreenDataRequest)The GetScreenData API allows retrieval of data from a screen in a Honeycode app.default InvokeScreenAutomationResponseinvokeScreenAutomation(Consumer<InvokeScreenAutomationRequest.Builder> invokeScreenAutomationRequest)The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.default InvokeScreenAutomationResponseinvokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest)The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.default ListTableColumnsResponselistTableColumns(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest)The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.default ListTableColumnsResponselistTableColumns(ListTableColumnsRequest listTableColumnsRequest)The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.default ListTableColumnsIterablelistTableColumnsPaginator(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest)This is a variant oflistTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation.default ListTableColumnsIterablelistTableColumnsPaginator(ListTableColumnsRequest listTableColumnsRequest)This is a variant oflistTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation.default ListTableRowsResponselistTableRows(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest)The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.default ListTableRowsResponselistTableRows(ListTableRowsRequest listTableRowsRequest)The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.default ListTableRowsIterablelistTableRowsPaginator(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest)This is a variant oflistTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation.default ListTableRowsIterablelistTableRowsPaginator(ListTableRowsRequest listTableRowsRequest)This is a variant oflistTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation.default ListTablesResponselistTables(Consumer<ListTablesRequest.Builder> listTablesRequest)The ListTables API allows you to retrieve a list of all the tables in a workbook.default ListTablesResponselistTables(ListTablesRequest listTablesRequest)The ListTables API allows you to retrieve a list of all the tables in a workbook.default ListTablesIterablelistTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)This is a variant oflistTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation.default ListTablesIterablelistTablesPaginator(ListTablesRequest listTablesRequest)This is a variant oflistTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)The ListTagsForResource API allows you to return a resource's tags.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)The ListTagsForResource API allows you to return a resource's tags.default QueryTableRowsResponsequeryTableRows(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest)The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.default QueryTableRowsResponsequeryTableRows(QueryTableRowsRequest queryTableRowsRequest)The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.default QueryTableRowsIterablequeryTableRowsPaginator(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest)This is a variant ofqueryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation.default QueryTableRowsIterablequeryTableRowsPaginator(QueryTableRowsRequest queryTableRowsRequest)This is a variant ofqueryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation.default HoneycodeServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartTableDataImportJobResponsestartTableDataImportJob(Consumer<StartTableDataImportJobRequest.Builder> startTableDataImportJobRequest)The StartTableDataImportJob API allows you to start an import job on a table.default StartTableDataImportJobResponsestartTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest)The StartTableDataImportJob API allows you to start an import job on a table.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)The TagResource API allows you to add tags to an ARN-able resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)The TagResource API allows you to add tags to an ARN-able resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)The UntagResource API allows you to removes tags from an ARN-able resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)The UntagResource API allows you to removes tags from an ARN-able resource.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchCreateTableRows
default BatchCreateTableRowsResponse batchCreateTableRows(BatchCreateTableRowsRequest batchCreateTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchCreateTableRows
default BatchCreateTableRowsResponse batchCreateTableRows(Consumer<BatchCreateTableRowsRequest.Builder> batchCreateTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.
This is a convenience which creates an instance of the
BatchCreateTableRowsRequest.Builderavoiding the need to create one manually viaBatchCreateTableRowsRequest.builder()- Parameters:
batchCreateTableRowsRequest- AConsumerthat will call methods onBatchCreateTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteTableRows
default BatchDeleteTableRowsResponse batchDeleteTableRows(BatchDeleteTableRowsRequest batchDeleteTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteTableRows
default BatchDeleteTableRowsResponse batchDeleteTableRows(Consumer<BatchDeleteTableRowsRequest.Builder> batchDeleteTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
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.
This is a convenience which creates an instance of the
BatchDeleteTableRowsRequest.Builderavoiding the need to create one manually viaBatchDeleteTableRowsRequest.builder()- Parameters:
batchDeleteTableRowsRequest- AConsumerthat will call methods onBatchDeleteTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpdateTableRows
default BatchUpdateTableRowsResponse batchUpdateTableRows(BatchUpdateTableRowsRequest batchUpdateTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpdateTableRows
default BatchUpdateTableRowsResponse batchUpdateTableRows(Consumer<BatchUpdateTableRowsRequest.Builder> batchUpdateTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
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 ("").
This is a convenience which creates an instance of the
BatchUpdateTableRowsRequest.Builderavoiding the need to create one manually viaBatchUpdateTableRowsRequest.builder()- Parameters:
batchUpdateTableRowsRequest- AConsumerthat will call methods onBatchUpdateTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpsertTableRows
default BatchUpsertTableRowsResponse batchUpsertTableRows(BatchUpsertTableRowsRequest batchUpsertTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchUpsertTableRows
default BatchUpsertTableRowsResponse batchUpsertTableRows(Consumer<BatchUpsertTableRowsRequest.Builder> batchUpsertTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceQuotaExceededException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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 ("").
This is a convenience which creates an instance of the
BatchUpsertTableRowsRequest.Builderavoiding the need to create one manually viaBatchUpsertTableRowsRequest.builder()- Parameters:
batchUpsertTableRowsRequest- AConsumerthat will call methods onBatchUpsertTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTableDataImportJob
default DescribeTableDataImportJobResponse describeTableDataImportJob(DescribeTableDataImportJobRequest describeTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTableDataImportJob
default DescribeTableDataImportJobResponse describeTableDataImportJob(Consumer<DescribeTableDataImportJobRequest.Builder> describeTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, AwsServiceException, SdkClientException, HoneycodeException
The DescribeTableDataImportJob API allows you to retrieve the status and details of a table data import job.
This is a convenience which creates an instance of the
DescribeTableDataImportJobRequest.Builderavoiding the need to create one manually viaDescribeTableDataImportJobRequest.builder()- Parameters:
describeTableDataImportJobRequest- AConsumerthat will call methods onDescribeTableDataImportJobRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getScreenData
default GetScreenDataResponse getScreenData(GetScreenDataRequest getScreenDataRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getScreenData
default GetScreenDataResponse getScreenData(Consumer<GetScreenDataRequest.Builder> getScreenDataRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.
This is a convenience which creates an instance of the
GetScreenDataRequest.Builderavoiding the need to create one manually viaGetScreenDataRequest.builder()- Parameters:
getScreenDataRequest- AConsumerthat will call methods onGetScreenDataRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
invokeScreenAutomation
default InvokeScreenAutomationResponse invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
invokeScreenAutomation
default InvokeScreenAutomationResponse invokeScreenAutomation(Consumer<InvokeScreenAutomationRequest.Builder> invokeScreenAutomationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ValidationException, ThrottlingException, ServiceUnavailableException, AutomationExecutionException, AutomationExecutionTimeoutException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException
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.
This is a convenience which creates an instance of the
InvokeScreenAutomationRequest.Builderavoiding the need to create one manually viaInvokeScreenAutomationRequest.builder()- Parameters:
invokeScreenAutomationRequest- AConsumerthat will call methods onInvokeScreenAutomationRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableColumns
default ListTableColumnsResponse listTableColumns(ListTableColumnsRequest listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableColumns
default ListTableColumnsResponse listTableColumns(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The ListTableColumns API allows you to retrieve a list of all the columns in a table in a workbook.
This is a convenience which creates an instance of the
ListTableColumnsRequest.Builderavoiding the need to create one manually viaListTableColumnsRequest.builder()- Parameters:
listTableColumnsRequest- AConsumerthat will call methods onListTableColumnsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableColumnsPaginator
default ListTableColumnsIterable listTableColumnsPaginator(ListTableColumnsRequest listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client .listTableColumnsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableColumnsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation.- Parameters:
listTableColumnsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableColumnsPaginator
default ListTableColumnsIterable listTableColumnsPaginator(Consumer<ListTableColumnsRequest.Builder> listTableColumnsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client .listTableColumnsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableColumnsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableColumnsIterable responses = client.listTableColumnsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableColumns(software.amazon.awssdk.services.honeycode.model.ListTableColumnsRequest)operation.
This is a convenience which creates an instance of the
ListTableColumnsRequest.Builderavoiding the need to create one manually viaListTableColumnsRequest.builder()- Parameters:
listTableColumnsRequest- AConsumerthat will call methods onListTableColumnsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableRows
default ListTableRowsResponse listTableRows(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableRows
default ListTableRowsResponse listTableRows(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
The ListTableRows API allows you to retrieve a list of all the rows in a table in a workbook.
This is a convenience which creates an instance of the
ListTableRowsRequest.Builderavoiding the need to create one manually viaListTableRowsRequest.builder()- Parameters:
listTableRowsRequest- AConsumerthat will call methods onListTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableRowsPaginator
default ListTableRowsIterable listTableRowsPaginator(ListTableRowsRequest listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableRowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation.- Parameters:
listTableRowsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTableRowsPaginator
default ListTableRowsIterable listTableRowsPaginator(Consumer<ListTableRowsRequest.Builder> listTableRowsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ValidationException, RequestTimeoutException, ThrottlingException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTableRowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTableRowsIterable responses = client.listTableRowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTableRows(software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest)operation.
This is a convenience which creates an instance of the
ListTableRowsRequest.Builderavoiding the need to create one manually viaListTableRowsRequest.builder()- Parameters:
listTableRowsRequest- AConsumerthat will call methods onListTableRowsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTables
default ListTablesResponse listTables(ListTablesRequest listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTables
default ListTablesResponse listTables(Consumer<ListTablesRequest.Builder> listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The ListTables API allows you to retrieve a list of all the tables in a workbook.
This is a convenience which creates an instance of the
ListTablesRequest.Builderavoiding the need to create one manually viaListTablesRequest.builder()- Parameters:
listTablesRequest- AConsumerthat will call methods onListTablesRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTablesPaginator
default ListTablesIterable listTablesPaginator(ListTablesRequest listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTablesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation.- Parameters:
listTablesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTablesPaginator
default ListTablesIterable listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); for (software.amazon.awssdk.services.honeycode.model.ListTablesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.ListTablesIterable responses = client.listTablesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTables(software.amazon.awssdk.services.honeycode.model.ListTablesRequest)operation.
This is a convenience which creates an instance of the
ListTablesRequest.Builderavoiding the need to create one manually viaListTablesRequest.builder()- Parameters:
listTablesRequest- AConsumerthat will call methods onListTablesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The ListTagsForResource API allows you to return a resource's tags.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryTableRows
default QueryTableRowsResponse queryTableRows(QueryTableRowsRequest queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryTableRows
default QueryTableRowsResponse queryTableRows(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The QueryTableRows API allows you to use a filter formula to query for specific rows in a table.
This is a convenience which creates an instance of the
QueryTableRowsRequest.Builderavoiding the need to create one manually viaQueryTableRowsRequest.builder()- Parameters:
queryTableRowsRequest- AConsumerthat will call methods onQueryTableRowsRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryTableRowsPaginator
default QueryTableRowsIterable queryTableRowsPaginator(QueryTableRowsRequest queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client .queryTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.QueryTableRowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation.- Parameters:
queryTableRowsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
queryTableRowsPaginator
default QueryTableRowsIterable queryTableRowsPaginator(Consumer<QueryTableRowsRequest.Builder> queryTableRowsRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
This is a variant of
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client .queryTableRowsPaginator(request); for (software.amazon.awssdk.services.honeycode.model.QueryTableRowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.honeycode.paginators.QueryTableRowsIterable responses = client.queryTableRowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryTableRows(software.amazon.awssdk.services.honeycode.model.QueryTableRowsRequest)operation.
This is a convenience which creates an instance of the
QueryTableRowsRequest.Builderavoiding the need to create one manually viaQueryTableRowsRequest.builder()- Parameters:
queryTableRowsRequest- AConsumerthat will call methods onQueryTableRowsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startTableDataImportJob
default StartTableDataImportJobResponse startTableDataImportJob(StartTableDataImportJobRequest startTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startTableDataImportJob
default StartTableDataImportJobResponse startTableDataImportJob(Consumer<StartTableDataImportJobRequest.Builder> startTableDataImportJobRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, RequestTimeoutException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, HoneycodeException
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.
This is a convenience which creates an instance of the
StartTableDataImportJobRequest.Builderavoiding the need to create one manually viaStartTableDataImportJobRequest.builder()- Parameters:
startTableDataImportJobRequest- AConsumerthat will call methods onStartTableDataImportJobRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The TagResource API allows you to add tags to an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws AccessDeniedException, InternalServerException, RequestTimeoutException, ResourceNotFoundException, ServiceUnavailableException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, HoneycodeException
The UntagResource API allows you to removes tags from an ARN-able resource. Resource includes workbook, table, screen and screen-automation.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- 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.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.HoneycodeException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static HoneycodeClient create()
Create aHoneycodeClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static HoneycodeClientBuilder builder()
Create a builder that can be used to configure and create aHoneycodeClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default HoneycodeServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-