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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.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::InstanceProfileCredentials 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)
  • :account_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.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :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_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.

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



444
445
446
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 444

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:



481
482
483
484
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 481

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 (Amazon MWAA) environment.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  name: "EnvironmentName", # required
  execution_role_arn: "IamRoleArn", # required
  source_bucket_arn: "S3BucketArn", # required
  dag_s3_path: "RelativePath", # required
  network_configuration: { # required
    subnet_ids: ["SubnetId"],
    security_group_ids: ["SecurityGroupId"],
  },
  plugins_s3_path: "RelativePath",
  plugins_s3_object_version: "S3ObjectVersion",
  requirements_s3_path: "RelativePath",
  requirements_s3_object_version: "S3ObjectVersion",
  startup_script_s3_path: "RelativePath",
  startup_script_s3_object_version: "S3ObjectVersion",
  airflow_configuration_options: {
    "ConfigKey" => "ConfigValue",
  },
  environment_class: "EnvironmentClass",
  max_workers: 1,
  kms_key: "KmsKey",
  airflow_version: "AirflowVersion",
  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
    },
    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
    },
    task_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
  },
  weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
  tags: {
    "TagKey" => "TagValue",
  },
  webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
  min_workers: 1,
  schedulers: 1,
  endpoint_management: "CUSTOMER", # accepts CUSTOMER, SERVICE
  min_webservers: 1,
  max_webservers: 1,
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :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. For more information, see Amazon MWAA Execution role.

  • :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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.

  • :dag_s3_path (required, String) —

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

  • :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. For more information, see About networking on Amazon MWAA.

  • :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. For more information, see Installing custom plugins.

  • :plugins_s3_object_version (String) —

    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.

  • :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 version is required. For more information, see Installing Python dependencies.

  • :requirements_s3_object_version (String) —

    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.

  • :startup_script_s3_path (String) —

    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.

  • :startup_script_s3_object_version (String) —

    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.

  • :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. For more information, see Apache Airflow configuration options.

  • :environment_class (String) —

    The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.

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

  • :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). For more information, see Create an Amazon MWAA environment.

  • :airflow_version (String) —

    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 (Amazon MWAA).

    Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2, 2.8.1, 2.9.2, and 2.10.1.

  • :logging_configuration (Types::LoggingConfigurationInput) —

    Defines the Apache Airflow logs to send to CloudWatch Logs.

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

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

    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.

  • :webserver_access_mode (String) —

    Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.

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

  • :schedulers (Integer) —

    The number of Apache Airflow schedulers to run in your environment. Valid values:

    • v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

    • v1 - Accepts 1.

  • :endpoint_management (String) —

    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.

  • :min_webservers (Integer) —

    The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

    Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

  • :max_webservers (Integer) —

    The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

    Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

Returns:

See Also:



811
812
813
814
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 811

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_token #=> String
resp.web_server_hostname #=> String
resp.iam_identity #=> String
resp.airflow_identity #=> 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:



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

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 (Amazon 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:



875
876
877
878
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 875

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.name #=> String
resp.environment.status #=> String, one of "CREATING", "CREATE_FAILED", "AVAILABLE", "UPDATING", "DELETING", "DELETED", "UNAVAILABLE", "UPDATE_FAILED", "ROLLING_BACK", "CREATING_SNAPSHOT", "PENDING", "MAINTENANCE"
resp.environment.arn #=> String
resp.environment.created_at #=> Time
resp.environment.webserver_url #=> String
resp.environment.execution_role_arn #=> String
resp.environment.service_role_arn #=> String
resp.environment.kms_key #=> String
resp.environment.airflow_version #=> String
resp.environment.source_bucket_arn #=> String
resp.environment.dag_s3_path #=> String
resp.environment.plugins_s3_path #=> String
resp.environment.plugins_s3_object_version #=> String
resp.environment.requirements_s3_path #=> String
resp.environment.requirements_s3_object_version #=> String
resp.environment.startup_script_s3_path #=> String
resp.environment.startup_script_s3_object_version #=> String
resp.environment.airflow_configuration_options #=> Hash
resp.environment.airflow_configuration_options["ConfigKey"] #=> String
resp.environment.environment_class #=> String
resp.environment.max_workers #=> Integer
resp.environment.network_configuration.subnet_ids #=> Array
resp.environment.network_configuration.subnet_ids[0] #=> String
resp.environment.network_configuration.security_group_ids #=> Array
resp.environment.network_configuration.security_group_ids[0] #=> 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.dag_processing_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.scheduler_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.webserver_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.logging_configuration.worker_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.task_logs.cloud_watch_log_group_arn #=> String
resp.environment.last_update.status #=> String, one of "SUCCESS", "PENDING", "FAILED"
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.weekly_maintenance_window_start #=> String
resp.environment.tags #=> Hash
resp.environment.tags["TagKey"] #=> String
resp.environment.webserver_access_mode #=> String, one of "PRIVATE_ONLY", "PUBLIC_ONLY"
resp.environment.min_workers #=> Integer
resp.environment.schedulers #=> Integer
resp.environment.webserver_vpc_endpoint_service #=> String
resp.environment.database_vpc_endpoint_service #=> String
resp.environment.celery_executor_queue #=> String
resp.environment.endpoint_management #=> String, one of "CUSTOMER", "SERVICE"
resp.environment.min_webservers #=> Integer
resp.environment.max_webservers #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

Returns:

See Also:



961
962
963
964
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 961

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

#invoke_rest_api(params = {}) ⇒ Types::InvokeRestApiResponse

Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API

Examples:

Request syntax with placeholder values


resp = client.invoke_rest_api({
  name: "EnvironmentName", # required
  path: "RestApiPath", # required
  method: "GET", # required, accepts GET, PUT, POST, PATCH, DELETE
  query_parameters: {
  },
  body: {
  },
})

Response structure


resp.rest_api_status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :path (required, String) —

    The Apache Airflow REST API endpoint path to be called. For example, /dags/123456/clearTaskInstances. For more information, see Apache Airflow API

  • :method (required, String) —

    The HTTP method used for making Airflow REST API calls. For example, POST.

  • :query_parameters (Hash, Array, String, Numeric, Boolean) —

    Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

  • :body (Hash, Array, String, Numeric, Boolean) —

    The request body for the Apache Airflow REST API call, provided as a JSON object.

    Document type used to carry open content (Hash,Array,String,Numeric,Boolean). A document type value is serialized using the same format as its surroundings and requires no additional encoding or escaping.

Returns:

See Also:



1034
1035
1036
1037
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1034

def invoke_rest_api(params = {}, options = {})
  req = build_request(:invoke_rest_api, 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({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    Retrieves the next page of the results.

  • :max_results (Integer) —

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

Returns:

See Also:



1073
1074
1075
1076
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1073

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:



1106
1107
1108
1109
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1106

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
    {
      metric_name: "String", # required
      timestamp: Time.now, # required
      dimensions: [
        {
          name: "String", # required
          value: "String", # required
        },
      ],
      value: 1.0,
      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
      statistic_values: {
        sample_count: 1,
        sum: 1.0,
        minimum: 1.0,
        maximum: 1.0,
      },
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1158
1159
1160
1161
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1158

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". For more information, see Tagging Amazon Web Services resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1195
1196
1197
1198
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1195

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:



1226
1227
1228
1229
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1226

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({
  name: "EnvironmentName", # required
  execution_role_arn: "IamRoleArn",
  airflow_version: "AirflowVersion",
  source_bucket_arn: "S3BucketArn",
  dag_s3_path: "RelativePath",
  plugins_s3_path: "RelativePath",
  plugins_s3_object_version: "S3ObjectVersion",
  requirements_s3_path: "RelativePath",
  requirements_s3_object_version: "S3ObjectVersion",
  startup_script_s3_path: "RelativePath",
  startup_script_s3_object_version: "S3ObjectVersion",
  airflow_configuration_options: {
    "ConfigKey" => "ConfigValue",
  },
  environment_class: "EnvironmentClass",
  max_workers: 1,
  network_configuration: {
    security_group_ids: ["SecurityGroupId"], # required
  },
  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
    },
    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
    },
    task_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
  },
  weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
  webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
  min_workers: 1,
  schedulers: 1,
  min_webservers: 1,
  max_webservers: 1,
})

Response structure


resp.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :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. For more information, see Amazon MWAA Execution role.

  • :airflow_version (String) —

    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, 2.8.1, 2.9.2, and 2.10.1.

  • :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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.

  • :dag_s3_path (String) —

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

  • :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. For more information, see Installing custom plugins.

  • :plugins_s3_object_version (String) —

    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.

  • :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. For more information, see Installing Python dependencies.

  • :requirements_s3_object_version (String) —

    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.

  • :startup_script_s3_path (String) —

    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.

  • :startup_script_s3_object_version (String) —

    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.

  • :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. For more information, see Apache Airflow configuration options.

  • :environment_class (String) —

    The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.

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

  • :network_configuration (Types::UpdateNetworkConfigurationInput) —

    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.

  • :logging_configuration (Types::LoggingConfigurationInput) —

    The Apache Airflow log types to send to CloudWatch Logs.

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

  • :webserver_access_mode (String) —

    The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.

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

  • :schedulers (Integer) —

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

  • :min_webservers (Integer) —

    The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

    Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

  • :max_webservers (Integer) —

    The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.

    Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.

Returns:

See Also:



1515
1516
1517
1518
 
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/client.rb', line 1515

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