aws-sdk-s3 1.61.1 → 1.61.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/bucket.rb +16 -12
- data/lib/aws-sdk-s3/bucket_acl.rb +13 -11
- data/lib/aws-sdk-s3/bucket_cors.rb +13 -11
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +13 -11
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +13 -11
- data/lib/aws-sdk-s3/bucket_logging.rb +13 -11
- data/lib/aws-sdk-s3/bucket_notification.rb +13 -11
- data/lib/aws-sdk-s3/bucket_policy.rb +13 -11
- data/lib/aws-sdk-s3/bucket_request_payment.rb +13 -11
- data/lib/aws-sdk-s3/bucket_tagging.rb +13 -11
- data/lib/aws-sdk-s3/bucket_versioning.rb +13 -11
- data/lib/aws-sdk-s3/bucket_website.rb +13 -11
- data/lib/aws-sdk-s3/client.rb +49 -24
- data/lib/aws-sdk-s3/multipart_upload.rb +13 -11
- data/lib/aws-sdk-s3/multipart_upload_part.rb +13 -11
- data/lib/aws-sdk-s3/object.rb +16 -12
- data/lib/aws-sdk-s3/object_acl.rb +13 -11
- data/lib/aws-sdk-s3/object_summary.rb +16 -12
- data/lib/aws-sdk-s3/object_version.rb +13 -11
- data/lib/aws-sdk-s3/plugins/md5s.rb +2 -0
- data/lib/aws-sdk-s3/resource.rb +6 -1
- data/lib/aws-sdk-s3/waiters.rb +64 -0
- metadata +4 -3
@@ -78,7 +78,8 @@ module Aws::S3
|
|
78
78
|
# Waiter polls an API operation until a resource enters a desired
|
79
79
|
# state.
|
80
80
|
#
|
81
|
-
# @note The waiting operation is performed on a copy. The original resource
|
81
|
+
# @note The waiting operation is performed on a copy. The original resource
|
82
|
+
# remains unchanged.
|
82
83
|
#
|
83
84
|
# ## Basic Usage
|
84
85
|
#
|
@@ -91,13 +92,15 @@ module Aws::S3
|
|
91
92
|
#
|
92
93
|
# ## Example
|
93
94
|
#
|
94
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
95
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
96
|
+
# instance.state.name == 'running'
|
97
|
+
# end
|
95
98
|
#
|
96
99
|
# ## Configuration
|
97
100
|
#
|
98
101
|
# You can configure the maximum number of polling attempts, and the
|
99
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
100
|
-
# by passing a block to {#wait_until}:
|
102
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
103
|
+
# set by passing a block to {#wait_until}:
|
101
104
|
#
|
102
105
|
# # poll for ~25 seconds
|
103
106
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -128,17 +131,16 @@ module Aws::S3
|
|
128
131
|
# # resource did not enter the desired state in time
|
129
132
|
# end
|
130
133
|
#
|
134
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
131
135
|
#
|
132
|
-
# @
|
133
|
-
#
|
134
|
-
#
|
135
|
-
# because the waiter has entered a state that it will not transition
|
136
|
-
# out of, preventing success.
|
136
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
137
|
+
# terminates because the waiter has entered a state that it will not
|
138
|
+
# transition out of, preventing success.
|
137
139
|
#
|
138
140
|
# yet successful.
|
139
141
|
#
|
140
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
141
|
-
# while polling for a resource that is not expected.
|
142
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
143
|
+
# encountered while polling for a resource that is not expected.
|
142
144
|
#
|
143
145
|
# @raise [NotImplementedError] Raised when the resource does not
|
144
146
|
#
|
@@ -78,7 +78,8 @@ module Aws::S3
|
|
78
78
|
# Waiter polls an API operation until a resource enters a desired
|
79
79
|
# state.
|
80
80
|
#
|
81
|
-
# @note The waiting operation is performed on a copy. The original resource
|
81
|
+
# @note The waiting operation is performed on a copy. The original resource
|
82
|
+
# remains unchanged.
|
82
83
|
#
|
83
84
|
# ## Basic Usage
|
84
85
|
#
|
@@ -91,13 +92,15 @@ module Aws::S3
|
|
91
92
|
#
|
92
93
|
# ## Example
|
93
94
|
#
|
94
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
95
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
96
|
+
# instance.state.name == 'running'
|
97
|
+
# end
|
95
98
|
#
|
96
99
|
# ## Configuration
|
97
100
|
#
|
98
101
|
# You can configure the maximum number of polling attempts, and the
|
99
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
100
|
-
# by passing a block to {#wait_until}:
|
102
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
103
|
+
# set by passing a block to {#wait_until}:
|
101
104
|
#
|
102
105
|
# # poll for ~25 seconds
|
103
106
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -128,17 +131,16 @@ module Aws::S3
|
|
128
131
|
# # resource did not enter the desired state in time
|
129
132
|
# end
|
130
133
|
#
|
134
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
131
135
|
#
|
132
|
-
# @
|
133
|
-
#
|
134
|
-
#
|
135
|
-
# because the waiter has entered a state that it will not transition
|
136
|
-
# out of, preventing success.
|
136
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
137
|
+
# terminates because the waiter has entered a state that it will not
|
138
|
+
# transition out of, preventing success.
|
137
139
|
#
|
138
140
|
# yet successful.
|
139
141
|
#
|
140
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
141
|
-
# while polling for a resource that is not expected.
|
142
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
143
|
+
# encountered while polling for a resource that is not expected.
|
142
144
|
#
|
143
145
|
# @raise [NotImplementedError] Raised when the resource does not
|
144
146
|
#
|
@@ -87,7 +87,8 @@ module Aws::S3
|
|
87
87
|
# Waiter polls an API operation until a resource enters a desired
|
88
88
|
# state.
|
89
89
|
#
|
90
|
-
# @note The waiting operation is performed on a copy. The original resource
|
90
|
+
# @note The waiting operation is performed on a copy. The original resource
|
91
|
+
# remains unchanged.
|
91
92
|
#
|
92
93
|
# ## Basic Usage
|
93
94
|
#
|
@@ -100,13 +101,15 @@ module Aws::S3
|
|
100
101
|
#
|
101
102
|
# ## Example
|
102
103
|
#
|
103
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
104
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
105
|
+
# instance.state.name == 'running'
|
106
|
+
# end
|
104
107
|
#
|
105
108
|
# ## Configuration
|
106
109
|
#
|
107
110
|
# You can configure the maximum number of polling attempts, and the
|
108
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
109
|
-
# by passing a block to {#wait_until}:
|
111
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
112
|
+
# set by passing a block to {#wait_until}:
|
110
113
|
#
|
111
114
|
# # poll for ~25 seconds
|
112
115
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -137,17 +140,16 @@ module Aws::S3
|
|
137
140
|
# # resource did not enter the desired state in time
|
138
141
|
# end
|
139
142
|
#
|
143
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
140
144
|
#
|
141
|
-
# @
|
142
|
-
#
|
143
|
-
#
|
144
|
-
# because the waiter has entered a state that it will not transition
|
145
|
-
# out of, preventing success.
|
145
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
146
|
+
# terminates because the waiter has entered a state that it will not
|
147
|
+
# transition out of, preventing success.
|
146
148
|
#
|
147
149
|
# yet successful.
|
148
150
|
#
|
149
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
150
|
-
# while polling for a resource that is not expected.
|
151
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
152
|
+
# encountered while polling for a resource that is not expected.
|
151
153
|
#
|
152
154
|
# @raise [NotImplementedError] Raised when the resource does not
|
153
155
|
#
|
@@ -98,7 +98,8 @@ module Aws::S3
|
|
98
98
|
# Waiter polls an API operation until a resource enters a desired
|
99
99
|
# state.
|
100
100
|
#
|
101
|
-
# @note The waiting operation is performed on a copy. The original resource
|
101
|
+
# @note The waiting operation is performed on a copy. The original resource
|
102
|
+
# remains unchanged.
|
102
103
|
#
|
103
104
|
# ## Basic Usage
|
104
105
|
#
|
@@ -111,13 +112,15 @@ module Aws::S3
|
|
111
112
|
#
|
112
113
|
# ## Example
|
113
114
|
#
|
114
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
115
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
116
|
+
# instance.state.name == 'running'
|
117
|
+
# end
|
115
118
|
#
|
116
119
|
# ## Configuration
|
117
120
|
#
|
118
121
|
# You can configure the maximum number of polling attempts, and the
|
119
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
120
|
-
# by passing a block to {#wait_until}:
|
122
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
123
|
+
# set by passing a block to {#wait_until}:
|
121
124
|
#
|
122
125
|
# # poll for ~25 seconds
|
123
126
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -148,17 +151,16 @@ module Aws::S3
|
|
148
151
|
# # resource did not enter the desired state in time
|
149
152
|
# end
|
150
153
|
#
|
154
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
151
155
|
#
|
152
|
-
# @
|
153
|
-
#
|
154
|
-
#
|
155
|
-
# because the waiter has entered a state that it will not transition
|
156
|
-
# out of, preventing success.
|
156
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
157
|
+
# terminates because the waiter has entered a state that it will not
|
158
|
+
# transition out of, preventing success.
|
157
159
|
#
|
158
160
|
# yet successful.
|
159
161
|
#
|
160
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
161
|
-
# while polling for a resource that is not expected.
|
162
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
163
|
+
# encountered while polling for a resource that is not expected.
|
162
164
|
#
|
163
165
|
# @raise [NotImplementedError] Raised when the resource does not
|
164
166
|
#
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -48,11 +48,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:s3)
|
|
48
48
|
module Aws::S3
|
49
49
|
# An API client for S3. To construct a client, you need to configure a `:region` and `:credentials`.
|
50
50
|
#
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
51
|
+
# client = Aws::S3::Client.new(
|
52
|
+
# region: region_name,
|
53
|
+
# credentials: credentials,
|
54
|
+
# # ...
|
55
|
+
# )
|
56
56
|
#
|
57
57
|
# For details on configuring region and credentials see
|
58
58
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -289,15 +289,19 @@ module Aws::S3
|
|
289
289
|
#
|
290
290
|
# @option options [String] :retry_mode ("legacy")
|
291
291
|
# Specifies which retry algorithm to use. Values are:
|
292
|
-
#
|
293
|
-
#
|
294
|
-
#
|
295
|
-
#
|
296
|
-
#
|
297
|
-
#
|
298
|
-
#
|
299
|
-
#
|
300
|
-
#
|
292
|
+
#
|
293
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
294
|
+
# no retry mode is provided.
|
295
|
+
#
|
296
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
297
|
+
# This includes support for retry quotas, which limit the number of
|
298
|
+
# unsuccessful retries a client can make.
|
299
|
+
#
|
300
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
301
|
+
# functionality of `standard` mode along with automatic client side
|
302
|
+
# throttling. This is a provisional mode that may change behavior
|
303
|
+
# in the future.
|
304
|
+
#
|
301
305
|
#
|
302
306
|
# @option options [String] :s3_us_east_1_regional_endpoint ("legacy")
|
303
307
|
# Passing in `regional` to enable regional endpoint for S3's `us-east-1`
|
@@ -343,8 +347,7 @@ module Aws::S3
|
|
343
347
|
#
|
344
348
|
# @option options [Integer] :http_read_timeout (60) The default
|
345
349
|
# number of seconds to wait for response data. This value can
|
346
|
-
# safely be set
|
347
|
-
# per-request on the session yielded by {#session_for}.
|
350
|
+
# safely be set per-request on the session.
|
348
351
|
#
|
349
352
|
# @option options [Float] :http_idle_timeout (5) The number of
|
350
353
|
# seconds a connection is allowed to sit idle before it is
|
@@ -356,7 +359,7 @@ module Aws::S3
|
|
356
359
|
# request body. This option has no effect unless the request has
|
357
360
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
358
361
|
# disables this behaviour. This value can safely be set per
|
359
|
-
# request on the session
|
362
|
+
# request on the session.
|
360
363
|
#
|
361
364
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
362
365
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -5318,6 +5321,12 @@ module Aws::S3
|
|
5318
5321
|
# bucket: "BucketName", # required
|
5319
5322
|
# })
|
5320
5323
|
#
|
5324
|
+
#
|
5325
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
5326
|
+
#
|
5327
|
+
# * bucket_exists
|
5328
|
+
# * bucket_not_exists
|
5329
|
+
#
|
5321
5330
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket AWS API Documentation
|
5322
5331
|
#
|
5323
5332
|
# @overload head_bucket(params = {})
|
@@ -5578,6 +5587,12 @@ module Aws::S3
|
|
5578
5587
|
# resp.object_lock_retain_until_date #=> Time
|
5579
5588
|
# resp.object_lock_legal_hold_status #=> String, one of "ON", "OFF"
|
5580
5589
|
#
|
5590
|
+
#
|
5591
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
5592
|
+
#
|
5593
|
+
# * object_exists
|
5594
|
+
# * object_not_exists
|
5595
|
+
#
|
5581
5596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject AWS API Documentation
|
5582
5597
|
#
|
5583
5598
|
# @overload head_object(params = {})
|
@@ -6033,6 +6048,8 @@ module Aws::S3
|
|
6033
6048
|
# * {Types::ListMultipartUploadsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
6034
6049
|
# * {Types::ListMultipartUploadsOutput#encoding_type #encoding_type} => String
|
6035
6050
|
#
|
6051
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6052
|
+
#
|
6036
6053
|
#
|
6037
6054
|
# @example Example: List next set of multipart uploads when previous result is truncated
|
6038
6055
|
#
|
@@ -6265,6 +6282,8 @@ module Aws::S3
|
|
6265
6282
|
# * {Types::ListObjectVersionsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
6266
6283
|
# * {Types::ListObjectVersionsOutput#encoding_type #encoding_type} => String
|
6267
6284
|
#
|
6285
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6286
|
+
#
|
6268
6287
|
#
|
6269
6288
|
# @example Example: To list object versions
|
6270
6289
|
#
|
@@ -6426,6 +6445,8 @@ module Aws::S3
|
|
6426
6445
|
# * {Types::ListObjectsOutput#common_prefixes #common_prefixes} => Array<Types::CommonPrefix>
|
6427
6446
|
# * {Types::ListObjectsOutput#encoding_type #encoding_type} => String
|
6428
6447
|
#
|
6448
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6449
|
+
#
|
6429
6450
|
#
|
6430
6451
|
# @example Example: To list objects in a bucket
|
6431
6452
|
#
|
@@ -6605,6 +6626,8 @@ module Aws::S3
|
|
6605
6626
|
# * {Types::ListObjectsV2Output#next_continuation_token #next_continuation_token} => String
|
6606
6627
|
# * {Types::ListObjectsV2Output#start_after #start_after} => String
|
6607
6628
|
#
|
6629
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6630
|
+
#
|
6608
6631
|
#
|
6609
6632
|
# @example Example: To get object list
|
6610
6633
|
#
|
@@ -6781,6 +6804,8 @@ module Aws::S3
|
|
6781
6804
|
# * {Types::ListPartsOutput#storage_class #storage_class} => String
|
6782
6805
|
# * {Types::ListPartsOutput#request_charged #request_charged} => String
|
6783
6806
|
#
|
6807
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6808
|
+
#
|
6784
6809
|
#
|
6785
6810
|
# @example Example: To list parts of a multipart upload.
|
6786
6811
|
#
|
@@ -11764,7 +11789,7 @@ module Aws::S3
|
|
11764
11789
|
params: params,
|
11765
11790
|
config: config)
|
11766
11791
|
context[:gem_name] = 'aws-sdk-s3'
|
11767
|
-
context[:gem_version] = '1.61.
|
11792
|
+
context[:gem_version] = '1.61.2'
|
11768
11793
|
Seahorse::Client::Request.new(handlers, context)
|
11769
11794
|
end
|
11770
11795
|
|
@@ -11830,12 +11855,12 @@ module Aws::S3
|
|
11830
11855
|
# The following table lists the valid waiter names, the operations they call,
|
11831
11856
|
# and the default `:delay` and `:max_attempts` values.
|
11832
11857
|
#
|
11833
|
-
# | waiter_name | params
|
11834
|
-
# | ----------------- |
|
11835
|
-
# | bucket_exists | {#head_bucket} | 5 | 20 |
|
11836
|
-
# | bucket_not_exists | {#head_bucket} | 5 | 20 |
|
11837
|
-
# | object_exists | {#head_object} | 5 | 20 |
|
11838
|
-
# | object_not_exists | {#head_object} | 5 | 20 |
|
11858
|
+
# | waiter_name | params | :delay | :max_attempts |
|
11859
|
+
# | ----------------- | -------------------- | -------- | ------------- |
|
11860
|
+
# | bucket_exists | {Client#head_bucket} | 5 | 20 |
|
11861
|
+
# | bucket_not_exists | {Client#head_bucket} | 5 | 20 |
|
11862
|
+
# | object_exists | {Client#head_object} | 5 | 20 |
|
11863
|
+
# | object_not_exists | {Client#head_object} | 5 | 20 |
|
11839
11864
|
#
|
11840
11865
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
11841
11866
|
# because the waiter has entered a state that it will not transition
|
@@ -120,7 +120,8 @@ module Aws::S3
|
|
120
120
|
# Waiter polls an API operation until a resource enters a desired
|
121
121
|
# state.
|
122
122
|
#
|
123
|
-
# @note The waiting operation is performed on a copy. The original resource
|
123
|
+
# @note The waiting operation is performed on a copy. The original resource
|
124
|
+
# remains unchanged.
|
124
125
|
#
|
125
126
|
# ## Basic Usage
|
126
127
|
#
|
@@ -133,13 +134,15 @@ module Aws::S3
|
|
133
134
|
#
|
134
135
|
# ## Example
|
135
136
|
#
|
136
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
137
|
+
# instance.wait_until(max_attempts:10, delay:5) do |instance|
|
138
|
+
# instance.state.name == 'running'
|
139
|
+
# end
|
137
140
|
#
|
138
141
|
# ## Configuration
|
139
142
|
#
|
140
143
|
# You can configure the maximum number of polling attempts, and the
|
141
|
-
# delay (in seconds) between each polling attempt. The waiting condition is
|
142
|
-
# by passing a block to {#wait_until}:
|
144
|
+
# delay (in seconds) between each polling attempt. The waiting condition is
|
145
|
+
# set by passing a block to {#wait_until}:
|
143
146
|
#
|
144
147
|
# # poll for ~25 seconds
|
145
148
|
# resource.wait_until(max_attempts:5,delay:5) {|resource|...}
|
@@ -170,17 +173,16 @@ module Aws::S3
|
|
170
173
|
# # resource did not enter the desired state in time
|
171
174
|
# end
|
172
175
|
#
|
176
|
+
# @yieldparam [Resource] resource to be used in the waiting condition.
|
173
177
|
#
|
174
|
-
# @
|
175
|
-
#
|
176
|
-
#
|
177
|
-
# because the waiter has entered a state that it will not transition
|
178
|
-
# out of, preventing success.
|
178
|
+
# @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
|
179
|
+
# terminates because the waiter has entered a state that it will not
|
180
|
+
# transition out of, preventing success.
|
179
181
|
#
|
180
182
|
# yet successful.
|
181
183
|
#
|
182
|
-
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
183
|
-
# while polling for a resource that is not expected.
|
184
|
+
# @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
|
185
|
+
# encountered while polling for a resource that is not expected.
|
184
186
|
#
|
185
187
|
# @raise [NotImplementedError] Raised when the resource does not
|
186
188
|
#
|
@@ -109,7 +109,8 @@ module Aws::S3
|
|
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
|
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::S3
|
|
122
123
|
#
|
123
124
|
# ## Example
|
124
125
|
#
|
125
|
-
# instance.wait_until(max_attempts:10, delay:5)
|
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
|
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::S3
|
|
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
|
-
# @
|
164
|
-
#
|
165
|
-
#
|
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
|
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
|
#
|