Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEnvironment

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

Request Syntax


GET /environments/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: [a-zA-Z][0-9a-zA-Z-_]*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Environment": { 
      "AirflowConfigurationOptions": { 
         "string" : "string" 
      },
      "AirflowVersion": "string",
      "Arn": "string",
      "CeleryExecutorQueue": "string",
      "CreatedAt": number,
      "DagS3Path": "string",
      "DatabaseVpcEndpointService": "string",
      "EndpointManagement": "string",
      "EnvironmentClass": "string",
      "ExecutionRoleArn": "string",
      "KmsKey": "string",
      "LastUpdate": { 
         "CreatedAt": number,
         "Error": { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         },
         "Source": "string",
         "Status": "string"
      },
      "LoggingConfiguration": { 
         "DagProcessingLogs": { 
            "CloudWatchLogGroupArn": "string",
            "Enabled": boolean,
            "LogLevel": "string"
         },
         "SchedulerLogs": { 
            "CloudWatchLogGroupArn": "string",
            "Enabled": boolean,
            "LogLevel": "string"
         },
         "TaskLogs": { 
            "CloudWatchLogGroupArn": "string",
            "Enabled": boolean,
            "LogLevel": "string"
         },
         "WebserverLogs": { 
            "CloudWatchLogGroupArn": "string",
            "Enabled": boolean,
            "LogLevel": "string"
         },
         "WorkerLogs": { 
            "CloudWatchLogGroupArn": "string",
            "Enabled": boolean,
            "LogLevel": "string"
         }
      },
      "MaxWebservers": number,
      "MaxWorkers": number,
      "MinWebservers": number,
      "MinWorkers": number,
      "Name": "string",
      "NetworkConfiguration": { 
         "SecurityGroupIds": [ "string" ],
         "SubnetIds": [ "string" ]
      },
      "PluginsS3ObjectVersion": "string",
      "PluginsS3Path": "string",
      "RequirementsS3ObjectVersion": "string",
      "RequirementsS3Path": "string",
      "Schedulers": number,
      "ServiceRoleArn": "string",
      "SourceBucketArn": "string",
      "StartupScriptS3ObjectVersion": "string",
      "StartupScriptS3Path": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "WebserverAccessMode": "string",
      "WebserverUrl": "string",
      "WebserverVpcEndpointService": "string",
      "WeeklyMaintenanceWindowStart": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Environment

An object containing all available details about the environment.

Type: Environment object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

InternalServerException: An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

ResourceNotFoundException: The resource is not available.

HTTP Status Code: 404

ValidationException

ValidationException: The provided input is not valid.

HTTP Status Code: 400