@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAmplifyBackendAsync extends AWSAmplifyBackend
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAmplifyBackendAsync
instead.
AWS Amplify Admin API
ENDPOINT_PREFIX
cloneBackend, createBackend, createBackendAPI, createBackendAuth, createBackendConfig, createBackendStorage, createToken, deleteBackend, deleteBackendAPI, deleteBackendAuth, deleteBackendStorage, deleteToken, generateBackendAPIModels, getBackend, getBackendAPI, getBackendAPIModels, getBackendAuth, getBackendJob, getBackendStorage, getCachedResponseMetadata, getToken, importBackendAuth, importBackendStorage, listBackendJobs, listS3Buckets, removeAllBackends, removeBackendConfig, shutdown, updateBackendAPI, updateBackendAuth, updateBackendConfig, updateBackendJob, updateBackendStorage
Future<CloneBackendResult> cloneBackendAsync(CloneBackendRequest cloneBackendRequest)
This operation clones an existing backend.
cloneBackendRequest
- The request body for CloneBackend.Future<CloneBackendResult> cloneBackendAsync(CloneBackendRequest cloneBackendRequest, AsyncHandler<CloneBackendRequest,CloneBackendResult> asyncHandler)
This operation clones an existing backend.
cloneBackendRequest
- The request body for CloneBackend.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackendResult> createBackendAsync(CreateBackendRequest createBackendRequest)
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
createBackendRequest
- The request body for CreateBackend.Future<CreateBackendResult> createBackendAsync(CreateBackendRequest createBackendRequest, AsyncHandler<CreateBackendRequest,CreateBackendResult> asyncHandler)
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
createBackendRequest
- The request body for CreateBackend.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackendAPIResult> createBackendAPIAsync(CreateBackendAPIRequest createBackendAPIRequest)
Creates a new backend API resource.
createBackendAPIRequest
- The request body for CreateBackendAPI.Future<CreateBackendAPIResult> createBackendAPIAsync(CreateBackendAPIRequest createBackendAPIRequest, AsyncHandler<CreateBackendAPIRequest,CreateBackendAPIResult> asyncHandler)
Creates a new backend API resource.
createBackendAPIRequest
- The request body for CreateBackendAPI.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackendAuthResult> createBackendAuthAsync(CreateBackendAuthRequest createBackendAuthRequest)
Creates a new backend authentication resource.
createBackendAuthRequest
- The request body for CreateBackendAuth.Future<CreateBackendAuthResult> createBackendAuthAsync(CreateBackendAuthRequest createBackendAuthRequest, AsyncHandler<CreateBackendAuthRequest,CreateBackendAuthResult> asyncHandler)
Creates a new backend authentication resource.
createBackendAuthRequest
- The request body for CreateBackendAuth.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackendConfigResult> createBackendConfigAsync(CreateBackendConfigRequest createBackendConfigRequest)
Creates a config object for a backend.
createBackendConfigRequest
- The request body for CreateBackendConfig.Future<CreateBackendConfigResult> createBackendConfigAsync(CreateBackendConfigRequest createBackendConfigRequest, AsyncHandler<CreateBackendConfigRequest,CreateBackendConfigResult> asyncHandler)
Creates a config object for a backend.
createBackendConfigRequest
- The request body for CreateBackendConfig.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackendStorageResult> createBackendStorageAsync(CreateBackendStorageRequest createBackendStorageRequest)
Creates a backend storage resource.
createBackendStorageRequest
- The request body for CreateBackendStorage.Future<CreateBackendStorageResult> createBackendStorageAsync(CreateBackendStorageRequest createBackendStorageRequest, AsyncHandler<CreateBackendStorageRequest,CreateBackendStorageResult> asyncHandler)
Creates a backend storage resource.
createBackendStorageRequest
- The request body for CreateBackendStorage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
createTokenRequest
- Future<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest, AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
createTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackendResult> deleteBackendAsync(DeleteBackendRequest deleteBackendRequest)
Removes an existing environment from your Amplify project.
deleteBackendRequest
- Future<DeleteBackendResult> deleteBackendAsync(DeleteBackendRequest deleteBackendRequest, AsyncHandler<DeleteBackendRequest,DeleteBackendResult> asyncHandler)
Removes an existing environment from your Amplify project.
deleteBackendRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackendAPIResult> deleteBackendAPIAsync(DeleteBackendAPIRequest deleteBackendAPIRequest)
Deletes an existing backend API resource.
deleteBackendAPIRequest
- The request body for DeleteBackendAPI.Future<DeleteBackendAPIResult> deleteBackendAPIAsync(DeleteBackendAPIRequest deleteBackendAPIRequest, AsyncHandler<DeleteBackendAPIRequest,DeleteBackendAPIResult> asyncHandler)
Deletes an existing backend API resource.
deleteBackendAPIRequest
- The request body for DeleteBackendAPI.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackendAuthResult> deleteBackendAuthAsync(DeleteBackendAuthRequest deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
deleteBackendAuthRequest
- The request body for DeleteBackendAuth.Future<DeleteBackendAuthResult> deleteBackendAuthAsync(DeleteBackendAuthRequest deleteBackendAuthRequest, AsyncHandler<DeleteBackendAuthRequest,DeleteBackendAuthResult> asyncHandler)
Deletes an existing backend authentication resource.
deleteBackendAuthRequest
- The request body for DeleteBackendAuth.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackendStorageResult> deleteBackendStorageAsync(DeleteBackendStorageRequest deleteBackendStorageRequest)
Removes the specified backend storage resource.
deleteBackendStorageRequest
- The request body for DeleteBackendStorage.Future<DeleteBackendStorageResult> deleteBackendStorageAsync(DeleteBackendStorageRequest deleteBackendStorageRequest, AsyncHandler<DeleteBackendStorageRequest,DeleteBackendStorageResult> asyncHandler)
Removes the specified backend storage resource.
deleteBackendStorageRequest
- The request body for DeleteBackendStorage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTokenResult> deleteTokenAsync(DeleteTokenRequest deleteTokenRequest)
Deletes the challenge token based on the given appId and sessionId.
deleteTokenRequest
- Future<DeleteTokenResult> deleteTokenAsync(DeleteTokenRequest deleteTokenRequest, AsyncHandler<DeleteTokenRequest,DeleteTokenResult> asyncHandler)
Deletes the challenge token based on the given appId and sessionId.
deleteTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GenerateBackendAPIModelsResult> generateBackendAPIModelsAsync(GenerateBackendAPIModelsRequest generateBackendAPIModelsRequest)
Generates a model schema for an existing backend API resource.
generateBackendAPIModelsRequest
- The request body for GenerateBackendAPIModels.Future<GenerateBackendAPIModelsResult> generateBackendAPIModelsAsync(GenerateBackendAPIModelsRequest generateBackendAPIModelsRequest, AsyncHandler<GenerateBackendAPIModelsRequest,GenerateBackendAPIModelsResult> asyncHandler)
Generates a model schema for an existing backend API resource.
generateBackendAPIModelsRequest
- The request body for GenerateBackendAPIModels.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendResult> getBackendAsync(GetBackendRequest getBackendRequest)
Provides project-level details for your Amplify UI project.
getBackendRequest
- The request body for GetBackend.Future<GetBackendResult> getBackendAsync(GetBackendRequest getBackendRequest, AsyncHandler<GetBackendRequest,GetBackendResult> asyncHandler)
Provides project-level details for your Amplify UI project.
getBackendRequest
- The request body for GetBackend.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendAPIResult> getBackendAPIAsync(GetBackendAPIRequest getBackendAPIRequest)
Gets the details for a backend API.
getBackendAPIRequest
- The request body for GetBackendAPI.Future<GetBackendAPIResult> getBackendAPIAsync(GetBackendAPIRequest getBackendAPIRequest, AsyncHandler<GetBackendAPIRequest,GetBackendAPIResult> asyncHandler)
Gets the details for a backend API.
getBackendAPIRequest
- The request body for GetBackendAPI.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendAPIModelsResult> getBackendAPIModelsAsync(GetBackendAPIModelsRequest getBackendAPIModelsRequest)
Gets a model introspection schema for an existing backend API resource.
getBackendAPIModelsRequest
- The request body for GetBackendAPIModels.Future<GetBackendAPIModelsResult> getBackendAPIModelsAsync(GetBackendAPIModelsRequest getBackendAPIModelsRequest, AsyncHandler<GetBackendAPIModelsRequest,GetBackendAPIModelsResult> asyncHandler)
Gets a model introspection schema for an existing backend API resource.
getBackendAPIModelsRequest
- The request body for GetBackendAPIModels.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendAuthResult> getBackendAuthAsync(GetBackendAuthRequest getBackendAuthRequest)
Gets a backend auth details.
getBackendAuthRequest
- The request body for GetBackendAuth.Future<GetBackendAuthResult> getBackendAuthAsync(GetBackendAuthRequest getBackendAuthRequest, AsyncHandler<GetBackendAuthRequest,GetBackendAuthResult> asyncHandler)
Gets a backend auth details.
getBackendAuthRequest
- The request body for GetBackendAuth.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendJobResult> getBackendJobAsync(GetBackendJobRequest getBackendJobRequest)
Returns information about a specific job.
getBackendJobRequest
- Future<GetBackendJobResult> getBackendJobAsync(GetBackendJobRequest getBackendJobRequest, AsyncHandler<GetBackendJobRequest,GetBackendJobResult> asyncHandler)
Returns information about a specific job.
getBackendJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackendStorageResult> getBackendStorageAsync(GetBackendStorageRequest getBackendStorageRequest)
Gets details for a backend storage resource.
getBackendStorageRequest
- The request body for GetBackendStorage.Future<GetBackendStorageResult> getBackendStorageAsync(GetBackendStorageRequest getBackendStorageRequest, AsyncHandler<GetBackendStorageRequest,GetBackendStorageResult> asyncHandler)
Gets details for a backend storage resource.
getBackendStorageRequest
- The request body for GetBackendStorage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetTokenResult> getTokenAsync(GetTokenRequest getTokenRequest)
Gets the challenge token based on the given appId and sessionId.
getTokenRequest
- Future<GetTokenResult> getTokenAsync(GetTokenRequest getTokenRequest, AsyncHandler<GetTokenRequest,GetTokenResult> asyncHandler)
Gets the challenge token based on the given appId and sessionId.
getTokenRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportBackendAuthResult> importBackendAuthAsync(ImportBackendAuthRequest importBackendAuthRequest)
Imports an existing backend authentication resource.
importBackendAuthRequest
- The request body for ImportBackendAuth.Future<ImportBackendAuthResult> importBackendAuthAsync(ImportBackendAuthRequest importBackendAuthRequest, AsyncHandler<ImportBackendAuthRequest,ImportBackendAuthResult> asyncHandler)
Imports an existing backend authentication resource.
importBackendAuthRequest
- The request body for ImportBackendAuth.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ImportBackendStorageResult> importBackendStorageAsync(ImportBackendStorageRequest importBackendStorageRequest)
Imports an existing backend storage resource.
importBackendStorageRequest
- The request body for ImportBackendStorage.Future<ImportBackendStorageResult> importBackendStorageAsync(ImportBackendStorageRequest importBackendStorageRequest, AsyncHandler<ImportBackendStorageRequest,ImportBackendStorageResult> asyncHandler)
Imports an existing backend storage resource.
importBackendStorageRequest
- The request body for ImportBackendStorage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackendJobsResult> listBackendJobsAsync(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
listBackendJobsRequest
- The request body for ListBackendJobs.Future<ListBackendJobsResult> listBackendJobsAsync(ListBackendJobsRequest listBackendJobsRequest, AsyncHandler<ListBackendJobsRequest,ListBackendJobsResult> asyncHandler)
Lists the jobs for the backend of an Amplify app.
listBackendJobsRequest
- The request body for ListBackendJobs.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListS3BucketsResult> listS3BucketsAsync(ListS3BucketsRequest listS3BucketsRequest)
The list of S3 buckets in your account.
listS3BucketsRequest
- The request body for S3Buckets.Future<ListS3BucketsResult> listS3BucketsAsync(ListS3BucketsRequest listS3BucketsRequest, AsyncHandler<ListS3BucketsRequest,ListS3BucketsResult> asyncHandler)
The list of S3 buckets in your account.
listS3BucketsRequest
- The request body for S3Buckets.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveAllBackendsResult> removeAllBackendsAsync(RemoveAllBackendsRequest removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
removeAllBackendsRequest
- The request body for RemoveAllBackends.Future<RemoveAllBackendsResult> removeAllBackendsAsync(RemoveAllBackendsRequest removeAllBackendsRequest, AsyncHandler<RemoveAllBackendsRequest,RemoveAllBackendsResult> asyncHandler)
Removes all backend environments from your Amplify project.
removeAllBackendsRequest
- The request body for RemoveAllBackends.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveBackendConfigResult> removeBackendConfigAsync(RemoveBackendConfigRequest removeBackendConfigRequest)
Removes the AWS resources required to access the Amplify Admin UI.
removeBackendConfigRequest
- Future<RemoveBackendConfigResult> removeBackendConfigAsync(RemoveBackendConfigRequest removeBackendConfigRequest, AsyncHandler<RemoveBackendConfigRequest,RemoveBackendConfigResult> asyncHandler)
Removes the AWS resources required to access the Amplify Admin UI.
removeBackendConfigRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackendAPIResult> updateBackendAPIAsync(UpdateBackendAPIRequest updateBackendAPIRequest)
Updates an existing backend API resource.
updateBackendAPIRequest
- The request body for UpdateBackendAPI.Future<UpdateBackendAPIResult> updateBackendAPIAsync(UpdateBackendAPIRequest updateBackendAPIRequest, AsyncHandler<UpdateBackendAPIRequest,UpdateBackendAPIResult> asyncHandler)
Updates an existing backend API resource.
updateBackendAPIRequest
- The request body for UpdateBackendAPI.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackendAuthResult> updateBackendAuthAsync(UpdateBackendAuthRequest updateBackendAuthRequest)
Updates an existing backend authentication resource.
updateBackendAuthRequest
- The request body for UpdateBackendAuth.Future<UpdateBackendAuthResult> updateBackendAuthAsync(UpdateBackendAuthRequest updateBackendAuthRequest, AsyncHandler<UpdateBackendAuthRequest,UpdateBackendAuthResult> asyncHandler)
Updates an existing backend authentication resource.
updateBackendAuthRequest
- The request body for UpdateBackendAuth.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackendConfigResult> updateBackendConfigAsync(UpdateBackendConfigRequest updateBackendConfigRequest)
Updates the AWS resources required to access the Amplify Admin UI.
updateBackendConfigRequest
- The request body for UpdateBackendConfig.Future<UpdateBackendConfigResult> updateBackendConfigAsync(UpdateBackendConfigRequest updateBackendConfigRequest, AsyncHandler<UpdateBackendConfigRequest,UpdateBackendConfigResult> asyncHandler)
Updates the AWS resources required to access the Amplify Admin UI.
updateBackendConfigRequest
- The request body for UpdateBackendConfig.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackendJobResult> updateBackendJobAsync(UpdateBackendJobRequest updateBackendJobRequest)
Updates a specific job.
updateBackendJobRequest
- The request body for GetBackendJob.Future<UpdateBackendJobResult> updateBackendJobAsync(UpdateBackendJobRequest updateBackendJobRequest, AsyncHandler<UpdateBackendJobRequest,UpdateBackendJobResult> asyncHandler)
Updates a specific job.
updateBackendJobRequest
- The request body for GetBackendJob.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackendStorageResult> updateBackendStorageAsync(UpdateBackendStorageRequest updateBackendStorageRequest)
Updates an existing backend storage resource.
updateBackendStorageRequest
- The request body for UpdateBackendStorage.Future<UpdateBackendStorageResult> updateBackendStorageAsync(UpdateBackendStorageRequest updateBackendStorageRequest, AsyncHandler<UpdateBackendStorageRequest,UpdateBackendStorageResult> asyncHandler)
Updates an existing backend storage resource.
updateBackendStorageRequest
- The request body for UpdateBackendStorage.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.