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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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) Create a CLI token to use Airflow CLI.
CreateEnvironmentResult	createEnvironment(CreateEnvironmentRequest request) JSON blob that describes the environment to create.
CreateWebLoginTokenResult	createWebLoginToken(CreateWebLoginTokenRequest request) Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
DeleteEnvironmentResult	deleteEnvironment(DeleteEnvironmentRequest request) 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 request) Get details of an existing environment.
ListEnvironmentsResult	listEnvironments(ListEnvironmentsRequest request) List Amazon MWAA Environments.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List the tags for MWAA environments.
PublishMetricsResult	publishMetrics(PublishMetricsRequest request) 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 request) Add tag to the MWAA environments.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove a tag from the MWAA environments.
UpdateEnvironmentResult	updateEnvironment(UpdateEnvironmentRequest request) Update an MWAA environment.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonMWAAClientBuilder builder()

createCliToken

public CreateCliTokenResult createCliToken(CreateCliTokenRequest request)

Create a CLI token to use Airflow CLI.

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)

JSON blob that describes the environment to create.

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)

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

Specified by:

createWebLoginToken in interface AmazonMWAA

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

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Delete an existing 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)

Get details of an existing 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)

List Amazon 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)

List the tags for MWAA environments.

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)

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

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)

Add tag to the MWAA environments.

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)

Remove a tag from the MWAA environments.

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)

Update an 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 interface: AmazonMWAA

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.

Specified by:

shutdown in interface AmazonMWAA

Overrides:

shutdown in class AmazonWebServiceClient