/*
* Copyright 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.
*/
/*
* Do not modify this file. This file is generated from the mwaa-2020-07-01.normal.json service model.
*/
using System;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.MWAA.Model;
namespace Amazon.MWAA
{
///
/// Interface for accessing MWAA
///
/// 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.
///
/// -
///
///
ops.airflow.{region}.amazonaws.com
- This endpoint is used to push environment
/// metrics that track environment health.
///
///
///
/// Regions
///
///
///
/// For a list of regions that Amazon MWAA supports, see Region
/// availability in the Amazon MWAA User Guide.
///
///
///
///
public partial interface IAmazonMWAA : IAmazonService, IDisposable
{
#if BCL45 || AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IMWAAPaginatorFactory Paginators { get; }
#endif
#region CreateCliToken
///
/// Creates a CLI token for the Airflow CLI. To learn more, see Creating
/// an Apache Airflow CLI token.
///
/// Container for the necessary parameters to execute the CreateCliToken service method.
///
/// The response from the CreateCliToken service method, as returned by MWAA.
///
/// ResourceNotFoundException: The resource is not available.
///
/// REST API Reference for CreateCliToken Operation
CreateCliTokenResponse CreateCliToken(CreateCliTokenRequest request);
///
/// Initiates the asynchronous execution of the CreateCliToken operation.
///
///
/// Container for the necessary parameters to execute the CreateCliToken operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateCliToken
/// operation.
/// REST API Reference for CreateCliToken Operation
IAsyncResult BeginCreateCliToken(CreateCliTokenRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateCliToken operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateCliToken.
///
/// Returns a CreateCliTokenResult from MWAA.
/// REST API Reference for CreateCliToken Operation
CreateCliTokenResponse EndCreateCliToken(IAsyncResult asyncResult);
#endregion
#region CreateEnvironment
///
/// Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the CreateEnvironment service method.
///
/// The response from the CreateEnvironment service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for CreateEnvironment Operation
CreateEnvironmentResponse CreateEnvironment(CreateEnvironmentRequest request);
///
/// Initiates the asynchronous execution of the CreateEnvironment operation.
///
///
/// Container for the necessary parameters to execute the CreateEnvironment operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateEnvironment
/// operation.
/// REST API Reference for CreateEnvironment Operation
IAsyncResult BeginCreateEnvironment(CreateEnvironmentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateEnvironment operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateEnvironment.
///
/// Returns a CreateEnvironmentResult from MWAA.
/// REST API Reference for CreateEnvironment Operation
CreateEnvironmentResponse EndCreateEnvironment(IAsyncResult asyncResult);
#endregion
#region CreateWebLoginToken
///
/// Creates a web login token for the Airflow Web UI. To learn more, see Creating
/// an Apache Airflow web login token.
///
/// Container for the necessary parameters to execute the CreateWebLoginToken service method.
///
/// The response from the CreateWebLoginToken service method, as returned by MWAA.
///
/// 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.
///
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for CreateWebLoginToken Operation
CreateWebLoginTokenResponse CreateWebLoginToken(CreateWebLoginTokenRequest request);
///
/// Initiates the asynchronous execution of the CreateWebLoginToken operation.
///
///
/// Container for the necessary parameters to execute the CreateWebLoginToken operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateWebLoginToken
/// operation.
/// REST API Reference for CreateWebLoginToken Operation
IAsyncResult BeginCreateWebLoginToken(CreateWebLoginTokenRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the CreateWebLoginToken operation.
///
///
/// The IAsyncResult returned by the call to BeginCreateWebLoginToken.
///
/// Returns a CreateWebLoginTokenResult from MWAA.
/// REST API Reference for CreateWebLoginToken Operation
CreateWebLoginTokenResponse EndCreateWebLoginToken(IAsyncResult asyncResult);
#endregion
#region DeleteEnvironment
///
/// Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the DeleteEnvironment service method.
///
/// The response from the DeleteEnvironment service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for DeleteEnvironment Operation
DeleteEnvironmentResponse DeleteEnvironment(DeleteEnvironmentRequest request);
///
/// Initiates the asynchronous execution of the DeleteEnvironment operation.
///
///
/// Container for the necessary parameters to execute the DeleteEnvironment operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteEnvironment
/// operation.
/// REST API Reference for DeleteEnvironment Operation
IAsyncResult BeginDeleteEnvironment(DeleteEnvironmentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the DeleteEnvironment operation.
///
///
/// The IAsyncResult returned by the call to BeginDeleteEnvironment.
///
/// Returns a DeleteEnvironmentResult from MWAA.
/// REST API Reference for DeleteEnvironment Operation
DeleteEnvironmentResponse EndDeleteEnvironment(IAsyncResult asyncResult);
#endregion
#region GetEnvironment
///
/// Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the GetEnvironment service method.
///
/// The response from the GetEnvironment service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for GetEnvironment Operation
GetEnvironmentResponse GetEnvironment(GetEnvironmentRequest request);
///
/// Initiates the asynchronous execution of the GetEnvironment operation.
///
///
/// Container for the necessary parameters to execute the GetEnvironment operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetEnvironment
/// operation.
/// REST API Reference for GetEnvironment Operation
IAsyncResult BeginGetEnvironment(GetEnvironmentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the GetEnvironment operation.
///
///
/// The IAsyncResult returned by the call to BeginGetEnvironment.
///
/// Returns a GetEnvironmentResult from MWAA.
/// REST API Reference for GetEnvironment Operation
GetEnvironmentResponse EndGetEnvironment(IAsyncResult asyncResult);
#endregion
#region ListEnvironments
///
/// Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
///
/// Container for the necessary parameters to execute the ListEnvironments service method.
///
/// The response from the ListEnvironments service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for ListEnvironments Operation
ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request);
///
/// Initiates the asynchronous execution of the ListEnvironments operation.
///
///
/// Container for the necessary parameters to execute the ListEnvironments operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListEnvironments
/// operation.
/// REST API Reference for ListEnvironments Operation
IAsyncResult BeginListEnvironments(ListEnvironmentsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListEnvironments operation.
///
///
/// The IAsyncResult returned by the call to BeginListEnvironments.
///
/// Returns a ListEnvironmentsResult from MWAA.
/// REST API Reference for ListEnvironments Operation
ListEnvironmentsResponse EndListEnvironments(IAsyncResult asyncResult);
#endregion
#region ListTagsForResource
///
/// Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache
/// Airflow (MWAA) environment. For example, "Environment": "Staging"
.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// The response from the ListTagsForResource service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request);
///
/// Initiates the asynchronous execution of the ListTagsForResource operation.
///
///
/// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource
/// operation.
/// REST API Reference for ListTagsForResource Operation
IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the ListTagsForResource operation.
///
///
/// The IAsyncResult returned by the call to BeginListTagsForResource.
///
/// Returns a ListTagsForResourceResult from MWAA.
/// REST API Reference for ListTagsForResource Operation
ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult);
#endregion
#region PublishMetrics
///
/// Internal only. Publishes environment health metrics to Amazon CloudWatch.
///
/// Container for the necessary parameters to execute the PublishMetrics service method.
///
/// The response from the PublishMetrics service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for PublishMetrics Operation
PublishMetricsResponse PublishMetrics(PublishMetricsRequest request);
///
/// Initiates the asynchronous execution of the PublishMetrics operation.
///
///
/// Container for the necessary parameters to execute the PublishMetrics operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPublishMetrics
/// operation.
/// REST API Reference for PublishMetrics Operation
IAsyncResult BeginPublishMetrics(PublishMetricsRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the PublishMetrics operation.
///
///
/// The IAsyncResult returned by the call to BeginPublishMetrics.
///
/// Returns a PublishMetricsResult from MWAA.
/// REST API Reference for PublishMetrics Operation
PublishMetricsResponse EndPublishMetrics(IAsyncResult asyncResult);
#endregion
#region TagResource
///
/// Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow
/// (MWAA) environment.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// The response from the TagResource service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for TagResource Operation
TagResourceResponse TagResource(TagResourceRequest request);
///
/// Initiates the asynchronous execution of the TagResource operation.
///
///
/// Container for the necessary parameters to execute the TagResource operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource
/// operation.
/// REST API Reference for TagResource Operation
IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the TagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginTagResource.
///
/// Returns a TagResourceResult from MWAA.
/// REST API Reference for TagResource Operation
TagResourceResponse EndTagResource(IAsyncResult asyncResult);
#endregion
#region UntagResource
///
/// Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache
/// Airflow (MWAA) environment. For example, "Environment": "Staging"
.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// The response from the UntagResource service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for UntagResource Operation
UntagResourceResponse UntagResource(UntagResourceRequest request);
///
/// Initiates the asynchronous execution of the UntagResource operation.
///
///
/// Container for the necessary parameters to execute the UntagResource operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource
/// operation.
/// REST API Reference for UntagResource Operation
IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UntagResource operation.
///
///
/// The IAsyncResult returned by the call to BeginUntagResource.
///
/// Returns a UntagResourceResult from MWAA.
/// REST API Reference for UntagResource Operation
UntagResourceResponse EndUntagResource(IAsyncResult asyncResult);
#endregion
#region UpdateEnvironment
///
/// Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the UpdateEnvironment service method.
///
/// The response from the UpdateEnvironment service method, as returned by MWAA.
///
/// InternalServerException: An internal error has occurred.
///
///
/// ResourceNotFoundException: The resource is not available.
///
///
/// ValidationException: The provided input is not valid.
///
/// REST API Reference for UpdateEnvironment Operation
UpdateEnvironmentResponse UpdateEnvironment(UpdateEnvironmentRequest request);
///
/// Initiates the asynchronous execution of the UpdateEnvironment operation.
///
///
/// Container for the necessary parameters to execute the UpdateEnvironment operation on AmazonMWAAClient.
/// An AsyncCallback delegate that is invoked when the operation completes.
/// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.
///
/// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateEnvironment
/// operation.
/// REST API Reference for UpdateEnvironment Operation
IAsyncResult BeginUpdateEnvironment(UpdateEnvironmentRequest request, AsyncCallback callback, object state);
///
/// Finishes the asynchronous execution of the UpdateEnvironment operation.
///
///
/// The IAsyncResult returned by the call to BeginUpdateEnvironment.
///
/// Returns a UpdateEnvironmentResult from MWAA.
/// REST API Reference for UpdateEnvironment Operation
UpdateEnvironmentResponse EndUpdateEnvironment(IAsyncResult asyncResult);
#endregion
}
}