@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSAmplify extends Object implements AWSAmplify
AWSAmplify
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
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.
|
public CreateAppResult createApp(CreateAppRequest request)
AWSAmplify
Creates a new Amplify app.
createApp
in interface AWSAmplify
request
- The request structure used to create apps in Amplify.public CreateBackendEnvironmentResult createBackendEnvironment(CreateBackendEnvironmentRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the backend environment create request.public CreateBranchResult createBranch(CreateBranchRequest request)
AWSAmplify
Creates a new branch for an Amplify app.
createBranch
in interface AWSAmplify
request
- The request structure for the create branch request.public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the create a new deployment request.public CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest request)
AWSAmplify
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
createDomainAssociation
in interface AWSAmplify
request
- The request structure for the create domain association request.public CreateWebhookResult createWebhook(CreateWebhookRequest request)
AWSAmplify
Creates a new webhook on an Amplify app.
createWebhook
in interface AWSAmplify
request
- The request structure for the create webhook request.public DeleteAppResult deleteApp(DeleteAppRequest request)
AWSAmplify
Deletes an existing Amplify app specified by an app ID.
deleteApp
in interface AWSAmplify
request
- Describes the request structure for the delete app request.public DeleteBackendEnvironmentResult deleteBackendEnvironment(DeleteBackendEnvironmentRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the delete backend environment request.public DeleteBranchResult deleteBranch(DeleteBranchRequest request)
AWSAmplify
Deletes a branch for an Amplify app.
deleteBranch
in interface AWSAmplify
request
- The request structure for the delete branch request.public DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest request)
AWSAmplify
Deletes a domain association for an Amplify app.
deleteDomainAssociation
in interface AWSAmplify
request
- The request structure for the delete domain association request.public DeleteJobResult deleteJob(DeleteJobRequest request)
AWSAmplify
Deletes a job for a branch of an Amplify app.
deleteJob
in interface AWSAmplify
request
- The request structure for the delete job request.public DeleteWebhookResult deleteWebhook(DeleteWebhookRequest request)
AWSAmplify
Deletes a webhook.
deleteWebhook
in interface AWSAmplify
request
- The request structure for the delete webhook request.public GenerateAccessLogsResult generateAccessLogs(GenerateAccessLogsRequest request)
AWSAmplify
Returns the website access logs for a specific time range using a presigned URL.
generateAccessLogs
in interface AWSAmplify
request
- The request structure for the generate access logs request.public GetAppResult getApp(GetAppRequest request)
AWSAmplify
Returns an existing Amplify app specified by an app ID.
getApp
in interface AWSAmplify
request
- The request structure for the get app request.public GetArtifactUrlResult getArtifactUrl(GetArtifactUrlRequest request)
AWSAmplify
Returns the artifact info that corresponds to an artifact id.
getArtifactUrl
in interface AWSAmplify
request
- Returns the request structure for the get artifact request.public GetBackendEnvironmentResult getBackendEnvironment(GetBackendEnvironmentRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the get backend environment request.public GetBranchResult getBranch(GetBranchRequest request)
AWSAmplify
Returns a branch for an Amplify app.
getBranch
in interface AWSAmplify
request
- The request structure for the get branch request.public GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest request)
AWSAmplify
Returns the domain information for an Amplify app.
getDomainAssociation
in interface AWSAmplify
request
- The request structure for the get domain association request.public GetJobResult getJob(GetJobRequest request)
AWSAmplify
Returns a job for a branch of an Amplify app.
getJob
in interface AWSAmplify
request
- The request structure for the get job request.public GetWebhookResult getWebhook(GetWebhookRequest request)
AWSAmplify
Returns the webhook information that corresponds to a specified webhook ID.
getWebhook
in interface AWSAmplify
request
- The request structure for the get webhook request.public ListAppsResult listApps(ListAppsRequest request)
AWSAmplify
Returns a list of the existing Amplify apps.
listApps
in interface AWSAmplify
request
- The request structure for the list apps request.public ListArtifactsResult listArtifacts(ListArtifactsRequest request)
AWSAmplify
Returns a list of artifacts for a specified app, branch, and job.
listArtifacts
in interface AWSAmplify
request
- Describes the request structure for the list artifacts request.public ListBackendEnvironmentsResult listBackendEnvironments(ListBackendEnvironmentsRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the list backend environments request.public ListBranchesResult listBranches(ListBranchesRequest request)
AWSAmplify
Lists the branches of an Amplify app.
listBranches
in interface AWSAmplify
request
- The request structure for the list branches request.public ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest request)
AWSAmplify
Returns the domain associations for an Amplify app.
listDomainAssociations
in interface AWSAmplify
request
- The request structure for the list domain associations request.public ListJobsResult listJobs(ListJobsRequest request)
AWSAmplify
Lists the jobs for a branch of an Amplify app.
listJobs
in interface AWSAmplify
request
- The request structure for the list jobs request.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSAmplify
Returns a list of tags for a specified Amazon Resource Name (ARN).
listTagsForResource
in interface AWSAmplify
request
- The request structure to use to list tags for a resource.public ListWebhooksResult listWebhooks(ListWebhooksRequest request)
AWSAmplify
Returns a list of webhooks for an Amplify app.
listWebhooks
in interface AWSAmplify
request
- The request structure for the list webhooks request.public StartDeploymentResult startDeployment(StartDeploymentRequest request)
AWSAmplify
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 AWSAmplify
request
- The request structure for the start a deployment request.public StartJobResult startJob(StartJobRequest request)
AWSAmplify
Starts a new job for a branch of an Amplify app.
startJob
in interface AWSAmplify
request
- The request structure for the start job request.public StopJobResult stopJob(StopJobRequest request)
AWSAmplify
Stops a job that is in progress for a branch of an Amplify app.
stopJob
in interface AWSAmplify
request
- The request structure for the stop job request.public TagResourceResult tagResource(TagResourceRequest request)
AWSAmplify
Tags the resource with a tag key and value.
tagResource
in interface AWSAmplify
request
- The request structure to tag a resource with a tag key and value.public UntagResourceResult untagResource(UntagResourceRequest request)
AWSAmplify
Untags a resource with a specified Amazon Resource Name (ARN).
untagResource
in interface AWSAmplify
request
- The request structure for the untag resource request.public UpdateAppResult updateApp(UpdateAppRequest request)
AWSAmplify
Updates an existing Amplify app.
updateApp
in interface AWSAmplify
request
- The request structure for the update app request.public UpdateBranchResult updateBranch(UpdateBranchRequest request)
AWSAmplify
Updates a branch for an Amplify app.
updateBranch
in interface AWSAmplify
request
- The request structure for the update branch request.public UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest request)
AWSAmplify
Creates a new domain association for an Amplify app.
updateDomainAssociation
in interface AWSAmplify
request
- The request structure for the update domain association request.public UpdateWebhookResult updateWebhook(UpdateWebhookRequest request)
AWSAmplify
Updates a webhook.
updateWebhook
in interface AWSAmplify
request
- The request structure for the update webhook request.public void shutdown()
AWSAmplify
shutdown
in interface AWSAmplify
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSAmplify
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.
getCachedResponseMetadata
in interface AWSAmplify
request
- The originally executed request.