Interface AmplifyBackendAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
AWS Amplify Admin API
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aAmplifyBackendAsyncClient
.default CompletableFuture
<CloneBackendResponse> cloneBackend
(Consumer<CloneBackendRequest.Builder> cloneBackendRequest) This operation clones an existing backend.default CompletableFuture
<CloneBackendResponse> cloneBackend
(CloneBackendRequest cloneBackendRequest) This operation clones an existing backend.static AmplifyBackendAsyncClient
create()
Create aAmplifyBackendAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateBackendResponse> createBackend
(Consumer<CreateBackendRequest.Builder> createBackendRequest) This operation creates a backend for an Amplify app.default CompletableFuture
<CreateBackendResponse> createBackend
(CreateBackendRequest createBackendRequest) This operation creates a backend for an Amplify app.createBackendAPI
(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest) Creates a new backend API resource.createBackendAPI
(CreateBackendApiRequest createBackendApiRequest) Creates a new backend API resource.createBackendAuth
(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest) Creates a new backend authentication resource.createBackendAuth
(CreateBackendAuthRequest createBackendAuthRequest) Creates a new backend authentication resource.createBackendConfig
(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest) Creates a config object for a backend.createBackendConfig
(CreateBackendConfigRequest createBackendConfigRequest) Creates a config object for a backend.createBackendStorage
(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest) Creates a backend storage resource.createBackendStorage
(CreateBackendStorageRequest createBackendStorageRequest) Creates a backend storage resource.default CompletableFuture
<CreateTokenResponse> createToken
(Consumer<CreateTokenRequest.Builder> createTokenRequest) Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.default CompletableFuture
<CreateTokenResponse> createToken
(CreateTokenRequest createTokenRequest) Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.default CompletableFuture
<DeleteBackendResponse> deleteBackend
(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest) Removes an existing environment from your Amplify project.default CompletableFuture
<DeleteBackendResponse> deleteBackend
(DeleteBackendRequest deleteBackendRequest) Removes an existing environment from your Amplify project.deleteBackendAPI
(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest) Deletes an existing backend API resource.deleteBackendAPI
(DeleteBackendApiRequest deleteBackendApiRequest) Deletes an existing backend API resource.deleteBackendAuth
(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest) Deletes an existing backend authentication resource.deleteBackendAuth
(DeleteBackendAuthRequest deleteBackendAuthRequest) Deletes an existing backend authentication resource.deleteBackendStorage
(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest) Removes the specified backend storage resource.deleteBackendStorage
(DeleteBackendStorageRequest deleteBackendStorageRequest) Removes the specified backend storage resource.default CompletableFuture
<DeleteTokenResponse> deleteToken
(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest) Deletes the challenge token based on the given appId and sessionId.default CompletableFuture
<DeleteTokenResponse> deleteToken
(DeleteTokenRequest deleteTokenRequest) Deletes the challenge token based on the given appId and sessionId.generateBackendAPIModels
(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest) Generates a model schema for an existing backend API resource.generateBackendAPIModels
(GenerateBackendApiModelsRequest generateBackendApiModelsRequest) Generates a model schema for an existing backend API resource.default CompletableFuture
<GetBackendResponse> getBackend
(Consumer<GetBackendRequest.Builder> getBackendRequest) Provides project-level details for your Amplify UI project.default CompletableFuture
<GetBackendResponse> getBackend
(GetBackendRequest getBackendRequest) Provides project-level details for your Amplify UI project.default CompletableFuture
<GetBackendApiResponse> getBackendAPI
(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest) Gets the details for a backend API.default CompletableFuture
<GetBackendApiResponse> getBackendAPI
(GetBackendApiRequest getBackendApiRequest) Gets the details for a backend API.getBackendAPIModels
(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest) Gets a model introspection schema for an existing backend API resource.getBackendAPIModels
(GetBackendApiModelsRequest getBackendApiModelsRequest) Gets a model introspection schema for an existing backend API resource.default CompletableFuture
<GetBackendAuthResponse> getBackendAuth
(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest) Gets a backend auth details.default CompletableFuture
<GetBackendAuthResponse> getBackendAuth
(GetBackendAuthRequest getBackendAuthRequest) Gets a backend auth details.default CompletableFuture
<GetBackendJobResponse> getBackendJob
(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest) Returns information about a specific job.default CompletableFuture
<GetBackendJobResponse> getBackendJob
(GetBackendJobRequest getBackendJobRequest) Returns information about a specific job.getBackendStorage
(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest) Gets details for a backend storage resource.getBackendStorage
(GetBackendStorageRequest getBackendStorageRequest) Gets details for a backend storage resource.default CompletableFuture
<GetTokenResponse> getToken
(Consumer<GetTokenRequest.Builder> getTokenRequest) Gets the challenge token based on the given appId and sessionId.default CompletableFuture
<GetTokenResponse> getToken
(GetTokenRequest getTokenRequest) Gets the challenge token based on the given appId and sessionId.importBackendAuth
(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest) Imports an existing backend authentication resource.importBackendAuth
(ImportBackendAuthRequest importBackendAuthRequest) Imports an existing backend authentication resource.importBackendStorage
(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest) Imports an existing backend storage resource.importBackendStorage
(ImportBackendStorageRequest importBackendStorageRequest) Imports an existing backend storage resource.default CompletableFuture
<ListBackendJobsResponse> listBackendJobs
(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) Lists the jobs for the backend of an Amplify app.default CompletableFuture
<ListBackendJobsResponse> listBackendJobs
(ListBackendJobsRequest listBackendJobsRequest) Lists the jobs for the backend of an Amplify app.default ListBackendJobsPublisher
listBackendJobsPaginator
(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) This is a variant oflistBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.default ListBackendJobsPublisher
listBackendJobsPaginator
(ListBackendJobsRequest listBackendJobsRequest) This is a variant oflistBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.default CompletableFuture
<ListS3BucketsResponse> listS3Buckets
(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest) The list of S3 buckets in your account.default CompletableFuture
<ListS3BucketsResponse> listS3Buckets
(ListS3BucketsRequest listS3BucketsRequest) The list of S3 buckets in your account.removeAllBackends
(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest) Removes all backend environments from your Amplify project.removeAllBackends
(RemoveAllBackendsRequest removeAllBackendsRequest) Removes all backend environments from your Amplify project.removeBackendConfig
(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest) Removes the AWS resources required to access the Amplify Admin UI.removeBackendConfig
(RemoveBackendConfigRequest removeBackendConfigRequest) Removes the AWS resources required to access the Amplify Admin UI.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdateBackendAPI
(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest) Updates an existing backend API resource.updateBackendAPI
(UpdateBackendApiRequest updateBackendApiRequest) Updates an existing backend API resource.updateBackendAuth
(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest) Updates an existing backend authentication resource.updateBackendAuth
(UpdateBackendAuthRequest updateBackendAuthRequest) Updates an existing backend authentication resource.updateBackendConfig
(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest) Updates the AWS resources required to access the Amplify Admin UI.updateBackendConfig
(UpdateBackendConfigRequest updateBackendConfigRequest) Updates the AWS resources required to access the Amplify Admin UI.updateBackendJob
(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest) Updates a specific job.updateBackendJob
(UpdateBackendJobRequest updateBackendJobRequest) Updates a specific job.updateBackendStorage
(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest) Updates an existing backend storage resource.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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cloneBackend
default CompletableFuture<CloneBackendResponse> cloneBackend(CloneBackendRequest cloneBackendRequest) This operation clones an existing backend.
- Parameters:
cloneBackendRequest
- The request body for CloneBackend.- Returns:
- A Java Future containing the result of the CloneBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cloneBackend
default CompletableFuture<CloneBackendResponse> cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest) 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 viaCloneBackendRequest.builder()
- Parameters:
cloneBackendRequest
- AConsumer
that will call methods onCloneBackendRequest.Builder
to create a request. The request body for CloneBackend.- Returns:
- A Java Future containing the result of the CloneBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackend
default CompletableFuture<CreateBackendResponse> 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:
- A Java Future containing the result of the CreateBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackend
default CompletableFuture<CreateBackendResponse> createBackend(Consumer<CreateBackendRequest.Builder> createBackendRequest) 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 viaCreateBackendRequest.builder()
- Parameters:
createBackendRequest
- AConsumer
that will call methods onCreateBackendRequest.Builder
to create a request. The request body for CreateBackend.- Returns:
- A Java Future containing the result of the CreateBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendAPI
default CompletableFuture<CreateBackendApiResponse> createBackendAPI(CreateBackendApiRequest createBackendApiRequest) Creates a new backend API resource.
- Parameters:
createBackendApiRequest
- The request body for CreateBackendAPI.- Returns:
- A Java Future containing the result of the CreateBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendAPI
default CompletableFuture<CreateBackendApiResponse> createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest) 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 viaCreateBackendApiRequest.builder()
- Parameters:
createBackendApiRequest
- AConsumer
that will call methods onCreateBackendApiRequest.Builder
to create a request. The request body for CreateBackendAPI.- Returns:
- A Java Future containing the result of the CreateBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendAuth
default CompletableFuture<CreateBackendAuthResponse> createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest) Creates a new backend authentication resource.
- Parameters:
createBackendAuthRequest
- The request body for CreateBackendAuth.- Returns:
- A Java Future containing the result of the CreateBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendAuth
default CompletableFuture<CreateBackendAuthResponse> createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest) 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 viaCreateBackendAuthRequest.builder()
- Parameters:
createBackendAuthRequest
- AConsumer
that will call methods onCreateBackendAuthRequest.Builder
to create a request. The request body for CreateBackendAuth.- Returns:
- A Java Future containing the result of the CreateBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendConfig
default CompletableFuture<CreateBackendConfigResponse> createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest) Creates a config object for a backend.
- Parameters:
createBackendConfigRequest
- The request body for CreateBackendConfig.- Returns:
- A Java Future containing the result of the CreateBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendConfig
default CompletableFuture<CreateBackendConfigResponse> createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest) 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 viaCreateBackendConfigRequest.builder()
- Parameters:
createBackendConfigRequest
- AConsumer
that will call methods onCreateBackendConfigRequest.Builder
to create a request. The request body for CreateBackendConfig.- Returns:
- A Java Future containing the result of the CreateBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendStorage
default CompletableFuture<CreateBackendStorageResponse> createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest) Creates a backend storage resource.
- Parameters:
createBackendStorageRequest
- The request body for CreateBackendStorage.- Returns:
- A Java Future containing the result of the CreateBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createBackendStorage
default CompletableFuture<CreateBackendStorageResponse> createBackendStorage(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest) Creates a backend storage resource.
This is a convenience which creates an instance of the
CreateBackendStorageRequest.Builder
avoiding the need to create one manually viaCreateBackendStorageRequest.builder()
- Parameters:
createBackendStorageRequest
- AConsumer
that will call methods onCreateBackendStorageRequest.Builder
to create a request. The request body for CreateBackendStorage.- Returns:
- A Java Future containing the result of the CreateBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createToken
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
- Parameters:
createTokenRequest
-- Returns:
- A Java Future containing the result of the CreateToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createToken
default CompletableFuture<CreateTokenResponse> createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest) 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 viaCreateTokenRequest.builder()
- Parameters:
createTokenRequest
- AConsumer
that will call methods onCreateTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackend
default CompletableFuture<DeleteBackendResponse> deleteBackend(DeleteBackendRequest deleteBackendRequest) Removes an existing environment from your Amplify project.
- Parameters:
deleteBackendRequest
-- Returns:
- A Java Future containing the result of the DeleteBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackend
default CompletableFuture<DeleteBackendResponse> deleteBackend(Consumer<DeleteBackendRequest.Builder> deleteBackendRequest) 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 viaDeleteBackendRequest.builder()
- Parameters:
deleteBackendRequest
- AConsumer
that will call methods onDeleteBackendRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendAPI
default CompletableFuture<DeleteBackendApiResponse> deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest) Deletes an existing backend API resource.
- Parameters:
deleteBackendApiRequest
- The request body for DeleteBackendAPI.- Returns:
- A Java Future containing the result of the DeleteBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendAPI
default CompletableFuture<DeleteBackendApiResponse> deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest) 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 viaDeleteBackendApiRequest.builder()
- Parameters:
deleteBackendApiRequest
- AConsumer
that will call methods onDeleteBackendApiRequest.Builder
to create a request. The request body for DeleteBackendAPI.- Returns:
- A Java Future containing the result of the DeleteBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendAuth
default CompletableFuture<DeleteBackendAuthResponse> deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest) Deletes an existing backend authentication resource.
- Parameters:
deleteBackendAuthRequest
- The request body for DeleteBackendAuth.- Returns:
- A Java Future containing the result of the DeleteBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendAuth
default CompletableFuture<DeleteBackendAuthResponse> deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest) 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 viaDeleteBackendAuthRequest.builder()
- Parameters:
deleteBackendAuthRequest
- AConsumer
that will call methods onDeleteBackendAuthRequest.Builder
to create a request. The request body for DeleteBackendAuth.- Returns:
- A Java Future containing the result of the DeleteBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendStorage
default CompletableFuture<DeleteBackendStorageResponse> deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest) Removes the specified backend storage resource.
- Parameters:
deleteBackendStorageRequest
- The request body for DeleteBackendStorage.- Returns:
- A Java Future containing the result of the DeleteBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackendStorage
default CompletableFuture<DeleteBackendStorageResponse> deleteBackendStorage(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest) 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 viaDeleteBackendStorageRequest.builder()
- Parameters:
deleteBackendStorageRequest
- AConsumer
that will call methods onDeleteBackendStorageRequest.Builder
to create a request. The request body for DeleteBackendStorage.- Returns:
- A Java Future containing the result of the DeleteBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteToken
Deletes the challenge token based on the given appId and sessionId.
- Parameters:
deleteTokenRequest
-- Returns:
- A Java Future containing the result of the DeleteToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteToken
default CompletableFuture<DeleteTokenResponse> deleteToken(Consumer<DeleteTokenRequest.Builder> deleteTokenRequest) 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 viaDeleteTokenRequest.builder()
- Parameters:
deleteTokenRequest
- AConsumer
that will call methods onDeleteTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateBackendAPIModels
default CompletableFuture<GenerateBackendApiModelsResponse> generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest) Generates a model schema for an existing backend API resource.
- Parameters:
generateBackendApiModelsRequest
- The request body for GenerateBackendAPIModels.- Returns:
- A Java Future containing the result of the GenerateBackendAPIModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
generateBackendAPIModels
default CompletableFuture<GenerateBackendApiModelsResponse> generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest) 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 viaGenerateBackendApiModelsRequest.builder()
- Parameters:
generateBackendApiModelsRequest
- AConsumer
that will call methods onGenerateBackendApiModelsRequest.Builder
to create a request. The request body for GenerateBackendAPIModels.- Returns:
- A Java Future containing the result of the GenerateBackendAPIModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackend
Provides project-level details for your Amplify UI project.
- Parameters:
getBackendRequest
- The request body for GetBackend.- Returns:
- A Java Future containing the result of the GetBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackend
default CompletableFuture<GetBackendResponse> getBackend(Consumer<GetBackendRequest.Builder> getBackendRequest) 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 viaGetBackendRequest.builder()
- Parameters:
getBackendRequest
- AConsumer
that will call methods onGetBackendRequest.Builder
to create a request. The request body for GetBackend.- Returns:
- A Java Future containing the result of the GetBackend operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAPI
default CompletableFuture<GetBackendApiResponse> getBackendAPI(GetBackendApiRequest getBackendApiRequest) Gets the details for a backend API.
- Parameters:
getBackendApiRequest
- The request body for GetBackendAPI.- Returns:
- A Java Future containing the result of the GetBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAPI
default CompletableFuture<GetBackendApiResponse> getBackendAPI(Consumer<GetBackendApiRequest.Builder> getBackendApiRequest) 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 viaGetBackendApiRequest.builder()
- Parameters:
getBackendApiRequest
- AConsumer
that will call methods onGetBackendApiRequest.Builder
to create a request. The request body for GetBackendAPI.- Returns:
- A Java Future containing the result of the GetBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAPIModels
default CompletableFuture<GetBackendApiModelsResponse> getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest) Gets a model introspection schema for an existing backend API resource.
- Parameters:
getBackendApiModelsRequest
- The request body for GetBackendAPIModels.- Returns:
- A Java Future containing the result of the GetBackendAPIModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAPIModels
default CompletableFuture<GetBackendApiModelsResponse> getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest) 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 viaGetBackendApiModelsRequest.builder()
- Parameters:
getBackendApiModelsRequest
- AConsumer
that will call methods onGetBackendApiModelsRequest.Builder
to create a request. The request body for GetBackendAPIModels.- Returns:
- A Java Future containing the result of the GetBackendAPIModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAuth
default CompletableFuture<GetBackendAuthResponse> getBackendAuth(GetBackendAuthRequest getBackendAuthRequest) Gets a backend auth details.
- Parameters:
getBackendAuthRequest
- The request body for GetBackendAuth.- Returns:
- A Java Future containing the result of the GetBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendAuth
default CompletableFuture<GetBackendAuthResponse> getBackendAuth(Consumer<GetBackendAuthRequest.Builder> getBackendAuthRequest) Gets a backend auth details.
This is a convenience which creates an instance of the
GetBackendAuthRequest.Builder
avoiding the need to create one manually viaGetBackendAuthRequest.builder()
- Parameters:
getBackendAuthRequest
- AConsumer
that will call methods onGetBackendAuthRequest.Builder
to create a request. The request body for GetBackendAuth.- Returns:
- A Java Future containing the result of the GetBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendJob
default CompletableFuture<GetBackendJobResponse> getBackendJob(GetBackendJobRequest getBackendJobRequest) Returns information about a specific job.
- Parameters:
getBackendJobRequest
-- Returns:
- A Java Future containing the result of the GetBackendJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendJob
default CompletableFuture<GetBackendJobResponse> getBackendJob(Consumer<GetBackendJobRequest.Builder> getBackendJobRequest) 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 viaGetBackendJobRequest.builder()
- Parameters:
getBackendJobRequest
- AConsumer
that will call methods onGetBackendJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetBackendJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendStorage
default CompletableFuture<GetBackendStorageResponse> getBackendStorage(GetBackendStorageRequest getBackendStorageRequest) Gets details for a backend storage resource.
- Parameters:
getBackendStorageRequest
- The request body for GetBackendStorage.- Returns:
- A Java Future containing the result of the GetBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getBackendStorage
default CompletableFuture<GetBackendStorageResponse> getBackendStorage(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest) 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 viaGetBackendStorageRequest.builder()
- Parameters:
getBackendStorageRequest
- AConsumer
that will call methods onGetBackendStorageRequest.Builder
to create a request. The request body for GetBackendStorage.- Returns:
- A Java Future containing the result of the GetBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getToken
Gets the challenge token based on the given appId and sessionId.
- Parameters:
getTokenRequest
-- Returns:
- A Java Future containing the result of the GetToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getToken
default CompletableFuture<GetTokenResponse> getToken(Consumer<GetTokenRequest.Builder> getTokenRequest) 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 viaGetTokenRequest.builder()
- Parameters:
getTokenRequest
- AConsumer
that will call methods onGetTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importBackendAuth
default CompletableFuture<ImportBackendAuthResponse> importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest) Imports an existing backend authentication resource.
- Parameters:
importBackendAuthRequest
- The request body for ImportBackendAuth.- Returns:
- A Java Future containing the result of the ImportBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importBackendAuth
default CompletableFuture<ImportBackendAuthResponse> importBackendAuth(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest) 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 viaImportBackendAuthRequest.builder()
- Parameters:
importBackendAuthRequest
- AConsumer
that will call methods onImportBackendAuthRequest.Builder
to create a request. The request body for ImportBackendAuth.- Returns:
- A Java Future containing the result of the ImportBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importBackendStorage
default CompletableFuture<ImportBackendStorageResponse> importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest) Imports an existing backend storage resource.
- Parameters:
importBackendStorageRequest
- The request body for ImportBackendStorage.- Returns:
- A Java Future containing the result of the ImportBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
importBackendStorage
default CompletableFuture<ImportBackendStorageResponse> importBackendStorage(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest) 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 viaImportBackendStorageRequest.builder()
- Parameters:
importBackendStorageRequest
- AConsumer
that will call methods onImportBackendStorageRequest.Builder
to create a request. The request body for ImportBackendStorage.- Returns:
- A Java Future containing the result of the ImportBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendJobs
default CompletableFuture<ListBackendJobsResponse> listBackendJobs(ListBackendJobsRequest listBackendJobsRequest) Lists the jobs for the backend of an Amplify app.
- Parameters:
listBackendJobsRequest
- The request body for ListBackendJobs.- Returns:
- A Java Future containing the result of the ListBackendJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendJobs
default CompletableFuture<ListBackendJobsResponse> listBackendJobs(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) 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 viaListBackendJobsRequest.builder()
- Parameters:
listBackendJobsRequest
- AConsumer
that will call methods onListBackendJobsRequest.Builder
to create a request. The request body for ListBackendJobs.- Returns:
- A Java Future containing the result of the ListBackendJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendJobsPaginator
default ListBackendJobsPublisher listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest) This is a variant of
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBackendJobsPaginator
default ListBackendJobsPublisher listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest) This is a variant of
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsResponse response) { //... }; });
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 viaListBackendJobsRequest.builder()
- Parameters:
listBackendJobsRequest
- AConsumer
that will call methods onListBackendJobsRequest.Builder
to create a request. The request body for ListBackendJobs.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listS3Buckets
default CompletableFuture<ListS3BucketsResponse> listS3Buckets(ListS3BucketsRequest listS3BucketsRequest) The list of S3 buckets in your account.
- Parameters:
listS3BucketsRequest
- The request body for S3Buckets.- Returns:
- A Java Future containing the result of the ListS3Buckets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listS3Buckets
default CompletableFuture<ListS3BucketsResponse> listS3Buckets(Consumer<ListS3BucketsRequest.Builder> listS3BucketsRequest) 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 viaListS3BucketsRequest.builder()
- Parameters:
listS3BucketsRequest
- AConsumer
that will call methods onListS3BucketsRequest.Builder
to create a request. The request body for S3Buckets.- Returns:
- A Java Future containing the result of the ListS3Buckets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeAllBackends
default CompletableFuture<RemoveAllBackendsResponse> removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest) Removes all backend environments from your Amplify project.
- Parameters:
removeAllBackendsRequest
- The request body for RemoveAllBackends.- Returns:
- A Java Future containing the result of the RemoveAllBackends operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeAllBackends
default CompletableFuture<RemoveAllBackendsResponse> removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest) 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 viaRemoveAllBackendsRequest.builder()
- Parameters:
removeAllBackendsRequest
- AConsumer
that will call methods onRemoveAllBackendsRequest.Builder
to create a request. The request body for RemoveAllBackends.- Returns:
- A Java Future containing the result of the RemoveAllBackends operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeBackendConfig
default CompletableFuture<RemoveBackendConfigResponse> removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest) Removes the AWS resources required to access the Amplify Admin UI.
- Parameters:
removeBackendConfigRequest
-- Returns:
- A Java Future containing the result of the RemoveBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeBackendConfig
default CompletableFuture<RemoveBackendConfigResponse> removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest) 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 viaRemoveBackendConfigRequest.builder()
- Parameters:
removeBackendConfigRequest
- AConsumer
that will call methods onRemoveBackendConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RemoveBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendAPI
default CompletableFuture<UpdateBackendApiResponse> updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest) Updates an existing backend API resource.
- Parameters:
updateBackendApiRequest
- The request body for UpdateBackendAPI.- Returns:
- A Java Future containing the result of the UpdateBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendAPI
default CompletableFuture<UpdateBackendApiResponse> updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest) 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 viaUpdateBackendApiRequest.builder()
- Parameters:
updateBackendApiRequest
- AConsumer
that will call methods onUpdateBackendApiRequest.Builder
to create a request. The request body for UpdateBackendAPI.- Returns:
- A Java Future containing the result of the UpdateBackendAPI operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendAuth
default CompletableFuture<UpdateBackendAuthResponse> updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest) Updates an existing backend authentication resource.
- Parameters:
updateBackendAuthRequest
- The request body for UpdateBackendAuth.- Returns:
- A Java Future containing the result of the UpdateBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendAuth
default CompletableFuture<UpdateBackendAuthResponse> updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest) 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 viaUpdateBackendAuthRequest.builder()
- Parameters:
updateBackendAuthRequest
- AConsumer
that will call methods onUpdateBackendAuthRequest.Builder
to create a request. The request body for UpdateBackendAuth.- Returns:
- A Java Future containing the result of the UpdateBackendAuth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendConfig
default CompletableFuture<UpdateBackendConfigResponse> updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest) Updates the AWS resources required to access the Amplify Admin UI.
- Parameters:
updateBackendConfigRequest
- The request body for UpdateBackendConfig.- Returns:
- A Java Future containing the result of the UpdateBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendConfig
default CompletableFuture<UpdateBackendConfigResponse> updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest) 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 viaUpdateBackendConfigRequest.builder()
- Parameters:
updateBackendConfigRequest
- AConsumer
that will call methods onUpdateBackendConfigRequest.Builder
to create a request. The request body for UpdateBackendConfig.- Returns:
- A Java Future containing the result of the UpdateBackendConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendJob
default CompletableFuture<UpdateBackendJobResponse> updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest) Updates a specific job.
- Parameters:
updateBackendJobRequest
- The request body for GetBackendJob.- Returns:
- A Java Future containing the result of the UpdateBackendJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendJob
default CompletableFuture<UpdateBackendJobResponse> updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest) Updates a specific job.
This is a convenience which creates an instance of the
UpdateBackendJobRequest.Builder
avoiding the need to create one manually viaUpdateBackendJobRequest.builder()
- Parameters:
updateBackendJobRequest
- AConsumer
that will call methods onUpdateBackendJobRequest.Builder
to create a request. The request body for GetBackendJob.- Returns:
- A Java Future containing the result of the UpdateBackendJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendStorage
default CompletableFuture<UpdateBackendStorageResponse> updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest) Updates an existing backend storage resource.
- Parameters:
updateBackendStorageRequest
- The request body for UpdateBackendStorage.- Returns:
- A Java Future containing the result of the UpdateBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBackendStorage
default CompletableFuture<UpdateBackendStorageResponse> updateBackendStorage(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest) 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 viaUpdateBackendStorageRequest.builder()
- Parameters:
updateBackendStorageRequest
- AConsumer
that will call methods onUpdateBackendStorageRequest.Builder
to create a request. The request body for UpdateBackendStorage.- Returns:
- A Java Future containing the result of the UpdateBackendStorage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- NotFoundException 404 response
- GatewayTimeoutException 504 response
- TooManyRequestsException 429 response
- BadRequestException 400 response
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- AmplifyBackendException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAmplifyBackendAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmplifyBackendAsyncClient
.
-