@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAmplifyUIBuilderClient extends AmazonWebServiceClient implements AWSAmplifyUIBuilder
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.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX | 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.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest request)
Returns a list of tags for a specified Amazon Resource Name (ARN).
|
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.
|
TagResourceResult |
tagResource (TagResourceRequest request)
Tags the resource with a tag key and value.
|
UntagResourceResult |
untagResource (UntagResourceRequest request)
Untags a resource with a specified Amazon Resource Name (ARN).
|
UpdateComponentResult |
updateComponent (UpdateComponentRequest request)
Updates an existing component.
|
UpdateFormResult |
updateForm (UpdateFormRequest request)
Updates an existing form.
|
UpdateThemeResult |
updateTheme (UpdateThemeRequest request)
Updates an existing theme.
|
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 public static AWSAmplifyUIBuilderClientBuilder builder()
public CreateComponentResult createComponent(CreateComponentRequest request)
Creates a new component for an Amplify app.
createComponent in interface AWSAmplifyUIBuilder createComponentRequest - 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.public CreateFormResult createForm(CreateFormRequest request)
Creates a new form for an Amplify app.
createForm in interface AWSAmplifyUIBuilder createFormRequest - 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.public CreateThemeResult createTheme(CreateThemeRequest request)
Creates a theme to apply to the components in an Amplify app.
createTheme in interface AWSAmplifyUIBuilder createThemeRequest - 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.public DeleteComponentResult deleteComponent(DeleteComponentRequest request)
Deletes a component from an Amplify app.
deleteComponent in interface AWSAmplifyUIBuilder deleteComponentRequest - 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.public DeleteFormResult deleteForm(DeleteFormRequest request)
Deletes a form from an Amplify app.
deleteForm in interface AWSAmplifyUIBuilder deleteFormRequest - 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.public DeleteThemeResult deleteTheme(DeleteThemeRequest request)
Deletes a theme from an Amplify app.
deleteTheme in interface AWSAmplifyUIBuilder deleteThemeRequest - 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.public ExchangeCodeForTokenResult exchangeCodeForToken(ExchangeCodeForTokenRequest request)
This is for internal use.
Amplify uses this action to exchange an access code for a token.
exchangeCodeForToken in interface AWSAmplifyUIBuilder exchangeCodeForTokenRequest - InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public ExportComponentsResult exportComponents(ExportComponentsRequest request)
Exports component configurations to code that is ready to integrate into an Amplify app.
exportComponents in interface AWSAmplifyUIBuilder exportComponentsRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public ExportFormsResult exportForms(ExportFormsRequest request)
Exports form configurations to code that is ready to integrate into an Amplify app.
exportForms in interface AWSAmplifyUIBuilder exportFormsRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public ExportThemesResult exportThemes(ExportThemesRequest request)
Exports theme configurations to code that is ready to integrate into an Amplify app.
exportThemes in interface AWSAmplifyUIBuilder exportThemesRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public GetCodegenJobResult getCodegenJob(GetCodegenJobRequest request)
Returns an existing code generation job.
getCodegenJob in interface AWSAmplifyUIBuilder getCodegenJobRequest - 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.public GetComponentResult getComponent(GetComponentRequest request)
Returns an existing component for an Amplify app.
getComponent in interface AWSAmplifyUIBuilder getComponentRequest - 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.public GetFormResult getForm(GetFormRequest request)
Returns an existing form for an Amplify app.
getForm in interface AWSAmplifyUIBuilder getFormRequest - 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.public GetMetadataResult getMetadata(GetMetadataRequest request)
Returns existing metadata for an Amplify app.
getMetadata in interface AWSAmplifyUIBuilder getMetadataRequest - UnauthorizedException - You don't have permission to perform this operation.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public GetThemeResult getTheme(GetThemeRequest request)
Returns an existing theme for an Amplify app.
getTheme in interface AWSAmplifyUIBuilder getThemeRequest - 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.public ListCodegenJobsResult listCodegenJobs(ListCodegenJobsRequest request)
Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
listCodegenJobs in interface AWSAmplifyUIBuilder listCodegenJobsRequest - 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.public ListComponentsResult listComponents(ListComponentsRequest request)
Retrieves a list of components for a specified Amplify app and backend environment.
listComponents in interface AWSAmplifyUIBuilder listComponentsRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public ListFormsResult listForms(ListFormsRequest request)
Retrieves a list of forms for a specified Amplify app and backend environment.
listForms in interface AWSAmplifyUIBuilder listFormsRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a specified Amazon Resource Name (ARN).
listTagsForResource in interface AWSAmplifyUIBuilder listTagsForResourceRequest - 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.public ListThemesResult listThemes(ListThemesRequest request)
Retrieves a list of themes for a specified Amplify app and backend environment.
listThemes in interface AWSAmplifyUIBuilder listThemesRequest - InternalServerException - An internal error has occurred. Please retry your request.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public PutMetadataFlagResult putMetadataFlag(PutMetadataFlagRequest request)
Stores the metadata information about a feature on a form.
putMetadataFlag in interface AWSAmplifyUIBuilder putMetadataFlagRequest - UnauthorizedException - You don't have permission to perform this operation.InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.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.
refreshToken in interface AWSAmplifyUIBuilder refreshTokenRequest - InvalidParameterException - An invalid or out-of-range value was supplied for the input parameter.public StartCodegenJobResult startCodegenJob(StartCodegenJobRequest request)
Starts a code generation job for a specified Amplify app and backend environment.
startCodegenJob in interface AWSAmplifyUIBuilder startCodegenJobRequest - 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.public TagResourceResult tagResource(TagResourceRequest request)
Tags the resource with a tag key and value.
tagResource in interface AWSAmplifyUIBuilder tagResourceRequest - 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Untags a resource with a specified Amazon Resource Name (ARN).
untagResource in interface AWSAmplifyUIBuilder untagResourceRequest - 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.public UpdateComponentResult updateComponent(UpdateComponentRequest request)
Updates an existing component.
updateComponent in interface AWSAmplifyUIBuilder updateComponentRequest - 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.public UpdateFormResult updateForm(UpdateFormRequest request)
Updates an existing form.
updateForm in interface AWSAmplifyUIBuilder updateFormRequest - 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.public UpdateThemeResult updateTheme(UpdateThemeRequest request)
Updates an existing theme.
updateTheme in interface AWSAmplifyUIBuilder updateThemeRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AWSAmplifyUIBuilder request - The originally executed requestpublic void shutdown()
AmazonWebServiceClient shutdown in interface AWSAmplifyUIBuilder shutdown in class AmazonWebServiceClient