You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MWAA

Inherits:

AWS.Service

Object
AWS.Service
AWS.MWAA

show all

Identifier:: mwaa

API Version:: 2020-07-01

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.

Sending a Request Using MWAA

var mwaa = new AWS.MWAA();
mwaa.createCliToken(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MWAA object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mwaa = new AWS.MWAA({apiVersion: '2020-07-01'});

You can also set the API version globally in AWS.config.apiVersions using the mwaa service identifier:

AWS.config.apiVersions = {
  mwaa: '2020-07-01',
  // other service API versions
};

var mwaa = new AWS.MWAA();

Version:

2020-07-01

Constructor Summary collapse

new AWS.MWAA(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

createCliToken(params = {}, callback) ⇒ AWS.Request
Create a CLI token to use Airflow CLI.

.
createEnvironment(params = {}, callback) ⇒ AWS.Request
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

.
createWebLoginToken(params = {}, callback) ⇒ AWS.Request
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.

.
deleteEnvironment(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

.
getEnvironment(params = {}, callback) ⇒ AWS.Request
Retrieves the details of an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

.
listEnvironments(params = {}, callback) ⇒ AWS.Request
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
publishMetrics(params = {}, callback) ⇒ AWS.Request
An operation for publishing metrics from the customers to the Ops plane.

.
tagResource(params = {}, callback) ⇒ AWS.Request
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
updateEnvironment(params = {}, callback) ⇒ AWS.Request
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MWAA(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MWAA object

var mwaa = new AWS.MWAA({apiVersion: '2020-07-01'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.MWAA.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.MWAA.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.MWAA.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

createCliToken(params = {}, callback) ⇒ `AWS.Request`

Create a CLI token to use Airflow CLI.

Service Reference:

CreateCliToken

Examples:

Calling the createCliToken operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
mwaa.createCliToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Name — (String)
  Create a CLI token request for a MWAA environment.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - CliToken — (String)
    Create an Airflow CLI login token response for the provided JWT token.
  - WebServerHostname — (String)
    Create an Airflow CLI login token response for the provided webserver hostname.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createEnvironment(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

CreateEnvironment

Examples:

Calling the createEnvironment operation

var params = {
  DagS3Path: 'STRING_VALUE', /* required */
  ExecutionRoleArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  NetworkConfiguration: { /* required */
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  SourceBucketArn: 'STRING_VALUE', /* required */
  AirflowConfigurationOptions: {
    '<ConfigKey>': 'STRING_VALUE',
    /* '<ConfigKey>': ... */
  },
  AirflowVersion: 'STRING_VALUE',
  EnvironmentClass: 'STRING_VALUE',
  KmsKey: 'STRING_VALUE',
  LoggingConfiguration: {
    DagProcessingLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    SchedulerLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    TaskLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    WebserverLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    WorkerLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    }
  },
  MaxWorkers: 'NUMBER_VALUE',
  MinWorkers: 'NUMBER_VALUE',
  PluginsS3ObjectVersion: 'STRING_VALUE',
  PluginsS3Path: 'STRING_VALUE',
  RequirementsS3ObjectVersion: 'STRING_VALUE',
  RequirementsS3Path: 'STRING_VALUE',
  Schedulers: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  WebserverAccessMode: PRIVATE_ONLY | PUBLIC_ONLY,
  WeeklyMaintenanceWindowStart: 'STRING_VALUE'
};
mwaa.createEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AirflowConfigurationOptions — (map<String>)
  A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.
- AirflowVersion — (String)
  The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.
- DagS3Path — (String)
  The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.
- EnvironmentClass — (String)
  The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.
- ExecutionRoleArn — (String)
  The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
- KmsKey — (String)
  The AWS Key Management Service (KMS) key to encrypt the data in your environment. You can use an AWS owned CMK, or a Customer managed CMK (advanced). To learn more, see Get started with Amazon Managed Workflows for Apache Airflow.
- LoggingConfiguration — (map)
  Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
  - DagProcessingLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - SchedulerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - TaskLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - WebserverLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - WorkerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
- MaxWorkers — (Integer)
  The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.
- MinWorkers — (Integer)
  The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.
- Name — (String)
  The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
- NetworkConfiguration — (map)
  The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
  - SecurityGroupIds — (Array<String>)
    A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
  - SubnetIds — (Array<String>)
    A list of 2 subnet IDs. Required to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group.
- PluginsS3ObjectVersion — (String)
  The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.
- PluginsS3Path — (String)
  The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.
- RequirementsS3ObjectVersion — (String)
  The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.
- RequirementsS3Path — (String)
  The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.
- Schedulers — (Integer)
  The number of Apache Airflow schedulers to run in your environment.
- SourceBucketArn — (String)
  The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.
- Tags — (map<String>)
  The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.
- WebserverAccessMode — (String)
  The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
  Possible values include:
  - "PRIVATE_ONLY"
  - "PUBLIC_ONLY"
- WeeklyMaintenanceWindowStart — (String)
  The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only. Supported input includes the following:
  - MON|TUE|WED|THU|FRI|SAT|SUN:([01]\d|2[0-3]):(00|30)

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String)
    The Amazon Resource Name (ARN) returned in the response for the environment.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createWebLoginToken(params = {}, callback) ⇒ `AWS.Request`

Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.

Service Reference:

CreateWebLoginToken

Examples:

Calling the createWebLoginToken operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
mwaa.createWebLoginToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Name — (String)
  Create an Airflow Web UI login token request for a MWAA environment.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - WebServerHostname — (String)
    Create an Airflow Web UI login token response for the provided webserver hostname.
  - WebToken — (String)
    Create an Airflow Web UI login token response for the provided JWT token.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteEnvironment(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

DeleteEnvironment

Examples:

Calling the deleteEnvironment operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
mwaa.deleteEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Name — (String)
  The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getEnvironment(params = {}, callback) ⇒ `AWS.Request`

Retrieves the details of an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Service Reference:

GetEnvironment

Examples:

Calling the getEnvironment operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
mwaa.getEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Name — (String)
  The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Environment — (map)
    An object containing all available details about the environment.
    
    AirflowConfigurationOptions — (map<String>)
    A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.
    
    AirflowVersion — (String)
    The Apache Airflow version on your environment. For example, v1.10.12.
    
    Arn — (String)
    The Amazon Resource Name (ARN) of the Amazon MWAA environment.
    
    CreatedAt — (Date)
    The day and time the environment was created.
    
    DagS3Path — (String)
    The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.
    
    EnvironmentClass — (String)
    The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.
    
    ExecutionRoleArn — (String)
    The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
    
    KmsKey — (String)
    The Key Management Service (KMS) encryption key used to encrypt the data in your environment.
    
    LastUpdate — (map)
    The status of the last update on the environment, and any errors that were encountered.
    
    CreatedAt — (Date)
    The day and time of the last update on the environment.
    
    Error — (map)
    The error that was encountered during the last update of the environment.
    
    ErrorCode — (String)
    The error code that corresponds to the error with the last update.
    
    ErrorMessage — (String)
    The error message that corresponds to the error code.
    
    Status — (String)
    The status of the last update on the environment. Valid values: SUCCESS, PENDING, FAILED.
    Possible values include:
    
    "SUCCESS"
    
    "PENDING"
    
    "FAILED"
    
    LoggingConfiguration — (map)
    The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
    
    DagProcessingLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    
    CloudWatchLogGroupArn — (String)
    The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
    
    Enabled — (Boolean)
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    
    LogLevel — (String)
    Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
    Possible values include:
    
    "CRITICAL"
    
    "ERROR"
    
    "WARNING"
    
    "INFO"
    
    "DEBUG"
    
    SchedulerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    
    CloudWatchLogGroupArn — (String)
    The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
    
    Enabled — (Boolean)
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    
    LogLevel — (String)
    Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
    Possible values include:
    
    "CRITICAL"
    
    "ERROR"
    
    "WARNING"
    
    "INFO"
    
    "DEBUG"
    
    TaskLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    
    CloudWatchLogGroupArn — (String)
    The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
    
    Enabled — (Boolean)
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    
    LogLevel — (String)
    Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
    Possible values include:
    
    "CRITICAL"
    
    "ERROR"
    
    "WARNING"
    
    "INFO"
    
    "DEBUG"
    
    WebserverLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    
    CloudWatchLogGroupArn — (String)
    The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
    
    Enabled — (Boolean)
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    
    LogLevel — (String)
    Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
    Possible values include:
    
    "CRITICAL"
    
    "ERROR"
    
    "WARNING"
    
    "INFO"
    
    "DEBUG"
    
    WorkerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    
    CloudWatchLogGroupArn — (String)
    The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
    
    Enabled — (Boolean)
    Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    
    LogLevel — (String)
    Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
    Possible values include:
    
    "CRITICAL"
    
    "ERROR"
    
    "WARNING"
    
    "INFO"
    
    "DEBUG"
    
    MaxWorkers — (Integer)
    The maximum number of workers that run in your environment. For example, 20.
    
    MinWorkers — (Integer)
    The minimum number of workers that run in your environment. For example, 2.
    
    Name — (String)
    The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
    
    NetworkConfiguration — (map)
    The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
    
    SecurityGroupIds — (Array<String>)
    A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
    
    SubnetIds — (Array<String>)
    A list of 2 subnet IDs. Required to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group.
    
    PluginsS3ObjectVersion — (String)
    The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.
    
    PluginsS3Path — (String)
    The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. To learn more, see Installing custom plugins.
    
    RequirementsS3ObjectVersion — (String)
    The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.
    
    RequirementsS3Path — (String)
    The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. To learn more, see Installing Python dependencies.
    
    Schedulers — (Integer)
    The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
    
    ServiceRoleArn — (String)
    The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.
    
    SourceBucketArn — (String)
    The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.
    
    Status — (String)
    The status of the Amazon MWAA environment. Valid values:
    
    CREATING - Indicates the request to create the environment is in progress.
    
    CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.
    
    AVAILABLE - Indicates the request was successful and the environment is ready to use.
    
    UPDATING - Indicates the request to update the environment is in progress.
    
    DELETING - Indicates the request to delete the environment is in progress.
    
    DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.
    
    UNAVAILABLE - Indicates the request failed, but the environment was unable to rollback and is not in a stable state.
    
    UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
    
    We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.
    Possible values include:
    
    "CREATING"
    
    "CREATE_FAILED"
    
    "AVAILABLE"
    
    "UPDATING"
    
    "DELETING"
    
    "DELETED"
    
    "UNAVAILABLE"
    
    "UPDATE_FAILED"
    
    Tags — (map<String>)
    The key-value tag pairs associated to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.
    
    WebserverAccessMode — (String)
    The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
    Possible values include:
    
    "PRIVATE_ONLY"
    
    "PUBLIC_ONLY"
    
    WebserverUrl — (String)
    The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.
    
    WeeklyMaintenanceWindowStart — (String)
    The day and time of the week that weekly maintenance updates are scheduled. For example: TUE:03:30.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listEnvironments(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

ListEnvironments

Examples:

Calling the listEnvironments operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mwaa.listEnvironments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- MaxResults — (Integer)
  The maximum number of results to retrieve per page. For example, 5 environments per page.
- NextToken — (String)
  Retrieves the next page of the results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Environments — (Array<String>)
    Returns the list of Amazon MWAA environments.
  - NextToken — (String)
    Retrieves the next page of the results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mwaa.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Tags — (map<String>)
    The key-value tag pairs associated to your environment. To learn more, see Tagging AWS resources.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

publishMetrics(params = {}, callback) ⇒ `AWS.Request`

An operation for publishing metrics from the customers to the Ops plane.

Service Reference:

PublishMetrics

Examples:

Calling the publishMetrics operation

var params = {
  EnvironmentName: 'STRING_VALUE', /* required */
  MetricData: [ /* required */
    {
      MetricName: 'STRING_VALUE', /* required */
      Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      Dimensions: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      StatisticValues: {
        Maximum: 'NUMBER_VALUE',
        Minimum: 'NUMBER_VALUE',
        SampleCount: 'NUMBER_VALUE',
        Sum: 'NUMBER_VALUE'
      },
      Unit: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None,
      Value: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
mwaa.publishMetrics(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- EnvironmentName — (String)
  Publishes environment metric data to Amazon CloudWatch.
- MetricData — (Array<map>)
  Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metrica.
  - Dimensions — (Array<map>)
    Internal only API.
    - Name — required — (String)
      Internal only API.
    - Value — required — (String)
      Internal only API.
  - MetricName — required — (String)
    Internal only API.
  - StatisticValues — (map)
    Internal only API.
    - Maximum — (Float)
      Internal only API.
    - Minimum — (Float)
      Internal only API.
    - SampleCount — (Integer)
      Internal only API.
    - Sum — (Float)
      Internal only API.
  - Timestamp — required — (Date)
    Internal only API.
  - Unit — (String)
    Unit
    Possible values include:
    - "Seconds"
    - "Microseconds"
    - "Milliseconds"
    - "Bytes"
    - "Kilobytes"
    - "Megabytes"
    - "Gigabytes"
    - "Terabytes"
    - "Bits"
    - "Kilobits"
    - "Megabits"
    - "Gigabits"
    - "Terabits"
    - "Percent"
    - "Count"
    - "Bytes/Second"
    - "Kilobytes/Second"
    - "Megabytes/Second"
    - "Gigabytes/Second"
    - "Terabytes/Second"
    - "Bits/Second"
    - "Kilobits/Second"
    - "Megabits/Second"
    - "Gigabits/Second"
    - "Terabits/Second"
    - "Count/Second"
    - "None"
  - Value — (Float)
    Internal only API.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mwaa.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
- Tags — (map<String>)
  The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mwaa.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceArn — (String)
  The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
- tagKeys — (Array<String>)
  The key-value tag pair you want to remove. For example, "Environment": "Staging".

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateEnvironment(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UpdateEnvironment

Examples:

Calling the updateEnvironment operation

var params = {
  Name: 'STRING_VALUE', /* required */
  AirflowConfigurationOptions: {
    '<ConfigKey>': 'STRING_VALUE',
    /* '<ConfigKey>': ... */
  },
  AirflowVersion: 'STRING_VALUE',
  DagS3Path: 'STRING_VALUE',
  EnvironmentClass: 'STRING_VALUE',
  ExecutionRoleArn: 'STRING_VALUE',
  LoggingConfiguration: {
    DagProcessingLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    SchedulerLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    TaskLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    WebserverLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    },
    WorkerLogs: {
      Enabled: true || false, /* required */
      LogLevel: CRITICAL | ERROR | WARNING | INFO | DEBUG /* required */
    }
  },
  MaxWorkers: 'NUMBER_VALUE',
  MinWorkers: 'NUMBER_VALUE',
  NetworkConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  PluginsS3ObjectVersion: 'STRING_VALUE',
  PluginsS3Path: 'STRING_VALUE',
  RequirementsS3ObjectVersion: 'STRING_VALUE',
  RequirementsS3Path: 'STRING_VALUE',
  Schedulers: 'NUMBER_VALUE',
  SourceBucketArn: 'STRING_VALUE',
  WebserverAccessMode: PRIVATE_ONLY | PUBLIC_ONLY,
  WeeklyMaintenanceWindowStart: 'STRING_VALUE'
};
mwaa.updateEnvironment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AirflowConfigurationOptions — (map<String>)
  A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.
- AirflowVersion — (String)
  The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.
- DagS3Path — (String)
  The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.
- EnvironmentClass — (String)
  The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.
- ExecutionRoleArn — (String)
  The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
- LoggingConfiguration — (map)
  Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
  - DagProcessingLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - SchedulerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - TaskLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - WebserverLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
  - WorkerLogs — (map)
    Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
    - Enabled — required — (Boolean)
      Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
    - LogLevel — required — (String)
      Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
      Possible values include:
      
      "CRITICAL"
      
      "ERROR"
      
      "WARNING"
      
      "INFO"
      
      "DEBUG"
- MaxWorkers — (Integer)
  The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.
- MinWorkers — (Integer)
  The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.
- Name — (String)
  The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
- NetworkConfiguration — (map)
  The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
  - SecurityGroupIds — required — (Array<String>)
    A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
- PluginsS3ObjectVersion — (String)
  The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.
- PluginsS3Path — (String)
  The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins.
- RequirementsS3ObjectVersion — (String)
  The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.
- RequirementsS3Path — (String)
  The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.
- Schedulers — (Integer)
  The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
- SourceBucketArn — (String)
  The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.
- WebserverAccessMode — (String)
  The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
  Possible values include:
  - "PRIVATE_ONLY"
  - "PUBLIC_ONLY"
- WeeklyMaintenanceWindowStart — (String)
  The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only. Supported input includes the following:
  - MON|TUE|WED|THU|FRI|SAT|SUN:([01]\d|2[0-3]):(00|30)

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Arn — (String)
    The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.MWAA

Overview

Service Description

Sending a Request Using MWAA

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.MWAA(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createCliToken(params = {}, callback) ⇒ AWS.Request

createEnvironment(params = {}, callback) ⇒ AWS.Request

createWebLoginToken(params = {}, callback) ⇒ AWS.Request

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

getEnvironment(params = {}, callback) ⇒ AWS.Request

listEnvironments(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

publishMetrics(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

updateEnvironment(params = {}, callback) ⇒ AWS.Request

new AWS.MWAA(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createCliToken(params = {}, callback) ⇒ `AWS.Request`

createEnvironment(params = {}, callback) ⇒ `AWS.Request`

createWebLoginToken(params = {}, callback) ⇒ `AWS.Request`

deleteEnvironment(params = {}, callback) ⇒ `AWS.Request`

getEnvironment(params = {}, callback) ⇒ `AWS.Request`

listEnvironments(params = {}, callback) ⇒ `AWS.Request`

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

publishMetrics(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`

updateEnvironment(params = {}, callback) ⇒ `AWS.Request`