AmazonMWAA (AWS SDK for Java

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

Endpoints
- api.airflow.{region}.amazonaws.com - This endpoint is used for environment management.
- 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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateCliTokenResult`	`createCliToken(CreateCliTokenRequest createCliTokenRequest)` Creates a CLI token for the Airflow CLI.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)` Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
`CreateWebLoginTokenResult`	`createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest)` Creates a web login token for the Airflow Web UI.
`DeleteEnvironmentResult`	`deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)` 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 getEnvironmentRequest)` Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
`ListEnvironmentsResult`	`listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)` Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
`PublishMetricsResult`	`publishMetrics(PublishMetricsRequest publishMetricsRequest)` Internal only.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)` Updates an Amazon Managed Workflows for Apache Airflow (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)
```
    Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
    
    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)
```
    Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
    
    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)
```
    Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
    
    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
```
DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
```
    Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) 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)
```
    Describes an Amazon Managed Workflows for Apache Airflow (MWAA) 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)
```
    Lists the Amazon Managed Workflows for Apache Airflow (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)
```
    Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".
    
    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)
```
    Internal only. Publishes environment health metrics to Amazon CloudWatch.
    
    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)
```
    Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
    
    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)
```
    Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".
    
    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)
```
    Updates an Amazon Managed Workflows for Apache Airflow (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.

Did this page help you?

Interface AmazonMWAA

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createCliToken

createEnvironment

createWebLoginToken

deleteEnvironment

getEnvironment

listEnvironments

listTagsForResource

publishMetrics

tagResource

untagResource

updateEnvironment

shutdown

getCachedResponseMetadata