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.

Installing

To install this package, simply type add or install @aws-sdk/client-mwaa using your favorite package manager:

npm install @aws-sdk/client-mwaa
yarn add @aws-sdk/client-mwaa
pnpm add @aws-sdk/client-mwaa

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the MWAAClient and the commands you need, for example ListEnvironmentsCommand:

// ES5 example
const { MWAAClient, ListEnvironmentsCommand } = require("@aws-sdk/client-mwaa");

// ES6+ example
import { MWAAClient, ListEnvironmentsCommand } from "@aws-sdk/client-mwaa";

Usage

To send a request, you:

Initiate client with configuration (e.g. credentials, region).
Initiate command with input parameters.
Call send operation on client with command object as input.
If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new MWAAClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListEnvironmentsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-mwaa";
const client = new AWS.MWAA({ region: "REGION" });

// async/await.
try {
  const data = await client.listEnvironments(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listEnvironments(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listEnvironments(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-mwaa package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateCliToken

Command API Reference / Input / Output

CreateEnvironment

Command API Reference / Input / Output

CreateWebLoginToken

Command API Reference / Input / Output

DeleteEnvironment

Command API Reference / Input / Output

GetEnvironment

Command API Reference / Input / Output

InvokeRestApi

Command API Reference / Input / Output

ListEnvironments

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PublishMetrics

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateEnvironment

Command API Reference / Input / Output

FAQs

What is @aws-sdk/client-mwaa?

Is @aws-sdk/client-mwaa popular?

Is @aws-sdk/client-mwaa well maintained?

Package last updated on 15 Nov 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@aws-sdk/client-mwaa