com.amazonaws.services.mwaa.AmazonMWAAAsync Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mwaa;
import javax.annotation.Generated;
import com.amazonaws.services.mwaa.model.*;
/**
* Interface for accessing AmazonMWAA asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.mwaa.AbstractAmazonMWAAAsync} 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.
*
*
* -
*
*
* -
*
*
* -
*
* 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.
*
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonMWAAAsync extends AmazonMWAA {
/**
*
* Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI
* token.
*
*
* @param createCliTokenRequest
* @return A Java Future containing the result of the CreateCliToken operation returned by the service.
* @sample AmazonMWAAAsync.CreateCliToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createCliTokenAsync(CreateCliTokenRequest createCliTokenRequest);
/**
*
* Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI
* token.
*
*
* @param createCliTokenRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateCliToken operation returned by the service.
* @sample AmazonMWAAAsyncHandler.CreateCliToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createCliTokenAsync(CreateCliTokenRequest createCliTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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 A Java Future containing the result of the CreateEnvironment operation returned by the service.
* @sample AmazonMWAAAsync.CreateEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createEnvironmentAsync(CreateEnvironmentRequest createEnvironmentRequest);
/**
*
* 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.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateEnvironment operation returned by the service.
* @sample AmazonMWAAAsyncHandler.CreateEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createEnvironmentAsync(CreateEnvironmentRequest createEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web
* login token.
*
*
* @param createWebLoginTokenRequest
* @return A Java Future containing the result of the CreateWebLoginToken operation returned by the service.
* @sample AmazonMWAAAsync.CreateWebLoginToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createWebLoginTokenAsync(CreateWebLoginTokenRequest createWebLoginTokenRequest);
/**
*
* Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web
* login token.
*
*
* @param createWebLoginTokenRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateWebLoginToken operation returned by the service.
* @sample AmazonMWAAAsyncHandler.CreateWebLoginToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createWebLoginTokenAsync(CreateWebLoginTokenRequest createWebLoginTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param deleteEnvironmentRequest
* @return A Java Future containing the result of the DeleteEnvironment operation returned by the service.
* @sample AmazonMWAAAsync.DeleteEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteEnvironmentAsync(DeleteEnvironmentRequest deleteEnvironmentRequest);
/**
*
* Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param deleteEnvironmentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteEnvironment operation returned by the service.
* @sample AmazonMWAAAsyncHandler.DeleteEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteEnvironmentAsync(DeleteEnvironmentRequest deleteEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param getEnvironmentRequest
* @return A Java Future containing the result of the GetEnvironment operation returned by the service.
* @sample AmazonMWAAAsync.GetEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getEnvironmentAsync(GetEnvironmentRequest getEnvironmentRequest);
/**
*
* Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param getEnvironmentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetEnvironment operation returned by the service.
* @sample AmazonMWAAAsyncHandler.GetEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getEnvironmentAsync(GetEnvironmentRequest getEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
*
*
* @param listEnvironmentsRequest
* @return A Java Future containing the result of the ListEnvironments operation returned by the service.
* @sample AmazonMWAAAsync.ListEnvironments
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listEnvironmentsAsync(ListEnvironmentsRequest listEnvironmentsRequest);
/**
*
* Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
*
*
* @param listEnvironmentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListEnvironments operation returned by the service.
* @sample AmazonMWAAAsyncHandler.ListEnvironments
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listEnvironmentsAsync(ListEnvironmentsRequest listEnvironmentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonMWAAAsync.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonMWAAAsyncHandler.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Internal only. Publishes environment health metrics to Amazon CloudWatch.
*
*
* @param publishMetricsRequest
* @return A Java Future containing the result of the PublishMetrics operation returned by the service.
* @sample AmazonMWAAAsync.PublishMetrics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishMetricsAsync(PublishMetricsRequest publishMetricsRequest);
/**
*
* Internal only. Publishes environment health metrics to Amazon CloudWatch.
*
*
* @param publishMetricsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PublishMetrics operation returned by the service.
* @sample AmazonMWAAAsyncHandler.PublishMetrics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishMetricsAsync(PublishMetricsRequest publishMetricsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonMWAAAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonMWAAAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonMWAAAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
* For example, "Environment": "Staging".
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonMWAAAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param updateEnvironmentRequest
* @return A Java Future containing the result of the UpdateEnvironment operation returned by the service.
* @sample AmazonMWAAAsync.UpdateEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateEnvironmentAsync(UpdateEnvironmentRequest updateEnvironmentRequest);
/**
*
* Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
*
*
* @param updateEnvironmentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateEnvironment operation returned by the service.
* @sample AmazonMWAAAsyncHandler.UpdateEnvironment
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateEnvironmentAsync(UpdateEnvironmentRequest updateEnvironmentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}