com.amazonaws.services.honeycode

Interface AmazonHoneycode

All Known Subinterfaces:

AmazonHoneycodeAsync

All Known Implementing Classes:

AbstractAmazonHoneycode, AbstractAmazonHoneycodeAsync, AmazonHoneycodeAsyncClient, AmazonHoneycodeClient

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

Interface for accessing Honeycode.

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

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetScreenDataResult	getScreenData(GetScreenDataRequest getScreenDataRequest) The GetScreenData API allows retrieval of data from a screen in a Honeycode app.
InvokeScreenAutomationResult	invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest) The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getScreenData

GetScreenDataResult getScreenData(GetScreenDataRequest getScreenDataRequest)

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

Parameters:

getScreenDataRequest -

Returns:

Result of the GetScreenData operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the 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.

See Also:

AWS API Documentation

invokeScreenAutomation

InvokeScreenAutomationResult invokeScreenAutomation(InvokeScreenAutomationRequest invokeScreenAutomationRequest)

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

Parameters:

invokeScreenAutomationRequest -

Returns:

Result of the InvokeScreenAutomation operation returned by the service.

Throws:

AccessDeniedException - You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the 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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Parameters:

request - The originally executed request.

Returns:

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