This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What is Amazon MWAA?.
Endpoints
api.airflow.{region}.amazonaws.com - This endpoint is used for environment management.
env.airflow.{region}.amazonaws.com - This endpoint is used to operate the Airflow environment.
Regions
For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.
", "operations": { "CreateCliToken": "Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
", "CreateEnvironment": "Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "CreateWebLoginToken": "Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
", "DeleteEnvironment": "Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "GetEnvironment": "Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "ListEnvironments": "Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
", "ListTagsForResource": "Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".
Internal only. Publishes environment health metrics to Amazon CloudWatch.
", "TagResource": "Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "UntagResource": "Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, \"Environment\": \"Staging\".
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
" }, "shapes": { "AccessDeniedException": { "base": "Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.
", "refs": { } }, "AirflowConfigurationOptions": { "base": null, "refs": { "CreateEnvironmentInput$AirflowConfigurationOptions": "A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.
", "Environment$AirflowConfigurationOptions": "A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
", "UpdateEnvironmentInput$AirflowConfigurationOptions": "A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.
" } }, "AirflowIdentity": { "base": null, "refs": { "CreateWebLoginTokenResponse$AirflowIdentity": "The user name of the Apache Airflow identity creating the web login token.
" } }, "AirflowVersion": { "base": null, "refs": { "CreateEnvironmentInput$AirflowVersion": "The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2
The Apache Airflow version on your environment.
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2.
The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.
Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment.
Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2.
The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
" } }, "CloudWatchLogGroupArn": { "base": null, "refs": { "ModuleLoggingConfiguration$CloudWatchLogGroupArn": "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:*.
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.
", "refs": { } }, "CreateEnvironmentOutput": { "base": null, "refs": { } }, "CreateWebLoginTokenRequest": { "base": null, "refs": { } }, "CreateWebLoginTokenResponse": { "base": null, "refs": { } }, "CreatedAt": { "base": null, "refs": { "Environment$CreatedAt": "The day and time the environment was created.
" } }, "DeleteEnvironmentInput": { "base": null, "refs": { } }, "DeleteEnvironmentOutput": { "base": null, "refs": { } }, "Dimension": { "base": "Internal only. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
", "refs": { "Dimensions$member": null } }, "Dimensions": { "base": null, "refs": { "MetricDatum$Dimensions": "Internal only. The dimensions associated with the metric.
" } }, "Double": { "base": null, "refs": { "MetricDatum$Value": "Internal only. The value for the metric.
", "StatisticSet$Maximum": "Internal only. The maximum value of the sample set.
", "StatisticSet$Minimum": "Internal only. The minimum value of the sample set.
", "StatisticSet$Sum": "Internal only. The sum of values for the sample set.
" } }, "EndpointManagement": { "base": null, "refs": { "CreateEnvironmentInput$EndpointManagement": "Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "refs": { "GetEnvironmentOutput$Environment": "An object containing all available details about the environment.
" } }, "EnvironmentArn": { "base": null, "refs": { "CreateEnvironmentOutput$Arn": "The Amazon Resource Name (ARN) returned in the response for the environment.
", "Environment$Arn": "The Amazon Resource Name (ARN) of the Amazon MWAA environment.
", "ListTagsForResourceInput$ResourceArn": "The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For more information, see Amazon MWAA environment class.
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For more information, see Amazon MWAA environment class.
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For more information, see Amazon MWAA environment class.
Returns a list of Amazon MWAA environments.
" } }, "EnvironmentName": { "base": null, "refs": { "CreateCliTokenRequest$Name": "The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Internal only. The name of the environment.
", "UpdateEnvironmentInput$Name": "The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
The status of the Amazon MWAA environment.
Valid values:
CREATING - Indicates the request to create the environment is in progress.
CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
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.
PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.
UPDATING - Indicates the request to update the environment is in progress.
ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
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 did not return to its previous state and is not stable.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.
MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
" } }, "ErrorCode": { "base": null, "refs": { "UpdateError$ErrorCode": "The error code that corresponds to the error with the last update.
" } }, "ErrorMessage": { "base": null, "refs": { "UpdateError$ErrorMessage": "The error message that corresponds to the error code.
" } }, "GetEnvironmentInput": { "base": null, "refs": { } }, "GetEnvironmentOutput": { "base": null, "refs": { } }, "Hostname": { "base": null, "refs": { "CreateCliTokenResponse$WebServerHostname": "The Airflow web server hostname for the environment.
", "CreateWebLoginTokenResponse$WebServerHostname": "The Airflow web server hostname for the environment.
" } }, "IamIdentity": { "base": null, "refs": { "CreateWebLoginTokenResponse$IamIdentity": "The name of the IAM identity creating the web login token. This might be an IAM user, or an assumed or federated identity. For example, assumed-role/Admin/your-name.
The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
", "UpdateEnvironmentInput$ExecutionRoleArn": "The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
Internal only. The number of samples used for the statistic set.
" } }, "InternalServerException": { "base": "InternalServerException: An internal error has occurred.
", "refs": { } }, "KmsKey": { "base": null, "refs": { "CreateEnvironmentInput$KmsKey": "The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.
", "Environment$KmsKey": "The KMS encryption key used to encrypt the data in your environment.
" } }, "LastUpdate": { "base": "Describes the status of the last update on the environment, and any errors that were encountered.
", "refs": { "Environment$LastUpdate": "The status of the last update on the environment.
" } }, "ListEnvironmentsInput": { "base": null, "refs": { } }, "ListEnvironmentsInputMaxResultsInteger": { "base": null, "refs": { "ListEnvironmentsInput$MaxResults": "The maximum number of results to retrieve per page. For example, 5 environments per page.
Describes the Apache Airflow log types that are published to CloudWatch Logs.
", "refs": { "Environment$LoggingConfiguration": "The Apache Airflow logs published to CloudWatch Logs.
" } }, "LoggingConfigurationInput": { "base": "Defines the Apache Airflow log types to send to CloudWatch Logs.
", "refs": { "CreateEnvironmentInput$LoggingConfiguration": "Defines the Apache Airflow logs to send to CloudWatch Logs.
", "UpdateEnvironmentInput$LoggingConfiguration": "The Apache Airflow log types to send to CloudWatch Logs.
" } }, "LoggingEnabled": { "base": null, "refs": { "ModuleLoggingConfiguration$Enabled": "Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
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.
The maximum number of workers that run in your environment. For example, 20.
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.
Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
" } }, "MetricDatum": { "base": "Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
", "refs": { "MetricData$member": null } }, "MinWorkers": { "base": null, "refs": { "CreateEnvironmentInput$MinWorkers": "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.
The minimum number of workers that run in your environment. For example, 2.
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.
Describes the Apache Airflow log details for the log type (e.g. DagProcessingLogs).
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
", "LoggingConfiguration$SchedulerLogs": "The Airflow scheduler logs published to CloudWatch Logs and the log level.
", "LoggingConfiguration$TaskLogs": "The Airflow task logs published to CloudWatch Logs and the log level.
", "LoggingConfiguration$WebserverLogs": "The Airflow web server logs published to CloudWatch Logs and the log level.
", "LoggingConfiguration$WorkerLogs": "The Airflow worker logs published to CloudWatch Logs and the log level.
" } }, "ModuleLoggingConfigurationInput": { "base": "Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log level to send to CloudWatch Logs (e.g. INFO).
Publishes Airflow DAG processing logs to CloudWatch Logs.
", "LoggingConfigurationInput$SchedulerLogs": "Publishes Airflow scheduler logs to CloudWatch Logs.
", "LoggingConfigurationInput$TaskLogs": "Publishes Airflow task logs to CloudWatch Logs.
", "LoggingConfigurationInput$WebserverLogs": "Publishes Airflow web server logs to CloudWatch Logs.
", "LoggingConfigurationInput$WorkerLogs": "Publishes Airflow worker logs to CloudWatch Logs.
" } }, "NetworkConfiguration": { "base": "Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
", "refs": { "CreateEnvironmentInput$NetworkConfiguration": "The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
", "Environment$NetworkConfiguration": "Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
" } }, "NextToken": { "base": null, "refs": { "ListEnvironmentsInput$NextToken": "Retrieves the next page of the results.
", "ListEnvironmentsOutput$NextToken": "Retrieves the next page of the results.
" } }, "PublishMetricsInput": { "base": null, "refs": { } }, "PublishMetricsOutput": { "base": null, "refs": { } }, "RelativePath": { "base": null, "refs": { "CreateEnvironmentInput$DagS3Path": "The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.
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. For more information, see Installing custom plugins.
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. For more information, see Installing Python dependencies.
The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
", "Environment$DagS3Path": "The relative path to the DAGs folder in your Amazon S3 bucket. For example, s3://mwaa-environment/dags. For more information, see Adding or updating DAGs.
The relative path to the file in your Amazon S3 bucket. For example, s3://mwaa-environment/plugins.zip. For more information, see Installing custom plugins.
The relative path to the requirements.txt file in your Amazon S3 bucket. For example, s3://mwaa-environment/requirements.txt. For more information, see Installing Python dependencies.
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.
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. For more information, see Installing custom plugins.
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. For more information, see Installing Python dependencies.
The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
" } }, "ResourceNotFoundException": { "base": "ResourceNotFoundException: The resource is not available.
", "refs": { } }, "S3BucketArn": { "base": null, "refs": { "CreateEnvironmentInput$SourceBucketArn": "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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
", "CreateEnvironmentInput$RequirementsS3ObjectVersion": "The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
", "Environment$PluginsS3ObjectVersion": "The version of the plugins.zip file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Installing custom plugins.
", "Environment$RequirementsS3ObjectVersion": "The version of the requirements.txt file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Installing Python dependencies.
", "UpdateEnvironmentInput$PluginsS3ObjectVersion": "The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
" } }, "Schedulers": { "base": null, "refs": { "CreateEnvironmentInput$Schedulers": "The number of Apache Airflow schedulers to run in your environment. Valid values:
v2 - Accepts between 2 to 5. Defaults to 2.
v1 - Accepts 1.
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
", "UpdateEnvironmentInput$Schedulers": "The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
" } }, "SecurityGroupId": { "base": null, "refs": { "SecurityGroupList$member": null } }, "SecurityGroupList": { "base": null, "refs": { "NetworkConfiguration$SecurityGroupIds": "A list of security group IDs. For more information, see Security in your VPC on Amazon MWAA.
", "UpdateNetworkConfigurationInput$SecurityGroupIds": "A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information, see Security in your VPC on Amazon MWAA.
" } }, "StatisticSet": { "base": "Internal only. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
", "refs": { "MetricDatum$StatisticValues": "Internal only. The statistical values for the metric.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$Message": null, "Dimension$Name": "Internal only. The name of the dimension.
", "Dimension$Value": "Internal only. The value of the dimension.
", "Environment$StartupScriptS3ObjectVersion": "The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, see Using a startup script.
", "Environment$StartupScriptS3Path": "The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
", "InternalServerException$message": null, "MetricDatum$MetricName": "Internal only. The name of the metric.
", "ResourceNotFoundException$message": null, "ValidationException$message": null } }, "SubnetId": { "base": null, "refs": { "SubnetList$member": null } }, "SubnetList": { "base": null, "refs": { "NetworkConfiguration$SubnetIds": "A list of subnet IDs. For more information, see About networking on Amazon MWAA.
" } }, "TagKey": { "base": null, "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceInput$tagKeys": "The key-value tag pair you want to remove. For example, \"Environment\": \"Staging\".
The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". For more information, see Tagging Amazon Web Services resources.
The key-value tag pairs associated to your environment. For example, \"Environment\": \"Staging\". For more information, see Tagging Amazon Web Services resources.
The key-value tag pairs associated to your environment. For more information, see Tagging Amazon Web Services resources.
", "TagResourceInput$Tags": "The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". For more information, see Tagging Amazon Web Services resources.
Internal only. The time the metric data was received.
" } }, "Token": { "base": null, "refs": { "CreateCliTokenResponse$CliToken": "An Airflow CLI login token.
", "CreateWebLoginTokenResponse$WebToken": "An Airflow web server login token.
" } }, "Unit": { "base": null, "refs": { "MetricDatum$Unit": "Internal only. The unit used to store the metric.
" } }, "UntagResourceInput": { "base": null, "refs": { } }, "UntagResourceOutput": { "base": null, "refs": { } }, "UpdateCreatedAt": { "base": null, "refs": { "LastUpdate$CreatedAt": "The day and time of the last update on the environment.
" } }, "UpdateEnvironmentInput": { "base": null, "refs": { } }, "UpdateEnvironmentOutput": { "base": null, "refs": { } }, "UpdateError": { "base": "Describes the error(s) encountered with the last update of the environment.
", "refs": { "LastUpdate$Error": "The error that was encountered during the last update of the environment.
" } }, "UpdateNetworkConfigurationInput": { "base": "Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
", "refs": { "UpdateEnvironmentInput$NetworkConfiguration": "The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
" } }, "UpdateSource": { "base": null, "refs": { "LastUpdate$Source": "The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
" } }, "UpdateStatus": { "base": null, "refs": { "LastUpdate$Status": "The status of the last update on the environment.
" } }, "ValidationException": { "base": "ValidationException: The provided input is not valid.
", "refs": { } }, "VpcEndpointServiceName": { "base": null, "refs": { "Environment$DatabaseVpcEndpointService": "The VPC endpoint for the environment's Amazon RDS database.
", "Environment$WebserverVpcEndpointService": "The VPC endpoint for the environment's web server.
" } }, "WebserverAccessMode": { "base": null, "refs": { "CreateEnvironmentInput$WebserverAccessMode": "Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
", "Environment$WebserverAccessMode": "The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
", "UpdateEnvironmentInput$WebserverAccessMode": "The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
" } }, "WebserverUrl": { "base": null, "refs": { "Environment$WebserverUrl": "The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
" } }, "WeeklyMaintenanceWindowStart": { "base": null, "refs": { "CreateEnvironmentInput$WeeklyMaintenanceWindowStart": "The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time 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.