com.amazonaws.services.amplifyuibuilder.AWSAmplifyUIBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-amplifyuibuilder Show documentation
Show all versions of aws-java-sdk-amplifyuibuilder Show documentation
The AWS Java SDK for AWS Amplify UI Builder module holds the client classes that are used for communicating with AWS Amplify UI Builder Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.amplifyuibuilder;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.amplifyuibuilder.model.*;
/**
* Interface for accessing AWS Amplify UI Builder.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.amplifyuibuilder.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplifyUIBuilder {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "amplifyuibuilder";
/**
*
* Creates a new component for an Amplify app.
*
*
* @param createComponentRequest
* @return 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.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.CreateComponent
* @see AWS API Documentation
*/
CreateComponentResult createComponent(CreateComponentRequest createComponentRequest);
/**
*
* Creates a new form for an Amplify app.
*
*
* @param createFormRequest
* @return 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.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.CreateForm
* @see AWS
* API Documentation
*/
CreateFormResult createForm(CreateFormRequest createFormRequest);
/**
*
* Creates a theme to apply to the components in an Amplify app.
*
*
* @param createThemeRequest
* @return 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.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.CreateTheme
* @see AWS
* API Documentation
*/
CreateThemeResult createTheme(CreateThemeRequest createThemeRequest);
/**
*
* Deletes a component from an Amplify app.
*
*
* @param deleteComponentRequest
* @return Result of the DeleteComponent operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.DeleteComponent
* @see AWS API Documentation
*/
DeleteComponentResult deleteComponent(DeleteComponentRequest deleteComponentRequest);
/**
*
* Deletes a form from an Amplify app.
*
*
* @param deleteFormRequest
* @return Result of the DeleteForm operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.DeleteForm
* @see AWS
* API Documentation
*/
DeleteFormResult deleteForm(DeleteFormRequest deleteFormRequest);
/**
*
* Deletes a theme from an Amplify app.
*
*
* @param deleteThemeRequest
* @return Result of the DeleteTheme operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.DeleteTheme
* @see AWS
* API Documentation
*/
DeleteThemeResult deleteTheme(DeleteThemeRequest deleteThemeRequest);
/**
*
*
* This is for internal use.
*
*
*
* Amplify uses this action to exchange an access code for a token.
*
*
* @param exchangeCodeForTokenRequest
* @return Result of the ExchangeCodeForToken operation returned by the service.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ExchangeCodeForToken
* @see AWS API Documentation
*/
ExchangeCodeForTokenResult exchangeCodeForToken(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest);
/**
*
* Exports component configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportComponentsRequest
* @return Result of the ExportComponents operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ExportComponents
* @see AWS API Documentation
*/
ExportComponentsResult exportComponents(ExportComponentsRequest exportComponentsRequest);
/**
*
* Exports form configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportFormsRequest
* @return Result of the ExportForms operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ExportForms
* @see AWS
* API Documentation
*/
ExportFormsResult exportForms(ExportFormsRequest exportFormsRequest);
/**
*
* Exports theme configurations to code that is ready to integrate into an Amplify app.
*
*
* @param exportThemesRequest
* @return Result of the ExportThemes operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ExportThemes
* @see AWS
* API Documentation
*/
ExportThemesResult exportThemes(ExportThemesRequest exportThemesRequest);
/**
*
* Returns an existing code generation job.
*
*
* @param getCodegenJobRequest
* @return Result of the GetCodegenJob operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.GetCodegenJob
* @see AWS
* API Documentation
*/
GetCodegenJobResult getCodegenJob(GetCodegenJobRequest getCodegenJobRequest);
/**
*
* Returns an existing component for an Amplify app.
*
*
* @param getComponentRequest
* @return Result of the GetComponent operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.GetComponent
* @see AWS
* API Documentation
*/
GetComponentResult getComponent(GetComponentRequest getComponentRequest);
/**
*
* Returns an existing form for an Amplify app.
*
*
* @param getFormRequest
* @return Result of the GetForm operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.GetForm
* @see AWS API
* Documentation
*/
GetFormResult getForm(GetFormRequest getFormRequest);
/**
*
* Returns existing metadata for an Amplify app.
*
*
* @param getMetadataRequest
* @return Result of the GetMetadata operation returned by the service.
* @throws UnauthorizedException
* You don't have permission to perform this operation.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.GetMetadata
* @see AWS
* API Documentation
*/
GetMetadataResult getMetadata(GetMetadataRequest getMetadataRequest);
/**
*
* Returns an existing theme for an Amplify app.
*
*
* @param getThemeRequest
* @return Result of the GetTheme operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.GetTheme
* @see AWS API
* Documentation
*/
GetThemeResult getTheme(GetThemeRequest getThemeRequest);
/**
*
* Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
*
*
* @param listCodegenJobsRequest
* @return Result of the ListCodegenJobs operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSAmplifyUIBuilder.ListCodegenJobs
* @see AWS API Documentation
*/
ListCodegenJobsResult listCodegenJobs(ListCodegenJobsRequest listCodegenJobsRequest);
/**
*
* Retrieves a list of components for a specified Amplify app and backend environment.
*
*
* @param listComponentsRequest
* @return Result of the ListComponents operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ListComponents
* @see AWS API Documentation
*/
ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest);
/**
*
* Retrieves a list of forms for a specified Amplify app and backend environment.
*
*
* @param listFormsRequest
* @return Result of the ListForms operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ListForms
* @see AWS API
* Documentation
*/
ListFormsResult listForms(ListFormsRequest listFormsRequest);
/**
*
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws UnauthorizedException
* You don't have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Retrieves a list of themes for a specified Amplify app and backend environment.
*
*
* @param listThemesRequest
* @return Result of the ListThemes operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.ListThemes
* @see AWS
* API Documentation
*/
ListThemesResult listThemes(ListThemesRequest listThemesRequest);
/**
*
* Stores the metadata information about a feature on a form.
*
*
* @param putMetadataFlagRequest
* @return Result of the PutMetadataFlag operation returned by the service.
* @throws UnauthorizedException
* You don't have permission to perform this operation.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.PutMetadataFlag
* @see AWS API Documentation
*/
PutMetadataFlagResult putMetadataFlag(PutMetadataFlagRequest putMetadataFlagRequest);
/**
*
*
* This is for internal use.
*
*
*
* Amplify uses this action to refresh a previously issued access token that might have expired.
*
*
* @param refreshTokenRequest
* @return Result of the RefreshToken operation returned by the service.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.RefreshToken
* @see AWS
* API Documentation
*/
RefreshTokenResult refreshToken(RefreshTokenRequest refreshTokenRequest);
/**
*
* Starts a code generation job for a specified Amplify app and backend environment.
*
*
* @param startCodegenJobRequest
* @return Result of the StartCodegenJob operation returned by the service.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @sample AWSAmplifyUIBuilder.StartCodegenJob
* @see AWS API Documentation
*/
StartCodegenJobResult startCodegenJob(StartCodegenJobRequest startCodegenJobRequest);
/**
*
* Tags the resource with a tag key and value.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws UnauthorizedException
* You don't have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Untags a resource with a specified Amazon Resource Name (ARN).
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws UnauthorizedException
* You don't have permission to perform this operation.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @throws ThrottlingException
* The request was denied due to request throttling.
* @throws ResourceNotFoundException
* The requested resource does not exist, or access was denied.
* @sample AWSAmplifyUIBuilder.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates an existing component.
*
*
* @param updateComponentRequest
* @return Result of the UpdateComponent operation returned by the service.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.UpdateComponent
* @see AWS API Documentation
*/
UpdateComponentResult updateComponent(UpdateComponentRequest updateComponentRequest);
/**
*
* Updates an existing form.
*
*
* @param updateFormRequest
* @return Result of the UpdateForm operation returned by the service.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.UpdateForm
* @see AWS
* API Documentation
*/
UpdateFormResult updateForm(UpdateFormRequest updateFormRequest);
/**
*
* Updates an existing theme.
*
*
* @param updateThemeRequest
* @return Result of the UpdateTheme operation returned by the service.
* @throws ResourceConflictException
* The resource specified in the request conflicts with an existing resource.
* @throws InternalServerException
* An internal error has occurred. Please retry your request.
* @throws InvalidParameterException
* An invalid or out-of-range value was supplied for the input parameter.
* @sample AWSAmplifyUIBuilder.UpdateTheme
* @see AWS
* API Documentation
*/
UpdateThemeResult updateTheme(UpdateThemeRequest updateThemeRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}