- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
MWAAClient
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.
Regions
For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.
Installation
npm install @aws-sdk/client-mwaa
yarn add @aws-sdk/client-mwaa
pnpm add @aws-sdk/client-mwaa
MWAAClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateCliTokenCommand | Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token . |
CreateEnvironmentCommand | Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment. |
CreateWebLoginTokenCommand | Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token . |
DeleteEnvironmentCommand | Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment. |
GetEnvironmentCommand | Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. |
InvokeRestApiCommand | Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API |
ListEnvironmentsCommand | Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments. |
ListTagsForResourceCommand | Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, |
PublishMetricsCommand | Internal only. Publishes environment health metrics to Amazon CloudWatch. |
TagResourceCommand | Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. |
UntagResourceCommand | Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, |
UpdateEnvironmentCommand | Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. |
MWAAClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: MWAAClientConfig