# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:mwaa) module Aws::MWAA # 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](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :mwaa set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::RestJson) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # 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. # # @option options [required, String] :region # 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` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (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. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [String] :endpoint # 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. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (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. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (: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 # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (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. # # @option options [String] :retry_mode ("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. # # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :stub_responses (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. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # 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`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Float] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (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. # # @option options [Float] :http_continue_timeout (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. # # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout # in seconds. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle 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. # # @option options [String] :ssl_ca_directory 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. # def initialize(*args) super end # @!group API Operations # Creates a CLI token for the Airflow CLI. To learn more, see [Creating # an Apache Airflow CLI token][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-cli.html # # @option params [required, String] :name # The name of the Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @return [Types::CreateCliTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateCliTokenResponse#cli_token #cli_token} => String # * {Types::CreateCliTokenResponse#web_server_hostname #web_server_hostname} => String # # @example Request syntax with placeholder values # # resp = client.create_cli_token({ # name: "EnvironmentName", # required # }) # # @example Response structure # # resp.cli_token #=> String # resp.web_server_hostname #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateCliToken AWS API Documentation # # @overload create_cli_token(params = {}) # @param [Hash] params ({}) def create_cli_token(params = {}, options = {}) req = build_request(:create_cli_token, params) req.send_request(options) end # Creates an Amazon Managed Workflows for Apache Airflow (MWAA) # environment. # # @option params [Hash] :airflow_configuration_options # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html # # @option params [String] :airflow_version # 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`. To learn more, see [Apache Airflow versions on Amazon Managed # Workflows for Apache Airflow (MWAA)][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html # # @option params [required, String] :dag_s3_path # The relative path to the DAGs folder on your Amazon S3 bucket. For # example, `dags`. To learn more, see [Adding or updating DAGs][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html # # @option params [String] :environment_class # The environment class type. Valid values: `mw1.small`, `mw1.medium`, # `mw1.large`. To learn more, see [Amazon MWAA environment class][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html # # @option params [required, String] :execution_role_arn # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html # # @option params [String] :kms_key # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html # # @option params [Types::LoggingConfigurationInput] :logging_configuration # Defines the Apache Airflow logs to send to CloudWatch Logs. # # @option params [Integer] :max_workers # 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`. # # @option params [Integer] :min_workers # 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`. # # @option params [required, String] :name # The name of the Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @option params [required, Types::NetworkConfiguration] :network_configuration # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html # # @option params [String] :plugins_s3_object_version # 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][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html # # @option params [String] :plugins_s3_path # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html # # @option params [String] :requirements_s3_object_version # 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][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html # # @option params [String] :requirements_s3_path # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html # # @option params [Integer] :schedulers # The number of Apache Airflow schedulers to run in your environment. # Valid values: # # * v2.0.2 - Accepts between 2 to 5. Defaults to 2. # # * v1.10.12 - Accepts 1. # # @option params [required, String] :source_bucket_arn # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html # # @option params [Hash] :tags # 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][1]. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html # # @option params [String] :webserver_access_mode # The Apache Airflow *Web server* access mode. To learn more, see # [Apache Airflow access modes][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html # # @option params [String] :weekly_maintenance_window_start # 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. # # @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateEnvironmentOutput#arn #arn} => String # # @example 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", # }) # # @example Response structure # # resp.arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateEnvironment AWS API Documentation # # @overload create_environment(params = {}) # @param [Hash] params ({}) def create_environment(params = {}, options = {}) req = build_request(:create_environment, params) req.send_request(options) end # Creates a web login token for the Airflow Web UI. To learn more, see # [Creating an Apache Airflow web login token][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html # # @option params [required, String] :name # The name of the Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @return [Types::CreateWebLoginTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateWebLoginTokenResponse#web_server_hostname #web_server_hostname} => String # * {Types::CreateWebLoginTokenResponse#web_token #web_token} => String # # @example Request syntax with placeholder values # # resp = client.create_web_login_token({ # name: "EnvironmentName", # required # }) # # @example Response structure # # resp.web_server_hostname #=> String # resp.web_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateWebLoginToken AWS API Documentation # # @overload create_web_login_token(params = {}) # @param [Hash] params ({}) def create_web_login_token(params = {}, options = {}) req = build_request(:create_web_login_token, params) req.send_request(options) end # Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) # environment. # # @option params [required, String] :name # The name of the Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_environment({ # name: "EnvironmentName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/DeleteEnvironment AWS API Documentation # # @overload delete_environment(params = {}) # @param [Hash] params ({}) def delete_environment(params = {}, options = {}) req = build_request(:delete_environment, params) req.send_request(options) end # Describes an Amazon Managed Workflows for Apache Airflow (MWAA) # environment. # # @option params [required, String] :name # The name of the Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @return [Types::GetEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetEnvironmentOutput#environment #environment} => Types::Environment # # @example Request syntax with placeholder values # # resp = client.get_environment({ # name: "EnvironmentName", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/GetEnvironment AWS API Documentation # # @overload get_environment(params = {}) # @param [Hash] params ({}) def get_environment(params = {}, options = {}) req = build_request(:get_environment, params) req.send_request(options) end # Lists the Amazon Managed Workflows for Apache Airflow (MWAA) # environments. # # @option params [Integer] :max_results # The maximum number of results to retrieve per page. For example, `5` # environments per page. # # @option params [String] :next_token # Retrieves the next page of the results. # # @return [Types::ListEnvironmentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListEnvironmentsOutput#environments #environments} => Array<String> # * {Types::ListEnvironmentsOutput#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_environments({ # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.environments #=> Array # resp.environments[0] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListEnvironments AWS API Documentation # # @overload list_environments(params = {}) # @param [Hash] params ({}) def list_environments(params = {}, options = {}) req = build_request(:list_environments, params) req.send_request(options) end # Lists the key-value tag pairs associated to the Amazon Managed # Workflows for Apache Airflow (MWAA) environment. For example, # `"Environment": "Staging"`. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the Amazon MWAA environment. For # example, # `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`. # # @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "EnvironmentArn", # required # }) # # @example Response structure # # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # **Internal only**. Publishes environment health metrics to Amazon # CloudWatch. # # @option params [required, String] :environment_name # **Internal only**. The name of the environment. # # @option params [required, Array] :metric_data # **Internal only**. Publishes metrics to Amazon CloudWatch. To learn # more about the metrics published to Amazon CloudWatch, see [Amazon # MWAA performance metrics in Amazon CloudWatch][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example 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, # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/PublishMetrics AWS API Documentation # # @overload publish_metrics(params = {}) # @param [Hash] params ({}) def publish_metrics(params = {}, options = {}) req = build_request(:publish_metrics, params) req.send_request(options) end # Associates key-value tag pairs to your Amazon Managed Workflows for # Apache Airflow (MWAA) environment. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the Amazon MWAA environment. For # example, # `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`. # # @option params [required, Hash] :tags # 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][1]. # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "EnvironmentArn", # required # tags: { # required # "TagKey" => "TagValue", # }, # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes key-value tag pairs associated to your Amazon Managed # Workflows for Apache Airflow (MWAA) environment. For example, # `"Environment": "Staging"`. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the Amazon MWAA environment. For # example, # `arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment`. # # @option params [required, Array] :tag_keys # The key-value tag pair you want to remove. For example, # `"Environment": "Staging"`. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "EnvironmentArn", # required # tag_keys: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates an Amazon Managed Workflows for Apache Airflow (MWAA) # environment. # # @option params [Hash] :airflow_configuration_options # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html # # @option params [String] :airflow_version # 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`. # # @option params [String] :dag_s3_path # The relative path to the DAGs folder on your Amazon S3 bucket. For # example, `dags`. To learn more, see [Adding or updating DAGs][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html # # @option params [String] :environment_class # The environment class type. Valid values: `mw1.small`, `mw1.medium`, # `mw1.large`. To learn more, see [Amazon MWAA environment class][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html # # @option params [String] :execution_role_arn # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html # # @option params [Types::LoggingConfigurationInput] :logging_configuration # The Apache Airflow log types to send to CloudWatch Logs. # # @option params [Integer] :max_workers # 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`. # # @option params [Integer] :min_workers # 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`. # # @option params [required, String] :name # The name of your Amazon MWAA environment. For example, # `MyMWAAEnvironment`. # # @option params [Types::UpdateNetworkConfigurationInput] :network_configuration # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html # # @option params [String] :plugins_s3_object_version # 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][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html # # @option params [String] :plugins_s3_path # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html # # @option params [String] :requirements_s3_object_version # 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][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html # # @option params [String] :requirements_s3_path # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html # # @option params [Integer] :schedulers # The number of Apache Airflow schedulers to run in your Amazon MWAA # environment. # # @option params [String] :source_bucket_arn # 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][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html # # @option params [String] :webserver_access_mode # The Apache Airflow *Web server* access mode. To learn more, see # [Apache Airflow access modes][1]. # # # # [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html # # @option params [String] :weekly_maintenance_window_start # 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. # # @return [Types::UpdateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateEnvironmentOutput#arn #arn} => String # # @example 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", # }) # # @example Response structure # # resp.arn #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateEnvironment AWS API Documentation # # @overload update_environment(params = {}) # @param [Hash] params ({}) def update_environment(params = {}, options = {}) req = build_request(:update_environment, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-mwaa' context[:gem_version] = '1.13.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end