com.amazonaws.services.mwaa

Class AmazonMWAAAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mwaa.AmazonMWAAClient

com.amazonaws.services.mwaa.AmazonMWAAAsyncClient

All Implemented Interfaces:

AmazonMWAA, AmazonMWAAAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonMWAAAsyncClient
extends AmazonMWAAClient
implements AmazonMWAAAsync

Client for accessing AmazonMWAA asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Managed Workflows for Apache Airflow

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What is Amazon MWAA?.

Endpoints

• api.airflow.{region}.amazonaws.com - This endpoint is used for environment management.

  • CreateEnvironment

  • DeleteEnvironment

  • GetEnvironment

  • ListEnvironments

  • ListTagsForResource

  • TagResource

  • UntagResource

  • UpdateEnvironment

• env.airflow.{region}.amazonaws.com - This endpoint is used to operate the Airflow environment.

  • CreateCliToken

  • CreateWebLoginToken

Regions

For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.mwaa.AmazonMWAA

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonMWAAAsyncClientBuilder	asyncBuilder()
Future<CreateCliTokenResult>	createCliTokenAsync(CreateCliTokenRequest request) Creates a CLI token for the Airflow CLI.
Future<CreateCliTokenResult>	createCliTokenAsync(CreateCliTokenRequest request, AsyncHandler<CreateCliTokenRequest,CreateCliTokenResult> asyncHandler) Creates a CLI token for the Airflow CLI.
Future<CreateEnvironmentResult>	createEnvironmentAsync(CreateEnvironmentRequest request) Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<CreateEnvironmentResult>	createEnvironmentAsync(CreateEnvironmentRequest request, AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResult> asyncHandler) Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<CreateWebLoginTokenResult>	createWebLoginTokenAsync(CreateWebLoginTokenRequest request) Creates a web login token for the Airflow Web UI.
Future<CreateWebLoginTokenResult>	createWebLoginTokenAsync(CreateWebLoginTokenRequest request, AsyncHandler<CreateWebLoginTokenRequest,CreateWebLoginTokenResult> asyncHandler) Creates a web login token for the Airflow Web UI.
Future<DeleteEnvironmentResult>	deleteEnvironmentAsync(DeleteEnvironmentRequest request) Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<DeleteEnvironmentResult>	deleteEnvironmentAsync(DeleteEnvironmentRequest request, AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResult> asyncHandler) Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<GetEnvironmentResult>	getEnvironmentAsync(GetEnvironmentRequest request) Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<GetEnvironmentResult>	getEnvironmentAsync(GetEnvironmentRequest request, AsyncHandler<GetEnvironmentRequest,GetEnvironmentResult> asyncHandler) Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListEnvironmentsResult>	listEnvironmentsAsync(ListEnvironmentsRequest request) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
Future<ListEnvironmentsResult>	listEnvironmentsAsync(ListEnvironmentsRequest request, AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResult> asyncHandler) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<PublishMetricsResult>	publishMetricsAsync(PublishMetricsRequest request) Deprecated.
Future<PublishMetricsResult>	publishMetricsAsync(PublishMetricsRequest request, AsyncHandler<PublishMetricsRequest,PublishMetricsResult> asyncHandler) Deprecated.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<UpdateEnvironmentResult>	updateEnvironmentAsync(UpdateEnvironmentRequest request) Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Future<UpdateEnvironmentResult>	updateEnvironmentAsync(UpdateEnvironmentRequest request, AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResult> asyncHandler) Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Methods inherited from class com.amazonaws.services.mwaa.AmazonMWAAClient

builder, createCliToken, createEnvironment, createWebLoginToken, deleteEnvironment, getCachedResponseMetadata, getEnvironment, listEnvironments, listTagsForResource, publishMetrics, tagResource, untagResource, updateEnvironment

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.mwaa.AmazonMWAA

createCliToken, createEnvironment, createWebLoginToken, deleteEnvironment, getCachedResponseMetadata, getEnvironment, listEnvironments, listTagsForResource, publishMetrics, tagResource, untagResource, updateEnvironment

Method Detail

asyncBuilder

public static AmazonMWAAAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

createCliTokenAsync

public Future<CreateCliTokenResult> createCliTokenAsync(CreateCliTokenRequest request)

Description copied from interface: AmazonMWAAAsync

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Specified by:

createCliTokenAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the CreateCliToken operation returned by the service.

See Also:

AWS API Documentation

createCliTokenAsync

public Future<CreateCliTokenResult> createCliTokenAsync(CreateCliTokenRequest request,
                                                        AsyncHandler<CreateCliTokenRequest,CreateCliTokenResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Specified by:

createCliTokenAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the CreateCliToken operation returned by the service.

See Also:

AWS API Documentation

createEnvironmentAsync

public Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request)

Description copied from interface: AmazonMWAAAsync

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

createEnvironmentAsync in interface AmazonMWAAAsync

Parameters:

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.

Returns:

A Java Future containing the result of the CreateEnvironment operation returned by the service.

See Also:

AWS API Documentation

createEnvironmentAsync

public Future<CreateEnvironmentResult> createEnvironmentAsync(CreateEnvironmentRequest request,
                                                              AsyncHandler<CreateEnvironmentRequest,CreateEnvironmentResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

createEnvironmentAsync in interface AmazonMWAAAsync

Parameters:

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.

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.

Returns:

A Java Future containing the result of the CreateEnvironment operation returned by the service.

See Also:

AWS API Documentation

createWebLoginTokenAsync

public Future<CreateWebLoginTokenResult> createWebLoginTokenAsync(CreateWebLoginTokenRequest request)

Description copied from interface: AmazonMWAAAsync

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Specified by:

createWebLoginTokenAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the CreateWebLoginToken operation returned by the service.

See Also:

AWS API Documentation

createWebLoginTokenAsync

public Future<CreateWebLoginTokenResult> createWebLoginTokenAsync(CreateWebLoginTokenRequest request,
                                                                  AsyncHandler<CreateWebLoginTokenRequest,CreateWebLoginTokenResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Specified by:

createWebLoginTokenAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the CreateWebLoginToken operation returned by the service.

See Also:

AWS API Documentation

deleteEnvironmentAsync

public Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request)

Description copied from interface: AmazonMWAAAsync

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

deleteEnvironmentAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the DeleteEnvironment operation returned by the service.

See Also:

AWS API Documentation

deleteEnvironmentAsync

public Future<DeleteEnvironmentResult> deleteEnvironmentAsync(DeleteEnvironmentRequest request,
                                                              AsyncHandler<DeleteEnvironmentRequest,DeleteEnvironmentResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

deleteEnvironmentAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the DeleteEnvironment operation returned by the service.

See Also:

AWS API Documentation

getEnvironmentAsync

public Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request)

Description copied from interface: AmazonMWAAAsync

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

getEnvironmentAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the GetEnvironment operation returned by the service.

See Also:

AWS API Documentation

getEnvironmentAsync

public Future<GetEnvironmentResult> getEnvironmentAsync(GetEnvironmentRequest request,
                                                        AsyncHandler<GetEnvironmentRequest,GetEnvironmentResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

getEnvironmentAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the GetEnvironment operation returned by the service.

See Also:

AWS API Documentation

listEnvironmentsAsync

public Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request)

Description copied from interface: AmazonMWAAAsync

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Specified by:

listEnvironmentsAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the ListEnvironments operation returned by the service.

See Also:

AWS API Documentation

listEnvironmentsAsync

public Future<ListEnvironmentsResult> listEnvironmentsAsync(ListEnvironmentsRequest request,
                                                            AsyncHandler<ListEnvironmentsRequest,ListEnvironmentsResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Specified by:

listEnvironmentsAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the ListEnvironments operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonMWAAAsync

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Specified by:

listTagsForResourceAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Specified by:

listTagsForResourceAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

publishMetricsAsync

@Deprecated
public Future<PublishMetricsResult> publishMetricsAsync(PublishMetricsRequest request)

Deprecated.

Description copied from interface: AmazonMWAAAsync

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Specified by:

publishMetricsAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the PublishMetrics operation returned by the service.

See Also:

AWS API Documentation

publishMetricsAsync

@Deprecated
public Future<PublishMetricsResult> publishMetricsAsync(PublishMetricsRequest request,
                                                                    AsyncHandler<PublishMetricsRequest,PublishMetricsResult> asyncHandler)

Deprecated.

Description copied from interface: AmazonMWAAAsync

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Specified by:

publishMetricsAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the PublishMetrics operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonMWAAAsync

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

tagResourceAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

tagResourceAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AmazonMWAAAsync

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Specified by:

untagResourceAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Specified by:

untagResourceAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateEnvironmentAsync

public Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request)

Description copied from interface: AmazonMWAAAsync

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

updateEnvironmentAsync in interface AmazonMWAAAsync

Returns:

A Java Future containing the result of the UpdateEnvironment operation returned by the service.

See Also:

AWS API Documentation

updateEnvironmentAsync

public Future<UpdateEnvironmentResult> updateEnvironmentAsync(UpdateEnvironmentRequest request,
                                                              AsyncHandler<UpdateEnvironmentRequest,UpdateEnvironmentResult> asyncHandler)

Description copied from interface: AmazonMWAAAsync

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Specified by:

updateEnvironmentAsync in interface AmazonMWAAAsync

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.

Returns:

A Java Future containing the result of the UpdateEnvironment operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonMWAA

Overrides:

shutdown in class AmazonMWAAClient