@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe 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?.
<p> <b>Endpoints</b> </p> <ul> <li> <p> <code>api.airflow.{region}.amazonaws.com</code> - This endpoint is used for environment management.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_CreateEnvironment.html">CreateEnvironment</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_DeleteEnvironment.html">DeleteEnvironment</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_GetEnvironment.html">GetEnvironment</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_ListEnvironments.html">ListEnvironments</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_ListTagsForResource.html">ListTagsForResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_TagResource.html">TagResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_UntagResource.html">UntagResource</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_UpdateEnvironment.html">UpdateEnvironment</a> </p> </li> </ul> </li> <li> <p> <code>env.airflow.{region}.amazonaws.com</code> - This endpoint is used to operate the Airflow environment.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_CreateCliToken.html ">CreateCliToken</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_CreateWebLoginToken.html">CreateWebLoginToken</a> </p> </li> </ul> </li> <li> <p> <code>ops.airflow.{region}.amazonaws.com</code> - This endpoint is used to push environment metrics that track environment health.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/mwaa/latest/API/API_PublishMetrics.html ">PublishMetrics</a> </p> </li> </ul> </li> </ul> <p> <b>Regions</b> </p> <p>For a list of regions that Amazon MWAA supports, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/what-is-mwaa.html#regions-mwaa">Region availability</a> in the <i>Amazon MWAA User Guide</i>.</p>
| 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 MwaaAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
MwaaAsyncClient. |
static MwaaAsyncClient |
create()
Create a
MwaaAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateCliTokenResponse> |
createCliToken(Consumer<CreateCliTokenRequest.Builder> createCliTokenRequest)
Creates a CLI token for the Airflow CLI.
|
default CompletableFuture<CreateCliTokenResponse> |
createCliToken(CreateCliTokenRequest createCliTokenRequest)
Creates a CLI token for the Airflow CLI.
|
default CompletableFuture<CreateEnvironmentResponse> |
createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<CreateEnvironmentResponse> |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<CreateWebLoginTokenResponse> |
createWebLoginToken(Consumer<CreateWebLoginTokenRequest.Builder> createWebLoginTokenRequest)
Creates a web login token for the Airflow Web UI.
|
default CompletableFuture<CreateWebLoginTokenResponse> |
createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest)
Creates a web login token for the Airflow Web UI.
|
default CompletableFuture<DeleteEnvironmentResponse> |
deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<DeleteEnvironmentResponse> |
deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<GetEnvironmentResponse> |
getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<GetEnvironmentResponse> |
getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<ListEnvironmentsResponse> |
listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
|
default CompletableFuture<ListEnvironmentsResponse> |
listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
|
default ListEnvironmentsPublisher |
listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
|
default ListEnvironmentsPublisher |
listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<PublishMetricsResponse> |
publishMetrics(Consumer<PublishMetricsRequest.Builder> publishMetricsRequest)
Internal only.
|
default CompletableFuture<PublishMetricsResponse> |
publishMetrics(PublishMetricsRequest publishMetricsRequest)
Internal only.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<UpdateEnvironmentResponse> |
updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
default CompletableFuture<UpdateEnvironmentResponse> |
updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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)
Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
createCliTokenRequest - default CompletableFuture<CreateCliTokenResponse> createCliToken(Consumer<CreateCliTokenRequest.Builder> createCliTokenRequest)
Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
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)
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
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)
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
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)
Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
createWebLoginTokenRequest - default CompletableFuture<CreateWebLoginTokenResponse> createWebLoginToken(Consumer<CreateWebLoginTokenRequest.Builder> createWebLoginTokenRequest)
Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
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)
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
deleteEnvironmentRequest - default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) 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)
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
getEnvironmentRequest - default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) 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)
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
listEnvironmentsRequest - default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
Lists the Amazon Managed Workflows for Apache Airflow (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)
Lists the Amazon Managed Workflows for Apache Airflow (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)
Lists the Amazon Managed Workflows for Apache Airflow (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)
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
For example, "Environment": "Staging".
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
For example, "Environment": "Staging".
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)
Internal only. Publishes environment health metrics to Amazon CloudWatch.
publishMetricsRequest - default CompletableFuture<PublishMetricsResponse> publishMetrics(Consumer<PublishMetricsRequest.Builder> publishMetricsRequest)
Internal only. Publishes environment health metrics to Amazon CloudWatch.
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)
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
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)
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
For example, "Environment": "Staging".
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
For example, "Environment": "Staging".
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)
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
updateEnvironmentRequest - default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
Updates an Amazon Managed Workflows for Apache Airflow (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 © 2022. All rights reserved.