software.amazon.awssdk.services.mwaa

Interface MwaaClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface MwaaClient
extends AwsClient

Service client for accessing AmazonMWAA. This can be created using the static builder() method.

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

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

Method Summary

Modifier and Type	Method and Description
static MwaaClientBuilder	builder() Create a builder that can be used to configure and create a MwaaClient.
static MwaaClient	create() Create a MwaaClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCliTokenResponse	createCliToken(Consumer<CreateCliTokenRequest.Builder> createCliTokenRequest) Creates a CLI token for the Airflow CLI.
default CreateCliTokenResponse	createCliToken(CreateCliTokenRequest createCliTokenRequest) Creates a CLI token for the Airflow CLI.
default CreateEnvironmentResponse	createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default CreateEnvironmentResponse	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default CreateWebLoginTokenResponse	createWebLoginToken(Consumer<CreateWebLoginTokenRequest.Builder> createWebLoginTokenRequest) Creates a web login token for the Airflow Web UI.
default CreateWebLoginTokenResponse	createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest) Creates a web login token for the Airflow Web UI.
default DeleteEnvironmentResponse	deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default GetEnvironmentResponse	getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default ListEnvironmentsResponse	listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
default ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
default ListEnvironmentsIterable	listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
default ListEnvironmentsIterable	listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest) Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default PublishMetricsResponse	publishMetrics(Consumer<PublishMetricsRequest.Builder> publishMetricsRequest) Internal only.
default PublishMetricsResponse	publishMetrics(PublishMetricsRequest publishMetricsRequest) Internal only.
default MwaaServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default UpdateEnvironmentResponse	updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
default UpdateEnvironmentResponse	updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createCliToken

default CreateCliTokenResponse createCliToken(CreateCliTokenRequest createCliTokenRequest)
                                       throws ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createCliToken

default CreateCliTokenResponse createCliToken(Consumer<CreateCliTokenRequest.Builder> createCliTokenRequest)
                                       throws ResourceNotFoundException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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()

Parameters:

createCliTokenRequest - A Consumer that will call methods on CreateCliTokenRequest.Builder to create a request.

Returns:

Result of the CreateCliToken operation returned by the service.

Throws:

ResourceNotFoundException - ResourceNotFoundException: The resource is not available.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createEnvironment

default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createEnvironment

default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
                                             throws ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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()

Parameters:

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.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createWebLoginToken

default CreateWebLoginTokenResponse createWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest)
                                                 throws AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createWebLoginToken

default CreateWebLoginTokenResponse createWebLoginToken(Consumer<CreateWebLoginTokenRequest.Builder> createWebLoginTokenRequest)
                                                 throws AccessDeniedException,
                                                        ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MwaaException

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()

Parameters:

createWebLoginTokenRequest - A Consumer that will call methods on CreateWebLoginTokenRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteEnvironment

default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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()

Parameters:

deleteEnvironmentRequest - A Consumer that will call methods on DeleteEnvironmentInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
                                       throws ResourceNotFoundException,
                                              ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getEnvironment

default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
                                       throws ResourceNotFoundException,
                                              ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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()

Parameters:

getEnvironmentRequest - A Consumer that will call methods on GetEnvironmentInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
                                           throws ValidationException,
                                                  InternalServerException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnvironments

default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                           throws ValidationException,
                                                  InternalServerException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  MwaaException

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()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(ListEnvironmentsRequest listEnvironmentsRequest)
                                                    throws ValidationException,
                                                           InternalServerException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           MwaaException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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.

Parameters:

listEnvironmentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listEnvironmentsPaginator

default ListEnvironmentsIterable listEnvironmentsPaginator(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
                                                    throws ValidationException,
                                                           InternalServerException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           MwaaException

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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client
             .listEnvironmentsPaginator(request);
     for (software.amazon.awssdk.services.mwaa.model.ListEnvironmentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mwaa.paginators.ListEnvironmentsIterable responses = client.listEnvironmentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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()

Parameters:

listEnvironmentsRequest - A Consumer that will call methods on ListEnvironmentsInput.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ValidationException - ValidationException: The provided input is not valid.

InternalServerException - InternalServerException: An internal error has occurred.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
                                                        ValidationException,
                                                        InternalServerException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        MwaaException

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()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

publishMetrics

default PublishMetricsResponse publishMetrics(PublishMetricsRequest publishMetricsRequest)
                                       throws ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

publishMetrics

default PublishMetricsResponse publishMetrics(Consumer<PublishMetricsRequest.Builder> publishMetricsRequest)
                                       throws ValidationException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              MwaaException

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()

Parameters:

publishMetricsRequest - A Consumer that will call methods on PublishMetricsInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
                                        ValidationException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        MwaaException

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()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
                                            ValidationException,
                                            InternalServerException,
                                            AwsServiceException,
                                            SdkClientException,
                                            MwaaException

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()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

updateEnvironment

default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
                                             throws ResourceNotFoundException,
                                                    ValidationException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    MwaaException

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()

Parameters:

updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentInput.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MwaaException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static MwaaClient create()

Create a MwaaClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MwaaClientBuilder builder()

Create a builder that can be used to configure and create a MwaaClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MwaaServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient