Interface AmplifyBackendClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface AmplifyBackendClient
extends AwsClient

Service client for accessing AmplifyBackend. This can be created using the static builder() method.

AWS Amplify Admin API

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static AmplifyBackendClientBuilder	builder()	Create a builder that can be used to configure and create a AmplifyBackendClient.
default CloneBackendResponse	cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest)	This operation clones an existing backend.
default CloneBackendResponse	cloneBackend(CloneBackendRequest cloneBackendRequest)	This operation clones an existing backend.
static AmplifyBackendClient	create()	Create a AmplifyBackendClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBackendResponse	createBackend(Consumer<CreateBackendRequest.Builder> createBackendRequest)	This operation creates a backend for an Amplify app.
default CreateBackendResponse	createBackend(CreateBackendRequest createBackendRequest)	This operation creates a backend for an Amplify app.
default CreateBackendApiResponse	createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest)	Creates a new backend API resource.
default CreateBackendApiResponse	createBackendAPI(CreateBackendApiRequest createBackendApiRequest)	Creates a new backend API resource.
default CreateBackendAuthResponse	createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest)	Creates a new backend authentication resource.
default CreateBackendAuthResponse	createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)	Creates a new backend authentication resource.
default CreateBackendConfigResponse	createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest)	Creates a config object for a backend.
default CreateBackendConfigResponse	createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)	Creates a config object for a backend.
default CreateBackendStorageResponse	createBackendStorage(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest)	Creates a backend storage resource.
default CreateBackendStorageResponse	createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest)	Creates a backend storage resource.
default CreateTokenResponse	createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest)	Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
default CreateTokenResponse	createToken(CreateTokenRequest createTokenRequest)	Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
default DeleteBackendResponse	deleteBackend(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest)	Removes an existing environment from your Amplify project.
default DeleteBackendResponse	deleteBackend(DeleteBackendRequest deleteBackendRequest)	Removes an existing environment from your Amplify project.
default DeleteBackendApiResponse	deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest)	Deletes an existing backend API resource.
default DeleteBackendApiResponse	deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest)	Deletes an existing backend API resource.
default DeleteBackendAuthResponse	deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest)	Deletes an existing backend authentication resource.
default DeleteBackendAuthResponse	deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)	Deletes an existing backend authentication resource.
default DeleteBackendStorageResponse	deleteBackendStorage(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest)	Removes the specified backend storage resource.
default DeleteBackendStorageResponse	deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest)	Removes the specified backend storage resource.
default DeleteTokenResponse	deleteToken(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest)	Deletes the challenge token based on the given appId and sessionId.
default DeleteTokenResponse	deleteToken(DeleteTokenRequest deleteTokenRequest)	Deletes the challenge token based on the given appId and sessionId.
default GenerateBackendApiModelsResponse	generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest)	Generates a model schema for an existing backend API resource.
default GenerateBackendApiModelsResponse	generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest)	Generates a model schema for an existing backend API resource.
default GetBackendResponse	getBackend(Consumer<GetBackendRequest.Builder> getBackendRequest)	Provides project-level details for your Amplify UI project.
default GetBackendResponse	getBackend(GetBackendRequest getBackendRequest)	Provides project-level details for your Amplify UI project.
default GetBackendApiResponse	getBackendAPI(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest)	Gets the details for a backend API.
default GetBackendApiResponse	getBackendAPI(GetBackendApiRequest getBackendApiRequest)	Gets the details for a backend API.
default GetBackendApiModelsResponse	getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest)	Gets a model introspection schema for an existing backend API resource.
default GetBackendApiModelsResponse	getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest)	Gets a model introspection schema for an existing backend API resource.
default GetBackendAuthResponse	getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest)	Gets a backend auth details.
default GetBackendAuthResponse	getBackendAuth(GetBackendAuthRequest getBackendAuthRequest)	Gets a backend auth details.
default GetBackendJobResponse	getBackendJob(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest)	Returns information about a specific job.
default GetBackendJobResponse	getBackendJob(GetBackendJobRequest getBackendJobRequest)	Returns information about a specific job.
default GetBackendStorageResponse	getBackendStorage(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest)	Gets details for a backend storage resource.
default GetBackendStorageResponse	getBackendStorage(GetBackendStorageRequest getBackendStorageRequest)	Gets details for a backend storage resource.
default GetTokenResponse	getToken(Consumer<GetTokenRequest.Builder> getTokenRequest)	Gets the challenge token based on the given appId and sessionId.
default GetTokenResponse	getToken(GetTokenRequest getTokenRequest)	Gets the challenge token based on the given appId and sessionId.
default ImportBackendAuthResponse	importBackendAuth(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest)	Imports an existing backend authentication resource.
default ImportBackendAuthResponse	importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest)	Imports an existing backend authentication resource.
default ImportBackendStorageResponse	importBackendStorage(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest)	Imports an existing backend storage resource.
default ImportBackendStorageResponse	importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest)	Imports an existing backend storage resource.
default ListBackendJobsResponse	listBackendJobs(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)	Lists the jobs for the backend of an Amplify app.
default ListBackendJobsResponse	listBackendJobs(ListBackendJobsRequest listBackendJobsRequest)	Lists the jobs for the backend of an Amplify app.
default ListBackendJobsIterable	listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)	This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.
default ListBackendJobsIterable	listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest)	This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.
default ListS3BucketsResponse	listS3Buckets(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest)	The list of S3 buckets in your account.
default ListS3BucketsResponse	listS3Buckets(ListS3BucketsRequest listS3BucketsRequest)	The list of S3 buckets in your account.
default RemoveAllBackendsResponse	removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest)	Removes all backend environments from your Amplify project.
default RemoveAllBackendsResponse	removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)	Removes all backend environments from your Amplify project.
default RemoveBackendConfigResponse	removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest)	Removes the AWS resources required to access the Amplify Admin UI.
default RemoveBackendConfigResponse	removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)	Removes the AWS resources required to access the Amplify Admin UI.
default AmplifyBackendServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateBackendApiResponse	updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest)	Updates an existing backend API resource.
default UpdateBackendApiResponse	updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest)	Updates an existing backend API resource.
default UpdateBackendAuthResponse	updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest)	Updates an existing backend authentication resource.
default UpdateBackendAuthResponse	updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)	Updates an existing backend authentication resource.
default UpdateBackendConfigResponse	updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest)	Updates the AWS resources required to access the Amplify Admin UI.
default UpdateBackendConfigResponse	updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)	Updates the AWS resources required to access the Amplify Admin UI.
default UpdateBackendJobResponse	updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest)	Updates a specific job.
default UpdateBackendJobResponse	updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)	Updates a specific job.
default UpdateBackendStorageResponse	updateBackendStorage(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest)	Updates an existing backend storage resource.
default UpdateBackendStorageResponse	updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest)	Updates an existing backend storage resource.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

cloneBackend

default CloneBackendResponse cloneBackend(CloneBackendRequest cloneBackendRequest)
                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

This operation clones an existing backend.

Parameters:

cloneBackendRequest - The request body for CloneBackend.

Returns:

Result of the CloneBackend operation returned by the service.

See Also:

• AWS API Documentation

cloneBackend

default CloneBackendResponse cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest)
                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

This operation clones an existing backend.

This is a convenience which creates an instance of the CloneBackendRequest.Builder avoiding the need to create one manually via CloneBackendRequest.builder()

Parameters:

cloneBackendRequest - A Consumer that will call methods on CloneBackendRequest.Builder to create a request. The request body for CloneBackend.

Returns:

Result of the CloneBackend operation returned by the service.

See Also:

• AWS API Documentation

createBackend

default CreateBackendResponse createBackend(CreateBackendRequest createBackendRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

createBackend

default CreateBackendResponse createBackend(Consumer<CreateBackendRequest.Builder> createBackendRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the CreateBackendRequest.Builder avoiding the need to create one manually via CreateBackendRequest.builder()

Parameters:

createBackendRequest - A Consumer that will call methods on CreateBackendRequest.Builder to create a request. The request body for CreateBackend.

Returns:

Result of the CreateBackend operation returned by the service.

See Also:

• AWS API Documentation

createBackendAPI

default CreateBackendApiResponse createBackendAPI(CreateBackendApiRequest createBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a new backend API resource.

Parameters:

createBackendApiRequest - The request body for CreateBackendAPI.

Returns:

Result of the CreateBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

createBackendAPI

default CreateBackendApiResponse createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a new backend API resource.

This is a convenience which creates an instance of the CreateBackendApiRequest.Builder avoiding the need to create one manually via CreateBackendApiRequest.builder()

Parameters:

createBackendApiRequest - A Consumer that will call methods on CreateBackendApiRequest.Builder to create a request. The request body for CreateBackendAPI.

Returns:

Result of the CreateBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

createBackendAuth

default CreateBackendAuthResponse createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a new backend authentication resource.

Parameters:

createBackendAuthRequest - The request body for CreateBackendAuth.

Returns:

Result of the CreateBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

createBackendAuth

default CreateBackendAuthResponse createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a new backend authentication resource.

This is a convenience which creates an instance of the CreateBackendAuthRequest.Builder avoiding the need to create one manually via CreateBackendAuthRequest.builder()

Parameters:

createBackendAuthRequest - A Consumer that will call methods on CreateBackendAuthRequest.Builder to create a request. The request body for CreateBackendAuth.

Returns:

Result of the CreateBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

createBackendConfig

default CreateBackendConfigResponse createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a config object for a backend.

Parameters:

createBackendConfigRequest - The request body for CreateBackendConfig.

Returns:

Result of the CreateBackendConfig operation returned by the service.

See Also:

• AWS API Documentation

createBackendConfig

default CreateBackendConfigResponse createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a config object for a backend.

This is a convenience which creates an instance of the CreateBackendConfigRequest.Builder avoiding the need to create one manually via CreateBackendConfigRequest.builder()

Parameters:

createBackendConfigRequest - A Consumer that will call methods on CreateBackendConfigRequest.Builder to create a request. The request body for CreateBackendConfig.

Returns:

Result of the CreateBackendConfig operation returned by the service.

See Also:

• AWS API Documentation

createBackendStorage

default CreateBackendStorageResponse createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a backend storage resource.

Parameters:

createBackendStorageRequest - The request body for CreateBackendStorage.

Returns:

Result of the CreateBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

createBackendStorage

default CreateBackendStorageResponse createBackendStorage(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Creates a backend storage resource.

This is a convenience which creates an instance of the CreateBackendStorageRequest.Builder avoiding the need to create one manually via CreateBackendStorageRequest.builder()

Parameters:

createBackendStorageRequest - A Consumer that will call methods on CreateBackendStorageRequest.Builder to create a request. The request body for CreateBackendStorage.

Returns:

Result of the CreateBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

createToken

default CreateTokenResponse createToken(CreateTokenRequest createTokenRequest)
                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

createToken

default CreateTokenResponse createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest)
                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the CreateTokenRequest.Builder avoiding the need to create one manually via CreateTokenRequest.builder()

Parameters:

createTokenRequest - A Consumer that will call methods on CreateTokenRequest.Builder to create a request.

Returns:

Result of the CreateToken operation returned by the service.

See Also:

• AWS API Documentation

deleteBackend

default DeleteBackendResponse deleteBackend(DeleteBackendRequest deleteBackendRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Removes an existing environment from your Amplify project.

Parameters:

deleteBackendRequest -

Returns:

Result of the DeleteBackend operation returned by the service.

See Also:

• AWS API Documentation

deleteBackend

default DeleteBackendResponse deleteBackend(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Removes an existing environment from your Amplify project.

This is a convenience which creates an instance of the DeleteBackendRequest.Builder avoiding the need to create one manually via DeleteBackendRequest.builder()

Parameters:

deleteBackendRequest - A Consumer that will call methods on DeleteBackendRequest.Builder to create a request.

Returns:

Result of the DeleteBackend operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendAPI

default DeleteBackendApiResponse deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Deletes an existing backend API resource.

Parameters:

deleteBackendApiRequest - The request body for DeleteBackendAPI.

Returns:

Result of the DeleteBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendAPI

default DeleteBackendApiResponse deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Deletes an existing backend API resource.

This is a convenience which creates an instance of the DeleteBackendApiRequest.Builder avoiding the need to create one manually via DeleteBackendApiRequest.builder()

Parameters:

deleteBackendApiRequest - A Consumer that will call methods on DeleteBackendApiRequest.Builder to create a request. The request body for DeleteBackendAPI.

Returns:

Result of the DeleteBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendAuth

default DeleteBackendAuthResponse deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Deletes an existing backend authentication resource.

Parameters:

deleteBackendAuthRequest - The request body for DeleteBackendAuth.

Returns:

Result of the DeleteBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendAuth

default DeleteBackendAuthResponse deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Deletes an existing backend authentication resource.

This is a convenience which creates an instance of the DeleteBackendAuthRequest.Builder avoiding the need to create one manually via DeleteBackendAuthRequest.builder()

Parameters:

deleteBackendAuthRequest - A Consumer that will call methods on DeleteBackendAuthRequest.Builder to create a request. The request body for DeleteBackendAuth.

Returns:

Result of the DeleteBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendStorage

default DeleteBackendStorageResponse deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Removes the specified backend storage resource.

Parameters:

deleteBackendStorageRequest - The request body for DeleteBackendStorage.

Returns:

Result of the DeleteBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

deleteBackendStorage

default DeleteBackendStorageResponse deleteBackendStorage(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Removes the specified backend storage resource.

This is a convenience which creates an instance of the DeleteBackendStorageRequest.Builder avoiding the need to create one manually via DeleteBackendStorageRequest.builder()

Parameters:

deleteBackendStorageRequest - A Consumer that will call methods on DeleteBackendStorageRequest.Builder to create a request. The request body for DeleteBackendStorage.

Returns:

Result of the DeleteBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

deleteToken

default DeleteTokenResponse deleteToken(DeleteTokenRequest deleteTokenRequest)
                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

Parameters:

deleteTokenRequest -

Returns:

Result of the DeleteToken operation returned by the service.

See Also:

• AWS API Documentation

deleteToken

default DeleteTokenResponse deleteToken(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest)
                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the DeleteTokenRequest.Builder avoiding the need to create one manually via DeleteTokenRequest.builder()

Parameters:

deleteTokenRequest - A Consumer that will call methods on DeleteTokenRequest.Builder to create a request.

Returns:

Result of the DeleteToken operation returned by the service.

See Also:

• AWS API Documentation

generateBackendAPIModels

default GenerateBackendApiModelsResponse generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest)
                                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

generateBackendAPIModels

default GenerateBackendApiModelsResponse generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest)
                                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Generates a model schema for an existing backend API resource.

This is a convenience which creates an instance of the GenerateBackendApiModelsRequest.Builder avoiding the need to create one manually via GenerateBackendApiModelsRequest.builder()

Parameters:

generateBackendApiModelsRequest - A Consumer that will call methods on GenerateBackendApiModelsRequest.Builder to create a request. The request body for GenerateBackendAPIModels.

Returns:

Result of the GenerateBackendAPIModels operation returned by the service.

See Also:

• AWS API Documentation

getBackend

default GetBackendResponse getBackend(GetBackendRequest getBackendRequest)
                               throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

getBackend

default GetBackendResponse getBackend(Consumer<GetBackendRequest.Builder> getBackendRequest)
                               throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Provides project-level details for your Amplify UI project.

This is a convenience which creates an instance of the GetBackendRequest.Builder avoiding the need to create one manually via GetBackendRequest.builder()

Parameters:

getBackendRequest - A Consumer that will call methods on GetBackendRequest.Builder to create a request. The request body for GetBackend.

Returns:

Result of the GetBackend operation returned by the service.

See Also:

• AWS API Documentation

getBackendAPI

default GetBackendApiResponse getBackendAPI(GetBackendApiRequest getBackendApiRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets the details for a backend API.

Parameters:

getBackendApiRequest - The request body for GetBackendAPI.

Returns:

Result of the GetBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

getBackendAPI

default GetBackendApiResponse getBackendAPI(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets the details for a backend API.

This is a convenience which creates an instance of the GetBackendApiRequest.Builder avoiding the need to create one manually via GetBackendApiRequest.builder()

Parameters:

getBackendApiRequest - A Consumer that will call methods on GetBackendApiRequest.Builder to create a request. The request body for GetBackendAPI.

Returns:

Result of the GetBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

getBackendAPIModels

default GetBackendApiModelsResponse getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

getBackendAPIModels

default GetBackendApiModelsResponse getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the GetBackendApiModelsRequest.Builder avoiding the need to create one manually via GetBackendApiModelsRequest.builder()

Parameters:

getBackendApiModelsRequest - A Consumer that will call methods on GetBackendApiModelsRequest.Builder to create a request. The request body for GetBackendAPIModels.

Returns:

Result of the GetBackendAPIModels operation returned by the service.

See Also:

• AWS API Documentation

getBackendAuth

default GetBackendAuthResponse getBackendAuth(GetBackendAuthRequest getBackendAuthRequest)
                                       throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets a backend auth details.

Parameters:

getBackendAuthRequest - The request body for GetBackendAuth.

Returns:

Result of the GetBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

getBackendAuth

default GetBackendAuthResponse getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest)
                                       throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets a backend auth details.

This is a convenience which creates an instance of the GetBackendAuthRequest.Builder avoiding the need to create one manually via GetBackendAuthRequest.builder()

Parameters:

getBackendAuthRequest - A Consumer that will call methods on GetBackendAuthRequest.Builder to create a request. The request body for GetBackendAuth.

Returns:

Result of the GetBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

getBackendJob

default GetBackendJobResponse getBackendJob(GetBackendJobRequest getBackendJobRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Returns information about a specific job.

Parameters:

getBackendJobRequest -

Returns:

Result of the GetBackendJob operation returned by the service.

See Also:

• AWS API Documentation

getBackendJob

default GetBackendJobResponse getBackendJob(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Returns information about a specific job.

This is a convenience which creates an instance of the GetBackendJobRequest.Builder avoiding the need to create one manually via GetBackendJobRequest.builder()

Parameters:

getBackendJobRequest - A Consumer that will call methods on GetBackendJobRequest.Builder to create a request.

Returns:

Result of the GetBackendJob operation returned by the service.

See Also:

• AWS API Documentation

getBackendStorage

default GetBackendStorageResponse getBackendStorage(GetBackendStorageRequest getBackendStorageRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets details for a backend storage resource.

Parameters:

getBackendStorageRequest - The request body for GetBackendStorage.

Returns:

Result of the GetBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

getBackendStorage

default GetBackendStorageResponse getBackendStorage(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Gets details for a backend storage resource.

This is a convenience which creates an instance of the GetBackendStorageRequest.Builder avoiding the need to create one manually via GetBackendStorageRequest.builder()

Parameters:

getBackendStorageRequest - A Consumer that will call methods on GetBackendStorageRequest.Builder to create a request. The request body for GetBackendStorage.

Returns:

Result of the GetBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

getToken

default GetTokenResponse getToken(GetTokenRequest getTokenRequest)
                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

Parameters:

getTokenRequest -

Returns:

Result of the GetToken operation returned by the service.

See Also:

• AWS API Documentation

getToken

default GetTokenResponse getToken(Consumer<GetTokenRequest.Builder> getTokenRequest)
                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the GetTokenRequest.Builder avoiding the need to create one manually via GetTokenRequest.builder()

Parameters:

getTokenRequest - A Consumer that will call methods on GetTokenRequest.Builder to create a request.

Returns:

Result of the GetToken operation returned by the service.

See Also:

• AWS API Documentation

importBackendAuth

default ImportBackendAuthResponse importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Imports an existing backend authentication resource.

Parameters:

importBackendAuthRequest - The request body for ImportBackendAuth.

Returns:

Result of the ImportBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

importBackendAuth

default ImportBackendAuthResponse importBackendAuth(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Imports an existing backend authentication resource.

This is a convenience which creates an instance of the ImportBackendAuthRequest.Builder avoiding the need to create one manually via ImportBackendAuthRequest.builder()

Parameters:

importBackendAuthRequest - A Consumer that will call methods on ImportBackendAuthRequest.Builder to create a request. The request body for ImportBackendAuth.

Returns:

Result of the ImportBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

importBackendStorage

default ImportBackendStorageResponse importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Imports an existing backend storage resource.

Parameters:

importBackendStorageRequest - The request body for ImportBackendStorage.

Returns:

Result of the ImportBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

importBackendStorage

default ImportBackendStorageResponse importBackendStorage(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Imports an existing backend storage resource.

This is a convenience which creates an instance of the ImportBackendStorageRequest.Builder avoiding the need to create one manually via ImportBackendStorageRequest.builder()

Parameters:

importBackendStorageRequest - A Consumer that will call methods on ImportBackendStorageRequest.Builder to create a request. The request body for ImportBackendStorage.

Returns:

Result of the ImportBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

listBackendJobs

default ListBackendJobsResponse listBackendJobs(ListBackendJobsRequest listBackendJobsRequest)
                                         throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

listBackendJobs

default ListBackendJobsResponse listBackendJobs(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)
                                         throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Lists the jobs for the backend of an Amplify app.

This is a convenience which creates an instance of the ListBackendJobsRequest.Builder avoiding the need to create one manually via ListBackendJobsRequest.builder()

Parameters:

listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request. The request body for ListBackendJobs.

Returns:

Result of the ListBackendJobs operation returned by the service.

See Also:

• AWS API Documentation

listBackendJobsPaginator

default ListBackendJobsIterable listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest)
                                                  throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client
             .listBackendJobsPaginator(request);
     for (software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.

Parameters:

listBackendJobsRequest - The request body for ListBackendJobs.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBackendJobsPaginator

default ListBackendJobsIterable listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)
                                                  throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

This is a variant of listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client
             .listBackendJobsPaginator(request);
     for (software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsIterable responses = client.listBackendJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest) operation.

This is a convenience which creates an instance of the ListBackendJobsRequest.Builder avoiding the need to create one manually via ListBackendJobsRequest.builder()

Parameters:

listBackendJobsRequest - A Consumer that will call methods on ListBackendJobsRequest.Builder to create a request. The request body for ListBackendJobs.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listS3Buckets

default ListS3BucketsResponse listS3Buckets(ListS3BucketsRequest listS3BucketsRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

listS3Buckets

default ListS3BucketsResponse listS3Buckets(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest)
                                     throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

The list of S3 buckets in your account.

This is a convenience which creates an instance of the ListS3BucketsRequest.Builder avoiding the need to create one manually via ListS3BucketsRequest.builder()

Parameters:

listS3BucketsRequest - A Consumer that will call methods on ListS3BucketsRequest.Builder to create a request. The request body for S3Buckets.

Returns:

Result of the ListS3Buckets operation returned by the service.

See Also:

• AWS API Documentation

removeAllBackends

default RemoveAllBackendsResponse removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

removeAllBackends

default RemoveAllBackendsResponse removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Removes all backend environments from your Amplify project.

This is a convenience which creates an instance of the RemoveAllBackendsRequest.Builder avoiding the need to create one manually via RemoveAllBackendsRequest.builder()

Parameters:

removeAllBackendsRequest - A Consumer that will call methods on RemoveAllBackendsRequest.Builder to create a request. The request body for RemoveAllBackends.

Returns:

Result of the RemoveAllBackends operation returned by the service.

See Also:

• AWS API Documentation

removeBackendConfig

default RemoveBackendConfigResponse removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

Parameters:

removeBackendConfigRequest -

Returns:

Result of the RemoveBackendConfig operation returned by the service.

See Also:

• AWS API Documentation

removeBackendConfig

default RemoveBackendConfigResponse removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the RemoveBackendConfigRequest.Builder avoiding the need to create one manually via RemoveBackendConfigRequest.builder()

Parameters:

removeBackendConfigRequest - A Consumer that will call methods on RemoveBackendConfigRequest.Builder to create a request.

Returns:

Result of the RemoveBackendConfig operation returned by the service.

See Also:

• AWS API Documentation

updateBackendAPI

default UpdateBackendApiResponse updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend API resource.

Parameters:

updateBackendApiRequest - The request body for UpdateBackendAPI.

Returns:

Result of the UpdateBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

updateBackendAPI

default UpdateBackendApiResponse updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend API resource.

This is a convenience which creates an instance of the UpdateBackendApiRequest.Builder avoiding the need to create one manually via UpdateBackendApiRequest.builder()

Parameters:

updateBackendApiRequest - A Consumer that will call methods on UpdateBackendApiRequest.Builder to create a request. The request body for UpdateBackendAPI.

Returns:

Result of the UpdateBackendAPI operation returned by the service.

See Also:

• AWS API Documentation

updateBackendAuth

default UpdateBackendAuthResponse updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend authentication resource.

Parameters:

updateBackendAuthRequest - The request body for UpdateBackendAuth.

Returns:

Result of the UpdateBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

updateBackendAuth

default UpdateBackendAuthResponse updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest)
                                             throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend authentication resource.

This is a convenience which creates an instance of the UpdateBackendAuthRequest.Builder avoiding the need to create one manually via UpdateBackendAuthRequest.builder()

Parameters:

updateBackendAuthRequest - A Consumer that will call methods on UpdateBackendAuthRequest.Builder to create a request. The request body for UpdateBackendAuth.

Returns:

Result of the UpdateBackendAuth operation returned by the service.

See Also:

• AWS API Documentation

updateBackendConfig

default UpdateBackendConfigResponse updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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.

See Also:

• AWS API Documentation

updateBackendConfig

default UpdateBackendConfigResponse updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest)
                                                 throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

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

This is a convenience which creates an instance of the UpdateBackendConfigRequest.Builder avoiding the need to create one manually via UpdateBackendConfigRequest.builder()

Parameters:

updateBackendConfigRequest - A Consumer that will call methods on UpdateBackendConfigRequest.Builder to create a request. The request body for UpdateBackendConfig.

Returns:

Result of the UpdateBackendConfig operation returned by the service.

See Also:

• AWS API Documentation

updateBackendJob

default UpdateBackendJobResponse updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates a specific job.

Parameters:

updateBackendJobRequest - The request body for GetBackendJob.

Returns:

Result of the UpdateBackendJob operation returned by the service.

See Also:

• AWS API Documentation

updateBackendJob

default UpdateBackendJobResponse updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest)
                                           throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates a specific job.

This is a convenience which creates an instance of the UpdateBackendJobRequest.Builder avoiding the need to create one manually via UpdateBackendJobRequest.builder()

Parameters:

updateBackendJobRequest - A Consumer that will call methods on UpdateBackendJobRequest.Builder to create a request. The request body for GetBackendJob.

Returns:

Result of the UpdateBackendJob operation returned by the service.

See Also:

• AWS API Documentation

updateBackendStorage

default UpdateBackendStorageResponse updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend storage resource.

Parameters:

updateBackendStorageRequest - The request body for UpdateBackendStorage.

Returns:

Result of the UpdateBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

updateBackendStorage

default UpdateBackendStorageResponse updateBackendStorage(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest)
                                                   throws NotFoundException,
GatewayTimeoutException,
TooManyRequestsException,
BadRequestException,
AwsServiceException,
SdkClientException,
AmplifyBackendException

Updates an existing backend storage resource.

This is a convenience which creates an instance of the UpdateBackendStorageRequest.Builder avoiding the need to create one manually via UpdateBackendStorageRequest.builder()

Parameters:

updateBackendStorageRequest - A Consumer that will call methods on UpdateBackendStorageRequest.Builder to create a request. The request body for UpdateBackendStorage.

Returns:

Result of the UpdateBackendStorage operation returned by the service.

See Also:

• AWS API Documentation

create

static AmplifyBackendClient create()

Create a AmplifyBackendClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static AmplifyBackendClientBuilder builder()

Create a builder that can be used to configure and create a AmplifyBackendClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default AmplifyBackendServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration