com.amazonaws.services.amplifybackend

Interface AWSAmplifyBackend

All Known Subinterfaces:

AWSAmplifyBackendAsync

All Known Implementing Classes:

AbstractAWSAmplifyBackend, AbstractAWSAmplifyBackendAsync, AWSAmplifyBackendAsyncClient, AWSAmplifyBackendClient

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

Interface for accessing AmplifyBackend.

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

AWS Amplify Admin API

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
CloneBackendResult	cloneBackend(CloneBackendRequest cloneBackendRequest) This operation clones an existing backend.
CreateBackendResult	createBackend(CreateBackendRequest createBackendRequest) This operation creates a backend for an Amplify app.
CreateBackendAPIResult	createBackendAPI(CreateBackendAPIRequest createBackendAPIRequest) Creates a new backend API resource.
CreateBackendAuthResult	createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest) Creates a new backend authentication resource.
CreateBackendConfigResult	createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest) Creates a config object for a backend.
CreateBackendStorageResult	createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest) Creates a backend storage resource.
CreateTokenResult	createToken(CreateTokenRequest createTokenRequest) Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
DeleteBackendResult	deleteBackend(DeleteBackendRequest deleteBackendRequest) Removes an existing environment from your Amplify project.
DeleteBackendAPIResult	deleteBackendAPI(DeleteBackendAPIRequest deleteBackendAPIRequest) Deletes an existing backend API resource.
DeleteBackendAuthResult	deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest) Deletes an existing backend authentication resource.
DeleteBackendStorageResult	deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest) Removes the specified backend storage resource.
DeleteTokenResult	deleteToken(DeleteTokenRequest deleteTokenRequest) Deletes the challenge token based on the given appId and sessionId.
GenerateBackendAPIModelsResult	generateBackendAPIModels(GenerateBackendAPIModelsRequest generateBackendAPIModelsRequest) Generates a model schema for an existing backend API resource.
GetBackendResult	getBackend(GetBackendRequest getBackendRequest) Provides project-level details for your Amplify UI project.
GetBackendAPIResult	getBackendAPI(GetBackendAPIRequest getBackendAPIRequest) Gets the details for a backend API.
GetBackendAPIModelsResult	getBackendAPIModels(GetBackendAPIModelsRequest getBackendAPIModelsRequest) Gets a model introspection schema for an existing backend API resource.
GetBackendAuthResult	getBackendAuth(GetBackendAuthRequest getBackendAuthRequest) Gets a backend auth details.
GetBackendJobResult	getBackendJob(GetBackendJobRequest getBackendJobRequest) Returns information about a specific job.
GetBackendStorageResult	getBackendStorage(GetBackendStorageRequest getBackendStorageRequest) Gets details for a backend storage resource.
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.
GetTokenResult	getToken(GetTokenRequest getTokenRequest) Gets the challenge token based on the given appId and sessionId.
ImportBackendAuthResult	importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest) Imports an existing backend authentication resource.
ImportBackendStorageResult	importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest) Imports an existing backend storage resource.
ListBackendJobsResult	listBackendJobs(ListBackendJobsRequest listBackendJobsRequest) Lists the jobs for the backend of an Amplify app.
ListS3BucketsResult	listS3Buckets(ListS3BucketsRequest listS3BucketsRequest) The list of S3 buckets in your account.
RemoveAllBackendsResult	removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest) Removes all backend environments from your Amplify project.
RemoveBackendConfigResult	removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest) Removes the AWS resources required to access the Amplify Admin UI.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateBackendAPIResult	updateBackendAPI(UpdateBackendAPIRequest updateBackendAPIRequest) Updates an existing backend API resource.
UpdateBackendAuthResult	updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest) Updates an existing backend authentication resource.
UpdateBackendConfigResult	updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest) Updates the AWS resources required to access the Amplify Admin UI.
UpdateBackendJobResult	updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest) Updates a specific job.
UpdateBackendStorageResult	updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest) Updates an existing backend storage resource.

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

cloneBackend

CloneBackendResult cloneBackend(CloneBackendRequest cloneBackendRequest)

This operation clones an existing backend.

Parameters:

cloneBackendRequest - The request body for CloneBackend.

Returns:

Result of the CloneBackend operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createBackend

CreateBackendResult createBackend(CreateBackendRequest createBackendRequest)

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Parameters:

createBackendRequest - The request body for CreateBackend.

Returns:

Result of the CreateBackend operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createBackendAPI

CreateBackendAPIResult createBackendAPI(CreateBackendAPIRequest createBackendAPIRequest)

Creates a new backend API resource.

Parameters:

createBackendAPIRequest - The request body for CreateBackendAPI.

Returns:

Result of the CreateBackendAPI operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createBackendAuth

CreateBackendAuthResult createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)

Creates a new backend authentication resource.

Parameters:

createBackendAuthRequest - The request body for CreateBackendAuth.

Returns:

Result of the CreateBackendAuth operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createBackendConfig

CreateBackendConfigResult createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)

Creates a config object for a backend.

Parameters:

createBackendConfigRequest - The request body for CreateBackendConfig.

Returns:

Result of the CreateBackendConfig operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createBackendStorage

CreateBackendStorageResult createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest)

Creates a backend storage resource.

Parameters:

createBackendStorageRequest - The request body for CreateBackendStorage.

Returns:

Result of the CreateBackendStorage operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

createToken

CreateTokenResult createToken(CreateTokenRequest createTokenRequest)

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

Parameters:

createTokenRequest -

Returns:

Result of the CreateToken operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

deleteBackend

DeleteBackendResult deleteBackend(DeleteBackendRequest deleteBackendRequest)

Removes an existing environment from your Amplify project.

Parameters:

deleteBackendRequest -

Returns:

Result of the DeleteBackend operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

deleteBackendAPI

DeleteBackendAPIResult deleteBackendAPI(DeleteBackendAPIRequest deleteBackendAPIRequest)

Deletes an existing backend API resource.

Parameters:

deleteBackendAPIRequest - The request body for DeleteBackendAPI.

Returns:

Result of the DeleteBackendAPI operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

deleteBackendAuth

DeleteBackendAuthResult deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)

Deletes an existing backend authentication resource.

Parameters:

deleteBackendAuthRequest - The request body for DeleteBackendAuth.

Returns:

Result of the DeleteBackendAuth operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

deleteBackendStorage

DeleteBackendStorageResult deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest)

Removes the specified backend storage resource.

Parameters:

deleteBackendStorageRequest - The request body for DeleteBackendStorage.

Returns:

Result of the DeleteBackendStorage operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

deleteToken

DeleteTokenResult deleteToken(DeleteTokenRequest deleteTokenRequest)

Deletes the challenge token based on the given appId and sessionId.

Parameters:

deleteTokenRequest -

Returns:

Result of the DeleteToken operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

generateBackendAPIModels

GenerateBackendAPIModelsResult generateBackendAPIModels(GenerateBackendAPIModelsRequest generateBackendAPIModelsRequest)

Generates a model schema for an existing backend API resource.

Parameters:

generateBackendAPIModelsRequest - The request body for GenerateBackendAPIModels.

Returns:

Result of the GenerateBackendAPIModels operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackend

GetBackendResult getBackend(GetBackendRequest getBackendRequest)

Provides project-level details for your Amplify UI project.

Parameters:

getBackendRequest - The request body for GetBackend.

Returns:

Result of the GetBackend operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackendAPI

GetBackendAPIResult getBackendAPI(GetBackendAPIRequest getBackendAPIRequest)

Gets the details for a backend API.

Parameters:

getBackendAPIRequest - The request body for GetBackendAPI.

Returns:

Result of the GetBackendAPI operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackendAPIModels

GetBackendAPIModelsResult getBackendAPIModels(GetBackendAPIModelsRequest getBackendAPIModelsRequest)

Gets a model introspection schema for an existing backend API resource.

Parameters:

getBackendAPIModelsRequest - The request body for GetBackendAPIModels.

Returns:

Result of the GetBackendAPIModels operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackendAuth

GetBackendAuthResult getBackendAuth(GetBackendAuthRequest getBackendAuthRequest)

Gets a backend auth details.

Parameters:

getBackendAuthRequest - The request body for GetBackendAuth.

Returns:

Result of the GetBackendAuth operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackendJob

GetBackendJobResult getBackendJob(GetBackendJobRequest getBackendJobRequest)

Returns information about a specific job.

Parameters:

getBackendJobRequest -

Returns:

Result of the GetBackendJob operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getBackendStorage

GetBackendStorageResult getBackendStorage(GetBackendStorageRequest getBackendStorageRequest)

Gets details for a backend storage resource.

Parameters:

getBackendStorageRequest - The request body for GetBackendStorage.

Returns:

Result of the GetBackendStorage operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

getToken

GetTokenResult getToken(GetTokenRequest getTokenRequest)

Gets the challenge token based on the given appId and sessionId.

Parameters:

getTokenRequest -

Returns:

Result of the GetToken operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

importBackendAuth

ImportBackendAuthResult importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest)

Imports an existing backend authentication resource.

Parameters:

importBackendAuthRequest - The request body for ImportBackendAuth.

Returns:

Result of the ImportBackendAuth operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

importBackendStorage

ImportBackendStorageResult importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest)

Imports an existing backend storage resource.

Parameters:

importBackendStorageRequest - The request body for ImportBackendStorage.

Returns:

Result of the ImportBackendStorage operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

listBackendJobs

ListBackendJobsResult listBackendJobs(ListBackendJobsRequest listBackendJobsRequest)

Lists the jobs for the backend of an Amplify app.

Parameters:

listBackendJobsRequest - The request body for ListBackendJobs.

Returns:

Result of the ListBackendJobs operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

listS3Buckets

ListS3BucketsResult listS3Buckets(ListS3BucketsRequest listS3BucketsRequest)

The list of S3 buckets in your account.

Parameters:

listS3BucketsRequest - The request body for S3Buckets.

Returns:

Result of the ListS3Buckets operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

removeAllBackends

RemoveAllBackendsResult removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)

Removes all backend environments from your Amplify project.

Parameters:

removeAllBackendsRequest - The request body for RemoveAllBackends.

Returns:

Result of the RemoveAllBackends operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

removeBackendConfig

RemoveBackendConfigResult removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)

Removes the AWS resources required to access the Amplify Admin UI.

Parameters:

removeBackendConfigRequest -

Returns:

Result of the RemoveBackendConfig operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

updateBackendAPI

UpdateBackendAPIResult updateBackendAPI(UpdateBackendAPIRequest updateBackendAPIRequest)

Updates an existing backend API resource.

Parameters:

updateBackendAPIRequest - The request body for UpdateBackendAPI.

Returns:

Result of the UpdateBackendAPI operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

updateBackendAuth

UpdateBackendAuthResult updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)

Updates an existing backend authentication resource.

Parameters:

updateBackendAuthRequest - The request body for UpdateBackendAuth.

Returns:

Result of the UpdateBackendAuth operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

updateBackendConfig

UpdateBackendConfigResult updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)

Updates the AWS resources required to access the Amplify Admin UI.

Parameters:

updateBackendConfigRequest - The request body for UpdateBackendConfig.

Returns:

Result of the UpdateBackendConfig operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

updateBackendJob

UpdateBackendJobResult updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)

Updates a specific job.

Parameters:

updateBackendJobRequest - The request body for GetBackendJob.

Returns:

Result of the UpdateBackendJob operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

See Also:

AWS API Documentation

updateBackendStorage

UpdateBackendStorageResult updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest)

Updates an existing backend storage resource.

Parameters:

updateBackendStorageRequest - The request body for UpdateBackendStorage.

Returns:

Result of the UpdateBackendStorage operation returned by the service.

Throws:

NotFoundException - 404 response

GatewayTimeoutException - 504 response

TooManyRequestsException - 429 response

BadRequestException - 400 response

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.