aws-sdk-elasticbeanstalk 1.33.0 → 1.38.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1385c9963d5b5585d14a9c983cdf3d8d03e368255faf434d074b33b1417f3851
4
- data.tar.gz: fc20b115cc50b2afb0cb4e75acbeaeac89c1148fc6ddea8898a0b4fde9e85066
3
+ metadata.gz: 501127a583c1ab4ca275ea6fe398295310decd022846154bd81026543f20297b
4
+ data.tar.gz: 8bd0da7d62a03bf8d361b76aa1204616056026ccd884e99ca3280dbafb25cd52
5
5
  SHA512:
6
- metadata.gz: ce910668fd2a46679a989dfbc48dd110644d3548d31a68240d345be0a59f35810edec80448cfbe76bb8e2614dae1aa8ee62a5d6a5b219a11d03eae198ef5ca2f
7
- data.tar.gz: aadcf69004dfd3a87de75d93f9b0de7d5fd65451ec222cd3c0dc8ca2edb0d6d2f5c57ada8aa012f2443050afe1a15567e60e44de9654a90a2ea787fd68d5c6f3
6
+ metadata.gz: e26633c7240922b2408571023397c1100eeb4edc6c3d370612f1f77615d3472b030e56934ecb965f87971be23d1bdc54735e59ae0ca83734ef8f46de1a9564ea
7
+ data.tar.gz: 00d943535c409b5f172f7978d81474a63e2cf2912205023247606a99f0f91df08b4477aac7b8366055517e542e3faea8c7d2a2585052824da79a9b9a6a051257
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -14,6 +15,7 @@ require_relative 'aws-sdk-elasticbeanstalk/types'
14
15
  require_relative 'aws-sdk-elasticbeanstalk/client_api'
15
16
  require_relative 'aws-sdk-elasticbeanstalk/client'
16
17
  require_relative 'aws-sdk-elasticbeanstalk/errors'
18
+ require_relative 'aws-sdk-elasticbeanstalk/waiters'
17
19
  require_relative 'aws-sdk-elasticbeanstalk/resource'
18
20
  require_relative 'aws-sdk-elasticbeanstalk/customizations'
19
21
 
@@ -44,9 +46,9 @@ require_relative 'aws-sdk-elasticbeanstalk/customizations'
44
46
  #
45
47
  # See {Errors} for more information.
46
48
  #
47
- # @service
49
+ # @!group service
48
50
  module Aws::ElasticBeanstalk
49
51
 
50
- GEM_VERSION = '1.33.0'
52
+ GEM_VERSION = '1.38.0'
51
53
 
52
54
  end
@@ -85,13 +85,28 @@ module Aws::ElasticBeanstalk
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
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
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::ElasticBeanstalk
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
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.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -2232,6 +2247,8 @@ module Aws::ElasticBeanstalk
2232
2247
  # * {Types::DescribeEnvironmentManagedActionHistoryResult#managed_action_history_items #managed_action_history_items} => Array<Types::ManagedActionHistoryItem>
2233
2248
  # * {Types::DescribeEnvironmentManagedActionHistoryResult#next_token #next_token} => String
2234
2249
  #
2250
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2251
+ #
2235
2252
  # @example Request syntax with placeholder values
2236
2253
  #
2237
2254
  # resp = client.describe_environment_managed_action_history({
@@ -2533,6 +2550,13 @@ module Aws::ElasticBeanstalk
2533
2550
  # resp.environments[0].operations_role #=> String
2534
2551
  # resp.next_token #=> String
2535
2552
  #
2553
+ #
2554
+ # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
2555
+ #
2556
+ # * environment_exists
2557
+ # * environment_terminated
2558
+ # * environment_updated
2559
+ #
2536
2560
  # @see http://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk-2010-12-01/DescribeEnvironments AWS API Documentation
2537
2561
  #
2538
2562
  # @overload describe_environments(params = {})
@@ -3151,6 +3175,8 @@ module Aws::ElasticBeanstalk
3151
3175
  # * {Types::ListPlatformVersionsResult#platform_summary_list #platform_summary_list} => Array<Types::PlatformSummary>
3152
3176
  # * {Types::ListPlatformVersionsResult#next_token #next_token} => String
3153
3177
  #
3178
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3179
+ #
3154
3180
  # @example Request syntax with placeholder values
3155
3181
  #
3156
3182
  # resp = client.list_platform_versions({
@@ -4475,14 +4501,131 @@ module Aws::ElasticBeanstalk
4475
4501
  params: params,
4476
4502
  config: config)
4477
4503
  context[:gem_name] = 'aws-sdk-elasticbeanstalk'
4478
- context[:gem_version] = '1.33.0'
4504
+ context[:gem_version] = '1.38.0'
4479
4505
  Seahorse::Client::Request.new(handlers, context)
4480
4506
  end
4481
4507
 
4508
+ # Polls an API operation until a resource enters a desired state.
4509
+ #
4510
+ # ## Basic Usage
4511
+ #
4512
+ # A waiter will call an API operation until:
4513
+ #
4514
+ # * It is successful
4515
+ # * It enters a terminal state
4516
+ # * It makes the maximum number of attempts
4517
+ #
4518
+ # In between attempts, the waiter will sleep.
4519
+ #
4520
+ # # polls in a loop, sleeping between attempts
4521
+ # client.wait_until(waiter_name, params)
4522
+ #
4523
+ # ## Configuration
4524
+ #
4525
+ # You can configure the maximum number of polling attempts, and the
4526
+ # delay (in seconds) between each polling attempt. You can pass
4527
+ # configuration as the final arguments hash.
4528
+ #
4529
+ # # poll for ~25 seconds
4530
+ # client.wait_until(waiter_name, params, {
4531
+ # max_attempts: 5,
4532
+ # delay: 5,
4533
+ # })
4534
+ #
4535
+ # ## Callbacks
4536
+ #
4537
+ # You can be notified before each polling attempt and before each
4538
+ # delay. If you throw `:success` or `:failure` from these callbacks,
4539
+ # it will terminate the waiter.
4540
+ #
4541
+ # started_at = Time.now
4542
+ # client.wait_until(waiter_name, params, {
4543
+ #
4544
+ # # disable max attempts
4545
+ # max_attempts: nil,
4546
+ #
4547
+ # # poll for 1 hour, instead of a number of attempts
4548
+ # before_wait: -> (attempts, response) do
4549
+ # throw :failure if Time.now - started_at > 3600
4550
+ # end
4551
+ # })
4552
+ #
4553
+ # ## Handling Errors
4554
+ #
4555
+ # When a waiter is unsuccessful, it will raise an error.
4556
+ # All of the failure errors extend from
4557
+ # {Aws::Waiters::Errors::WaiterFailed}.
4558
+ #
4559
+ # begin
4560
+ # client.wait_until(...)
4561
+ # rescue Aws::Waiters::Errors::WaiterFailed
4562
+ # # resource did not enter the desired state in time
4563
+ # end
4564
+ #
4565
+ # ## Valid Waiters
4566
+ #
4567
+ # The following table lists the valid waiter names, the operations they call,
4568
+ # and the default `:delay` and `:max_attempts` values.
4569
+ #
4570
+ # | waiter_name | params | :delay | :max_attempts |
4571
+ # | ---------------------- | ------------------------------ | -------- | ------------- |
4572
+ # | environment_exists | {Client#describe_environments} | 20 | 20 |
4573
+ # | environment_terminated | {Client#describe_environments} | 20 | 20 |
4574
+ # | environment_updated | {Client#describe_environments} | 20 | 20 |
4575
+ #
4576
+ # @raise [Errors::FailureStateError] Raised when the waiter terminates
4577
+ # because the waiter has entered a state that it will not transition
4578
+ # out of, preventing success.
4579
+ #
4580
+ # @raise [Errors::TooManyAttemptsError] Raised when the configured
4581
+ # maximum number of attempts have been made, and the waiter is not
4582
+ # yet successful.
4583
+ #
4584
+ # @raise [Errors::UnexpectedError] Raised when an error is encounted
4585
+ # while polling for a resource that is not expected.
4586
+ #
4587
+ # @raise [Errors::NoSuchWaiterError] Raised when you request to wait
4588
+ # for an unknown state.
4589
+ #
4590
+ # @return [Boolean] Returns `true` if the waiter was successful.
4591
+ # @param [Symbol] waiter_name
4592
+ # @param [Hash] params ({})
4593
+ # @param [Hash] options ({})
4594
+ # @option options [Integer] :max_attempts
4595
+ # @option options [Integer] :delay
4596
+ # @option options [Proc] :before_attempt
4597
+ # @option options [Proc] :before_wait
4598
+ def wait_until(waiter_name, params = {}, options = {})
4599
+ w = waiter(waiter_name, options)
4600
+ yield(w.waiter) if block_given? # deprecated
4601
+ w.wait(params)
4602
+ end
4603
+
4482
4604
  # @api private
4483
4605
  # @deprecated
4484
4606
  def waiter_names
4485
- []
4607
+ waiters.keys
4608
+ end
4609
+
4610
+ private
4611
+
4612
+ # @param [Symbol] waiter_name
4613
+ # @param [Hash] options ({})
4614
+ def waiter(waiter_name, options = {})
4615
+ waiter_class = waiters[waiter_name]
4616
+ if waiter_class
4617
+ waiter_class.new(options.merge(client: self))
4618
+ else
4619
+ raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
4620
+ end
4621
+ end
4622
+
4623
+ def waiters
4624
+ {
4625
+ environment_exists: Waiters::EnvironmentExists,
4626
+ environment_terminated: Waiters::EnvironmentTerminated,
4627
+ environment_updated: Waiters::EnvironmentUpdated
4628
+ }
4486
4629
  end
4487
4630
 
4488
4631
  class << self
@@ -1440,6 +1440,12 @@ module Aws::ElasticBeanstalk
1440
1440
  o.input = Shapes::ShapeRef.new(shape: DescribeEnvironmentManagedActionHistoryRequest)
1441
1441
  o.output = Shapes::ShapeRef.new(shape: DescribeEnvironmentManagedActionHistoryResult)
1442
1442
  o.errors << Shapes::ShapeRef.new(shape: ElasticBeanstalkServiceException)
1443
+ o[:pager] = Aws::Pager.new(
1444
+ limit_key: "max_items",
1445
+ tokens: {
1446
+ "next_token" => "next_token"
1447
+ }
1448
+ )
1443
1449
  end)
1444
1450
 
1445
1451
  api.add_operation(:describe_environment_managed_actions, Seahorse::Model::Operation.new.tap do |o|
@@ -1541,6 +1547,12 @@ module Aws::ElasticBeanstalk
1541
1547
  o.output = Shapes::ShapeRef.new(shape: ListPlatformVersionsResult)
1542
1548
  o.errors << Shapes::ShapeRef.new(shape: InsufficientPrivilegesException)
1543
1549
  o.errors << Shapes::ShapeRef.new(shape: ElasticBeanstalkServiceException)
1550
+ o[:pager] = Aws::Pager.new(
1551
+ limit_key: "max_records",
1552
+ tokens: {
1553
+ "next_token" => "next_token"
1554
+ }
1555
+ )
1544
1556
  end)
1545
1557
 
1546
1558
  api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
@@ -0,0 +1,210 @@
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 'aws-sdk-core/waiters'
11
+
12
+ module Aws::ElasticBeanstalk
13
+ # Waiters are utility methods that poll for a particular state to occur
14
+ # on a client. Waiters can fail after a number of attempts at a polling
15
+ # interval defined for the service client.
16
+ #
17
+ # For a list of operations that can be waited for and the
18
+ # client methods called for each operation, see the table below or the
19
+ # {Client#wait_until} field documentation for the {Client}.
20
+ #
21
+ # # Invoking a Waiter
22
+ # To invoke a waiter, call #wait_until on a {Client}. The first parameter
23
+ # is the waiter name, which is specific to the service client and indicates
24
+ # which operation is being waited for. The second parameter is a hash of
25
+ # parameters that are passed to the client method called by the waiter,
26
+ # which varies according to the waiter name.
27
+ #
28
+ # # Wait Failures
29
+ # To catch errors in a waiter, use WaiterFailed,
30
+ # as shown in the following example.
31
+ #
32
+ # rescue rescue Aws::Waiters::Errors::WaiterFailed => error
33
+ # puts "failed waiting for instance running: #{error.message}
34
+ # end
35
+ #
36
+ # # Configuring a Waiter
37
+ # Each waiter has a default polling interval and a maximum number of
38
+ # attempts it will make before returning control to your program.
39
+ # To set these values, use the `max_attempts` and `delay` parameters
40
+ # in your `#wait_until` call.
41
+ # The following example waits for up to 25 seconds, polling every five seconds.
42
+ #
43
+ # client.wait_until(...) do |w|
44
+ # w.max_attempts = 5
45
+ # w.delay = 5
46
+ # end
47
+ #
48
+ # To disable wait failures, set the value of either of these parameters
49
+ # to `nil`.
50
+ #
51
+ # # Extending a Waiter
52
+ # To modify the behavior of waiters, you can register callbacks that are
53
+ # triggered before each polling attempt and before waiting.
54
+ #
55
+ # The following example implements an exponential backoff in a waiter
56
+ # by doubling the amount of time to wait on every attempt.
57
+ #
58
+ # client.wait_until(...) do |w|
59
+ # w.interval = 0 # disable normal sleep
60
+ # w.before_wait do |n, resp|
61
+ # sleep(n ** 2)
62
+ # end
63
+ # end
64
+ #
65
+ # # Available Waiters
66
+ #
67
+ # The following table lists the valid waiter names, the operations they call,
68
+ # and the default `:delay` and `:max_attempts` values.
69
+ #
70
+ # | waiter_name | params | :delay | :max_attempts |
71
+ # | ---------------------- | ------------------------------ | -------- | ------------- |
72
+ # | environment_exists | {Client#describe_environments} | 20 | 20 |
73
+ # | environment_terminated | {Client#describe_environments} | 20 | 20 |
74
+ # | environment_updated | {Client#describe_environments} | 20 | 20 |
75
+ #
76
+ module Waiters
77
+
78
+ class EnvironmentExists
79
+
80
+ # @param [Hash] options
81
+ # @option options [required, Client] :client
82
+ # @option options [Integer] :max_attempts (20)
83
+ # @option options [Integer] :delay (20)
84
+ # @option options [Proc] :before_attempt
85
+ # @option options [Proc] :before_wait
86
+ def initialize(options)
87
+ @client = options.fetch(:client)
88
+ @waiter = Aws::Waiters::Waiter.new({
89
+ max_attempts: 20,
90
+ delay: 20,
91
+ poller: Aws::Waiters::Poller.new(
92
+ operation_name: :describe_environments,
93
+ acceptors: [
94
+ {
95
+ "state" => "success",
96
+ "matcher" => "pathAll",
97
+ "argument" => "environments[].status",
98
+ "expected" => "Ready"
99
+ },
100
+ {
101
+ "state" => "retry",
102
+ "matcher" => "pathAll",
103
+ "argument" => "environments[].status",
104
+ "expected" => "Launching"
105
+ }
106
+ ]
107
+ )
108
+ }.merge(options))
109
+ end
110
+
111
+ # @option (see Client#describe_environments)
112
+ # @return (see Client#describe_environments)
113
+ def wait(params = {})
114
+ @waiter.wait(client: @client, params: params)
115
+ end
116
+
117
+ # @api private
118
+ attr_reader :waiter
119
+
120
+ end
121
+
122
+ class EnvironmentTerminated
123
+
124
+ # @param [Hash] options
125
+ # @option options [required, Client] :client
126
+ # @option options [Integer] :max_attempts (20)
127
+ # @option options [Integer] :delay (20)
128
+ # @option options [Proc] :before_attempt
129
+ # @option options [Proc] :before_wait
130
+ def initialize(options)
131
+ @client = options.fetch(:client)
132
+ @waiter = Aws::Waiters::Waiter.new({
133
+ max_attempts: 20,
134
+ delay: 20,
135
+ poller: Aws::Waiters::Poller.new(
136
+ operation_name: :describe_environments,
137
+ acceptors: [
138
+ {
139
+ "state" => "success",
140
+ "matcher" => "pathAll",
141
+ "argument" => "environments[].status",
142
+ "expected" => "Terminated"
143
+ },
144
+ {
145
+ "state" => "retry",
146
+ "matcher" => "pathAll",
147
+ "argument" => "environments[].status",
148
+ "expected" => "Terminating"
149
+ }
150
+ ]
151
+ )
152
+ }.merge(options))
153
+ end
154
+
155
+ # @option (see Client#describe_environments)
156
+ # @return (see Client#describe_environments)
157
+ def wait(params = {})
158
+ @waiter.wait(client: @client, params: params)
159
+ end
160
+
161
+ # @api private
162
+ attr_reader :waiter
163
+
164
+ end
165
+
166
+ class EnvironmentUpdated
167
+
168
+ # @param [Hash] options
169
+ # @option options [required, Client] :client
170
+ # @option options [Integer] :max_attempts (20)
171
+ # @option options [Integer] :delay (20)
172
+ # @option options [Proc] :before_attempt
173
+ # @option options [Proc] :before_wait
174
+ def initialize(options)
175
+ @client = options.fetch(:client)
176
+ @waiter = Aws::Waiters::Waiter.new({
177
+ max_attempts: 20,
178
+ delay: 20,
179
+ poller: Aws::Waiters::Poller.new(
180
+ operation_name: :describe_environments,
181
+ acceptors: [
182
+ {
183
+ "state" => "success",
184
+ "matcher" => "pathAll",
185
+ "argument" => "environments[].status",
186
+ "expected" => "Ready"
187
+ },
188
+ {
189
+ "state" => "retry",
190
+ "matcher" => "pathAll",
191
+ "argument" => "environments[].status",
192
+ "expected" => "Updating"
193
+ }
194
+ ]
195
+ )
196
+ }.merge(options))
197
+ end
198
+
199
+ # @option (see Client#describe_environments)
200
+ # @return (see Client#describe_environments)
201
+ def wait(params = {})
202
+ @waiter.wait(client: @client, params: params)
203
+ end
204
+
205
+ # @api private
206
+ attr_reader :waiter
207
+
208
+ end
209
+ end
210
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-elasticbeanstalk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.33.0
4
+ version: 1.38.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-23 00:00:00.000000000 Z
11
+ date: 2020-09-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.99.0
22
+ version: 3.109.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.99.0
32
+ version: 3.109.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -59,6 +59,7 @@ files:
59
59
  - lib/aws-sdk-elasticbeanstalk/errors.rb
60
60
  - lib/aws-sdk-elasticbeanstalk/resource.rb
61
61
  - lib/aws-sdk-elasticbeanstalk/types.rb
62
+ - lib/aws-sdk-elasticbeanstalk/waiters.rb
62
63
  homepage: https://github.com/aws/aws-sdk-ruby
63
64
  licenses:
64
65
  - Apache-2.0