Interface AmplifyAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AmplifyAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAmplifyAsyncClient
.static AmplifyAsyncClient
create()
Create aAmplifyAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAppResponse> createApp
(Consumer<CreateAppRequest.Builder> createAppRequest) Creates a new Amplify app.default CompletableFuture
<CreateAppResponse> createApp
(CreateAppRequest createAppRequest) Creates a new Amplify app.createBackendEnvironment
(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest) Creates a new backend environment for an Amplify app.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.createDeployment
(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest) Creates a deployment for a manually deployed Amplify app.createDeployment
(CreateDeploymentRequest createDeploymentRequest) Creates a deployment for a manually deployed Amplify app.createDomainAssociation
(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest) Creates a new domain association for an Amplify app.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.deleteBackendEnvironment
(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest) Deletes a backend environment for an Amplify app.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.deleteDomainAssociation
(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest) Deletes a domain association for an Amplify app.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.generateAccessLogs
(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest) Returns the website access logs for a specific time range using a presigned URL.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 specified by an app ID.default CompletableFuture
<GetAppResponse> getApp
(GetAppRequest getAppRequest) Returns an existing Amplify app specified by an app ID.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.getBackendEnvironment
(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest) Returns a backend environment for an Amplify app.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.getDomainAssociation
(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest) Returns the domain information for an Amplify app.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 ListAppsPublisher
This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.default ListAppsPublisher
listAppsPaginator
(Consumer<ListAppsRequest.Builder> listAppsRequest) This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.default ListAppsPublisher
listAppsPaginator
(ListAppsRequest listAppsRequest) This is a variant oflistApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.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.listBackendEnvironments
(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest) Lists the backend environments for an Amplify app.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 ListBranchesPublisher
listBranchesPaginator
(Consumer<ListBranchesRequest.Builder> listBranchesRequest) This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.default ListBranchesPublisher
listBranchesPaginator
(ListBranchesRequest listBranchesRequest) This is a variant oflistBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.listDomainAssociations
(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) Returns the domain associations for an Amplify app.listDomainAssociations
(ListDomainAssociationsRequest listDomainAssociationsRequest) Returns the domain associations for an Amplify app.default ListDomainAssociationsPublisher
listDomainAssociationsPaginator
(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.default ListDomainAssociationsPublisher
listDomainAssociationsPaginator
(ListDomainAssociationsRequest listDomainAssociationsRequest) This is a variant oflistDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.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 ListJobsPublisher
listJobsPaginator
(Consumer<ListJobsRequest.Builder> listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.default ListJobsPublisher
listJobsPaginator
(ListJobsRequest listJobsRequest) This is a variant oflistJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault 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.updateDomainAssociation
(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest) Creates a new domain association for an Amplify app.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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createApp
Creates a new Amplify app.
- Parameters:
createAppRequest
- The request structure used to create apps in Amplify.- Returns:
- A Java Future containing the result of the CreateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createApp
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 viaCreateAppRequest.builder()
- Parameters:
createAppRequest
- AConsumer
that will call methods onCreateAppRequest.Builder
to create a request. The request structure used to create apps in Amplify.- Returns:
- A Java Future containing the result of the CreateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendEnvironment
default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest) 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 applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
createBackendEnvironmentRequest
- The request structure for the backend environment create request.- Returns:
- A Java Future containing the result of the CreateBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendEnvironment
default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest) 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 applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
CreateBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateBackendEnvironmentRequest.builder()
- Parameters:
createBackendEnvironmentRequest
- AConsumer
that will call methods onCreateBackendEnvironmentRequest.Builder
to create a request. The request structure for the backend environment create request.- Returns:
- A Java Future containing the result of the CreateBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBranch
default CompletableFuture<CreateBranchResponse> createBranch(CreateBranchRequest createBranchRequest) Creates a new branch for an Amplify app.
- Parameters:
createBranchRequest
- The request structure for the create branch request.- Returns:
- A Java Future containing the result of the CreateBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBranch
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 viaCreateBranchRequest.builder()
- Parameters:
createBranchRequest
- AConsumer
that will call methods onCreateBranchRequest.Builder
to create a request. The request structure for the create branch request.- Returns:
- A Java Future containing the result of the CreateBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
default CompletableFuture<CreateDeploymentResponse> createDeployment(CreateDeploymentRequest createDeploymentRequest) 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 theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.- Parameters:
createDeploymentRequest
- The request structure for the create a new deployment request.- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDeployment
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.
The maximum duration between the
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builder
avoiding the need to create one manually viaCreateDeploymentRequest.builder()
- Parameters:
createDeploymentRequest
- AConsumer
that will call methods onCreateDeploymentRequest.Builder
to create a request. The request structure for the create a new deployment request.- Returns:
- A Java Future containing the result of the CreateDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainAssociation
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
- Parameters:
createDomainAssociationRequest
- The request structure for the create domain association request.- Returns:
- A Java Future containing the result of the CreateDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainAssociation
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 viaCreateDomainAssociationRequest.builder()
- Parameters:
createDomainAssociationRequest
- AConsumer
that will call methods onCreateDomainAssociationRequest.Builder
to create a request. The request structure for the create domain association request.- Returns:
- A Java Future containing the result of the CreateDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWebhook
default CompletableFuture<CreateWebhookResponse> createWebhook(CreateWebhookRequest createWebhookRequest) Creates a new webhook on an Amplify app.
- Parameters:
createWebhookRequest
- The request structure for the create webhook request.- Returns:
- A Java Future containing the result of the CreateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWebhook
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 viaCreateWebhookRequest.builder()
- Parameters:
createWebhookRequest
- AConsumer
that will call methods onCreateWebhookRequest.Builder
to create a request. The request structure for the create webhook request.- Returns:
- A Java Future containing the result of the CreateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApp
Deletes an existing Amplify app specified by an app ID.
- Parameters:
deleteAppRequest
- Describes the request structure for the delete app request.- Returns:
- A Java Future containing the result of the DeleteApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteApp
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 viaDeleteAppRequest.builder()
- Parameters:
deleteAppRequest
- AConsumer
that will call methods onDeleteAppRequest.Builder
to create a request. Describes the request structure for the delete app request.- Returns:
- A Java Future containing the result of the DeleteApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendEnvironment
default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest) Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
deleteBackendEnvironmentRequest
- The request structure for the delete backend environment request.- Returns:
- A Java Future containing the result of the DeleteBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendEnvironment
default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest) Deletes a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
DeleteBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteBackendEnvironmentRequest.builder()
- Parameters:
deleteBackendEnvironmentRequest
- AConsumer
that will call methods onDeleteBackendEnvironmentRequest.Builder
to create a request. The request structure for the delete backend environment request.- Returns:
- A Java Future containing the result of the DeleteBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBranch
default CompletableFuture<DeleteBranchResponse> deleteBranch(DeleteBranchRequest deleteBranchRequest) Deletes a branch for an Amplify app.
- Parameters:
deleteBranchRequest
- The request structure for the delete branch request.- Returns:
- A Java Future containing the result of the DeleteBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBranch
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 viaDeleteBranchRequest.builder()
- Parameters:
deleteBranchRequest
- AConsumer
that will call methods onDeleteBranchRequest.Builder
to create a request. The request structure for the delete branch request.- Returns:
- A Java Future containing the result of the DeleteBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainAssociation
default CompletableFuture<DeleteDomainAssociationResponse> deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest) Deletes a domain association for an Amplify app.
- Parameters:
deleteDomainAssociationRequest
- The request structure for the delete domain association request.- Returns:
- A Java Future containing the result of the DeleteDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainAssociation
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 viaDeleteDomainAssociationRequest.builder()
- Parameters:
deleteDomainAssociationRequest
- AConsumer
that will call methods onDeleteDomainAssociationRequest.Builder
to create a request. The request structure for the delete domain association request.- Returns:
- A Java Future containing the result of the DeleteDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteJob
Deletes a job for a branch of an Amplify app.
- Parameters:
deleteJobRequest
- The request structure for the delete job request.- Returns:
- A Java Future containing the result of the DeleteJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteJob
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 viaDeleteJobRequest.builder()
- Parameters:
deleteJobRequest
- AConsumer
that will call methods onDeleteJobRequest.Builder
to create a request. The request structure for the delete job request.- Returns:
- A Java Future containing the result of the DeleteJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWebhook
default CompletableFuture<DeleteWebhookResponse> deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) Deletes a webhook.
- Parameters:
deleteWebhookRequest
- The request structure for the delete webhook request.- Returns:
- A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteWebhook
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 viaDeleteWebhookRequest.builder()
- Parameters:
deleteWebhookRequest
- AConsumer
that will call methods onDeleteWebhookRequest.Builder
to create a request. The request structure for the delete webhook request.- Returns:
- A Java Future containing the result of the DeleteWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateAccessLogs
default CompletableFuture<GenerateAccessLogsResponse> generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest) Returns the website access logs for a specific time range using a presigned URL.
- Parameters:
generateAccessLogsRequest
- The request structure for the generate access logs request.- Returns:
- A Java Future containing the result of the GenerateAccessLogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateAccessLogs
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 viaGenerateAccessLogsRequest.builder()
- Parameters:
generateAccessLogsRequest
- AConsumer
that will call methods onGenerateAccessLogsRequest.Builder
to create a request. The request structure for the generate access logs request.- Returns:
- A Java Future containing the result of the GenerateAccessLogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApp
Returns an existing Amplify app specified by an app ID.
- Parameters:
getAppRequest
- The request structure for the get app request.- Returns:
- A Java Future containing the result of the GetApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApp
Returns an existing Amplify app specified by an app ID.
This is a convenience which creates an instance of the
GetAppRequest.Builder
avoiding the need to create one manually viaGetAppRequest.builder()
- Parameters:
getAppRequest
- AConsumer
that will call methods onGetAppRequest.Builder
to create a request. The request structure for the get app request.- Returns:
- A Java Future containing the result of the GetApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArtifactUrl
default CompletableFuture<GetArtifactUrlResponse> getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest) Returns the artifact info that corresponds to an artifact id.
- Parameters:
getArtifactUrlRequest
- Returns the request structure for the get artifact request.- Returns:
- A Java Future containing the result of the GetArtifactUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getArtifactUrl
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 viaGetArtifactUrlRequest.builder()
- Parameters:
getArtifactUrlRequest
- AConsumer
that will call methods onGetArtifactUrlRequest.Builder
to create a request. Returns the request structure for the get artifact request.- Returns:
- A Java Future containing the result of the GetArtifactUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendEnvironment
default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest) Returns a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
getBackendEnvironmentRequest
- The request structure for the get backend environment request.- Returns:
- A Java Future containing the result of the GetBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendEnvironment
default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest) Returns a backend environment for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
GetBackendEnvironmentRequest.Builder
avoiding the need to create one manually viaGetBackendEnvironmentRequest.builder()
- Parameters:
getBackendEnvironmentRequest
- AConsumer
that will call methods onGetBackendEnvironmentRequest.Builder
to create a request. The request structure for the get backend environment request.- Returns:
- A Java Future containing the result of the GetBackendEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBranch
Returns a branch for an Amplify app.
- Parameters:
getBranchRequest
- The request structure for the get branch request.- Returns:
- A Java Future containing the result of the GetBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBranch
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 viaGetBranchRequest.builder()
- Parameters:
getBranchRequest
- AConsumer
that will call methods onGetBranchRequest.Builder
to create a request. The request structure for the get branch request.- Returns:
- A Java Future containing the result of the GetBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainAssociation
default CompletableFuture<GetDomainAssociationResponse> getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest) Returns the domain information for an Amplify app.
- Parameters:
getDomainAssociationRequest
- The request structure for the get domain association request.- Returns:
- A Java Future containing the result of the GetDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainAssociation
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 viaGetDomainAssociationRequest.builder()
- Parameters:
getDomainAssociationRequest
- AConsumer
that will call methods onGetDomainAssociationRequest.Builder
to create a request. The request structure for the get domain association request.- Returns:
- A Java Future containing the result of the GetDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getJob
Returns a job for a branch of an Amplify app.
- Parameters:
getJobRequest
- The request structure for the get job request.- Returns:
- A Java Future containing the result of the GetJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getJob
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 viaGetJobRequest.builder()
- Parameters:
getJobRequest
- AConsumer
that will call methods onGetJobRequest.Builder
to create a request. The request structure for the get job request.- Returns:
- A Java Future containing the result of the GetJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWebhook
Returns the webhook information that corresponds to a specified webhook ID.
- Parameters:
getWebhookRequest
- The request structure for the get webhook request.- Returns:
- A Java Future containing the result of the GetWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWebhook
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 viaGetWebhookRequest.builder()
- Parameters:
getWebhookRequest
- AConsumer
that will call methods onGetWebhookRequest.Builder
to create a request. The request structure for the get webhook request.- Returns:
- A Java Future containing the result of the GetWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
Returns a list of the existing Amplify apps.
- Parameters:
listAppsRequest
- The request structure for the list apps request.- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
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 viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request. The request structure for the list apps request.- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApps
Returns a list of the existing Amplify apps.
- Returns:
- A Java Future containing the result of the ListApps operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppsPaginator
This is a variant of
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListAppsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListAppsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppsPaginator
This is a variant of
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListAppsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListAppsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.- Parameters:
listAppsRequest
- The request structure for the list apps request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAppsPaginator
This is a variant of
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListAppsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListAppsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listApps(software.amazon.awssdk.services.amplify.model.ListAppsRequest)
operation.
This is a convenience which creates an instance of the
ListAppsRequest.Builder
avoiding the need to create one manually viaListAppsRequest.builder()
- Parameters:
listAppsRequest
- AConsumer
that will call methods onListAppsRequest.Builder
to create a request. The request structure for the list apps request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArtifacts
default CompletableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest listArtifactsRequest) Returns a list of artifacts for a specified app, branch, and job.
- Parameters:
listArtifactsRequest
- Describes the request structure for the list artifacts request.- Returns:
- A Java Future containing the result of the ListArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listArtifacts
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 viaListArtifactsRequest.builder()
- Parameters:
listArtifactsRequest
- AConsumer
that will call methods onListArtifactsRequest.Builder
to create a request. Describes the request structure for the list artifacts request.- Returns:
- A Java Future containing the result of the ListArtifacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendEnvironments
default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest) Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
- Parameters:
listBackendEnvironmentsRequest
- The request structure for the list backend environments request.- Returns:
- A Java Future containing the result of the ListBackendEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendEnvironments
default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest) Lists the backend environments for an Amplify app.
This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
This is a convenience which creates an instance of the
ListBackendEnvironmentsRequest.Builder
avoiding the need to create one manually viaListBackendEnvironmentsRequest.builder()
- Parameters:
listBackendEnvironmentsRequest
- AConsumer
that will call methods onListBackendEnvironmentsRequest.Builder
to create a request. The request structure for the list backend environments request.- Returns:
- A Java Future containing the result of the ListBackendEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBranches
default CompletableFuture<ListBranchesResponse> listBranches(ListBranchesRequest listBranchesRequest) Lists the branches of an Amplify app.
- Parameters:
listBranchesRequest
- The request structure for the list branches request.- Returns:
- A Java Future containing the result of the ListBranches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBranches
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 viaListBranchesRequest.builder()
- Parameters:
listBranchesRequest
- AConsumer
that will call methods onListBranchesRequest.Builder
to create a request. The request structure for the list branches request.- Returns:
- A Java Future containing the result of the ListBranches operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBranchesPaginator
This is a variant of
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListBranchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListBranchesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.- Parameters:
listBranchesRequest
- The request structure for the list branches request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBranchesPaginator
default ListBranchesPublisher listBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest) This is a variant of
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListBranchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListBranchesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBranches(software.amazon.awssdk.services.amplify.model.ListBranchesRequest)
operation.
This is a convenience which creates an instance of the
ListBranchesRequest.Builder
avoiding the need to create one manually viaListBranchesRequest.builder()
- Parameters:
listBranchesRequest
- AConsumer
that will call methods onListBranchesRequest.Builder
to create a request. The request structure for the list branches request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAssociations
default CompletableFuture<ListDomainAssociationsResponse> listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest) Returns the domain associations for an Amplify app.
- Parameters:
listDomainAssociationsRequest
- The request structure for the list domain associations request.- Returns:
- A Java Future containing the result of the ListDomainAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAssociations
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 viaListDomainAssociationsRequest.builder()
- Parameters:
listDomainAssociationsRequest
- AConsumer
that will call methods onListDomainAssociationsRequest.Builder
to create a request. The request structure for the list domain associations request.- Returns:
- A Java Future containing the result of the ListDomainAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAssociationsPaginator
default ListDomainAssociationsPublisher listDomainAssociationsPaginator(ListDomainAssociationsRequest listDomainAssociationsRequest) This is a variant of
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.- Parameters:
listDomainAssociationsRequest
- The request structure for the list domain associations request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAssociationsPaginator
default ListDomainAssociationsPublisher listDomainAssociationsPaginator(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest) This is a variant of
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainAssociations(software.amazon.awssdk.services.amplify.model.ListDomainAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListDomainAssociationsRequest.Builder
avoiding the need to create one manually viaListDomainAssociationsRequest.builder()
- Parameters:
listDomainAssociationsRequest
- AConsumer
that will call methods onListDomainAssociationsRequest.Builder
to create a request. The request structure for the list domain associations request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobs
Lists the jobs for a branch of an Amplify app.
- Parameters:
listJobsRequest
- The request structure for the list jobs request.- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobs
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 viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. The request structure for the list jobs request.- Returns:
- A Java Future containing the result of the ListJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.- Parameters:
listJobsRequest
- The request structure for the list jobs request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobsPaginator
This is a variant of
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplify.model.ListJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplify.model.ListJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listJobs(software.amazon.awssdk.services.amplify.model.ListJobsRequest)
operation.
This is a convenience which creates an instance of the
ListJobsRequest.Builder
avoiding the need to create one manually viaListJobsRequest.builder()
- Parameters:
listJobsRequest
- AConsumer
that will call methods onListJobsRequest.Builder
to create a request. The request structure for the list jobs request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).
- Parameters:
listTagsForResourceRequest
- The request structure to use to list tags for a resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. The request structure to use to list tags for a resource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooks
default CompletableFuture<ListWebhooksResponse> listWebhooks(ListWebhooksRequest listWebhooksRequest) Returns a list of webhooks for an Amplify app.
- Parameters:
listWebhooksRequest
- The request structure for the list webhooks request.- Returns:
- A Java Future containing the result of the ListWebhooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWebhooks
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 viaListWebhooksRequest.builder()
- Parameters:
listWebhooksRequest
- AConsumer
that will call methods onListWebhooksRequest.Builder
to create a request. The request structure for the list webhooks request.- Returns:
- A Java Future containing the result of the ListWebhooks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
default CompletableFuture<StartDeploymentResponse> startDeployment(StartDeploymentRequest startDeploymentRequest) 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 theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.- Parameters:
startDeploymentRequest
- The request structure for the start a deployment request.- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDeployment
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.
The maximum duration between the
CreateDeployment
call and theStartDeployment
call cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeployment
call and the associatedJob
will fail.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builder
avoiding the need to create one manually viaStartDeploymentRequest.builder()
- Parameters:
startDeploymentRequest
- AConsumer
that will call methods onStartDeploymentRequest.Builder
to create a request. The request structure for the start a deployment request.- Returns:
- A Java Future containing the result of the StartDeployment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startJob
Starts a new job for a branch of an Amplify app.
- Parameters:
startJobRequest
- The request structure for the start job request.- Returns:
- A Java Future containing the result of the StartJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startJob
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 viaStartJobRequest.builder()
- Parameters:
startJobRequest
- AConsumer
that will call methods onStartJobRequest.Builder
to create a request. The request structure for the start job request.- Returns:
- A Java Future containing the result of the StartJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopJob
Stops a job that is in progress for a branch of an Amplify app.
- Parameters:
stopJobRequest
- The request structure for the stop job request.- Returns:
- A Java Future containing the result of the StopJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopJob
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 viaStopJobRequest.builder()
- Parameters:
stopJobRequest
- AConsumer
that will call methods onStopJobRequest.Builder
to create a request. The request structure for the stop job request.- Returns:
- A Java Future containing the result of the StopJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tags the resource with a tag key and value.
- Parameters:
tagResourceRequest
- The request structure to tag a resource with a tag key and value.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request. The request structure to tag a resource with a tag key and value.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).
- Parameters:
untagResourceRequest
- The request structure for the untag resource request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request. The request structure for the untag resource request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApp
Updates an existing Amplify app.
- Parameters:
updateAppRequest
- The request structure for the update app request.- Returns:
- A Java Future containing the result of the UpdateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApp
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 viaUpdateAppRequest.builder()
- Parameters:
updateAppRequest
- AConsumer
that will call methods onUpdateAppRequest.Builder
to create a request. The request structure for the update app request.- Returns:
- A Java Future containing the result of the UpdateApp operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBranch
default CompletableFuture<UpdateBranchResponse> updateBranch(UpdateBranchRequest updateBranchRequest) Updates a branch for an Amplify app.
- Parameters:
updateBranchRequest
- The request structure for the update branch request.- Returns:
- A Java Future containing the result of the UpdateBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBranch
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 viaUpdateBranchRequest.builder()
- Parameters:
updateBranchRequest
- AConsumer
that will call methods onUpdateBranchRequest.Builder
to create a request. The request structure for the update branch request.- Returns:
- A Java Future containing the result of the UpdateBranch operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomainAssociation
default CompletableFuture<UpdateDomainAssociationResponse> updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest) Creates a new domain association for an Amplify app.
- Parameters:
updateDomainAssociationRequest
- The request structure for the update domain association request.- Returns:
- A Java Future containing the result of the UpdateDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomainAssociation
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 viaUpdateDomainAssociationRequest.builder()
- Parameters:
updateDomainAssociationRequest
- AConsumer
that will call methods onUpdateDomainAssociationRequest.Builder
to create a request. The request structure for the update domain association request.- Returns:
- A Java Future containing the result of the UpdateDomainAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWebhook
default CompletableFuture<UpdateWebhookResponse> updateWebhook(UpdateWebhookRequest updateWebhookRequest) Updates a webhook.
- Parameters:
updateWebhookRequest
- The request structure for the update webhook request.- Returns:
- A Java Future containing the result of the UpdateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateWebhook
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 viaUpdateWebhookRequest.builder()
- Parameters:
updateWebhookRequest
- AConsumer
that will call methods onUpdateWebhookRequest.Builder
to create a request. The request structure for the update webhook request.- Returns:
- A Java Future containing the result of the UpdateWebhook operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAmplifyAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmplifyAsyncClient
.
-