Class: Aws::MWAA::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb

Overview

An API client for MWAA. To construct a client, you need to configure a :region and :credentials.

client = Aws::MWAA::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MWAA::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::MWAA::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



365
366
367
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#create_cli_token(params = {}) ⇒ Types::CreateCliTokenResponse

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Examples:

Request syntax with placeholder values


resp = client.create_cli_token({
  name: "EnvironmentName", # required
})

Response structure


resp.cli_token #=> String
resp.web_server_hostname #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

See Also:



402
403
404
405
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 402

def create_cli_token(params = {}, options = {})
  req = build_request(:create_cli_token, params)
  req.send_request(options)
end

#create_environment(params = {}) ⇒ Types::CreateEnvironmentOutput

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

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  airflow_configuration_options: {
    "ConfigKey" => "ConfigValue",
  },
  airflow_version: "AirflowVersion",
  dag_s3_path: "RelativePath", # required
  environment_class: "EnvironmentClass",
  execution_role_arn: "IamRoleArn", # required
  kms_key: "KmsKey",
  logging_configuration: {
    dag_processing_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    scheduler_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    task_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    webserver_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    worker_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
  },
  max_workers: 1,
  min_workers: 1,
  name: "EnvironmentName", # required
  network_configuration: { # required
    security_group_ids: ["SecurityGroupId"],
    subnet_ids: ["SubnetId"],
  },
  plugins_s3_object_version: "S3ObjectVersion",
  plugins_s3_path: "RelativePath",
  requirements_s3_object_version: "S3ObjectVersion",
  requirements_s3_path: "RelativePath",
  schedulers: 1,
  source_bucket_arn: "S3BucketArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
  weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :airflow_configuration_options (Hash<String,String>) —

    A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

  • :airflow_version (String) —

    The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

  • :dag_s3_path (required, String) —

    The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

  • :environment_class (String) —

    The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

  • :execution_role_arn (required, String) —

    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. To learn more, see Amazon MWAA Execution role.

  • :kms_key (String) —

    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). To learn more, see Create an Amazon MWAA environment.

  • :logging_configuration (Types::LoggingConfigurationInput) —

    Defines the Apache Airflow logs to send to CloudWatch Logs.

  • :max_workers (Integer) —

    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.

  • :min_workers (Integer) —

    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.

  • :name (required, String) —

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

  • :network_configuration (required, Types::NetworkConfiguration) —

    The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

  • :plugins_s3_object_version (String) —

    The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

  • :plugins_s3_path (String) —

    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. To learn more, see Installing custom plugins.

  • :requirements_s3_object_version (String) —

    The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

  • :requirements_s3_path (String) —

    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. To learn more, see Installing Python dependencies.

  • :schedulers (Integer) —

    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.

  • :source_bucket_arn (required, String) —

    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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

  • :tags (Hash<String,String>) —

    The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

  • :webserver_access_mode (String) —

    The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

  • :weekly_maintenance_window_start (String) —

    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.

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 643

def create_environment(params = {}, options = {})
  req = build_request(:create_environment, params)
  req.send_request(options)
end

#create_web_login_token(params = {}) ⇒ Types::CreateWebLoginTokenResponse

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Examples:

Request syntax with placeholder values


resp = client.({
  name: "EnvironmentName", # required
})

Response structure


resp.web_server_hostname #=> String
resp.web_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

See Also:



679
680
681
682
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 679

def (params = {}, options = {})
  req = build_request(:create_web_login_token, params)
  req.send_request(options)
end

#delete_environment(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  name: "EnvironmentName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



703
704
705
706
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 703

def delete_environment(params = {}, options = {})
  req = build_request(:delete_environment, params)
  req.send_request(options)
end

#get_environment(params = {}) ⇒ Types::GetEnvironmentOutput

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

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  name: "EnvironmentName", # required
})

Response structure


resp.environment.airflow_configuration_options #=> Hash
resp.environment.airflow_configuration_options["ConfigKey"] #=> String
resp.environment.airflow_version #=> String
resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.dag_s3_path #=> String
resp.environment.environment_class #=> String
resp.environment.execution_role_arn #=> String
resp.environment.kms_key #=> String
resp.environment.last_update.created_at #=> Time
resp.environment.last_update.error.error_code #=> String
resp.environment.last_update.error.error_message #=> String
resp.environment.last_update.source #=> String
resp.environment.last_update.status #=> String, one of "SUCCESS", "PENDING", "FAILED"
resp.environment.logging_configuration.dag_processing_logs.cloud_watch_log_group_arn #=> String
resp.environment.logging_configuration.dag_processing_logs.enabled #=> Boolean
resp.environment.logging_configuration.dag_processing_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
resp.environment.logging_configuration.scheduler_logs.cloud_watch_log_group_arn #=> String
resp.environment.logging_configuration.scheduler_logs.enabled #=> Boolean
resp.environment.logging_configuration.scheduler_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
resp.environment.logging_configuration.task_logs.cloud_watch_log_group_arn #=> String
resp.environment.logging_configuration.task_logs.enabled #=> Boolean
resp.environment.logging_configuration.task_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
resp.environment.logging_configuration.webserver_logs.cloud_watch_log_group_arn #=> String
resp.environment.logging_configuration.webserver_logs.enabled #=> Boolean
resp.environment.logging_configuration.webserver_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
resp.environment.logging_configuration.worker_logs.cloud_watch_log_group_arn #=> String
resp.environment.logging_configuration.worker_logs.enabled #=> Boolean
resp.environment.logging_configuration.worker_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
resp.environment.max_workers #=> Integer
resp.environment.min_workers #=> Integer
resp.environment.name #=> String
resp.environment.network_configuration.security_group_ids #=> Array
resp.environment.network_configuration.security_group_ids[0] #=> String
resp.environment.network_configuration.subnet_ids #=> Array
resp.environment.network_configuration.subnet_ids[0] #=> String
resp.environment.plugins_s3_object_version #=> String
resp.environment.plugins_s3_path #=> String
resp.environment.requirements_s3_object_version #=> String
resp.environment.requirements_s3_path #=> String
resp.environment.schedulers #=> Integer
resp.environment.service_role_arn #=> String
resp.environment.source_bucket_arn #=> String
resp.environment.status #=> String, one of "CREATING", "CREATE_FAILED", "AVAILABLE", "UPDATING", "DELETING", "DELETED", "UNAVAILABLE", "UPDATE_FAILED"
resp.environment.tags #=> Hash
resp.environment.tags["TagKey"] #=> String
resp.environment.webserver_access_mode #=> String, one of "PRIVATE_ONLY", "PUBLIC_ONLY"
resp.environment.webserver_url #=> String
resp.environment.weekly_maintenance_window_start #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

See Also:



781
782
783
784
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 781

def get_environment(params = {}, options = {})
  req = build_request(:get_environment, params)
  req.send_request(options)
end

#list_environments(params = {}) ⇒ Types::ListEnvironmentsOutput

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environments({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.environments #=> Array
resp.environments[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to retrieve per page. For example, 5 environments per page.

  • :next_token (String) —

    Retrieves the next page of the results.

Returns:

See Also:



820
821
822
823
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 820

def list_environments(params = {}, options = {})
  req = build_request(:list_environments, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "EnvironmentArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Returns:

See Also:



853
854
855
856
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 853

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#publish_metrics(params = {}) ⇒ Struct

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Examples:

Request syntax with placeholder values


resp = client.publish_metrics({
  environment_name: "EnvironmentName", # required
  metric_data: [ # required
    {
      dimensions: [
        {
          name: "String", # required
          value: "String", # required
        },
      ],
      metric_name: "String", # required
      statistic_values: {
        maximum: 1.0,
        minimum: 1.0,
        sample_count: 1,
        sum: 1.0,
      },
      timestamp: Time.now, # required
      unit: "Seconds", # accepts 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: 1.0,
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



905
906
907
908
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 905

def publish_metrics(params = {}, options = {})
  req = build_request(:publish_metrics, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "EnvironmentArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

  • :tags (required, Hash<String,String>) —

    The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging Amazon Web Services resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



942
943
944
945
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 942

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "EnvironmentArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

  • :tag_keys (required, Array<String>) —

    The key-value tag pair you want to remove. For example, "Environment": "Staging".

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 973

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentOutput

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

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  airflow_configuration_options: {
    "ConfigKey" => "ConfigValue",
  },
  airflow_version: "AirflowVersion",
  dag_s3_path: "RelativePath",
  environment_class: "EnvironmentClass",
  execution_role_arn: "IamRoleArn",
  logging_configuration: {
    dag_processing_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    scheduler_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    task_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    webserver_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    worker_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
  },
  max_workers: 1,
  min_workers: 1,
  name: "EnvironmentName", # required
  network_configuration: {
    security_group_ids: ["SecurityGroupId"], # required
  },
  plugins_s3_object_version: "S3ObjectVersion",
  plugins_s3_path: "RelativePath",
  requirements_s3_object_version: "S3ObjectVersion",
  requirements_s3_path: "RelativePath",
  schedulers: 1,
  source_bucket_arn: "S3BucketArn",
  webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
  weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :airflow_configuration_options (Hash<String,String>) —

    A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

  • :airflow_version (String) —

    The Apache Airflow version for your environment. If no value is specified, defaults to the latest version. Valid values: 1.10.12, 2.0.2, and 2.2.2.

  • :dag_s3_path (String) —

    The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

  • :environment_class (String) —

    The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

  • :execution_role_arn (String) —

    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. To learn more, see Amazon MWAA Execution role.

  • :logging_configuration (Types::LoggingConfigurationInput) —

    The Apache Airflow log types to send to CloudWatch Logs.

  • :max_workers (Integer) —

    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.

  • :min_workers (Integer) —

    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.

  • :name (required, String) —

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

  • :network_configuration (Types::UpdateNetworkConfigurationInput) —

    The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.

  • :plugins_s3_object_version (String) —

    The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.

  • :plugins_s3_path (String) —

    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. To learn more, see Installing custom plugins.

  • :requirements_s3_object_version (String) —

    The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.

  • :requirements_s3_path (String) —

    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. To learn more, see Installing Python dependencies.

  • :schedulers (Integer) —

    The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

  • :source_bucket_arn (String) —

    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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

  • :webserver_access_mode (String) —

    The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

  • :weekly_maintenance_window_start (String) —

    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.

Returns:

See Also:



1180
1181
1182
1183
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1180

def update_environment(params = {}, options = {})
  req = build_request(:update_environment, params)
  req.send_request(options)
end