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