Interface AmplifyAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyAsyncClient extends AwsClient
Service client for accessing Amplify asynchronously. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static AmplifyAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aAmplifyAsyncClient.static AmplifyAsyncClientcreate()Create aAmplifyAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand 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.default CompletableFuture<CreateBackendEnvironmentResponse>createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest)Creates a new backend environment for an Amplify app.default CompletableFuture<CreateBackendEnvironmentResponse>createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)Creates a new backend environment for an Amplify app.default CompletableFuture<CreateBranchResponse>createBranch(Consumer<CreateBranchRequest.Builder> createBranchRequest)Creates a new branch for an Amplify app.default CompletableFuture<CreateBranchResponse>createBranch(CreateBranchRequest createBranchRequest)Creates a new branch for an Amplify app.default CompletableFuture<CreateDeploymentResponse>createDeployment(Consumer<CreateDeploymentRequest.Builder> createDeploymentRequest)Creates a deployment for a manually deployed Amplify app.default CompletableFuture<CreateDeploymentResponse>createDeployment(CreateDeploymentRequest createDeploymentRequest)Creates a deployment for a manually deployed Amplify app.default CompletableFuture<CreateDomainAssociationResponse>createDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest)Creates a new domain association for an Amplify app.default CompletableFuture<CreateDomainAssociationResponse>createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)Creates a new domain association for an Amplify app.default CompletableFuture<CreateWebhookResponse>createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)Creates a new webhook on an Amplify app.default CompletableFuture<CreateWebhookResponse>createWebhook(CreateWebhookRequest createWebhookRequest)Creates a new webhook on an Amplify app.default CompletableFuture<DeleteAppResponse>deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)Deletes an existing Amplify app specified by an app ID.default CompletableFuture<DeleteAppResponse>deleteApp(DeleteAppRequest deleteAppRequest)Deletes an existing Amplify app specified by an app ID.default CompletableFuture<DeleteBackendEnvironmentResponse>deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)Deletes a backend environment for an Amplify app.default CompletableFuture<DeleteBackendEnvironmentResponse>deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)Deletes a backend environment for an Amplify app.default CompletableFuture<DeleteBranchResponse>deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)Deletes a branch for an Amplify app.default CompletableFuture<DeleteBranchResponse>deleteBranch(DeleteBranchRequest deleteBranchRequest)Deletes a branch for an Amplify app.default CompletableFuture<DeleteDomainAssociationResponse>deleteDomainAssociation(Consumer<DeleteDomainAssociationRequest.Builder> deleteDomainAssociationRequest)Deletes a domain association for an Amplify app.default CompletableFuture<DeleteDomainAssociationResponse>deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)Deletes a domain association for an Amplify app.default CompletableFuture<DeleteJobResponse>deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)Deletes a job for a branch of an Amplify app.default CompletableFuture<DeleteJobResponse>deleteJob(DeleteJobRequest deleteJobRequest)Deletes a job for a branch of an Amplify app.default CompletableFuture<DeleteWebhookResponse>deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)Deletes a webhook.default CompletableFuture<DeleteWebhookResponse>deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)Deletes a webhook.default CompletableFuture<GenerateAccessLogsResponse>generateAccessLogs(Consumer<GenerateAccessLogsRequest.Builder> generateAccessLogsRequest)Returns the website access logs for a specific time range using a presigned URL.default CompletableFuture<GenerateAccessLogsResponse>generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)Returns the website access logs for a specific time range using a presigned URL.default CompletableFuture<GetAppResponse>getApp(Consumer<GetAppRequest.Builder> getAppRequest)Returns an existing Amplify app 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.default CompletableFuture<GetBackendEnvironmentResponse>getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)Returns a backend environment for an Amplify app.default CompletableFuture<GetBackendEnvironmentResponse>getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)Returns a backend environment for an Amplify app.default CompletableFuture<GetBranchResponse>getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)Returns a branch for an Amplify app.default CompletableFuture<GetBranchResponse>getBranch(GetBranchRequest getBranchRequest)Returns a branch for an Amplify app.default CompletableFuture<GetDomainAssociationResponse>getDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest)Returns the domain information for an Amplify app.default CompletableFuture<GetDomainAssociationResponse>getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)Returns the domain information for an Amplify app.default CompletableFuture<GetJobResponse>getJob(Consumer<GetJobRequest.Builder> getJobRequest)Returns a job for a branch of an Amplify app.default CompletableFuture<GetJobResponse>getJob(GetJobRequest getJobRequest)Returns a job for a branch of an Amplify app.default CompletableFuture<GetWebhookResponse>getWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest)Returns the webhook information that corresponds to a specified webhook ID.default CompletableFuture<GetWebhookResponse>getWebhook(GetWebhookRequest getWebhookRequest)Returns the webhook information that corresponds to a specified webhook ID.default CompletableFuture<ListAppsResponse>listApps()Returns a list of the existing Amplify apps.default CompletableFuture<ListAppsResponse>listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)Returns a list of the existing Amplify apps.default CompletableFuture<ListAppsResponse>listApps(ListAppsRequest listAppsRequest)Returns a list of the existing Amplify apps.default ListAppsPublisherlistAppsPaginator()Returns a list of the existing Amplify apps.default ListAppsPublisherlistAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)Returns a list of the existing Amplify apps.default ListAppsPublisherlistAppsPaginator(ListAppsRequest listAppsRequest)Returns a list of the existing Amplify apps.default CompletableFuture<ListArtifactsResponse>listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)Returns a list of artifacts for a specified app, branch, and job.default CompletableFuture<ListArtifactsResponse>listArtifacts(ListArtifactsRequest listArtifactsRequest)Returns a list of artifacts for a specified app, branch, and job.default CompletableFuture<ListBackendEnvironmentsResponse>listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)Lists the backend environments for an Amplify app.default CompletableFuture<ListBackendEnvironmentsResponse>listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)Lists the backend environments for an Amplify app.default CompletableFuture<ListBranchesResponse>listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)Lists the branches of an Amplify app.default CompletableFuture<ListBranchesResponse>listBranches(ListBranchesRequest listBranchesRequest)Lists the branches of an Amplify app.default ListBranchesPublisherlistBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest)Lists the branches of an Amplify app.default ListBranchesPublisherlistBranchesPaginator(ListBranchesRequest listBranchesRequest)Lists the branches of an Amplify app.default CompletableFuture<ListDomainAssociationsResponse>listDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default CompletableFuture<ListDomainAssociationsResponse>listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default ListDomainAssociationsPublisherlistDomainAssociationsPaginator(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default ListDomainAssociationsPublisherlistDomainAssociationsPaginator(ListDomainAssociationsRequest listDomainAssociationsRequest)Returns the domain associations for an Amplify app.default CompletableFuture<ListJobsResponse>listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)Lists the jobs for a branch of an Amplify app.default CompletableFuture<ListJobsResponse>listJobs(ListJobsRequest listJobsRequest)Lists the jobs for a branch of an Amplify app.default ListJobsPublisherlistJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)Lists the jobs for a branch of an Amplify app.default ListJobsPublisherlistJobsPaginator(ListJobsRequest listJobsRequest)Lists the jobs for a branch of an Amplify app.default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Returns a list of tags for a specified Amazon Resource Name (ARN).default CompletableFuture<ListTagsForResourceResponse>listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Returns a list of tags for a specified Amazon Resource Name (ARN).default CompletableFuture<ListWebhooksResponse>listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)Returns a list of webhooks for an Amplify app.default CompletableFuture<ListWebhooksResponse>listWebhooks(ListWebhooksRequest listWebhooksRequest)Returns a list of webhooks for an Amplify app.default AmplifyServiceClientConfigurationserviceClientConfiguration()default CompletableFuture<StartDeploymentResponse>startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest)Starts a deployment for a manually deployed app.default CompletableFuture<StartDeploymentResponse>startDeployment(StartDeploymentRequest startDeploymentRequest)Starts a deployment for a manually deployed app.default CompletableFuture<StartJobResponse>startJob(Consumer<StartJobRequest.Builder> startJobRequest)Starts a new job for a branch of an Amplify app.default CompletableFuture<StartJobResponse>startJob(StartJobRequest startJobRequest)Starts a new job for a branch of an Amplify app.default CompletableFuture<StopJobResponse>stopJob(Consumer<StopJobRequest.Builder> stopJobRequest)Stops a job that is in progress for a branch of an Amplify app.default CompletableFuture<StopJobResponse>stopJob(StopJobRequest stopJobRequest)Stops a job that is in progress for a branch of an Amplify app.default CompletableFuture<TagResourceResponse>tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Tags the resource with a tag key and value.default CompletableFuture<TagResourceResponse>tagResource(TagResourceRequest tagResourceRequest)Tags the resource with a tag key and value.default CompletableFuture<UntagResourceResponse>untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Untags a resource with a specified Amazon Resource Name (ARN).default CompletableFuture<UntagResourceResponse>untagResource(UntagResourceRequest untagResourceRequest)Untags a resource with a specified Amazon Resource Name (ARN).default CompletableFuture<UpdateAppResponse>updateApp(Consumer<UpdateAppRequest.Builder> updateAppRequest)Updates an existing Amplify app.default CompletableFuture<UpdateAppResponse>updateApp(UpdateAppRequest updateAppRequest)Updates an existing Amplify app.default CompletableFuture<UpdateBranchResponse>updateBranch(Consumer<UpdateBranchRequest.Builder> updateBranchRequest)Updates a branch for an Amplify app.default CompletableFuture<UpdateBranchResponse>updateBranch(UpdateBranchRequest updateBranchRequest)Updates a branch for an Amplify app.default CompletableFuture<UpdateDomainAssociationResponse>updateDomainAssociation(Consumer<UpdateDomainAssociationRequest.Builder> updateDomainAssociationRequest)Creates a new domain association for an Amplify app.default CompletableFuture<UpdateDomainAssociationResponse>updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)Creates a new domain association for an Amplify app.default CompletableFuture<UpdateWebhookResponse>updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)Updates a webhook.default CompletableFuture<UpdateWebhookResponse>updateWebhook(UpdateWebhookRequest updateWebhookRequest)Updates a webhook.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createApp
default CompletableFuture<CreateAppResponse> createApp(CreateAppRequest createAppRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateAppRequest.builder()- Parameters:
createAppRequest- AConsumerthat will call methods onCreateAppRequest.Builderto 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:
- AWS API Documentation
-
createBackendEnvironment
default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(CreateBackendEnvironmentRequest createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
- 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:
- AWS API Documentation
-
createBackendEnvironment
default CompletableFuture<CreateBackendEnvironmentResponse> createBackendEnvironment(Consumer<CreateBackendEnvironmentRequest.Builder> createBackendEnvironmentRequest)
Creates a new backend environment for an Amplify app.
This is a convenience which creates an instance of the
CreateBackendEnvironmentRequest.Builderavoiding the need to create one manually viaCreateBackendEnvironmentRequest.builder()- Parameters:
createBackendEnvironmentRequest- AConsumerthat will call methods onCreateBackendEnvironmentRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateBranchRequest.builder()- Parameters:
createBranchRequest- AConsumerthat will call methods onCreateBranchRequest.Builderto 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:
- AWS API Documentation
-
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
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill 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:
- AWS API Documentation
-
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
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.
This is a convenience which creates an instance of the
CreateDeploymentRequest.Builderavoiding the need to create one manually viaCreateDeploymentRequest.builder()- Parameters:
createDeploymentRequest- AConsumerthat will call methods onCreateDeploymentRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateDomainAssociationRequest.builder()- Parameters:
createDomainAssociationRequest- AConsumerthat will call methods onCreateDomainAssociationRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateWebhookRequest.builder()- Parameters:
createWebhookRequest- AConsumerthat will call methods onCreateWebhookRequest.Builderto 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:
- AWS API Documentation
-
deleteApp
default CompletableFuture<DeleteAppResponse> deleteApp(DeleteAppRequest deleteAppRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAppRequest.builder()- Parameters:
deleteAppRequest- AConsumerthat will call methods onDeleteAppRequest.Builderto 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:
- AWS API Documentation
-
deleteBackendEnvironment
default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
- 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:
- AWS API Documentation
-
deleteBackendEnvironment
default CompletableFuture<DeleteBackendEnvironmentResponse> deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)
Deletes a backend environment for an Amplify app.
This is a convenience which creates an instance of the
DeleteBackendEnvironmentRequest.Builderavoiding the need to create one manually viaDeleteBackendEnvironmentRequest.builder()- Parameters:
deleteBackendEnvironmentRequest- AConsumerthat will call methods onDeleteBackendEnvironmentRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteBranchRequest.builder()- Parameters:
deleteBranchRequest- AConsumerthat will call methods onDeleteBranchRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDomainAssociationRequest.builder()- Parameters:
deleteDomainAssociationRequest- AConsumerthat will call methods onDeleteDomainAssociationRequest.Builderto 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:
- AWS API Documentation
-
deleteJob
default CompletableFuture<DeleteJobResponse> deleteJob(DeleteJobRequest deleteJobRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteJobRequest.builder()- Parameters:
deleteJobRequest- AConsumerthat will call methods onDeleteJobRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
deleteWebhook
default CompletableFuture<DeleteWebhookResponse> deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
Deletes a webhook.
This is a convenience which creates an instance of the
DeleteWebhookRequest.Builderavoiding the need to create one manually viaDeleteWebhookRequest.builder()- Parameters:
deleteWebhookRequest- AConsumerthat will call methods onDeleteWebhookRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGenerateAccessLogsRequest.builder()- Parameters:
generateAccessLogsRequest- AConsumerthat will call methods onGenerateAccessLogsRequest.Builderto 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:
- AWS API Documentation
-
getApp
default CompletableFuture<GetAppResponse> getApp(GetAppRequest getAppRequest)
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:
- AWS API Documentation
-
getApp
default CompletableFuture<GetAppResponse> getApp(Consumer<GetAppRequest.Builder> getAppRequest)
Returns an existing Amplify app specified by an app ID.
This is a convenience which creates an instance of the
GetAppRequest.Builderavoiding the need to create one manually viaGetAppRequest.builder()- Parameters:
getAppRequest- AConsumerthat will call methods onGetAppRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetArtifactUrlRequest.builder()- Parameters:
getArtifactUrlRequest- AConsumerthat will call methods onGetArtifactUrlRequest.Builderto 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:
- AWS API Documentation
-
getBackendEnvironment
default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
- 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:
- AWS API Documentation
-
getBackendEnvironment
default CompletableFuture<GetBackendEnvironmentResponse> getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)
Returns a backend environment for an Amplify app.
This is a convenience which creates an instance of the
GetBackendEnvironmentRequest.Builderavoiding the need to create one manually viaGetBackendEnvironmentRequest.builder()- Parameters:
getBackendEnvironmentRequest- AConsumerthat will call methods onGetBackendEnvironmentRequest.Builderto 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:
- AWS API Documentation
-
getBranch
default CompletableFuture<GetBranchResponse> getBranch(GetBranchRequest getBranchRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetBranchRequest.builder()- Parameters:
getBranchRequest- AConsumerthat will call methods onGetBranchRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetDomainAssociationRequest.builder()- Parameters:
getDomainAssociationRequest- AConsumerthat will call methods onGetDomainAssociationRequest.Builderto 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:
- AWS API Documentation
-
getJob
default CompletableFuture<GetJobResponse> getJob(GetJobRequest getJobRequest)
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:
- AWS API Documentation
-
getJob
default CompletableFuture<GetJobResponse> getJob(Consumer<GetJobRequest.Builder> getJobRequest)
Returns a job for a branch of an Amplify app.
This is a convenience which creates an instance of the
GetJobRequest.Builderavoiding the need to create one manually viaGetJobRequest.builder()- Parameters:
getJobRequest- AConsumerthat will call methods onGetJobRequest.Builderto 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:
- AWS API Documentation
-
getWebhook
default CompletableFuture<GetWebhookResponse> getWebhook(GetWebhookRequest getWebhookRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetWebhookRequest.builder()- Parameters:
getWebhookRequest- AConsumerthat will call methods onGetWebhookRequest.Builderto 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:
- AWS API Documentation
-
listApps
default CompletableFuture<ListAppsResponse> listApps(ListAppsRequest listAppsRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAppsRequest.builder()- Parameters:
listAppsRequest- AConsumerthat will call methods onListAppsRequest.Builderto 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:
- AWS API Documentation
-
listApps
default CompletableFuture<ListAppsResponse> 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:
- AWS API Documentation
-
listAppsPaginator
default ListAppsPublisher listAppsPaginator()
Returns a list of the existing Amplify apps.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
listAppsPaginator
default ListAppsPublisher listAppsPaginator(ListAppsRequest listAppsRequest)
Returns a list of the existing Amplify apps.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
listAppsPaginator
default ListAppsPublisher listAppsPaginator(Consumer<ListAppsRequest.Builder> listAppsRequest)
Returns a list of the existing Amplify apps.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListAppsPublisher publisher = client.listAppsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListAppsRequest.builder()- Parameters:
listAppsRequest- AConsumerthat will call methods onListAppsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListArtifactsRequest.builder()- Parameters:
listArtifactsRequest- AConsumerthat will call methods onListArtifactsRequest.Builderto 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:
- AWS API Documentation
-
listBackendEnvironments
default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
- 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:
- AWS API Documentation
-
listBackendEnvironments
default CompletableFuture<ListBackendEnvironmentsResponse> listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)
Lists the backend environments for an Amplify app.
This is a convenience which creates an instance of the
ListBackendEnvironmentsRequest.Builderavoiding the need to create one manually viaListBackendEnvironmentsRequest.builder()- Parameters:
listBackendEnvironmentsRequest- AConsumerthat will call methods onListBackendEnvironmentsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListBranchesRequest.builder()- Parameters:
listBranchesRequest- AConsumerthat will call methods onListBranchesRequest.Builderto 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:
- AWS API Documentation
-
listBranchesPaginator
default ListBranchesPublisher listBranchesPaginator(ListBranchesRequest listBranchesRequest)
Lists the branches of an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
listBranchesPaginator
default ListBranchesPublisher listBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Lists the branches of an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListBranchesRequest.builder()- Parameters:
listBranchesRequest- AConsumerthat will call methods onListBranchesRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListDomainAssociationsRequest.builder()- Parameters:
listDomainAssociationsRequest- AConsumerthat will call methods onListDomainAssociationsRequest.Builderto 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:
- AWS API Documentation
-
listDomainAssociationsPaginator
default ListDomainAssociationsPublisher listDomainAssociationsPaginator(ListDomainAssociationsRequest listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
listDomainAssociationsPaginator
default ListDomainAssociationsPublisher listDomainAssociationsPaginator(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)
Returns the domain associations for an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListDomainAssociationsPublisher publisher = client.listDomainAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListDomainAssociationsRequest.builder()- Parameters:
listDomainAssociationsRequest- AConsumerthat will call methods onListDomainAssociationsRequest.Builderto 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:
- AWS API Documentation
-
listJobs
default CompletableFuture<ListJobsResponse> listJobs(ListJobsRequest listJobsRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListJobsRequest.builder()- Parameters:
listJobsRequest- AConsumerthat will call methods onListJobsRequest.Builderto 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:
- AWS API Documentation
-
listJobsPaginator
default ListJobsPublisher listJobsPaginator(ListJobsRequest listJobsRequest)
Lists the jobs for a branch of an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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:
- AWS API Documentation
-
listJobsPaginator
default ListJobsPublisher listJobsPaginator(Consumer<ListJobsRequest.Builder> listJobsRequest)
Lists the jobs for a branch of an Amplify app.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.amplify.paginators.ListJobsPublisher publisher = client.listJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListJobsRequest.builder()- Parameters:
listJobsRequest- AConsumerthat will call methods onListJobsRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListWebhooksRequest.builder()- Parameters:
listWebhooksRequest- AConsumerthat will call methods onListWebhooksRequest.Builderto 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:
- AWS API Documentation
-
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
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill 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:
- AWS API Documentation
-
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
CreateDeploymentcall and theStartDeploymentcall cannot exceed 8 hours. If the duration exceeds 8 hours, theStartDeploymentcall and the associatedJobwill fail.
This is a convenience which creates an instance of the
StartDeploymentRequest.Builderavoiding the need to create one manually viaStartDeploymentRequest.builder()- Parameters:
startDeploymentRequest- AConsumerthat will call methods onStartDeploymentRequest.Builderto 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:
- AWS API Documentation
-
startJob
default CompletableFuture<StartJobResponse> startJob(StartJobRequest startJobRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartJobRequest.builder()- Parameters:
startJobRequest- AConsumerthat will call methods onStartJobRequest.Builderto 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:
- AWS API Documentation
-
stopJob
default CompletableFuture<StopJobResponse> stopJob(StopJobRequest stopJobRequest)
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:
- AWS API Documentation
-
stopJob
default CompletableFuture<StopJobResponse> stopJob(Consumer<StopJobRequest.Builder> stopJobRequest)
Stops a job that is in progress for a branch of an Amplify app.
This is a convenience which creates an instance of the
StopJobRequest.Builderavoiding the need to create one manually viaStopJobRequest.builder()- Parameters:
stopJobRequest- AConsumerthat will call methods onStopJobRequest.Builderto 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:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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:
- AWS API Documentation
-
updateApp
default CompletableFuture<UpdateAppResponse> updateApp(UpdateAppRequest updateAppRequest)
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateAppRequest.builder()- Parameters:
updateAppRequest- AConsumerthat will call methods onUpdateAppRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateBranchRequest.builder()- Parameters:
updateBranchRequest- AConsumerthat will call methods onUpdateBranchRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateDomainAssociationRequest.builder()- Parameters:
updateDomainAssociationRequest- AConsumerthat will call methods onUpdateDomainAssociationRequest.Builderto 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:
- AWS API Documentation
-
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:
- AWS API Documentation
-
updateWebhook
default CompletableFuture<UpdateWebhookResponse> updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)
Updates a webhook.
This is a convenience which creates an instance of the
UpdateWebhookRequest.Builderavoiding the need to create one manually viaUpdateWebhookRequest.builder()- Parameters:
updateWebhookRequest- AConsumerthat will call methods onUpdateWebhookRequest.Builderto 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:
- AWS API Documentation
-
serviceClientConfiguration
default AmplifyServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static AmplifyAsyncClient create()
Create aAmplifyAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AmplifyAsyncClientBuilder builder()
Create a builder that can be used to configure and create aAmplifyAsyncClient.
-
-