aws-sdk-opsworks 1.21.0 → 1.26.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 22f86bbc80ed6622608817411d6512f86a7a048b
4
- data.tar.gz: 89057e5d31d0c6189e7df028b032006f789c37bc
2
+ SHA256:
3
+ metadata.gz: a39558dab9509873e88cc3b51fe68c4a893ad38b9bec2823235e681fbd1e931d
4
+ data.tar.gz: 7b035318e4622fa788763ee639be51028eb8427f11f7b852856b0eba2704b3bb
5
5
  SHA512:
6
- metadata.gz: acf9f856964c1f1c89db9960626a9d2ede47958250fed883f8004fb7c43ee98ddc3b986cf0d6fa3e4a67469e79d4e3af303f326561463e48e529902fc1e29333
7
- data.tar.gz: 57fc4c66b856355367c943a0777d4e7991078755b9f9468aa0ff1777eff82249eaafd13d800b274f139687d4216914c37f21da5faa656c56d6db19aea550a3c8
6
+ metadata.gz: f267613bd679f84fa58fdf03a47a5a1fa57e6d631531e0438cc2fdaae43f1e085cbf35e2ca6849b43aa7d93960ed8d22c7af4faf37dcff772334ea0f04b941d8
7
+ data.tar.gz: 85e2b32701807800640cf0525bdd947f8190808124d60fa3967ffb49d9a52aa239eee1fd22096e03389837966895d1ba57c552e5e12cf1d65574519f7bc499b7
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -28,17 +30,20 @@ require_relative 'aws-sdk-opsworks/customizations'
28
30
  # methods each accept a hash of request parameters and return a response
29
31
  # structure.
30
32
  #
33
+ # ops_works = Aws::OpsWorks::Client.new
34
+ # resp = ops_works.assign_instance(params)
35
+ #
31
36
  # See {Client} for more information.
32
37
  #
33
38
  # # Errors
34
39
  #
35
- # Errors returned from AWS OpsWorks all
36
- # extend {Errors::ServiceError}.
40
+ # Errors returned from AWS OpsWorks are defined in the
41
+ # {Errors} module and all extend {Errors::ServiceError}.
37
42
  #
38
43
  # begin
39
44
  # # do stuff
40
45
  # rescue Aws::OpsWorks::Errors::ServiceError
41
- # # rescues all service API errors
46
+ # # rescues all AWS OpsWorks API errors
42
47
  # end
43
48
  #
44
49
  # See {Errors} for more information.
@@ -46,6 +51,6 @@ require_relative 'aws-sdk-opsworks/customizations'
46
51
  # @service
47
52
  module Aws::OpsWorks
48
53
 
49
- GEM_VERSION = '1.21.0'
54
+ GEM_VERSION = '1.26.0'
50
55
 
51
56
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
32
 
30
33
  Aws::Plugins::GlobalConfiguration.add_identifier(:opsworks)
31
34
 
32
35
  module Aws::OpsWorks
36
+ # An API client for OpsWorks. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::OpsWorks::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.
33
48
  class Client < Seahorse::Client::Base
34
49
 
35
50
  include Aws::ClientStubs
@@ -57,6 +72,7 @@ module Aws::OpsWorks
57
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
60
76
  add_plugin(Aws::Plugins::SignatureV4)
61
77
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
78
 
@@ -93,7 +109,7 @@ module Aws::OpsWorks
93
109
  # @option options [required, String] :region
94
110
  # The AWS region to connect to. The configured `:region` is
95
111
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
97
113
  #
98
114
  # * `Aws.config[:region]`
99
115
  # * `ENV['AWS_REGION']`
@@ -108,6 +124,12 @@ module Aws::OpsWorks
108
124
  # When set to `true`, a thread polling for endpoints will be running in
109
125
  # the background every 60 secs (default). Defaults to `false`.
110
126
  #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
111
133
  # @option options [Boolean] :client_side_monitoring (false)
112
134
  # When `true`, client-side metrics will be collected for all API requests from
113
135
  # this client.
@@ -132,6 +154,10 @@ module Aws::OpsWorks
132
154
  # When `true`, an attempt is made to coerce request parameters into
133
155
  # the required types.
134
156
  #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
135
161
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
162
  # Set to true to disable SDK automatically adding host prefix
137
163
  # to default service endpoint when available.
@@ -139,7 +165,7 @@ module Aws::OpsWorks
139
165
  # @option options [String] :endpoint
140
166
  # The client endpoint is normally constructed from the `:region`
141
167
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
169
  #
144
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +180,7 @@ module Aws::OpsWorks
154
180
  # requests fetching endpoints information. Defaults to 60 sec.
155
181
  #
156
182
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
184
  #
159
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
186
  # The log formatter.
@@ -166,15 +192,29 @@ module Aws::OpsWorks
166
192
  # The Logger instance to send log messages to. If this option
167
193
  # is not set, logging will be disabled.
168
194
  #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
169
201
  # @option options [String] :profile ("default")
170
202
  # Used when loading credentials from the shared credentials file
171
203
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
204
  #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
173
209
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
175
212
  #
176
213
  # @option options [Symbol] :retry_jitter (:none)
177
- # 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.
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
178
218
  #
179
219
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
220
  #
@@ -182,11 +222,30 @@ module Aws::OpsWorks
182
222
  # The maximum number of times to retry failed requests. Only
183
223
  # ~ 500 level server errors and certain ~ 400 level client errors
184
224
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
187
228
  #
188
229
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
190
249
  #
191
250
  # @option options [String] :secret_access_key
192
251
  #
@@ -219,16 +278,15 @@ module Aws::OpsWorks
219
278
  # requests through. Formatted like 'http://proxy.com:123'.
220
279
  #
221
280
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
281
+ # seconds to wait when opening a HTTP session before raising a
223
282
  # `Timeout::Error`.
224
283
  #
225
284
  # @option options [Integer] :http_read_timeout (60) The default
226
285
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
286
+ # safely be set per-request on the session.
229
287
  #
230
288
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
289
+ # seconds a connection is allowed to sit idle before it is
232
290
  # considered stale. Stale connections are closed and removed
233
291
  # from the pool before making a request.
234
292
  #
@@ -237,7 +295,7 @@ module Aws::OpsWorks
237
295
  # request body. This option has no effect unless the request has
238
296
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
297
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
298
+ # request on the session.
241
299
  #
242
300
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
301
  # HTTP debug output will be sent to the `:logger`.
@@ -2356,6 +2414,11 @@ module Aws::OpsWorks
2356
2414
  # resp.apps[0].environment[0].value #=> String
2357
2415
  # resp.apps[0].environment[0].secure #=> Boolean
2358
2416
  #
2417
+ #
2418
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2419
+ #
2420
+ # * app_exists
2421
+ #
2359
2422
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeApps AWS API Documentation
2360
2423
  #
2361
2424
  # @overload describe_apps(params = {})
@@ -2492,6 +2555,11 @@ module Aws::OpsWorks
2492
2555
  # resp.deployments[0].instance_ids #=> Array
2493
2556
  # resp.deployments[0].instance_ids[0] #=> String
2494
2557
  #
2558
+ #
2559
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2560
+ #
2561
+ # * deployment_successful
2562
+ #
2495
2563
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeDeployments AWS API Documentation
2496
2564
  #
2497
2565
  # @overload describe_deployments(params = {})
@@ -2545,6 +2613,8 @@ module Aws::OpsWorks
2545
2613
  # * {Types::DescribeEcsClustersResult#ecs_clusters #ecs_clusters} => Array&lt;Types::EcsCluster&gt;
2546
2614
  # * {Types::DescribeEcsClustersResult#next_token #next_token} => String
2547
2615
  #
2616
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2617
+ #
2548
2618
  # @example Request syntax with placeholder values
2549
2619
  #
2550
2620
  # resp = client.describe_ecs_clusters({
@@ -2793,6 +2863,14 @@ module Aws::OpsWorks
2793
2863
  # resp.instances[0].tenancy #=> String
2794
2864
  # resp.instances[0].virtualization_type #=> String, one of "paravirtual", "hvm"
2795
2865
  #
2866
+ #
2867
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2868
+ #
2869
+ # * instance_online
2870
+ # * instance_registered
2871
+ # * instance_stopped
2872
+ # * instance_terminated
2873
+ #
2796
2874
  # @see http://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeInstances AWS API Documentation
2797
2875
  #
2798
2876
  # @overload describe_instances(params = {})
@@ -5556,7 +5634,7 @@ module Aws::OpsWorks
5556
5634
  params: params,
5557
5635
  config: config)
5558
5636
  context[:gem_name] = 'aws-sdk-opsworks'
5559
- context[:gem_version] = '1.21.0'
5637
+ context[:gem_version] = '1.26.0'
5560
5638
  Seahorse::Client::Request.new(handlers, context)
5561
5639
  end
5562
5640
 
@@ -5622,14 +5700,14 @@ module Aws::OpsWorks
5622
5700
  # The following table lists the valid waiter names, the operations they call,
5623
5701
  # and the default `:delay` and `:max_attempts` values.
5624
5702
  #
5625
- # | waiter_name | params | :delay | :max_attempts |
5626
- # | --------------------- | ----------------------- | -------- | ------------- |
5627
- # | app_exists | {#describe_apps} | 1 | 40 |
5628
- # | deployment_successful | {#describe_deployments} | 15 | 40 |
5629
- # | instance_online | {#describe_instances} | 15 | 40 |
5630
- # | instance_registered | {#describe_instances} | 15 | 40 |
5631
- # | instance_stopped | {#describe_instances} | 15 | 40 |
5632
- # | instance_terminated | {#describe_instances} | 15 | 40 |
5703
+ # | waiter_name | params | :delay | :max_attempts |
5704
+ # | --------------------- | ----------------------------- | -------- | ------------- |
5705
+ # | app_exists | {Client#describe_apps} | 1 | 40 |
5706
+ # | deployment_successful | {Client#describe_deployments} | 15 | 40 |
5707
+ # | instance_online | {Client#describe_instances} | 15 | 40 |
5708
+ # | instance_registered | {Client#describe_instances} | 15 | 40 |
5709
+ # | instance_stopped | {Client#describe_instances} | 15 | 40 |
5710
+ # | instance_terminated | {Client#describe_instances} | 15 | 40 |
5633
5711
  #
5634
5712
  # @raise [Errors::FailureStateError] Raised when the waiter terminates
5635
5713
  # because the waiter has entered a state that it will not transition
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,4 @@
1
+ # frozen_string_literal: true
1
2
  # WARNING ABOUT GENERATED CODE
2
3
  #
3
4
  # This file is generated. See the contributing for info on making contributions:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,30 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::OpsWorks
11
+
12
+ # When OpsWorks returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::OpsWorks::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all OpsWorks errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::OpsWorks::Errors::ServiceError
20
+ # # rescues all OpsWorks API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {ResourceNotFoundException}
31
+ # * {ValidationException}
32
+ #
33
+ # Additionally, error classes are dynamically generated for service errors based on the error code
34
+ # if they are not defined above.
9
35
  module Errors
10
36
 
11
37
  extend Aws::Errors::DynamicErrors
@@ -23,7 +49,6 @@ module Aws::OpsWorks
23
49
  def message
24
50
  @message || @data[:message]
25
51
  end
26
-
27
52
  end
28
53
 
29
54
  class ValidationException < ServiceError
@@ -39,7 +64,6 @@ module Aws::OpsWorks
39
64
  def message
40
65
  @message || @data[:message]
41
66
  end
42
-
43
67
  end
44
68
 
45
69
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,7 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::OpsWorks
11
+
9
12
  class Layer
10
13
 
11
14
  extend Aws::Deprecations
@@ -21,6 +24,7 @@ module Aws::OpsWorks
21
24
  @id = extract_id(args, options)
22
25
  @data = options.delete(:data)
23
26
  @client = options.delete(:client) || Client.new(options)
27
+ @waiter_block_warned = false
24
28
  end
25
29
 
26
30
  # @!group Read-Only Attributes
@@ -261,7 +265,8 @@ module Aws::OpsWorks
261
265
  # Waiter polls an API operation until a resource enters a desired
262
266
  # state.
263
267
  #
264
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
268
+ # @note The waiting operation is performed on a copy. The original resource
269
+ # remains unchanged.
265
270
  #
266
271
  # ## Basic Usage
267
272
  #
@@ -274,13 +279,15 @@ module Aws::OpsWorks
274
279
  #
275
280
  # ## Example
276
281
  #
277
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
282
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
283
+ # instance.state.name == 'running'
284
+ # end
278
285
  #
279
286
  # ## Configuration
280
287
  #
281
288
  # You can configure the maximum number of polling attempts, and the
282
- # delay (in seconds) between each polling attempt. The waiting condition is set
283
- # by passing a block to {#wait_until}:
289
+ # delay (in seconds) between each polling attempt. The waiting condition is
290
+ # set by passing a block to {#wait_until}:
284
291
  #
285
292
  # # poll for ~25 seconds
286
293
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -311,17 +318,16 @@ module Aws::OpsWorks
311
318
  # # resource did not enter the desired state in time
312
319
  # end
313
320
  #
321
+ # @yieldparam [Resource] resource to be used in the waiting condition.
314
322
  #
315
- # @yield param [Resource] resource to be used in the waiting condition
316
- #
317
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
318
- # because the waiter has entered a state that it will not transition
319
- # out of, preventing success.
323
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
324
+ # terminates because the waiter has entered a state that it will not
325
+ # transition out of, preventing success.
320
326
  #
321
327
  # yet successful.
322
328
  #
323
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
324
- # while polling for a resource that is not expected.
329
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
330
+ # encountered while polling for a resource that is not expected.
325
331
  #
326
332
  # @raise [NotImplementedError] Raised when the resource does not
327
333
  #
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,18 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::OpsWorks
11
+
12
+ # This class provides a resource oriented interface for OpsWorks.
13
+ # To create a resource object:
14
+ #
15
+ # resource = Aws::OpsWorks::Resource.new(region: 'us-west-2')
16
+ #
17
+ # You can supply a client object with custom configuration that will be used for all resource operations.
18
+ # If you do not pass `:client`, a default client will be constructed.
19
+ #
20
+ # client = Aws::OpsWorks::Client.new(region: 'us-west-2')
21
+ # resource = Aws::OpsWorks::Resource.new(client: client)
22
+ #
9
23
  class Resource
10
24
 
11
25
  # @param options ({})