software.amazon.awssdk.services.honeycode

Interface HoneycodeClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface HoneycodeClient
extends SdkClient

Service client for accessing Honeycode. This can be created using the static builder() 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 and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static HoneycodeClientBuilder	builder() Create a builder that can be used to configure and create a HoneycodeClient.
static HoneycodeClient	create() Create a HoneycodeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetScreenDataResponse	getScreenData(Consumer<GetScreenDataRequest.Builder> getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
default GetScreenDataResponse	getScreenData(GetScreenDataRequest getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
default InvokeScreenAutomationResponse	invokeScreenAutomation(Consumer<InvokeScreenAutomationRequest.Builder> invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
default InvokeScreenAutomationResponse	invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static HoneycodeClient create()

Create a HoneycodeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static HoneycodeClientBuilder builder()

Create a builder that can be used to configure and create a HoneycodeClient.

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 screen/automation in the request.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

ResourceNotFoundException - A Workbook, 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.Builder avoiding the need to create one manually via GetScreenDataRequest.builder()

Parameters:

getScreenDataRequest - A Consumer that will call methods on GetScreenDataRequest.Builder to 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 screen/automation in the request.

InternalServerException - There were unexpected errors from the server.

RequestTimeoutException - The request timed out.

ResourceNotFoundException - A Workbook, 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,
                                                              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 screen/automation in the request.

InternalServerException - There were unexpected errors from the server.

ResourceNotFoundException - A Workbook, 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.

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,
                                                              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.Builder avoiding the need to create one manually via InvokeScreenAutomationRequest.builder()

Parameters:

invokeScreenAutomationRequest - A Consumer that will call methods on InvokeScreenAutomationRequest.Builder to 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 screen/automation in the request.

InternalServerException - There were unexpected errors from the server.

ResourceNotFoundException - A Workbook, 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.

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

serviceMetadata

static ServiceMetadata serviceMetadata()