com.amazonaws.services.mwaa

Class AmazonMWAAClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mwaa.AmazonMWAAClient

All Implemented Interfaces:

AmazonMWAA

Direct Known Subclasses:

AmazonMWAAAsyncClient

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

Client for accessing AmazonMWAA. All service calls made using this client are blocking, and will not return until the service call 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

• ops.airflow.{region}.amazonaws.com - This endpoint is used to push environment metrics that track environment health.

  • PublishMetrics

Regions

For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.

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 AmazonMWAAClientBuilder	builder()
CreateCliTokenResult	createCliToken(CreateCliTokenRequest request) Creates a CLI token for the Airflow CLI.
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
CreateWebLoginTokenResult	createWebLoginToken(CreateWebLoginTokenRequest request) Creates a web login token for the Airflow Web UI.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetEnvironmentResult	getEnvironment(GetEnvironmentRequest request) Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
PublishMetricsResult	publishMetrics(PublishMetricsRequest request) Internal only.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

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

Method Detail

builder

public static AmazonMWAAClientBuilder builder()

createCliToken

public CreateCliTokenResult createCliToken(CreateCliTokenRequest request)

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

Specified by:

createCliToken in interface AmazonMWAA

Parameters:

createCliTokenRequest -

Returns:

Result of the CreateCliToken operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

See Also:

AWS API Documentation

createEnvironment

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

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

Specified by:

createEnvironment in interface AmazonMWAA

Parameters:

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.

Returns:

Result of the CreateEnvironment operation returned by the service.

Throws:

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

createWebLoginToken

public CreateWebLoginTokenResult createWebLoginToken(CreateWebLoginTokenRequest request)

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

Specified by:

createWebLoginToken in interface AmazonMWAA

Parameters:

createWebLoginTokenRequest -

Returns:

Result of the CreateWebLoginToken operation returned by the service.

Throws:

AccessDeniedException - Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

deleteEnvironment

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

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

Specified by:

deleteEnvironment in interface AmazonMWAA

Parameters:

deleteEnvironmentRequest -

Returns:

Result of the DeleteEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

getEnvironment

public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

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

Specified by:

getEnvironment in interface AmazonMWAA

Parameters:

getEnvironmentRequest -

Returns:

Result of the GetEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

listEnvironments

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

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

Specified by:

listEnvironments in interface AmazonMWAA

Parameters:

listEnvironmentsRequest -

Returns:

Result of the ListEnvironments operation returned by the service.

Throws:

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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

Specified by:

listTagsForResource in interface AmazonMWAA

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

publishMetrics

public PublishMetricsResult publishMetrics(PublishMetricsRequest request)

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Specified by:

publishMetrics in interface AmazonMWAA

Parameters:

publishMetricsRequest -

Returns:

Result of the PublishMetrics operation returned by the service.

Throws:

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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

Specified by:

tagResource in interface AmazonMWAA

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AmazonMWAA

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

updateEnvironment

public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)

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

Specified by:

updateEnvironment in interface AmazonMWAA

Parameters:

updateEnvironmentRequest -

Returns:

Result of the UpdateEnvironment operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonMWAA

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonMWAA

Overrides:

shutdown in class AmazonWebServiceClient