@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAmplify
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAmplify
instead.
Amplify is a fully managed continuous deployment and hosting service for modern web apps.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateAppResult |
createApp(CreateAppRequest createAppRequest)
Creates a new Amplify App.
|
CreateBranchResult |
createBranch(CreateBranchRequest createBranchRequest)
Creates a new Branch for an Amplify App.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Create a deployment for manual deploy apps.
|
CreateDomainAssociationResult |
createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
Create a new DomainAssociation on an App
|
CreateWebhookResult |
createWebhook(CreateWebhookRequest createWebhookRequest)
Create a new webhook on an App.
|
DeleteAppResult |
deleteApp(DeleteAppRequest deleteAppRequest)
Delete an existing Amplify App by appId.
|
DeleteBranchResult |
deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch for an Amplify App.
|
DeleteDomainAssociationResult |
deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
Deletes a DomainAssociation.
|
DeleteJobResult |
deleteJob(DeleteJobRequest deleteJobRequest)
Delete a job, for an Amplify branch, part of Amplify App.
|
DeleteWebhookResult |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a webhook.
|
GenerateAccessLogsResult |
generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
Retrieve website access logs for a specific time range via a pre-signed URL.
|
GetAppResult |
getApp(GetAppRequest getAppRequest)
Retrieves an existing Amplify App by appId.
|
GetArtifactUrlResult |
getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
Retrieves artifact info that corresponds to a artifactId.
|
GetBranchResult |
getBranch(GetBranchRequest getBranchRequest)
Retrieves 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 getDomainAssociationRequest)
Retrieves domain info that corresponds to an appId and domainName.
|
GetJobResult |
getJob(GetJobRequest getJobRequest)
Get a job for a branch, part of an Amplify App.
|
GetWebhookResult |
getWebhook(GetWebhookRequest getWebhookRequest)
Retrieves webhook info that corresponds to a webhookId.
|
ListAppsResult |
listApps(ListAppsRequest listAppsRequest)
Lists existing Amplify Apps.
|
ListArtifactsResult |
listArtifacts(ListArtifactsRequest listArtifactsRequest)
List artifacts with an app, a branch, a job and an artifact type.
|
ListBranchesResult |
listBranches(ListBranchesRequest listBranchesRequest)
Lists branches for an Amplify App.
|
ListDomainAssociationsResult |
listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
List domains with an app
|
ListJobsResult |
listJobs(ListJobsRequest listJobsRequest)
List Jobs for a branch, part of an Amplify App.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for resource.
|
ListWebhooksResult |
listWebhooks(ListWebhooksRequest listWebhooksRequest)
List webhooks with an app.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartDeploymentResult |
startDeployment(StartDeploymentRequest startDeploymentRequest)
Start a deployment for manual deploy apps.
|
StartJobResult |
startJob(StartJobRequest startJobRequest)
Starts a new job for a branch, part of an Amplify App.
|
StopJobResult |
stopJob(StopJobRequest stopJobRequest)
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Tag resource with tag key and value.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Untag resource with resourceArn.
|
UpdateAppResult |
updateApp(UpdateAppRequest updateAppRequest)
Updates an existing Amplify App.
|
UpdateBranchResult |
updateBranch(UpdateBranchRequest updateBranchRequest)
Updates a branch for an Amplify App.
|
UpdateDomainAssociationResult |
updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
Create a new DomainAssociation on an App
|
UpdateWebhookResult |
updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Update a webhook.
|
static final String ENDPOINT_PREFIX
CreateAppResult createApp(CreateAppRequest createAppRequest)
Creates a new Amplify App.
createAppRequest
- Request structure used to create Apps in Amplify.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.CreateBranchResult createBranch(CreateBranchRequest createBranchRequest)
Creates a new Branch for an Amplify App.
createBranchRequest
- Request structure for a branch create request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.CreateDeploymentResult createDeployment(CreateDeploymentRequest createDeploymentRequest)
Create a deployment for manual deploy apps. (Apps are not connected to repository)
createDeploymentRequest
- Request structure for create a new deployment.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
Create a new DomainAssociation on an App
createDomainAssociationRequest
- Request structure for create Domain Association request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.CreateWebhookResult createWebhook(CreateWebhookRequest createWebhookRequest)
Create a new webhook on an App.
createWebhookRequest
- Request structure for create webhook request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)
Delete an existing Amplify App by appId.
deleteAppRequest
- Request structure for an Amplify App delete request.BadRequestException
- Exception thrown when a request contains unexpected data.NotFoundException
- Exception thrown when an entity has not been found during an operation.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.DeleteBranchResult deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch for an Amplify App.
deleteBranchRequest
- Request structure for delete branch request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
Deletes a DomainAssociation.
deleteDomainAssociationRequest
- Request structure for the delete Domain Association request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)
Delete a job, for an Amplify branch, part of Amplify App.
deleteJobRequest
- Request structure for delete job request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.DeleteWebhookResult deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a webhook.
deleteWebhookRequest
- Request structure for the delete webhook request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.GenerateAccessLogsResult generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
Retrieve website access logs for a specific time range via a pre-signed URL. Optionally, deliver the logs to a given S3 bucket.
generateAccessLogsRequest
- Request structure for the generate access logs request.NotFoundException
- Exception thrown when an entity has not been found during an operation.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.GetAppResult getApp(GetAppRequest getAppRequest)
Retrieves an existing Amplify App by appId.
getAppRequest
- Request structure for get App request.BadRequestException
- Exception thrown when a request contains unexpected data.NotFoundException
- Exception thrown when an entity has not been found during an operation.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.GetArtifactUrlResult getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
Retrieves artifact info that corresponds to a artifactId.
getArtifactUrlRequest
- Request structure for the get artifact request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.GetBranchResult getBranch(GetBranchRequest getBranchRequest)
Retrieves a branch for an Amplify App.
getBranchRequest
- Result structure for get branch request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
Retrieves domain info that corresponds to an appId and domainName.
getDomainAssociationRequest
- Request structure for the get Domain Association request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.GetJobResult getJob(GetJobRequest getJobRequest)
Get a job for a branch, part of an Amplify App.
getJobRequest
- Request structure for get job request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.GetWebhookResult getWebhook(GetWebhookRequest getWebhookRequest)
Retrieves webhook info that corresponds to a webhookId.
getWebhookRequest
- Request structure for the get webhook request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.ListAppsResult listApps(ListAppsRequest listAppsRequest)
Lists existing Amplify Apps.
listAppsRequest
- Request structure for an Amplify App list request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.ListArtifactsResult listArtifacts(ListArtifactsRequest listArtifactsRequest)
List artifacts with an app, a branch, a job and an artifact type.
listArtifactsRequest
- Request structure for the list artifacts request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.ListBranchesResult listBranches(ListBranchesRequest listBranchesRequest)
Lists branches for an Amplify App.
listBranchesRequest
- Request structure for list branches request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
List domains with an app
listDomainAssociationsRequest
- Request structure for the list Domain Associations request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.ListJobsResult listJobs(ListJobsRequest listJobsRequest)
List Jobs for a branch, part of an Amplify App.
listJobsRequest
- Request structure for list job request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for resource.
listTagsForResourceRequest
- Request structure used to list tags for resource.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException
- Exception thrown when a request contains unexpected data.ResourceNotFoundException
- Exception thrown when an operation fails due to non-existent resource.ListWebhooksResult listWebhooks(ListWebhooksRequest listWebhooksRequest)
List webhooks with an app.
listWebhooksRequest
- Request structure for the list webhooks request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.StartDeploymentResult startDeployment(StartDeploymentRequest startDeploymentRequest)
Start a deployment for manual deploy apps. (Apps are not connected to repository)
startDeploymentRequest
- Request structure for start a deployment.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.StartJobResult startJob(StartJobRequest startJobRequest)
Starts a new job for a branch, part of an Amplify App.
startJobRequest
- Request structure for Start job request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.StopJobResult stopJob(StopJobRequest stopJobRequest)
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
stopJobRequest
- Request structure for stop job request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException
- Exception thrown when an entity has not been found during an operation.LimitExceededException
- Exception thrown when a resource could not be created because of service limits.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Tag resource with tag key and value.
tagResourceRequest
- Request structure used to tag resource.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException
- Exception thrown when a request contains unexpected data.ResourceNotFoundException
- Exception thrown when an operation fails due to non-existent resource.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Untag resource with resourceArn.
untagResourceRequest
- Request structure used to untag resource.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException
- Exception thrown when a request contains unexpected data.ResourceNotFoundException
- Exception thrown when an operation fails due to non-existent resource.UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)
Updates an existing Amplify App.
updateAppRequest
- Request structure for update App request.BadRequestException
- Exception thrown when a request contains unexpected data.NotFoundException
- Exception thrown when an entity has not been found during an operation.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.UpdateBranchResult updateBranch(UpdateBranchRequest updateBranchRequest)
Updates a branch for an Amplify App.
updateBranchRequest
- Request structure for update branch request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
Create a new DomainAssociation on an App
updateDomainAssociationRequest
- Request structure for update Domain Association request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.UpdateWebhookResult updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Update a webhook.
updateWebhookRequest
- Request structure for update webhook request.BadRequestException
- Exception thrown when a request contains unexpected data.UnauthorizedException
- Exception thrown when an operation fails due to a lack of access.NotFoundException
- Exception thrown when an entity has not been found during an operation.InternalFailureException
- Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException
- Exception thrown when an operation fails due to a dependent service throwing an exception.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.