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.

Class: AWS.MWAA

Inherits:
AWS.Service 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

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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

endpointAWS.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:

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

JSON blob that describes the environment to create.

Service Reference:

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',
  PluginsS3ObjectVersion: 'STRING_VALUE',
  PluginsS3Path: 'STRING_VALUE',
  RequirementsS3ObjectVersion: 'STRING_VALUE',
  RequirementsS3Path: 'STRING_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>)

      The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.

    • AirflowVersion — (String)

      The Apache Airflow version you want to use for your environment.

    • DagS3Path — (String)

      The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.

    • EnvironmentClass — (String)

      The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.

    • 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. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow.

    • KmsKey — (String)

      The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.

    • LoggingConfiguration — (map)

      The Apache Airflow logs you want to send to Amazon CloudWatch Logs.

      • DagProcessingLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • SchedulerLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • TaskLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • WebserverLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • WorkerLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or 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 and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.

    • Name — (String)

      The name of your MWAA environment.

    • NetworkConfiguration — (map)

      The VPC networking components you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.

      • SecurityGroupIds — (Array<String>)

        A JSON list of 1 or more security groups IDs by name, in the same VPC as the subnets.

      • SubnetIds — (Array<String>)

        Provide a JSON list of 2 subnet IDs by name. These must be private subnets, in the same VPC, in two different availability zones.

    • PluginsS3ObjectVersion — (String)

      The plugins.zip file version you want to use.

    • PluginsS3Path — (String)

      The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then PluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

    • RequirementsS3ObjectVersion — (String)

      The requirements.txt file version you want to use.

    • RequirementsS3Path — (String)

      The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then RequirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.

    • SourceBucketArn — (String)

      The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.

    • Tags — (map<String>)

      The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.

    • WebserverAccessMode — (String)

      The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.

      Possible values include:
      • "PRIVATE_ONLY"
      • "PUBLIC_ONLY"
    • WeeklyMaintenanceWindowStart — (String)

      The day and time you want MWAA to start weekly maintenance updates on your 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:

      • Arn — (String)

        The resulting Amazon MWAA envirnonment ARN.

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:

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

Delete an existing environment.

Service Reference:

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 environment to delete.

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

Get details of an existing environment.

Service Reference:

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 environment to retrieve.

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)

        A JSON blob with environment details.

        • AirflowConfigurationOptions — (map<String>)

          The Airflow Configuration Options of the Amazon MWAA Environment.

        • AirflowVersion — (String)

          The AirflowV ersion of the Amazon MWAA Environment.

        • Arn — (String)

          The ARN of the Amazon MWAA Environment.

        • CreatedAt — (Date)

          The Created At date of the Amazon MWAA Environment.

        • DagS3Path — (String)

          The Dags S3 Path of the Amazon MWAA Environment.

        • EnvironmentClass — (String)

          The Environment Class (size) of the Amazon MWAA Environment.

        • ExecutionRoleArn — (String)

          The Execution Role ARN of the Amazon MWAA Environment.

        • KmsKey — (String)

          The Kms Key of the Amazon MWAA Environment.

        • LastUpdate — (map)

          Last update information for the environment.

          • CreatedAt — (Date)

            Time that last update occurred.

          • Error — (map)

            Error string of last update, if applicable.

            • ErrorCode — (String)

              Error code of update.

            • ErrorMessage — (String)

              Error message of update.

          • Status — (String)

            Status of last update of SUCCESS, FAILED, CREATING, DELETING.

            Possible values include:
            • "SUCCESS"
            • "PENDING"
            • "FAILED"
        • LoggingConfiguration — (map)

          The Logging Configuration of the Amazon MWAA Environment.

          • DagProcessingLogs — (map)

            A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

            • CloudWatchLogGroupArn — (String)

              Provides the ARN for the CloudWatch group where the logs will be published.

            • Enabled — (Boolean)

              Defines that the logging module is enabled.

            • LogLevel — (String)

              Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

              Possible values include:
              • "CRITICAL"
              • "ERROR"
              • "WARNING"
              • "INFO"
              • "DEBUG"
          • SchedulerLogs — (map)

            A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

            • CloudWatchLogGroupArn — (String)

              Provides the ARN for the CloudWatch group where the logs will be published.

            • Enabled — (Boolean)

              Defines that the logging module is enabled.

            • LogLevel — (String)

              Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

              Possible values include:
              • "CRITICAL"
              • "ERROR"
              • "WARNING"
              • "INFO"
              • "DEBUG"
          • TaskLogs — (map)

            A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

            • CloudWatchLogGroupArn — (String)

              Provides the ARN for the CloudWatch group where the logs will be published.

            • Enabled — (Boolean)

              Defines that the logging module is enabled.

            • LogLevel — (String)

              Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

              Possible values include:
              • "CRITICAL"
              • "ERROR"
              • "WARNING"
              • "INFO"
              • "DEBUG"
          • WebserverLogs — (map)

            A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

            • CloudWatchLogGroupArn — (String)

              Provides the ARN for the CloudWatch group where the logs will be published.

            • Enabled — (Boolean)

              Defines that the logging module is enabled.

            • LogLevel — (String)

              Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

              Possible values include:
              • "CRITICAL"
              • "ERROR"
              • "WARNING"
              • "INFO"
              • "DEBUG"
          • WorkerLogs — (map)

            A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

            • CloudWatchLogGroupArn — (String)

              Provides the ARN for the CloudWatch group where the logs will be published.

            • Enabled — (Boolean)

              Defines that the logging module is enabled.

            • LogLevel — (String)

              Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

              Possible values include:
              • "CRITICAL"
              • "ERROR"
              • "WARNING"
              • "INFO"
              • "DEBUG"
        • MaxWorkers — (Integer)

          The Maximum Workers of the Amazon MWAA Environment.

        • Name — (String)

          The name of the Amazon MWAA Environment.

        • NetworkConfiguration — (map)

          Provide the security group and subnet IDs for the workers and scheduler.

          • SecurityGroupIds — (Array<String>)

            A JSON list of 1 or more security groups IDs by name, in the same VPC as the subnets.

          • SubnetIds — (Array<String>)

            Provide a JSON list of 2 subnet IDs by name. These must be private subnets, in the same VPC, in two different availability zones.

        • PluginsS3ObjectVersion — (String)

          The Plugins.zip S3 Object Version of the Amazon MWAA Environment.

        • PluginsS3Path — (String)

          The Plugins.zip S3 Path of the Amazon MWAA Environment.

        • RequirementsS3ObjectVersion — (String)

          The Requirements.txt file S3 Object Version of the Amazon MWAA Environment.

        • RequirementsS3Path — (String)

          The Requirement.txt S3 Path of the Amazon MWAA Environment.

        • ServiceRoleArn — (String)

          The Service Role ARN of the Amazon MWAA Environment.

        • SourceBucketArn — (String)

          The Source S3 Bucket ARN of the Amazon MWAA Environment.

        • Status — (String)

          The status of the Amazon MWAA Environment.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "AVAILABLE"
          • "UPDATING"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>)

          The Tags of the Amazon MWAA Environment.

        • WebserverAccessMode — (String)

          The Webserver Access Mode of the Amazon MWAA Environment (public or private only).

          Possible values include:
          • "PRIVATE_ONLY"
          • "PUBLIC_ONLY"
        • WebserverUrl — (String)

          The Webserver URL of the Amazon MWAA Environment.

        • WeeklyMaintenanceWindowStart — (String)

          The Weekly Maintenance Window Start of the Amazon MWAA Environment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List Amazon MWAA Environments.

Service Reference:

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 results when listing MWAA environments.

    • NextToken — (String)

      The Next Token when listing MWAA environments.

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>)

        The list of Amazon MWAA Environments.

      • NextToken — (String)

        The Next Token when listing MWAA environments.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

List the tags for MWAA environments.

Service Reference:

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 ARN of the 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:

      • Tags — (map<String>)

        The tags of the MWAA environments.

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:

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.

        • Namerequired — (String)

          Internal only API.

        • Valuerequired — (String)

          Internal only API.

      • MetricNamerequired — (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.

      • Timestamprequired — (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

Add tag to the MWAA environments.

Service Reference:

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 tag resource ARN of the MWAA environments.

    • Tags — (map<String>)

      The tag resource tag of the MWAA environments.

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

Remove a tag from the MWAA environments.

Service Reference:

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 tag resource ARN of the MWAA environments.

    • tagKeys — (Array<String>)

      The tag resource key of the MWAA environments.

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

Update an MWAA environment.

Service Reference:

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',
  NetworkConfiguration: {
    SecurityGroupIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  PluginsS3ObjectVersion: 'STRING_VALUE',
  PluginsS3Path: 'STRING_VALUE',
  RequirementsS3ObjectVersion: 'STRING_VALUE',
  RequirementsS3Path: 'STRING_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>)

      The Airflow Configuration Options to update of your Amazon MWAA environment.

    • AirflowVersion — (String)

      The Airflow Version to update of your Amazon MWAA environment.

    • DagS3Path — (String)

      The Dags folder S3 Path to update of your Amazon MWAA environment.

    • EnvironmentClass — (String)

      The Environment Class to update of your Amazon MWAA environment.

    • ExecutionRoleArn — (String)

      The Executio Role ARN to update of your Amazon MWAA environment.

    • LoggingConfiguration — (map)

      The Logging Configuration to update of your Amazon MWAA environment.

      • DagProcessingLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • SchedulerLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • TaskLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • WebserverLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
      • WorkerLogs — (map)

        A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.

        • Enabledrequired — (Boolean)

          Defines that the logging module is enabled.

        • LogLevelrequired — (String)

          Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.

          Possible values include:
          • "CRITICAL"
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
    • MaxWorkers — (Integer)

      The Maximum Workers to update of your Amazon MWAA environment.

    • Name — (String)

      The name of your Amazon MWAA environment that you wish to update.

    • NetworkConfiguration — (map)

      The Network Configuration to update of your Amazon MWAA environment.

      • SecurityGroupIdsrequired — (Array<String>)

        Provide a JSON list of 1 or more security groups IDs by name, in the same VPC as the subnets.

    • PluginsS3ObjectVersion — (String)

      The Plugins.zip S3 Object Version to update of your Amazon MWAA environment.

    • PluginsS3Path — (String)

      The Plugins.zip S3 Path to update of your Amazon MWAA environment.

    • RequirementsS3ObjectVersion — (String)

      The Requirements.txt S3 ObjectV ersion to update of your Amazon MWAA environment.

    • RequirementsS3Path — (String)

      The Requirements.txt S3 Path to update of your Amazon MWAA environment.

    • SourceBucketArn — (String)

      The S3 Source Bucket ARN to update of your Amazon MWAA environment.

    • WebserverAccessMode — (String)

      The Webserver Access Mode to update of your Amazon MWAA environment.

      Possible values include:
      • "PRIVATE_ONLY"
      • "PUBLIC_ONLY"
    • WeeklyMaintenanceWindowStart — (String)

      The Weekly Maintenance Window Start to update of your Amazon 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:

      • Arn — (String)

        The ARN to update of your Amazon MWAA environment.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.