@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSAmplifyClient extends AmazonWebServiceClient implements AWSAmplify
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
static AWSAmplifyClientBuilder |
builder() |
CreateAppResult |
createApp(CreateAppRequest request)
Creates a new Amplify app.
|
CreateBackendEnvironmentResult |
createBackendEnvironment(CreateBackendEnvironmentRequest request)
Creates a new backend environment for an Amplify app.
|
CreateBranchResult |
createBranch(CreateBranchRequest request)
Creates a new branch for an Amplify app.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Creates a deployment for a manually deployed Amplify app.
|
CreateDomainAssociationResult |
createDomainAssociation(CreateDomainAssociationRequest request)
Creates a new domain association for an Amplify app.
|
CreateWebhookResult |
createWebhook(CreateWebhookRequest request)
Creates a new webhook on an Amplify app.
|
DeleteAppResult |
deleteApp(DeleteAppRequest request)
Deletes an existing Amplify app specified by an app ID.
|
DeleteBackendEnvironmentResult |
deleteBackendEnvironment(DeleteBackendEnvironmentRequest request)
Deletes a backend environment for an Amplify app.
|
DeleteBranchResult |
deleteBranch(DeleteBranchRequest request)
Deletes a branch for an Amplify app.
|
DeleteDomainAssociationResult |
deleteDomainAssociation(DeleteDomainAssociationRequest request)
Deletes a domain association for an Amplify app.
|
DeleteJobResult |
deleteJob(DeleteJobRequest request)
Deletes a job for a branch of an Amplify app.
|
DeleteWebhookResult |
deleteWebhook(DeleteWebhookRequest request)
Deletes a webhook.
|
GenerateAccessLogsResult |
generateAccessLogs(GenerateAccessLogsRequest request)
Returns the website access logs for a specific time range using a presigned URL.
|
GetAppResult |
getApp(GetAppRequest request)
Returns an existing Amplify app specified by an app ID.
|
GetArtifactUrlResult |
getArtifactUrl(GetArtifactUrlRequest request)
Returns the artifact info that corresponds to an artifact id.
|
GetBackendEnvironmentResult |
getBackendEnvironment(GetBackendEnvironmentRequest request)
Returns a backend environment for an Amplify app.
|
GetBranchResult |
getBranch(GetBranchRequest request)
Returns a branch for 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.
|
GetDomainAssociationResult |
getDomainAssociation(GetDomainAssociationRequest request)
Returns the domain information for an Amplify app.
|
GetJobResult |
getJob(GetJobRequest request)
Returns a job for a branch of an Amplify app.
|
GetWebhookResult |
getWebhook(GetWebhookRequest request)
Returns the webhook information that corresponds to a specified webhook ID.
|
ListAppsResult |
listApps(ListAppsRequest request)
Returns a list of the existing Amplify apps.
|
ListArtifactsResult |
listArtifacts(ListArtifactsRequest request)
Returns a list of artifacts for a specified app, branch, and job.
|
ListBackendEnvironmentsResult |
listBackendEnvironments(ListBackendEnvironmentsRequest request)
Lists the backend environments for an Amplify app.
|
ListBranchesResult |
listBranches(ListBranchesRequest request)
Lists the branches of an Amplify app.
|
ListDomainAssociationsResult |
listDomainAssociations(ListDomainAssociationsRequest request)
Returns the domain associations for an Amplify app.
|
ListJobsResult |
listJobs(ListJobsRequest request)
Lists the jobs for a branch of an Amplify app.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a specified Amazon Resource Name (ARN).
|
ListWebhooksResult |
listWebhooks(ListWebhooksRequest request)
Returns a list of webhooks for an Amplify app.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDeploymentResult |
startDeployment(StartDeploymentRequest request)
Starts a deployment for a manually deployed app.
|
StartJobResult |
startJob(StartJobRequest request)
Starts a new job for a branch of an Amplify app.
|
StopJobResult |
stopJob(StopJobRequest request)
Stops a job that is in progress for a branch of an Amplify app.
|
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).
|
UpdateAppResult |
updateApp(UpdateAppRequest request)
Updates an existing Amplify app.
|
UpdateBranchResult |
updateBranch(UpdateBranchRequest request)
Updates a branch for an Amplify app.
|
UpdateDomainAssociationResult |
updateDomainAssociation(UpdateDomainAssociationRequest request)
Creates a new domain association for an Amplify app.
|
UpdateWebhookResult |
updateWebhook(UpdateWebhookRequest request)
Updates a webhook.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSAmplifyClientBuilder builder()
public CreateAppResult createApp(CreateAppRequest request)
Creates a new Amplify app.
createApp in interface AWSAmplifycreateAppRequest - The request structure used to create apps in Amplify.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public CreateBackendEnvironmentResult createBackendEnvironment(CreateBackendEnvironmentRequest request)
Creates a new backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
createBackendEnvironment in interface AWSAmplifycreateBackendEnvironmentRequest - The request structure for the backend environment create request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.public CreateBranchResult createBranch(CreateBranchRequest request)
Creates a new branch for an Amplify app.
createBranch in interface AWSAmplifycreateBranchRequest - The request structure for the create branch request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
The maximum duration between the CreateDeployment call and the StartDeployment call
cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
Job will fail.
createDeployment in interface AWSAmplifycreateDeploymentRequest - The request structure for the create a new deployment request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.public CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest request)
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
createDomainAssociation in interface AWSAmplifycreateDomainAssociationRequest - The request structure for the create domain association request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public CreateWebhookResult createWebhook(CreateWebhookRequest request)
Creates a new webhook on an Amplify app.
createWebhook in interface AWSAmplifycreateWebhookRequest - The request structure for the create webhook request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public DeleteAppResult deleteApp(DeleteAppRequest request)
Deletes an existing Amplify app specified by an app ID.
deleteApp in interface AWSAmplifydeleteAppRequest - Describes the request structure for the delete app request.BadRequestException - A request contains unexpected data.NotFoundException - An entity was not found during an operation.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public DeleteBackendEnvironmentResult deleteBackendEnvironment(DeleteBackendEnvironmentRequest request)
Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
deleteBackendEnvironment in interface AWSAmplifydeleteBackendEnvironmentRequest - The request structure for the delete backend environment request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public DeleteBranchResult deleteBranch(DeleteBranchRequest request)
Deletes a branch for an Amplify app.
deleteBranch in interface AWSAmplifydeleteBranchRequest - The request structure for the delete branch request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest request)
Deletes a domain association for an Amplify app.
deleteDomainAssociation in interface AWSAmplifydeleteDomainAssociationRequest - The request structure for the delete domain association request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public DeleteJobResult deleteJob(DeleteJobRequest request)
Deletes a job for a branch of an Amplify app.
deleteJob in interface AWSAmplifydeleteJobRequest - The request structure for the delete job request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
Deletes a webhook.
deleteWebhook in interface AWSAmplifydeleteWebhookRequest - The request structure for the delete webhook request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public GenerateAccessLogsResult generateAccessLogs(GenerateAccessLogsRequest request)
Returns the website access logs for a specific time range using a presigned URL.
generateAccessLogs in interface AWSAmplifygenerateAccessLogsRequest - The request structure for the generate access logs request.NotFoundException - An entity was not found during an operation.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public GetAppResult getApp(GetAppRequest request)
Returns an existing Amplify app specified by an app ID.
getApp in interface AWSAmplifygetAppRequest - The request structure for the get app request.BadRequestException - A request contains unexpected data.NotFoundException - An entity was not found during an operation.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public GetArtifactUrlResult getArtifactUrl(GetArtifactUrlRequest request)
Returns the artifact info that corresponds to an artifact id.
getArtifactUrl in interface AWSAmplifygetArtifactUrlRequest - Returns the request structure for the get artifact request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public GetBackendEnvironmentResult getBackendEnvironment(GetBackendEnvironmentRequest request)
Returns a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
getBackendEnvironment in interface AWSAmplifygetBackendEnvironmentRequest - The request structure for the get backend environment request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.public GetBranchResult getBranch(GetBranchRequest request)
Returns a branch for an Amplify app.
getBranch in interface AWSAmplifygetBranchRequest - The request structure for the get branch request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.public GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest request)
Returns the domain information for an Amplify app.
getDomainAssociation in interface AWSAmplifygetDomainAssociationRequest - The request structure for the get domain association request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.public GetJobResult getJob(GetJobRequest request)
Returns a job for a branch of an Amplify app.
getJob in interface AWSAmplifygetJobRequest - The request structure for the get job request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public GetWebhookResult getWebhook(GetWebhookRequest request)
Returns the webhook information that corresponds to a specified webhook ID.
getWebhook in interface AWSAmplifygetWebhookRequest - The request structure for the get webhook request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public ListAppsResult listApps(ListAppsRequest request)
Returns a list of the existing Amplify apps.
listApps in interface AWSAmplifylistAppsRequest - The request structure for the list apps request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public ListArtifactsResult listArtifacts(ListArtifactsRequest request)
Returns a list of artifacts for a specified app, branch, and job.
listArtifacts in interface AWSAmplifylistArtifactsRequest - Describes the request structure for the list artifacts request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.public ListBackendEnvironmentsResult listBackendEnvironments(ListBackendEnvironmentsRequest request)
Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
listBackendEnvironments in interface AWSAmplifylistBackendEnvironmentsRequest - The request structure for the list backend environments request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public ListBranchesResult listBranches(ListBranchesRequest request)
Lists the branches of an Amplify app.
listBranches in interface AWSAmplifylistBranchesRequest - The request structure for the list branches request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest request)
Returns the domain associations for an Amplify app.
listDomainAssociations in interface AWSAmplifylistDomainAssociationsRequest - The request structure for the list domain associations request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public ListJobsResult listJobs(ListJobsRequest request)
Lists the jobs for a branch of an Amplify app.
listJobs in interface AWSAmplifylistJobsRequest - The request structure for the list jobs request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns a list of tags for a specified Amazon Resource Name (ARN).
listTagsForResource in interface AWSAmplifylistTagsForResourceRequest - The request structure to use to list tags for a resource.InternalFailureException - The service failed to perform an operation due to an internal issue.BadRequestException - A request contains unexpected data.ResourceNotFoundException - An operation failed due to a non-existent resource.public ListWebhooksResult listWebhooks(ListWebhooksRequest request)
Returns a list of webhooks for an Amplify app.
listWebhooks in interface AWSAmplifylistWebhooksRequest - The request structure for the list webhooks request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.LimitExceededException - A resource could not be created because service quotas were exceeded.public StartDeploymentResult startDeployment(StartDeploymentRequest request)
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
The maximum duration between the CreateDeployment call and the StartDeployment call
cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated
Job will fail.
startDeployment in interface AWSAmplifystartDeploymentRequest - The request structure for the start a deployment request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public StartJobResult startJob(StartJobRequest request)
Starts a new job for a branch of an Amplify app.
startJob in interface AWSAmplifystartJobRequest - The request structure for the start job request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public StopJobResult stopJob(StopJobRequest request)
Stops a job that is in progress for a branch of an Amplify app.
stopJob in interface AWSAmplifystopJobRequest - The request structure for the stop job request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.NotFoundException - An entity was not found during an operation.LimitExceededException - A resource could not be created because service quotas were exceeded.public TagResourceResult tagResource(TagResourceRequest request)
Tags the resource with a tag key and value.
tagResource in interface AWSAmplifytagResourceRequest - The request structure to tag a resource with a tag key and value.InternalFailureException - The service failed to perform an operation due to an internal issue.BadRequestException - A request contains unexpected data.ResourceNotFoundException - An operation failed due to a non-existent resource.public UntagResourceResult untagResource(UntagResourceRequest request)
Untags a resource with a specified Amazon Resource Name (ARN).
untagResource in interface AWSAmplifyuntagResourceRequest - The request structure for the untag resource request.InternalFailureException - The service failed to perform an operation due to an internal issue.BadRequestException - A request contains unexpected data.ResourceNotFoundException - An operation failed due to a non-existent resource.public UpdateAppResult updateApp(UpdateAppRequest request)
Updates an existing Amplify app.
updateApp in interface AWSAmplifyupdateAppRequest - The request structure for the update app request.BadRequestException - A request contains unexpected data.NotFoundException - An entity was not found during an operation.UnauthorizedException - An operation failed due to a lack of access.InternalFailureException - The service failed to perform an operation due to an internal issue.public UpdateBranchResult updateBranch(UpdateBranchRequest request)
Updates a branch for an Amplify app.
updateBranch in interface AWSAmplifyupdateBranchRequest - The request structure for the update branch request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest request)
Creates a new domain association for an Amplify app.
updateDomainAssociation in interface AWSAmplifyupdateDomainAssociationRequest - The request structure for the update domain association request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.public UpdateWebhookResult updateWebhook(UpdateWebhookRequest request)
Updates a webhook.
updateWebhook in interface AWSAmplifyupdateWebhookRequest - The request structure for the update webhook request.BadRequestException - A request contains unexpected data.UnauthorizedException - An operation failed due to a lack of access.NotFoundException - An entity was not found during an operation.InternalFailureException - The service failed to perform an operation due to an internal issue.DependentServiceFailureException - An operation failed because a dependent service threw an exception.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 AWSAmplifyrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSAmplifyshutdown in class AmazonWebServiceClient