com.amazonaws.services.amplifybackend

Class AWSAmplifyBackendClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.amplifybackend.AWSAmplifyBackendClient

All Implemented Interfaces:

AWSAmplifyBackend

Direct Known Subclasses:

AWSAmplifyBackendAsyncClient

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

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

AWS Amplify Admin API

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.amplifybackend.AWSAmplifyBackend

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSAmplifyBackendClientBuilder	builder()
CloneBackendResult	cloneBackend(CloneBackendRequest request) This operation clones an existing backend.
CreateBackendResult	createBackend(CreateBackendRequest request) This operation creates a backend for an Amplify app.
CreateBackendAPIResult	createBackendAPI(CreateBackendAPIRequest request) Creates a new backend API resource.
CreateBackendAuthResult	createBackendAuth(CreateBackendAuthRequest request) Creates a new backend authentication resource.
CreateBackendConfigResult	createBackendConfig(CreateBackendConfigRequest request) Creates a config object for a backend.
CreateBackendStorageResult	createBackendStorage(CreateBackendStorageRequest request) Creates a backend storage resource.
CreateTokenResult	createToken(CreateTokenRequest request) Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
DeleteBackendResult	deleteBackend(DeleteBackendRequest request) Removes an existing environment from your Amplify project.
DeleteBackendAPIResult	deleteBackendAPI(DeleteBackendAPIRequest request) Deletes an existing backend API resource.
DeleteBackendAuthResult	deleteBackendAuth(DeleteBackendAuthRequest request) Deletes an existing backend authentication resource.
DeleteBackendStorageResult	deleteBackendStorage(DeleteBackendStorageRequest request) Removes the specified backend storage resource.
DeleteTokenResult	deleteToken(DeleteTokenRequest request) Deletes the challenge token based on the given appId and sessionId.
GenerateBackendAPIModelsResult	generateBackendAPIModels(GenerateBackendAPIModelsRequest request) Generates a model schema for an existing backend API resource.
GetBackendResult	getBackend(GetBackendRequest request) Provides project-level details for your Amplify UI project.
GetBackendAPIResult	getBackendAPI(GetBackendAPIRequest request) Gets the details for a backend API.
GetBackendAPIModelsResult	getBackendAPIModels(GetBackendAPIModelsRequest request) Gets a model introspection schema for an existing backend API resource.
GetBackendAuthResult	getBackendAuth(GetBackendAuthRequest request) Gets a backend auth details.
GetBackendJobResult	getBackendJob(GetBackendJobRequest request) Returns information about a specific job.
GetBackendStorageResult	getBackendStorage(GetBackendStorageRequest request) 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 request) Gets the challenge token based on the given appId and sessionId.
ImportBackendAuthResult	importBackendAuth(ImportBackendAuthRequest request) Imports an existing backend authentication resource.
ImportBackendStorageResult	importBackendStorage(ImportBackendStorageRequest request) Imports an existing backend storage resource.
ListBackendJobsResult	listBackendJobs(ListBackendJobsRequest request) Lists the jobs for the backend of an Amplify app.
ListS3BucketsResult	listS3Buckets(ListS3BucketsRequest request) The list of S3 buckets in your account.
RemoveAllBackendsResult	removeAllBackends(RemoveAllBackendsRequest request) Removes all backend environments from your Amplify project.
RemoveBackendConfigResult	removeBackendConfig(RemoveBackendConfigRequest request) 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 request) Updates an existing backend API resource.
UpdateBackendAuthResult	updateBackendAuth(UpdateBackendAuthRequest request) Updates an existing backend authentication resource.
UpdateBackendConfigResult	updateBackendConfig(UpdateBackendConfigRequest request) Updates the AWS resources required to access the Amplify Admin UI.
UpdateBackendJobResult	updateBackendJob(UpdateBackendJobRequest request) Updates a specific job.
UpdateBackendStorageResult	updateBackendStorage(UpdateBackendStorageRequest request) Updates an existing backend storage resource.

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, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSAmplifyBackendClientBuilder builder()

cloneBackend

public CloneBackendResult cloneBackend(CloneBackendRequest request)

This operation clones an existing backend.

Specified by:

cloneBackend in interface AWSAmplifyBackend

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

public CreateBackendResult createBackend(CreateBackendRequest request)

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

Specified by:

createBackend in interface AWSAmplifyBackend

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

public CreateBackendAPIResult createBackendAPI(CreateBackendAPIRequest request)

Creates a new backend API resource.

Specified by:

createBackendAPI in interface AWSAmplifyBackend

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

public CreateBackendAuthResult createBackendAuth(CreateBackendAuthRequest request)

Creates a new backend authentication resource.

Specified by:

createBackendAuth in interface AWSAmplifyBackend

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

public CreateBackendConfigResult createBackendConfig(CreateBackendConfigRequest request)

Creates a config object for a backend.

Specified by:

createBackendConfig in interface AWSAmplifyBackend

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

public CreateBackendStorageResult createBackendStorage(CreateBackendStorageRequest request)

Creates a backend storage resource.

Specified by:

createBackendStorage in interface AWSAmplifyBackend

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

public CreateTokenResult createToken(CreateTokenRequest request)

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

Specified by:

createToken in interface AWSAmplifyBackend

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

public DeleteBackendResult deleteBackend(DeleteBackendRequest request)

Removes an existing environment from your Amplify project.

Specified by:

deleteBackend in interface AWSAmplifyBackend

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

public DeleteBackendAPIResult deleteBackendAPI(DeleteBackendAPIRequest request)

Deletes an existing backend API resource.

Specified by:

deleteBackendAPI in interface AWSAmplifyBackend

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

public DeleteBackendAuthResult deleteBackendAuth(DeleteBackendAuthRequest request)

Deletes an existing backend authentication resource.

Specified by:

deleteBackendAuth in interface AWSAmplifyBackend

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

public DeleteBackendStorageResult deleteBackendStorage(DeleteBackendStorageRequest request)

Removes the specified backend storage resource.

Specified by:

deleteBackendStorage in interface AWSAmplifyBackend

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

public DeleteTokenResult deleteToken(DeleteTokenRequest request)

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

Specified by:

deleteToken in interface AWSAmplifyBackend

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

public GenerateBackendAPIModelsResult generateBackendAPIModels(GenerateBackendAPIModelsRequest request)

Generates a model schema for an existing backend API resource.

Specified by:

generateBackendAPIModels in interface AWSAmplifyBackend

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

public GetBackendResult getBackend(GetBackendRequest request)

Provides project-level details for your Amplify UI project.

Specified by:

getBackend in interface AWSAmplifyBackend

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

public GetBackendAPIResult getBackendAPI(GetBackendAPIRequest request)

Gets the details for a backend API.

Specified by:

getBackendAPI in interface AWSAmplifyBackend

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

public GetBackendAPIModelsResult getBackendAPIModels(GetBackendAPIModelsRequest request)

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

Specified by:

getBackendAPIModels in interface AWSAmplifyBackend

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

public GetBackendAuthResult getBackendAuth(GetBackendAuthRequest request)

Gets a backend auth details.

Specified by:

getBackendAuth in interface AWSAmplifyBackend

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

public GetBackendJobResult getBackendJob(GetBackendJobRequest request)

Returns information about a specific job.

Specified by:

getBackendJob in interface AWSAmplifyBackend

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

public GetBackendStorageResult getBackendStorage(GetBackendStorageRequest request)

Gets details for a backend storage resource.

Specified by:

getBackendStorage in interface AWSAmplifyBackend

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

public GetTokenResult getToken(GetTokenRequest request)

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

Specified by:

getToken in interface AWSAmplifyBackend

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

public ImportBackendAuthResult importBackendAuth(ImportBackendAuthRequest request)

Imports an existing backend authentication resource.

Specified by:

importBackendAuth in interface AWSAmplifyBackend

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

public ImportBackendStorageResult importBackendStorage(ImportBackendStorageRequest request)

Imports an existing backend storage resource.

Specified by:

importBackendStorage in interface AWSAmplifyBackend

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

public ListBackendJobsResult listBackendJobs(ListBackendJobsRequest request)

Lists the jobs for the backend of an Amplify app.

Specified by:

listBackendJobs in interface AWSAmplifyBackend

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

public ListS3BucketsResult listS3Buckets(ListS3BucketsRequest request)

The list of S3 buckets in your account.

Specified by:

listS3Buckets in interface AWSAmplifyBackend

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

public RemoveAllBackendsResult removeAllBackends(RemoveAllBackendsRequest request)

Removes all backend environments from your Amplify project.

Specified by:

removeAllBackends in interface AWSAmplifyBackend

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

public RemoveBackendConfigResult removeBackendConfig(RemoveBackendConfigRequest request)

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

Specified by:

removeBackendConfig in interface AWSAmplifyBackend

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

public UpdateBackendAPIResult updateBackendAPI(UpdateBackendAPIRequest request)

Updates an existing backend API resource.

Specified by:

updateBackendAPI in interface AWSAmplifyBackend

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

public UpdateBackendAuthResult updateBackendAuth(UpdateBackendAuthRequest request)

Updates an existing backend authentication resource.

Specified by:

updateBackendAuth in interface AWSAmplifyBackend

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

public UpdateBackendConfigResult updateBackendConfig(UpdateBackendConfigRequest request)

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

Specified by:

updateBackendConfig in interface AWSAmplifyBackend

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

public UpdateBackendJobResult updateBackendJob(UpdateBackendJobRequest request)

Updates a specific job.

Specified by:

updateBackendJob in interface AWSAmplifyBackend

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

public UpdateBackendStorageResult updateBackendStorage(UpdateBackendStorageRequest request)

Updates an existing backend storage resource.

Specified by:

updateBackendStorage in interface AWSAmplifyBackend

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

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 AWSAmplifyBackend

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSAmplifyBackend

Overrides:

shutdown in class AmazonWebServiceClient