@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyAsyncClient extends AwsClient
builder() method.
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static AmplifyAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AmplifyAsyncClient. |
static AmplifyAsyncClient |
create()
Create a
AmplifyAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateAppResponse> |
createApp(Consumer<CreateAppRequest.Builder> createAppRequest)
Creates a new Amplify app.
|
default CompletableFuture<CreateAppResponse> |
createApp(CreateAppRequest createAppRequest)
Creates a new Amplify app.
|
default CompletableFuture<CreateBackendEnvironmentResponse> |
createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
|
default CompletableFuture<CreateBackendEnvironmentResponse> |
createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
|
default CompletableFuture<CreateBranchResponse> |
createBranch(Consumer<CreateBranchRequest.Builder> createBranchRequest)
Creates a new branch for an Amplify app.
|
default CompletableFuture<CreateBranchResponse> |
createBranch(CreateBranchRequest createBranchRequest)
Creates a new branch for an Amplify app.
|
default CompletableFuture<CreateDeploymentResponse> |
createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
Creates a deployment for a manually deployed Amplify app.
|
default CompletableFuture<CreateDeploymentResponse> |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a deployment for a manually deployed Amplify app.
|
default CompletableFuture<CreateDomainAssociationResponse> |
createDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest)
Creates a new domain association for an Amplify app.
|
default CompletableFuture<CreateDomainAssociationResponse> |
createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
Creates a new domain association for an Amplify app.
|
default CompletableFuture<CreateWebhookResponse> |
createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)
Creates a new webhook on an Amplify app.
|
default CompletableFuture<CreateWebhookResponse> |
createWebhook(CreateWebhookRequest createWebhookRequest)
Creates a new webhook on an Amplify app.
|
default CompletableFuture<DeleteAppResponse> |
deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
Deletes an existing Amplify app specified by an app ID.
|
default CompletableFuture<DeleteAppResponse> |
deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an existing Amplify app specified by an app ID.
|
default CompletableFuture<DeleteBackendEnvironmentResponse> |
deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
|
default CompletableFuture<DeleteBackendEnvironmentResponse> |
deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
|
default CompletableFuture<DeleteBranchResponse> |
deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)
Deletes a branch for an Amplify app.
|
default CompletableFuture<DeleteBranchResponse> |
deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch for an Amplify app.
|
default CompletableFuture<DeleteDomainAssociationResponse> |
deleteDomainAssociation(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest)
Deletes a domain association for an Amplify app.
|
default CompletableFuture<DeleteDomainAssociationResponse> |
deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
Deletes a domain association for an Amplify app.
|
default CompletableFuture<DeleteJobResponse> |
deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)
Deletes a job for a branch of an Amplify app.
|
default CompletableFuture<DeleteJobResponse> |
deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job for a branch of an Amplify app.
|
default CompletableFuture<DeleteWebhookResponse> |
deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a webhook.
|
default CompletableFuture<DeleteWebhookResponse> |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a webhook.
|
default CompletableFuture<GenerateAccessLogsResponse> |
generateAccessLogs(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest)
Returns the website access logs for a specific time range using a presigned URL.
|
default CompletableFuture<GenerateAccessLogsResponse> |
generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
Returns the website access logs for a specific time range using a presigned URL.
|
default CompletableFuture<GetAppResponse> |
getApp(Consumer<GetAppRequest.Builder> getAppRequest)
Returns an existing Amplify app by appID.
|
default CompletableFuture<GetAppResponse> |
getApp(GetAppRequest getAppRequest)
Returns an existing Amplify app by appID.
|
default CompletableFuture<GetArtifactUrlResponse> |
getArtifactUrl(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest)
Returns the artifact info that corresponds to an artifact id.
|
default CompletableFuture<GetArtifactUrlResponse> |
getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
Returns the artifact info that corresponds to an artifact id.
|
default CompletableFuture<GetBackendEnvironmentResponse> |
getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
|
default CompletableFuture<GetBackendEnvironmentResponse> |
getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
|
default CompletableFuture<GetBranchResponse> |
getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)
Returns a branch for an Amplify app.
|
default CompletableFuture<GetBranchResponse> |
getBranch(GetBranchRequest getBranchRequest)
Returns a branch for an Amplify app.
|
default CompletableFuture<GetDomainAssociationResponse> |
getDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest)
Returns the domain information for an Amplify app.
|
default CompletableFuture<GetDomainAssociationResponse> |
getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
Returns the domain information for an Amplify app.
|
default CompletableFuture<GetJobResponse> |
getJob(Consumer<GetJobRequest.Builder> getJobRequest)
Returns a job for a branch of an Amplify app.
|
default CompletableFuture<GetJobResponse> |
getJob(GetJobRequest getJobRequest)
Returns a job for a branch of an Amplify app.
|
default CompletableFuture<GetWebhookResponse> |
getWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest)
Returns the webhook information that corresponds to a specified webhook ID.
|
default CompletableFuture<GetWebhookResponse> |
getWebhook(GetWebhookRequest getWebhookRequest)
Returns the webhook information that corresponds to a specified webhook ID.
|
default CompletableFuture<ListAppsResponse> |
listApps()
Returns a list of the existing Amplify apps.
|
default CompletableFuture<ListAppsResponse> |
listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)
Returns a list of the existing Amplify apps.
|
default CompletableFuture<ListAppsResponse> |
listApps(ListAppsRequest listAppsRequest)
Returns a list of the existing Amplify apps.
|
default CompletableFuture<ListArtifactsResponse> |
listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)
Returns a list of artifacts for a specified app, branch, and job.
|
default CompletableFuture<ListArtifactsResponse> |
listArtifacts(ListArtifactsRequest listArtifactsRequest)
Returns a list of artifacts for a specified app, branch, and job.
|
default CompletableFuture<ListBackendEnvironmentsResponse> |
listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
|
default CompletableFuture<ListBackendEnvironmentsResponse> |
listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
|
default CompletableFuture<ListBranchesResponse> |
listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Lists the branches of an Amplify app.
|
default CompletableFuture<ListBranchesResponse> |
listBranches(ListBranchesRequest listBranchesRequest)
Lists the branches of an Amplify app.
|
default CompletableFuture<ListDomainAssociationsResponse> |
listDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
|
default CompletableFuture<ListDomainAssociationsResponse> |
listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
|
default CompletableFuture<ListJobsResponse> |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists the jobs for a branch of an Amplify app.
|
default CompletableFuture<ListJobsResponse> |
listJobs(ListJobsRequest listJobsRequest)
Lists the jobs for a branch of an Amplify app.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
|
default CompletableFuture<ListWebhooksResponse> |
listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Returns a list of webhooks for an Amplify app.
|
default CompletableFuture<ListWebhooksResponse> |
listWebhooks(ListWebhooksRequest listWebhooksRequest)
Returns a list of webhooks for an Amplify app.
|
default AmplifyServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartDeploymentResponse> |
startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest)
Starts a deployment for a manually deployed app.
|
default CompletableFuture<StartDeploymentResponse> |
startDeployment(StartDeploymentRequest startDeploymentRequest)
Starts a deployment for a manually deployed app.
|
default CompletableFuture<StartJobResponse> |
startJob(Consumer<StartJobRequest.Builder> startJobRequest)
Starts a new job for a branch of an Amplify app.
|
default CompletableFuture<StartJobResponse> |
startJob(StartJobRequest startJobRequest)
Starts a new job for a branch of an Amplify app.
|
default CompletableFuture<StopJobResponse> |
stopJob(Consumer<StopJobRequest.Builder> stopJobRequest)
Stops a job that is in progress for a branch of an Amplify app.
|
default CompletableFuture<StopJobResponse> |
stopJob(StopJobRequest stopJobRequest)
Stops a job that is in progress for a branch of an Amplify app.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags the resource with a tag key and value.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Tags the resource with a tag key and value.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
|
default CompletableFuture<UpdateAppResponse> |
updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)
Updates an existing Amplify app.
|
default CompletableFuture<UpdateAppResponse> |
updateApp(UpdateAppRequest updateAppRequest)
Updates an existing Amplify app.
|
default CompletableFuture<UpdateBranchResponse> |
updateBranch(Consumer<UpdateBranchRequest.Builder> updateBranchRequest)
Updates a branch for an Amplify app.
|
default CompletableFuture<UpdateBranchResponse> |
updateBranch(UpdateBranchRequest updateBranchRequest)
Updates a branch for an Amplify app.
|
default CompletableFuture<UpdateDomainAssociationResponse> |
updateDomainAssociation(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest)
Creates a new domain association for an Amplify app.
|
default CompletableFuture<UpdateDomainAssociationResponse> |
updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
Creates a new domain association for an Amplify app.
|
default CompletableFuture<UpdateWebhookResponse> |
updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)
Updates a webhook.
|
default CompletableFuture<UpdateWebhookResponse> |
updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Updates a webhook.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateAppResponse> createApp(CreateAppRequest createAppRequest)
Creates a new Amplify app.
createAppRequest - The request structure used to create apps in Amplify.default CompletableFuture<CreateAppResponse> createApp(Consumer<CreateAppRequest.Builder> createAppRequest)
Creates a new Amplify app.
This is a convenience which creates an instance of the CreateAppRequest.Builder avoiding the need to
create one manually via CreateAppRequest.builder()
createAppRequest - A Consumer that will call methods on CreateAppRequest.Builder to create a request. The
request structure used to create apps in Amplify.default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
createBackendEnvironmentRequest - The request structure for the backend environment create request.default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
This is a convenience which creates an instance of the CreateBackendEnvironmentRequest.Builder avoiding
the need to create one manually via CreateBackendEnvironmentRequest.builder()
createBackendEnvironmentRequest - A Consumer that will call methods on CreateBackendEnvironmentRequest.Builder to create a
request. The request structure for the backend environment create request.default CompletableFuture<CreateBranchResponse> createBranch(CreateBranchRequest createBranchRequest)
Creates a new branch for an Amplify app.
createBranchRequest - The request structure for the create branch request.default CompletableFuture<CreateBranchResponse> createBranch(Consumer<CreateBranchRequest.Builder> createBranchRequest)
Creates a new branch for an Amplify app.
This is a convenience which creates an instance of the CreateBranchRequest.Builder avoiding the need to
create one manually via CreateBranchRequest.builder()
createBranchRequest - A Consumer that will call methods on CreateBranchRequest.Builder to create a request. The
request structure for the create branch request.default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
createDeploymentRequest - The request structure for the create a new deployment request.default CompletableFuture<CreateDeploymentResponse> createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)
Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
This is a convenience which creates an instance of the CreateDeploymentRequest.Builder avoiding the need
to create one manually via CreateDeploymentRequest.builder()
createDeploymentRequest - A Consumer that will call methods on CreateDeploymentRequest.Builder to create a request.
The request structure for the create a new deployment request.default CompletableFuture<CreateDomainAssociationResponse> createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
createDomainAssociationRequest - The request structure for the create domain association request.default CompletableFuture<CreateDomainAssociationResponse> createDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest)
Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
This is a convenience which creates an instance of the CreateDomainAssociationRequest.Builder avoiding
the need to create one manually via CreateDomainAssociationRequest.builder()
createDomainAssociationRequest - A Consumer that will call methods on CreateDomainAssociationRequest.Builder to create a
request. The request structure for the create domain association request.default CompletableFuture<CreateWebhookResponse> createWebhook(CreateWebhookRequest createWebhookRequest)
Creates a new webhook on an Amplify app.
createWebhookRequest - The request structure for the create webhook request.default CompletableFuture<CreateWebhookResponse> createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)
Creates a new webhook on an Amplify app.
This is a convenience which creates an instance of the CreateWebhookRequest.Builder avoiding the need to
create one manually via CreateWebhookRequest.builder()
createWebhookRequest - A Consumer that will call methods on CreateWebhookRequest.Builder to create a request. The
request structure for the create webhook request.default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)
Deletes an existing Amplify app specified by an app ID.
deleteAppRequest - Describes the request structure for the delete app request.default CompletableFuture<DeleteAppResponse> deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
Deletes an existing Amplify app specified by an app ID.
This is a convenience which creates an instance of the DeleteAppRequest.Builder avoiding the need to
create one manually via DeleteAppRequest.builder()
deleteAppRequest - A Consumer that will call methods on DeleteAppRequest.Builder to create a request.
Describes the request structure for the delete app request.default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
deleteBackendEnvironmentRequest - The request structure for the delete backend environment request.default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
This is a convenience which creates an instance of the DeleteBackendEnvironmentRequest.Builder avoiding
the need to create one manually via DeleteBackendEnvironmentRequest.builder()
deleteBackendEnvironmentRequest - A Consumer that will call methods on DeleteBackendEnvironmentRequest.Builder to create a
request. The request structure for the delete backend environment request.default CompletableFuture<DeleteBranchResponse> deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch for an Amplify app.
deleteBranchRequest - The request structure for the delete branch request.default CompletableFuture<DeleteBranchResponse> deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)
Deletes a branch for an Amplify app.
This is a convenience which creates an instance of the DeleteBranchRequest.Builder avoiding the need to
create one manually via DeleteBranchRequest.builder()
deleteBranchRequest - A Consumer that will call methods on DeleteBranchRequest.Builder to create a request. The
request structure for the delete branch request.default CompletableFuture<DeleteDomainAssociationResponse> deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
Deletes a domain association for an Amplify app.
deleteDomainAssociationRequest - The request structure for the delete domain association request.default CompletableFuture<DeleteDomainAssociationResponse> deleteDomainAssociation(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest)
Deletes a domain association for an Amplify app.
This is a convenience which creates an instance of the DeleteDomainAssociationRequest.Builder avoiding
the need to create one manually via DeleteDomainAssociationRequest.builder()
deleteDomainAssociationRequest - A Consumer that will call methods on DeleteDomainAssociationRequest.Builder to create a
request. The request structure for the delete domain association request.default CompletableFuture<DeleteJobResponse> deleteJob(DeleteJobRequest deleteJobRequest)
Deletes a job for a branch of an Amplify app.
deleteJobRequest - The request structure for the delete job request.default CompletableFuture<DeleteJobResponse> deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)
Deletes a job for a branch of an Amplify app.
This is a convenience which creates an instance of the DeleteJobRequest.Builder avoiding the need to
create one manually via DeleteJobRequest.builder()
deleteJobRequest - A Consumer that will call methods on DeleteJobRequest.Builder to create a request. The
request structure for the delete job request.default CompletableFuture<DeleteWebhookResponse> deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
Deletes a webhook.
deleteWebhookRequest - The request structure for the delete webhook request.default CompletableFuture<DeleteWebhookResponse> deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a webhook.
This is a convenience which creates an instance of the DeleteWebhookRequest.Builder avoiding the need to
create one manually via DeleteWebhookRequest.builder()
deleteWebhookRequest - A Consumer that will call methods on DeleteWebhookRequest.Builder to create a request. The
request structure for the delete webhook request.default CompletableFuture<GenerateAccessLogsResponse> generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
Returns the website access logs for a specific time range using a presigned URL.
generateAccessLogsRequest - The request structure for the generate access logs request.default CompletableFuture<GenerateAccessLogsResponse> generateAccessLogs(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest)
Returns the website access logs for a specific time range using a presigned URL.
This is a convenience which creates an instance of the GenerateAccessLogsRequest.Builder avoiding the
need to create one manually via GenerateAccessLogsRequest.builder()
generateAccessLogsRequest - A Consumer that will call methods on GenerateAccessLogsRequest.Builder to create a
request. The request structure for the generate access logs request.default CompletableFuture<GetAppResponse> getApp(GetAppRequest getAppRequest)
Returns an existing Amplify app by appID.
getAppRequest - The request structure for the get app request.default CompletableFuture<GetAppResponse> getApp(Consumer<GetAppRequest.Builder> getAppRequest)
Returns an existing Amplify app by appID.
This is a convenience which creates an instance of the GetAppRequest.Builder avoiding the need to create
one manually via GetAppRequest.builder()
getAppRequest - A Consumer that will call methods on GetAppRequest.Builder to create a request. The
request structure for the get app request.default CompletableFuture<GetArtifactUrlResponse> getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
Returns the artifact info that corresponds to an artifact id.
getArtifactUrlRequest - Returns the request structure for the get artifact request.default CompletableFuture<GetArtifactUrlResponse> getArtifactUrl(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest)
Returns the artifact info that corresponds to an artifact id.
This is a convenience which creates an instance of the GetArtifactUrlRequest.Builder avoiding the need to
create one manually via GetArtifactUrlRequest.builder()
getArtifactUrlRequest - A Consumer that will call methods on GetArtifactUrlRequest.Builder to create a request.
Returns the request structure for the get artifact request.default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
getBackendEnvironmentRequest - The request structure for the get backend environment request.default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
This is a convenience which creates an instance of the GetBackendEnvironmentRequest.Builder avoiding the
need to create one manually via GetBackendEnvironmentRequest.builder()
getBackendEnvironmentRequest - A Consumer that will call methods on GetBackendEnvironmentRequest.Builder to create a
request. The request structure for the get backend environment request.default CompletableFuture<GetBranchResponse> getBranch(GetBranchRequest getBranchRequest)
Returns a branch for an Amplify app.
getBranchRequest - The request structure for the get branch request.default CompletableFuture<GetBranchResponse> getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)
Returns a branch for an Amplify app.
This is a convenience which creates an instance of the GetBranchRequest.Builder avoiding the need to
create one manually via GetBranchRequest.builder()
getBranchRequest - A Consumer that will call methods on GetBranchRequest.Builder to create a request. The
request structure for the get branch request.default CompletableFuture<GetDomainAssociationResponse> getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
Returns the domain information for an Amplify app.
getDomainAssociationRequest - The request structure for the get domain association request.default CompletableFuture<GetDomainAssociationResponse> getDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest)
Returns the domain information for an Amplify app.
This is a convenience which creates an instance of the GetDomainAssociationRequest.Builder avoiding the
need to create one manually via GetDomainAssociationRequest.builder()
getDomainAssociationRequest - A Consumer that will call methods on GetDomainAssociationRequest.Builder to create a
request. The request structure for the get domain association request.default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)
Returns a job for a branch of an Amplify app.
getJobRequest - The request structure for the get job request.default CompletableFuture<GetJobResponse> getJob(Consumer<GetJobRequest.Builder> getJobRequest)
Returns a job for a branch of an Amplify app.
This is a convenience which creates an instance of the GetJobRequest.Builder avoiding the need to create
one manually via GetJobRequest.builder()
getJobRequest - A Consumer that will call methods on GetJobRequest.Builder to create a request. The
request structure for the get job request.default CompletableFuture<GetWebhookResponse> getWebhook(GetWebhookRequest getWebhookRequest)
Returns the webhook information that corresponds to a specified webhook ID.
getWebhookRequest - The request structure for the get webhook request.default CompletableFuture<GetWebhookResponse> getWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest)
Returns the webhook information that corresponds to a specified webhook ID.
This is a convenience which creates an instance of the GetWebhookRequest.Builder avoiding the need to
create one manually via GetWebhookRequest.builder()
getWebhookRequest - A Consumer that will call methods on GetWebhookRequest.Builder to create a request. The
request structure for the get webhook request.default CompletableFuture<ListAppsResponse> listApps(ListAppsRequest listAppsRequest)
Returns a list of the existing Amplify apps.
listAppsRequest - The request structure for the list apps request.default CompletableFuture<ListAppsResponse> listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)
Returns a list of the existing Amplify apps.
This is a convenience which creates an instance of the ListAppsRequest.Builder avoiding the need to
create one manually via ListAppsRequest.builder()
listAppsRequest - A Consumer that will call methods on ListAppsRequest.Builder to create a request. The
request structure for the list apps request.default CompletableFuture<ListAppsResponse> listApps()
Returns a list of the existing Amplify apps.
default CompletableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest listArtifactsRequest)
Returns a list of artifacts for a specified app, branch, and job.
listArtifactsRequest - Describes the request structure for the list artifacts request.default CompletableFuture<ListArtifactsResponse> listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)
Returns a list of artifacts for a specified app, branch, and job.
This is a convenience which creates an instance of the ListArtifactsRequest.Builder avoiding the need to
create one manually via ListArtifactsRequest.builder()
listArtifactsRequest - A Consumer that will call methods on ListArtifactsRequest.Builder to create a request.
Describes the request structure for the list artifacts request.default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
listBackendEnvironmentsRequest - The request structure for the list backend environments request.default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
This is a convenience which creates an instance of the ListBackendEnvironmentsRequest.Builder avoiding
the need to create one manually via ListBackendEnvironmentsRequest.builder()
listBackendEnvironmentsRequest - A Consumer that will call methods on ListBackendEnvironmentsRequest.Builder to create a
request. The request structure for the list backend environments request.default CompletableFuture<ListBranchesResponse> listBranches(ListBranchesRequest listBranchesRequest)
Lists the branches of an Amplify app.
listBranchesRequest - The request structure for the list branches request.default CompletableFuture<ListBranchesResponse> listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Lists the branches of an Amplify app.
This is a convenience which creates an instance of the ListBranchesRequest.Builder avoiding the need to
create one manually via ListBranchesRequest.builder()
listBranchesRequest - A Consumer that will call methods on ListBranchesRequest.Builder to create a request. The
request structure for the list branches request.default CompletableFuture<ListDomainAssociationsResponse> listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
listDomainAssociationsRequest - The request structure for the list domain associations request.default CompletableFuture<ListDomainAssociationsResponse> listDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
This is a convenience which creates an instance of the ListDomainAssociationsRequest.Builder avoiding the
need to create one manually via ListDomainAssociationsRequest.builder()
listDomainAssociationsRequest - A Consumer that will call methods on ListDomainAssociationsRequest.Builder to create a
request. The request structure for the list domain associations request.default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)
Lists the jobs for a branch of an Amplify app.
listJobsRequest - The request structure for the list jobs request.default CompletableFuture<ListJobsResponse> listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists the jobs for a branch of an Amplify app.
This is a convenience which creates an instance of the ListJobsRequest.Builder avoiding the need to
create one manually via ListJobsRequest.builder()
listJobsRequest - A Consumer that will call methods on ListJobsRequest.Builder to create a request. The
request structure for the list jobs request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
listTagsForResourceRequest - The request structure to use to list tags for a resource.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags for a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request. The request structure to use to list tags for a resource.default CompletableFuture<ListWebhooksResponse> listWebhooks(ListWebhooksRequest listWebhooksRequest)
Returns a list of webhooks for an Amplify app.
listWebhooksRequest - The request structure for the list webhooks request.default CompletableFuture<ListWebhooksResponse> listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
Returns a list of webhooks for an Amplify app.
This is a convenience which creates an instance of the ListWebhooksRequest.Builder avoiding the need to
create one manually via ListWebhooksRequest.builder()
listWebhooksRequest - A Consumer that will call methods on ListWebhooksRequest.Builder to create a request. The
request structure for the list webhooks request.default CompletableFuture<StartDeploymentResponse> startDeployment(StartDeploymentRequest startDeploymentRequest)
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
startDeploymentRequest - The request structure for the start a deployment request.default CompletableFuture<StartDeploymentResponse> startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest)
Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
This is a convenience which creates an instance of the StartDeploymentRequest.Builder avoiding the need
to create one manually via StartDeploymentRequest.builder()
startDeploymentRequest - A Consumer that will call methods on StartDeploymentRequest.Builder to create a request.
The request structure for the start a deployment request.default CompletableFuture<StartJobResponse> startJob(StartJobRequest startJobRequest)
Starts a new job for a branch of an Amplify app.
startJobRequest - The request structure for the start job request.default CompletableFuture<StartJobResponse> startJob(Consumer<StartJobRequest.Builder> startJobRequest)
Starts a new job for a branch of an Amplify app.
This is a convenience which creates an instance of the StartJobRequest.Builder avoiding the need to
create one manually via StartJobRequest.builder()
startJobRequest - A Consumer that will call methods on StartJobRequest.Builder to create a request. The
request structure for the start job request.default CompletableFuture<StopJobResponse> stopJob(StopJobRequest stopJobRequest)
Stops a job that is in progress for a branch of an Amplify app.
stopJobRequest - The request structure for the stop job request.default CompletableFuture<StopJobResponse> stopJob(Consumer<StopJobRequest.Builder> stopJobRequest)
Stops a job that is in progress for a branch of an Amplify app.
This is a convenience which creates an instance of the StopJobRequest.Builder avoiding the need to create
one manually via StopJobRequest.builder()
stopJobRequest - A Consumer that will call methods on StopJobRequest.Builder to create a request. The
request structure for the stop job request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags the resource with a tag key and value.
tagResourceRequest - The request structure to tag a resource with a tag key and value.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags the resource with a tag key and value.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. The
request structure to tag a resource with a tag key and value.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
untagResourceRequest - The request structure for the untag resource request.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untags a resource with a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. The
request structure for the untag resource request.default CompletableFuture<UpdateAppResponse> updateApp(UpdateAppRequest updateAppRequest)
Updates an existing Amplify app.
updateAppRequest - The request structure for the update app request.default CompletableFuture<UpdateAppResponse> updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)
Updates an existing Amplify app.
This is a convenience which creates an instance of the UpdateAppRequest.Builder avoiding the need to
create one manually via UpdateAppRequest.builder()
updateAppRequest - A Consumer that will call methods on UpdateAppRequest.Builder to create a request. The
request structure for the update app request.default CompletableFuture<UpdateBranchResponse> updateBranch(UpdateBranchRequest updateBranchRequest)
Updates a branch for an Amplify app.
updateBranchRequest - The request structure for the update branch request.default CompletableFuture<UpdateBranchResponse> updateBranch(Consumer<UpdateBranchRequest.Builder> updateBranchRequest)
Updates a branch for an Amplify app.
This is a convenience which creates an instance of the UpdateBranchRequest.Builder avoiding the need to
create one manually via UpdateBranchRequest.builder()
updateBranchRequest - A Consumer that will call methods on UpdateBranchRequest.Builder to create a request. The
request structure for the update branch request.default CompletableFuture<UpdateDomainAssociationResponse> updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
Creates a new domain association for an Amplify app.
updateDomainAssociationRequest - The request structure for the update domain association request.default CompletableFuture<UpdateDomainAssociationResponse> updateDomainAssociation(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest)
Creates a new domain association for an Amplify app.
This is a convenience which creates an instance of the UpdateDomainAssociationRequest.Builder avoiding
the need to create one manually via UpdateDomainAssociationRequest.builder()
updateDomainAssociationRequest - A Consumer that will call methods on UpdateDomainAssociationRequest.Builder to create a
request. The request structure for the update domain association request.default CompletableFuture<UpdateWebhookResponse> updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Updates a webhook.
updateWebhookRequest - The request structure for the update webhook request.default CompletableFuture<UpdateWebhookResponse> updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)
Updates a webhook.
This is a convenience which creates an instance of the UpdateWebhookRequest.Builder avoiding the need to
create one manually via UpdateWebhookRequest.builder()
updateWebhookRequest - A Consumer that will call methods on UpdateWebhookRequest.Builder to create a request. The
request structure for the update webhook request.default AmplifyServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic AmplifyAsyncClient create()
AmplifyAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AmplifyAsyncClientBuilder builder()
AmplifyAsyncClient.Copyright © 2023. All rights reserved.