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