AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation 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

Regions

For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.MWAA.AmazonMWAAClient

Namespace: Amazon.MWAA
Assembly: AWSSDK.MWAA.dll
Version: 3.x.y.z

Syntax

C# 
public class AmazonMWAAClient : AmazonServiceClient
         IAmazonMWAA, IAmazonService, IDisposable

The AmazonMWAAClient type exposes the following members

Constructors

NameDescription
Public Method AmazonMWAAClient()

Constructs AmazonMWAAClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMWAAClient(RegionEndpoint)

Constructs AmazonMWAAClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMWAAClient(AmazonMWAAConfig)

Constructs AmazonMWAAClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonMWAAClient(AWSCredentials)

Constructs AmazonMWAAClient with AWS Credentials

Public Method AmazonMWAAClient(AWSCredentials, RegionEndpoint)

Constructs AmazonMWAAClient with AWS Credentials

Public Method AmazonMWAAClient(AWSCredentials, AmazonMWAAConfig)

Constructs AmazonMWAAClient with AWS Credentials and an AmazonMWAAClient Configuration object.

Public Method AmazonMWAAClient(string, string)

Constructs AmazonMWAAClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMWAAClient(string, string, RegionEndpoint)

Constructs AmazonMWAAClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMWAAClient(string, string, AmazonMWAAConfig)

Constructs AmazonMWAAClient with AWS Access Key ID, AWS Secret Key and an AmazonMWAAClient Configuration object.

Public Method AmazonMWAAClient(string, string, string)

Constructs AmazonMWAAClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMWAAClient(string, string, string, RegionEndpoint)

Constructs AmazonMWAAClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonMWAAClient(string, string, string, AmazonMWAAConfig)

Constructs AmazonMWAAClient with AWS Access Key ID, AWS Secret Key and an AmazonMWAAClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.MWAA.Model.IMWAAPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateCliToken(CreateCliTokenRequest)

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Public Method CreateCliTokenAsync(CreateCliTokenRequest, CancellationToken)

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Public Method CreateEnvironment(CreateEnvironmentRequest)

Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Public Method CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Public Method CreateWebLoginToken(CreateWebLoginTokenRequest)

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Public Method CreateWebLoginTokenAsync(CreateWebLoginTokenRequest, CancellationToken)

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Public Method DeleteEnvironment(DeleteEnvironmentRequest)

Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Public Method DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetEnvironment(GetEnvironmentRequest)

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Public Method GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Public Method InvokeRestApi(InvokeRestApiRequest)

Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API
Public Method InvokeRestApiAsync(InvokeRestApiRequest, CancellationToken)

Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API
Public Method ListEnvironments(ListEnvironmentsRequest)

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Public Method ListEnvironmentsAsync(ListEnvironmentsRequest, CancellationToken)

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Public Method PublishMetrics(PublishMetricsRequest)

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Public Method PublishMetricsAsync(PublishMetricsRequest, CancellationToken)

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Public Method TagResource(TagResourceRequest)

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Public Method UntagResource(UntagResourceRequest)

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Public Method UpdateEnvironment(UpdateEnvironmentRequest)

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Public Method UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5