aws-sdk-s3 1.45.0 → 1.143.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 +1106 -0
  3. data/LICENSE.txt +202 -0
  4. data/VERSION +1 -0
  5. data/lib/aws-sdk-s3/bucket.rb +784 -98
  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 +12610 -902
  19. data/lib/aws-sdk-s3/client_api.rb +1086 -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 +282 -68
  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 +28 -7
  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 +11 -6
  66. data/lib/aws-sdk-s3/file_uploader.rb +39 -18
  67. data/lib/aws-sdk-s3/legacy_signer.rb +17 -25
  68. data/lib/aws-sdk-s3/multipart_file_uploader.rb +78 -20
  69. data/lib/aws-sdk-s3/multipart_stream_uploader.rb +56 -18
  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 +35 -30
  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 +171 -80
  101. data/lib/aws-sdk-s3/resource.rb +120 -8
  102. data/lib/aws-sdk-s3/types.rb +11353 -4225
  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 ObjectSummary
10
13
 
11
14
  extend Aws::Deprecations
@@ -24,6 +27,7 @@ module Aws::S3
24
27
  @key = extract_key(args, options)
25
28
  @data = options.delete(:data)
26
29
  @client = options.delete(:client) || Client.new(options)
30
+ @waiter_block_warned = false
27
31
  end
28
32
 
29
33
  # @!group Read-Only Attributes
@@ -38,36 +42,96 @@ module Aws::S3
38
42
  @key
39
43
  end
40
44
 
41
-
45
+ # Creation date of the object.
42
46
  # @return [Time]
43
47
  def last_modified
44
48
  data[:last_modified]
45
49
  end
46
50
 
47
-
51
+ # The entity tag is a hash of the object. The ETag reflects changes only
52
+ # to the contents of an object, not its metadata. The ETag may or may
53
+ # not be an MD5 digest of the object data. Whether or not it is depends
54
+ # on how the object was created and how it is encrypted as described
55
+ # below:
56
+ #
57
+ # * Objects created by the PUT Object, POST Object, or Copy operation,
58
+ # or through the Amazon Web Services Management Console, and are
59
+ # encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest
60
+ # of their object data.
61
+ #
62
+ # * Objects created by the PUT Object, POST Object, or Copy operation,
63
+ # or through the Amazon Web Services Management Console, and are
64
+ # encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest
65
+ # of their object data.
66
+ #
67
+ # * If an object is created by either the Multipart Upload or Part Copy
68
+ # operation, the ETag is not an MD5 digest, regardless of the method
69
+ # of encryption. If an object is larger than 16 MB, the Amazon Web
70
+ # Services Management Console will upload or copy that object as a
71
+ # Multipart Upload, and therefore the ETag will not be an MD5 digest.
72
+ #
73
+ # <note markdown="1"> **Directory buckets** - MD5 is not supported by directory buckets.
74
+ #
75
+ # </note>
48
76
  # @return [String]
49
77
  def etag
50
78
  data[:etag]
51
79
  end
52
80
 
53
-
81
+ # The algorithm that was used to create a checksum of the object.
82
+ # @return [Array<String>]
83
+ def checksum_algorithm
84
+ data[:checksum_algorithm]
85
+ end
86
+
87
+ # Size in bytes of the object
54
88
  # @return [Integer]
55
89
  def size
56
90
  data[:size]
57
91
  end
58
92
 
59
93
  # The class of storage used to store the object.
94
+ #
95
+ # <note markdown="1"> **Directory buckets** - Only the S3 Express One Zone storage class is
96
+ # supported by directory buckets to store objects.
97
+ #
98
+ # </note>
60
99
  # @return [String]
61
100
  def storage_class
62
101
  data[:storage_class]
63
102
  end
64
103
 
65
-
104
+ # The owner of the object
105
+ #
106
+ # <note markdown="1"> **Directory buckets** - The bucket owner is returned as the object
107
+ # owner.
108
+ #
109
+ # </note>
66
110
  # @return [Types::Owner]
67
111
  def owner
68
112
  data[:owner]
69
113
  end
70
114
 
115
+ # Specifies the restoration status of an object. Objects in certain
116
+ # storage classes must be restored before they can be retrieved. For
117
+ # more information about these storage classes and how to work with
118
+ # archived objects, see [ Working with archived objects][1] in the
119
+ # *Amazon S3 User Guide*.
120
+ #
121
+ # <note markdown="1"> This functionality is not supported for directory buckets. Only the S3
122
+ # Express One Zone storage class is supported by directory buckets to
123
+ # store objects.
124
+ #
125
+ # </note>
126
+ #
127
+ #
128
+ #
129
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
130
+ # @return [Types::RestoreStatus]
131
+ def restore_status
132
+ data[:restore_status]
133
+ end
134
+
71
135
  # @!endgroup
72
136
 
73
137
  # @return [Client]
@@ -122,8 +186,10 @@ module Aws::S3
122
186
  options, params = separate_params_and_options(options)
123
187
  waiter = Waiters::ObjectExists.new(options)
124
188
  yield_waiter_and_warn(waiter, &block) if block_given?
125
- waiter.wait(params.merge(bucket: @bucket_name,
189
+ Aws::Plugins::UserAgent.feature('resource') do
190
+ waiter.wait(params.merge(bucket: @bucket_name,
126
191
  key: @key))
192
+ end
127
193
  ObjectSummary.new({
128
194
  bucket_name: @bucket_name,
129
195
  key: @key,
@@ -141,8 +207,10 @@ module Aws::S3
141
207
  options, params = separate_params_and_options(options)
142
208
  waiter = Waiters::ObjectNotExists.new(options)
143
209
  yield_waiter_and_warn(waiter, &block) if block_given?
144
- waiter.wait(params.merge(bucket: @bucket_name,
210
+ Aws::Plugins::UserAgent.feature('resource') do
211
+ waiter.wait(params.merge(bucket: @bucket_name,
145
212
  key: @key))
213
+ end
146
214
  ObjectSummary.new({
147
215
  bucket_name: @bucket_name,
148
216
  key: @key,
@@ -155,7 +223,8 @@ module Aws::S3
155
223
  # Waiter polls an API operation until a resource enters a desired
156
224
  # state.
157
225
  #
158
- # @note The waiting operation is performed on a copy. The original resource remains unchanged
226
+ # @note The waiting operation is performed on a copy. The original resource
227
+ # remains unchanged.
159
228
  #
160
229
  # ## Basic Usage
161
230
  #
@@ -168,13 +237,15 @@ module Aws::S3
168
237
  #
169
238
  # ## Example
170
239
  #
171
- # instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }
240
+ # instance.wait_until(max_attempts:10, delay:5) do |instance|
241
+ # instance.state.name == 'running'
242
+ # end
172
243
  #
173
244
  # ## Configuration
174
245
  #
175
246
  # You can configure the maximum number of polling attempts, and the
176
- # delay (in seconds) between each polling attempt. The waiting condition is set
177
- # by passing a block to {#wait_until}:
247
+ # delay (in seconds) between each polling attempt. The waiting condition is
248
+ # set by passing a block to {#wait_until}:
178
249
  #
179
250
  # # poll for ~25 seconds
180
251
  # resource.wait_until(max_attempts:5,delay:5) {|resource|...}
@@ -205,17 +276,16 @@ module Aws::S3
205
276
  # # resource did not enter the desired state in time
206
277
  # end
207
278
  #
279
+ # @yieldparam [Resource] resource to be used in the waiting condition.
208
280
  #
209
- # @yield param [Resource] resource to be used in the waiting condition
210
- #
211
- # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter terminates
212
- # because the waiter has entered a state that it will not transition
213
- # out of, preventing success.
281
+ # @raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter
282
+ # terminates because the waiter has entered a state that it will not
283
+ # transition out of, preventing success.
214
284
  #
215
285
  # yet successful.
216
286
  #
217
- # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is encountered
218
- # while polling for a resource that is not expected.
287
+ # @raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is
288
+ # encountered while polling for a resource that is not expected.
219
289
  #
220
290
  # @raise [NotImplementedError] Raised when the resource does not
221
291
  #
@@ -242,7 +312,9 @@ module Aws::S3
242
312
  :retry
243
313
  end
244
314
  end
245
- Aws::Waiters::Waiter.new(options).wait({})
315
+ Aws::Plugins::UserAgent.feature('resource') do
316
+ Aws::Waiters::Waiter.new(options).wait({})
317
+ end
246
318
  end
247
319
 
248
320
  # @!group Actions
@@ -252,6 +324,7 @@ module Aws::S3
252
324
  # object_summary.copy_from({
253
325
  # acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
254
326
  # cache_control: "CacheControl",
327
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
255
328
  # content_disposition: "ContentDisposition",
256
329
  # content_encoding: "ContentEncoding",
257
330
  # content_language: "ContentLanguage",
@@ -271,14 +344,15 @@ module Aws::S3
271
344
  # },
272
345
  # metadata_directive: "COPY", # accepts COPY, REPLACE
273
346
  # tagging_directive: "COPY", # accepts COPY, REPLACE
274
- # server_side_encryption: "AES256", # accepts AES256, aws:kms
275
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
347
+ # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
348
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
276
349
  # website_redirect_location: "WebsiteRedirectLocation",
277
350
  # sse_customer_algorithm: "SSECustomerAlgorithm",
278
351
  # sse_customer_key: "SSECustomerKey",
279
352
  # sse_customer_key_md5: "SSECustomerKeyMD5",
280
353
  # ssekms_key_id: "SSEKMSKeyId",
281
354
  # ssekms_encryption_context: "SSEKMSEncryptionContext",
355
+ # bucket_key_enabled: false,
282
356
  # copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
283
357
  # copy_source_sse_customer_key: "CopySourceSSECustomerKey",
284
358
  # copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
@@ -287,121 +361,630 @@ module Aws::S3
287
361
  # object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
288
362
  # object_lock_retain_until_date: Time.now,
289
363
  # object_lock_legal_hold_status: "ON", # accepts ON, OFF
364
+ # expected_bucket_owner: "AccountId",
365
+ # expected_source_bucket_owner: "AccountId",
290
366
  # })
291
367
  # @param [Hash] options ({})
292
368
  # @option options [String] :acl
293
- # The canned ACL to apply to the object.
369
+ # The canned access control list (ACL) to apply to the object.
370
+ #
371
+ # When you copy an object, the ACL metadata is not preserved and is set
372
+ # to `private` by default. Only the owner has full access control. To
373
+ # override the default ACL setting, specify a new ACL when you generate
374
+ # a copy request. For more information, see [Using ACLs][1].
375
+ #
376
+ # If the destination bucket that you're copying objects to uses the
377
+ # bucket owner enforced setting for S3 Object Ownership, ACLs are
378
+ # disabled and no longer affect permissions. Buckets that use this
379
+ # setting only accept `PUT` requests that don't specify an ACL or `PUT`
380
+ # requests that specify bucket owner full control ACLs, such as the
381
+ # `bucket-owner-full-control` canned ACL or an equivalent form of this
382
+ # ACL expressed in the XML format. For more information, see
383
+ # [Controlling ownership of objects and disabling ACLs][2] in the
384
+ # *Amazon S3 User Guide*.
385
+ #
386
+ # <note markdown="1"> * If your destination bucket uses the bucket owner enforced setting
387
+ # for Object Ownership, all objects written to the bucket by any
388
+ # account will be owned by the bucket owner.
389
+ #
390
+ # * This functionality is not supported for directory buckets.
391
+ #
392
+ # * This functionality is not supported for Amazon S3 on Outposts.
393
+ #
394
+ # </note>
395
+ #
396
+ #
397
+ #
398
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
399
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
294
400
  # @option options [String] :cache_control
295
- # Specifies caching behavior along the request/reply chain.
401
+ # Specifies the caching behavior along the request/reply chain.
402
+ # @option options [String] :checksum_algorithm
403
+ # Indicates the algorithm that you want Amazon S3 to use to create the
404
+ # checksum for the object. For more information, see [Checking object
405
+ # integrity][1] in the *Amazon S3 User Guide*.
406
+ #
407
+ # When you copy an object, if the source object has a checksum, that
408
+ # checksum value will be copied to the new object by default. If the
409
+ # `CopyObject` request does not include this `x-amz-checksum-algorithm`
410
+ # header, the checksum algorithm will be copied from the source object
411
+ # to the destination object (if it's present on the source object). You
412
+ # can optionally specify a different checksum algorithm to use with the
413
+ # `x-amz-checksum-algorithm` header. Unrecognized or unsupported values
414
+ # will respond with the HTTP status code `400 Bad Request`.
415
+ #
416
+ # <note markdown="1"> For directory buckets, when you use Amazon Web Services SDKs, `CRC32`
417
+ # is the default checksum algorithm that's used for performance.
418
+ #
419
+ # </note>
420
+ #
421
+ #
422
+ #
423
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
296
424
  # @option options [String] :content_disposition
297
- # Specifies presentational information for the object.
425
+ # Specifies presentational information for the object. Indicates whether
426
+ # an object should be displayed in a web browser or downloaded as a
427
+ # file. It allows specifying the desired filename for the downloaded
428
+ # file.
298
429
  # @option options [String] :content_encoding
299
430
  # Specifies what content encodings have been applied to the object and
300
431
  # thus what decoding mechanisms must be applied to obtain the media-type
301
432
  # referenced by the Content-Type header field.
433
+ #
434
+ # <note markdown="1"> For directory buckets, only the `aws-chunked` value is supported in
435
+ # this header field.
436
+ #
437
+ # </note>
302
438
  # @option options [String] :content_language
303
439
  # The language the content is in.
304
440
  # @option options [String] :content_type
305
- # A standard MIME type describing the format of the object data.
441
+ # A standard MIME type that describes the format of the object data.
306
442
  # @option options [required, String] :copy_source
307
- # The name of the source bucket and key name of the source object,
308
- # separated by a slash (/). Must be URL-encoded.
443
+ # Specifies the source object for the copy operation. The source object
444
+ # can be up to 5 GB. If the source object is an object that was uploaded
445
+ # by using a multipart upload, the object copy will be a single part
446
+ # object after the source object is copied to the destination bucket.
447
+ #
448
+ # You specify the value of the copy source in one of two formats,
449
+ # depending on whether you want to access the source object through an
450
+ # [access point][1]:
451
+ #
452
+ # * For objects not accessed through an access point, specify the name
453
+ # of the source bucket and the key of the source object, separated by
454
+ # a slash (/). For example, to copy the object `reports/january.pdf`
455
+ # from the general purpose bucket `awsexamplebucket`, use
456
+ # `awsexamplebucket/reports/january.pdf`. The value must be
457
+ # URL-encoded. To copy the object `reports/january.pdf` from the
458
+ # directory bucket `awsexamplebucket--use1-az5--x-s3`, use
459
+ # `awsexamplebucket--use1-az5--x-s3/reports/january.pdf`. The value
460
+ # must be URL-encoded.
461
+ #
462
+ # * For objects accessed through access points, specify the Amazon
463
+ # Resource Name (ARN) of the object as accessed through the access
464
+ # point, in the format
465
+ # `arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`.
466
+ # For example, to copy the object `reports/january.pdf` through access
467
+ # point `my-access-point` owned by account `123456789012` in Region
468
+ # `us-west-2`, use the URL encoding of
469
+ # `arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf`.
470
+ # The value must be URL encoded.
471
+ #
472
+ # <note markdown="1"> * Amazon S3 supports copy operations using Access points only when
473
+ # the source and destination buckets are in the same Amazon Web
474
+ # Services Region.
475
+ #
476
+ # * Access points are not supported by directory buckets.
477
+ #
478
+ # </note>
479
+ #
480
+ # Alternatively, for objects accessed through Amazon S3 on Outposts,
481
+ # specify the ARN of the object as accessed in the format
482
+ # `arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`.
483
+ # For example, to copy the object `reports/january.pdf` through
484
+ # outpost `my-outpost` owned by account `123456789012` in Region
485
+ # `us-west-2`, use the URL encoding of
486
+ # `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`.
487
+ # The value must be URL-encoded.
488
+ #
489
+ # If your source bucket versioning is enabled, the `x-amz-copy-source`
490
+ # header by default identifies the current version of an object to copy.
491
+ # If the current version is a delete marker, Amazon S3 behaves as if the
492
+ # object was deleted. To copy a different version, use the `versionId`
493
+ # query parameter. Specifically, append `?versionId=<version-id>` to the
494
+ # value (for example,
495
+ # `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`).
496
+ # If you don't specify a version ID, Amazon S3 copies the latest
497
+ # version of the source object.
498
+ #
499
+ # If you enable versioning on the destination bucket, Amazon S3
500
+ # generates a unique version ID for the copied object. This version ID
501
+ # is different from the version ID of the source object. Amazon S3
502
+ # returns the version ID of the copied object in the `x-amz-version-id`
503
+ # response header in the response.
504
+ #
505
+ # If you do not enable versioning or suspend it on the destination
506
+ # bucket, the version ID that Amazon S3 generates in the
507
+ # `x-amz-version-id` response header is always null.
508
+ #
509
+ # <note markdown="1"> **Directory buckets** - S3 Versioning isn't enabled and supported for
510
+ # directory buckets.
511
+ #
512
+ # </note>
513
+ #
514
+ #
515
+ #
516
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
309
517
  # @option options [String] :copy_source_if_match
310
518
  # Copies the object if its entity tag (ETag) matches the specified tag.
519
+ #
520
+ # If both the `x-amz-copy-source-if-match` and
521
+ # `x-amz-copy-source-if-unmodified-since` headers are present in the
522
+ # request and evaluate as follows, Amazon S3 returns `200 OK` and copies
523
+ # the data:
524
+ #
525
+ # * `x-amz-copy-source-if-match` condition evaluates to true
526
+ #
527
+ # * `x-amz-copy-source-if-unmodified-since` condition evaluates to false
311
528
  # @option options [Time,DateTime,Date,Integer,String] :copy_source_if_modified_since
312
529
  # Copies the object if it has been modified since the specified time.
530
+ #
531
+ # If both the `x-amz-copy-source-if-none-match` and
532
+ # `x-amz-copy-source-if-modified-since` headers are present in the
533
+ # request and evaluate as follows, Amazon S3 returns the `412
534
+ # Precondition Failed` response code:
535
+ #
536
+ # * `x-amz-copy-source-if-none-match` condition evaluates to false
537
+ #
538
+ # * `x-amz-copy-source-if-modified-since` condition evaluates to true
313
539
  # @option options [String] :copy_source_if_none_match
314
540
  # Copies the object if its entity tag (ETag) is different than the
315
541
  # specified ETag.
542
+ #
543
+ # If both the `x-amz-copy-source-if-none-match` and
544
+ # `x-amz-copy-source-if-modified-since` headers are present in the
545
+ # request and evaluate as follows, Amazon S3 returns the `412
546
+ # Precondition Failed` response code:
547
+ #
548
+ # * `x-amz-copy-source-if-none-match` condition evaluates to false
549
+ #
550
+ # * `x-amz-copy-source-if-modified-since` condition evaluates to true
316
551
  # @option options [Time,DateTime,Date,Integer,String] :copy_source_if_unmodified_since
317
552
  # Copies the object if it hasn't been modified since the specified
318
553
  # time.
554
+ #
555
+ # If both the `x-amz-copy-source-if-match` and
556
+ # `x-amz-copy-source-if-unmodified-since` headers are present in the
557
+ # request and evaluate as follows, Amazon S3 returns `200 OK` and copies
558
+ # the data:
559
+ #
560
+ # * `x-amz-copy-source-if-match` condition evaluates to true
561
+ #
562
+ # * `x-amz-copy-source-if-unmodified-since` condition evaluates to false
319
563
  # @option options [Time,DateTime,Date,Integer,String] :expires
320
564
  # The date and time at which the object is no longer cacheable.
321
565
  # @option options [String] :grant_full_control
322
566
  # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
323
567
  # object.
568
+ #
569
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
570
+ #
571
+ # * This functionality is not supported for Amazon S3 on Outposts.
572
+ #
573
+ # </note>
324
574
  # @option options [String] :grant_read
325
575
  # Allows grantee to read the object data and its metadata.
576
+ #
577
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
578
+ #
579
+ # * This functionality is not supported for Amazon S3 on Outposts.
580
+ #
581
+ # </note>
326
582
  # @option options [String] :grant_read_acp
327
583
  # Allows grantee to read the object ACL.
584
+ #
585
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
586
+ #
587
+ # * This functionality is not supported for Amazon S3 on Outposts.
588
+ #
589
+ # </note>
328
590
  # @option options [String] :grant_write_acp
329
591
  # Allows grantee to write the ACL for the applicable object.
592
+ #
593
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
594
+ #
595
+ # * This functionality is not supported for Amazon S3 on Outposts.
596
+ #
597
+ # </note>
330
598
  # @option options [Hash<String,String>] :metadata
331
599
  # A map of metadata to store with the object in S3.
332
600
  # @option options [String] :metadata_directive
333
601
  # Specifies whether the metadata is copied from the source object or
334
- # replaced with metadata provided in the request.
602
+ # replaced with metadata that's provided in the request. When copying
603
+ # an object, you can preserve all metadata (the default) or specify new
604
+ # metadata. If this header isn’t specified, `COPY` is the default
605
+ # behavior.
606
+ #
607
+ # **General purpose bucket** - For general purpose buckets, when you
608
+ # grant permissions, you can use the `s3:x-amz-metadata-directive`
609
+ # condition key to enforce certain metadata behavior when objects are
610
+ # uploaded. For more information, see [Amazon S3 condition key
611
+ # examples][1] in the *Amazon S3 User Guide*.
612
+ #
613
+ # <note markdown="1"> `x-amz-website-redirect-location` is unique to each object and is not
614
+ # copied when using the `x-amz-metadata-directive` header. To copy the
615
+ # value, you must specify `x-amz-website-redirect-location` in the
616
+ # request header.
617
+ #
618
+ # </note>
619
+ #
620
+ #
621
+ #
622
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
335
623
  # @option options [String] :tagging_directive
336
- # Specifies whether the object tag-set are copied from the source object
337
- # or replaced with tag-set provided in the request.
624
+ # Specifies whether the object tag-set is copied from the source object
625
+ # or replaced with the tag-set that's provided in the request.
626
+ #
627
+ # The default value is `COPY`.
628
+ #
629
+ # <note markdown="1"> **Directory buckets** - For directory buckets in a `CopyObject`
630
+ # operation, only the empty tag-set is supported. Any requests that
631
+ # attempt to write non-empty tags into directory buckets will receive a
632
+ # `501 Not Implemented` status code. When the destination bucket is a
633
+ # directory bucket, you will receive a `501 Not Implemented` response in
634
+ # any of the following situations:
635
+ #
636
+ # * When you attempt to `COPY` the tag-set from an S3 source object that
637
+ # has non-empty tags.
638
+ #
639
+ # * When you attempt to `REPLACE` the tag-set of a source object and set
640
+ # a non-empty value to `x-amz-tagging`.
641
+ #
642
+ # * When you don't set the `x-amz-tagging-directive` header and the
643
+ # source object has non-empty tags. This is because the default value
644
+ # of `x-amz-tagging-directive` is `COPY`.
645
+ #
646
+ # Because only the empty tag-set is supported for directory buckets in a
647
+ # `CopyObject` operation, the following situations are allowed:
648
+ #
649
+ # * When you attempt to `COPY` the tag-set from a directory bucket
650
+ # source object that has no tags to a general purpose bucket. It
651
+ # copies an empty tag-set to the destination object.
652
+ #
653
+ # * When you attempt to `REPLACE` the tag-set of a directory bucket
654
+ # source object and set the `x-amz-tagging` value of the directory
655
+ # bucket destination object to empty.
656
+ #
657
+ # * When you attempt to `REPLACE` the tag-set of a general purpose
658
+ # bucket source object that has non-empty tags and set the
659
+ # `x-amz-tagging` value of the directory bucket destination object to
660
+ # empty.
661
+ #
662
+ # * When you attempt to `REPLACE` the tag-set of a directory bucket
663
+ # source object and don't set the `x-amz-tagging` value of the
664
+ # directory bucket destination object. This is because the default
665
+ # value of `x-amz-tagging` is the empty value.
666
+ #
667
+ # </note>
338
668
  # @option options [String] :server_side_encryption
339
- # The Server-side encryption algorithm used when storing this object in
340
- # S3 (e.g., AES256, aws:kms).
669
+ # The server-side encryption algorithm used when storing this object in
670
+ # Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
671
+ # Unrecognized or unsupported values won’t write a destination object
672
+ # and will receive a `400 Bad Request` response.
673
+ #
674
+ # Amazon S3 automatically encrypts all new objects that are copied to an
675
+ # S3 bucket. When copying an object, if you don't specify encryption
676
+ # information in your copy request, the encryption setting of the target
677
+ # object is set to the default encryption configuration of the
678
+ # destination bucket. By default, all buckets have a base level of
679
+ # encryption configuration that uses server-side encryption with Amazon
680
+ # S3 managed keys (SSE-S3). If the destination bucket has a default
681
+ # encryption configuration that uses server-side encryption with Key
682
+ # Management Service (KMS) keys (SSE-KMS), dual-layer server-side
683
+ # encryption with Amazon Web Services KMS keys (DSSE-KMS), or
684
+ # server-side encryption with customer-provided encryption keys (SSE-C),
685
+ # Amazon S3 uses the corresponding KMS key, or a customer-provided key
686
+ # to encrypt the target object copy.
687
+ #
688
+ # When you perform a `CopyObject` operation, if you want to use a
689
+ # different type of encryption setting for the target object, you can
690
+ # specify appropriate encryption-related headers to encrypt the target
691
+ # object with an Amazon S3 managed key, a KMS key, or a
692
+ # customer-provided key. If the encryption setting in your request is
693
+ # different from the default encryption configuration of the destination
694
+ # bucket, the encryption setting in your request takes precedence.
695
+ #
696
+ # With server-side encryption, Amazon S3 encrypts your data as it writes
697
+ # your data to disks in its data centers and decrypts the data when you
698
+ # access it. For more information about server-side encryption, see
699
+ # [Using Server-Side Encryption][1] in the *Amazon S3 User Guide*.
700
+ #
701
+ # <note markdown="1"> For directory buckets, only server-side encryption with Amazon S3
702
+ # managed keys (SSE-S3) (`AES256`) is supported.
703
+ #
704
+ # </note>
705
+ #
706
+ #
707
+ #
708
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
341
709
  # @option options [String] :storage_class
342
- # The type of storage to use for the object. Defaults to 'STANDARD'.
710
+ # If the `x-amz-storage-class` header is not used, the copied object
711
+ # will be stored in the `STANDARD` Storage Class by default. The
712
+ # `STANDARD` storage class provides high durability and high
713
+ # availability. Depending on performance needs, you can specify a
714
+ # different Storage Class.
715
+ #
716
+ # <note markdown="1"> * <b>Directory buckets </b> - For directory buckets, only the S3
717
+ # Express One Zone storage class is supported to store newly created
718
+ # objects. Unsupported storage class values won't write a destination
719
+ # object and will respond with the HTTP status code `400 Bad Request`.
720
+ #
721
+ # * <b>Amazon S3 on Outposts </b> - S3 on Outposts only uses the
722
+ # `OUTPOSTS` Storage Class.
723
+ #
724
+ # </note>
725
+ #
726
+ # You can use the `CopyObject` action to change the storage class of an
727
+ # object that is already stored in Amazon S3 by using the
728
+ # `x-amz-storage-class` header. For more information, see [Storage
729
+ # Classes][1] in the *Amazon S3 User Guide*.
730
+ #
731
+ # Before using an object as a source object for the copy operation, you
732
+ # must restore a copy of it if it meets any of the following conditions:
733
+ #
734
+ # * The storage class of the source object is `GLACIER` or
735
+ # `DEEP_ARCHIVE`.
736
+ #
737
+ # * The storage class of the source object is `INTELLIGENT_TIERING` and
738
+ # it's [S3 Intelligent-Tiering access tier][2] is `Archive Access` or
739
+ # `Deep Archive Access`.
740
+ #
741
+ # For more information, see [RestoreObject][3] and [Copying Objects][4]
742
+ # in the *Amazon S3 User Guide*.
743
+ #
744
+ #
745
+ #
746
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
747
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition
748
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
749
+ # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
343
750
  # @option options [String] :website_redirect_location
344
- # If the bucket is configured as a website, redirects requests for this
345
- # object to another object in the same bucket or to an external URL.
346
- # Amazon S3 stores the value of this header in the object metadata.
751
+ # If the destination bucket is configured as a website, redirects
752
+ # requests for this object copy to another object in the same bucket or
753
+ # to an external URL. Amazon S3 stores the value of this header in the
754
+ # object metadata. This value is unique to each object and is not copied
755
+ # when using the `x-amz-metadata-directive` header. Instead, you may opt
756
+ # to provide this header in combination with the
757
+ # `x-amz-metadata-directive` header.
758
+ #
759
+ # <note markdown="1"> This functionality is not supported for directory buckets.
760
+ #
761
+ # </note>
347
762
  # @option options [String] :sse_customer_algorithm
348
- # Specifies the algorithm to use to when encrypting the object (e.g.,
349
- # AES256).
763
+ # Specifies the algorithm to use when encrypting the object (for
764
+ # example, `AES256`).
765
+ #
766
+ # When you perform a `CopyObject` operation, if you want to use a
767
+ # different type of encryption setting for the target object, you can
768
+ # specify appropriate encryption-related headers to encrypt the target
769
+ # object with an Amazon S3 managed key, a KMS key, or a
770
+ # customer-provided key. If the encryption setting in your request is
771
+ # different from the default encryption configuration of the destination
772
+ # bucket, the encryption setting in your request takes precedence.
773
+ #
774
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
775
+ # directory bucket.
776
+ #
777
+ # </note>
350
778
  # @option options [String] :sse_customer_key
351
779
  # Specifies the customer-provided encryption key for Amazon S3 to use in
352
780
  # encrypting data. This value is used to store the object and then it is
353
- # discarded; Amazon does not store the encryption key. The key must be
354
- # appropriate for use with the algorithm specified in the
355
- # x-amz-server-side​-encryption​-customer-algorithm header.
781
+ # discarded. Amazon S3 does not store the encryption key. The key must
782
+ # be appropriate for use with the algorithm specified in the
783
+ # `x-amz-server-side-encryption-customer-algorithm` header.
784
+ #
785
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
786
+ # directory bucket.
787
+ #
788
+ # </note>
356
789
  # @option options [String] :sse_customer_key_md5
357
790
  # Specifies the 128-bit MD5 digest of the encryption key according to
358
791
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
359
- # ensure the encryption key was transmitted without error.
792
+ # ensure that the encryption key was transmitted without error.
793
+ #
794
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
795
+ # directory bucket.
796
+ #
797
+ # </note>
360
798
  # @option options [String] :ssekms_key_id
361
- # Specifies the AWS KMS key ID to use for object encryption. All GET and
362
- # PUT requests for an object protected by AWS KMS will fail if not made
363
- # via SSL or using SigV4. Documentation on configuring any of the
364
- # officially supported AWS SDKs and CLI can be found at
365
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
799
+ # Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object
800
+ # encryption. All GET and PUT requests for an object protected by KMS
801
+ # will fail if they're not made via SSL or using SigV4. For information
802
+ # about configuring any of the officially supported Amazon Web Services
803
+ # SDKs and Amazon Web Services CLI, see [Specifying the Signature
804
+ # Version in Request Authentication][1] in the *Amazon S3 User Guide*.
805
+ #
806
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
807
+ # directory bucket.
808
+ #
809
+ # </note>
810
+ #
811
+ #
812
+ #
813
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
366
814
  # @option options [String] :ssekms_encryption_context
367
- # Specifies the AWS KMS Encryption Context to use for object encryption.
368
- # The value of this header is a base64-encoded UTF-8 string holding JSON
369
- # with the encryption context key-value pairs.
815
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
816
+ # object encryption. The value of this header is a base64-encoded UTF-8
817
+ # string holding JSON with the encryption context key-value pairs. This
818
+ # value must be explicitly added to specify encryption context for
819
+ # `CopyObject` requests.
820
+ #
821
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
822
+ # directory bucket.
823
+ #
824
+ # </note>
825
+ # @option options [Boolean] :bucket_key_enabled
826
+ # Specifies whether Amazon S3 should use an S3 Bucket Key for object
827
+ # encryption with server-side encryption using Key Management Service
828
+ # (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable
829
+ # an S3 Bucket Key for the object.
830
+ #
831
+ # Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
832
+ # for object encryption with SSE-KMS. Specifying this header with a COPY
833
+ # action doesn’t affect bucket-level settings for S3 Bucket Key.
834
+ #
835
+ # For more information, see [Amazon S3 Bucket Keys][1] in the *Amazon S3
836
+ # User Guide*.
837
+ #
838
+ # <note markdown="1"> This functionality is not supported when the destination bucket is a
839
+ # directory bucket.
840
+ #
841
+ # </note>
842
+ #
843
+ #
844
+ #
845
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
370
846
  # @option options [String] :copy_source_sse_customer_algorithm
371
- # Specifies the algorithm to use when decrypting the source object
372
- # (e.g., AES256).
847
+ # Specifies the algorithm to use when decrypting the source object (for
848
+ # example, `AES256`).
849
+ #
850
+ # If the source object for the copy is stored in Amazon S3 using SSE-C,
851
+ # you must provide the necessary encryption information in your request
852
+ # so that Amazon S3 can decrypt the object for copying.
853
+ #
854
+ # <note markdown="1"> This functionality is not supported when the source object is in a
855
+ # directory bucket.
856
+ #
857
+ # </note>
373
858
  # @option options [String] :copy_source_sse_customer_key
374
859
  # Specifies the customer-provided encryption key for Amazon S3 to use to
375
860
  # decrypt the source object. The encryption key provided in this header
376
- # must be one that was used when the source object was created.
861
+ # must be the same one that was used when the source object was created.
862
+ #
863
+ # If the source object for the copy is stored in Amazon S3 using SSE-C,
864
+ # you must provide the necessary encryption information in your request
865
+ # so that Amazon S3 can decrypt the object for copying.
866
+ #
867
+ # <note markdown="1"> This functionality is not supported when the source object is in a
868
+ # directory bucket.
869
+ #
870
+ # </note>
377
871
  # @option options [String] :copy_source_sse_customer_key_md5
378
872
  # Specifies the 128-bit MD5 digest of the encryption key according to
379
873
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
380
- # ensure the encryption key was transmitted without error.
874
+ # ensure that the encryption key was transmitted without error.
875
+ #
876
+ # If the source object for the copy is stored in Amazon S3 using SSE-C,
877
+ # you must provide the necessary encryption information in your request
878
+ # so that Amazon S3 can decrypt the object for copying.
879
+ #
880
+ # <note markdown="1"> This functionality is not supported when the source object is in a
881
+ # directory bucket.
882
+ #
883
+ # </note>
381
884
  # @option options [String] :request_payer
382
- # Confirms that the requester knows that she or he will be charged for
383
- # the request. Bucket owners need not specify this parameter in their
384
- # requests. Documentation on downloading objects from requester pays
385
- # buckets can be found at
386
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
885
+ # Confirms that the requester knows that they will be charged for the
886
+ # request. Bucket owners need not specify this parameter in their
887
+ # requests. If either the source or destination S3 bucket has Requester
888
+ # Pays enabled, the requester will pay for corresponding charges to copy
889
+ # the object. For information about downloading objects from Requester
890
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
891
+ # in the *Amazon S3 User Guide*.
892
+ #
893
+ # <note markdown="1"> This functionality is not supported for directory buckets.
894
+ #
895
+ # </note>
896
+ #
897
+ #
898
+ #
899
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
387
900
  # @option options [String] :tagging
388
- # The tag-set for the object destination object this value must be used
389
- # in conjunction with the TaggingDirective. The tag-set must be encoded
390
- # as URL Query parameters
901
+ # The tag-set for the object copy in the destination bucket. This value
902
+ # must be used in conjunction with the `x-amz-tagging-directive` if you
903
+ # choose `REPLACE` for the `x-amz-tagging-directive`. If you choose
904
+ # `COPY` for the `x-amz-tagging-directive`, you don't need to set the
905
+ # `x-amz-tagging` header, because the tag-set will be copied from the
906
+ # source object directly. The tag-set must be encoded as URL Query
907
+ # parameters.
908
+ #
909
+ # The default value is the empty value.
910
+ #
911
+ # <note markdown="1"> **Directory buckets** - For directory buckets in a `CopyObject`
912
+ # operation, only the empty tag-set is supported. Any requests that
913
+ # attempt to write non-empty tags into directory buckets will receive a
914
+ # `501 Not Implemented` status code. When the destination bucket is a
915
+ # directory bucket, you will receive a `501 Not Implemented` response in
916
+ # any of the following situations:
917
+ #
918
+ # * When you attempt to `COPY` the tag-set from an S3 source object that
919
+ # has non-empty tags.
920
+ #
921
+ # * When you attempt to `REPLACE` the tag-set of a source object and set
922
+ # a non-empty value to `x-amz-tagging`.
923
+ #
924
+ # * When you don't set the `x-amz-tagging-directive` header and the
925
+ # source object has non-empty tags. This is because the default value
926
+ # of `x-amz-tagging-directive` is `COPY`.
927
+ #
928
+ # Because only the empty tag-set is supported for directory buckets in a
929
+ # `CopyObject` operation, the following situations are allowed:
930
+ #
931
+ # * When you attempt to `COPY` the tag-set from a directory bucket
932
+ # source object that has no tags to a general purpose bucket. It
933
+ # copies an empty tag-set to the destination object.
934
+ #
935
+ # * When you attempt to `REPLACE` the tag-set of a directory bucket
936
+ # source object and set the `x-amz-tagging` value of the directory
937
+ # bucket destination object to empty.
938
+ #
939
+ # * When you attempt to `REPLACE` the tag-set of a general purpose
940
+ # bucket source object that has non-empty tags and set the
941
+ # `x-amz-tagging` value of the directory bucket destination object to
942
+ # empty.
943
+ #
944
+ # * When you attempt to `REPLACE` the tag-set of a directory bucket
945
+ # source object and don't set the `x-amz-tagging` value of the
946
+ # directory bucket destination object. This is because the default
947
+ # value of `x-amz-tagging` is the empty value.
948
+ #
949
+ # </note>
391
950
  # @option options [String] :object_lock_mode
392
- # The object lock mode that you want to apply to the copied object.
951
+ # The Object Lock mode that you want to apply to the object copy.
952
+ #
953
+ # <note markdown="1"> This functionality is not supported for directory buckets.
954
+ #
955
+ # </note>
393
956
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
394
- # The date and time when you want the copied object's object lock to
957
+ # The date and time when you want the Object Lock of the object copy to
395
958
  # expire.
959
+ #
960
+ # <note markdown="1"> This functionality is not supported for directory buckets.
961
+ #
962
+ # </note>
396
963
  # @option options [String] :object_lock_legal_hold_status
397
- # Specifies whether you want to apply a Legal Hold to the copied object.
964
+ # Specifies whether you want to apply a legal hold to the object copy.
965
+ #
966
+ # <note markdown="1"> This functionality is not supported for directory buckets.
967
+ #
968
+ # </note>
969
+ # @option options [String] :expected_bucket_owner
970
+ # The account ID of the expected destination bucket owner. If the
971
+ # account ID that you provide does not match the actual owner of the
972
+ # destination bucket, the request fails with the HTTP status code `403
973
+ # Forbidden` (access denied).
974
+ # @option options [String] :expected_source_bucket_owner
975
+ # The account ID of the expected source bucket owner. If the account ID
976
+ # that you provide does not match the actual owner of the source bucket,
977
+ # the request fails with the HTTP status code `403 Forbidden` (access
978
+ # denied).
398
979
  # @return [Types::CopyObjectOutput]
399
980
  def copy_from(options = {})
400
981
  options = options.merge(
401
982
  bucket: @bucket_name,
402
983
  key: @key
403
984
  )
404
- resp = @client.copy_object(options)
985
+ resp = Aws::Plugins::UserAgent.feature('resource') do
986
+ @client.copy_object(options)
987
+ end
405
988
  resp.data
406
989
  end
407
990
 
@@ -412,29 +995,62 @@ module Aws::S3
412
995
  # version_id: "ObjectVersionId",
413
996
  # request_payer: "requester", # accepts requester
414
997
  # bypass_governance_retention: false,
998
+ # expected_bucket_owner: "AccountId",
415
999
  # })
416
1000
  # @param [Hash] options ({})
417
1001
  # @option options [String] :mfa
418
1002
  # The concatenation of the authentication device's serial number, a
419
1003
  # space, and the value that is displayed on your authentication device.
1004
+ # Required to permanently delete a versioned object if versioning is
1005
+ # configured with MFA delete enabled.
1006
+ #
1007
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1008
+ #
1009
+ # </note>
420
1010
  # @option options [String] :version_id
421
- # VersionId used to reference a specific version of the object.
1011
+ # Version ID used to reference a specific version of the object.
1012
+ #
1013
+ # <note markdown="1"> For directory buckets in this API operation, only the `null` value of
1014
+ # the version ID is supported.
1015
+ #
1016
+ # </note>
422
1017
  # @option options [String] :request_payer
423
- # Confirms that the requester knows that she or he will be charged for
424
- # the request. Bucket owners need not specify this parameter in their
425
- # requests. Documentation on downloading objects from requester pays
426
- # buckets can be found at
427
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1018
+ # Confirms that the requester knows that they will be charged for the
1019
+ # request. Bucket owners need not specify this parameter in their
1020
+ # requests. If either the source or destination S3 bucket has Requester
1021
+ # Pays enabled, the requester will pay for corresponding charges to copy
1022
+ # the object. For information about downloading objects from Requester
1023
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
1024
+ # in the *Amazon S3 User Guide*.
1025
+ #
1026
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1027
+ #
1028
+ # </note>
1029
+ #
1030
+ #
1031
+ #
1032
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
428
1033
  # @option options [Boolean] :bypass_governance_retention
429
- # Indicates whether Amazon S3 object lock should bypass governance-mode
430
- # restrictions to process this operation.
1034
+ # Indicates whether S3 Object Lock should bypass Governance-mode
1035
+ # restrictions to process this operation. To use this header, you must
1036
+ # have the `s3:BypassGovernanceRetention` permission.
1037
+ #
1038
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1039
+ #
1040
+ # </note>
1041
+ # @option options [String] :expected_bucket_owner
1042
+ # The account ID of the expected bucket owner. If the account ID that
1043
+ # you provide does not match the actual owner of the bucket, the request
1044
+ # fails with the HTTP status code `403 Forbidden` (access denied).
431
1045
  # @return [Types::DeleteObjectOutput]
432
1046
  def delete(options = {})
433
1047
  options = options.merge(
434
1048
  bucket: @bucket_name,
435
1049
  key: @key
436
1050
  )
437
- resp = @client.delete_object(options)
1051
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1052
+ @client.delete_object(options)
1053
+ end
438
1054
  resp.data
439
1055
  end
440
1056
 
@@ -458,69 +1074,239 @@ module Aws::S3
458
1074
  # sse_customer_key_md5: "SSECustomerKeyMD5",
459
1075
  # request_payer: "requester", # accepts requester
460
1076
  # part_number: 1,
1077
+ # expected_bucket_owner: "AccountId",
1078
+ # checksum_mode: "ENABLED", # accepts ENABLED
461
1079
  # })
462
1080
  # @param [Hash] options ({})
463
1081
  # @option options [String] :if_match
464
1082
  # Return the object only if its entity tag (ETag) is the same as the one
465
- # specified, otherwise return a 412 (precondition failed).
1083
+ # specified in this header; otherwise, return a `412 Precondition
1084
+ # Failed` error.
1085
+ #
1086
+ # If both of the `If-Match` and `If-Unmodified-Since` headers are
1087
+ # present in the request as follows: `If-Match` condition evaluates to
1088
+ # `true`, and; `If-Unmodified-Since` condition evaluates to `false`;
1089
+ # then, S3 returns `200 OK` and the data requested.
1090
+ #
1091
+ # For more information about conditional requests, see [RFC 7232][1].
1092
+ #
1093
+ #
1094
+ #
1095
+ # [1]: https://tools.ietf.org/html/rfc7232
466
1096
  # @option options [Time,DateTime,Date,Integer,String] :if_modified_since
467
1097
  # Return the object only if it has been modified since the specified
468
- # time, otherwise return a 304 (not modified).
1098
+ # time; otherwise, return a `304 Not Modified` error.
1099
+ #
1100
+ # If both of the `If-None-Match` and `If-Modified-Since` headers are
1101
+ # present in the request as follows:` If-None-Match` condition evaluates
1102
+ # to `false`, and; `If-Modified-Since` condition evaluates to `true`;
1103
+ # then, S3 returns `304 Not Modified` status code.
1104
+ #
1105
+ # For more information about conditional requests, see [RFC 7232][1].
1106
+ #
1107
+ #
1108
+ #
1109
+ # [1]: https://tools.ietf.org/html/rfc7232
469
1110
  # @option options [String] :if_none_match
470
1111
  # Return the object only if its entity tag (ETag) is different from the
471
- # one specified, otherwise return a 304 (not modified).
1112
+ # one specified in this header; otherwise, return a `304 Not Modified`
1113
+ # error.
1114
+ #
1115
+ # If both of the `If-None-Match` and `If-Modified-Since` headers are
1116
+ # present in the request as follows:` If-None-Match` condition evaluates
1117
+ # to `false`, and; `If-Modified-Since` condition evaluates to `true`;
1118
+ # then, S3 returns `304 Not Modified` HTTP status code.
1119
+ #
1120
+ # For more information about conditional requests, see [RFC 7232][1].
1121
+ #
1122
+ #
1123
+ #
1124
+ # [1]: https://tools.ietf.org/html/rfc7232
472
1125
  # @option options [Time,DateTime,Date,Integer,String] :if_unmodified_since
473
1126
  # Return the object only if it has not been modified since the specified
474
- # time, otherwise return a 412 (precondition failed).
1127
+ # time; otherwise, return a `412 Precondition Failed` error.
1128
+ #
1129
+ # If both of the `If-Match` and `If-Unmodified-Since` headers are
1130
+ # present in the request as follows: `If-Match` condition evaluates to
1131
+ # `true`, and; `If-Unmodified-Since` condition evaluates to `false`;
1132
+ # then, S3 returns `200 OK` and the data requested.
1133
+ #
1134
+ # For more information about conditional requests, see [RFC 7232][1].
1135
+ #
1136
+ #
1137
+ #
1138
+ # [1]: https://tools.ietf.org/html/rfc7232
475
1139
  # @option options [String] :range
476
- # Downloads the specified range bytes of an object. For more information
477
- # about the HTTP Range header, go to
478
- # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
1140
+ # Downloads the specified byte range of an object. For more information
1141
+ # about the HTTP Range header, see
1142
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-range][1].
1143
+ #
1144
+ # <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
1145
+ # `GET` request.
1146
+ #
1147
+ # </note>
1148
+ #
1149
+ #
1150
+ #
1151
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-range
479
1152
  # @option options [String] :response_cache_control
480
- # Sets the Cache-Control header of the response.
1153
+ # Sets the `Cache-Control` header of the response.
481
1154
  # @option options [String] :response_content_disposition
482
- # Sets the Content-Disposition header of the response
1155
+ # Sets the `Content-Disposition` header of the response.
483
1156
  # @option options [String] :response_content_encoding
484
- # Sets the Content-Encoding header of the response.
1157
+ # Sets the `Content-Encoding` header of the response.
485
1158
  # @option options [String] :response_content_language
486
- # Sets the Content-Language header of the response.
1159
+ # Sets the `Content-Language` header of the response.
487
1160
  # @option options [String] :response_content_type
488
- # Sets the Content-Type header of the response.
1161
+ # Sets the `Content-Type` header of the response.
489
1162
  # @option options [Time,DateTime,Date,Integer,String] :response_expires
490
- # Sets the Expires header of the response.
1163
+ # Sets the `Expires` header of the response.
491
1164
  # @option options [String] :version_id
492
- # VersionId used to reference a specific version of the object.
1165
+ # Version ID used to reference a specific version of the object.
1166
+ #
1167
+ # By default, the `GetObject` operation returns the current version of
1168
+ # an object. To return a different version, use the `versionId`
1169
+ # subresource.
1170
+ #
1171
+ # <note markdown="1"> * If you include a `versionId` in your request header, you must have
1172
+ # the `s3:GetObjectVersion` permission to access a specific version of
1173
+ # an object. The `s3:GetObject` permission is not required in this
1174
+ # scenario.
1175
+ #
1176
+ # * If you request the current version of an object without a specific
1177
+ # `versionId` in the request header, only the `s3:GetObject`
1178
+ # permission is required. The `s3:GetObjectVersion` permission is not
1179
+ # required in this scenario.
1180
+ #
1181
+ # * **Directory buckets** - S3 Versioning isn't enabled and supported
1182
+ # for directory buckets. For this API operation, only the `null` value
1183
+ # of the version ID is supported by directory buckets. You can only
1184
+ # specify `null` to the `versionId` query parameter in the request.
1185
+ #
1186
+ # </note>
1187
+ #
1188
+ # For more information about versioning, see [PutBucketVersioning][1].
1189
+ #
1190
+ #
1191
+ #
1192
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html
493
1193
  # @option options [String] :sse_customer_algorithm
494
- # Specifies the algorithm to use to when encrypting the object (e.g.,
495
- # AES256).
1194
+ # Specifies the algorithm to use when decrypting the object (for
1195
+ # example, `AES256`).
1196
+ #
1197
+ # If you encrypt an object by using server-side encryption with
1198
+ # customer-provided encryption keys (SSE-C) when you store the object in
1199
+ # Amazon S3, then when you GET the object, you must use the following
1200
+ # headers:
1201
+ #
1202
+ # * `x-amz-server-side-encryption-customer-algorithm`
1203
+ #
1204
+ # * `x-amz-server-side-encryption-customer-key`
1205
+ #
1206
+ # * `x-amz-server-side-encryption-customer-key-MD5`
1207
+ #
1208
+ # For more information about SSE-C, see [Server-Side Encryption (Using
1209
+ # Customer-Provided Encryption Keys)][1] in the *Amazon S3 User Guide*.
1210
+ #
1211
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1212
+ #
1213
+ # </note>
1214
+ #
1215
+ #
1216
+ #
1217
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
496
1218
  # @option options [String] :sse_customer_key
497
- # Specifies the customer-provided encryption key for Amazon S3 to use in
498
- # encrypting data. This value is used to store the object and then it is
499
- # discarded; Amazon does not store the encryption key. The key must be
500
- # appropriate for use with the algorithm specified in the
501
- # x-amz-server-side​-encryption​-customer-algorithm header.
1219
+ # Specifies the customer-provided encryption key that you originally
1220
+ # provided for Amazon S3 to encrypt the data before storing it. This
1221
+ # value is used to decrypt the object when recovering it and must match
1222
+ # the one used when storing the data. The key must be appropriate for
1223
+ # use with the algorithm specified in the
1224
+ # `x-amz-server-side-encryption-customer-algorithm` header.
1225
+ #
1226
+ # If you encrypt an object by using server-side encryption with
1227
+ # customer-provided encryption keys (SSE-C) when you store the object in
1228
+ # Amazon S3, then when you GET the object, you must use the following
1229
+ # headers:
1230
+ #
1231
+ # * `x-amz-server-side-encryption-customer-algorithm`
1232
+ #
1233
+ # * `x-amz-server-side-encryption-customer-key`
1234
+ #
1235
+ # * `x-amz-server-side-encryption-customer-key-MD5`
1236
+ #
1237
+ # For more information about SSE-C, see [Server-Side Encryption (Using
1238
+ # Customer-Provided Encryption Keys)][1] in the *Amazon S3 User Guide*.
1239
+ #
1240
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1241
+ #
1242
+ # </note>
1243
+ #
1244
+ #
1245
+ #
1246
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
502
1247
  # @option options [String] :sse_customer_key_md5
503
- # Specifies the 128-bit MD5 digest of the encryption key according to
504
- # RFC 1321. Amazon S3 uses this header for a message integrity check to
505
- # ensure the encryption key was transmitted without error.
506
- # @option options [String] :request_payer
507
- # Confirms that the requester knows that she or he will be charged for
508
- # the request. Bucket owners need not specify this parameter in their
509
- # requests. Documentation on downloading objects from requester pays
510
- # buckets can be found at
511
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
512
- # @option options [Integer] :part_number
513
- # Part number of the object being read. This is a positive integer
514
- # between 1 and 10,000. Effectively performs a 'ranged' GET request
515
- # for the part specified. Useful for downloading just a part of an
516
- # object.
1248
+ # Specifies the 128-bit MD5 digest of the customer-provided encryption
1249
+ # key according to RFC 1321. Amazon S3 uses this header for a message
1250
+ # integrity check to ensure that the encryption key was transmitted
1251
+ # without error.
1252
+ #
1253
+ # If you encrypt an object by using server-side encryption with
1254
+ # customer-provided encryption keys (SSE-C) when you store the object in
1255
+ # Amazon S3, then when you GET the object, you must use the following
1256
+ # headers:
1257
+ #
1258
+ # * `x-amz-server-side-encryption-customer-algorithm`
1259
+ #
1260
+ # * `x-amz-server-side-encryption-customer-key`
1261
+ #
1262
+ # * `x-amz-server-side-encryption-customer-key-MD5`
1263
+ #
1264
+ # For more information about SSE-C, see [Server-Side Encryption (Using
1265
+ # Customer-Provided Encryption Keys)][1] in the *Amazon S3 User Guide*.
1266
+ #
1267
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1268
+ #
1269
+ # </note>
1270
+ #
1271
+ #
1272
+ #
1273
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
1274
+ # @option options [String] :request_payer
1275
+ # Confirms that the requester knows that they will be charged for the
1276
+ # request. Bucket owners need not specify this parameter in their
1277
+ # requests. If either the source or destination S3 bucket has Requester
1278
+ # Pays enabled, the requester will pay for corresponding charges to copy
1279
+ # the object. For information about downloading objects from Requester
1280
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
1281
+ # in the *Amazon S3 User Guide*.
1282
+ #
1283
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1284
+ #
1285
+ # </note>
1286
+ #
1287
+ #
1288
+ #
1289
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1290
+ # @option options [Integer] :part_number
1291
+ # Part number of the object being read. This is a positive integer
1292
+ # between 1 and 10,000. Effectively performs a 'ranged' GET request
1293
+ # for the part specified. Useful for downloading just a part of an
1294
+ # object.
1295
+ # @option options [String] :expected_bucket_owner
1296
+ # The account ID of the expected bucket owner. If the account ID that
1297
+ # you provide does not match the actual owner of the bucket, the request
1298
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1299
+ # @option options [String] :checksum_mode
1300
+ # To retrieve the checksum, this mode must be enabled.
517
1301
  # @return [Types::GetObjectOutput]
518
1302
  def get(options = {}, &block)
519
1303
  options = options.merge(
520
1304
  bucket: @bucket_name,
521
1305
  key: @key
522
1306
  )
523
- resp = @client.get_object(options, &block)
1307
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1308
+ @client.get_object(options, &block)
1309
+ end
524
1310
  resp.data
525
1311
  end
526
1312
 
@@ -541,23 +1327,48 @@ module Aws::S3
541
1327
  # metadata: {
542
1328
  # "MetadataKey" => "MetadataValue",
543
1329
  # },
544
- # server_side_encryption: "AES256", # accepts AES256, aws:kms
545
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
1330
+ # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
1331
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
546
1332
  # website_redirect_location: "WebsiteRedirectLocation",
547
1333
  # sse_customer_algorithm: "SSECustomerAlgorithm",
548
1334
  # sse_customer_key: "SSECustomerKey",
549
1335
  # sse_customer_key_md5: "SSECustomerKeyMD5",
550
1336
  # ssekms_key_id: "SSEKMSKeyId",
551
1337
  # ssekms_encryption_context: "SSEKMSEncryptionContext",
1338
+ # bucket_key_enabled: false,
552
1339
  # request_payer: "requester", # accepts requester
553
1340
  # tagging: "TaggingHeader",
554
1341
  # object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
555
1342
  # object_lock_retain_until_date: Time.now,
556
1343
  # object_lock_legal_hold_status: "ON", # accepts ON, OFF
1344
+ # expected_bucket_owner: "AccountId",
1345
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
557
1346
  # })
558
1347
  # @param [Hash] options ({})
559
1348
  # @option options [String] :acl
560
- # The canned ACL to apply to the object.
1349
+ # The canned ACL to apply to the object. Amazon S3 supports a set of
1350
+ # predefined ACLs, known as *canned ACLs*. Each canned ACL has a
1351
+ # predefined set of grantees and permissions. For more information, see
1352
+ # [Canned ACL][1] in the *Amazon S3 User Guide*.
1353
+ #
1354
+ # By default, all objects are private. Only the owner has full access
1355
+ # control. When uploading an object, you can grant access permissions to
1356
+ # individual Amazon Web Services accounts or to predefined groups
1357
+ # defined by Amazon S3. These permissions are then added to the access
1358
+ # control list (ACL) on the new object. For more information, see [Using
1359
+ # ACLs][2]. One way to grant the permissions using the request headers
1360
+ # is to specify a canned ACL with the `x-amz-acl` request header.
1361
+ #
1362
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1363
+ #
1364
+ # * This functionality is not supported for Amazon S3 on Outposts.
1365
+ #
1366
+ # </note>
1367
+ #
1368
+ #
1369
+ #
1370
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
1371
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
561
1372
  # @option options [String] :cache_control
562
1373
  # Specifies caching behavior along the request/reply chain.
563
1374
  # @option options [String] :content_disposition
@@ -566,79 +1377,421 @@ module Aws::S3
566
1377
  # Specifies what content encodings have been applied to the object and
567
1378
  # thus what decoding mechanisms must be applied to obtain the media-type
568
1379
  # referenced by the Content-Type header field.
1380
+ #
1381
+ # <note markdown="1"> For directory buckets, only the `aws-chunked` value is supported in
1382
+ # this header field.
1383
+ #
1384
+ # </note>
569
1385
  # @option options [String] :content_language
570
- # The language the content is in.
1386
+ # The language that the content is in.
571
1387
  # @option options [String] :content_type
572
1388
  # A standard MIME type describing the format of the object data.
573
1389
  # @option options [Time,DateTime,Date,Integer,String] :expires
574
1390
  # The date and time at which the object is no longer cacheable.
575
1391
  # @option options [String] :grant_full_control
576
- # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
577
- # object.
1392
+ # Specify access permissions explicitly to give the grantee READ,
1393
+ # READ\_ACP, and WRITE\_ACP permissions on the object.
1394
+ #
1395
+ # By default, all objects are private. Only the owner has full access
1396
+ # control. When uploading an object, you can use this header to
1397
+ # explicitly grant access permissions to specific Amazon Web Services
1398
+ # accounts or groups. This header maps to specific permissions that
1399
+ # Amazon S3 supports in an ACL. For more information, see [Access
1400
+ # Control List (ACL) Overview][1] in the *Amazon S3 User Guide*.
1401
+ #
1402
+ # You specify each grantee as a type=value pair, where the type is one
1403
+ # of the following:
1404
+ #
1405
+ # * `id` – if the value specified is the canonical user ID of an Amazon
1406
+ # Web Services account
1407
+ #
1408
+ # * `uri` – if you are granting permissions to a predefined group
1409
+ #
1410
+ # * `emailAddress` – if the value specified is the email address of an
1411
+ # Amazon Web Services account
1412
+ #
1413
+ # <note markdown="1"> Using email addresses to specify a grantee is only supported in the
1414
+ # following Amazon Web Services Regions:
1415
+ #
1416
+ # * US East (N. Virginia)
1417
+ #
1418
+ # * US West (N. California)
1419
+ #
1420
+ # * US West (Oregon)
1421
+ #
1422
+ # * Asia Pacific (Singapore)
1423
+ #
1424
+ # * Asia Pacific (Sydney)
1425
+ #
1426
+ # * Asia Pacific (Tokyo)
1427
+ #
1428
+ # * Europe (Ireland)
1429
+ #
1430
+ # * South America (São Paulo)
1431
+ #
1432
+ # For a list of all the Amazon S3 supported Regions and endpoints, see
1433
+ # [Regions and Endpoints][2] in the Amazon Web Services General
1434
+ # Reference.
1435
+ #
1436
+ # </note>
1437
+ #
1438
+ # For example, the following `x-amz-grant-read` header grants the Amazon
1439
+ # Web Services accounts identified by account IDs permissions to read
1440
+ # object data and its metadata:
1441
+ #
1442
+ # `x-amz-grant-read: id="11112222333", id="444455556666" `
1443
+ #
1444
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1445
+ #
1446
+ # * This functionality is not supported for Amazon S3 on Outposts.
1447
+ #
1448
+ # </note>
1449
+ #
1450
+ #
1451
+ #
1452
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
1453
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
578
1454
  # @option options [String] :grant_read
579
- # Allows grantee to read the object data and its metadata.
1455
+ # Specify access permissions explicitly to allow grantee to read the
1456
+ # object data and its metadata.
1457
+ #
1458
+ # By default, all objects are private. Only the owner has full access
1459
+ # control. When uploading an object, you can use this header to
1460
+ # explicitly grant access permissions to specific Amazon Web Services
1461
+ # accounts or groups. This header maps to specific permissions that
1462
+ # Amazon S3 supports in an ACL. For more information, see [Access
1463
+ # Control List (ACL) Overview][1] in the *Amazon S3 User Guide*.
1464
+ #
1465
+ # You specify each grantee as a type=value pair, where the type is one
1466
+ # of the following:
1467
+ #
1468
+ # * `id` – if the value specified is the canonical user ID of an Amazon
1469
+ # Web Services account
1470
+ #
1471
+ # * `uri` – if you are granting permissions to a predefined group
1472
+ #
1473
+ # * `emailAddress` – if the value specified is the email address of an
1474
+ # Amazon Web Services account
1475
+ #
1476
+ # <note markdown="1"> Using email addresses to specify a grantee is only supported in the
1477
+ # following Amazon Web Services Regions:
1478
+ #
1479
+ # * US East (N. Virginia)
1480
+ #
1481
+ # * US West (N. California)
1482
+ #
1483
+ # * US West (Oregon)
1484
+ #
1485
+ # * Asia Pacific (Singapore)
1486
+ #
1487
+ # * Asia Pacific (Sydney)
1488
+ #
1489
+ # * Asia Pacific (Tokyo)
1490
+ #
1491
+ # * Europe (Ireland)
1492
+ #
1493
+ # * South America (São Paulo)
1494
+ #
1495
+ # For a list of all the Amazon S3 supported Regions and endpoints, see
1496
+ # [Regions and Endpoints][2] in the Amazon Web Services General
1497
+ # Reference.
1498
+ #
1499
+ # </note>
1500
+ #
1501
+ # For example, the following `x-amz-grant-read` header grants the Amazon
1502
+ # Web Services accounts identified by account IDs permissions to read
1503
+ # object data and its metadata:
1504
+ #
1505
+ # `x-amz-grant-read: id="11112222333", id="444455556666" `
1506
+ #
1507
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1508
+ #
1509
+ # * This functionality is not supported for Amazon S3 on Outposts.
1510
+ #
1511
+ # </note>
1512
+ #
1513
+ #
1514
+ #
1515
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
1516
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
580
1517
  # @option options [String] :grant_read_acp
581
- # Allows grantee to read the object ACL.
1518
+ # Specify access permissions explicitly to allows grantee to read the
1519
+ # object ACL.
1520
+ #
1521
+ # By default, all objects are private. Only the owner has full access
1522
+ # control. When uploading an object, you can use this header to
1523
+ # explicitly grant access permissions to specific Amazon Web Services
1524
+ # accounts or groups. This header maps to specific permissions that
1525
+ # Amazon S3 supports in an ACL. For more information, see [Access
1526
+ # Control List (ACL) Overview][1] in the *Amazon S3 User Guide*.
1527
+ #
1528
+ # You specify each grantee as a type=value pair, where the type is one
1529
+ # of the following:
1530
+ #
1531
+ # * `id` – if the value specified is the canonical user ID of an Amazon
1532
+ # Web Services account
1533
+ #
1534
+ # * `uri` – if you are granting permissions to a predefined group
1535
+ #
1536
+ # * `emailAddress` – if the value specified is the email address of an
1537
+ # Amazon Web Services account
1538
+ #
1539
+ # <note markdown="1"> Using email addresses to specify a grantee is only supported in the
1540
+ # following Amazon Web Services Regions:
1541
+ #
1542
+ # * US East (N. Virginia)
1543
+ #
1544
+ # * US West (N. California)
1545
+ #
1546
+ # * US West (Oregon)
1547
+ #
1548
+ # * Asia Pacific (Singapore)
1549
+ #
1550
+ # * Asia Pacific (Sydney)
1551
+ #
1552
+ # * Asia Pacific (Tokyo)
1553
+ #
1554
+ # * Europe (Ireland)
1555
+ #
1556
+ # * South America (São Paulo)
1557
+ #
1558
+ # For a list of all the Amazon S3 supported Regions and endpoints, see
1559
+ # [Regions and Endpoints][2] in the Amazon Web Services General
1560
+ # Reference.
1561
+ #
1562
+ # </note>
1563
+ #
1564
+ # For example, the following `x-amz-grant-read` header grants the Amazon
1565
+ # Web Services accounts identified by account IDs permissions to read
1566
+ # object data and its metadata:
1567
+ #
1568
+ # `x-amz-grant-read: id="11112222333", id="444455556666" `
1569
+ #
1570
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1571
+ #
1572
+ # * This functionality is not supported for Amazon S3 on Outposts.
1573
+ #
1574
+ # </note>
1575
+ #
1576
+ #
1577
+ #
1578
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
1579
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
582
1580
  # @option options [String] :grant_write_acp
583
- # Allows grantee to write the ACL for the applicable object.
1581
+ # Specify access permissions explicitly to allows grantee to allow
1582
+ # grantee to write the ACL for the applicable object.
1583
+ #
1584
+ # By default, all objects are private. Only the owner has full access
1585
+ # control. When uploading an object, you can use this header to
1586
+ # explicitly grant access permissions to specific Amazon Web Services
1587
+ # accounts or groups. This header maps to specific permissions that
1588
+ # Amazon S3 supports in an ACL. For more information, see [Access
1589
+ # Control List (ACL) Overview][1] in the *Amazon S3 User Guide*.
1590
+ #
1591
+ # You specify each grantee as a type=value pair, where the type is one
1592
+ # of the following:
1593
+ #
1594
+ # * `id` – if the value specified is the canonical user ID of an Amazon
1595
+ # Web Services account
1596
+ #
1597
+ # * `uri` – if you are granting permissions to a predefined group
1598
+ #
1599
+ # * `emailAddress` – if the value specified is the email address of an
1600
+ # Amazon Web Services account
1601
+ #
1602
+ # <note markdown="1"> Using email addresses to specify a grantee is only supported in the
1603
+ # following Amazon Web Services Regions:
1604
+ #
1605
+ # * US East (N. Virginia)
1606
+ #
1607
+ # * US West (N. California)
1608
+ #
1609
+ # * US West (Oregon)
1610
+ #
1611
+ # * Asia Pacific (Singapore)
1612
+ #
1613
+ # * Asia Pacific (Sydney)
1614
+ #
1615
+ # * Asia Pacific (Tokyo)
1616
+ #
1617
+ # * Europe (Ireland)
1618
+ #
1619
+ # * South America (São Paulo)
1620
+ #
1621
+ # For a list of all the Amazon S3 supported Regions and endpoints, see
1622
+ # [Regions and Endpoints][2] in the Amazon Web Services General
1623
+ # Reference.
1624
+ #
1625
+ # </note>
1626
+ #
1627
+ # For example, the following `x-amz-grant-read` header grants the Amazon
1628
+ # Web Services accounts identified by account IDs permissions to read
1629
+ # object data and its metadata:
1630
+ #
1631
+ # `x-amz-grant-read: id="11112222333", id="444455556666" `
1632
+ #
1633
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1634
+ #
1635
+ # * This functionality is not supported for Amazon S3 on Outposts.
1636
+ #
1637
+ # </note>
1638
+ #
1639
+ #
1640
+ #
1641
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
1642
+ # [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
584
1643
  # @option options [Hash<String,String>] :metadata
585
1644
  # A map of metadata to store with the object in S3.
586
1645
  # @option options [String] :server_side_encryption
587
- # The Server-side encryption algorithm used when storing this object in
588
- # S3 (e.g., AES256, aws:kms).
1646
+ # The server-side encryption algorithm used when you store this object
1647
+ # in Amazon S3 (for example, `AES256`, `aws:kms`).
1648
+ #
1649
+ # <note markdown="1"> For directory buckets, only server-side encryption with Amazon S3
1650
+ # managed keys (SSE-S3) (`AES256`) is supported.
1651
+ #
1652
+ # </note>
589
1653
  # @option options [String] :storage_class
590
- # The type of storage to use for the object. Defaults to 'STANDARD'.
1654
+ # By default, Amazon S3 uses the STANDARD Storage Class to store newly
1655
+ # created objects. The STANDARD storage class provides high durability
1656
+ # and high availability. Depending on performance needs, you can specify
1657
+ # a different Storage Class. For more information, see [Storage
1658
+ # Classes][1] in the *Amazon S3 User Guide*.
1659
+ #
1660
+ # <note markdown="1"> * For directory buckets, only the S3 Express One Zone storage class is
1661
+ # supported to store newly created objects.
1662
+ #
1663
+ # * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
1664
+ #
1665
+ # </note>
1666
+ #
1667
+ #
1668
+ #
1669
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
591
1670
  # @option options [String] :website_redirect_location
592
1671
  # If the bucket is configured as a website, redirects requests for this
593
1672
  # object to another object in the same bucket or to an external URL.
594
1673
  # Amazon S3 stores the value of this header in the object metadata.
1674
+ #
1675
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1676
+ #
1677
+ # </note>
595
1678
  # @option options [String] :sse_customer_algorithm
596
- # Specifies the algorithm to use to when encrypting the object (e.g.,
597
- # AES256).
1679
+ # Specifies the algorithm to use when encrypting the object (for
1680
+ # example, AES256).
1681
+ #
1682
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1683
+ #
1684
+ # </note>
598
1685
  # @option options [String] :sse_customer_key
599
1686
  # Specifies the customer-provided encryption key for Amazon S3 to use in
600
1687
  # encrypting data. This value is used to store the object and then it is
601
- # discarded; Amazon does not store the encryption key. The key must be
602
- # appropriate for use with the algorithm specified in the
603
- # x-amz-server-side​-encryption​-customer-algorithm header.
1688
+ # discarded; Amazon S3 does not store the encryption key. The key must
1689
+ # be appropriate for use with the algorithm specified in the
1690
+ # `x-amz-server-side-encryption-customer-algorithm` header.
1691
+ #
1692
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1693
+ #
1694
+ # </note>
604
1695
  # @option options [String] :sse_customer_key_md5
605
- # Specifies the 128-bit MD5 digest of the encryption key according to
606
- # RFC 1321. Amazon S3 uses this header for a message integrity check to
607
- # ensure the encryption key was transmitted without error.
1696
+ # Specifies the 128-bit MD5 digest of the customer-provided encryption
1697
+ # key according to RFC 1321. Amazon S3 uses this header for a message
1698
+ # integrity check to ensure that the encryption key was transmitted
1699
+ # without error.
1700
+ #
1701
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1702
+ #
1703
+ # </note>
608
1704
  # @option options [String] :ssekms_key_id
609
- # Specifies the AWS KMS key ID to use for object encryption. All GET and
610
- # PUT requests for an object protected by AWS KMS will fail if not made
611
- # via SSL or using SigV4. Documentation on configuring any of the
612
- # officially supported AWS SDKs and CLI can be found at
613
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
1705
+ # Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric
1706
+ # encryption customer managed key to use for object encryption.
1707
+ #
1708
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1709
+ #
1710
+ # </note>
614
1711
  # @option options [String] :ssekms_encryption_context
615
- # Specifies the AWS KMS Encryption Context to use for object encryption.
616
- # The value of this header is a base64-encoded UTF-8 string holding JSON
617
- # with the encryption context key-value pairs.
1712
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
1713
+ # object encryption. The value of this header is a base64-encoded UTF-8
1714
+ # string holding JSON with the encryption context key-value pairs.
1715
+ #
1716
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1717
+ #
1718
+ # </note>
1719
+ # @option options [Boolean] :bucket_key_enabled
1720
+ # Specifies whether Amazon S3 should use an S3 Bucket Key for object
1721
+ # encryption with server-side encryption using Key Management Service
1722
+ # (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
1723
+ # to use an S3 Bucket Key for object encryption with SSE-KMS.
1724
+ #
1725
+ # Specifying this header with an object action doesn’t affect
1726
+ # bucket-level settings for S3 Bucket Key.
1727
+ #
1728
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1729
+ #
1730
+ # </note>
618
1731
  # @option options [String] :request_payer
619
- # Confirms that the requester knows that she or he will be charged for
620
- # the request. Bucket owners need not specify this parameter in their
621
- # requests. Documentation on downloading objects from requester pays
622
- # buckets can be found at
623
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1732
+ # Confirms that the requester knows that they will be charged for the
1733
+ # request. Bucket owners need not specify this parameter in their
1734
+ # requests. If either the source or destination S3 bucket has Requester
1735
+ # Pays enabled, the requester will pay for corresponding charges to copy
1736
+ # the object. For information about downloading objects from Requester
1737
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
1738
+ # in the *Amazon S3 User Guide*.
1739
+ #
1740
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1741
+ #
1742
+ # </note>
1743
+ #
1744
+ #
1745
+ #
1746
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
624
1747
  # @option options [String] :tagging
625
1748
  # The tag-set for the object. The tag-set must be encoded as URL Query
626
- # parameters
1749
+ # parameters.
1750
+ #
1751
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1752
+ #
1753
+ # </note>
627
1754
  # @option options [String] :object_lock_mode
628
- # Specifies the object lock mode that you want to apply to the uploaded
1755
+ # Specifies the Object Lock mode that you want to apply to the uploaded
629
1756
  # object.
1757
+ #
1758
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1759
+ #
1760
+ # </note>
630
1761
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
631
- # Specifies the date and time when you want the object lock to expire.
1762
+ # Specifies the date and time when you want the Object Lock to expire.
1763
+ #
1764
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1765
+ #
1766
+ # </note>
632
1767
  # @option options [String] :object_lock_legal_hold_status
633
- # Specifies whether you want to apply a Legal Hold to the uploaded
1768
+ # Specifies whether you want to apply a legal hold to the uploaded
634
1769
  # object.
1770
+ #
1771
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1772
+ #
1773
+ # </note>
1774
+ # @option options [String] :expected_bucket_owner
1775
+ # The account ID of the expected bucket owner. If the account ID that
1776
+ # you provide does not match the actual owner of the bucket, the request
1777
+ # fails with the HTTP status code `403 Forbidden` (access denied).
1778
+ # @option options [String] :checksum_algorithm
1779
+ # Indicates the algorithm that you want Amazon S3 to use to create the
1780
+ # checksum for the object. For more information, see [Checking object
1781
+ # integrity][1] in the *Amazon S3 User Guide*.
1782
+ #
1783
+ #
1784
+ #
1785
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
635
1786
  # @return [MultipartUpload]
636
1787
  def initiate_multipart_upload(options = {})
637
1788
  options = options.merge(
638
1789
  bucket: @bucket_name,
639
1790
  key: @key
640
1791
  )
641
- resp = @client.create_multipart_upload(options)
1792
+ resp = Aws::Plugins::UserAgent.feature('resource') do
1793
+ @client.create_multipart_upload(options)
1794
+ end
642
1795
  MultipartUpload.new(
643
1796
  bucket_name: @bucket_name,
644
1797
  object_key: @key,
@@ -659,6 +1812,11 @@ module Aws::S3
659
1812
  # content_length: 1,
660
1813
  # content_md5: "ContentMD5",
661
1814
  # content_type: "ContentType",
1815
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
1816
+ # checksum_crc32: "ChecksumCRC32",
1817
+ # checksum_crc32c: "ChecksumCRC32C",
1818
+ # checksum_sha1: "ChecksumSHA1",
1819
+ # checksum_sha256: "ChecksumSHA256",
662
1820
  # expires: Time.now,
663
1821
  # grant_full_control: "GrantFullControl",
664
1822
  # grant_read: "GrantRead",
@@ -667,111 +1825,444 @@ module Aws::S3
667
1825
  # metadata: {
668
1826
  # "MetadataKey" => "MetadataValue",
669
1827
  # },
670
- # server_side_encryption: "AES256", # accepts AES256, aws:kms
671
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
1828
+ # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse
1829
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
672
1830
  # website_redirect_location: "WebsiteRedirectLocation",
673
1831
  # sse_customer_algorithm: "SSECustomerAlgorithm",
674
1832
  # sse_customer_key: "SSECustomerKey",
675
1833
  # sse_customer_key_md5: "SSECustomerKeyMD5",
676
1834
  # ssekms_key_id: "SSEKMSKeyId",
677
1835
  # ssekms_encryption_context: "SSEKMSEncryptionContext",
1836
+ # bucket_key_enabled: false,
678
1837
  # request_payer: "requester", # accepts requester
679
1838
  # tagging: "TaggingHeader",
680
1839
  # object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
681
1840
  # object_lock_retain_until_date: Time.now,
682
1841
  # object_lock_legal_hold_status: "ON", # accepts ON, OFF
1842
+ # expected_bucket_owner: "AccountId",
683
1843
  # })
684
1844
  # @param [Hash] options ({})
685
1845
  # @option options [String] :acl
686
- # The canned ACL to apply to the object.
687
- # @option options [String, IO] :body
1846
+ # The canned ACL to apply to the object. For more information, see
1847
+ # [Canned ACL][1] in the *Amazon S3 User Guide*.
1848
+ #
1849
+ # When adding a new object, you can use headers to grant ACL-based
1850
+ # permissions to individual Amazon Web Services accounts or to
1851
+ # predefined groups defined by Amazon S3. These permissions are then
1852
+ # added to the ACL on the object. By default, all objects are private.
1853
+ # Only the owner has full access control. For more information, see
1854
+ # [Access Control List (ACL) Overview][2] and [Managing ACLs Using the
1855
+ # REST API][3] in the *Amazon S3 User Guide*.
1856
+ #
1857
+ # If the bucket that you're uploading objects to uses the bucket owner
1858
+ # enforced setting for S3 Object Ownership, ACLs are disabled and no
1859
+ # longer affect permissions. Buckets that use this setting only accept
1860
+ # PUT requests that don't specify an ACL or PUT requests that specify
1861
+ # bucket owner full control ACLs, such as the
1862
+ # `bucket-owner-full-control` canned ACL or an equivalent form of this
1863
+ # ACL expressed in the XML format. PUT requests that contain other ACLs
1864
+ # (for example, custom grants to certain Amazon Web Services accounts)
1865
+ # fail and return a `400` error with the error code
1866
+ # `AccessControlListNotSupported`. For more information, see [
1867
+ # Controlling ownership of objects and disabling ACLs][4] in the *Amazon
1868
+ # S3 User Guide*.
1869
+ #
1870
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
1871
+ #
1872
+ # * This functionality is not supported for Amazon S3 on Outposts.
1873
+ #
1874
+ # </note>
1875
+ #
1876
+ #
1877
+ #
1878
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
1879
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
1880
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
1881
+ # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
1882
+ # @option options [String, StringIO, File] :body
688
1883
  # Object data.
689
1884
  # @option options [String] :cache_control
690
- # Specifies caching behavior along the request/reply chain.
1885
+ # Can be used to specify caching behavior along the request/reply chain.
1886
+ # For more information, see
1887
+ # [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9][1].
1888
+ #
1889
+ #
1890
+ #
1891
+ # [1]: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
691
1892
  # @option options [String] :content_disposition
692
- # Specifies presentational information for the object.
1893
+ # Specifies presentational information for the object. For more
1894
+ # information, see
1895
+ # [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
1896
+ #
1897
+ #
1898
+ #
1899
+ # [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
693
1900
  # @option options [String] :content_encoding
694
1901
  # Specifies what content encodings have been applied to the object and
695
1902
  # thus what decoding mechanisms must be applied to obtain the media-type
696
- # referenced by the Content-Type header field.
1903
+ # referenced by the Content-Type header field. For more information, see
1904
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
1905
+ #
1906
+ #
1907
+ #
1908
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
697
1909
  # @option options [String] :content_language
698
1910
  # The language the content is in.
699
1911
  # @option options [Integer] :content_length
700
1912
  # Size of the body in bytes. This parameter is useful when the size of
701
- # the body cannot be determined automatically.
1913
+ # the body cannot be determined automatically. For more information, see
1914
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
1915
+ #
1916
+ #
1917
+ #
1918
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
702
1919
  # @option options [String] :content_md5
703
- # The base64-encoded 128-bit MD5 digest of the part data. This parameter
704
- # is auto-populated when using the command from the CLI. This parameted
705
- # is required if object lock parameters are specified.
1920
+ # The base64-encoded 128-bit MD5 digest of the message (without the
1921
+ # headers) according to RFC 1864. This header can be used as a message
1922
+ # integrity check to verify that the data is the same data that was
1923
+ # originally sent. Although it is optional, we recommend using the
1924
+ # Content-MD5 mechanism as an end-to-end integrity check. For more
1925
+ # information about REST request authentication, see [REST
1926
+ # Authentication][1].
1927
+ #
1928
+ # <note markdown="1"> The `Content-MD5` header is required for any request to upload an
1929
+ # object with a retention period configured using Amazon S3 Object Lock.
1930
+ # For more information about Amazon S3 Object Lock, see [Amazon S3
1931
+ # Object Lock Overview][2] in the *Amazon S3 User Guide*.
1932
+ #
1933
+ # </note>
1934
+ #
1935
+ # <note markdown="1"> This functionality is not supported for directory buckets.
1936
+ #
1937
+ # </note>
1938
+ #
1939
+ #
1940
+ #
1941
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
1942
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
706
1943
  # @option options [String] :content_type
707
- # A standard MIME type describing the format of the object data.
1944
+ # A standard MIME type describing the format of the contents. For more
1945
+ # information, see
1946
+ # [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
1947
+ #
1948
+ #
1949
+ #
1950
+ # [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
1951
+ # @option options [String] :checksum_algorithm
1952
+ # Indicates the algorithm used to create the checksum for the object
1953
+ # when you use the SDK. This header will not provide any additional
1954
+ # functionality if you don't use the SDK. When you send this header,
1955
+ # there must be a corresponding `x-amz-checksum-algorithm ` or
1956
+ # `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
1957
+ # with the HTTP status code `400 Bad Request`.
1958
+ #
1959
+ # For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
1960
+ # the supported algorithm from the following list:
1961
+ #
1962
+ # * CRC32
1963
+ #
1964
+ # * CRC32C
1965
+ #
1966
+ # * SHA1
1967
+ #
1968
+ # * SHA256
1969
+ #
1970
+ # For more information, see [Checking object integrity][1] in the
1971
+ # *Amazon S3 User Guide*.
1972
+ #
1973
+ # If the individual checksum value you provide through
1974
+ # `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
1975
+ # set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any
1976
+ # provided `ChecksumAlgorithm` parameter and uses the checksum algorithm
1977
+ # that matches the provided value in `x-amz-checksum-algorithm `.
1978
+ #
1979
+ # <note markdown="1"> For directory buckets, when you use Amazon Web Services SDKs, `CRC32`
1980
+ # is the default checksum algorithm that's used for performance.
1981
+ #
1982
+ # </note>
1983
+ #
1984
+ #
1985
+ #
1986
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1987
+ # @option options [String] :checksum_crc32
1988
+ # This header can be used as a data integrity check to verify that the
1989
+ # data received is the same data that was originally sent. This header
1990
+ # specifies the base64-encoded, 32-bit CRC32 checksum of the object. For
1991
+ # more information, see [Checking object integrity][1] in the *Amazon S3
1992
+ # User Guide*.
1993
+ #
1994
+ #
1995
+ #
1996
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1997
+ # @option options [String] :checksum_crc32c
1998
+ # This header can be used as a data integrity check to verify that the
1999
+ # data received is the same data that was originally sent. This header
2000
+ # specifies the base64-encoded, 32-bit CRC32C checksum of the object.
2001
+ # For more information, see [Checking object integrity][1] in the
2002
+ # *Amazon S3 User Guide*.
2003
+ #
2004
+ #
2005
+ #
2006
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
2007
+ # @option options [String] :checksum_sha1
2008
+ # This header can be used as a data integrity check to verify that the
2009
+ # data received is the same data that was originally sent. This header
2010
+ # specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
2011
+ # more information, see [Checking object integrity][1] in the *Amazon S3
2012
+ # User Guide*.
2013
+ #
2014
+ #
2015
+ #
2016
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
2017
+ # @option options [String] :checksum_sha256
2018
+ # This header can be used as a data integrity check to verify that the
2019
+ # data received is the same data that was originally sent. This header
2020
+ # specifies the base64-encoded, 256-bit SHA-256 digest of the object.
2021
+ # For more information, see [Checking object integrity][1] in the
2022
+ # *Amazon S3 User Guide*.
2023
+ #
2024
+ #
2025
+ #
2026
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
708
2027
  # @option options [Time,DateTime,Date,Integer,String] :expires
709
- # The date and time at which the object is no longer cacheable.
2028
+ # The date and time at which the object is no longer cacheable. For more
2029
+ # information, see
2030
+ # [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
2031
+ #
2032
+ #
2033
+ #
2034
+ # [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
710
2035
  # @option options [String] :grant_full_control
711
2036
  # Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
712
2037
  # object.
2038
+ #
2039
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
2040
+ #
2041
+ # * This functionality is not supported for Amazon S3 on Outposts.
2042
+ #
2043
+ # </note>
713
2044
  # @option options [String] :grant_read
714
2045
  # Allows grantee to read the object data and its metadata.
2046
+ #
2047
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
2048
+ #
2049
+ # * This functionality is not supported for Amazon S3 on Outposts.
2050
+ #
2051
+ # </note>
715
2052
  # @option options [String] :grant_read_acp
716
2053
  # Allows grantee to read the object ACL.
2054
+ #
2055
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
2056
+ #
2057
+ # * This functionality is not supported for Amazon S3 on Outposts.
2058
+ #
2059
+ # </note>
717
2060
  # @option options [String] :grant_write_acp
718
2061
  # Allows grantee to write the ACL for the applicable object.
2062
+ #
2063
+ # <note markdown="1"> * This functionality is not supported for directory buckets.
2064
+ #
2065
+ # * This functionality is not supported for Amazon S3 on Outposts.
2066
+ #
2067
+ # </note>
719
2068
  # @option options [Hash<String,String>] :metadata
720
2069
  # A map of metadata to store with the object in S3.
721
2070
  # @option options [String] :server_side_encryption
722
- # The Server-side encryption algorithm used when storing this object in
723
- # S3 (e.g., AES256, aws:kms).
2071
+ # The server-side encryption algorithm that was used when you store this
2072
+ # object in Amazon S3 (for example, `AES256`, `aws:kms`,
2073
+ # `aws:kms:dsse`).
2074
+ #
2075
+ # <b>General purpose buckets </b> - You have four mutually exclusive
2076
+ # options to protect data using server-side encryption in Amazon S3,
2077
+ # depending on how you choose to manage the encryption keys.
2078
+ # Specifically, the encryption key options are Amazon S3 managed keys
2079
+ # (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
2080
+ # customer-provided keys (SSE-C). Amazon S3 encrypts data with
2081
+ # server-side encryption by using Amazon S3 managed keys (SSE-S3) by
2082
+ # default. You can optionally tell Amazon S3 to encrypt data at rest by
2083
+ # using server-side encryption with other key options. For more
2084
+ # information, see [Using Server-Side Encryption][1] in the *Amazon S3
2085
+ # User Guide*.
2086
+ #
2087
+ # <b>Directory buckets </b> - For directory buckets, only the
2088
+ # server-side encryption with Amazon S3 managed keys (SSE-S3) (`AES256`)
2089
+ # value is supported.
2090
+ #
2091
+ #
2092
+ #
2093
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
724
2094
  # @option options [String] :storage_class
725
- # The type of storage to use for the object. Defaults to 'STANDARD'.
2095
+ # By default, Amazon S3 uses the STANDARD Storage Class to store newly
2096
+ # created objects. The STANDARD storage class provides high durability
2097
+ # and high availability. Depending on performance needs, you can specify
2098
+ # a different Storage Class. For more information, see [Storage
2099
+ # Classes][1] in the *Amazon S3 User Guide*.
2100
+ #
2101
+ # <note markdown="1"> * For directory buckets, only the S3 Express One Zone storage class is
2102
+ # supported to store newly created objects.
2103
+ #
2104
+ # * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
2105
+ #
2106
+ # </note>
2107
+ #
2108
+ #
2109
+ #
2110
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
726
2111
  # @option options [String] :website_redirect_location
727
2112
  # If the bucket is configured as a website, redirects requests for this
728
2113
  # object to another object in the same bucket or to an external URL.
729
- # Amazon S3 stores the value of this header in the object metadata.
2114
+ # Amazon S3 stores the value of this header in the object metadata. For
2115
+ # information about object metadata, see [Object Key and Metadata][1] in
2116
+ # the *Amazon S3 User Guide*.
2117
+ #
2118
+ # In the following example, the request header sets the redirect to an
2119
+ # object (anotherPage.html) in the same bucket:
2120
+ #
2121
+ # `x-amz-website-redirect-location: /anotherPage.html`
2122
+ #
2123
+ # In the following example, the request header sets the object redirect
2124
+ # to another website:
2125
+ #
2126
+ # `x-amz-website-redirect-location: http://www.example.com/`
2127
+ #
2128
+ # For more information about website hosting in Amazon S3, see [Hosting
2129
+ # Websites on Amazon S3][2] and [How to Configure Website Page
2130
+ # Redirects][3] in the *Amazon S3 User Guide*.
2131
+ #
2132
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2133
+ #
2134
+ # </note>
2135
+ #
2136
+ #
2137
+ #
2138
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
2139
+ # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
2140
+ # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
730
2141
  # @option options [String] :sse_customer_algorithm
731
- # Specifies the algorithm to use to when encrypting the object (e.g.,
732
- # AES256).
2142
+ # Specifies the algorithm to use when encrypting the object (for
2143
+ # example, `AES256`).
2144
+ #
2145
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2146
+ #
2147
+ # </note>
733
2148
  # @option options [String] :sse_customer_key
734
2149
  # Specifies the customer-provided encryption key for Amazon S3 to use in
735
2150
  # encrypting data. This value is used to store the object and then it is
736
- # discarded; Amazon does not store the encryption key. The key must be
737
- # appropriate for use with the algorithm specified in the
738
- # x-amz-server-side​-encryption​-customer-algorithm header.
2151
+ # discarded; Amazon S3 does not store the encryption key. The key must
2152
+ # be appropriate for use with the algorithm specified in the
2153
+ # `x-amz-server-side-encryption-customer-algorithm` header.
2154
+ #
2155
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2156
+ #
2157
+ # </note>
739
2158
  # @option options [String] :sse_customer_key_md5
740
2159
  # Specifies the 128-bit MD5 digest of the encryption key according to
741
2160
  # RFC 1321. Amazon S3 uses this header for a message integrity check to
742
- # ensure the encryption key was transmitted without error.
2161
+ # ensure that the encryption key was transmitted without error.
2162
+ #
2163
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2164
+ #
2165
+ # </note>
743
2166
  # @option options [String] :ssekms_key_id
744
- # Specifies the AWS KMS key ID to use for object encryption. All GET and
745
- # PUT requests for an object protected by AWS KMS will fail if not made
746
- # via SSL or using SigV4. Documentation on configuring any of the
747
- # officially supported AWS SDKs and CLI can be found at
748
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
2167
+ # If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
2168
+ # `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or Key
2169
+ # Alias) of the Key Management Service (KMS) symmetric encryption
2170
+ # customer managed key that was used for the object. If you specify
2171
+ # `x-amz-server-side-encryption:aws:kms` or
2172
+ # `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
2173
+ # x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
2174
+ # Amazon Web Services managed key (`aws/s3`) to protect the data. If the
2175
+ # KMS key does not exist in the same account that's issuing the
2176
+ # command, you must use the full ARN and not just the ID.
2177
+ #
2178
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2179
+ #
2180
+ # </note>
749
2181
  # @option options [String] :ssekms_encryption_context
750
- # Specifies the AWS KMS Encryption Context to use for object encryption.
751
- # The value of this header is a base64-encoded UTF-8 string holding JSON
752
- # with the encryption context key-value pairs.
2182
+ # Specifies the Amazon Web Services KMS Encryption Context to use for
2183
+ # object encryption. The value of this header is a base64-encoded UTF-8
2184
+ # string holding JSON with the encryption context key-value pairs. This
2185
+ # value is stored as object metadata and automatically gets passed on to
2186
+ # Amazon Web Services KMS for future `GetObject` or `CopyObject`
2187
+ # operations on this object. This value must be explicitly added during
2188
+ # `CopyObject` operations.
2189
+ #
2190
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2191
+ #
2192
+ # </note>
2193
+ # @option options [Boolean] :bucket_key_enabled
2194
+ # Specifies whether Amazon S3 should use an S3 Bucket Key for object
2195
+ # encryption with server-side encryption using Key Management Service
2196
+ # (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
2197
+ # to use an S3 Bucket Key for object encryption with SSE-KMS.
2198
+ #
2199
+ # Specifying this header with a PUT action doesn’t affect bucket-level
2200
+ # settings for S3 Bucket Key.
2201
+ #
2202
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2203
+ #
2204
+ # </note>
753
2205
  # @option options [String] :request_payer
754
- # Confirms that the requester knows that she or he will be charged for
755
- # the request. Bucket owners need not specify this parameter in their
756
- # requests. Documentation on downloading objects from requester pays
757
- # buckets can be found at
758
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
2206
+ # Confirms that the requester knows that they will be charged for the
2207
+ # request. Bucket owners need not specify this parameter in their
2208
+ # requests. If either the source or destination S3 bucket has Requester
2209
+ # Pays enabled, the requester will pay for corresponding charges to copy
2210
+ # the object. For information about downloading objects from Requester
2211
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
2212
+ # in the *Amazon S3 User Guide*.
2213
+ #
2214
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2215
+ #
2216
+ # </note>
2217
+ #
2218
+ #
2219
+ #
2220
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
759
2221
  # @option options [String] :tagging
760
2222
  # The tag-set for the object. The tag-set must be encoded as URL Query
761
2223
  # parameters. (For example, "Key1=Value1")
2224
+ #
2225
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2226
+ #
2227
+ # </note>
762
2228
  # @option options [String] :object_lock_mode
763
- # The object lock mode that you want to apply to this object.
2229
+ # The Object Lock mode that you want to apply to this object.
2230
+ #
2231
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2232
+ #
2233
+ # </note>
764
2234
  # @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
765
- # The date and time when you want this object's object lock to expire.
2235
+ # The date and time when you want this object's Object Lock to expire.
2236
+ # Must be formatted as a timestamp parameter.
2237
+ #
2238
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2239
+ #
2240
+ # </note>
766
2241
  # @option options [String] :object_lock_legal_hold_status
767
- # The Legal Hold status that you want to apply to the specified object.
2242
+ # Specifies whether a legal hold will be applied to this object. For
2243
+ # more information about S3 Object Lock, see [Object Lock][1] in the
2244
+ # *Amazon S3 User Guide*.
2245
+ #
2246
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2247
+ #
2248
+ # </note>
2249
+ #
2250
+ #
2251
+ #
2252
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
2253
+ # @option options [String] :expected_bucket_owner
2254
+ # The account ID of the expected bucket owner. If the account ID that
2255
+ # you provide does not match the actual owner of the bucket, the request
2256
+ # fails with the HTTP status code `403 Forbidden` (access denied).
768
2257
  # @return [Types::PutObjectOutput]
769
2258
  def put(options = {})
770
2259
  options = options.merge(
771
2260
  bucket: @bucket_name,
772
2261
  key: @key
773
2262
  )
774
- resp = @client.put_object(options)
2263
+ resp = Aws::Plugins::UserAgent.feature('resource') do
2264
+ @client.put_object(options)
2265
+ end
775
2266
  resp.data
776
2267
  end
777
2268
 
@@ -825,7 +2316,7 @@ module Aws::S3
825
2316
  # bucket_name: "BucketName", # required
826
2317
  # prefix: "LocationPrefix", # required
827
2318
  # encryption: {
828
- # encryption_type: "AES256", # required, accepts AES256, aws:kms
2319
+ # encryption_type: "AES256", # required, accepts AES256, aws:kms, aws:kms:dsse
829
2320
  # kms_key_id: "SSEKMSKeyId",
830
2321
  # kms_context: "KMSContext",
831
2322
  # },
@@ -856,28 +2347,63 @@ module Aws::S3
856
2347
  # value: "MetadataValue",
857
2348
  # },
858
2349
  # ],
859
- # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
2350
+ # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE
860
2351
  # },
861
2352
  # },
862
2353
  # },
863
2354
  # request_payer: "requester", # accepts requester
2355
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
2356
+ # expected_bucket_owner: "AccountId",
864
2357
  # })
865
2358
  # @param [Hash] options ({})
866
2359
  # @option options [String] :version_id
2360
+ # VersionId used to reference a specific version of the object.
867
2361
  # @option options [Types::RestoreRequest] :restore_request
2362
+ # Container for restore job parameters.
868
2363
  # @option options [String] :request_payer
869
- # Confirms that the requester knows that she or he will be charged for
870
- # the request. Bucket owners need not specify this parameter in their
871
- # requests. Documentation on downloading objects from requester pays
872
- # buckets can be found at
873
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
2364
+ # Confirms that the requester knows that they will be charged for the
2365
+ # request. Bucket owners need not specify this parameter in their
2366
+ # requests. If either the source or destination S3 bucket has Requester
2367
+ # Pays enabled, the requester will pay for corresponding charges to copy
2368
+ # the object. For information about downloading objects from Requester
2369
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
2370
+ # in the *Amazon S3 User Guide*.
2371
+ #
2372
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2373
+ #
2374
+ # </note>
2375
+ #
2376
+ #
2377
+ #
2378
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
2379
+ # @option options [String] :checksum_algorithm
2380
+ # Indicates the algorithm used to create the checksum for the object
2381
+ # when you use the SDK. This header will not provide any additional
2382
+ # functionality if you don't use the SDK. When you send this header,
2383
+ # there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
2384
+ # header sent. Otherwise, Amazon S3 fails the request with the HTTP
2385
+ # status code `400 Bad Request`. For more information, see [Checking
2386
+ # object integrity][1] in the *Amazon S3 User Guide*.
2387
+ #
2388
+ # If you provide an individual checksum, Amazon S3 ignores any provided
2389
+ # `ChecksumAlgorithm` parameter.
2390
+ #
2391
+ #
2392
+ #
2393
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
2394
+ # @option options [String] :expected_bucket_owner
2395
+ # The account ID of the expected bucket owner. If the account ID that
2396
+ # you provide does not match the actual owner of the bucket, the request
2397
+ # fails with the HTTP status code `403 Forbidden` (access denied).
874
2398
  # @return [Types::RestoreObjectOutput]
875
2399
  def restore_object(options = {})
876
2400
  options = options.merge(
877
2401
  bucket: @bucket_name,
878
2402
  key: @key
879
2403
  )
880
- resp = @client.restore_object(options)
2404
+ resp = Aws::Plugins::UserAgent.feature('resource') do
2405
+ @client.restore_object(options)
2406
+ end
881
2407
  resp.data
882
2408
  end
883
2409
 
@@ -967,8 +2493,8 @@ module Aws::S3
967
2493
 
968
2494
  def yield_waiter_and_warn(waiter, &block)
969
2495
  if !@waiter_block_warned
970
- msg = "pass options to configure the waiter; "
971
- msg << "yielding the waiter is deprecated"
2496
+ msg = "pass options to configure the waiter; "\
2497
+ "yielding the waiter is deprecated"
972
2498
  warn(msg)
973
2499
  @waiter_block_warned = true
974
2500
  end
@@ -976,7 +2502,9 @@ module Aws::S3
976
2502
  end
977
2503
 
978
2504
  def separate_params_and_options(options)
979
- opts = Set.new([:client, :max_attempts, :delay, :before_attempt, :before_wait])
2505
+ opts = Set.new(
2506
+ [:client, :max_attempts, :delay, :before_attempt, :before_wait]
2507
+ )
980
2508
  waiter_opts = {}
981
2509
  waiter_params = {}
982
2510
  options.each_pair do |key, value|
@@ -1000,21 +2528,94 @@ module Aws::S3
1000
2528
  # mfa: "MFA",
1001
2529
  # request_payer: "requester", # accepts requester
1002
2530
  # bypass_governance_retention: false,
2531
+ # expected_bucket_owner: "AccountId",
2532
+ # checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
1003
2533
  # })
1004
2534
  # @param options ({})
1005
2535
  # @option options [String] :mfa
1006
2536
  # The concatenation of the authentication device's serial number, a
1007
2537
  # space, and the value that is displayed on your authentication device.
2538
+ # Required to permanently delete a versioned object if versioning is
2539
+ # configured with MFA delete enabled.
2540
+ #
2541
+ # When performing the `DeleteObjects` operation on an MFA delete enabled
2542
+ # bucket, which attempts to delete the specified versioned objects, you
2543
+ # must include an MFA token. If you don't provide an MFA token, the
2544
+ # entire request will fail, even if there are non-versioned objects that
2545
+ # you are trying to delete. If you provide an invalid token, whether
2546
+ # there are versioned object keys in the request or not, the entire
2547
+ # Multi-Object Delete request will fail. For information about MFA
2548
+ # Delete, see [ MFA Delete][1] in the *Amazon S3 User Guide*.
2549
+ #
2550
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2551
+ #
2552
+ # </note>
2553
+ #
2554
+ #
2555
+ #
2556
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
1008
2557
  # @option options [String] :request_payer
1009
- # Confirms that the requester knows that she or he will be charged for
1010
- # the request. Bucket owners need not specify this parameter in their
1011
- # requests. Documentation on downloading objects from requester pays
1012
- # buckets can be found at
1013
- # http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
2558
+ # Confirms that the requester knows that they will be charged for the
2559
+ # request. Bucket owners need not specify this parameter in their
2560
+ # requests. If either the source or destination S3 bucket has Requester
2561
+ # Pays enabled, the requester will pay for corresponding charges to copy
2562
+ # the object. For information about downloading objects from Requester
2563
+ # Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
2564
+ # in the *Amazon S3 User Guide*.
2565
+ #
2566
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2567
+ #
2568
+ # </note>
2569
+ #
2570
+ #
2571
+ #
2572
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1014
2573
  # @option options [Boolean] :bypass_governance_retention
1015
2574
  # Specifies whether you want to delete this object even if it has a
1016
- # Governance-type object lock in place. You must have sufficient
1017
- # permissions to perform this operation.
2575
+ # Governance-type Object Lock in place. To use this header, you must
2576
+ # have the `s3:BypassGovernanceRetention` permission.
2577
+ #
2578
+ # <note markdown="1"> This functionality is not supported for directory buckets.
2579
+ #
2580
+ # </note>
2581
+ # @option options [String] :expected_bucket_owner
2582
+ # The account ID of the expected bucket owner. If the account ID that
2583
+ # you provide does not match the actual owner of the bucket, the request
2584
+ # fails with the HTTP status code `403 Forbidden` (access denied).
2585
+ # @option options [String] :checksum_algorithm
2586
+ # Indicates the algorithm used to create the checksum for the object
2587
+ # when you use the SDK. This header will not provide any additional
2588
+ # functionality if you don't use the SDK. When you send this header,
2589
+ # there must be a corresponding `x-amz-checksum-algorithm ` or
2590
+ # `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
2591
+ # with the HTTP status code `400 Bad Request`.
2592
+ #
2593
+ # For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
2594
+ # the supported algorithm from the following list:
2595
+ #
2596
+ # * CRC32
2597
+ #
2598
+ # * CRC32C
2599
+ #
2600
+ # * SHA1
2601
+ #
2602
+ # * SHA256
2603
+ #
2604
+ # For more information, see [Checking object integrity][1] in the
2605
+ # *Amazon S3 User Guide*.
2606
+ #
2607
+ # If the individual checksum value you provide through
2608
+ # `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
2609
+ # set through `x-amz-sdk-checksum-algorithm`, Amazon S3 ignores any
2610
+ # provided `ChecksumAlgorithm` parameter and uses the checksum algorithm
2611
+ # that matches the provided value in `x-amz-checksum-algorithm `.
2612
+ #
2613
+ # If you provide an individual checksum, Amazon S3 ignores any provided
2614
+ # `ChecksumAlgorithm` parameter.
2615
+ #
2616
+ #
2617
+ #
2618
+ # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1018
2619
  # @return [void]
1019
2620
  def batch_delete!(options = {})
1020
2621
  batch_enum.each do |batch|
@@ -1027,7 +2628,9 @@ module Aws::S3
1027
2628
  key: item.key
1028
2629
  }
1029
2630
  end
1030
- batch[0].client.delete_objects(params)
2631
+ Aws::Plugins::UserAgent.feature('resource') do
2632
+ batch[0].client.delete_objects(params)
2633
+ end
1031
2634
  end
1032
2635
  nil
1033
2636
  end