Skip to content

Get Environment

mwaa_get_environment R Documentation

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

Description

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

Usage

mwaa_get_environment(Name)

Arguments

Name

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

Value

A list with the following syntax:

list(
  Environment = list(
    Name = "string",
    Status = "CREATING"|"CREATE_FAILED"|"AVAILABLE"|"UPDATING"|"DELETING"|"DELETED"|"UNAVAILABLE"|"UPDATE_FAILED"|"ROLLING_BACK"|"CREATING_SNAPSHOT"|"PENDING"|"MAINTENANCE",
    Arn = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    WebserverUrl = "string",
    ExecutionRoleArn = "string",
    ServiceRoleArn = "string",
    KmsKey = "string",
    AirflowVersion = "string",
    SourceBucketArn = "string",
    DagS3Path = "string",
    PluginsS3Path = "string",
    PluginsS3ObjectVersion = "string",
    RequirementsS3Path = "string",
    RequirementsS3ObjectVersion = "string",
    StartupScriptS3Path = "string",
    StartupScriptS3ObjectVersion = "string",
    AirflowConfigurationOptions = list(
      "string"
    ),
    EnvironmentClass = "string",
    MaxWorkers = 123,
    NetworkConfiguration = list(
      SubnetIds = list(
        "string"
      ),
      SecurityGroupIds = list(
        "string"
      )
    ),
    LoggingConfiguration = list(
      DagProcessingLogs = list(
        Enabled = TRUE|FALSE,
        LogLevel = "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG",
        CloudWatchLogGroupArn = "string"
      ),
      SchedulerLogs = list(
        Enabled = TRUE|FALSE,
        LogLevel = "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG",
        CloudWatchLogGroupArn = "string"
      ),
      WebserverLogs = list(
        Enabled = TRUE|FALSE,
        LogLevel = "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG",
        CloudWatchLogGroupArn = "string"
      ),
      WorkerLogs = list(
        Enabled = TRUE|FALSE,
        LogLevel = "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG",
        CloudWatchLogGroupArn = "string"
      ),
      TaskLogs = list(
        Enabled = TRUE|FALSE,
        LogLevel = "CRITICAL"|"ERROR"|"WARNING"|"INFO"|"DEBUG",
        CloudWatchLogGroupArn = "string"
      )
    ),
    LastUpdate = list(
      Status = "SUCCESS"|"PENDING"|"FAILED",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      Error = list(
        ErrorCode = "string",
        ErrorMessage = "string"
      ),
      Source = "string"
    ),
    WeeklyMaintenanceWindowStart = "string",
    Tags = list(
      "string"
    ),
    WebserverAccessMode = "PRIVATE_ONLY"|"PUBLIC_ONLY",
    MinWorkers = 123,
    Schedulers = 123,
    WebserverVpcEndpointService = "string",
    DatabaseVpcEndpointService = "string",
    CeleryExecutorQueue = "string",
    EndpointManagement = "CUSTOMER"|"SERVICE",
    MinWebservers = 123,
    MaxWebservers = 123
  )
)

Request syntax

svc$get_environment(
  Name = "string"
)