com.amazonaws.services.amplify

Interface AWSAmplify

All Known Subinterfaces:

AWSAmplifyAsync

All Known Implementing Classes:

AbstractAWSAmplify, AbstractAWSAmplifyAsync, AWSAmplifyAsyncClient, AWSAmplifyClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAmplify

Interface for accessing Amplify.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAmplify instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAppResult	createApp(CreateAppRequest createAppRequest) Creates a new Amplify App.
CreateBranchResult	createBranch(CreateBranchRequest createBranchRequest) Creates a new Branch for an Amplify App.
CreateDomainAssociationResult	createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest) Create a new DomainAssociation on an App
DeleteAppResult	deleteApp(DeleteAppRequest deleteAppRequest) Delete an existing Amplify App by appId.
DeleteBranchResult	deleteBranch(DeleteBranchRequest deleteBranchRequest) Deletes a branch for an Amplify App.
DeleteDomainAssociationResult	deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest) Deletes a DomainAssociation.
DeleteJobResult	deleteJob(DeleteJobRequest deleteJobRequest) Delete a job, for an Amplify branch, part of Amplify App.
GetAppResult	getApp(GetAppRequest getAppRequest) Retrieves an existing Amplify App by appId.
GetBranchResult	getBranch(GetBranchRequest getBranchRequest) 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 getDomainAssociationRequest) Retrieves domain info that corresponds to an appId and domainName.
GetJobResult	getJob(GetJobRequest getJobRequest) Get a job for a branch, part of an Amplify App.
ListAppsResult	listApps(ListAppsRequest listAppsRequest) Lists existing Amplify Apps.
ListBranchesResult	listBranches(ListBranchesRequest listBranchesRequest) Lists branches for an Amplify App.
ListDomainAssociationsResult	listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest) List domains with an app
ListJobsResult	listJobs(ListJobsRequest listJobsRequest) List Jobs for a branch, part of an Amplify App.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartJobResult	startJob(StartJobRequest startJobRequest) Starts a new job for a branch, part of an Amplify App.
StopJobResult	stopJob(StopJobRequest stopJobRequest) Stop a job that is in progress, for an Amplify branch, part of Amplify App.
UpdateAppResult	updateApp(UpdateAppRequest updateAppRequest) Updates an existing Amplify App.
UpdateBranchResult	updateBranch(UpdateBranchRequest updateBranchRequest) Updates a branch for an Amplify App.
UpdateDomainAssociationResult	updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest) Create a new DomainAssociation on an App

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createApp

CreateAppResult createApp(CreateAppRequest createAppRequest)

Creates a new Amplify App.

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

CreateBranchResult createBranch(CreateBranchRequest createBranchRequest)

Creates a new Branch for an Amplify App.

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

CreateDomainAssociationResult createDomainAssociation(CreateDomainAssociationRequest createDomainAssociationRequest)

Create a new DomainAssociation on an App

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

DeleteAppResult deleteApp(DeleteAppRequest deleteAppRequest)

Delete an existing Amplify App by appId.

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

DeleteBranchResult deleteBranch(DeleteBranchRequest deleteBranchRequest)

Deletes a branch for an Amplify App.

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

DeleteDomainAssociationResult deleteDomainAssociation(DeleteDomainAssociationRequest deleteDomainAssociationRequest)

Deletes a DomainAssociation.

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

DeleteJobResult deleteJob(DeleteJobRequest deleteJobRequest)

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

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

GetAppResult getApp(GetAppRequest getAppRequest)

Retrieves an existing Amplify App by appId.

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

GetBranchResult getBranch(GetBranchRequest getBranchRequest)

Retrieves a branch for an Amplify App.

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

GetDomainAssociationResult getDomainAssociation(GetDomainAssociationRequest getDomainAssociationRequest)

Retrieves domain info that corresponds to an appId and domainName.

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

GetJobResult getJob(GetJobRequest getJobRequest)

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

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

ListAppsResult listApps(ListAppsRequest listAppsRequest)

Lists existing Amplify Apps.

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

ListBranchesResult listBranches(ListBranchesRequest listBranchesRequest)

Lists branches for an Amplify App.

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

ListDomainAssociationsResult listDomainAssociations(ListDomainAssociationsRequest listDomainAssociationsRequest)

List domains with an app

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

ListJobsResult listJobs(ListJobsRequest listJobsRequest)

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

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

StartJobResult startJob(StartJobRequest startJobRequest)

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

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

StopJobResult stopJob(StopJobRequest stopJobRequest)

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

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

UpdateAppResult updateApp(UpdateAppRequest updateAppRequest)

Updates an existing Amplify App.

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

UpdateBranchResult updateBranch(UpdateBranchRequest updateBranchRequest)

Updates a branch for an Amplify App.

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

UpdateDomainAssociationResult updateDomainAssociation(UpdateDomainAssociationRequest updateDomainAssociationRequest)

Create a new DomainAssociation on an App

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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