aws-sdk-s3 1.87.0 → 1.143.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (98) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1106 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-s3/bucket.rb +605 -114
  6. data/lib/aws-sdk-s3/bucket_acl.rb +36 -11
  7. data/lib/aws-sdk-s3/bucket_cors.rb +40 -15
  8. data/lib/aws-sdk-s3/bucket_lifecycle.rb +42 -15
  9. data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +43 -13
  10. data/lib/aws-sdk-s3/bucket_logging.rb +40 -11
  11. data/lib/aws-sdk-s3/bucket_notification.rb +30 -12
  12. data/lib/aws-sdk-s3/bucket_policy.rb +82 -13
  13. data/lib/aws-sdk-s3/bucket_request_payment.rb +35 -13
  14. data/lib/aws-sdk-s3/bucket_tagging.rb +38 -13
  15. data/lib/aws-sdk-s3/bucket_versioning.rb +82 -21
  16. data/lib/aws-sdk-s3/bucket_website.rb +38 -13
  17. data/lib/aws-sdk-s3/client.rb +8666 -3425
  18. data/lib/aws-sdk-s3/client_api.rb +774 -225
  19. data/lib/aws-sdk-s3/customizations/bucket.rb +31 -50
  20. data/lib/aws-sdk-s3/customizations/errors.rb +27 -0
  21. data/lib/aws-sdk-s3/customizations/object.rb +211 -37
  22. data/lib/aws-sdk-s3/customizations/types/permanent_redirect.rb +26 -0
  23. data/lib/aws-sdk-s3/customizations.rb +7 -0
  24. data/lib/aws-sdk-s3/encryption/client.rb +7 -3
  25. data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +0 -4
  26. data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +13 -9
  27. data/lib/aws-sdk-s3/encryptionV2/client.rb +7 -3
  28. data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +1 -4
  29. data/lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb +3 -3
  30. data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +0 -4
  31. data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +10 -6
  32. data/lib/aws-sdk-s3/endpoint_parameters.rb +178 -0
  33. data/lib/aws-sdk-s3/endpoint_provider.rb +591 -0
  34. data/lib/aws-sdk-s3/endpoints.rb +2590 -0
  35. data/lib/aws-sdk-s3/errors.rb +1 -1
  36. data/lib/aws-sdk-s3/event_streams.rb +1 -1
  37. data/lib/aws-sdk-s3/express_credentials.rb +55 -0
  38. data/lib/aws-sdk-s3/express_credentials_cache.rb +30 -0
  39. data/lib/aws-sdk-s3/express_credentials_provider.rb +36 -0
  40. data/lib/aws-sdk-s3/file_downloader.rb +171 -41
  41. data/lib/aws-sdk-s3/file_uploader.rb +14 -7
  42. data/lib/aws-sdk-s3/multipart_file_uploader.rb +26 -8
  43. data/lib/aws-sdk-s3/multipart_stream_uploader.rb +41 -14
  44. data/lib/aws-sdk-s3/multipart_upload.rb +198 -23
  45. data/lib/aws-sdk-s3/multipart_upload_part.rb +285 -34
  46. data/lib/aws-sdk-s3/object.rb +1824 -266
  47. data/lib/aws-sdk-s3/object_acl.rb +58 -19
  48. data/lib/aws-sdk-s3/object_copier.rb +7 -5
  49. data/lib/aws-sdk-s3/object_multipart_copier.rb +41 -19
  50. data/lib/aws-sdk-s3/object_summary.rb +1579 -299
  51. data/lib/aws-sdk-s3/object_version.rb +372 -64
  52. data/lib/aws-sdk-s3/plugins/accelerate.rb +1 -39
  53. data/lib/aws-sdk-s3/plugins/arn.rb +25 -142
  54. data/lib/aws-sdk-s3/plugins/bucket_dns.rb +3 -39
  55. data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +1 -6
  56. data/lib/aws-sdk-s3/plugins/dualstack.rb +2 -49
  57. data/lib/aws-sdk-s3/plugins/endpoints.rb +274 -0
  58. data/lib/aws-sdk-s3/plugins/expect_100_continue.rb +3 -1
  59. data/lib/aws-sdk-s3/plugins/express_session_auth.rb +91 -0
  60. data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb +1 -1
  61. data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +8 -31
  62. data/lib/aws-sdk-s3/plugins/location_constraint.rb +3 -1
  63. data/lib/aws-sdk-s3/plugins/md5s.rb +6 -3
  64. data/lib/aws-sdk-s3/plugins/s3_signer.rb +35 -102
  65. data/lib/aws-sdk-s3/plugins/skip_whole_multipart_get_checksums.rb +31 -0
  66. data/lib/aws-sdk-s3/plugins/streaming_retry.rb +23 -2
  67. data/lib/aws-sdk-s3/presigned_post.rb +99 -78
  68. data/lib/aws-sdk-s3/presigner.rb +43 -51
  69. data/lib/aws-sdk-s3/resource.rb +102 -6
  70. data/lib/aws-sdk-s3/types.rb +7404 -5114
  71. data/lib/aws-sdk-s3/waiters.rb +1 -1
  72. data/lib/aws-sdk-s3.rb +6 -2
  73. data/sig/bucket.rbs +212 -0
  74. data/sig/bucket_acl.rbs +78 -0
  75. data/sig/bucket_cors.rbs +69 -0
  76. data/sig/bucket_lifecycle.rbs +88 -0
  77. data/sig/bucket_lifecycle_configuration.rbs +111 -0
  78. data/sig/bucket_logging.rbs +76 -0
  79. data/sig/bucket_notification.rbs +114 -0
  80. data/sig/bucket_policy.rbs +59 -0
  81. data/sig/bucket_request_payment.rbs +54 -0
  82. data/sig/bucket_tagging.rbs +65 -0
  83. data/sig/bucket_versioning.rbs +77 -0
  84. data/sig/bucket_website.rbs +93 -0
  85. data/sig/client.rbs +2360 -0
  86. data/sig/errors.rbs +34 -0
  87. data/sig/multipart_upload.rbs +110 -0
  88. data/sig/multipart_upload_part.rbs +105 -0
  89. data/sig/object.rbs +436 -0
  90. data/sig/object_acl.rbs +86 -0
  91. data/sig/object_summary.rbs +334 -0
  92. data/sig/object_version.rbs +131 -0
  93. data/sig/resource.rbs +124 -0
  94. data/sig/types.rbs +2562 -0
  95. data/sig/waiters.rbs +83 -0
  96. metadata +51 -17
  97. data/lib/aws-sdk-s3/arn/access_point_arn.rb +0 -62
  98. data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +0 -71
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -95,7 +95,9 @@ module Aws::S3
95
95
  options, params = separate_params_and_options(options)
96
96
  waiter = Waiters::BucketExists.new(options)
97
97
  yield_waiter_and_warn(waiter, &block) if block_given?
98
- waiter.wait(params.merge(bucket: @name))
98
+ Aws::Plugins::UserAgent.feature('resource') do
99
+ waiter.wait(params.merge(bucket: @name))
100
+ end
99
101
  Bucket.new({
100
102
  name: @name,
101
103
  client: @client
@@ -112,7 +114,9 @@ module Aws::S3
112
114
  options, params = separate_params_and_options(options)
113
115
  waiter = Waiters::BucketNotExists.new(options)
114
116
  yield_waiter_and_warn(waiter, &block) if block_given?
115
- waiter.wait(params.merge(bucket: @name))
117
+ Aws::Plugins::UserAgent.feature('resource') do
118
+ waiter.wait(params.merge(bucket: @name))
119
+ end
116
120
  Bucket.new({
117
121
  name: @name,
118
122
  client: @client
@@ -213,7 +217,9 @@ module Aws::S3
213
217
  :retry
214
218
  end
215
219
  end
216
- Aws::Waiters::Waiter.new(options).wait({})
220
+ Aws::Plugins::UserAgent.feature('resource') do
221
+ Aws::Waiters::Waiter.new(options).wait({})
222
+ end
217
223
  end
218
224
 
219
225
  # @!group Actions
@@ -223,7 +229,15 @@ module Aws::S3
223
229
  # bucket.create({
224
230
  # acl: "private", # accepts private, public-read, public-read-write, authenticated-read
225
231
  # create_bucket_configuration: {
226
- # 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-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, 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
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
+ # },
227
241
  # },
228
242
  # grant_full_control: "GrantFullControl",
229
243
  # grant_read: "GrantRead",
@@ -231,31 +245,98 @@ module Aws::S3
231
245
  # grant_write: "GrantWrite",
232
246
  # grant_write_acp: "GrantWriteACP",
233
247
  # object_lock_enabled_for_bucket: false,
248
+ # object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
234
249
  # })
235
250
  # @param [Hash] options ({})
236
251
  # @option options [String] :acl
237
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>
238
257
  # @option options [Types::CreateBucketConfiguration] :create_bucket_configuration
239
258
  # The configuration information for the bucket.
240
259
  # @option options [String] :grant_full_control
241
260
  # Allows grantee the read, write, read ACP, and write ACP permissions on
242
261
  # the bucket.
262
+ #
263
+ # <note markdown="1"> This functionality is not supported for directory buckets.
264
+ #
265
+ # </note>
243
266
  # @option options [String] :grant_read
244
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>
245
272
  # @option options [String] :grant_read_acp
246
273
  # Allows grantee to read the bucket ACL.
274
+ #
275
+ # <note markdown="1"> This functionality is not supported for directory buckets.
276
+ #
277
+ # </note>
247
278
  # @option options [String] :grant_write
248
- # Allows grantee to create, overwrite, and delete any object in the
249
- # 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>
250
287
  # @option options [String] :grant_write_acp
251
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>
252
293
  # @option options [Boolean] :object_lock_enabled_for_bucket
253
294
  # Specifies whether you want S3 Object Lock to be enabled for the new
254
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
255
334
  # @return [Types::CreateBucketOutput]
256
335
  def create(options = {})
257
336
  options = options.merge(bucket: @name)
258
- resp = @client.create_bucket(options)
337
+ resp = Aws::Plugins::UserAgent.feature('resource') do
338
+ @client.create_bucket(options)
339
+ end
259
340
  resp.data
260
341
  end
261
342
 
@@ -266,13 +347,21 @@ module Aws::S3
266
347
  # })
267
348
  # @param [Hash] options ({})
268
349
  # @option options [String] :expected_bucket_owner
269
- # The account id of the expected bucket owner. If the bucket is owned by
270
- # a different account, the request will fail with an HTTP `403 (Access
271
- # Denied)` error.
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>
272
359
  # @return [EmptyStructure]
273
360
  def delete(options = {})
274
361
  options = options.merge(bucket: @name)
275
- resp = @client.delete_bucket(options)
362
+ resp = Aws::Plugins::UserAgent.feature('resource') do
363
+ @client.delete_bucket(options)
364
+ end
276
365
  resp.data
277
366
  end
278
367
 
@@ -292,6 +381,7 @@ module Aws::S3
292
381
  # request_payer: "requester", # accepts requester
293
382
  # bypass_governance_retention: false,
294
383
  # expected_bucket_owner: "AccountId",
384
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
295
385
  # })
296
386
  # @param [Hash] options ({})
297
387
  # @option options [required, Types::Delete] :delete
@@ -301,28 +391,91 @@ module Aws::S3
301
391
  # space, and the value that is displayed on your authentication device.
302
392
  # Required to permanently delete a versioned object if versioning is
303
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
304
411
  # @option options [String] :request_payer
305
412
  # Confirms that the requester knows that they will be charged for the
306
413
  # request. Bucket owners need not specify this parameter in their
307
- # requests. For information about downloading objects from requester
308
- # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
309
- # in the *Amazon S3 Developer Guide*.
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>
310
423
  #
311
424
  #
312
425
  #
313
426
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
314
427
  # @option options [Boolean] :bypass_governance_retention
315
428
  # Specifies whether you want to delete this object even if it has a
316
- # Governance-type Object Lock in place. You must have sufficient
317
- # 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>
318
435
  # @option options [String] :expected_bucket_owner
319
- # The account id of the expected bucket owner. If the bucket is owned by
320
- # a different account, the request will fail with an HTTP `403 (Access
321
- # Denied)` error.
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
322
473
  # @return [Types::DeleteObjectsOutput]
323
474
  def delete_objects(options = {})
324
475
  options = options.merge(bucket: @name)
325
- resp = @client.delete_objects(options)
476
+ resp = Aws::Plugins::UserAgent.feature('resource') do
477
+ @client.delete_objects(options)
478
+ end
326
479
  resp.data
327
480
  end
328
481
 
@@ -338,6 +491,11 @@ module Aws::S3
338
491
  # content_length: 1,
339
492
  # content_md5: "ContentMD5",
340
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",
341
499
  # expires: Time.now,
342
500
  # grant_full_control: "GrantFullControl",
343
501
  # grant_read: "GrantRead",
@@ -347,8 +505,8 @@ module Aws::S3
347
505
  # metadata: {
348
506
  # "MetadataKey" => "MetadataValue",
349
507
  # },
350
- # server_side_encryption: "AES256", # accepts AES256, aws:kms
351
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
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
352
510
  # website_redirect_location: "WebsiteRedirectLocation",
353
511
  # sse_customer_algorithm: "SSECustomerAlgorithm",
354
512
  # sse_customer_key: "SSECustomerKey",
@@ -366,13 +524,41 @@ module Aws::S3
366
524
  # @param [Hash] options ({})
367
525
  # @option options [String] :acl
368
526
  # The canned ACL to apply to the object. For more information, see
369
- # [Canned ACL][1].
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*.
370
536
  #
371
- # This action is not supported by Amazon S3 on Outposts.
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>
372
555
  #
373
556
  #
374
557
  #
375
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
376
562
  # @option options [String, StringIO, File] :body
377
563
  # Object data.
378
564
  # @option options [String] :cache_control
@@ -386,30 +572,30 @@ module Aws::S3
386
572
  # @option options [String] :content_disposition
387
573
  # Specifies presentational information for the object. For more
388
574
  # information, see
389
- # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1][1].
575
+ # [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
390
576
  #
391
577
  #
392
578
  #
393
- # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1
579
+ # [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
394
580
  # @option options [String] :content_encoding
395
581
  # Specifies what content encodings have been applied to the object and
396
582
  # thus what decoding mechanisms must be applied to obtain the media-type
397
583
  # referenced by the Content-Type header field. For more information, see
398
- # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11][1].
584
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
399
585
  #
400
586
  #
401
587
  #
402
- # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
588
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
403
589
  # @option options [String] :content_language
404
590
  # The language the content is in.
405
591
  # @option options [Integer] :content_length
406
592
  # Size of the body in bytes. This parameter is useful when the size of
407
593
  # the body cannot be determined automatically. For more information, see
408
- # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13][1].
594
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
409
595
  #
410
596
  #
411
597
  #
412
- # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13
598
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
413
599
  # @option options [String] :content_md5
414
600
  # The base64-encoded 128-bit MD5 digest of the message (without the
415
601
  # headers) according to RFC 1864. This header can be used as a message
@@ -419,56 +605,187 @@ module Aws::S3
419
605
  # information about REST request authentication, see [REST
420
606
  # Authentication][1].
421
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
+ #
422
619
  #
423
620
  #
424
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
425
623
  # @option options [String] :content_type
426
624
  # A standard MIME type describing the format of the contents. For more
427
625
  # information, see
428
- # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17][1].
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:
429
641
  #
642
+ # * CRC32
430
643
  #
644
+ # * CRC32C
431
645
  #
432
- # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17
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
433
707
  # @option options [Time,DateTime,Date,Integer,String] :expires
434
708
  # The date and time at which the object is no longer cacheable. For more
435
709
  # information, see
436
- # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21][1].
710
+ # [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
437
711
  #
438
712
  #
439
713
  #
440
- # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21
714
+ # [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
441
715
  # @option options [String] :grant_full_control
442
716
  # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
443
717
  # object.
444
718
  #
445
- # This action is not supported by Amazon S3 on Outposts.
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>
446
724
  # @option options [String] :grant_read
447
725
  # Allows grantee to read the object data and its metadata.
448
726
  #
449
- # This action is not supported by Amazon S3 on Outposts.
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>
450
732
  # @option options [String] :grant_read_acp
451
733
  # Allows grantee to read the object ACL.
452
734
  #
453
- # This action is not supported by Amazon S3 on Outposts.
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>
454
740
  # @option options [String] :grant_write_acp
455
741
  # Allows grantee to write the ACL for the applicable object.
456
742
  #
457
- # This action is not supported by Amazon S3 on Outposts.
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>
458
748
  # @option options [required, String] :key
459
- # Object key for which the PUT operation was initiated.
749
+ # Object key for which the PUT action was initiated.
460
750
  # @option options [Hash<String,String>] :metadata
461
751
  # A map of metadata to store with the object in S3.
462
752
  # @option options [String] :server_side_encryption
463
- # The server-side encryption algorithm used when storing this object in
464
- # Amazon S3 (for example, 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
465
776
  # @option options [String] :storage_class
466
777
  # By default, Amazon S3 uses the STANDARD Storage Class to store newly
467
778
  # created objects. The STANDARD storage class provides high durability
468
779
  # and high availability. Depending on performance needs, you can specify
469
- # a different Storage Class. Amazon S3 on Outposts only uses the
470
- # OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
471
- # in the *Amazon S3 Service Developer Guide*.
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>
472
789
  #
473
790
  #
474
791
  #
@@ -477,7 +794,8 @@ module Aws::S3
477
794
  # If the bucket is configured as a website, redirects requests for this
478
795
  # object to another object in the same bucket or to an external URL.
479
796
  # Amazon S3 stores the value of this header in the object metadata. For
480
- # information about object metadata, see [Object Key and Metadata][1].
797
+ # information about object metadata, see [Object Key and Metadata][1] in
798
+ # the *Amazon S3 User Guide*.
481
799
  #
482
800
  # In the following example, the request header sets the redirect to an
483
801
  # object (anotherPage.html) in the same bucket:
@@ -491,7 +809,11 @@ module Aws::S3
491
809
  #
492
810
  # For more information about website hosting in Amazon S3, see [Hosting
493
811
  # Websites on Amazon S3][2] and [How to Configure Website Page
494
- # Redirects][3].
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>
495
817
  #
496
818
  #
497
819
  #
@@ -499,48 +821,81 @@ module Aws::S3
499
821
  # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
500
822
  # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
501
823
  # @option options [String] :sse_customer_algorithm
502
- # Specifies the algorithm to use to when encrypting the object (for
503
- # example, 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>
504
830
  # @option options [String] :sse_customer_key
505
831
  # Specifies the customer-provided encryption key for Amazon S3 to use in
506
832
  # encrypting data. This value is used to store the object and then it is
507
833
  # discarded; Amazon S3 does not store the encryption key. The key must
508
834
  # be appropriate for use with the algorithm specified in the
509
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>
510
840
  # @option options [String] :sse_customer_key_md5
511
841
  # Specifies the 128-bit MD5 digest of the encryption key according to
512
842
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
513
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>
514
848
  # @option options [String] :ssekms_key_id
515
- # If `x-amz-server-side-encryption` is present and has the value of
516
- # `aws:kms`, this header specifies the ID of the AWS Key Management
517
- # Service (AWS KMS) symmetrical customer managed customer master key
518
- # (CMK) that was used for the object.
519
- #
520
- # If the value of `x-amz-server-side-encryption` is `aws:kms`, this
521
- # header specifies the ID of the symmetric customer managed AWS KMS CMK
522
- # that will be used for the object. If you specify
523
- # `x-amz-server-side-encryption:aws:kms`, but do not provide`
524
- # x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
525
- # managed CMK in AWS to protect the data.
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>
526
863
  # @option options [String] :ssekms_encryption_context
527
- # Specifies the AWS KMS Encryption Context to use for object encryption.
528
- # The value of this header is a base64-encoded UTF-8 string holding JSON
529
- # 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>
530
875
  # @option options [Boolean] :bucket_key_enabled
531
876
  # Specifies whether Amazon S3 should use an S3 Bucket Key for object
532
- # encryption with server-side encryption using AWS KMS (SSE-KMS).
533
- # Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
534
- # for object encryption with SSE-KMS.
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.
535
883
  #
536
- # Specifying this header with a PUT operation doesn’t affect
537
- # bucket-level settings for S3 Bucket Key.
884
+ # <note markdown="1"> This functionality is not supported for directory buckets.
885
+ #
886
+ # </note>
538
887
  # @option options [String] :request_payer
539
888
  # Confirms that the requester knows that they will be charged for the
540
889
  # request. Bucket owners need not specify this parameter in their
541
- # requests. For information about downloading objects from requester
542
- # pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
543
- # in the *Amazon S3 Developer Guide*.
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>
544
899
  #
545
900
  #
546
901
  #
@@ -548,25 +903,45 @@ module Aws::S3
548
903
  # @option options [String] :tagging
549
904
  # The tag-set for the object. The tag-set must be encoded as URL Query
550
905
  # parameters. (For example, "Key1=Value1")
906
+ #
907
+ # <note markdown="1"> This functionality is not supported for directory buckets.
908
+ #
909
+ # </note>
551
910
  # @option options [String] :object_lock_mode
552
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>
553
916
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
554
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>
555
923
  # @option options [String] :object_lock_legal_hold_status
556
924
  # Specifies whether a legal hold will be applied to this object. For
557
- # more information about S3 Object Lock, see [Object Lock][1].
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>
558
931
  #
559
932
  #
560
933
  #
561
934
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
562
935
  # @option options [String] :expected_bucket_owner
563
- # The account id of the expected bucket owner. If the bucket is owned by
564
- # a different account, the request will fail with an HTTP `403 (Access
565
- # Denied)` error.
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).
566
939
  # @return [Object]
567
940
  def put_object(options = {})
568
941
  options = options.merge(bucket: @name)
569
- @client.put_object(options)
942
+ Aws::Plugins::UserAgent.feature('resource') do
943
+ @client.put_object(options)
944
+ end
570
945
  Object.new(
571
946
  bucket_name: @name,
572
947
  key: options[:key],
@@ -625,6 +1000,7 @@ module Aws::S3
625
1000
  # prefix: "Prefix",
626
1001
  # upload_id_marker: "UploadIdMarker",
627
1002
  # expected_bucket_owner: "AccountId",
1003
+ # request_payer: "requester", # accepts requester
628
1004
  # })
629
1005
  # @param [Hash] options ({})
630
1006
  # @option options [String] :delimiter
@@ -636,30 +1012,56 @@ module Aws::S3
636
1012
  # don't specify the prefix parameter, then the substring starts at the
637
1013
  # beginning of the key. The keys that are grouped under `CommonPrefixes`
638
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>
639
1020
  # @option options [String] :encoding_type
640
1021
  # Requests Amazon S3 to encode the object keys in the response and
641
- # specifies the encoding method to use. An object key may contain any
642
- # 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
643
1024
  # characters, such as characters with an ASCII value from 0 to 10. For
644
1025
  # characters that are not supported in XML 1.0, you can add this
645
1026
  # parameter to request that Amazon S3 encode the keys in the response.
646
1027
  # @option options [String] :key_marker
647
- # Together with upload-id-marker, this parameter specifies the multipart
648
- # upload after which listing should begin.
1028
+ # Specifies the multipart upload after which listing should begin.
649
1029
  #
650
- # If `upload-id-marker` is not specified, only the keys
651
- # lexicographically greater than the specified `key-marker` will be
652
- # included in the list.
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.
653
1034
  #
654
- # If `upload-id-marker` is specified, any multipart uploads for a key
655
- # equal to the `key-marker` might also be included, provided those
656
- # multipart uploads have upload IDs lexicographically greater than the
657
- # specified `upload-id-marker`.
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>
658
1055
  # @option options [String] :prefix
659
1056
  # Lists in-progress uploads only for those keys that begin with the
660
1057
  # specified prefix. You can use prefixes to separate a bucket into
661
- # different grouping of keys. (You can think of using prefix to make
662
- # groups in the same way you'd use a folder in a file system.)
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>
663
1065
  # @option options [String] :upload_id_marker
664
1066
  # Together with key-marker, specifies the multipart upload after which
665
1067
  # listing should begin. If key-marker is not specified, the
@@ -667,15 +1069,37 @@ module Aws::S3
667
1069
  # uploads for a key equal to the key-marker might be included in the
668
1070
  # list only if they have an upload ID lexicographically greater than the
669
1071
  # specified `upload-id-marker`.
1072
+ #
1073
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1074
+ #
1075
+ # </note>
670
1076
  # @option options [String] :expected_bucket_owner
671
- # The account id of the expected bucket owner. If the bucket is owned by
672
- # a different account, the request will fail with an HTTP `403 (Access
673
- # Denied)` error.
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
674
1096
  # @return [MultipartUpload::Collection]
675
1097
  def multipart_uploads(options = {})
676
1098
  batches = Enumerator.new do |y|
677
1099
  options = options.merge(bucket: @name)
678
- resp = @client.list_multipart_uploads(options)
1100
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1101
+ @client.list_multipart_uploads(options)
1102
+ end
679
1103
  resp.each_page do |page|
680
1104
  batch = []
681
1105
  page.data.uploads.each do |u|
@@ -720,19 +1144,21 @@ module Aws::S3
720
1144
  # prefix: "Prefix",
721
1145
  # version_id_marker: "VersionIdMarker",
722
1146
  # expected_bucket_owner: "AccountId",
1147
+ # request_payer: "requester", # accepts requester
1148
+ # optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
723
1149
  # })
724
1150
  # @param [Hash] options ({})
725
1151
  # @option options [String] :delimiter
726
1152
  # A delimiter is a character that you specify to group keys. All keys
727
1153
  # that contain the same string between the `prefix` and the first
728
1154
  # occurrence of the delimiter are grouped under a single result element
729
- # in CommonPrefixes. These groups are counted as one result against the
730
- # max-keys limitation. These keys are not returned elsewhere in the
731
- # response.
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.
732
1158
  # @option options [String] :encoding_type
733
1159
  # Requests Amazon S3 to encode the object keys in the response and
734
- # specifies the encoding method to use. An object key may contain any
735
- # 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
736
1162
  # characters, such as characters with an ASCII value from 0 to 10. For
737
1163
  # characters that are not supported in XML 1.0, you can add this
738
1164
  # parameter to request that Amazon S3 encode the keys in the response.
@@ -741,21 +1167,42 @@ module Aws::S3
741
1167
  # @option options [String] :prefix
742
1168
  # Use this parameter to select only those keys that begin with the
743
1169
  # specified prefix. You can use prefixes to separate a bucket into
744
- # different groupings of keys. (You can think of using prefix to make
745
- # groups in the same way you'd use a folder in a file system.) You can
746
- # use prefix with delimiter to roll up numerous objects into a single
747
- # result under CommonPrefixes.
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`.
748
1174
  # @option options [String] :version_id_marker
749
1175
  # Specifies the object version you want to start listing from.
750
1176
  # @option options [String] :expected_bucket_owner
751
- # The account id of the expected bucket owner. If the bucket is owned by
752
- # a different account, the request will fail with an HTTP `403 (Access
753
- # Denied)` error.
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.
754
1199
  # @return [ObjectVersion::Collection]
755
1200
  def object_versions(options = {})
756
1201
  batches = Enumerator.new do |y|
757
1202
  options = options.merge(bucket: @name)
758
- resp = @client.list_object_versions(options)
1203
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1204
+ @client.list_object_versions(options)
1205
+ end
759
1206
  resp.each_page do |page|
760
1207
  batch = []
761
1208
  page.data.versions_delete_markers.each do |v|
@@ -783,35 +1230,79 @@ module Aws::S3
783
1230
  # start_after: "StartAfter",
784
1231
  # request_payer: "requester", # accepts requester
785
1232
  # expected_bucket_owner: "AccountId",
1233
+ # optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
786
1234
  # })
787
1235
  # @param [Hash] options ({})
788
1236
  # @option options [String] :delimiter
789
- # 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
790
1254
  # @option options [String] :encoding_type
791
1255
  # Encoding type used by Amazon S3 to encode object keys in the response.
792
1256
  # @option options [String] :prefix
793
1257
  # Limits the response to keys that begin with the specified prefix.
1258
+ #
1259
+ # <note markdown="1"> **Directory buckets** - For directory buckets, only prefixes that end
1260
+ # in a delimiter (`/`) are supported.
1261
+ #
1262
+ # </note>
794
1263
  # @option options [Boolean] :fetch_owner
795
- # The owner field is not present in listV2 by default, if you want to
796
- # return owner field with each key in the result then set the fetch
797
- # owner field to true.
1264
+ # The owner field is not present in `ListObjectsV2` by default. If you
1265
+ # want to return the owner field with each key in the result, then set
1266
+ # the `FetchOwner` field to `true`.
1267
+ #
1268
+ # <note markdown="1"> **Directory buckets** - For directory buckets, the bucket owner is
1269
+ # returned as the object owner for all objects.
1270
+ #
1271
+ # </note>
798
1272
  # @option options [String] :start_after
799
1273
  # StartAfter is where you want Amazon S3 to start listing from. Amazon
800
1274
  # S3 starts listing after this specified key. StartAfter can be any key
801
1275
  # in the bucket.
1276
+ #
1277
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1278
+ #
1279
+ # </note>
802
1280
  # @option options [String] :request_payer
803
1281
  # Confirms that the requester knows that she or he will be charged for
804
1282
  # the list objects request in V2 style. Bucket owners need not specify
805
1283
  # this parameter in their requests.
1284
+ #
1285
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1286
+ #
1287
+ # </note>
806
1288
  # @option options [String] :expected_bucket_owner
807
- # The account id of the expected bucket owner. If the bucket is owned by
808
- # a different account, the request will fail with an HTTP `403 (Access
809
- # Denied)` error.
1289
+ # The account ID of the expected bucket owner. If the account ID that
1290
+ # you provide does not match the actual owner of the bucket, the request
1291
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1292
+ # @option options [Array<String>] :optional_object_attributes
1293
+ # Specifies the optional fields that you want returned in the response.
1294
+ # Fields that you do not specify are not returned.
1295
+ #
1296
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1297
+ #
1298
+ # </note>
810
1299
  # @return [ObjectSummary::Collection]
811
1300
  def objects(options = {})
812
1301
  batches = Enumerator.new do |y|
813
1302
  options = options.merge(bucket: @name)
814
- resp = @client.list_objects_v2(options)
1303
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1304
+ @client.list_objects_v2(options)
1305
+ end
815
1306
  resp.each_page do |page|
816
1307
  batch = []
817
1308
  page.data.contents.each do |c|