aws-sdk-s3 1.53.0 → 1.146.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (128) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +1126 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-s3/bucket.rb +778 -94
  6. data/lib/aws-sdk-s3/bucket_acl.rb +64 -18
  7. data/lib/aws-sdk-s3/bucket_cors.rb +79 -18
  8. data/lib/aws-sdk-s3/bucket_lifecycle.rb +66 -20
  9. data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +68 -20
  10. data/lib/aws-sdk-s3/bucket_logging.rb +68 -16
  11. data/lib/aws-sdk-s3/bucket_notification.rb +52 -20
  12. data/lib/aws-sdk-s3/bucket_policy.rb +107 -17
  13. data/lib/aws-sdk-s3/bucket_region_cache.rb +2 -0
  14. data/lib/aws-sdk-s3/bucket_request_payment.rb +60 -15
  15. data/lib/aws-sdk-s3/bucket_tagging.rb +71 -18
  16. data/lib/aws-sdk-s3/bucket_versioning.rb +133 -17
  17. data/lib/aws-sdk-s3/bucket_website.rb +78 -21
  18. data/lib/aws-sdk-s3/client.rb +12559 -877
  19. data/lib/aws-sdk-s3/client_api.rb +1078 -191
  20. data/lib/aws-sdk-s3/customizations/bucket.rb +56 -37
  21. data/lib/aws-sdk-s3/customizations/errors.rb +27 -0
  22. data/lib/aws-sdk-s3/customizations/multipart_upload.rb +2 -0
  23. data/lib/aws-sdk-s3/customizations/object.rb +231 -39
  24. data/lib/aws-sdk-s3/customizations/object_summary.rb +5 -0
  25. data/lib/aws-sdk-s3/customizations/types/list_object_versions_output.rb +2 -0
  26. data/lib/aws-sdk-s3/customizations/types/permanent_redirect.rb +26 -0
  27. data/lib/aws-sdk-s3/customizations.rb +11 -1
  28. data/lib/aws-sdk-s3/encryption/client.rb +25 -8
  29. data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +71 -29
  30. data/lib/aws-sdk-s3/encryption/default_cipher_provider.rb +43 -5
  31. data/lib/aws-sdk-s3/encryption/default_key_provider.rb +2 -0
  32. data/lib/aws-sdk-s3/encryption/encrypt_handler.rb +13 -2
  33. data/lib/aws-sdk-s3/encryption/errors.rb +2 -0
  34. data/lib/aws-sdk-s3/encryption/io_auth_decrypter.rb +2 -0
  35. data/lib/aws-sdk-s3/encryption/io_decrypter.rb +11 -3
  36. data/lib/aws-sdk-s3/encryption/io_encrypter.rb +2 -0
  37. data/lib/aws-sdk-s3/encryption/key_provider.rb +2 -0
  38. data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +46 -11
  39. data/lib/aws-sdk-s3/encryption/materials.rb +8 -6
  40. data/lib/aws-sdk-s3/encryption/utils.rb +25 -0
  41. data/lib/aws-sdk-s3/encryption.rb +4 -0
  42. data/lib/aws-sdk-s3/encryptionV2/client.rb +570 -0
  43. data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +223 -0
  44. data/lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb +170 -0
  45. data/lib/aws-sdk-s3/encryptionV2/default_key_provider.rb +40 -0
  46. data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +65 -0
  47. data/lib/aws-sdk-s3/encryptionV2/errors.rb +37 -0
  48. data/lib/aws-sdk-s3/encryptionV2/io_auth_decrypter.rb +58 -0
  49. data/lib/aws-sdk-s3/encryptionV2/io_decrypter.rb +37 -0
  50. data/lib/aws-sdk-s3/encryptionV2/io_encrypter.rb +73 -0
  51. data/lib/aws-sdk-s3/encryptionV2/key_provider.rb +31 -0
  52. data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +173 -0
  53. data/lib/aws-sdk-s3/encryptionV2/materials.rb +60 -0
  54. data/lib/aws-sdk-s3/encryptionV2/utils.rb +103 -0
  55. data/lib/aws-sdk-s3/encryption_v2.rb +23 -0
  56. data/lib/aws-sdk-s3/endpoint_parameters.rb +178 -0
  57. data/lib/aws-sdk-s3/endpoint_provider.rb +591 -0
  58. data/lib/aws-sdk-s3/endpoints.rb +2590 -0
  59. data/lib/aws-sdk-s3/errors.rb +123 -1
  60. data/lib/aws-sdk-s3/event_streams.rb +8 -1
  61. data/lib/aws-sdk-s3/express_credentials.rb +55 -0
  62. data/lib/aws-sdk-s3/express_credentials_cache.rb +30 -0
  63. data/lib/aws-sdk-s3/express_credentials_provider.rb +36 -0
  64. data/lib/aws-sdk-s3/file_downloader.rb +176 -44
  65. data/lib/aws-sdk-s3/file_part.rb +2 -0
  66. data/lib/aws-sdk-s3/file_uploader.rb +28 -8
  67. data/lib/aws-sdk-s3/legacy_signer.rb +17 -25
  68. data/lib/aws-sdk-s3/multipart_file_uploader.rb +68 -12
  69. data/lib/aws-sdk-s3/multipart_stream_uploader.rb +59 -20
  70. data/lib/aws-sdk-s3/multipart_upload.rb +242 -32
  71. data/lib/aws-sdk-s3/multipart_upload_error.rb +2 -0
  72. data/lib/aws-sdk-s3/multipart_upload_part.rb +367 -45
  73. data/lib/aws-sdk-s3/object.rb +2191 -227
  74. data/lib/aws-sdk-s3/object_acl.rb +103 -25
  75. data/lib/aws-sdk-s3/object_copier.rb +9 -5
  76. data/lib/aws-sdk-s3/object_multipart_copier.rb +43 -19
  77. data/lib/aws-sdk-s3/object_summary.rb +1811 -208
  78. data/lib/aws-sdk-s3/object_version.rb +452 -80
  79. data/lib/aws-sdk-s3/plugins/accelerate.rb +17 -64
  80. data/lib/aws-sdk-s3/plugins/arn.rb +70 -0
  81. data/lib/aws-sdk-s3/plugins/bucket_dns.rb +7 -43
  82. data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +20 -3
  83. data/lib/aws-sdk-s3/plugins/dualstack.rb +7 -50
  84. data/lib/aws-sdk-s3/plugins/endpoints.rb +274 -0
  85. data/lib/aws-sdk-s3/plugins/expect_100_continue.rb +5 -4
  86. data/lib/aws-sdk-s3/plugins/express_session_auth.rb +91 -0
  87. data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb +3 -1
  88. data/lib/aws-sdk-s3/plugins/http_200_errors.rb +11 -3
  89. data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +44 -0
  90. data/lib/aws-sdk-s3/plugins/location_constraint.rb +5 -1
  91. data/lib/aws-sdk-s3/plugins/md5s.rb +32 -26
  92. data/lib/aws-sdk-s3/plugins/redirects.rb +2 -0
  93. data/lib/aws-sdk-s3/plugins/s3_host_id.rb +2 -0
  94. data/lib/aws-sdk-s3/plugins/s3_signer.rb +56 -92
  95. data/lib/aws-sdk-s3/plugins/skip_whole_multipart_get_checksums.rb +31 -0
  96. data/lib/aws-sdk-s3/plugins/sse_cpk.rb +3 -1
  97. data/lib/aws-sdk-s3/plugins/streaming_retry.rb +139 -0
  98. data/lib/aws-sdk-s3/plugins/url_encoded_keys.rb +2 -0
  99. data/lib/aws-sdk-s3/presigned_post.rb +160 -99
  100. data/lib/aws-sdk-s3/presigner.rb +136 -59
  101. data/lib/aws-sdk-s3/resource.rb +120 -8
  102. data/lib/aws-sdk-s3/types.rb +11349 -4242
  103. data/lib/aws-sdk-s3/waiters.rb +67 -1
  104. data/lib/aws-sdk-s3.rb +16 -6
  105. data/sig/bucket.rbs +212 -0
  106. data/sig/bucket_acl.rbs +78 -0
  107. data/sig/bucket_cors.rbs +69 -0
  108. data/sig/bucket_lifecycle.rbs +88 -0
  109. data/sig/bucket_lifecycle_configuration.rbs +111 -0
  110. data/sig/bucket_logging.rbs +76 -0
  111. data/sig/bucket_notification.rbs +114 -0
  112. data/sig/bucket_policy.rbs +59 -0
  113. data/sig/bucket_request_payment.rbs +54 -0
  114. data/sig/bucket_tagging.rbs +65 -0
  115. data/sig/bucket_versioning.rbs +77 -0
  116. data/sig/bucket_website.rbs +93 -0
  117. data/sig/client.rbs +2360 -0
  118. data/sig/errors.rbs +34 -0
  119. data/sig/multipart_upload.rbs +110 -0
  120. data/sig/multipart_upload_part.rbs +105 -0
  121. data/sig/object.rbs +436 -0
  122. data/sig/object_acl.rbs +86 -0
  123. data/sig/object_summary.rbs +334 -0
  124. data/sig/object_version.rbs +131 -0
  125. data/sig/resource.rbs +124 -0
  126. data/sig/types.rbs +2562 -0
  127. data/sig/waiters.rbs +83 -0
  128. metadata +68 -15
@@ -1,11 +1,14 @@
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:
4
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
7
  #
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::S3
11
+
9
12
  class Bucket
10
13
 
11
14
  extend Aws::Deprecations
@@ -21,6 +24,7 @@ module Aws::S3
21
24
  @name = extract_name(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
@@ -30,7 +34,8 @@ module Aws::S3
30
34
  @name
31
35
  end
32
36
 
33
- # Date the bucket was created.
37
+ # Date the bucket was created. This date can change when making changes
38
+ # to your bucket, such as editing its bucket policy.
34
39
  # @return [Time]
35
40
  def creation_date
36
41
  data[:creation_date]
@@ -90,7 +95,9 @@ module Aws::S3
90
95
  options, params = separate_params_and_options(options)
91
96
  waiter = Waiters::BucketExists.new(options)
92
97
  yield_waiter_and_warn(waiter, &block) if block_given?
93
- waiter.wait(params.merge(bucket: @name))
98
+ Aws::Plugins::UserAgent.feature('resource') do
99
+ waiter.wait(params.merge(bucket: @name))
100
+ end
94
101
  Bucket.new({
95
102
  name: @name,
96
103
  client: @client
@@ -107,7 +114,9 @@ module Aws::S3
107
114
  options, params = separate_params_and_options(options)
108
115
  waiter = Waiters::BucketNotExists.new(options)
109
116
  yield_waiter_and_warn(waiter, &block) if block_given?
110
- waiter.wait(params.merge(bucket: @name))
117
+ Aws::Plugins::UserAgent.feature('resource') do
118
+ waiter.wait(params.merge(bucket: @name))
119
+ end
111
120
  Bucket.new({
112
121
  name: @name,
113
122
  client: @client
@@ -119,7 +128,8 @@ module Aws::S3
119
128
  # Waiter polls an API operation until a resource enters a desired
120
129
  # state.
121
130
  #
122
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
131
+ # @note The waiting operation is performed on a copy. The original resource
132
+ # remains unchanged.
123
133
  #
124
134
  # ## Basic Usage
125
135
  #
@@ -132,13 +142,15 @@ module Aws::S3
132
142
  #
133
143
  # ## Example
134
144
  #
135
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
145
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
146
+ # instance.state.name == 'running'
147
+ # end
136
148
  #
137
149
  # ## Configuration
138
150
  #
139
151
  # 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}:
152
+ # delay (in seconds) between each polling attempt. The waiting condition is
153
+ # set by passing a block to {#wait_until}:
142
154
  #
143
155
  # # poll for ~25 seconds
144
156
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -169,17 +181,16 @@ module Aws::S3
169
181
  # # resource did not enter the desired state in time
170
182
  # end
171
183
  #
184
+ # @yieldparam [Resource] resource to be used in the waiting condition.
172
185
  #
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.
186
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
187
+ # terminates because the waiter has entered a state that it will not
188
+ # transition out of, preventing success.
178
189
  #
179
190
  # yet successful.
180
191
  #
181
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
182
- # while polling for a resource that is not expected.
192
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
193
+ # encountered while polling for a resource that is not expected.
183
194
  #
184
195
  # @raise [NotImplementedError] Raised when the resource does not
185
196
  #
@@ -206,7 +217,9 @@ module Aws::S3
206
217
  :retry
207
218
  end
208
219
  end
209
- Aws::Waiters::Waiter.new(options).wait({})
220
+ Aws::Plugins::UserAgent.feature('resource') do
221
+ Aws::Waiters::Waiter.new(options).wait({})
222
+ end
210
223
  end
211
224
 
212
225
  # @!group Actions
@@ -216,7 +229,15 @@ module Aws::S3
216
229
  # bucket.create({
217
230
  # acl: "private", # accepts private, public-read, public-read-write, authenticated-read
218
231
  # create_bucket_configuration: {
219
- # location_constraint: "EU", # accepts EU, eu-west-1, us-west-1, us-west-2, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1
232
+ # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
233
+ # location: {
234
+ # type: "AvailabilityZone", # accepts AvailabilityZone
235
+ # name: "LocationNameAsString",
236
+ # },
237
+ # bucket: {
238
+ # data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone
239
+ # type: "Directory", # accepts Directory
240
+ # },
220
241
  # },
221
242
  # grant_full_control: "GrantFullControl",
222
243
  # grant_read: "GrantRead",
@@ -224,41 +245,123 @@ module Aws::S3
224
245
  # grant_write: "GrantWrite",
225
246
  # grant_write_acp: "GrantWriteACP",
226
247
  # object_lock_enabled_for_bucket: false,
248
+ # object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
227
249
  # })
228
250
  # @param [Hash] options ({})
229
251
  # @option options [String] :acl
230
252
  # The canned ACL to apply to the bucket.
253
+ #
254
+ # <note markdown="1"> This functionality is not supported for directory buckets.
255
+ #
256
+ # </note>
231
257
  # @option options [Types::CreateBucketConfiguration] :create_bucket_configuration
258
+ # The configuration information for the bucket.
232
259
  # @option options [String] :grant_full_control
233
260
  # Allows grantee the read, write, read ACP, and write ACP permissions on
234
261
  # the bucket.
262
+ #
263
+ # <note markdown="1"> This functionality is not supported for directory buckets.
264
+ #
265
+ # </note>
235
266
  # @option options [String] :grant_read
236
267
  # Allows grantee to list the objects in the bucket.
268
+ #
269
+ # <note markdown="1"> This functionality is not supported for directory buckets.
270
+ #
271
+ # </note>
237
272
  # @option options [String] :grant_read_acp
238
273
  # Allows grantee to read the bucket ACL.
274
+ #
275
+ # <note markdown="1"> This functionality is not supported for directory buckets.
276
+ #
277
+ # </note>
239
278
  # @option options [String] :grant_write
240
- # Allows grantee to create, overwrite, and delete any object in the
241
- # bucket.
279
+ # Allows grantee to create new objects in the bucket.
280
+ #
281
+ # For the bucket and object owners of existing objects, also allows
282
+ # deletions and overwrites of those objects.
283
+ #
284
+ # <note markdown="1"> This functionality is not supported for directory buckets.
285
+ #
286
+ # </note>
242
287
  # @option options [String] :grant_write_acp
243
288
  # Allows grantee to write the ACL for the applicable bucket.
289
+ #
290
+ # <note markdown="1"> This functionality is not supported for directory buckets.
291
+ #
292
+ # </note>
244
293
  # @option options [Boolean] :object_lock_enabled_for_bucket
245
- # Specifies whether you want Amazon S3 object lock to be enabled for the
246
- # new bucket.
294
+ # Specifies whether you want S3 Object Lock to be enabled for the new
295
+ # bucket.
296
+ #
297
+ # <note markdown="1"> This functionality is not supported for directory buckets.
298
+ #
299
+ # </note>
300
+ # @option options [String] :object_ownership
301
+ # The container element for object ownership for a bucket's ownership
302
+ # controls.
303
+ #
304
+ # `BucketOwnerPreferred` - Objects uploaded to the bucket change
305
+ # ownership to the bucket owner if the objects are uploaded with the
306
+ # `bucket-owner-full-control` canned ACL.
307
+ #
308
+ # `ObjectWriter` - The uploading account will own the object if the
309
+ # object is uploaded with the `bucket-owner-full-control` canned ACL.
310
+ #
311
+ # `BucketOwnerEnforced` - Access control lists (ACLs) are disabled and
312
+ # no longer affect permissions. The bucket owner automatically owns and
313
+ # has full control over every object in the bucket. The bucket only
314
+ # accepts PUT requests that don't specify an ACL or specify bucket
315
+ # owner full control ACLs (such as the predefined
316
+ # `bucket-owner-full-control` canned ACL or a custom ACL in XML format
317
+ # that grants the same permissions).
318
+ #
319
+ # By default, `ObjectOwnership` is set to `BucketOwnerEnforced` and ACLs
320
+ # are disabled. We recommend keeping ACLs disabled, except in uncommon
321
+ # use cases where you must control access for each object individually.
322
+ # For more information about S3 Object Ownership, see [Controlling
323
+ # ownership of objects and disabling ACLs for your bucket][1] in the
324
+ # *Amazon S3 User Guide*.
325
+ #
326
+ # <note markdown="1"> This functionality is not supported for directory buckets. Directory
327
+ # buckets use the bucket owner enforced setting for S3 Object Ownership.
328
+ #
329
+ # </note>
330
+ #
331
+ #
332
+ #
333
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
247
334
  # @return [Types::CreateBucketOutput]
248
335
  def create(options = {})
249
336
  options = options.merge(bucket: @name)
250
- resp = @client.create_bucket(options)
337
+ resp = Aws::Plugins::UserAgent.feature('resource') do
338
+ @client.create_bucket(options)
339
+ end
251
340
  resp.data
252
341
  end
253
342
 
254
343
  # @example Request syntax with placeholder values
255
344
  #
256
- # bucket.delete()
345
+ # bucket.delete({
346
+ # expected_bucket_owner: "AccountId",
347
+ # })
257
348
  # @param [Hash] options ({})
349
+ # @option options [String] :expected_bucket_owner
350
+ # The account ID of the expected bucket owner. If the account ID that
351
+ # you provide does not match the actual owner of the bucket, the request
352
+ # fails with the HTTP status code `403 Forbidden` (access denied).
353
+ #
354
+ # <note markdown="1"> For directory buckets, this header is not supported in this API
355
+ # operation. If you specify this header, the request fails with the HTTP
356
+ # status code `501 Not Implemented`.
357
+ #
358
+ # </note>
258
359
  # @return [EmptyStructure]
259
360
  def delete(options = {})
260
361
  options = options.merge(bucket: @name)
261
- resp = @client.delete_bucket(options)
362
+ resp = Aws::Plugins::UserAgent.feature('resource') do
363
+ @client.delete_bucket(options)
364
+ end
262
365
  resp.data
263
366
  end
264
367
 
@@ -277,26 +380,102 @@ module Aws::S3
277
380
  # mfa: "MFA",
278
381
  # request_payer: "requester", # accepts requester
279
382
  # bypass_governance_retention: false,
383
+ # expected_bucket_owner: "AccountId",
384
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
280
385
  # })
281
386
  # @param [Hash] options ({})
282
387
  # @option options [required, Types::Delete] :delete
388
+ # Container for the request.
283
389
  # @option options [String] :mfa
284
390
  # The concatenation of the authentication device's serial number, a
285
391
  # space, and the value that is displayed on your authentication device.
392
+ # Required to permanently delete a versioned object if versioning is
393
+ # configured with MFA delete enabled.
394
+ #
395
+ # When performing the `DeleteObjects` operation on an MFA delete enabled
396
+ # bucket, which attempts to delete the specified versioned objects, you
397
+ # must include an MFA token. If you don't provide an MFA token, the
398
+ # entire request will fail, even if there are non-versioned objects that
399
+ # you are trying to delete. If you provide an invalid token, whether
400
+ # there are versioned object keys in the request or not, the entire
401
+ # Multi-Object Delete request will fail. For information about MFA
402
+ # Delete, see [ MFA Delete][1] in the *Amazon S3 User Guide*.
403
+ #
404
+ # <note markdown="1"> This functionality is not supported for directory buckets.
405
+ #
406
+ # </note>
407
+ #
408
+ #
409
+ #
410
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
286
411
  # @option options [String] :request_payer
287
- # Confirms that the requester knows that she or he will be charged for
288
- # the request. Bucket owners need not specify this parameter in their
289
- # requests. Documentation on downloading objects from requester pays
290
- # buckets can be found at
291
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
412
+ # Confirms that the requester knows that they will be charged for the
413
+ # request. Bucket owners need not specify this parameter in their
414
+ # requests. If either the source or destination S3 bucket has Requester
415
+ # Pays enabled, the requester will pay for corresponding charges to copy
416
+ # the object. For information about downloading objects from Requester
417
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
418
+ # in the *Amazon S3 User Guide*.
419
+ #
420
+ # <note markdown="1"> This functionality is not supported for directory buckets.
421
+ #
422
+ # </note>
423
+ #
424
+ #
425
+ #
426
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
292
427
  # @option options [Boolean] :bypass_governance_retention
293
428
  # Specifies whether you want to delete this object even if it has a
294
- # Governance-type object lock in place. You must have sufficient
295
- # permissions to perform this operation.
429
+ # Governance-type Object Lock in place. To use this header, you must
430
+ # have the `s3:BypassGovernanceRetention` permission.
431
+ #
432
+ # <note markdown="1"> This functionality is not supported for directory buckets.
433
+ #
434
+ # </note>
435
+ # @option options [String] :expected_bucket_owner
436
+ # The account ID of the expected bucket owner. If the account ID that
437
+ # you provide does not match the actual owner of the bucket, the request
438
+ # fails with the HTTP status code `403 Forbidden` (access denied).
439
+ # @option options [String] :checksum_algorithm
440
+ # Indicates the algorithm used to create the checksum for the object
441
+ # when you use the SDK. This header will not provide any additional
442
+ # functionality if you don't use the SDK. When you send this header,
443
+ # there must be a corresponding `x-amz-checksum-algorithm ` or
444
+ # `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
445
+ # with the HTTP status code `400 Bad Request`.
446
+ #
447
+ # For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
448
+ # the supported algorithm from the following list:
449
+ #
450
+ # * CRC32
451
+ #
452
+ # * CRC32C
453
+ #
454
+ # * SHA1
455
+ #
456
+ # * SHA256
457
+ #
458
+ # For more information, see [Checking object integrity][1] in the
459
+ # *Amazon S3 User Guide*.
460
+ #
461
+ # If the individual checksum value you provide through
462
+ # `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
463
+ # set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any
464
+ # provided `ChecksumAlgorithm` parameter and uses the checksum algorithm
465
+ # that matches the provided value in `x-amz-checksum-algorithm `.
466
+ #
467
+ # If you provide an individual checksum, Amazon S3 ignores any provided
468
+ # `ChecksumAlgorithm` parameter.
469
+ #
470
+ #
471
+ #
472
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
296
473
  # @return [Types::DeleteObjectsOutput]
297
474
  def delete_objects(options = {})
298
475
  options = options.merge(bucket: @name)
299
- resp = @client.delete_objects(options)
476
+ resp = Aws::Plugins::UserAgent.feature('resource') do
477
+ @client.delete_objects(options)
478
+ end
300
479
  resp.data
301
480
  end
302
481
 
@@ -312,6 +491,11 @@ module Aws::S3
312
491
  # content_length: 1,
313
492
  # content_md5: "ContentMD5",
314
493
  # content_type: "ContentType",
494
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
495
+ # checksum_crc32: "ChecksumCRC32",
496
+ # checksum_crc32c: "ChecksumCRC32C",
497
+ # checksum_sha1: "ChecksumSHA1",
498
+ # checksum_sha256: "ChecksumSHA256",
315
499
  # expires: Time.now,
316
500
  # grant_full_control: "GrantFullControl",
317
501
  # grant_read: "GrantRead",
@@ -321,110 +505,443 @@ module Aws::S3
321
505
  # metadata: {
322
506
  # "MetadataKey" => "MetadataValue",
323
507
  # },
324
- # server_side_encryption: "AES256", # accepts AES256, aws:kms
325
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
508
+ # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
509
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
326
510
  # website_redirect_location: "WebsiteRedirectLocation",
327
511
  # sse_customer_algorithm: "SSECustomerAlgorithm",
328
512
  # sse_customer_key: "SSECustomerKey",
329
513
  # sse_customer_key_md5: "SSECustomerKeyMD5",
330
514
  # ssekms_key_id: "SSEKMSKeyId",
331
515
  # ssekms_encryption_context: "SSEKMSEncryptionContext",
516
+ # bucket_key_enabled: false,
332
517
  # request_payer: "requester", # accepts requester
333
518
  # tagging: "TaggingHeader",
334
519
  # object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
335
520
  # object_lock_retain_until_date: Time.now,
336
521
  # object_lock_legal_hold_status: "ON", # accepts ON, OFF
522
+ # expected_bucket_owner: "AccountId",
337
523
  # })
338
524
  # @param [Hash] options ({})
339
525
  # @option options [String] :acl
340
- # The canned ACL to apply to the object.
341
- # @option options [String, IO] :body
526
+ # The canned ACL to apply to the object. For more information, see
527
+ # [Canned ACL][1] in the *Amazon S3 User Guide*.
528
+ #
529
+ # When adding a new object, you can use headers to grant ACL-based
530
+ # permissions to individual Amazon Web Services accounts or to
531
+ # predefined groups defined by Amazon S3. These permissions are then
532
+ # added to the ACL on the object. By default, all objects are private.
533
+ # Only the owner has full access control. For more information, see
534
+ # [Access Control List (ACL) Overview][2] and [Managing ACLs Using the
535
+ # REST API][3] in the *Amazon S3 User Guide*.
536
+ #
537
+ # If the bucket that you're uploading objects to uses the bucket owner
538
+ # enforced setting for S3 Object Ownership, ACLs are disabled and no
539
+ # longer affect permissions. Buckets that use this setting only accept
540
+ # PUT requests that don't specify an ACL or PUT requests that specify
541
+ # bucket owner full control ACLs, such as the
542
+ # `bucket-owner-full-control` canned ACL or an equivalent form of this
543
+ # ACL expressed in the XML format. PUT requests that contain other ACLs
544
+ # (for example, custom grants to certain Amazon Web Services accounts)
545
+ # fail and return a `400` error with the error code
546
+ # `AccessControlListNotSupported`. For more information, see [
547
+ # Controlling ownership of objects and disabling ACLs][4] in the *Amazon
548
+ # S3 User Guide*.
549
+ #
550
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
551
+ #
552
+ # * This functionality is not supported for Amazon S3 on Outposts.
553
+ #
554
+ # </note>
555
+ #
556
+ #
557
+ #
558
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
559
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
560
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
561
+ # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
562
+ # @option options [String, StringIO, File] :body
342
563
  # Object data.
343
564
  # @option options [String] :cache_control
344
- # Specifies caching behavior along the request/reply chain.
565
+ # Can be used to specify caching behavior along the request/reply chain.
566
+ # For more information, see
567
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
568
+ #
569
+ #
570
+ #
571
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
345
572
  # @option options [String] :content_disposition
346
- # Specifies presentational information for the object.
573
+ # Specifies presentational information for the object. For more
574
+ # information, see
575
+ # [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
576
+ #
577
+ #
578
+ #
579
+ # [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
347
580
  # @option options [String] :content_encoding
348
581
  # Specifies what content encodings have been applied to the object and
349
582
  # thus what decoding mechanisms must be applied to obtain the media-type
350
- # referenced by the Content-Type header field.
583
+ # referenced by the Content-Type header field. For more information, see
584
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
585
+ #
586
+ #
587
+ #
588
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
351
589
  # @option options [String] :content_language
352
590
  # The language the content is in.
353
591
  # @option options [Integer] :content_length
354
592
  # Size of the body in bytes. This parameter is useful when the size of
355
- # the body cannot be determined automatically.
593
+ # the body cannot be determined automatically. For more information, see
594
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
595
+ #
596
+ #
597
+ #
598
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
356
599
  # @option options [String] :content_md5
357
- # The base64-encoded 128-bit MD5 digest of the part data. This parameter
358
- # is auto-populated when using the command from the CLI. This parameted
359
- # is required if object lock parameters are specified.
600
+ # The base64-encoded 128-bit MD5 digest of the message (without the
601
+ # headers) according to RFC 1864. This header can be used as a message
602
+ # integrity check to verify that the data is the same data that was
603
+ # originally sent. Although it is optional, we recommend using the
604
+ # Content-MD5 mechanism as an end-to-end integrity check. For more
605
+ # information about REST request authentication, see [REST
606
+ # Authentication][1].
607
+ #
608
+ # <note markdown="1"> The `Content-MD5` header is required for any request to upload an
609
+ # object with a retention period configured using Amazon S3 Object Lock.
610
+ # For more information about Amazon S3 Object Lock, see [Amazon S3
611
+ # Object Lock Overview][2] in the *Amazon S3 User Guide*.
612
+ #
613
+ # </note>
614
+ #
615
+ # <note markdown="1"> This functionality is not supported for directory buckets.
616
+ #
617
+ # </note>
618
+ #
619
+ #
620
+ #
621
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
622
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
360
623
  # @option options [String] :content_type
361
- # A standard MIME type describing the format of the object data.
624
+ # A standard MIME type describing the format of the contents. For more
625
+ # information, see
626
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
627
+ #
628
+ #
629
+ #
630
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
631
+ # @option options [String] :checksum_algorithm
632
+ # Indicates the algorithm used to create the checksum for the object
633
+ # when you use the SDK. This header will not provide any additional
634
+ # functionality if you don't use the SDK. When you send this header,
635
+ # there must be a corresponding `x-amz-checksum-algorithm ` or
636
+ # `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
637
+ # with the HTTP status code `400 Bad Request`.
638
+ #
639
+ # For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
640
+ # the supported algorithm from the following list:
641
+ #
642
+ # * CRC32
643
+ #
644
+ # * CRC32C
645
+ #
646
+ # * SHA1
647
+ #
648
+ # * SHA256
649
+ #
650
+ # For more information, see [Checking object integrity][1] in the
651
+ # *Amazon S3 User Guide*.
652
+ #
653
+ # If the individual checksum value you provide through
654
+ # `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
655
+ # set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any
656
+ # provided `ChecksumAlgorithm` parameter and uses the checksum algorithm
657
+ # that matches the provided value in `x-amz-checksum-algorithm `.
658
+ #
659
+ # <note markdown="1"> For directory buckets, when you use Amazon Web Services SDKs, `CRC32`
660
+ # is the default checksum algorithm that's used for performance.
661
+ #
662
+ # </note>
663
+ #
664
+ #
665
+ #
666
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
667
+ # @option options [String] :checksum_crc32
668
+ # This header can be used as a data integrity check to verify that the
669
+ # data received is the same data that was originally sent. This header
670
+ # specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
671
+ # more information, see [Checking object integrity][1] in the *Amazon S3
672
+ # User Guide*.
673
+ #
674
+ #
675
+ #
676
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
677
+ # @option options [String] :checksum_crc32c
678
+ # This header can be used as a data integrity check to verify that the
679
+ # data received is the same data that was originally sent. This header
680
+ # specifies the base64-encoded, 32-bit CRC32C checksum of the object.
681
+ # For more information, see [Checking object integrity][1] in the
682
+ # *Amazon S3 User Guide*.
683
+ #
684
+ #
685
+ #
686
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
687
+ # @option options [String] :checksum_sha1
688
+ # This header can be used as a data integrity check to verify that the
689
+ # data received is the same data that was originally sent. This header
690
+ # specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
691
+ # more information, see [Checking object integrity][1] in the *Amazon S3
692
+ # User Guide*.
693
+ #
694
+ #
695
+ #
696
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
697
+ # @option options [String] :checksum_sha256
698
+ # This header can be used as a data integrity check to verify that the
699
+ # data received is the same data that was originally sent. This header
700
+ # specifies the base64-encoded, 256-bit SHA-256 digest of the object.
701
+ # For more information, see [Checking object integrity][1] in the
702
+ # *Amazon S3 User Guide*.
703
+ #
704
+ #
705
+ #
706
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
362
707
  # @option options [Time,DateTime,Date,Integer,String] :expires
363
- # The date and time at which the object is no longer cacheable.
708
+ # The date and time at which the object is no longer cacheable. For more
709
+ # information, see
710
+ # [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
711
+ #
712
+ #
713
+ #
714
+ # [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
364
715
  # @option options [String] :grant_full_control
365
716
  # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
366
717
  # object.
718
+ #
719
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
720
+ #
721
+ # * This functionality is not supported for Amazon S3 on Outposts.
722
+ #
723
+ # </note>
367
724
  # @option options [String] :grant_read
368
725
  # Allows grantee to read the object data and its metadata.
726
+ #
727
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
728
+ #
729
+ # * This functionality is not supported for Amazon S3 on Outposts.
730
+ #
731
+ # </note>
369
732
  # @option options [String] :grant_read_acp
370
733
  # Allows grantee to read the object ACL.
734
+ #
735
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
736
+ #
737
+ # * This functionality is not supported for Amazon S3 on Outposts.
738
+ #
739
+ # </note>
371
740
  # @option options [String] :grant_write_acp
372
741
  # Allows grantee to write the ACL for the applicable object.
742
+ #
743
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
744
+ #
745
+ # * This functionality is not supported for Amazon S3 on Outposts.
746
+ #
747
+ # </note>
373
748
  # @option options [required, String] :key
374
- # Object key for which the PUT operation was initiated.
749
+ # Object key for which the PUT action was initiated.
375
750
  # @option options [Hash<String,String>] :metadata
376
751
  # A map of metadata to store with the object in S3.
377
752
  # @option options [String] :server_side_encryption
378
- # The Server-side encryption algorithm used when storing this object in
379
- # S3 (e.g., AES256, aws:kms).
753
+ # The server-side encryption algorithm that was used when you store this
754
+ # object in Amazon S3 (for example, `AES256`, `aws:kms`,
755
+ # `aws:kms:dsse`).
756
+ #
757
+ # <b>General purpose buckets </b> - You have four mutually exclusive
758
+ # options to protect data using server-side encryption in Amazon S3,
759
+ # depending on how you choose to manage the encryption keys.
760
+ # Specifically, the encryption key options are Amazon S3 managed keys
761
+ # (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
762
+ # customer-provided keys (SSE-C). Amazon S3 encrypts data with
763
+ # server-side encryption by using Amazon S3 managed keys (SSE-S3) by
764
+ # default. You can optionally tell Amazon S3 to encrypt data at rest by
765
+ # using server-side encryption with other key options. For more
766
+ # information, see [Using Server-Side Encryption][1] in the *Amazon S3
767
+ # User Guide*.
768
+ #
769
+ # <b>Directory buckets </b> - For directory buckets, only the
770
+ # server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`)
771
+ # value is supported.
772
+ #
773
+ #
774
+ #
775
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
380
776
  # @option options [String] :storage_class
381
- # The type of storage to use for the object. Defaults to 'STANDARD'.
777
+ # By default, Amazon S3 uses the STANDARD Storage Class to store newly
778
+ # created objects. The STANDARD storage class provides high durability
779
+ # and high availability. Depending on performance needs, you can specify
780
+ # a different Storage Class. For more information, see [Storage
781
+ # Classes][1] in the *Amazon S3 User Guide*.
782
+ #
783
+ # <note markdown="1"> * For directory buckets, only the S3 Express One Zone storage class is
784
+ # supported to store newly created objects.
785
+ #
786
+ # * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
787
+ #
788
+ # </note>
789
+ #
790
+ #
791
+ #
792
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
382
793
  # @option options [String] :website_redirect_location
383
794
  # If the bucket is configured as a website, redirects requests for this
384
795
  # object to another object in the same bucket or to an external URL.
385
- # Amazon S3 stores the value of this header in the object metadata.
796
+ # Amazon S3 stores the value of this header in the object metadata. For
797
+ # information about object metadata, see [Object Key and Metadata][1] in
798
+ # the *Amazon S3 User Guide*.
799
+ #
800
+ # In the following example, the request header sets the redirect to an
801
+ # object (anotherPage.html) in the same bucket:
802
+ #
803
+ # `x-amz-website-redirect-location: /anotherPage.html`
804
+ #
805
+ # In the following example, the request header sets the object redirect
806
+ # to another website:
807
+ #
808
+ # `x-amz-website-redirect-location: http://www.example.com/`
809
+ #
810
+ # For more information about website hosting in Amazon S3, see [Hosting
811
+ # Websites on Amazon S3][2] and [How to Configure Website Page
812
+ # Redirects][3] in the *Amazon S3 User Guide*.
813
+ #
814
+ # <note markdown="1"> This functionality is not supported for directory buckets.
815
+ #
816
+ # </note>
817
+ #
818
+ #
819
+ #
820
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
821
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
822
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
386
823
  # @option options [String] :sse_customer_algorithm
387
- # Specifies the algorithm to use to when encrypting the object (e.g.,
388
- # AES256).
824
+ # Specifies the algorithm to use when encrypting the object (for
825
+ # example, `AES256`).
826
+ #
827
+ # <note markdown="1"> This functionality is not supported for directory buckets.
828
+ #
829
+ # </note>
389
830
  # @option options [String] :sse_customer_key
390
831
  # Specifies the customer-provided encryption key for Amazon S3 to use in
391
832
  # encrypting data. This value is used to store the object and then it is
392
- # discarded; Amazon does not store the encryption key. The key must be
393
- # appropriate for use with the algorithm specified in the
394
- # x-amz-server-side​-encryption​-customer-algorithm header.
833
+ # discarded; Amazon S3 does not store the encryption key. The key must
834
+ # be appropriate for use with the algorithm specified in the
835
+ # `x-amz-server-side-encryption-customer-algorithm` header.
836
+ #
837
+ # <note markdown="1"> This functionality is not supported for directory buckets.
838
+ #
839
+ # </note>
395
840
  # @option options [String] :sse_customer_key_md5
396
841
  # Specifies the 128-bit MD5 digest of the encryption key according to
397
842
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
398
- # ensure the encryption key was transmitted without error.
843
+ # ensure that the encryption key was transmitted without error.
844
+ #
845
+ # <note markdown="1"> This functionality is not supported for directory buckets.
846
+ #
847
+ # </note>
399
848
  # @option options [String] :ssekms_key_id
400
- # Specifies the AWS KMS key ID to use for object encryption. All GET and
401
- # PUT requests for an object protected by AWS KMS will fail if not made
402
- # via SSL or using SigV4. Documentation on configuring any of the
403
- # officially supported AWS SDKs and CLI can be found at
404
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
849
+ # If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
850
+ # `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key
851
+ # Alias) of the Key Management Service (KMS) symmetric encryption
852
+ # customer managed key that was used for the object. If you specify
853
+ # `x-amz-server-side-encryption:aws:kms` or
854
+ # `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
855
+ # x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
856
+ # Amazon Web Services managed key (`aws/s3`) to protect the data. If the
857
+ # KMS key does not exist in the same account that's issuing the
858
+ # command, you must use the full ARN and not just the ID.
859
+ #
860
+ # <note markdown="1"> This functionality is not supported for directory buckets.
861
+ #
862
+ # </note>
405
863
  # @option options [String] :ssekms_encryption_context
406
- # Specifies the AWS KMS Encryption Context to use for object encryption.
407
- # The value of this header is a base64-encoded UTF-8 string holding JSON
408
- # with the encryption context key-value pairs.
864
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
865
+ # object encryption. The value of this header is a base64-encoded UTF-8
866
+ # string holding JSON with the encryption context key-value pairs. This
867
+ # value is stored as object metadata and automatically gets passed on to
868
+ # Amazon Web Services KMS for future `GetObject` or `CopyObject`
869
+ # operations on this object. This value must be explicitly added during
870
+ # `CopyObject` operations.
871
+ #
872
+ # <note markdown="1"> This functionality is not supported for directory buckets.
873
+ #
874
+ # </note>
875
+ # @option options [Boolean] :bucket_key_enabled
876
+ # Specifies whether Amazon S3 should use an S3 Bucket Key for object
877
+ # encryption with server-side encryption using Key Management Service
878
+ # (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
879
+ # to use an S3 Bucket Key for object encryption with SSE-KMS.
880
+ #
881
+ # Specifying this header with a PUT action doesn’t affect bucket-level
882
+ # settings for S3 Bucket Key.
883
+ #
884
+ # <note markdown="1"> This functionality is not supported for directory buckets.
885
+ #
886
+ # </note>
409
887
  # @option options [String] :request_payer
410
- # Confirms that the requester knows that she or he will be charged for
411
- # the request. Bucket owners need not specify this parameter in their
412
- # requests. Documentation on downloading objects from requester pays
413
- # buckets can be found at
414
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
888
+ # Confirms that the requester knows that they will be charged for the
889
+ # request. Bucket owners need not specify this parameter in their
890
+ # requests. If either the source or destination S3 bucket has Requester
891
+ # Pays enabled, the requester will pay for corresponding charges to copy
892
+ # the object. For information about downloading objects from Requester
893
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
894
+ # in the *Amazon S3 User Guide*.
895
+ #
896
+ # <note markdown="1"> This functionality is not supported for directory buckets.
897
+ #
898
+ # </note>
899
+ #
900
+ #
901
+ #
902
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
415
903
  # @option options [String] :tagging
416
904
  # The tag-set for the object. The tag-set must be encoded as URL Query
417
905
  # parameters. (For example, "Key1=Value1")
906
+ #
907
+ # <note markdown="1"> This functionality is not supported for directory buckets.
908
+ #
909
+ # </note>
418
910
  # @option options [String] :object_lock_mode
419
- # The object lock mode that you want to apply to this object.
911
+ # The Object Lock mode that you want to apply to this object.
912
+ #
913
+ # <note markdown="1"> This functionality is not supported for directory buckets.
914
+ #
915
+ # </note>
420
916
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
421
- # The date and time when you want this object's object lock to expire.
917
+ # The date and time when you want this object's Object Lock to expire.
918
+ # Must be formatted as a timestamp parameter.
919
+ #
920
+ # <note markdown="1"> This functionality is not supported for directory buckets.
921
+ #
922
+ # </note>
422
923
  # @option options [String] :object_lock_legal_hold_status
423
- # The Legal Hold status that you want to apply to the specified object.
924
+ # Specifies whether a legal hold will be applied to this object. For
925
+ # more information about S3 Object Lock, see [Object Lock][1] in the
926
+ # *Amazon S3 User Guide*.
927
+ #
928
+ # <note markdown="1"> This functionality is not supported for directory buckets.
929
+ #
930
+ # </note>
931
+ #
932
+ #
933
+ #
934
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
935
+ # @option options [String] :expected_bucket_owner
936
+ # The account ID of the expected bucket owner. If the account ID that
937
+ # you provide does not match the actual owner of the bucket, the request
938
+ # fails with the HTTP status code `403 Forbidden` (access denied).
424
939
  # @return [Object]
425
940
  def put_object(options = {})
426
941
  options = options.merge(bucket: @name)
427
- resp = @client.put_object(options)
942
+ Aws::Plugins::UserAgent.feature('resource') do
943
+ @client.put_object(options)
944
+ end
428
945
  Object.new(
429
946
  bucket_name: @name,
430
947
  key: options[:key],
@@ -482,32 +999,107 @@ module Aws::S3
482
999
  # key_marker: "KeyMarker",
483
1000
  # prefix: "Prefix",
484
1001
  # upload_id_marker: "UploadIdMarker",
1002
+ # expected_bucket_owner: "AccountId",
1003
+ # request_payer: "requester", # accepts requester
485
1004
  # })
486
1005
  # @param [Hash] options ({})
487
1006
  # @option options [String] :delimiter
488
1007
  # Character you use to group keys.
1008
+ #
1009
+ # All keys that contain the same string between the prefix, if
1010
+ # specified, and the first occurrence of the delimiter after the prefix
1011
+ # are grouped under a single result element, `CommonPrefixes`. If you
1012
+ # don't specify the prefix parameter, then the substring starts at the
1013
+ # beginning of the key. The keys that are grouped under `CommonPrefixes`
1014
+ # result element are not returned elsewhere in the response.
1015
+ #
1016
+ # <note markdown="1"> **Directory buckets** - For directory buckets, `/` is the only
1017
+ # supported delimiter.
1018
+ #
1019
+ # </note>
489
1020
  # @option options [String] :encoding_type
490
1021
  # Requests Amazon S3 to encode the object keys in the response and
491
- # specifies the encoding method to use. An object key may contain any
492
- # Unicode character; however, XML 1.0 parser cannot parse some
1022
+ # specifies the encoding method to use. An object key can contain any
1023
+ # Unicode character; however, the XML 1.0 parser cannot parse some
493
1024
  # characters, such as characters with an ASCII value from 0 to 10. For
494
1025
  # characters that are not supported in XML 1.0, you can add this
495
1026
  # parameter to request that Amazon S3 encode the keys in the response.
496
1027
  # @option options [String] :key_marker
497
- # Together with upload-id-marker, this parameter specifies the multipart
498
- # upload after which listing should begin.
1028
+ # Specifies the multipart upload after which listing should begin.
1029
+ #
1030
+ # <note markdown="1"> * **General purpose buckets** - For general purpose buckets,
1031
+ # `key-marker` is an object key. Together with `upload-id-marker`,
1032
+ # this parameter specifies the multipart upload after which listing
1033
+ # should begin.
1034
+ #
1035
+ # If `upload-id-marker` is not specified, only the keys
1036
+ # lexicographically greater than the specified `key-marker` will be
1037
+ # included in the list.
1038
+ #
1039
+ # If `upload-id-marker` is specified, any multipart uploads for a key
1040
+ # equal to the `key-marker` might also be included, provided those
1041
+ # multipart uploads have upload IDs lexicographically greater than the
1042
+ # specified `upload-id-marker`.
1043
+ #
1044
+ # * **Directory buckets** - For directory buckets, `key-marker` is
1045
+ # obfuscated and isn't a real object key. The `upload-id-marker`
1046
+ # parameter isn't supported by directory buckets. To list the
1047
+ # additional multipart uploads, you only need to set the value of
1048
+ # `key-marker` to the `NextKeyMarker` value from the previous
1049
+ # response.
1050
+ #
1051
+ # In the `ListMultipartUploads` response, the multipart uploads
1052
+ # aren't sorted lexicographically based on the object keys.
1053
+ #
1054
+ # </note>
499
1055
  # @option options [String] :prefix
500
1056
  # Lists in-progress uploads only for those keys that begin with the
501
- # specified prefix.
1057
+ # specified prefix. You can use prefixes to separate a bucket into
1058
+ # different grouping of keys. (You can think of using `prefix` to make
1059
+ # groups in the same way that you'd use a folder in a file system.)
1060
+ #
1061
+ # <note markdown="1"> **Directory buckets** - For directory buckets, only prefixes that end
1062
+ # in a delimiter (`/`) are supported.
1063
+ #
1064
+ # </note>
502
1065
  # @option options [String] :upload_id_marker
503
1066
  # Together with key-marker, specifies the multipart upload after which
504
1067
  # listing should begin. If key-marker is not specified, the
505
- # upload-id-marker parameter is ignored.
1068
+ # upload-id-marker parameter is ignored. Otherwise, any multipart
1069
+ # uploads for a key equal to the key-marker might be included in the
1070
+ # list only if they have an upload ID lexicographically greater than the
1071
+ # specified `upload-id-marker`.
1072
+ #
1073
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1074
+ #
1075
+ # </note>
1076
+ # @option options [String] :expected_bucket_owner
1077
+ # The account ID of the expected bucket owner. If the account ID that
1078
+ # you provide does not match the actual owner of the bucket, the request
1079
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1080
+ # @option options [String] :request_payer
1081
+ # Confirms that the requester knows that they will be charged for the
1082
+ # request. Bucket owners need not specify this parameter in their
1083
+ # requests. If either the source or destination S3 bucket has Requester
1084
+ # Pays enabled, the requester will pay for corresponding charges to copy
1085
+ # the object. For information about downloading objects from Requester
1086
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
1087
+ # in the *Amazon S3 User Guide*.
1088
+ #
1089
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1090
+ #
1091
+ # </note>
1092
+ #
1093
+ #
1094
+ #
1095
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
506
1096
  # @return [MultipartUpload::Collection]
507
1097
  def multipart_uploads(options = {})
508
1098
  batches = Enumerator.new do |y|
509
1099
  options = options.merge(bucket: @name)
510
- resp = @client.list_multipart_uploads(options)
1100
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1101
+ @client.list_multipart_uploads(options)
1102
+ end
511
1103
  resp.each_page do |page|
512
1104
  batch = []
513
1105
  page.data.uploads.each do |u|
@@ -551,28 +1143,66 @@ module Aws::S3
551
1143
  # key_marker: "KeyMarker",
552
1144
  # prefix: "Prefix",
553
1145
  # version_id_marker: "VersionIdMarker",
1146
+ # expected_bucket_owner: "AccountId",
1147
+ # request_payer: "requester", # accepts requester
1148
+ # optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
554
1149
  # })
555
1150
  # @param [Hash] options ({})
556
1151
  # @option options [String] :delimiter
557
- # A delimiter is a character you use to group keys.
1152
+ # A delimiter is a character that you specify to group keys. All keys
1153
+ # that contain the same string between the `prefix` and the first
1154
+ # occurrence of the delimiter are grouped under a single result element
1155
+ # in `CommonPrefixes`. These groups are counted as one result against
1156
+ # the `max-keys` limitation. These keys are not returned elsewhere in
1157
+ # the response.
558
1158
  # @option options [String] :encoding_type
559
1159
  # Requests Amazon S3 to encode the object keys in the response and
560
- # specifies the encoding method to use. An object key may contain any
561
- # Unicode character; however, XML 1.0 parser cannot parse some
1160
+ # specifies the encoding method to use. An object key can contain any
1161
+ # Unicode character; however, the XML 1.0 parser cannot parse some
562
1162
  # characters, such as characters with an ASCII value from 0 to 10. For
563
1163
  # characters that are not supported in XML 1.0, you can add this
564
1164
  # parameter to request that Amazon S3 encode the keys in the response.
565
1165
  # @option options [String] :key_marker
566
1166
  # Specifies the key to start with when listing objects in a bucket.
567
1167
  # @option options [String] :prefix
568
- # Limits the response to keys that begin with the specified prefix.
1168
+ # Use this parameter to select only those keys that begin with the
1169
+ # specified prefix. You can use prefixes to separate a bucket into
1170
+ # different groupings of keys. (You can think of using `prefix` to make
1171
+ # groups in the same way that you'd use a folder in a file system.) You
1172
+ # can use `prefix` with `delimiter` to roll up numerous objects into a
1173
+ # single result under `CommonPrefixes`.
569
1174
  # @option options [String] :version_id_marker
570
1175
  # Specifies the object version you want to start listing from.
1176
+ # @option options [String] :expected_bucket_owner
1177
+ # The account ID of the expected bucket owner. If the account ID that
1178
+ # you provide does not match the actual owner of the bucket, the request
1179
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1180
+ # @option options [String] :request_payer
1181
+ # Confirms that the requester knows that they will be charged for the
1182
+ # request. Bucket owners need not specify this parameter in their
1183
+ # requests. If either the source or destination S3 bucket has Requester
1184
+ # Pays enabled, the requester will pay for corresponding charges to copy
1185
+ # the object. For information about downloading objects from Requester
1186
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
1187
+ # in the *Amazon S3 User Guide*.
1188
+ #
1189
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1190
+ #
1191
+ # </note>
1192
+ #
1193
+ #
1194
+ #
1195
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1196
+ # @option options [Array<String>] :optional_object_attributes
1197
+ # Specifies the optional fields that you want returned in the response.
1198
+ # Fields that you do not specify are not returned.
571
1199
  # @return [ObjectVersion::Collection]
572
1200
  def object_versions(options = {})
573
1201
  batches = Enumerator.new do |y|
574
1202
  options = options.merge(bucket: @name)
575
- resp = @client.list_object_versions(options)
1203
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1204
+ @client.list_object_versions(options)
1205
+ end
576
1206
  resp.each_page do |page|
577
1207
  batch = []
578
1208
  page.data.versions_delete_markers.each do |v|
@@ -599,31 +1229,83 @@ module Aws::S3
599
1229
  # fetch_owner: false,
600
1230
  # start_after: "StartAfter",
601
1231
  # request_payer: "requester", # accepts requester
1232
+ # expected_bucket_owner: "AccountId",
1233
+ # optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
602
1234
  # })
603
1235
  # @param [Hash] options ({})
604
1236
  # @option options [String] :delimiter
605
- # A delimiter is a character you use to group keys.
1237
+ # A delimiter is a character that you use to group keys.
1238
+ #
1239
+ # <note markdown="1"> * **Directory buckets** - For directory buckets, `/` is the only
1240
+ # supported delimiter.
1241
+ #
1242
+ # * <b>Directory buckets </b> - When you query `ListObjectsV2` with a
1243
+ # delimiter during in-progress multipart uploads, the `CommonPrefixes`
1244
+ # response parameter contains the prefixes that are associated with
1245
+ # the in-progress multipart uploads. For more information about
1246
+ # multipart uploads, see [Multipart Upload Overview][1] in the *Amazon
1247
+ # S3 User Guide*.
1248
+ #
1249
+ # </note>
1250
+ #
1251
+ #
1252
+ #
1253
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
606
1254
  # @option options [String] :encoding_type
607
1255
  # Encoding type used by Amazon S3 to encode object keys in the response.
1256
+ # If using `url`, non-ASCII characters used in an object's key name
1257
+ # will be URL encoded. For example, the object test\_file(3).png will
1258
+ # appear as test\_file%283%29.png.
608
1259
  # @option options [String] :prefix
609
1260
  # Limits the response to keys that begin with the specified prefix.
1261
+ #
1262
+ # <note markdown="1"> **Directory buckets** - For directory buckets, only prefixes that end
1263
+ # in a delimiter (`/`) are supported.
1264
+ #
1265
+ # </note>
610
1266
  # @option options [Boolean] :fetch_owner
611
- # The owner field is not present in listV2 by default, if you want to
612
- # return owner field with each key in the result then set the fetch
613
- # owner field to true
1267
+ # The owner field is not present in `ListObjectsV2` by default. If you
1268
+ # want to return the owner field with each key in the result, then set
1269
+ # the `FetchOwner` field to `true`.
1270
+ #
1271
+ # <note markdown="1"> **Directory buckets** - For directory buckets, the bucket owner is
1272
+ # returned as the object owner for all objects.
1273
+ #
1274
+ # </note>
614
1275
  # @option options [String] :start_after
615
1276
  # StartAfter is where you want Amazon S3 to start listing from. Amazon
616
1277
  # S3 starts listing after this specified key. StartAfter can be any key
617
- # in the bucket
1278
+ # in the bucket.
1279
+ #
1280
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1281
+ #
1282
+ # </note>
618
1283
  # @option options [String] :request_payer
619
1284
  # Confirms that the requester knows that she or he will be charged for
620
1285
  # the list objects request in V2 style. Bucket owners need not specify
621
1286
  # this parameter in their requests.
1287
+ #
1288
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1289
+ #
1290
+ # </note>
1291
+ # @option options [String] :expected_bucket_owner
1292
+ # The account ID of the expected bucket owner. If the account ID that
1293
+ # you provide does not match the actual owner of the bucket, the request
1294
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1295
+ # @option options [Array<String>] :optional_object_attributes
1296
+ # Specifies the optional fields that you want returned in the response.
1297
+ # Fields that you do not specify are not returned.
1298
+ #
1299
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1300
+ #
1301
+ # </note>
622
1302
  # @return [ObjectSummary::Collection]
623
1303
  def objects(options = {})
624
1304
  batches = Enumerator.new do |y|
625
1305
  options = options.merge(bucket: @name)
626
- resp = @client.list_objects_v2(options)
1306
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1307
+ @client.list_objects_v2(options)
1308
+ end
627
1309
  resp.each_page do |page|
628
1310
  batch = []
629
1311
  page.data.contents.each do |c|
@@ -702,8 +1384,8 @@ module Aws::S3
702
1384
 
703
1385
  def yield_waiter_and_warn(waiter, &block)
704
1386
  if !@waiter_block_warned
705
- msg = "pass options to configure the waiter; "
706
- msg << "yielding the waiter is deprecated"
1387
+ msg = "pass options to configure the waiter; "\
1388
+ "yielding the waiter is deprecated"
707
1389
  warn(msg)
708
1390
  @waiter_block_warned = true
709
1391
  end
@@ -711,7 +1393,9 @@ module Aws::S3
711
1393
  end
712
1394
 
713
1395
  def separate_params_and_options(options)
714
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
1396
+ opts = Set.new(
1397
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
1398
+ )
715
1399
  waiter_opts = {}
716
1400
  waiter_params = {}
717
1401
  options.each_pair do |key, value|