@Generated(value="software.amazon.awssdk:codegen") public interface MwaaAsyncClient extends SdkClient
builder()
method.
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static MwaaAsyncClient create()
MwaaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MwaaAsyncClientBuilder builder()
MwaaAsyncClient.default CompletableFuture<CreateCliTokenResponse> createCliToken(CreateCliTokenRequest createCliTokenRequest)
Create a CLI token to use Airflow CLI.
createCliTokenRequest - default CompletableFuture<CreateCliTokenResponse> createCliToken(Consumer<CreateCliTokenRequest.Builder> createCliTokenRequest)
Create a CLI token to use Airflow CLI.
This is a convenience which creates an instance of the CreateCliTokenRequest.Builder avoiding the need to
create one manually via CreateCliTokenRequest.builder()
createCliTokenRequest - A Consumer that will call methods on CreateCliTokenRequest.Builder to create a request.default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
JSON blob that describes the environment to create.
createEnvironmentRequest - This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation
to create an environment. For more information, see Get started with Amazon Managed
Workflows for Apache Airflow.default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
JSON blob that describes the environment to create.
This is a convenience which creates an instance of the CreateEnvironmentRequest.Builder avoiding the need
to create one manually via CreateEnvironmentRequest.builder()
createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentInput.Builder to create a request.
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation
to create an environment. For more information, see Get started with Amazon Managed
Workflows for Apache Airflow.default CompletableFuture<CreateWebLoginTokenResponse> createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest)
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
createWebLoginTokenRequest - default CompletableFuture<CreateWebLoginTokenResponse> createWebLoginToken(Consumer<CreateWebLoginTokenRequest.Builder> createWebLoginTokenRequest)
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
This is a convenience which creates an instance of the CreateWebLoginTokenRequest.Builder avoiding the
need to create one manually via CreateWebLoginTokenRequest.builder()
createWebLoginTokenRequest - A Consumer that will call methods on CreateWebLoginTokenRequest.Builder to create a
request.default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an existing environment.
deleteEnvironmentRequest - default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
Delete an existing environment.
This is a convenience which creates an instance of the DeleteEnvironmentRequest.Builder avoiding the need
to create one manually via DeleteEnvironmentRequest.builder()
deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentInput.Builder to create a request.default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Get details of an existing environment.
getEnvironmentRequest - default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
Get details of an existing environment.
This is a convenience which creates an instance of the GetEnvironmentRequest.Builder avoiding the need to
create one manually via GetEnvironmentRequest.builder()
getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentInput.Builder to create a request.default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
List Amazon MWAA Environments.
listEnvironmentsRequest - default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
List Amazon MWAA Environments.
This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need
to create one manually via ListEnvironmentsRequest.builder()
listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsInput.Builder to create a request.default ListEnvironmentsPublisher listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
List Amazon MWAA Environments.
This is a variant of
listEnvironments(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsRequest) 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.mwaa.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse 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
listEnvironments(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsRequest) operation.
listEnvironmentsRequest - default ListEnvironmentsPublisher listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
List Amazon MWAA Environments.
This is a variant of
listEnvironments(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsRequest) 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.mwaa.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsPublisher publisher = client.listEnvironmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse 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
listEnvironments(software.amazon.awssdk.services.mwaa.model.ListEnvironmentsRequest) operation.
This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need
to create one manually via ListEnvironmentsRequest.builder()
listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsInput.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for MWAA environments.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for MWAA environments.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.default CompletableFuture<PublishMetricsResponse> publishMetrics(PublishMetricsRequest publishMetricsRequest)
An operation for publishing metrics from the customers to the Ops plane.
publishMetricsRequest - default CompletableFuture<PublishMetricsResponse> publishMetrics(Consumer<PublishMetricsRequest.Builder> publishMetricsRequest)
An operation for publishing metrics from the customers to the Ops plane.
This is a convenience which creates an instance of the PublishMetricsRequest.Builder avoiding the need to
create one manually via PublishMetricsRequest.builder()
publishMetricsRequest - A Consumer that will call methods on PublishMetricsInput.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Add tag to the MWAA environments.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Add tag to the MWAA environments.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove a tag from the MWAA environments.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove a tag from the MWAA environments.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Update an MWAA environment.
updateEnvironmentRequest - default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
Update an MWAA environment.
This is a convenience which creates an instance of the UpdateEnvironmentRequest.Builder avoiding the need
to create one manually via UpdateEnvironmentRequest.builder()
updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentInput.Builder to create a request.Copyright © 2021. All rights reserved.