com.amazonaws.services.amplifyuibuilder

Class AWSAmplifyUIBuilderClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilderClient

All Implemented Interfaces:

AWSAmplifyUIBuilder

Direct Known Subclasses:

AWSAmplifyUIBuilderAsyncClient

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

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

The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.

You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.

The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAmplifyUIBuilderClientBuilder	builder()
CreateComponentResult	createComponent(CreateComponentRequest request) Creates a new component for an Amplify app.
CreateFormResult	createForm(CreateFormRequest request) Creates a new form for an Amplify app.
CreateThemeResult	createTheme(CreateThemeRequest request) Creates a theme to apply to the components in an Amplify app.
DeleteComponentResult	deleteComponent(DeleteComponentRequest request) Deletes a component from an Amplify app.
DeleteFormResult	deleteForm(DeleteFormRequest request) Deletes a form from an Amplify app.
DeleteThemeResult	deleteTheme(DeleteThemeRequest request) Deletes a theme from an Amplify app.
ExchangeCodeForTokenResult	exchangeCodeForToken(ExchangeCodeForTokenRequest request)
ExportComponentsResult	exportComponents(ExportComponentsRequest request) Exports component configurations to code that is ready to integrate into an Amplify app.
ExportFormsResult	exportForms(ExportFormsRequest request) Exports form configurations to code that is ready to integrate into an Amplify app.
ExportThemesResult	exportThemes(ExportThemesRequest request) Exports theme configurations to code that is ready to integrate into an Amplify app.
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.
GetCodegenJobResult	getCodegenJob(GetCodegenJobRequest request) Returns an existing code generation job.
GetComponentResult	getComponent(GetComponentRequest request) Returns an existing component for an Amplify app.
GetFormResult	getForm(GetFormRequest request) Returns an existing form for an Amplify app.
GetMetadataResult	getMetadata(GetMetadataRequest request) Returns existing metadata for an Amplify app.
GetThemeResult	getTheme(GetThemeRequest request) Returns an existing theme for an Amplify app.
ListCodegenJobsResult	listCodegenJobs(ListCodegenJobsRequest request) Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
ListComponentsResult	listComponents(ListComponentsRequest request) Retrieves a list of components for a specified Amplify app and backend environment.
ListFormsResult	listForms(ListFormsRequest request) Retrieves a list of forms for a specified Amplify app and backend environment.
ListThemesResult	listThemes(ListThemesRequest request) Retrieves a list of themes for a specified Amplify app and backend environment.
PutMetadataFlagResult	putMetadataFlag(PutMetadataFlagRequest request) Stores the metadata information about a feature on a form.
RefreshTokenResult	refreshToken(RefreshTokenRequest request)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCodegenJobResult	startCodegenJob(StartCodegenJobRequest request) Starts a code generation job for a specified Amplify app and backend environment.
UpdateComponentResult	updateComponent(UpdateComponentRequest request) Updates an existing component.
UpdateFormResult	updateForm(UpdateFormRequest request) Updates an existing form.
UpdateThemeResult	updateTheme(UpdateThemeRequest request) Updates an existing theme.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSAmplifyUIBuilderClientBuilder builder()

createComponent

public CreateComponentResult createComponent(CreateComponentRequest request)

Creates a new component for an Amplify app.

Specified by:

createComponent in interface AWSAmplifyUIBuilder

Parameters:

createComponentRequest -

Returns:

Result of the CreateComponent operation returned by the service.

Throws:

ServiceQuotaExceededException - You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

createForm

public CreateFormResult createForm(CreateFormRequest request)

Creates a new form for an Amplify app.

Specified by:

createForm in interface AWSAmplifyUIBuilder

Parameters:

createFormRequest -

Returns:

Result of the CreateForm operation returned by the service.

Throws:

ServiceQuotaExceededException - You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

createTheme

public CreateThemeResult createTheme(CreateThemeRequest request)

Creates a theme to apply to the components in an Amplify app.

Specified by:

createTheme in interface AWSAmplifyUIBuilder

Parameters:

createThemeRequest -

Returns:

Result of the CreateTheme operation returned by the service.

Throws:

ServiceQuotaExceededException - You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

deleteComponent

public DeleteComponentResult deleteComponent(DeleteComponentRequest request)

Deletes a component from an Amplify app.

Specified by:

deleteComponent in interface AWSAmplifyUIBuilder

Parameters:

deleteComponentRequest -

Returns:

Result of the DeleteComponent operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

deleteForm

public DeleteFormResult deleteForm(DeleteFormRequest request)

Deletes a form from an Amplify app.

Specified by:

deleteForm in interface AWSAmplifyUIBuilder

Parameters:

deleteFormRequest -

Returns:

Result of the DeleteForm operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

deleteTheme

public DeleteThemeResult deleteTheme(DeleteThemeRequest request)

Deletes a theme from an Amplify app.

Specified by:

deleteTheme in interface AWSAmplifyUIBuilder

Parameters:

deleteThemeRequest -

Returns:

Result of the DeleteTheme operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

exchangeCodeForToken

public ExchangeCodeForTokenResult exchangeCodeForToken(ExchangeCodeForTokenRequest request)

This is for internal use.

Amplify uses this action to exchange an access code for a token.

Specified by:

exchangeCodeForToken in interface AWSAmplifyUIBuilder

Parameters:

exchangeCodeForTokenRequest -

Returns:

Result of the ExchangeCodeForToken operation returned by the service.

Throws:

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

exportComponents

public ExportComponentsResult exportComponents(ExportComponentsRequest request)

Exports component configurations to code that is ready to integrate into an Amplify app.

Specified by:

exportComponents in interface AWSAmplifyUIBuilder

Parameters:

exportComponentsRequest -

Returns:

Result of the ExportComponents operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

exportForms

public ExportFormsResult exportForms(ExportFormsRequest request)

Exports form configurations to code that is ready to integrate into an Amplify app.

Specified by:

exportForms in interface AWSAmplifyUIBuilder

Parameters:

exportFormsRequest -

Returns:

Result of the ExportForms operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

exportThemes

public ExportThemesResult exportThemes(ExportThemesRequest request)

Exports theme configurations to code that is ready to integrate into an Amplify app.

Specified by:

exportThemes in interface AWSAmplifyUIBuilder

Parameters:

exportThemesRequest -

Returns:

Result of the ExportThemes operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

getCodegenJob

public GetCodegenJobResult getCodegenJob(GetCodegenJobRequest request)

Returns an existing code generation job.

Specified by:

getCodegenJob in interface AWSAmplifyUIBuilder

Parameters:

getCodegenJobRequest -

Returns:

Result of the GetCodegenJob operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ThrottlingException - The request was denied due to request throttling.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

getComponent

public GetComponentResult getComponent(GetComponentRequest request)

Returns an existing component for an Amplify app.

Specified by:

getComponent in interface AWSAmplifyUIBuilder

Parameters:

getComponentRequest -

Returns:

Result of the GetComponent operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

getForm

public GetFormResult getForm(GetFormRequest request)

Returns an existing form for an Amplify app.

Specified by:

getForm in interface AWSAmplifyUIBuilder

Parameters:

getFormRequest -

Returns:

Result of the GetForm operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

getMetadata

public GetMetadataResult getMetadata(GetMetadataRequest request)

Returns existing metadata for an Amplify app.

Specified by:

getMetadata in interface AWSAmplifyUIBuilder

Parameters:

getMetadataRequest -

Returns:

Result of the GetMetadata operation returned by the service.

Throws:

UnauthorizedException - You don't have permission to perform this operation.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

getTheme

public GetThemeResult getTheme(GetThemeRequest request)

Returns an existing theme for an Amplify app.

Specified by:

getTheme in interface AWSAmplifyUIBuilder

Parameters:

getThemeRequest -

Returns:

Result of the GetTheme operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ResourceNotFoundException - The requested resource does not exist, or access was denied.

See Also:

AWS API Documentation

listCodegenJobs

public ListCodegenJobsResult listCodegenJobs(ListCodegenJobsRequest request)

Retrieves a list of code generation jobs for a specified Amplify app and backend environment.

Specified by:

listCodegenJobs in interface AWSAmplifyUIBuilder

Parameters:

listCodegenJobsRequest -

Returns:

Result of the ListCodegenJobs operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listComponents

public ListComponentsResult listComponents(ListComponentsRequest request)

Retrieves a list of components for a specified Amplify app and backend environment.

Specified by:

listComponents in interface AWSAmplifyUIBuilder

Parameters:

listComponentsRequest -

Returns:

Result of the ListComponents operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

listForms

public ListFormsResult listForms(ListFormsRequest request)

Retrieves a list of forms for a specified Amplify app and backend environment.

Specified by:

listForms in interface AWSAmplifyUIBuilder

Parameters:

listFormsRequest -

Returns:

Result of the ListForms operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

listThemes

public ListThemesResult listThemes(ListThemesRequest request)

Retrieves a list of themes for a specified Amplify app and backend environment.

Specified by:

listThemes in interface AWSAmplifyUIBuilder

Parameters:

listThemesRequest -

Returns:

Result of the ListThemes operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

putMetadataFlag

public PutMetadataFlagResult putMetadataFlag(PutMetadataFlagRequest request)

Stores the metadata information about a feature on a form.

Specified by:

putMetadataFlag in interface AWSAmplifyUIBuilder

Parameters:

putMetadataFlagRequest -

Returns:

Result of the PutMetadataFlag operation returned by the service.

Throws:

UnauthorizedException - You don't have permission to perform this operation.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

refreshToken

public RefreshTokenResult refreshToken(RefreshTokenRequest request)

This is for internal use.

Amplify uses this action to refresh a previously issued access token that might have expired.

Specified by:

refreshToken in interface AWSAmplifyUIBuilder

Parameters:

refreshTokenRequest -

Returns:

Result of the RefreshToken operation returned by the service.

Throws:

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

startCodegenJob

public StartCodegenJobResult startCodegenJob(StartCodegenJobRequest request)

Starts a code generation job for a specified Amplify app and backend environment.

Specified by:

startCodegenJob in interface AWSAmplifyUIBuilder

Parameters:

startCodegenJobRequest -

Returns:

Result of the StartCodegenJob operation returned by the service.

Throws:

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

updateComponent

public UpdateComponentResult updateComponent(UpdateComponentRequest request)

Updates an existing component.

Specified by:

updateComponent in interface AWSAmplifyUIBuilder

Parameters:

updateComponentRequest -

Returns:

Result of the UpdateComponent operation returned by the service.

Throws:

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

updateForm

public UpdateFormResult updateForm(UpdateFormRequest request)

Updates an existing form.

Specified by:

updateForm in interface AWSAmplifyUIBuilder

Parameters:

updateFormRequest -

Returns:

Result of the UpdateForm operation returned by the service.

Throws:

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

updateTheme

public UpdateThemeResult updateTheme(UpdateThemeRequest request)

Updates an existing theme.

Specified by:

updateTheme in interface AWSAmplifyUIBuilder

Parameters:

updateThemeRequest -

Returns:

Result of the UpdateTheme operation returned by the service.

Throws:

ResourceConflictException - The resource specified in the request conflicts with an existing resource.

InternalServerException - An internal error has occurred. Please retry your request.

InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

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

Specified by:

getCachedResponseMetadata in interface AWSAmplifyUIBuilder

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

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

Specified by:

shutdown in interface AWSAmplifyUIBuilder

Overrides:

shutdown in class AmazonWebServiceClient