com.amazonaws.services.mwaa

Interface AmazonMWAA

All Known Subinterfaces:

AmazonMWAAAsync

All Known Implementing Classes:

AbstractAmazonMWAA, AbstractAmazonMWAAAsync, AmazonMWAAAsyncClient, AmazonMWAAClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonMWAA

Interface for accessing AmazonMWAA.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonMWAA instead.

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?.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateCliTokenResult	createCliToken(CreateCliTokenRequest createCliTokenRequest) Create a CLI token to use Airflow CLI.
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) JSON blob that describes the environment to create.
CreateWebLoginTokenResult	createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest) Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Delete an existing 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 getEnvironmentRequest) Get details of an existing environment.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) List Amazon MWAA Environments.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for MWAA environments.
PublishMetricsResult	publishMetrics(PublishMetricsRequest publishMetricsRequest) An operation for publishing metrics from the customers to the Ops plane.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Add tag to the MWAA environments.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove a tag from the MWAA environments.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Update an MWAA environment.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createCliToken

CreateCliTokenResult createCliToken(CreateCliTokenRequest createCliTokenRequest)

Create a CLI token to use Airflow CLI.

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

CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

JSON blob that describes the environment to create.

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

CreateWebLoginTokenResult createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest)

Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.

Parameters:

createWebLoginTokenRequest -

Returns:

Result of the CreateWebLoginToken operation returned by the service.

Throws:

AccessDeniedException - Access to the Airflow Web UI or CLI has been Denied. Please follow the MWAA user guide to setup permissions to access the Web UI and CLI functionality.

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

DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)

Delete an existing environment.

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

GetEnvironmentResult getEnvironment(GetEnvironmentRequest getEnvironmentRequest)

Get details of an existing environment.

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

ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)

List Amazon MWAA Environments.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List the tags for MWAA environments.

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

PublishMetricsResult publishMetrics(PublishMetricsRequest publishMetricsRequest)

An operation for publishing metrics from the customers to the Ops plane.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Add tag to the MWAA environments.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Remove a tag from the MWAA environments.

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

UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)

Update an MWAA environment.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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