com.amazonaws.services.amplifyuibuilder

Interface AWSAmplifyUIBuilder

All Known Subinterfaces:

AWSAmplifyUIBuilderAsync

All Known Implementing Classes:

AbstractAWSAmplifyUIBuilder, AbstractAWSAmplifyUIBuilderAsync, AWSAmplifyUIBuilderAsyncClient, AWSAmplifyUIBuilderClient

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

Interface for accessing AWS Amplify UI Builder.

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

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

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
CreateComponentResult	createComponent(CreateComponentRequest createComponentRequest) Creates a new component for an Amplify app.
CreateFormResult	createForm(CreateFormRequest createFormRequest) Creates a new form for an Amplify app.
CreateThemeResult	createTheme(CreateThemeRequest createThemeRequest) Creates a theme to apply to the components in an Amplify app.
DeleteComponentResult	deleteComponent(DeleteComponentRequest deleteComponentRequest) Deletes a component from an Amplify app.
DeleteFormResult	deleteForm(DeleteFormRequest deleteFormRequest) Deletes a form from an Amplify app.
DeleteThemeResult	deleteTheme(DeleteThemeRequest deleteThemeRequest) Deletes a theme from an Amplify app.
ExchangeCodeForTokenResult	exchangeCodeForToken(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest)
ExportComponentsResult	exportComponents(ExportComponentsRequest exportComponentsRequest) Exports component configurations to code that is ready to integrate into an Amplify app.
ExportFormsResult	exportForms(ExportFormsRequest exportFormsRequest) Exports form configurations to code that is ready to integrate into an Amplify app.
ExportThemesResult	exportThemes(ExportThemesRequest exportThemesRequest) 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 getCodegenJobRequest) Returns an existing code generation job.
GetComponentResult	getComponent(GetComponentRequest getComponentRequest) Returns an existing component for an Amplify app.
GetFormResult	getForm(GetFormRequest getFormRequest) Returns an existing form for an Amplify app.
GetMetadataResult	getMetadata(GetMetadataRequest getMetadataRequest) Returns existing metadata for an Amplify app.
GetThemeResult	getTheme(GetThemeRequest getThemeRequest) Returns an existing theme for an Amplify app.
ListCodegenJobsResult	listCodegenJobs(ListCodegenJobsRequest listCodegenJobsRequest) Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
ListComponentsResult	listComponents(ListComponentsRequest listComponentsRequest) Retrieves a list of components for a specified Amplify app and backend environment.
ListFormsResult	listForms(ListFormsRequest listFormsRequest) Retrieves a list of forms for a specified Amplify app and backend environment.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).
ListThemesResult	listThemes(ListThemesRequest listThemesRequest) Retrieves a list of themes for a specified Amplify app and backend environment.
PutMetadataFlagResult	putMetadataFlag(PutMetadataFlagRequest putMetadataFlagRequest) Stores the metadata information about a feature on a form.
RefreshTokenResult	refreshToken(RefreshTokenRequest refreshTokenRequest)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartCodegenJobResult	startCodegenJob(StartCodegenJobRequest startCodegenJobRequest) Starts a code generation job for a specified Amplify app and backend environment.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tags the resource with a tag key and value.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).
UpdateComponentResult	updateComponent(UpdateComponentRequest updateComponentRequest) Updates an existing component.
UpdateFormResult	updateForm(UpdateFormRequest updateFormRequest) Updates an existing form.
UpdateThemeResult	updateTheme(UpdateThemeRequest updateThemeRequest) Updates an existing theme.

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

createComponent

CreateComponentResult createComponent(CreateComponentRequest createComponentRequest)

Creates a new component for an Amplify app.

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

CreateFormResult createForm(CreateFormRequest createFormRequest)

Creates a new form for an Amplify app.

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

CreateThemeResult createTheme(CreateThemeRequest createThemeRequest)

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

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

DeleteComponentResult deleteComponent(DeleteComponentRequest deleteComponentRequest)

Deletes a component from an Amplify app.

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

DeleteFormResult deleteForm(DeleteFormRequest deleteFormRequest)

Deletes a form from an Amplify app.

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

DeleteThemeResult deleteTheme(DeleteThemeRequest deleteThemeRequest)

Deletes a theme from an Amplify app.

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

ExchangeCodeForTokenResult exchangeCodeForToken(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest)

This is for internal use.

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

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

ExportComponentsResult exportComponents(ExportComponentsRequest exportComponentsRequest)

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

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

ExportFormsResult exportForms(ExportFormsRequest exportFormsRequest)

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

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

ExportThemesResult exportThemes(ExportThemesRequest exportThemesRequest)

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

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

GetCodegenJobResult getCodegenJob(GetCodegenJobRequest getCodegenJobRequest)

Returns an existing code generation job.

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

GetComponentResult getComponent(GetComponentRequest getComponentRequest)

Returns an existing component for an Amplify app.

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

GetFormResult getForm(GetFormRequest getFormRequest)

Returns an existing form for an Amplify app.

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

GetMetadataResult getMetadata(GetMetadataRequest getMetadataRequest)

Returns existing metadata for an Amplify app.

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

GetThemeResult getTheme(GetThemeRequest getThemeRequest)

Returns an existing theme for an Amplify app.

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

ListCodegenJobsResult listCodegenJobs(ListCodegenJobsRequest listCodegenJobsRequest)

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

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

ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest)

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

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

ListFormsResult listForms(ListFormsRequest listFormsRequest)

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

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

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of tags for a specified Amazon Resource Name (ARN).

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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

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

listThemes

ListThemesResult listThemes(ListThemesRequest listThemesRequest)

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

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

PutMetadataFlagResult putMetadataFlag(PutMetadataFlagRequest putMetadataFlagRequest)

Stores the metadata information about a feature on a form.

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

RefreshTokenResult refreshToken(RefreshTokenRequest refreshTokenRequest)

This is for internal use.

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

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

StartCodegenJobResult startCodegenJob(StartCodegenJobRequest startCodegenJobRequest)

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

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

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tags the resource with a tag key and value.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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

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

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Untags a resource with a specified Amazon Resource Name (ARN).

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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

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

updateComponent

UpdateComponentResult updateComponent(UpdateComponentRequest updateComponentRequest)

Updates an existing component.

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

UpdateFormResult updateForm(UpdateFormRequest updateFormRequest)

Updates an existing form.

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

UpdateThemeResult updateTheme(UpdateThemeRequest updateThemeRequest)

Updates an existing theme.

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

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.