@Generated(value="software.amazon.awssdk:codegen") public interface AmplifyClient extends SdkClient
builder() method.
Amplify is a fully managed continuous deployment and hosting service for modern web apps.
| Modifier and Type | Field and Description |
|---|---|
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)
Create a deployment for manual deploy apps.
|
default CreateDeploymentResponse |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Create a deployment for manual deploy apps.
|
default CreateDomainAssociationResponse |
createDomainAssociation(Consumer<CreateDomainAssociationRequest.Builder> createDomainAssociationRequest)
Create a new DomainAssociation on an App
|
default CreateDomainAssociationResponse |
createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)
Create a new DomainAssociation on an App
|
default CreateWebhookResponse |
createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)
Create a new webhook on an App.
|
default CreateWebhookResponse |
createWebhook(CreateWebhookRequest createWebhookRequest)
Create a new webhook on an App.
|
default DeleteAppResponse |
deleteApp(Consumer<DeleteAppRequest.Builder> deleteAppRequest)
Delete an existing Amplify App by appId.
|
default DeleteAppResponse |
deleteApp(DeleteAppRequest deleteAppRequest)
Delete an existing Amplify App by appId.
|
default DeleteBackendEnvironmentResponse |
deleteBackendEnvironment(Consumer<DeleteBackendEnvironmentRequest.Builder> deleteBackendEnvironmentRequest)
Delete backend environment for an Amplify App.
|
default DeleteBackendEnvironmentResponse |
deleteBackendEnvironment(DeleteBackendEnvironmentRequest deleteBackendEnvironmentRequest)
Delete 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 DomainAssociation.
|
default DeleteDomainAssociationResponse |
deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)
Deletes a DomainAssociation.
|
default DeleteJobResponse |
deleteJob(Consumer<DeleteJobRequest.Builder> deleteJobRequest)
Delete a job, for an Amplify branch, part of Amplify App.
|
default DeleteJobResponse |
deleteJob(DeleteJobRequest deleteJobRequest)
Delete a job, for an Amplify branch, part of 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)
Retrieve website access logs for a specific time range via a pre-signed URL.
|
default GenerateAccessLogsResponse |
generateAccessLogs(GenerateAccessLogsRequest generateAccessLogsRequest)
Retrieve website access logs for a specific time range via a pre-signed URL.
|
default GetAppResponse |
getApp(Consumer<GetAppRequest.Builder> getAppRequest)
Retrieves an existing Amplify App by appId.
|
default GetAppResponse |
getApp(GetAppRequest getAppRequest)
Retrieves an existing Amplify App by appId.
|
default GetArtifactUrlResponse |
getArtifactUrl(Consumer<GetArtifactUrlRequest.Builder> getArtifactUrlRequest)
Retrieves artifact info that corresponds to a artifactId.
|
default GetArtifactUrlResponse |
getArtifactUrl(GetArtifactUrlRequest getArtifactUrlRequest)
Retrieves artifact info that corresponds to a artifactId.
|
default GetBackendEnvironmentResponse |
getBackendEnvironment(Consumer<GetBackendEnvironmentRequest.Builder> getBackendEnvironmentRequest)
Retrieves a backend environment for an Amplify App.
|
default GetBackendEnvironmentResponse |
getBackendEnvironment(GetBackendEnvironmentRequest getBackendEnvironmentRequest)
Retrieves a backend environment for an Amplify App.
|
default GetBranchResponse |
getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)
Retrieves a branch for an Amplify App.
|
default GetBranchResponse |
getBranch(GetBranchRequest getBranchRequest)
Retrieves a branch for an Amplify App.
|
default GetDomainAssociationResponse |
getDomainAssociation(Consumer<GetDomainAssociationRequest.Builder> getDomainAssociationRequest)
Retrieves domain info that corresponds to an appId and domainName.
|
default GetDomainAssociationResponse |
getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)
Retrieves domain info that corresponds to an appId and domainName.
|
default GetJobResponse |
getJob(Consumer<GetJobRequest.Builder> getJobRequest)
Get a job for a branch, part of an Amplify App.
|
default GetJobResponse |
getJob(GetJobRequest getJobRequest)
Get a job for a branch, part of an Amplify App.
|
default GetWebhookResponse |
getWebhook(Consumer<GetWebhookRequest.Builder> getWebhookRequest)
Retrieves webhook info that corresponds to a webhookId.
|
default GetWebhookResponse |
getWebhook(GetWebhookRequest getWebhookRequest)
Retrieves webhook info that corresponds to a webhookId.
|
default ListAppsResponse |
listApps()
Lists existing Amplify Apps.
|
default ListAppsResponse |
listApps(Consumer<ListAppsRequest.Builder> listAppsRequest)
Lists existing Amplify Apps.
|
default ListAppsResponse |
listApps(ListAppsRequest listAppsRequest)
Lists existing Amplify Apps.
|
default ListArtifactsResponse |
listArtifacts(Consumer<ListArtifactsRequest.Builder> listArtifactsRequest)
List artifacts with an app, a branch, a job and an artifact type.
|
default ListArtifactsResponse |
listArtifacts(ListArtifactsRequest listArtifactsRequest)
List artifacts with an app, a branch, a job and an artifact type.
|
default ListBackendEnvironmentsResponse |
listBackendEnvironments(Consumer<ListBackendEnvironmentsRequest.Builder> listBackendEnvironmentsRequest)
Lists backend environments for an Amplify App.
|
default ListBackendEnvironmentsResponse |
listBackendEnvironments(ListBackendEnvironmentsRequest listBackendEnvironmentsRequest)
Lists backend environments for an Amplify App.
|
default ListBranchesResponse |
listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Lists branches for an Amplify App.
|
default ListBranchesResponse |
listBranches(ListBranchesRequest listBranchesRequest)
Lists branches for an Amplify App.
|
default ListDomainAssociationsResponse |
listDomainAssociations(Consumer<ListDomainAssociationsRequest.Builder> listDomainAssociationsRequest)
List domains with an app
|
default ListDomainAssociationsResponse |
listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)
List domains with an app
|
default ListJobsResponse |
listJobs(Consumer<ListJobsRequest.Builder> listJobsRequest)
List Jobs for a branch, part of an Amplify App.
|
default ListJobsResponse |
listJobs(ListJobsRequest listJobsRequest)
List Jobs for a branch, part of an Amplify App.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List tags for resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List tags for resource.
|
default ListWebhooksResponse |
listWebhooks(Consumer<ListWebhooksRequest.Builder> listWebhooksRequest)
List webhooks with an app.
|
default ListWebhooksResponse |
listWebhooks(ListWebhooksRequest listWebhooksRequest)
List webhooks with an app.
|
static ServiceMetadata |
serviceMetadata() |
default StartDeploymentResponse |
startDeployment(Consumer<StartDeploymentRequest.Builder> startDeploymentRequest)
Start a deployment for manual deploy apps.
|
default StartDeploymentResponse |
startDeployment(StartDeploymentRequest startDeploymentRequest)
Start a deployment for manual deploy apps.
|
default StartJobResponse |
startJob(Consumer<StartJobRequest.Builder> startJobRequest)
Starts a new job for a branch, part of an Amplify App.
|
default StartJobResponse |
startJob(StartJobRequest startJobRequest)
Starts a new job for a branch, part of an Amplify App.
|
default StopJobResponse |
stopJob(Consumer<StopJobRequest.Builder> stopJobRequest)
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
|
default StopJobResponse |
stopJob(StopJobRequest stopJobRequest)
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tag resource with tag key and value.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Tag resource with tag key and value.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Untag resource with resourceArn.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Untag resource with resourceArn.
|
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)
Create a new DomainAssociation on an App
|
default UpdateDomainAssociationResponse |
updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)
Create a new DomainAssociation on an App
|
default UpdateWebhookResponse |
updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)
Update a webhook.
|
default UpdateWebhookResponse |
updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Update a webhook.
|
serviceNameclosestatic final String SERVICE_NAME
static AmplifyClient create()
AmplifyClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AmplifyClientBuilder builder()
AmplifyClient.default CreateAppResponse createApp(CreateAppRequest createAppRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, DependentServiceFailureException, AwsServiceException, SdkClientException, AmplifyException
Creates a new Amplify App.
createAppRequest - Request structure used to create Apps in Amplify.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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. Request
structure used to create Apps in Amplify.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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 - Request structure for a backend environment create request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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. Request structure for a backend environment create request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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 - Request structure for a branch create request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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.
Request structure for a branch create request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a deployment for manual deploy apps. (Apps are not connected to repository)
createDeploymentRequest - Request structure for create a new deployment.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Create a deployment for manual deploy apps. (Apps are not connected to 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.
Request structure for create a new deployment.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Create a new DomainAssociation on an App
createDomainAssociationRequest - Request structure for create Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a new DomainAssociation on an 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. Request structure for create Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a new webhook on an App.
createWebhookRequest - Request structure for create webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a new webhook on an 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.
Request structure for create webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Delete an existing Amplify App by appId.
deleteAppRequest - Request structure for an Amplify App delete request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Delete an existing Amplify App by appId.
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. Request
structure for an Amplify App delete request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Delete backend environment for an Amplify App.
deleteBackendEnvironmentRequest - Request structure for delete backend environment request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Delete 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. Request structure for delete backend environment request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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 - Request structure for delete branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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.
Request structure for delete branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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 DomainAssociation.
deleteDomainAssociationRequest - Request structure for the delete Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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 DomainAssociation.
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. Request structure for the delete Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Delete a job, for an Amplify branch, part of Amplify App.
deleteJobRequest - Request structure for delete job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Delete a job, for an Amplify branch, part of 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. Request
structure for delete job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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 - Request structure for the delete webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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.
Request structure for the delete webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Retrieve website access logs for a specific time range via a pre-signed URL.
generateAccessLogsRequest - Request structure for the generate access logs request.NotFoundException - Exception thrown when an entity has not been found during an operation.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
Retrieve website access logs for a specific time range via a pre-signed 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. Request structure for the generate access logs request.NotFoundException - Exception thrown when an entity has not been found during an operation.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
Retrieves an existing Amplify App by appId.
getAppRequest - Request structure for get App request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
Retrieves 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. Request
structure for get App request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
Retrieves artifact info that corresponds to a artifactId.
getArtifactUrlRequest - Request structure for the get artifact request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Retrieves artifact info that corresponds to a artifactId.
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.
Request structure for the get artifact request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Retrieves a backend environment for an Amplify App.
getBackendEnvironmentRequest - Request structure for get backend environment request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Retrieves 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. Request structure for get backend environment request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Retrieves a branch for an Amplify App.
getBranchRequest - Request structure for get branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Retrieves 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. Request
structure for get branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Retrieves domain info that corresponds to an appId and domainName.
getDomainAssociationRequest - Request structure for the get Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Retrieves domain info that corresponds to an appId and domainName.
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. Request structure for the get Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails 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
Get a job for a branch, part of an Amplify App.
getJobRequest - Request structure for get job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Get a job for a branch, part 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. Request
structure for get job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Retrieves webhook info that corresponds to a webhookId.
getWebhookRequest - Request structure for the get webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Retrieves webhook info that corresponds to a webhookId.
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.
Request structure for the get webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Lists existing Amplify Apps.
BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 ListAppsResponse listApps(ListAppsRequest listAppsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, AwsServiceException, SdkClientException, AmplifyException
Lists existing Amplify Apps.
listAppsRequest - Request structure for an Amplify App list request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
Lists 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. Request
structure for an Amplify App list request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 ListArtifactsResponse listArtifacts(ListArtifactsRequest listArtifactsRequest) throws BadRequestException, UnauthorizedException, InternalFailureException, LimitExceededException, AwsServiceException, SdkClientException, AmplifyException
List artifacts with an app, a branch, a job and an artifact type.
listArtifactsRequest - Request structure for the list artifacts request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
List artifacts with an app, a branch, a job and an artifact type.
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.
Request structure for the list artifacts request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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 backend environments for an Amplify App.
listBackendEnvironmentsRequest - Request structure for list backend environments request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 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. Request structure for list backend environments request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 branches for an Amplify App.
listBranchesRequest - Request structure for list branches request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 branches for 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.
Request structure for list branches request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
List domains with an app
listDomainAssociationsRequest - Request structure for the list Domain Associations request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
List domains with an 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. Request structure for the list Domain Associations request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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
List Jobs for a branch, part of an Amplify App.
listJobsRequest - Request structure for list job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
List Jobs for a branch, part 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. Request
structure for list job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
List tags for resource.
listTagsForResourceRequest - Request structure used to list tags for resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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
List tags for resource.
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. Request structure used to list tags for resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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
List webhooks with an app.
listWebhooksRequest - Request structure for the list webhooks request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
List webhooks with an 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.
Request structure for the list webhooks request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Start a deployment for manual deploy apps. (Apps are not connected to repository)
startDeploymentRequest - Request structure for start a deployment.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Start a deployment for manual deploy apps. (Apps are not connected to 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.
Request structure for start a deployment.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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, part of an Amplify App.
startJobRequest - Request structure for Start job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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, part 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. Request
structure for Start job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Stop a job that is in progress, for an Amplify branch, part of Amplify App.
stopJobRequest - Request structure for stop job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Stop a job that is in progress, for an Amplify branch, part of 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. Request
structure for stop job request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.NotFoundException - Exception thrown when an entity has not been found during an operation.LimitExceededException - Exception thrown when a resource could not be created because of service limits.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
Tag resource with tag key and value.
tagResourceRequest - Request structure used to tag resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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
Tag resource with 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.
Request structure used to tag resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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
Untag resource with resourceArn.
untagResourceRequest - Request structure used to untag resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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
Untag resource with resourceArn.
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.
Request structure used to untag resource.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.BadRequestException - Exception thrown when a request contains unexpected data.ResourceNotFoundException - Exception thrown when an operation fails due to 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 - Request structure for update App request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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. Request
structure for update App request.BadRequestException - Exception thrown when a request contains unexpected data.NotFoundException - Exception thrown when an entity has not been found during an operation.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.InternalFailureException - Exception thrown when the service fails 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 - Request structure for update branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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.
Request structure for update branch request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a new DomainAssociation on an App
updateDomainAssociationRequest - Request structure for update Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Create a new DomainAssociation on an 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. Request structure for update Domain Association request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Update a webhook.
updateWebhookRequest - Request structure for update webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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
Update 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.
Request structure for update webhook request.BadRequestException - Exception thrown when a request contains unexpected data.UnauthorizedException - Exception thrown when an operation fails due to a lack of access.NotFoundException - Exception thrown when an entity has not been found during an operation.InternalFailureException - Exception thrown when the service fails to perform an operation due to an internal issue.DependentServiceFailureException - Exception thrown when an operation fails due to a dependent service throwing 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 ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.