aws-sdk-iam 1.34.0 → 1.35.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.
@@ -169,7 +169,8 @@ module Aws::IAM
169
169
  # Waiter polls an API operation until a resource enters a desired
170
170
  # state.
171
171
  #
172
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
172
+ # @note The waiting operation is performed on a copy. The original resource
173
+ # remains unchanged.
173
174
  #
174
175
  # ## Basic Usage
175
176
  #
@@ -182,13 +183,15 @@ module Aws::IAM
182
183
  #
183
184
  # ## Example
184
185
  #
185
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
186
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
187
+ # instance.state.name == 'running'
188
+ # end
186
189
  #
187
190
  # ## Configuration
188
191
  #
189
192
  # You can configure the maximum number of polling attempts, and the
190
- # delay (in seconds) between each polling attempt. The waiting condition is set
191
- # by passing a block to {#wait_until}:
193
+ # delay (in seconds) between each polling attempt. The waiting condition is
194
+ # set by passing a block to {#wait_until}:
192
195
  #
193
196
  # # poll for ~25 seconds
194
197
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -219,17 +222,16 @@ module Aws::IAM
219
222
  # # resource did not enter the desired state in time
220
223
  # end
221
224
  #
225
+ # @yieldparam [Resource] resource to be used in the waiting condition.
222
226
  #
223
- # @yield param [Resource] resource to be used in the waiting condition
224
- #
225
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
226
- # because the waiter has entered a state that it will not transition
227
- # out of, preventing success.
227
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
228
+ # terminates because the waiter has entered a state that it will not
229
+ # transition out of, preventing success.
228
230
  #
229
231
  # yet successful.
230
232
  #
231
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
232
- # while polling for a resource that is not expected.
233
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
234
+ # encountered while polling for a resource that is not expected.
233
235
  #
234
236
  # @raise [NotImplementedError] Raised when the resource does not
235
237
  #
@@ -119,7 +119,8 @@ module Aws::IAM
119
119
  # Waiter polls an API operation until a resource enters a desired
120
120
  # state.
121
121
  #
122
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
122
+ # @note The waiting operation is performed on a copy. The original resource
123
+ # remains unchanged.
123
124
  #
124
125
  # ## Basic Usage
125
126
  #
@@ -132,13 +133,15 @@ module Aws::IAM
132
133
  #
133
134
  # ## Example
134
135
  #
135
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
136
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
137
+ # instance.state.name == 'running'
138
+ # end
136
139
  #
137
140
  # ## Configuration
138
141
  #
139
142
  # You can configure the maximum number of polling attempts, and the
140
- # delay (in seconds) between each polling attempt. The waiting condition is set
141
- # by passing a block to {#wait_until}:
143
+ # delay (in seconds) between each polling attempt. The waiting condition is
144
+ # set by passing a block to {#wait_until}:
142
145
  #
143
146
  # # poll for ~25 seconds
144
147
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -169,17 +172,16 @@ module Aws::IAM
169
172
  # # resource did not enter the desired state in time
170
173
  # end
171
174
  #
175
+ # @yieldparam [Resource] resource to be used in the waiting condition.
172
176
  #
173
- # @yield param [Resource] resource to be used in the waiting condition
174
- #
175
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
176
- # because the waiter has entered a state that it will not transition
177
- # out of, preventing success.
177
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
178
+ # terminates because the waiter has entered a state that it will not
179
+ # transition out of, preventing success.
178
180
  #
179
181
  # yet successful.
180
182
  #
181
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
182
- # while polling for a resource that is not expected.
183
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
184
+ # encountered while polling for a resource that is not expected.
183
185
  #
184
186
  # @raise [NotImplementedError] Raised when the resource does not
185
187
  #
@@ -95,7 +95,8 @@ module Aws::IAM
95
95
  # Waiter polls an API operation until a resource enters a desired
96
96
  # state.
97
97
  #
98
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
98
+ # @note The waiting operation is performed on a copy. The original resource
99
+ # remains unchanged.
99
100
  #
100
101
  # ## Basic Usage
101
102
  #
@@ -108,13 +109,15 @@ module Aws::IAM
108
109
  #
109
110
  # ## Example
110
111
  #
111
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
112
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
113
+ # instance.state.name == 'running'
114
+ # end
112
115
  #
113
116
  # ## Configuration
114
117
  #
115
118
  # You can configure the maximum number of polling attempts, and the
116
- # delay (in seconds) between each polling attempt. The waiting condition is set
117
- # by passing a block to {#wait_until}:
119
+ # delay (in seconds) between each polling attempt. The waiting condition is
120
+ # set by passing a block to {#wait_until}:
118
121
  #
119
122
  # # poll for ~25 seconds
120
123
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -145,17 +148,16 @@ module Aws::IAM
145
148
  # # resource did not enter the desired state in time
146
149
  # end
147
150
  #
151
+ # @yieldparam [Resource] resource to be used in the waiting condition.
148
152
  #
149
- # @yield param [Resource] resource to be used in the waiting condition
150
- #
151
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
152
- # because the waiter has entered a state that it will not transition
153
- # out of, preventing success.
153
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
154
+ # terminates because the waiter has entered a state that it will not
155
+ # transition out of, preventing success.
154
156
  #
155
157
  # yet successful.
156
158
  #
157
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
158
- # while polling for a resource that is not expected.
159
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
160
+ # encountered while polling for a resource that is not expected.
159
161
  #
160
162
  # @raise [NotImplementedError] Raised when the resource does not
161
163
  #
@@ -145,7 +145,8 @@ module Aws::IAM
145
145
  # Waiter polls an API operation until a resource enters a desired
146
146
  # state.
147
147
  #
148
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
148
+ # @note The waiting operation is performed on a copy. The original resource
149
+ # remains unchanged.
149
150
  #
150
151
  # ## Basic Usage
151
152
  #
@@ -158,13 +159,15 @@ module Aws::IAM
158
159
  #
159
160
  # ## Example
160
161
  #
161
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
162
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
163
+ # instance.state.name == 'running'
164
+ # end
162
165
  #
163
166
  # ## Configuration
164
167
  #
165
168
  # You can configure the maximum number of polling attempts, and the
166
- # delay (in seconds) between each polling attempt. The waiting condition is set
167
- # by passing a block to {#wait_until}:
169
+ # delay (in seconds) between each polling attempt. The waiting condition is
170
+ # set by passing a block to {#wait_until}:
168
171
  #
169
172
  # # poll for ~25 seconds
170
173
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -195,17 +198,16 @@ module Aws::IAM
195
198
  # # resource did not enter the desired state in time
196
199
  # end
197
200
  #
201
+ # @yieldparam [Resource] resource to be used in the waiting condition.
198
202
  #
199
- # @yield param [Resource] resource to be used in the waiting condition
200
- #
201
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
202
- # because the waiter has entered a state that it will not transition
203
- # out of, preventing success.
203
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
204
+ # terminates because the waiter has entered a state that it will not
205
+ # transition out of, preventing success.
204
206
  #
205
207
  # yet successful.
206
208
  #
207
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
208
- # while polling for a resource that is not expected.
209
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
210
+ # encountered while polling for a resource that is not expected.
209
211
  #
210
212
  # @raise [NotImplementedError] Raised when the resource does not
211
213
  #
@@ -342,7 +344,9 @@ module Aws::IAM
342
344
  end
343
345
 
344
346
  def separate_params_and_options(options)
345
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
347
+ opts = Set.new(
348
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
349
+ )
346
350
  waiter_opts = {}
347
351
  waiter_params = {}
348
352
  options.each_pair do |key, value|
@@ -85,7 +85,8 @@ module Aws::IAM
85
85
  # Waiter polls an API operation until a resource enters a desired
86
86
  # state.
87
87
  #
88
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
88
+ # @note The waiting operation is performed on a copy. The original resource
89
+ # remains unchanged.
89
90
  #
90
91
  # ## Basic Usage
91
92
  #
@@ -98,13 +99,15 @@ module Aws::IAM
98
99
  #
99
100
  # ## Example
100
101
  #
101
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
102
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
103
+ # instance.state.name == 'running'
104
+ # end
102
105
  #
103
106
  # ## Configuration
104
107
  #
105
108
  # You can configure the maximum number of polling attempts, and the
106
- # delay (in seconds) between each polling attempt. The waiting condition is set
107
- # by passing a block to {#wait_until}:
109
+ # delay (in seconds) between each polling attempt. The waiting condition is
110
+ # set by passing a block to {#wait_until}:
108
111
  #
109
112
  # # poll for ~25 seconds
110
113
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -135,17 +138,16 @@ module Aws::IAM
135
138
  # # resource did not enter the desired state in time
136
139
  # end
137
140
  #
141
+ # @yieldparam [Resource] resource to be used in the waiting condition.
138
142
  #
139
- # @yield param [Resource] resource to be used in the waiting condition
140
- #
141
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
142
- # because the waiter has entered a state that it will not transition
143
- # out of, preventing success.
143
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
144
+ # terminates because the waiter has entered a state that it will not
145
+ # transition out of, preventing success.
144
146
  #
145
147
  # yet successful.
146
148
  #
147
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
148
- # while polling for a resource that is not expected.
149
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
150
+ # encountered while polling for a resource that is not expected.
149
151
  #
150
152
  # @raise [NotImplementedError] Raised when the resource does not
151
153
  #
@@ -81,7 +81,8 @@ module Aws::IAM
81
81
  # Waiter polls an API operation until a resource enters a desired
82
82
  # state.
83
83
  #
84
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
84
+ # @note The waiting operation is performed on a copy. The original resource
85
+ # remains unchanged.
85
86
  #
86
87
  # ## Basic Usage
87
88
  #
@@ -94,13 +95,15 @@ module Aws::IAM
94
95
  #
95
96
  # ## Example
96
97
  #
97
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
98
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
99
+ # instance.state.name == 'running'
100
+ # end
98
101
  #
99
102
  # ## Configuration
100
103
  #
101
104
  # You can configure the maximum number of polling attempts, and the
102
- # delay (in seconds) between each polling attempt. The waiting condition is set
103
- # by passing a block to {#wait_until}:
105
+ # delay (in seconds) between each polling attempt. The waiting condition is
106
+ # set by passing a block to {#wait_until}:
104
107
  #
105
108
  # # poll for ~25 seconds
106
109
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -131,17 +134,16 @@ module Aws::IAM
131
134
  # # resource did not enter the desired state in time
132
135
  # end
133
136
  #
137
+ # @yieldparam [Resource] resource to be used in the waiting condition.
134
138
  #
135
- # @yield param [Resource] resource to be used in the waiting condition
136
- #
137
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
138
- # because the waiter has entered a state that it will not transition
139
- # out of, preventing success.
139
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
140
+ # terminates because the waiter has entered a state that it will not
141
+ # transition out of, preventing success.
140
142
  #
141
143
  # yet successful.
142
144
  #
143
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
144
- # while polling for a resource that is not expected.
145
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
146
+ # encountered while polling for a resource that is not expected.
145
147
  #
146
148
  # @raise [NotImplementedError] Raised when the resource does not
147
149
  #
@@ -175,7 +175,8 @@ module Aws::IAM
175
175
  # Waiter polls an API operation until a resource enters a desired
176
176
  # state.
177
177
  #
178
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
178
+ # @note The waiting operation is performed on a copy. The original resource
179
+ # remains unchanged.
179
180
  #
180
181
  # ## Basic Usage
181
182
  #
@@ -188,13 +189,15 @@ module Aws::IAM
188
189
  #
189
190
  # ## Example
190
191
  #
191
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
192
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
193
+ # instance.state.name == 'running'
194
+ # end
192
195
  #
193
196
  # ## Configuration
194
197
  #
195
198
  # You can configure the maximum number of polling attempts, and the
196
- # delay (in seconds) between each polling attempt. The waiting condition is set
197
- # by passing a block to {#wait_until}:
199
+ # delay (in seconds) between each polling attempt. The waiting condition is
200
+ # set by passing a block to {#wait_until}:
198
201
  #
199
202
  # # poll for ~25 seconds
200
203
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -225,17 +228,16 @@ module Aws::IAM
225
228
  # # resource did not enter the desired state in time
226
229
  # end
227
230
  #
231
+ # @yieldparam [Resource] resource to be used in the waiting condition.
228
232
  #
229
- # @yield param [Resource] resource to be used in the waiting condition
230
- #
231
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
232
- # because the waiter has entered a state that it will not transition
233
- # out of, preventing success.
233
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
234
+ # terminates because the waiter has entered a state that it will not
235
+ # transition out of, preventing success.
234
236
  #
235
237
  # yet successful.
236
238
  #
237
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
238
- # while polling for a resource that is not expected.
239
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
240
+ # encountered while polling for a resource that is not expected.
239
241
  #
240
242
  # @raise [NotImplementedError] Raised when the resource does not
241
243
  #
@@ -123,7 +123,8 @@ module Aws::IAM
123
123
  # Waiter polls an API operation until a resource enters a desired
124
124
  # state.
125
125
  #
126
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
126
+ # @note The waiting operation is performed on a copy. The original resource
127
+ # remains unchanged.
127
128
  #
128
129
  # ## Basic Usage
129
130
  #
@@ -136,13 +137,15 @@ module Aws::IAM
136
137
  #
137
138
  # ## Example
138
139
  #
139
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
140
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
141
+ # instance.state.name == 'running'
142
+ # end
140
143
  #
141
144
  # ## Configuration
142
145
  #
143
146
  # You can configure the maximum number of polling attempts, and the
144
- # delay (in seconds) between each polling attempt. The waiting condition is set
145
- # by passing a block to {#wait_until}:
147
+ # delay (in seconds) between each polling attempt. The waiting condition is
148
+ # set by passing a block to {#wait_until}:
146
149
  #
147
150
  # # poll for ~25 seconds
148
151
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -173,17 +176,16 @@ module Aws::IAM
173
176
  # # resource did not enter the desired state in time
174
177
  # end
175
178
  #
179
+ # @yieldparam [Resource] resource to be used in the waiting condition.
176
180
  #
177
- # @yield param [Resource] resource to be used in the waiting condition
178
- #
179
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
180
- # because the waiter has entered a state that it will not transition
181
- # out of, preventing success.
181
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
182
+ # terminates because the waiter has entered a state that it will not
183
+ # transition out of, preventing success.
182
184
  #
183
185
  # yet successful.
184
186
  #
185
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
186
- # while polling for a resource that is not expected.
187
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
188
+ # encountered while polling for a resource that is not expected.
187
189
  #
188
190
  # @raise [NotImplementedError] Raised when the resource does not
189
191
  #
@@ -6,13 +6,18 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::IAM
9
+
9
10
  # This class provides a resource oriented interface for IAM.
10
11
  # To create a resource object:
12
+ #
11
13
  # resource = Aws::IAM::Resource.new(region: 'us-west-2')
14
+ #
12
15
  # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
16
+ # If you do not pass `:client`, a default client will be constructed.
17
+ #
14
18
  # client = Aws::IAM::Client.new(region: 'us-west-2')
15
19
  # resource = Aws::IAM::Resource.new(client: client)
20
+ #
16
21
  class Resource
17
22
 
18
23
  # @param options ({})