AmazonMWAA

{'Environment': {'Status': {'UPDATE_FAILED', 'UNAVAILABLE'}}}

Get details of an existing environment.

See also: AWS API Documentation

Request Syntax

client.get_environment(
    Name='string'
)

type Name:

string

param Name:

[REQUIRED]

The name of the environment to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Environment': {
        'AirflowConfigurationOptions': {
            'string': 'string'
        },
        'AirflowVersion': 'string',
        'Arn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'DagS3Path': 'string',
        'EnvironmentClass': 'string',
        'ExecutionRoleArn': 'string',
        'KmsKey': 'string',
        'LastUpdate': {
            'CreatedAt': datetime(2015, 1, 1),
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            },
            'Status': 'SUCCESS'|'PENDING'|'FAILED'
        },
        'LoggingConfiguration': {
            'DagProcessingLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'SchedulerLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'TaskLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'WebserverLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'WorkerLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            }
        },
        'MaxWorkers': 123,
        'MinWorkers': 123,
        'Name': 'string',
        'NetworkConfiguration': {
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ]
        },
        'PluginsS3ObjectVersion': 'string',
        'PluginsS3Path': 'string',
        'RequirementsS3ObjectVersion': 'string',
        'RequirementsS3Path': 'string',
        'ServiceRoleArn': 'string',
        'SourceBucketArn': 'string',
        'Status': 'CREATING'|'CREATE_FAILED'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED'|'UNAVAILABLE'|'UPDATE_FAILED',
        'Tags': {
            'string': 'string'
        },
        'WebserverAccessMode': 'PRIVATE_ONLY'|'PUBLIC_ONLY',
        'WebserverUrl': 'string',
        'WeeklyMaintenanceWindowStart': 'string'
    }
}

Response Structure

• (dict) --

  • Environment (dict) --

    A JSON blob with environment details.

    • AirflowConfigurationOptions (dict) --

      The Airflow Configuration Options of the Amazon MWAA Environment.

      • (string) --

        • (string) --

    • AirflowVersion (string) --

      The AirflowV ersion of the Amazon MWAA Environment.

    • Arn (string) --

      The ARN of the Amazon MWAA Environment.

    • CreatedAt (datetime) --

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

      Last update information for the environment.

      • CreatedAt (datetime) --

        Time that last update occurred.

      • Error (dict) --

        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.

    • LoggingConfiguration (dict) --

      The Logging Configuration of the Amazon MWAA Environment.

      • DagProcessingLogs (dict) --

        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.

      • SchedulerLogs (dict) --

        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.

      • TaskLogs (dict) --

        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.

      • WebserverLogs (dict) --

        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.

      • WorkerLogs (dict) --

        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.

    • MaxWorkers (integer) --

      The maximum number of workers to run in your Amazon MWAA Environment.

    • MinWorkers (integer) --

      The minimum number of workers to run in your Amazon MWAA Environment.

    • Name (string) --

      The name of the Amazon MWAA Environment.

    • NetworkConfiguration (dict) --

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

      • SecurityGroupIds (list) --

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

        • (string) --

      • SubnetIds (list) --

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

        • (string) --

    • 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.

    • Tags (dict) --

      The Tags of the Amazon MWAA Environment.

      • (string) --

        • (string) --

    • WebserverAccessMode (string) --

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

    • WebserverUrl (string) --

      The Webserver URL of the Amazon MWAA Environment.

    • WeeklyMaintenanceWindowStart (string) --

      The Weekly Maintenance Window Start of the Amazon MWAA Environment.