*
*
* 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.
*
* GetEnvironment *
** ListEnvironments *
** TagResource *
** UntagResource *
*
* env.airflow.{region}.amazonaws.com - This endpoint is used to operate the Airflow environment.
*
* CreateCliToken *
*
* 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. *
* */ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonMWAAClient extends AmazonWebServiceClient implements AmazonMWAA { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonMWAA.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "airflow"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller( com.amazonaws.services.mwaa.model.transform.AccessDeniedExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.mwaa.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.mwaa.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.mwaa.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.mwaa.model.AmazonMWAAException.class)); public static AmazonMWAAClientBuilder builder() { return AmazonMWAAClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AmazonMWAA using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonMWAAClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AmazonMWAA using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonMWAAClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("airflow.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/mwaa/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/mwaa/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI * token. *
* * @param createCliTokenRequest * @return Result of the CreateCliToken operation returned by the service. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @sample AmazonMWAA.CreateCliToken * @see AWS API * Documentation */ @Override public CreateCliTokenResult createCliToken(CreateCliTokenRequest request) { request = beforeClientExecution(request); return executeCreateCliToken(request); } @SdkInternalApi final CreateCliTokenResult executeCreateCliToken(CreateCliTokenRequest createCliTokenRequest) { ExecutionContext executionContext = createExecutionContext(createCliTokenRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. *
* * @param 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. * @return Result of the CreateEnvironment operation returned by the service. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.CreateEnvironment * @see AWS API * Documentation */ @Override public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request) { request = beforeClientExecution(request); return executeCreateEnvironment(request); } @SdkInternalApi final CreateEnvironmentResult executeCreateEnvironment(CreateEnvironmentRequest createEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(createEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web * login token. *
* * @param createWebLoginTokenRequest * @return 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. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.CreateWebLoginToken * @see AWS API * Documentation */ @Override public CreateWebLoginTokenResult createWebLoginToken(CreateWebLoginTokenRequest request) { request = beforeClientExecution(request); return executeCreateWebLoginToken(request); } @SdkInternalApi final CreateWebLoginTokenResult executeCreateWebLoginToken(CreateWebLoginTokenRequest createWebLoginTokenRequest) { ExecutionContext executionContext = createExecutionContext(createWebLoginTokenRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. *
* * @param deleteEnvironmentRequest * @return Result of the DeleteEnvironment operation returned by the service. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.DeleteEnvironment * @see AWS API * Documentation */ @Override public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request) { request = beforeClientExecution(request); return executeDeleteEnvironment(request); } @SdkInternalApi final DeleteEnvironmentResult executeDeleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(deleteEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. *
* * @param getEnvironmentRequest * @return Result of the GetEnvironment operation returned by the service. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.GetEnvironment * @see AWS API * Documentation */ @Override public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request) { request = beforeClientExecution(request); return executeGetEnvironment(request); } @SdkInternalApi final GetEnvironmentResult executeGetEnvironment(GetEnvironmentRequest getEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(getEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments. *
* * @param listEnvironmentsRequest * @return Result of the ListEnvironments operation returned by the service. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.ListEnvironments * @see AWS API * Documentation */ @Override public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request) { request = beforeClientExecution(request); return executeListEnvironments(request); } @SdkInternalApi final ListEnvironmentsResult executeListEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) { ExecutionContext executionContext = createExecutionContext(listEnvironmentsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
* Internal only. Publishes environment health metrics to Amazon CloudWatch. *
* * @param publishMetricsRequest * @return Result of the PublishMetrics operation returned by the service. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.PublishMetrics * @see AWS API * Documentation */ @Override public PublishMetricsResult publishMetrics(PublishMetricsRequest request) { request = beforeClientExecution(request); return executePublishMetrics(request); } @SdkInternalApi final PublishMetricsResult executePublishMetrics(PublishMetricsRequest publishMetricsRequest) { ExecutionContext executionContext = createExecutionContext(publishMetricsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.TagResource * @see AWS API * Documentation */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
* Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. *
* * @param updateEnvironmentRequest * @return Result of the UpdateEnvironment operation returned by the service. * @throws ResourceNotFoundException * ResourceNotFoundException: The resource is not available. * @throws ValidationException * ValidationException: The provided input is not valid. * @throws InternalServerException * InternalServerException: An internal error has occurred. * @sample AmazonMWAA.UpdateEnvironment * @see AWS API * Documentation */ @Override public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request) { request = beforeClientExecution(request); return executeUpdateEnvironment(request); } @SdkInternalApi final UpdateEnvironmentResult executeUpdateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) { ExecutionContext executionContext = createExecutionContext(updateEnvironmentRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private