@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AmplifyBackendAsyncClient extends AwsClient
builder()
method.
AWS Amplify Admin API
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static AmplifyBackendAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AmplifyBackendAsyncClient. |
default CompletableFuture<CloneBackendResponse> |
cloneBackend(CloneBackendRequest cloneBackendRequest)
This operation clones an existing backend.
|
default CompletableFuture<CloneBackendResponse> |
cloneBackend(Consumer<CloneBackendRequest.Builder> cloneBackendRequest)
This operation clones an existing backend.
|
static AmplifyBackendAsyncClient |
create()
Create a
AmplifyBackendAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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.
|
default CompletableFuture<CreateBackendApiResponse> |
createBackendAPI(Consumer<CreateBackendApiRequest.Builder> createBackendApiRequest)
Creates a new backend API resource.
|
default CompletableFuture<CreateBackendApiResponse> |
createBackendAPI(CreateBackendApiRequest createBackendApiRequest)
Creates a new backend API resource.
|
default CompletableFuture<CreateBackendAuthResponse> |
createBackendAuth(Consumer<CreateBackendAuthRequest.Builder> createBackendAuthRequest)
Creates a new backend authentication resource.
|
default CompletableFuture<CreateBackendAuthResponse> |
createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)
Creates a new backend authentication resource.
|
default CompletableFuture<CreateBackendConfigResponse> |
createBackendConfig(Consumer<CreateBackendConfigRequest.Builder> createBackendConfigRequest)
Creates a config object for a backend.
|
default CompletableFuture<CreateBackendConfigResponse> |
createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)
Creates a config object for a backend.
|
default CompletableFuture<CreateBackendStorageResponse> |
createBackendStorage(Consumer<CreateBackendStorageRequest.Builder> createBackendStorageRequest)
Creates a backend storage resource.
|
default CompletableFuture<CreateBackendStorageResponse> |
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.
|
default CompletableFuture<DeleteBackendApiResponse> |
deleteBackendAPI(Consumer<DeleteBackendApiRequest.Builder> deleteBackendApiRequest)
Deletes an existing backend API resource.
|
default CompletableFuture<DeleteBackendApiResponse> |
deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest)
Deletes an existing backend API resource.
|
default CompletableFuture<DeleteBackendAuthResponse> |
deleteBackendAuth(Consumer<DeleteBackendAuthRequest.Builder> deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
|
default CompletableFuture<DeleteBackendAuthResponse> |
deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
|
default CompletableFuture<DeleteBackendStorageResponse> |
deleteBackendStorage(Consumer<DeleteBackendStorageRequest.Builder> deleteBackendStorageRequest)
Removes the specified backend storage resource.
|
default CompletableFuture<DeleteBackendStorageResponse> |
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.
|
default CompletableFuture<GenerateBackendApiModelsResponse> |
generateBackendAPIModels(Consumer<GenerateBackendApiModelsRequest.Builder> generateBackendApiModelsRequest)
Generates a model schema for an existing backend API resource.
|
default CompletableFuture<GenerateBackendApiModelsResponse> |
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.
|
default CompletableFuture<GetBackendApiModelsResponse> |
getBackendAPIModels(Consumer<GetBackendApiModelsRequest.Builder> getBackendApiModelsRequest)
Gets a model introspection schema for an existing backend API resource.
|
default CompletableFuture<GetBackendApiModelsResponse> |
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.
|
default CompletableFuture<GetBackendStorageResponse> |
getBackendStorage(Consumer<GetBackendStorageRequest.Builder> getBackendStorageRequest)
Gets details for a backend storage resource.
|
default CompletableFuture<GetBackendStorageResponse> |
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.
|
default CompletableFuture<ImportBackendAuthResponse> |
importBackendAuth(Consumer<ImportBackendAuthRequest.Builder> importBackendAuthRequest)
Imports an existing backend authentication resource.
|
default CompletableFuture<ImportBackendAuthResponse> |
importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest)
Imports an existing backend authentication resource.
|
default CompletableFuture<ImportBackendStorageResponse> |
importBackendStorage(Consumer<ImportBackendStorageRequest.Builder> importBackendStorageRequest)
Imports an existing backend storage resource.
|
default CompletableFuture<ImportBackendStorageResponse> |
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)
Lists the jobs for the backend of an Amplify app.
|
default ListBackendJobsPublisher |
listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
|
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.
|
default CompletableFuture<RemoveAllBackendsResponse> |
removeAllBackends(Consumer<RemoveAllBackendsRequest.Builder> removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
|
default CompletableFuture<RemoveAllBackendsResponse> |
removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
|
default CompletableFuture<RemoveBackendConfigResponse> |
removeBackendConfig(Consumer<RemoveBackendConfigRequest.Builder> removeBackendConfigRequest)
Removes the AWS resources required to access the Amplify Admin UI.
|
default CompletableFuture<RemoveBackendConfigResponse> |
removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)
Removes the AWS resources required to access the Amplify Admin UI.
|
default AmplifyBackendServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<UpdateBackendApiResponse> |
updateBackendAPI(Consumer<UpdateBackendApiRequest.Builder> updateBackendApiRequest)
Updates an existing backend API resource.
|
default CompletableFuture<UpdateBackendApiResponse> |
updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest)
Updates an existing backend API resource.
|
default CompletableFuture<UpdateBackendAuthResponse> |
updateBackendAuth(Consumer<UpdateBackendAuthRequest.Builder> updateBackendAuthRequest)
Updates an existing backend authentication resource.
|
default CompletableFuture<UpdateBackendAuthResponse> |
updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)
Updates an existing backend authentication resource.
|
default CompletableFuture<UpdateBackendConfigResponse> |
updateBackendConfig(Consumer<UpdateBackendConfigRequest.Builder> updateBackendConfigRequest)
Updates the AWS resources required to access the Amplify Admin UI.
|
default CompletableFuture<UpdateBackendConfigResponse> |
updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)
Updates the AWS resources required to access the Amplify Admin UI.
|
default CompletableFuture<UpdateBackendJobResponse> |
updateBackendJob(Consumer<UpdateBackendJobRequest.Builder> updateBackendJobRequest)
Updates a specific job.
|
default CompletableFuture<UpdateBackendJobResponse> |
updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)
Updates a specific job.
|
default CompletableFuture<UpdateBackendStorageResponse> |
updateBackendStorage(Consumer<UpdateBackendStorageRequest.Builder> updateBackendStorageRequest)
Updates an existing backend storage resource.
|
default CompletableFuture<UpdateBackendStorageResponse> |
updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest)
Updates an existing backend storage resource.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CloneBackendResponse> cloneBackend(CloneBackendRequest cloneBackendRequest)
This operation clones an existing backend.
cloneBackendRequest - The request body for 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 via CloneBackendRequest.builder()
cloneBackendRequest - A Consumer that will call methods on
CloneBackendRequest.Builder to create a
request. The request body for CloneBackend.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.
createBackendRequest - The request body for 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 via CreateBackendRequest.builder()
createBackendRequest - A Consumer that will call methods on
CreateBackendRequest.Builder to create a
request. The request body for CreateBackend.default CompletableFuture<CreateBackendApiResponse> createBackendAPI(CreateBackendApiRequest createBackendApiRequest)
Creates a new backend API resource.
createBackendApiRequest - The request body for 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 via CreateBackendApiRequest.builder()
createBackendApiRequest - A Consumer that will call methods on
CreateBackendApiRequest.Builder to create a
request. The request body for CreateBackendAPI.default CompletableFuture<CreateBackendAuthResponse> createBackendAuth(CreateBackendAuthRequest createBackendAuthRequest)
Creates a new backend authentication resource.
createBackendAuthRequest - The request body for 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 via CreateBackendAuthRequest.builder()
createBackendAuthRequest - A Consumer that will call methods on
CreateBackendAuthRequest.Builder to create a
request. The request body for CreateBackendAuth.default CompletableFuture<CreateBackendConfigResponse> createBackendConfig(CreateBackendConfigRequest createBackendConfigRequest)
Creates a config object for a backend.
createBackendConfigRequest - The request body for 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 via CreateBackendConfigRequest.builder()
createBackendConfigRequest - A Consumer that will call methods on
CreateBackendConfigRequest.Builder to create
a request. The request body for CreateBackendConfig.default CompletableFuture<CreateBackendStorageResponse> createBackendStorage(CreateBackendStorageRequest createBackendStorageRequest)
Creates a backend storage resource.
createBackendStorageRequest - The request body for 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 via CreateBackendStorageRequest.builder()
createBackendStorageRequest - A Consumer that will call methods on
CreateBackendStorageRequest.Builder to create
a request. The request body for CreateBackendStorage.default CompletableFuture<CreateTokenResponse> createToken(CreateTokenRequest createTokenRequest)
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
createTokenRequest - 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 via CreateTokenRequest.builder()
createTokenRequest - A Consumer that will call methods on
CreateTokenRequest.Builder to create a
request.default CompletableFuture<DeleteBackendResponse> deleteBackend(DeleteBackendRequest deleteBackendRequest)
Removes an existing environment from your Amplify project.
deleteBackendRequest - 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 via DeleteBackendRequest.builder()
deleteBackendRequest - A Consumer that will call methods on
DeleteBackendRequest.Builder to create a
request.default CompletableFuture<DeleteBackendApiResponse> deleteBackendAPI(DeleteBackendApiRequest deleteBackendApiRequest)
Deletes an existing backend API resource.
deleteBackendApiRequest - The request body for 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 via DeleteBackendApiRequest.builder()
deleteBackendApiRequest - A Consumer that will call methods on
DeleteBackendApiRequest.Builder to create a
request. The request body for DeleteBackendAPI.default CompletableFuture<DeleteBackendAuthResponse> deleteBackendAuth(DeleteBackendAuthRequest deleteBackendAuthRequest)
Deletes an existing backend authentication resource.
deleteBackendAuthRequest - The request body for 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 via DeleteBackendAuthRequest.builder()
deleteBackendAuthRequest - A Consumer that will call methods on
DeleteBackendAuthRequest.Builder to create a
request. The request body for DeleteBackendAuth.default CompletableFuture<DeleteBackendStorageResponse> deleteBackendStorage(DeleteBackendStorageRequest deleteBackendStorageRequest)
Removes the specified backend storage resource.
deleteBackendStorageRequest - The request body for 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 via DeleteBackendStorageRequest.builder()
deleteBackendStorageRequest - A Consumer that will call methods on
DeleteBackendStorageRequest.Builder to create
a request. The request body for DeleteBackendStorage.default CompletableFuture<DeleteTokenResponse> deleteToken(DeleteTokenRequest deleteTokenRequest)
Deletes the challenge token based on the given appId and sessionId.
deleteTokenRequest - 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 via DeleteTokenRequest.builder()
deleteTokenRequest - A Consumer that will call methods on
DeleteTokenRequest.Builder to create a
request.default CompletableFuture<GenerateBackendApiModelsResponse> generateBackendAPIModels(GenerateBackendApiModelsRequest generateBackendApiModelsRequest)
Generates a model schema for an existing backend API resource.
generateBackendApiModelsRequest - The request body for 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 via GenerateBackendApiModelsRequest.builder()
generateBackendApiModelsRequest - A Consumer that will call methods on
GenerateBackendApiModelsRequest.Builder to
create a request. The request body for GenerateBackendAPIModels.default CompletableFuture<GetBackendResponse> getBackend(GetBackendRequest getBackendRequest)
Provides project-level details for your Amplify UI project.
getBackendRequest - The request body for 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 via GetBackendRequest.builder()
getBackendRequest - A Consumer that will call methods on
GetBackendRequest.Builder to create a
request. The request body for GetBackend.default CompletableFuture<GetBackendApiResponse> getBackendAPI(GetBackendApiRequest getBackendApiRequest)
Gets the details for a backend API.
getBackendApiRequest - The request body for 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 via GetBackendApiRequest.builder()
getBackendApiRequest - A Consumer that will call methods on
GetBackendApiRequest.Builder to create a
request. The request body for GetBackendAPI.default CompletableFuture<GetBackendApiModelsResponse> getBackendAPIModels(GetBackendApiModelsRequest getBackendApiModelsRequest)
Gets a model introspection schema for an existing backend API resource.
getBackendApiModelsRequest - The request body for 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 via GetBackendApiModelsRequest.builder()
getBackendApiModelsRequest - A Consumer that will call methods on
GetBackendApiModelsRequest.Builder to create
a request. The request body for GetBackendAPIModels.default CompletableFuture<GetBackendAuthResponse> getBackendAuth(GetBackendAuthRequest getBackendAuthRequest)
Gets a backend auth details.
getBackendAuthRequest - The request body for 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 via GetBackendAuthRequest.builder()
getBackendAuthRequest - A Consumer that will call methods on
GetBackendAuthRequest.Builder to create a
request. The request body for GetBackendAuth.default CompletableFuture<GetBackendJobResponse> getBackendJob(GetBackendJobRequest getBackendJobRequest)
Returns information about a specific job.
getBackendJobRequest - 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 via GetBackendJobRequest.builder()
getBackendJobRequest - A Consumer that will call methods on
GetBackendJobRequest.Builder to create a
request.default CompletableFuture<GetBackendStorageResponse> getBackendStorage(GetBackendStorageRequest getBackendStorageRequest)
Gets details for a backend storage resource.
getBackendStorageRequest - The request body for 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 via GetBackendStorageRequest.builder()
getBackendStorageRequest - A Consumer that will call methods on
GetBackendStorageRequest.Builder to create a
request. The request body for GetBackendStorage.default CompletableFuture<GetTokenResponse> getToken(GetTokenRequest getTokenRequest)
Gets the challenge token based on the given appId and sessionId.
getTokenRequest - 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 via GetTokenRequest.builder()
getTokenRequest - A Consumer that will call methods on
GetTokenRequest.Builder to create a request.default CompletableFuture<ImportBackendAuthResponse> importBackendAuth(ImportBackendAuthRequest importBackendAuthRequest)
Imports an existing backend authentication resource.
importBackendAuthRequest - The request body for 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 via ImportBackendAuthRequest.builder()
importBackendAuthRequest - A Consumer that will call methods on
ImportBackendAuthRequest.Builder to create a
request. The request body for ImportBackendAuth.default CompletableFuture<ImportBackendStorageResponse> importBackendStorage(ImportBackendStorageRequest importBackendStorageRequest)
Imports an existing backend storage resource.
importBackendStorageRequest - The request body for 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 via ImportBackendStorageRequest.builder()
importBackendStorageRequest - A Consumer that will call methods on
ImportBackendStorageRequest.Builder to create
a request. The request body for ImportBackendStorage.default CompletableFuture<ListBackendJobsResponse> listBackendJobs(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
listBackendJobsRequest - The request body for 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 via ListBackendJobsRequest.builder()
listBackendJobsRequest - A Consumer that will call methods on
ListBackendJobsRequest.Builder to create a
request. The request body for ListBackendJobs.default ListBackendJobsPublisher listBackendJobsPaginator(ListBackendJobsRequest listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
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 new Subscription 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 method
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listBackendJobsRequest - The request body for ListBackendJobs.default ListBackendJobsPublisher listBackendJobsPaginator(Consumer<ListBackendJobsRequest.Builder> listBackendJobsRequest)
Lists the jobs for the backend of an Amplify app.
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 new Subscription 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 method
software.amazon.awssdk.services.amplifybackend.paginators.ListBackendJobsPublisher publisher = client.listBackendJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBackendJobs(software.amazon.awssdk.services.amplifybackend.model.ListBackendJobsRequest)
operation.
This is a convenience which creates an instance of the ListBackendJobsRequest.Builder avoiding the need
to create one manually via ListBackendJobsRequest.builder()
listBackendJobsRequest - A Consumer that will call methods on
ListBackendJobsRequest.Builder to create a
request. The request body for ListBackendJobs.default CompletableFuture<ListS3BucketsResponse> listS3Buckets(ListS3BucketsRequest listS3BucketsRequest)
The list of S3 buckets in your account.
listS3BucketsRequest - The request body for S3Buckets.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 via ListS3BucketsRequest.builder()
listS3BucketsRequest - A Consumer that will call methods on
ListS3BucketsRequest.Builder to create a
request. The request body for S3Buckets.default CompletableFuture<RemoveAllBackendsResponse> removeAllBackends(RemoveAllBackendsRequest removeAllBackendsRequest)
Removes all backend environments from your Amplify project.
removeAllBackendsRequest - The request body for 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 via RemoveAllBackendsRequest.builder()
removeAllBackendsRequest - A Consumer that will call methods on
RemoveAllBackendsRequest.Builder to create a
request. The request body for RemoveAllBackends.default CompletableFuture<RemoveBackendConfigResponse> removeBackendConfig(RemoveBackendConfigRequest removeBackendConfigRequest)
Removes the AWS resources required to access the Amplify Admin UI.
removeBackendConfigRequest - 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 via RemoveBackendConfigRequest.builder()
removeBackendConfigRequest - A Consumer that will call methods on
RemoveBackendConfigRequest.Builder to create
a request.default CompletableFuture<UpdateBackendApiResponse> updateBackendAPI(UpdateBackendApiRequest updateBackendApiRequest)
Updates an existing backend API resource.
updateBackendApiRequest - The request body for 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 via UpdateBackendApiRequest.builder()
updateBackendApiRequest - A Consumer that will call methods on
UpdateBackendApiRequest.Builder to create a
request. The request body for UpdateBackendAPI.default CompletableFuture<UpdateBackendAuthResponse> updateBackendAuth(UpdateBackendAuthRequest updateBackendAuthRequest)
Updates an existing backend authentication resource.
updateBackendAuthRequest - The request body for 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 via UpdateBackendAuthRequest.builder()
updateBackendAuthRequest - A Consumer that will call methods on
UpdateBackendAuthRequest.Builder to create a
request. The request body for UpdateBackendAuth.default CompletableFuture<UpdateBackendConfigResponse> updateBackendConfig(UpdateBackendConfigRequest updateBackendConfigRequest)
Updates the AWS resources required to access the Amplify Admin UI.
updateBackendConfigRequest - The request body for 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 via UpdateBackendConfigRequest.builder()
updateBackendConfigRequest - A Consumer that will call methods on
UpdateBackendConfigRequest.Builder to create
a request. The request body for UpdateBackendConfig.default CompletableFuture<UpdateBackendJobResponse> updateBackendJob(UpdateBackendJobRequest updateBackendJobRequest)
Updates a specific job.
updateBackendJobRequest - The request body for GetBackendJob.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 via UpdateBackendJobRequest.builder()
updateBackendJobRequest - A Consumer that will call methods on
UpdateBackendJobRequest.Builder to create a
request. The request body for GetBackendJob.default CompletableFuture<UpdateBackendStorageResponse> updateBackendStorage(UpdateBackendStorageRequest updateBackendStorageRequest)
Updates an existing backend storage resource.
updateBackendStorageRequest - The request body for 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 via UpdateBackendStorageRequest.builder()
updateBackendStorageRequest - A Consumer that will call methods on
UpdateBackendStorageRequest.Builder to create
a request. The request body for UpdateBackendStorage.default AmplifyBackendServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic AmplifyBackendAsyncClient create()
AmplifyBackendAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AmplifyBackendAsyncClientBuilder builder()
AmplifyBackendAsyncClient.Copyright © 2023. All rights reserved.