com.amazonaws.services.amplify

Class AWSAmplifyClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.amplify.AWSAmplifyClient

All Implemented Interfaces:

AWSAmplify

Direct Known Subclasses:

AWSAmplifyAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAmplifyClient
extends AmazonWebServiceClient
implements AWSAmplify

Client for accessing Amplify. All service calls made using this client are blocking, and will not return until the service call completes.

Amplify is a fully managed continuous deployment and hosting service for modern web apps.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.amplify.AWSAmplify

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAmplifyClientBuilder	builder()
CreateAppResult	createApp(CreateAppRequest request) Creates a new Amplify App.
CreateBranchResult	createBranch(CreateBranchRequest request) Creates a new Branch for an Amplify App.
CreateDomainAssociationResult	createDomainAssociation(CreateDomainAssociationRequest request) Create a new DomainAssociation on an App
DeleteAppResult	deleteApp(DeleteAppRequest request) Delete an existing Amplify App by appId.
DeleteBranchResult	deleteBranch(DeleteBranchRequest request) Deletes a branch for an Amplify App.
DeleteDomainAssociationResult	deleteDomainAssociation(DeleteDomainAssociationRequest request) Deletes a DomainAssociation.
DeleteJobResult	deleteJob(DeleteJobRequest request) Delete a job, for an Amplify branch, part of Amplify App.
GetAppResult	getApp(GetAppRequest request) Retrieves an existing Amplify App by appId.
GetBranchResult	getBranch(GetBranchRequest request) Retrieves a branch for an Amplify App.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetDomainAssociationResult	getDomainAssociation(GetDomainAssociationRequest request) Retrieves domain info that corresponds to an appId and domainName.
GetJobResult	getJob(GetJobRequest request) Get a job for a branch, part of an Amplify App.
ListAppsResult	listApps(ListAppsRequest request) Lists existing Amplify Apps.
ListBranchesResult	listBranches(ListBranchesRequest request) Lists branches for an Amplify App.
ListDomainAssociationsResult	listDomainAssociations(ListDomainAssociationsRequest request) List domains with an app
ListJobsResult	listJobs(ListJobsRequest request) List Jobs for a branch, part of an Amplify App.
StartJobResult	startJob(StartJobRequest request) Starts a new job for a branch, part of an Amplify App.
StopJobResult	stopJob(StopJobRequest request) Stop a job that is in progress, for an Amplify branch, part of Amplify App.
UpdateAppResult	updateApp(UpdateAppRequest request) Updates an existing Amplify App.
UpdateBranchResult	updateBranch(UpdateBranchRequest request) Updates a branch for an Amplify App.
UpdateDomainAssociationResult	updateDomainAssociation(UpdateDomainAssociationRequest request) Create a new DomainAssociation on an App

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.amplify.AWSAmplify

shutdown

Method Detail

builder

public static AWSAmplifyClientBuilder builder()

createApp

public CreateAppResult createApp(CreateAppRequest request)

Creates a new Amplify App.

Specified by:

createApp in interface AWSAmplify

Parameters:

createAppRequest - Request structure used to create Apps in Amplify.

Returns:

Result of the CreateApp operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createBranch

public CreateBranchResult createBranch(CreateBranchRequest request)

Creates a new Branch for an Amplify App.

Specified by:

createBranch in interface AWSAmplify

Parameters:

createBranchRequest - Request structure for a branch create request.

Returns:

Result of the CreateBranch operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createDomainAssociation

public CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest request)

Create a new DomainAssociation on an App

Specified by:

createDomainAssociation in interface AWSAmplify

Parameters:

createDomainAssociationRequest - Request structure for create Domain Association request.

Returns:

Result of the CreateDomainAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteApp

public DeleteAppResult deleteApp(DeleteAppRequest request)

Delete an existing Amplify App by appId.

Specified by:

deleteApp in interface AWSAmplify

Parameters:

deleteAppRequest - Request structure for an Amplify App delete request.

Returns:

Result of the DeleteApp operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteBranch

public DeleteBranchResult deleteBranch(DeleteBranchRequest request)

Deletes a branch for an Amplify App.

Specified by:

deleteBranch in interface AWSAmplify

Parameters:

deleteBranchRequest - Request structure for delete branch request.

Returns:

Result of the DeleteBranch operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteDomainAssociation

public DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest request)

Deletes a DomainAssociation.

Specified by:

deleteDomainAssociation in interface AWSAmplify

Parameters:

deleteDomainAssociationRequest - Request structure for the delete Domain Association request.

Returns:

Result of the DeleteDomainAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteJob

public DeleteJobResult deleteJob(DeleteJobRequest request)

Delete a job, for an Amplify branch, part of Amplify App.

Specified by:

deleteJob in interface AWSAmplify

Parameters:

deleteJobRequest - Request structure for delete job request.

Returns:

Result of the DeleteJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getApp

public GetAppResult getApp(GetAppRequest request)

Retrieves an existing Amplify App by appId.

Specified by:

getApp in interface AWSAmplify

Parameters:

getAppRequest - Request structure for get App request.

Returns:

Result of the GetApp operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getBranch

public GetBranchResult getBranch(GetBranchRequest request)

Retrieves a branch for an Amplify App.

Specified by:

getBranch in interface AWSAmplify

Parameters:

getBranchRequest - Result structure for get branch request.

Returns:

Result of the GetBranch operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getDomainAssociation

public GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest request)

Retrieves domain info that corresponds to an appId and domainName.

Specified by:

getDomainAssociation in interface AWSAmplify

Parameters:

getDomainAssociationRequest - Request structure for the get Domain Association request.

Returns:

Result of the GetDomainAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getJob

public GetJobResult getJob(GetJobRequest request)

Get a job for a branch, part of an Amplify App.

Specified by:

getJob in interface AWSAmplify

Parameters:

getJobRequest - Request structure for get job request.

Returns:

Result of the GetJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listApps

public ListAppsResult listApps(ListAppsRequest request)

Lists existing Amplify Apps.

Specified by:

listApps in interface AWSAmplify

Parameters:

listAppsRequest - Request structure for an Amplify App list request.

Returns:

Result of the ListApps operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listBranches

public ListBranchesResult listBranches(ListBranchesRequest request)

Lists branches for an Amplify App.

Specified by:

listBranches in interface AWSAmplify

Parameters:

listBranchesRequest - Request structure for list branches request.

Returns:

Result of the ListBranches operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDomainAssociations

public ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest request)

List domains with an app

Specified by:

listDomainAssociations in interface AWSAmplify

Parameters:

listDomainAssociationsRequest - Request structure for the list Domain Associations request.

Returns:

Result of the ListDomainAssociations operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listJobs

public ListJobsResult listJobs(ListJobsRequest request)

List Jobs for a branch, part of an Amplify App.

Specified by:

listJobs in interface AWSAmplify

Parameters:

listJobsRequest - Request structure for list job request.

Returns:

Result of the ListJobs operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startJob

public StartJobResult startJob(StartJobRequest request)

Starts a new job for a branch, part of an Amplify App.

Specified by:

startJob in interface AWSAmplify

Parameters:

startJobRequest - Request structure for Start job request.

Returns:

Result of the StartJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopJob

public StopJobResult stopJob(StopJobRequest request)

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

Specified by:

stopJob in interface AWSAmplify

Parameters:

stopJobRequest - Request structure for stop job request.

Returns:

Result of the StopJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateApp

public UpdateAppResult updateApp(UpdateAppRequest request)

Updates an existing Amplify App.

Specified by:

updateApp in interface AWSAmplify

Parameters:

updateAppRequest - Request structure for update App request.

Returns:

Result of the UpdateApp operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateBranch

public UpdateBranchResult updateBranch(UpdateBranchRequest request)

Updates a branch for an Amplify App.

Specified by:

updateBranch in interface AWSAmplify

Parameters:

updateBranchRequest - Request structure for update branch request.

Returns:

Result of the UpdateBranch operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateDomainAssociation

public UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest request)

Create a new DomainAssociation on an App

Specified by:

updateDomainAssociation in interface AWSAmplify

Parameters:

updateDomainAssociationRequest - Request structure for update Domain Association request.

Returns:

Result of the UpdateDomainAssociation operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSAmplify

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.