aws-sdk-mwaa 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-mwaa.rb +53 -0
- data/lib/aws-sdk-mwaa/client.rb +1002 -0
- data/lib/aws-sdk-mwaa/client_api.rb +499 -0
- data/lib/aws-sdk-mwaa/customizations.rb +0 -0
- data/lib/aws-sdk-mwaa/errors.rb +102 -0
- data/lib/aws-sdk-mwaa/resource.rb +26 -0
- data/lib/aws-sdk-mwaa/types.rb +1303 -0
- metadata +88 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 108ed3431dc7f544b8a78547e1f872f52aa51f3a0c003437f174e4e0a06ab5a4
|
4
|
+
data.tar.gz: 4a67e4c909277f0d48cf77cf9bf75544b6c2b3044786810f85cb08c2c37a95bc
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b48f9afaa615f1b5caa38e2d523233312bc7b65dce2ca592185e01984b7aa34e6a1b1db49b6aaa04777ffad7ff952492b5268a86a6ff9a53e3c6c36b6b9dbfbd
|
7
|
+
data.tar.gz: b196d8d038df694201824e631cfa1e7ed2cc4f86a784785b423f3365c2e0d608b727152fb786c24696c2c5470ff168fd0a336d7f92fa6574b40a739ef357598a
|
data/lib/aws-sdk-mwaa.rb
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
|
11
|
+
require 'aws-sdk-core'
|
12
|
+
require 'aws-sigv4'
|
13
|
+
|
14
|
+
require_relative 'aws-sdk-mwaa/types'
|
15
|
+
require_relative 'aws-sdk-mwaa/client_api'
|
16
|
+
require_relative 'aws-sdk-mwaa/client'
|
17
|
+
require_relative 'aws-sdk-mwaa/errors'
|
18
|
+
require_relative 'aws-sdk-mwaa/resource'
|
19
|
+
require_relative 'aws-sdk-mwaa/customizations'
|
20
|
+
|
21
|
+
# This module provides support for AmazonMWAA. This module is available in the
|
22
|
+
# `aws-sdk-mwaa` gem.
|
23
|
+
#
|
24
|
+
# # Client
|
25
|
+
#
|
26
|
+
# The {Client} class provides one method for each API operation. Operation
|
27
|
+
# methods each accept a hash of request parameters and return a response
|
28
|
+
# structure.
|
29
|
+
#
|
30
|
+
# mwaa = Aws::MWAA::Client.new
|
31
|
+
# resp = mwaa.create_cli_token(params)
|
32
|
+
#
|
33
|
+
# See {Client} for more information.
|
34
|
+
#
|
35
|
+
# # Errors
|
36
|
+
#
|
37
|
+
# Errors returned from AmazonMWAA are defined in the
|
38
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
39
|
+
#
|
40
|
+
# begin
|
41
|
+
# # do stuff
|
42
|
+
# rescue Aws::MWAA::Errors::ServiceError
|
43
|
+
# # rescues all AmazonMWAA API errors
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# See {Errors} for more information.
|
47
|
+
#
|
48
|
+
# @!group service
|
49
|
+
module Aws::MWAA
|
50
|
+
|
51
|
+
GEM_VERSION = '1.0.0'
|
52
|
+
|
53
|
+
end
|
@@ -0,0 +1,1002 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
require 'seahorse/client/plugins/content_length.rb'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
12
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery.rb'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern.rb'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
25
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
26
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
|
+
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
|
+
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
|
+
|
33
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:mwaa)
|
34
|
+
|
35
|
+
module Aws::MWAA
|
36
|
+
# An API client for MWAA. To construct a client, you need to configure a `:region` and `:credentials`.
|
37
|
+
#
|
38
|
+
# client = Aws::MWAA::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
43
|
+
#
|
44
|
+
# For details on configuring region and credentials see
|
45
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
46
|
+
#
|
47
|
+
# See {#initialize} for a full list of supported configuration options.
|
48
|
+
class Client < Seahorse::Client::Base
|
49
|
+
|
50
|
+
include Aws::ClientStubs
|
51
|
+
|
52
|
+
@identifier = :mwaa
|
53
|
+
|
54
|
+
set_api(ClientApi::API)
|
55
|
+
|
56
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
57
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
58
|
+
add_plugin(Aws::Plugins::Logging)
|
59
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
60
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
61
|
+
add_plugin(Aws::Plugins::UserAgent)
|
62
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
63
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
64
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
65
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
66
|
+
add_plugin(Aws::Plugins::EndpointDiscovery)
|
67
|
+
add_plugin(Aws::Plugins::EndpointPattern)
|
68
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
69
|
+
add_plugin(Aws::Plugins::StubResponses)
|
70
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
71
|
+
add_plugin(Aws::Plugins::JsonvalueConverter)
|
72
|
+
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
73
|
+
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
|
+
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
77
|
+
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
|
+
|
79
|
+
# @overload initialize(options)
|
80
|
+
# @param [Hash] options
|
81
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
82
|
+
# Your AWS credentials. This can be an instance of any one of the
|
83
|
+
# following classes:
|
84
|
+
#
|
85
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
|
+
# credentials.
|
87
|
+
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
102
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
103
|
+
# from an EC2 IMDS on an EC2 instance.
|
104
|
+
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
107
|
+
#
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
110
|
+
#
|
111
|
+
# When `:credentials` are not configured directly, the following
|
112
|
+
# locations will be searched for credentials:
|
113
|
+
#
|
114
|
+
# * `Aws.config[:credentials]`
|
115
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
116
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
117
|
+
# * `~/.aws/credentials`
|
118
|
+
# * `~/.aws/config`
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
123
|
+
#
|
124
|
+
# @option options [required, String] :region
|
125
|
+
# The AWS region to connect to. The configured `:region` is
|
126
|
+
# used to determine the service `:endpoint`. When not passed,
|
127
|
+
# a default `:region` is searched for in the following locations:
|
128
|
+
#
|
129
|
+
# * `Aws.config[:region]`
|
130
|
+
# * `ENV['AWS_REGION']`
|
131
|
+
# * `ENV['AMAZON_REGION']`
|
132
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
133
|
+
# * `~/.aws/credentials`
|
134
|
+
# * `~/.aws/config`
|
135
|
+
#
|
136
|
+
# @option options [String] :access_key_id
|
137
|
+
#
|
138
|
+
# @option options [Boolean] :active_endpoint_cache (false)
|
139
|
+
# When set to `true`, a thread polling for endpoints will be running in
|
140
|
+
# the background every 60 secs (default). Defaults to `false`.
|
141
|
+
#
|
142
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
143
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
144
|
+
# until there is sufficent client side capacity to retry the request.
|
145
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
146
|
+
# not retry instead of sleeping.
|
147
|
+
#
|
148
|
+
# @option options [Boolean] :client_side_monitoring (false)
|
149
|
+
# When `true`, client-side metrics will be collected for all API requests from
|
150
|
+
# this client.
|
151
|
+
#
|
152
|
+
# @option options [String] :client_side_monitoring_client_id ("")
|
153
|
+
# Allows you to provide an identifier for this client which will be attached to
|
154
|
+
# all generated client side metrics. Defaults to an empty string.
|
155
|
+
#
|
156
|
+
# @option options [String] :client_side_monitoring_host ("127.0.0.1")
|
157
|
+
# Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
|
158
|
+
# side monitoring agent is running on, where client metrics will be published via UDP.
|
159
|
+
#
|
160
|
+
# @option options [Integer] :client_side_monitoring_port (31000)
|
161
|
+
# Required for publishing client metrics. The port that the client side monitoring
|
162
|
+
# agent is running on, where client metrics will be published via UDP.
|
163
|
+
#
|
164
|
+
# @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
|
165
|
+
# Allows you to provide a custom client-side monitoring publisher class. By default,
|
166
|
+
# will use the Client Side Monitoring Agent Publisher.
|
167
|
+
#
|
168
|
+
# @option options [Boolean] :convert_params (true)
|
169
|
+
# When `true`, an attempt is made to coerce request parameters into
|
170
|
+
# the required types.
|
171
|
+
#
|
172
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
173
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
175
|
+
#
|
176
|
+
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
|
+
# Set to true to disable SDK automatically adding host prefix
|
178
|
+
# to default service endpoint when available.
|
179
|
+
#
|
180
|
+
# @option options [String] :endpoint
|
181
|
+
# The client endpoint is normally constructed from the `:region`
|
182
|
+
# option. You should only configure an `:endpoint` when connecting
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
184
|
+
#
|
185
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
186
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
187
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
188
|
+
#
|
189
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
190
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
191
|
+
#
|
192
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
193
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
194
|
+
# Use this option to config the time interval in seconds for making
|
195
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
196
|
+
#
|
197
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
198
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
199
|
+
#
|
200
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
201
|
+
# The log formatter.
|
202
|
+
#
|
203
|
+
# @option options [Symbol] :log_level (:info)
|
204
|
+
# The log level to send messages to the `:logger` at.
|
205
|
+
#
|
206
|
+
# @option options [Logger] :logger
|
207
|
+
# The Logger instance to send log messages to. If this option
|
208
|
+
# is not set, logging will be disabled.
|
209
|
+
#
|
210
|
+
# @option options [Integer] :max_attempts (3)
|
211
|
+
# An integer representing the maximum number attempts that will be made for
|
212
|
+
# a single request, including the initial attempt. For example,
|
213
|
+
# setting this value to 5 will result in a request being retried up to
|
214
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
215
|
+
#
|
216
|
+
# @option options [String] :profile ("default")
|
217
|
+
# Used when loading credentials from the shared credentials file
|
218
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
219
|
+
#
|
220
|
+
# @option options [Proc] :retry_backoff
|
221
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
222
|
+
# This option is only used in the `legacy` retry mode.
|
223
|
+
#
|
224
|
+
# @option options [Float] :retry_base_delay (0.3)
|
225
|
+
# The base delay in seconds used by the default backoff function. This option
|
226
|
+
# is only used in the `legacy` retry mode.
|
227
|
+
#
|
228
|
+
# @option options [Symbol] :retry_jitter (:none)
|
229
|
+
# A delay randomiser function used by the default backoff function.
|
230
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
231
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
232
|
+
# in the `legacy` retry mode.
|
233
|
+
#
|
234
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
235
|
+
#
|
236
|
+
# @option options [Integer] :retry_limit (3)
|
237
|
+
# The maximum number of times to retry failed requests. Only
|
238
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
239
|
+
# are retried. Generally, these are throttling errors, data
|
240
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
241
|
+
# endpoint discovery, and errors from expired credentials.
|
242
|
+
# This option is only used in the `legacy` retry mode.
|
243
|
+
#
|
244
|
+
# @option options [Integer] :retry_max_delay (0)
|
245
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
246
|
+
# used by the default backoff function. This option is only used in the
|
247
|
+
# `legacy` retry mode.
|
248
|
+
#
|
249
|
+
# @option options [String] :retry_mode ("legacy")
|
250
|
+
# Specifies which retry algorithm to use. Values are:
|
251
|
+
#
|
252
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
253
|
+
# no retry mode is provided.
|
254
|
+
#
|
255
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
256
|
+
# This includes support for retry quotas, which limit the number of
|
257
|
+
# unsuccessful retries a client can make.
|
258
|
+
#
|
259
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
260
|
+
# functionality of `standard` mode along with automatic client side
|
261
|
+
# throttling. This is a provisional mode that may change behavior
|
262
|
+
# in the future.
|
263
|
+
#
|
264
|
+
#
|
265
|
+
# @option options [String] :secret_access_key
|
266
|
+
#
|
267
|
+
# @option options [String] :session_token
|
268
|
+
#
|
269
|
+
# @option options [Boolean] :stub_responses (false)
|
270
|
+
# Causes the client to return stubbed responses. By default
|
271
|
+
# fake responses are generated and returned. You can specify
|
272
|
+
# the response data to return or errors to raise by calling
|
273
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
274
|
+
#
|
275
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
|
+
# requests are made, and retries are disabled.
|
277
|
+
#
|
278
|
+
# @option options [Boolean] :validate_params (true)
|
279
|
+
# When `true`, request parameters are validated before
|
280
|
+
# sending the request.
|
281
|
+
#
|
282
|
+
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
283
|
+
# requests through. Formatted like 'http://proxy.com:123'.
|
284
|
+
#
|
285
|
+
# @option options [Float] :http_open_timeout (15) The number of
|
286
|
+
# seconds to wait when opening a HTTP session before raising a
|
287
|
+
# `Timeout::Error`.
|
288
|
+
#
|
289
|
+
# @option options [Integer] :http_read_timeout (60) The default
|
290
|
+
# number of seconds to wait for response data. This value can
|
291
|
+
# safely be set per-request on the session.
|
292
|
+
#
|
293
|
+
# @option options [Float] :http_idle_timeout (5) The number of
|
294
|
+
# seconds a connection is allowed to sit idle before it is
|
295
|
+
# considered stale. Stale connections are closed and removed
|
296
|
+
# from the pool before making a request.
|
297
|
+
#
|
298
|
+
# @option options [Float] :http_continue_timeout (1) The number of
|
299
|
+
# seconds to wait for a 100-continue response before sending the
|
300
|
+
# request body. This option has no effect unless the request has
|
301
|
+
# "Expect" header set to "100-continue". Defaults to `nil` which
|
302
|
+
# disables this behaviour. This value can safely be set per
|
303
|
+
# request on the session.
|
304
|
+
#
|
305
|
+
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
306
|
+
# HTTP debug output will be sent to the `:logger`.
|
307
|
+
#
|
308
|
+
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
|
309
|
+
# SSL peer certificates are verified when establishing a
|
310
|
+
# connection.
|
311
|
+
#
|
312
|
+
# @option options [String] :ssl_ca_bundle Full path to the SSL
|
313
|
+
# certificate authority bundle file that should be used when
|
314
|
+
# verifying peer certificates. If you do not pass
|
315
|
+
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
316
|
+
# will be used if available.
|
317
|
+
#
|
318
|
+
# @option options [String] :ssl_ca_directory Full path of the
|
319
|
+
# directory that contains the unbundled SSL certificate
|
320
|
+
# authority files for verifying peer certificates. If you do
|
321
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
322
|
+
# system default will be used if available.
|
323
|
+
#
|
324
|
+
def initialize(*args)
|
325
|
+
super
|
326
|
+
end
|
327
|
+
|
328
|
+
# @!group API Operations
|
329
|
+
|
330
|
+
# Create a CLI token to use Airflow CLI.
|
331
|
+
#
|
332
|
+
# @option params [required, String] :name
|
333
|
+
# Create a CLI token request for a MWAA environment.
|
334
|
+
#
|
335
|
+
# @return [Types::CreateCliTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
336
|
+
#
|
337
|
+
# * {Types::CreateCliTokenResponse#cli_token #cli_token} => String
|
338
|
+
# * {Types::CreateCliTokenResponse#web_server_hostname #web_server_hostname} => String
|
339
|
+
#
|
340
|
+
# @example Request syntax with placeholder values
|
341
|
+
#
|
342
|
+
# resp = client.create_cli_token({
|
343
|
+
# name: "EnvironmentName", # required
|
344
|
+
# })
|
345
|
+
#
|
346
|
+
# @example Response structure
|
347
|
+
#
|
348
|
+
# resp.cli_token #=> String
|
349
|
+
# resp.web_server_hostname #=> String
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateCliToken AWS API Documentation
|
352
|
+
#
|
353
|
+
# @overload create_cli_token(params = {})
|
354
|
+
# @param [Hash] params ({})
|
355
|
+
def create_cli_token(params = {}, options = {})
|
356
|
+
req = build_request(:create_cli_token, params)
|
357
|
+
req.send_request(options)
|
358
|
+
end
|
359
|
+
|
360
|
+
# JSON blob that describes the environment to create.
|
361
|
+
#
|
362
|
+
# @option params [Hash<String,String>] :airflow_configuration_options
|
363
|
+
# The Apache Airflow configuration setting you want to override in your
|
364
|
+
# environment. For more information, see [Environment configuration][1].
|
365
|
+
#
|
366
|
+
#
|
367
|
+
#
|
368
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html
|
369
|
+
#
|
370
|
+
# @option params [String] :airflow_version
|
371
|
+
# The Apache Airflow version you want to use for your environment.
|
372
|
+
#
|
373
|
+
# @option params [required, String] :dag_s3_path
|
374
|
+
# The relative path to the DAG folder on your Amazon S3 storage bucket.
|
375
|
+
# For example, `dags`. For more information, see [Importing DAGs on
|
376
|
+
# Amazon MWAA][1].
|
377
|
+
#
|
378
|
+
#
|
379
|
+
#
|
380
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html
|
381
|
+
#
|
382
|
+
# @option params [String] :environment_class
|
383
|
+
# The environment class you want to use for your environment. The
|
384
|
+
# environment class determines the size of the containers and database
|
385
|
+
# used for your Apache Airflow services.
|
386
|
+
#
|
387
|
+
# @option params [required, String] :execution_role_arn
|
388
|
+
# The Amazon Resource Name (ARN) of the execution role for your
|
389
|
+
# environment. An execution role is an AWS Identity and Access
|
390
|
+
# Management (IAM) role that grants MWAA permission to access AWS
|
391
|
+
# services and resources used by your environment. For example,
|
392
|
+
# `arn:aws:iam::123456789:role/my-execution-role`. For more information,
|
393
|
+
# see [Managing access to Amazon Managed Workflows for Apache
|
394
|
+
# Airflow][1].
|
395
|
+
#
|
396
|
+
#
|
397
|
+
#
|
398
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/manage-access.html
|
399
|
+
#
|
400
|
+
# @option params [String] :kms_key
|
401
|
+
# The AWS Key Management Service (KMS) key to encrypt and decrypt the
|
402
|
+
# data in your environment. You can use an AWS KMS key managed by MWAA,
|
403
|
+
# or a custom KMS key (advanced). For more information, see [Customer
|
404
|
+
# master keys (CMKs)][1] in the AWS KMS developer guide.
|
405
|
+
#
|
406
|
+
#
|
407
|
+
#
|
408
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html?icmpid=docs_console_unmapped#master_keys
|
409
|
+
#
|
410
|
+
# @option params [Types::LoggingConfigurationInput] :logging_configuration
|
411
|
+
# The Apache Airflow logs you want to send to Amazon CloudWatch Logs.
|
412
|
+
#
|
413
|
+
# @option params [Integer] :max_workers
|
414
|
+
# The maximum number of workers that you want to run in your
|
415
|
+
# environment. MWAA scales the number of Apache Airflow workers and the
|
416
|
+
# Fargate containers that run your tasks up to the number you specify in
|
417
|
+
# this field. When there are no more tasks running, and no more in the
|
418
|
+
# queue, MWAA disposes of the extra containers leaving the one worker
|
419
|
+
# that is included with your environment.
|
420
|
+
#
|
421
|
+
# @option params [required, String] :name
|
422
|
+
# The name of your MWAA environment.
|
423
|
+
#
|
424
|
+
# @option params [required, Types::NetworkConfiguration] :network_configuration
|
425
|
+
# The VPC networking components you want to use for your environment. At
|
426
|
+
# least two private subnet identifiers and one VPC security group
|
427
|
+
# identifier are required to create an environment. For more
|
428
|
+
# information, see [Creating the VPC network for a MWAA environment][1].
|
429
|
+
#
|
430
|
+
#
|
431
|
+
#
|
432
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-mwaa.html
|
433
|
+
#
|
434
|
+
# @option params [String] :plugins_s3_object_version
|
435
|
+
# The `plugins.zip` file version you want to use.
|
436
|
+
#
|
437
|
+
# @option params [String] :plugins_s3_path
|
438
|
+
# The relative path to the `plugins.zip` file on your Amazon S3 storage
|
439
|
+
# bucket. For example, `plugins.zip`. If a relative path is provided in
|
440
|
+
# the request, then `PluginsS3ObjectVersion` is required. For more
|
441
|
+
# information, see [Importing DAGs on Amazon MWAA][1].
|
442
|
+
#
|
443
|
+
#
|
444
|
+
#
|
445
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html
|
446
|
+
#
|
447
|
+
# @option params [String] :requirements_s3_object_version
|
448
|
+
# The `requirements.txt` file version you want to use.
|
449
|
+
#
|
450
|
+
# @option params [String] :requirements_s3_path
|
451
|
+
# The relative path to the `requirements.txt` file on your Amazon S3
|
452
|
+
# storage bucket. For example, `requirements.txt`. If a relative path is
|
453
|
+
# provided in the request, then `RequirementsS3ObjectVersion` is
|
454
|
+
# required. For more information, see [Importing DAGs on Amazon
|
455
|
+
# MWAA][1].
|
456
|
+
#
|
457
|
+
#
|
458
|
+
#
|
459
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html
|
460
|
+
#
|
461
|
+
# @option params [required, String] :source_bucket_arn
|
462
|
+
# The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For
|
463
|
+
# example, `arn:aws:s3:::airflow-mybucketname`.
|
464
|
+
#
|
465
|
+
# @option params [Hash<String,String>] :tags
|
466
|
+
# The metadata tags you want to attach to your environment. For more
|
467
|
+
# information, see [Tagging AWS resources][1].
|
468
|
+
#
|
469
|
+
#
|
470
|
+
#
|
471
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
472
|
+
#
|
473
|
+
# @option params [String] :webserver_access_mode
|
474
|
+
# The networking access of your Apache Airflow web server. A public
|
475
|
+
# network allows your Airflow UI to be accessed over the Internet by
|
476
|
+
# users granted access in your IAM policy. A private network limits
|
477
|
+
# access of your Airflow UI to users within your VPC. For more
|
478
|
+
# information, see [Creating the VPC network for a MWAA environment][1].
|
479
|
+
#
|
480
|
+
#
|
481
|
+
#
|
482
|
+
# [1]: https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-mwaa.html
|
483
|
+
#
|
484
|
+
# @option params [String] :weekly_maintenance_window_start
|
485
|
+
# The day and time you want MWAA to start weekly maintenance updates on
|
486
|
+
# your environment.
|
487
|
+
#
|
488
|
+
# @return [Types::CreateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
489
|
+
#
|
490
|
+
# * {Types::CreateEnvironmentOutput#arn #arn} => String
|
491
|
+
#
|
492
|
+
# @example Request syntax with placeholder values
|
493
|
+
#
|
494
|
+
# resp = client.create_environment({
|
495
|
+
# airflow_configuration_options: {
|
496
|
+
# "ConfigKey" => "ConfigValue",
|
497
|
+
# },
|
498
|
+
# airflow_version: "AirflowVersion",
|
499
|
+
# dag_s3_path: "RelativePath", # required
|
500
|
+
# environment_class: "EnvironmentClass",
|
501
|
+
# execution_role_arn: "IamRoleArn", # required
|
502
|
+
# kms_key: "KmsKey",
|
503
|
+
# logging_configuration: {
|
504
|
+
# dag_processing_logs: {
|
505
|
+
# enabled: false, # required
|
506
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
507
|
+
# },
|
508
|
+
# scheduler_logs: {
|
509
|
+
# enabled: false, # required
|
510
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
511
|
+
# },
|
512
|
+
# task_logs: {
|
513
|
+
# enabled: false, # required
|
514
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
515
|
+
# },
|
516
|
+
# webserver_logs: {
|
517
|
+
# enabled: false, # required
|
518
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
519
|
+
# },
|
520
|
+
# worker_logs: {
|
521
|
+
# enabled: false, # required
|
522
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
523
|
+
# },
|
524
|
+
# },
|
525
|
+
# max_workers: 1,
|
526
|
+
# name: "EnvironmentName", # required
|
527
|
+
# network_configuration: { # required
|
528
|
+
# security_group_ids: ["SecurityGroupId"],
|
529
|
+
# subnet_ids: ["SubnetId"],
|
530
|
+
# },
|
531
|
+
# plugins_s3_object_version: "S3ObjectVersion",
|
532
|
+
# plugins_s3_path: "RelativePath",
|
533
|
+
# requirements_s3_object_version: "S3ObjectVersion",
|
534
|
+
# requirements_s3_path: "RelativePath",
|
535
|
+
# source_bucket_arn: "S3BucketArn", # required
|
536
|
+
# tags: {
|
537
|
+
# "TagKey" => "TagValue",
|
538
|
+
# },
|
539
|
+
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
540
|
+
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
541
|
+
# })
|
542
|
+
#
|
543
|
+
# @example Response structure
|
544
|
+
#
|
545
|
+
# resp.arn #=> String
|
546
|
+
#
|
547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateEnvironment AWS API Documentation
|
548
|
+
#
|
549
|
+
# @overload create_environment(params = {})
|
550
|
+
# @param [Hash] params ({})
|
551
|
+
def create_environment(params = {}, options = {})
|
552
|
+
req = build_request(:create_environment, params)
|
553
|
+
req.send_request(options)
|
554
|
+
end
|
555
|
+
|
556
|
+
# Create a JWT token to be used to login to Airflow Web UI with claims
|
557
|
+
# based Authentication.
|
558
|
+
#
|
559
|
+
# @option params [required, String] :name
|
560
|
+
# Create an Airflow Web UI login token request for a MWAA environment.
|
561
|
+
#
|
562
|
+
# @return [Types::CreateWebLoginTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
563
|
+
#
|
564
|
+
# * {Types::CreateWebLoginTokenResponse#web_server_hostname #web_server_hostname} => String
|
565
|
+
# * {Types::CreateWebLoginTokenResponse#web_token #web_token} => String
|
566
|
+
#
|
567
|
+
# @example Request syntax with placeholder values
|
568
|
+
#
|
569
|
+
# resp = client.create_web_login_token({
|
570
|
+
# name: "EnvironmentName", # required
|
571
|
+
# })
|
572
|
+
#
|
573
|
+
# @example Response structure
|
574
|
+
#
|
575
|
+
# resp.web_server_hostname #=> String
|
576
|
+
# resp.web_token #=> String
|
577
|
+
#
|
578
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/CreateWebLoginToken AWS API Documentation
|
579
|
+
#
|
580
|
+
# @overload create_web_login_token(params = {})
|
581
|
+
# @param [Hash] params ({})
|
582
|
+
def create_web_login_token(params = {}, options = {})
|
583
|
+
req = build_request(:create_web_login_token, params)
|
584
|
+
req.send_request(options)
|
585
|
+
end
|
586
|
+
|
587
|
+
# Delete an existing environment.
|
588
|
+
#
|
589
|
+
# @option params [required, String] :name
|
590
|
+
# The name of the environment to delete.
|
591
|
+
#
|
592
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
593
|
+
#
|
594
|
+
# @example Request syntax with placeholder values
|
595
|
+
#
|
596
|
+
# resp = client.delete_environment({
|
597
|
+
# name: "EnvironmentName", # required
|
598
|
+
# })
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/DeleteEnvironment AWS API Documentation
|
601
|
+
#
|
602
|
+
# @overload delete_environment(params = {})
|
603
|
+
# @param [Hash] params ({})
|
604
|
+
def delete_environment(params = {}, options = {})
|
605
|
+
req = build_request(:delete_environment, params)
|
606
|
+
req.send_request(options)
|
607
|
+
end
|
608
|
+
|
609
|
+
# Get details of an existing environment.
|
610
|
+
#
|
611
|
+
# @option params [required, String] :name
|
612
|
+
# The name of the environment to retrieve.
|
613
|
+
#
|
614
|
+
# @return [Types::GetEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
615
|
+
#
|
616
|
+
# * {Types::GetEnvironmentOutput#environment #environment} => Types::Environment
|
617
|
+
#
|
618
|
+
# @example Request syntax with placeholder values
|
619
|
+
#
|
620
|
+
# resp = client.get_environment({
|
621
|
+
# name: "EnvironmentName", # required
|
622
|
+
# })
|
623
|
+
#
|
624
|
+
# @example Response structure
|
625
|
+
#
|
626
|
+
# resp.environment.airflow_configuration_options #=> Hash
|
627
|
+
# resp.environment.airflow_configuration_options["ConfigKey"] #=> String
|
628
|
+
# resp.environment.airflow_version #=> String
|
629
|
+
# resp.environment.arn #=> String
|
630
|
+
# resp.environment.created_at #=> Time
|
631
|
+
# resp.environment.dag_s3_path #=> String
|
632
|
+
# resp.environment.environment_class #=> String
|
633
|
+
# resp.environment.execution_role_arn #=> String
|
634
|
+
# resp.environment.kms_key #=> String
|
635
|
+
# resp.environment.last_update.created_at #=> Time
|
636
|
+
# resp.environment.last_update.error.error_code #=> String
|
637
|
+
# resp.environment.last_update.error.error_message #=> String
|
638
|
+
# resp.environment.last_update.status #=> String, one of "SUCCESS", "PENDING", "FAILED"
|
639
|
+
# resp.environment.logging_configuration.dag_processing_logs.cloud_watch_log_group_arn #=> String
|
640
|
+
# resp.environment.logging_configuration.dag_processing_logs.enabled #=> Boolean
|
641
|
+
# resp.environment.logging_configuration.dag_processing_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
642
|
+
# resp.environment.logging_configuration.scheduler_logs.cloud_watch_log_group_arn #=> String
|
643
|
+
# resp.environment.logging_configuration.scheduler_logs.enabled #=> Boolean
|
644
|
+
# resp.environment.logging_configuration.scheduler_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
645
|
+
# resp.environment.logging_configuration.task_logs.cloud_watch_log_group_arn #=> String
|
646
|
+
# resp.environment.logging_configuration.task_logs.enabled #=> Boolean
|
647
|
+
# resp.environment.logging_configuration.task_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
648
|
+
# resp.environment.logging_configuration.webserver_logs.cloud_watch_log_group_arn #=> String
|
649
|
+
# resp.environment.logging_configuration.webserver_logs.enabled #=> Boolean
|
650
|
+
# resp.environment.logging_configuration.webserver_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
651
|
+
# resp.environment.logging_configuration.worker_logs.cloud_watch_log_group_arn #=> String
|
652
|
+
# resp.environment.logging_configuration.worker_logs.enabled #=> Boolean
|
653
|
+
# resp.environment.logging_configuration.worker_logs.log_level #=> String, one of "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG"
|
654
|
+
# resp.environment.max_workers #=> Integer
|
655
|
+
# resp.environment.name #=> String
|
656
|
+
# resp.environment.network_configuration.security_group_ids #=> Array
|
657
|
+
# resp.environment.network_configuration.security_group_ids[0] #=> String
|
658
|
+
# resp.environment.network_configuration.subnet_ids #=> Array
|
659
|
+
# resp.environment.network_configuration.subnet_ids[0] #=> String
|
660
|
+
# resp.environment.plugins_s3_object_version #=> String
|
661
|
+
# resp.environment.plugins_s3_path #=> String
|
662
|
+
# resp.environment.requirements_s3_object_version #=> String
|
663
|
+
# resp.environment.requirements_s3_path #=> String
|
664
|
+
# resp.environment.service_role_arn #=> String
|
665
|
+
# resp.environment.source_bucket_arn #=> String
|
666
|
+
# resp.environment.status #=> String, one of "CREATING", "CREATE_FAILED", "AVAILABLE", "UPDATING", "DELETING", "DELETED"
|
667
|
+
# resp.environment.tags #=> Hash
|
668
|
+
# resp.environment.tags["TagKey"] #=> String
|
669
|
+
# resp.environment.webserver_access_mode #=> String, one of "PRIVATE_ONLY", "PUBLIC_ONLY"
|
670
|
+
# resp.environment.webserver_url #=> String
|
671
|
+
# resp.environment.weekly_maintenance_window_start #=> String
|
672
|
+
#
|
673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/GetEnvironment AWS API Documentation
|
674
|
+
#
|
675
|
+
# @overload get_environment(params = {})
|
676
|
+
# @param [Hash] params ({})
|
677
|
+
def get_environment(params = {}, options = {})
|
678
|
+
req = build_request(:get_environment, params)
|
679
|
+
req.send_request(options)
|
680
|
+
end
|
681
|
+
|
682
|
+
# List Amazon MWAA Environments.
|
683
|
+
#
|
684
|
+
# @option params [Integer] :max_results
|
685
|
+
# The maximum results when listing MWAA environments.
|
686
|
+
#
|
687
|
+
# @option params [String] :next_token
|
688
|
+
# The Next Token when listing MWAA environments.
|
689
|
+
#
|
690
|
+
# @return [Types::ListEnvironmentsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
691
|
+
#
|
692
|
+
# * {Types::ListEnvironmentsOutput#environments #environments} => Array<String>
|
693
|
+
# * {Types::ListEnvironmentsOutput#next_token #next_token} => String
|
694
|
+
#
|
695
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
696
|
+
#
|
697
|
+
# @example Request syntax with placeholder values
|
698
|
+
#
|
699
|
+
# resp = client.list_environments({
|
700
|
+
# max_results: 1,
|
701
|
+
# next_token: "NextToken",
|
702
|
+
# })
|
703
|
+
#
|
704
|
+
# @example Response structure
|
705
|
+
#
|
706
|
+
# resp.environments #=> Array
|
707
|
+
# resp.environments[0] #=> String
|
708
|
+
# resp.next_token #=> String
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListEnvironments AWS API Documentation
|
711
|
+
#
|
712
|
+
# @overload list_environments(params = {})
|
713
|
+
# @param [Hash] params ({})
|
714
|
+
def list_environments(params = {}, options = {})
|
715
|
+
req = build_request(:list_environments, params)
|
716
|
+
req.send_request(options)
|
717
|
+
end
|
718
|
+
|
719
|
+
# List the tags for MWAA environments.
|
720
|
+
#
|
721
|
+
# @option params [required, String] :resource_arn
|
722
|
+
# The ARN of the MWAA environment.
|
723
|
+
#
|
724
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
725
|
+
#
|
726
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
727
|
+
#
|
728
|
+
# @example Request syntax with placeholder values
|
729
|
+
#
|
730
|
+
# resp = client.list_tags_for_resource({
|
731
|
+
# resource_arn: "EnvironmentArn", # required
|
732
|
+
# })
|
733
|
+
#
|
734
|
+
# @example Response structure
|
735
|
+
#
|
736
|
+
# resp.tags #=> Hash
|
737
|
+
# resp.tags["TagKey"] #=> String
|
738
|
+
#
|
739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/ListTagsForResource AWS API Documentation
|
740
|
+
#
|
741
|
+
# @overload list_tags_for_resource(params = {})
|
742
|
+
# @param [Hash] params ({})
|
743
|
+
def list_tags_for_resource(params = {}, options = {})
|
744
|
+
req = build_request(:list_tags_for_resource, params)
|
745
|
+
req.send_request(options)
|
746
|
+
end
|
747
|
+
|
748
|
+
# An operation for publishing metrics from the customers to the Ops
|
749
|
+
# plane.
|
750
|
+
#
|
751
|
+
# @option params [required, String] :environment_name
|
752
|
+
# Publishes environment metric data to Amazon CloudWatch.
|
753
|
+
#
|
754
|
+
# @option params [required, Array<Types::MetricDatum>] :metric_data
|
755
|
+
# Publishes metric data points to Amazon CloudWatch. CloudWatch
|
756
|
+
# associates the data points with the specified metrica.
|
757
|
+
#
|
758
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
759
|
+
#
|
760
|
+
# @example Request syntax with placeholder values
|
761
|
+
#
|
762
|
+
# resp = client.publish_metrics({
|
763
|
+
# environment_name: "EnvironmentName", # required
|
764
|
+
# metric_data: [ # required
|
765
|
+
# {
|
766
|
+
# dimensions: [
|
767
|
+
# {
|
768
|
+
# name: "String", # required
|
769
|
+
# value: "String", # required
|
770
|
+
# },
|
771
|
+
# ],
|
772
|
+
# metric_name: "String", # required
|
773
|
+
# statistic_values: {
|
774
|
+
# maximum: 1.0,
|
775
|
+
# minimum: 1.0,
|
776
|
+
# sample_count: 1,
|
777
|
+
# sum: 1.0,
|
778
|
+
# },
|
779
|
+
# timestamp: Time.now, # required
|
780
|
+
# 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
|
781
|
+
# value: 1.0,
|
782
|
+
# },
|
783
|
+
# ],
|
784
|
+
# })
|
785
|
+
#
|
786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/PublishMetrics AWS API Documentation
|
787
|
+
#
|
788
|
+
# @overload publish_metrics(params = {})
|
789
|
+
# @param [Hash] params ({})
|
790
|
+
def publish_metrics(params = {}, options = {})
|
791
|
+
req = build_request(:publish_metrics, params)
|
792
|
+
req.send_request(options)
|
793
|
+
end
|
794
|
+
|
795
|
+
# Add tag to the MWAA environments.
|
796
|
+
#
|
797
|
+
# @option params [required, String] :resource_arn
|
798
|
+
# The tag resource ARN of the MWAA environments.
|
799
|
+
#
|
800
|
+
# @option params [required, Hash<String,String>] :tags
|
801
|
+
# The tag resource tag of the MWAA environments.
|
802
|
+
#
|
803
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
804
|
+
#
|
805
|
+
# @example Request syntax with placeholder values
|
806
|
+
#
|
807
|
+
# resp = client.tag_resource({
|
808
|
+
# resource_arn: "EnvironmentArn", # required
|
809
|
+
# tags: { # required
|
810
|
+
# "TagKey" => "TagValue",
|
811
|
+
# },
|
812
|
+
# })
|
813
|
+
#
|
814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/TagResource AWS API Documentation
|
815
|
+
#
|
816
|
+
# @overload tag_resource(params = {})
|
817
|
+
# @param [Hash] params ({})
|
818
|
+
def tag_resource(params = {}, options = {})
|
819
|
+
req = build_request(:tag_resource, params)
|
820
|
+
req.send_request(options)
|
821
|
+
end
|
822
|
+
|
823
|
+
# Remove a tag from the MWAA environments.
|
824
|
+
#
|
825
|
+
# @option params [required, String] :resource_arn
|
826
|
+
# The tag resource ARN of the MWAA environments.
|
827
|
+
#
|
828
|
+
# @option params [required, Array<String>] :tag_keys
|
829
|
+
# The tag resource key of the MWAA environments.
|
830
|
+
#
|
831
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
832
|
+
#
|
833
|
+
# @example Request syntax with placeholder values
|
834
|
+
#
|
835
|
+
# resp = client.untag_resource({
|
836
|
+
# resource_arn: "EnvironmentArn", # required
|
837
|
+
# tag_keys: ["TagKey"], # required
|
838
|
+
# })
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UntagResource AWS API Documentation
|
841
|
+
#
|
842
|
+
# @overload untag_resource(params = {})
|
843
|
+
# @param [Hash] params ({})
|
844
|
+
def untag_resource(params = {}, options = {})
|
845
|
+
req = build_request(:untag_resource, params)
|
846
|
+
req.send_request(options)
|
847
|
+
end
|
848
|
+
|
849
|
+
# Update an MWAA environment.
|
850
|
+
#
|
851
|
+
# @option params [Hash<String,String>] :airflow_configuration_options
|
852
|
+
# The Airflow Configuration Options to update of your Amazon MWAA
|
853
|
+
# environment.
|
854
|
+
#
|
855
|
+
# @option params [String] :airflow_version
|
856
|
+
# The Airflow Version to update of your Amazon MWAA environment.
|
857
|
+
#
|
858
|
+
# @option params [String] :dag_s3_path
|
859
|
+
# The Dags folder S3 Path to update of your Amazon MWAA environment.
|
860
|
+
#
|
861
|
+
# @option params [String] :environment_class
|
862
|
+
# The Environment Class to update of your Amazon MWAA environment.
|
863
|
+
#
|
864
|
+
# @option params [String] :execution_role_arn
|
865
|
+
# The Executio Role ARN to update of your Amazon MWAA environment.
|
866
|
+
#
|
867
|
+
# @option params [Types::LoggingConfigurationInput] :logging_configuration
|
868
|
+
# The Logging Configuration to update of your Amazon MWAA environment.
|
869
|
+
#
|
870
|
+
# @option params [Integer] :max_workers
|
871
|
+
# The Maximum Workers to update of your Amazon MWAA environment.
|
872
|
+
#
|
873
|
+
# @option params [required, String] :name
|
874
|
+
# The name of your Amazon MWAA environment that you wish to update.
|
875
|
+
#
|
876
|
+
# @option params [Types::UpdateNetworkConfigurationInput] :network_configuration
|
877
|
+
# The Network Configuration to update of your Amazon MWAA environment.
|
878
|
+
#
|
879
|
+
# @option params [String] :plugins_s3_object_version
|
880
|
+
# The Plugins.zip S3 Object Version to update of your Amazon MWAA
|
881
|
+
# environment.
|
882
|
+
#
|
883
|
+
# @option params [String] :plugins_s3_path
|
884
|
+
# The Plugins.zip S3 Path to update of your Amazon MWAA environment.
|
885
|
+
#
|
886
|
+
# @option params [String] :requirements_s3_object_version
|
887
|
+
# The Requirements.txt S3 ObjectV ersion to update of your Amazon MWAA
|
888
|
+
# environment.
|
889
|
+
#
|
890
|
+
# @option params [String] :requirements_s3_path
|
891
|
+
# The Requirements.txt S3 Path to update of your Amazon MWAA
|
892
|
+
# environment.
|
893
|
+
#
|
894
|
+
# @option params [String] :source_bucket_arn
|
895
|
+
# The S3 Source Bucket ARN to update of your Amazon MWAA environment.
|
896
|
+
#
|
897
|
+
# @option params [String] :webserver_access_mode
|
898
|
+
# The Webserver Access Mode to update of your Amazon MWAA environment.
|
899
|
+
#
|
900
|
+
# @option params [String] :weekly_maintenance_window_start
|
901
|
+
# The Weekly Maintenance Window Start to update of your Amazon MWAA
|
902
|
+
# environment.
|
903
|
+
#
|
904
|
+
# @return [Types::UpdateEnvironmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
905
|
+
#
|
906
|
+
# * {Types::UpdateEnvironmentOutput#arn #arn} => String
|
907
|
+
#
|
908
|
+
# @example Request syntax with placeholder values
|
909
|
+
#
|
910
|
+
# resp = client.update_environment({
|
911
|
+
# airflow_configuration_options: {
|
912
|
+
# "ConfigKey" => "ConfigValue",
|
913
|
+
# },
|
914
|
+
# airflow_version: "AirflowVersion",
|
915
|
+
# dag_s3_path: "RelativePath",
|
916
|
+
# environment_class: "EnvironmentClass",
|
917
|
+
# execution_role_arn: "IamRoleArn",
|
918
|
+
# logging_configuration: {
|
919
|
+
# dag_processing_logs: {
|
920
|
+
# enabled: false, # required
|
921
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
922
|
+
# },
|
923
|
+
# scheduler_logs: {
|
924
|
+
# enabled: false, # required
|
925
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
926
|
+
# },
|
927
|
+
# task_logs: {
|
928
|
+
# enabled: false, # required
|
929
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
930
|
+
# },
|
931
|
+
# webserver_logs: {
|
932
|
+
# enabled: false, # required
|
933
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
934
|
+
# },
|
935
|
+
# worker_logs: {
|
936
|
+
# enabled: false, # required
|
937
|
+
# log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
|
938
|
+
# },
|
939
|
+
# },
|
940
|
+
# max_workers: 1,
|
941
|
+
# name: "EnvironmentName", # required
|
942
|
+
# network_configuration: {
|
943
|
+
# security_group_ids: ["SecurityGroupId"], # required
|
944
|
+
# },
|
945
|
+
# plugins_s3_object_version: "S3ObjectVersion",
|
946
|
+
# plugins_s3_path: "RelativePath",
|
947
|
+
# requirements_s3_object_version: "S3ObjectVersion",
|
948
|
+
# requirements_s3_path: "RelativePath",
|
949
|
+
# source_bucket_arn: "S3BucketArn",
|
950
|
+
# webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
|
951
|
+
# weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
|
952
|
+
# })
|
953
|
+
#
|
954
|
+
# @example Response structure
|
955
|
+
#
|
956
|
+
# resp.arn #=> String
|
957
|
+
#
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mwaa-2020-07-01/UpdateEnvironment AWS API Documentation
|
959
|
+
#
|
960
|
+
# @overload update_environment(params = {})
|
961
|
+
# @param [Hash] params ({})
|
962
|
+
def update_environment(params = {}, options = {})
|
963
|
+
req = build_request(:update_environment, params)
|
964
|
+
req.send_request(options)
|
965
|
+
end
|
966
|
+
|
967
|
+
# @!endgroup
|
968
|
+
|
969
|
+
# @param params ({})
|
970
|
+
# @api private
|
971
|
+
def build_request(operation_name, params = {})
|
972
|
+
handlers = @handlers.for(operation_name)
|
973
|
+
context = Seahorse::Client::RequestContext.new(
|
974
|
+
operation_name: operation_name,
|
975
|
+
operation: config.api.operation(operation_name),
|
976
|
+
client: self,
|
977
|
+
params: params,
|
978
|
+
config: config)
|
979
|
+
context[:gem_name] = 'aws-sdk-mwaa'
|
980
|
+
context[:gem_version] = '1.0.0'
|
981
|
+
Seahorse::Client::Request.new(handlers, context)
|
982
|
+
end
|
983
|
+
|
984
|
+
# @api private
|
985
|
+
# @deprecated
|
986
|
+
def waiter_names
|
987
|
+
[]
|
988
|
+
end
|
989
|
+
|
990
|
+
class << self
|
991
|
+
|
992
|
+
# @api private
|
993
|
+
attr_reader :identifier
|
994
|
+
|
995
|
+
# @api private
|
996
|
+
def errors_module
|
997
|
+
Errors
|
998
|
+
end
|
999
|
+
|
1000
|
+
end
|
1001
|
+
end
|
1002
|
+
end
|