/*
* 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.Threading;
using System.Threading.Tasks;
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
{
///
/// Paginators for the service
///
IMWAAPaginatorFactory Paginators { get; }
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateCliToken service method, as returned by MWAA.
///
/// ResourceNotFoundException: The resource is not available.
///
/// REST API Reference for CreateCliToken Operation
Task CreateCliTokenAsync(CreateCliTokenRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the CreateEnvironment service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateEnvironmentAsync(CreateEnvironmentRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task CreateWebLoginTokenAsync(CreateWebLoginTokenRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the DeleteEnvironment service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the GetEnvironment service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task GetEnvironmentAsync(GetEnvironmentRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
///
/// Container for the necessary parameters to execute the ListEnvironments service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListEnvironmentsAsync(ListEnvironmentsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Internal only. Publishes environment health metrics to Amazon CloudWatch.
///
/// Container for the necessary parameters to execute the PublishMetrics service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task PublishMetricsAsync(PublishMetricsRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// 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.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default(CancellationToken));
#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);
///
/// Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
///
/// Container for the necessary parameters to execute the UpdateEnvironment service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// 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
Task UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}