aws-sdk-s3 1.79.1 → 1.212.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +1548 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-s3/access_grants_credentials.rb +57 -0
- data/lib/aws-sdk-s3/access_grants_credentials_provider.rb +250 -0
- data/lib/aws-sdk-s3/bucket.rb +900 -98
- data/lib/aws-sdk-s3/bucket_acl.rb +44 -10
- data/lib/aws-sdk-s3/bucket_cors.rb +51 -11
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +53 -8
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +107 -9
- data/lib/aws-sdk-s3/bucket_logging.rb +43 -6
- data/lib/aws-sdk-s3/bucket_notification.rb +32 -9
- data/lib/aws-sdk-s3/bucket_policy.rb +90 -6
- data/lib/aws-sdk-s3/bucket_region_cache.rb +9 -5
- data/lib/aws-sdk-s3/bucket_request_payment.rb +38 -8
- data/lib/aws-sdk-s3/bucket_tagging.rb +46 -7
- data/lib/aws-sdk-s3/bucket_versioning.rb +127 -9
- data/lib/aws-sdk-s3/bucket_website.rb +46 -7
- data/lib/aws-sdk-s3/client.rb +13729 -3146
- data/lib/aws-sdk-s3/client_api.rb +1604 -277
- data/lib/aws-sdk-s3/customizations/bucket.rb +31 -47
- data/lib/aws-sdk-s3/customizations/errors.rb +40 -0
- data/lib/aws-sdk-s3/customizations/object.rb +253 -82
- data/lib/aws-sdk-s3/customizations/object_summary.rb +5 -0
- data/lib/aws-sdk-s3/customizations/object_version.rb +13 -0
- data/lib/aws-sdk-s3/customizations/types/permanent_redirect.rb +26 -0
- data/lib/aws-sdk-s3/customizations.rb +28 -29
- data/lib/aws-sdk-s3/default_executor.rb +103 -0
- data/lib/aws-sdk-s3/encryption/client.rb +9 -5
- data/lib/aws-sdk-s3/encryption/decrypt_handler.rb +0 -4
- data/lib/aws-sdk-s3/encryption/default_cipher_provider.rb +2 -0
- data/lib/aws-sdk-s3/encryption/encrypt_handler.rb +2 -0
- data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +15 -9
- data/lib/aws-sdk-s3/encryptionV2/client.rb +105 -26
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +7 -165
- data/lib/aws-sdk-s3/encryptionV2/decryption.rb +205 -0
- data/lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb +20 -3
- data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +2 -4
- data/lib/aws-sdk-s3/encryptionV2/io_encrypter.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +18 -6
- data/lib/aws-sdk-s3/encryptionV2/utils.rb +5 -0
- data/lib/aws-sdk-s3/encryptionV3/client.rb +885 -0
- data/lib/aws-sdk-s3/encryptionV3/decrypt_handler.rb +98 -0
- data/lib/aws-sdk-s3/encryptionV3/decryption.rb +244 -0
- data/lib/aws-sdk-s3/encryptionV3/default_cipher_provider.rb +159 -0
- data/lib/aws-sdk-s3/encryptionV3/default_key_provider.rb +35 -0
- data/lib/aws-sdk-s3/encryptionV3/encrypt_handler.rb +98 -0
- data/lib/aws-sdk-s3/encryptionV3/errors.rb +47 -0
- data/lib/aws-sdk-s3/encryptionV3/io_auth_decrypter.rb +60 -0
- data/lib/aws-sdk-s3/encryptionV3/io_decrypter.rb +35 -0
- data/lib/aws-sdk-s3/encryptionV3/io_encrypter.rb +84 -0
- data/lib/aws-sdk-s3/encryptionV3/key_provider.rb +28 -0
- data/lib/aws-sdk-s3/encryptionV3/kms_cipher_provider.rb +159 -0
- data/lib/aws-sdk-s3/encryptionV3/materials.rb +58 -0
- data/lib/aws-sdk-s3/encryptionV3/utils.rb +321 -0
- data/lib/aws-sdk-s3/encryption_v2.rb +1 -0
- data/lib/aws-sdk-s3/encryption_v3.rb +24 -0
- data/lib/aws-sdk-s3/endpoint_parameters.rb +181 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +889 -0
- data/lib/aws-sdk-s3/endpoints.rb +1544 -0
- data/lib/aws-sdk-s3/errors.rb +80 -1
- data/lib/aws-sdk-s3/event_streams.rb +1 -1
- data/lib/aws-sdk-s3/express_credentials.rb +55 -0
- data/lib/aws-sdk-s3/express_credentials_provider.rb +59 -0
- data/lib/aws-sdk-s3/file_downloader.rb +258 -82
- data/lib/aws-sdk-s3/file_uploader.rb +25 -14
- data/lib/aws-sdk-s3/legacy_signer.rb +17 -26
- data/lib/aws-sdk-s3/multipart_download_error.rb +8 -0
- data/lib/aws-sdk-s3/multipart_file_uploader.rb +111 -86
- data/lib/aws-sdk-s3/multipart_stream_uploader.rb +110 -92
- data/lib/aws-sdk-s3/multipart_upload.rb +304 -14
- data/lib/aws-sdk-s3/multipart_upload_error.rb +3 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +344 -20
- data/lib/aws-sdk-s3/object.rb +2457 -225
- data/lib/aws-sdk-s3/object_acl.rb +76 -15
- data/lib/aws-sdk-s3/object_copier.rb +7 -5
- data/lib/aws-sdk-s3/object_multipart_copier.rb +48 -23
- data/lib/aws-sdk-s3/object_summary.rb +2033 -169
- data/lib/aws-sdk-s3/object_version.rb +470 -53
- data/lib/aws-sdk-s3/plugins/accelerate.rb +1 -39
- data/lib/aws-sdk-s3/plugins/access_grants.rb +178 -0
- data/lib/aws-sdk-s3/plugins/arn.rb +70 -0
- data/lib/aws-sdk-s3/plugins/bucket_dns.rb +3 -41
- data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +1 -6
- data/lib/aws-sdk-s3/plugins/checksum_algorithm.rb +44 -0
- data/lib/aws-sdk-s3/plugins/dualstack.rb +2 -49
- data/lib/aws-sdk-s3/plugins/endpoints.rb +86 -0
- data/lib/aws-sdk-s3/plugins/expect_100_continue.rb +3 -1
- data/lib/aws-sdk-s3/plugins/express_session_auth.rb +88 -0
- data/lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb +1 -1
- data/lib/aws-sdk-s3/plugins/http_200_errors.rb +87 -26
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +8 -26
- data/lib/aws-sdk-s3/plugins/location_constraint.rb +3 -1
- data/lib/aws-sdk-s3/plugins/md5s.rb +10 -68
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +48 -88
- data/lib/aws-sdk-s3/plugins/streaming_retry.rb +28 -9
- data/lib/aws-sdk-s3/plugins/url_encoded_keys.rb +2 -1
- data/lib/aws-sdk-s3/presigned_post.rb +99 -78
- data/lib/aws-sdk-s3/presigner.rb +50 -42
- data/lib/aws-sdk-s3/resource.rb +144 -15
- data/lib/aws-sdk-s3/transfer_manager.rb +321 -0
- data/lib/aws-sdk-s3/types.rb +12223 -4723
- data/lib/aws-sdk-s3/waiters.rb +1 -1
- data/lib/aws-sdk-s3.rb +37 -28
- data/sig/bucket.rbs +231 -0
- data/sig/bucket_acl.rbs +78 -0
- data/sig/bucket_cors.rbs +69 -0
- data/sig/bucket_lifecycle.rbs +88 -0
- data/sig/bucket_lifecycle_configuration.rbs +115 -0
- data/sig/bucket_logging.rbs +76 -0
- data/sig/bucket_notification.rbs +114 -0
- data/sig/bucket_policy.rbs +59 -0
- data/sig/bucket_request_payment.rbs +54 -0
- data/sig/bucket_tagging.rbs +65 -0
- data/sig/bucket_versioning.rbs +77 -0
- data/sig/bucket_website.rbs +93 -0
- data/sig/client.rbs +2612 -0
- data/sig/customizations/bucket.rbs +19 -0
- data/sig/customizations/object.rbs +38 -0
- data/sig/customizations/object_summary.rbs +35 -0
- data/sig/errors.rbs +44 -0
- data/sig/multipart_upload.rbs +120 -0
- data/sig/multipart_upload_part.rbs +109 -0
- data/sig/object.rbs +464 -0
- data/sig/object_acl.rbs +86 -0
- data/sig/object_summary.rbs +347 -0
- data/sig/object_version.rbs +143 -0
- data/sig/resource.rbs +141 -0
- data/sig/types.rbs +2899 -0
- data/sig/waiters.rbs +95 -0
- metadata +74 -16
- data/lib/aws-sdk-s3/plugins/bucket_arn.rb +0 -212
data/lib/aws-sdk-s3/bucket.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -34,12 +34,38 @@ module Aws::S3
|
|
|
34
34
|
@name
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
-
# Date the bucket was created.
|
|
37
|
+
# Date the bucket was created. This date can change when making changes
|
|
38
|
+
# to your bucket, such as editing its bucket policy.
|
|
38
39
|
# @return [Time]
|
|
39
40
|
def creation_date
|
|
40
41
|
data[:creation_date]
|
|
41
42
|
end
|
|
42
43
|
|
|
44
|
+
# `BucketRegion` indicates the Amazon Web Services region where the
|
|
45
|
+
# bucket is located. If the request contains at least one valid
|
|
46
|
+
# parameter, it is included in the response.
|
|
47
|
+
# @return [String]
|
|
48
|
+
def bucket_region
|
|
49
|
+
data[:bucket_region]
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely
|
|
53
|
+
# identify Amazon Web Services resources across all of Amazon Web
|
|
54
|
+
# Services.
|
|
55
|
+
#
|
|
56
|
+
# <note markdown="1"> This parameter is only supported for S3 directory buckets. For more
|
|
57
|
+
# information, see [Using tags with directory buckets][1].
|
|
58
|
+
#
|
|
59
|
+
# </note>
|
|
60
|
+
#
|
|
61
|
+
#
|
|
62
|
+
#
|
|
63
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-tagging.html
|
|
64
|
+
# @return [String]
|
|
65
|
+
def bucket_arn
|
|
66
|
+
data[:bucket_arn]
|
|
67
|
+
end
|
|
68
|
+
|
|
43
69
|
# @!endgroup
|
|
44
70
|
|
|
45
71
|
# @return [Client]
|
|
@@ -94,7 +120,9 @@ module Aws::S3
|
|
|
94
120
|
options, params = separate_params_and_options(options)
|
|
95
121
|
waiter = Waiters::BucketExists.new(options)
|
|
96
122
|
yield_waiter_and_warn(waiter, &block) if block_given?
|
|
97
|
-
|
|
123
|
+
Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
124
|
+
waiter.wait(params.merge(bucket: @name))
|
|
125
|
+
end
|
|
98
126
|
Bucket.new({
|
|
99
127
|
name: @name,
|
|
100
128
|
client: @client
|
|
@@ -111,7 +139,9 @@ module Aws::S3
|
|
|
111
139
|
options, params = separate_params_and_options(options)
|
|
112
140
|
waiter = Waiters::BucketNotExists.new(options)
|
|
113
141
|
yield_waiter_and_warn(waiter, &block) if block_given?
|
|
114
|
-
|
|
142
|
+
Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
143
|
+
waiter.wait(params.merge(bucket: @name))
|
|
144
|
+
end
|
|
115
145
|
Bucket.new({
|
|
116
146
|
name: @name,
|
|
117
147
|
client: @client
|
|
@@ -212,7 +242,9 @@ module Aws::S3
|
|
|
212
242
|
:retry
|
|
213
243
|
end
|
|
214
244
|
end
|
|
215
|
-
Aws::
|
|
245
|
+
Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
246
|
+
Aws::Waiters::Waiter.new(options).wait({})
|
|
247
|
+
end
|
|
216
248
|
end
|
|
217
249
|
|
|
218
250
|
# @!group Actions
|
|
@@ -222,7 +254,21 @@ module Aws::S3
|
|
|
222
254
|
# bucket.create({
|
|
223
255
|
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read
|
|
224
256
|
# create_bucket_configuration: {
|
|
225
|
-
# location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
|
|
257
|
+
# location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ap-southeast-4, ap-southeast-5, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-central-2, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, il-central-1, me-central-1, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
|
|
258
|
+
# location: {
|
|
259
|
+
# type: "AvailabilityZone", # accepts AvailabilityZone, LocalZone
|
|
260
|
+
# name: "LocationNameAsString",
|
|
261
|
+
# },
|
|
262
|
+
# bucket: {
|
|
263
|
+
# data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone, SingleLocalZone
|
|
264
|
+
# type: "Directory", # accepts Directory
|
|
265
|
+
# },
|
|
266
|
+
# tags: [
|
|
267
|
+
# {
|
|
268
|
+
# key: "ObjectKey", # required
|
|
269
|
+
# value: "Value", # required
|
|
270
|
+
# },
|
|
271
|
+
# ],
|
|
226
272
|
# },
|
|
227
273
|
# grant_full_control: "GrantFullControl",
|
|
228
274
|
# grant_read: "GrantRead",
|
|
@@ -230,42 +276,123 @@ module Aws::S3
|
|
|
230
276
|
# grant_write: "GrantWrite",
|
|
231
277
|
# grant_write_acp: "GrantWriteACP",
|
|
232
278
|
# object_lock_enabled_for_bucket: false,
|
|
279
|
+
# object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
|
|
233
280
|
# })
|
|
234
281
|
# @param [Hash] options ({})
|
|
235
282
|
# @option options [String] :acl
|
|
236
283
|
# The canned ACL to apply to the bucket.
|
|
284
|
+
#
|
|
285
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
286
|
+
#
|
|
287
|
+
# </note>
|
|
237
288
|
# @option options [Types::CreateBucketConfiguration] :create_bucket_configuration
|
|
238
289
|
# The configuration information for the bucket.
|
|
239
290
|
# @option options [String] :grant_full_control
|
|
240
291
|
# Allows grantee the read, write, read ACP, and write ACP permissions on
|
|
241
292
|
# the bucket.
|
|
293
|
+
#
|
|
294
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
295
|
+
#
|
|
296
|
+
# </note>
|
|
242
297
|
# @option options [String] :grant_read
|
|
243
298
|
# Allows grantee to list the objects in the bucket.
|
|
299
|
+
#
|
|
300
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
301
|
+
#
|
|
302
|
+
# </note>
|
|
244
303
|
# @option options [String] :grant_read_acp
|
|
245
304
|
# Allows grantee to read the bucket ACL.
|
|
305
|
+
#
|
|
306
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
307
|
+
#
|
|
308
|
+
# </note>
|
|
246
309
|
# @option options [String] :grant_write
|
|
247
|
-
# Allows grantee to create
|
|
248
|
-
#
|
|
310
|
+
# Allows grantee to create new objects in the bucket.
|
|
311
|
+
#
|
|
312
|
+
# For the bucket and object owners of existing objects, also allows
|
|
313
|
+
# deletions and overwrites of those objects.
|
|
314
|
+
#
|
|
315
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
316
|
+
#
|
|
317
|
+
# </note>
|
|
249
318
|
# @option options [String] :grant_write_acp
|
|
250
319
|
# Allows grantee to write the ACL for the applicable bucket.
|
|
320
|
+
#
|
|
321
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
322
|
+
#
|
|
323
|
+
# </note>
|
|
251
324
|
# @option options [Boolean] :object_lock_enabled_for_bucket
|
|
252
325
|
# Specifies whether you want S3 Object Lock to be enabled for the new
|
|
253
326
|
# bucket.
|
|
327
|
+
#
|
|
328
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
329
|
+
#
|
|
330
|
+
# </note>
|
|
331
|
+
# @option options [String] :object_ownership
|
|
332
|
+
# The container element for object ownership for a bucket's ownership
|
|
333
|
+
# controls.
|
|
334
|
+
#
|
|
335
|
+
# `BucketOwnerPreferred` - Objects uploaded to the bucket change
|
|
336
|
+
# ownership to the bucket owner if the objects are uploaded with the
|
|
337
|
+
# `bucket-owner-full-control` canned ACL.
|
|
338
|
+
#
|
|
339
|
+
# `ObjectWriter` - The uploading account will own the object if the
|
|
340
|
+
# object is uploaded with the `bucket-owner-full-control` canned ACL.
|
|
341
|
+
#
|
|
342
|
+
# `BucketOwnerEnforced` - Access control lists (ACLs) are disabled and
|
|
343
|
+
# no longer affect permissions. The bucket owner automatically owns and
|
|
344
|
+
# has full control over every object in the bucket. The bucket only
|
|
345
|
+
# accepts PUT requests that don't specify an ACL or specify bucket
|
|
346
|
+
# owner full control ACLs (such as the predefined
|
|
347
|
+
# `bucket-owner-full-control` canned ACL or a custom ACL in XML format
|
|
348
|
+
# that grants the same permissions).
|
|
349
|
+
#
|
|
350
|
+
# By default, `ObjectOwnership` is set to `BucketOwnerEnforced` and ACLs
|
|
351
|
+
# are disabled. We recommend keeping ACLs disabled, except in uncommon
|
|
352
|
+
# use cases where you must control access for each object individually.
|
|
353
|
+
# For more information about S3 Object Ownership, see [Controlling
|
|
354
|
+
# ownership of objects and disabling ACLs for your bucket][1] in the
|
|
355
|
+
# *Amazon S3 User Guide*.
|
|
356
|
+
#
|
|
357
|
+
# <note markdown="1"> This functionality is not supported for directory buckets. Directory
|
|
358
|
+
# buckets use the bucket owner enforced setting for S3 Object Ownership.
|
|
359
|
+
#
|
|
360
|
+
# </note>
|
|
361
|
+
#
|
|
362
|
+
#
|
|
363
|
+
#
|
|
364
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
254
365
|
# @return [Types::CreateBucketOutput]
|
|
255
366
|
def create(options = {})
|
|
256
367
|
options = options.merge(bucket: @name)
|
|
257
|
-
resp =
|
|
368
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
369
|
+
@client.create_bucket(options)
|
|
370
|
+
end
|
|
258
371
|
resp.data
|
|
259
372
|
end
|
|
260
373
|
|
|
261
374
|
# @example Request syntax with placeholder values
|
|
262
375
|
#
|
|
263
|
-
# bucket.delete(
|
|
376
|
+
# bucket.delete({
|
|
377
|
+
# expected_bucket_owner: "AccountId",
|
|
378
|
+
# })
|
|
264
379
|
# @param [Hash] options ({})
|
|
380
|
+
# @option options [String] :expected_bucket_owner
|
|
381
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
382
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
383
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
384
|
+
#
|
|
385
|
+
# <note markdown="1"> For directory buckets, this header is not supported in this API
|
|
386
|
+
# operation. If you specify this header, the request fails with the HTTP
|
|
387
|
+
# status code `501 Not Implemented`.
|
|
388
|
+
#
|
|
389
|
+
# </note>
|
|
265
390
|
# @return [EmptyStructure]
|
|
266
391
|
def delete(options = {})
|
|
267
392
|
options = options.merge(bucket: @name)
|
|
268
|
-
resp =
|
|
393
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
394
|
+
@client.delete_bucket(options)
|
|
395
|
+
end
|
|
269
396
|
resp.data
|
|
270
397
|
end
|
|
271
398
|
|
|
@@ -277,6 +404,9 @@ module Aws::S3
|
|
|
277
404
|
# {
|
|
278
405
|
# key: "ObjectKey", # required
|
|
279
406
|
# version_id: "ObjectVersionId",
|
|
407
|
+
# etag: "ETag",
|
|
408
|
+
# last_modified_time: Time.now,
|
|
409
|
+
# size: 1,
|
|
280
410
|
# },
|
|
281
411
|
# ],
|
|
282
412
|
# quiet: false,
|
|
@@ -284,6 +414,8 @@ module Aws::S3
|
|
|
284
414
|
# mfa: "MFA",
|
|
285
415
|
# request_payer: "requester", # accepts requester
|
|
286
416
|
# bypass_governance_retention: false,
|
|
417
|
+
# expected_bucket_owner: "AccountId",
|
|
418
|
+
# checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256, CRC64NVME
|
|
287
419
|
# })
|
|
288
420
|
# @param [Hash] options ({})
|
|
289
421
|
# @option options [required, Types::Delete] :delete
|
|
@@ -293,24 +425,92 @@ module Aws::S3
|
|
|
293
425
|
# space, and the value that is displayed on your authentication device.
|
|
294
426
|
# Required to permanently delete a versioned object if versioning is
|
|
295
427
|
# configured with MFA delete enabled.
|
|
428
|
+
#
|
|
429
|
+
# When performing the `DeleteObjects` operation on an MFA delete enabled
|
|
430
|
+
# bucket, which attempts to delete the specified versioned objects, you
|
|
431
|
+
# must include an MFA token. If you don't provide an MFA token, the
|
|
432
|
+
# entire request will fail, even if there are non-versioned objects that
|
|
433
|
+
# you are trying to delete. If you provide an invalid token, whether
|
|
434
|
+
# there are versioned object keys in the request or not, the entire
|
|
435
|
+
# Multi-Object Delete request will fail. For information about MFA
|
|
436
|
+
# Delete, see [ MFA Delete][1] in the *Amazon S3 User Guide*.
|
|
437
|
+
#
|
|
438
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
439
|
+
#
|
|
440
|
+
# </note>
|
|
441
|
+
#
|
|
442
|
+
#
|
|
443
|
+
#
|
|
444
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
|
|
296
445
|
# @option options [String] :request_payer
|
|
297
446
|
# Confirms that the requester knows that they will be charged for the
|
|
298
447
|
# request. Bucket owners need not specify this parameter in their
|
|
299
|
-
# requests.
|
|
300
|
-
#
|
|
301
|
-
#
|
|
448
|
+
# requests. If either the source or destination S3 bucket has Requester
|
|
449
|
+
# Pays enabled, the requester will pay for corresponding charges to copy
|
|
450
|
+
# the object. For information about downloading objects from Requester
|
|
451
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
|
452
|
+
# in the *Amazon S3 User Guide*.
|
|
453
|
+
#
|
|
454
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
455
|
+
#
|
|
456
|
+
# </note>
|
|
302
457
|
#
|
|
303
458
|
#
|
|
304
459
|
#
|
|
305
460
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
306
461
|
# @option options [Boolean] :bypass_governance_retention
|
|
307
462
|
# Specifies whether you want to delete this object even if it has a
|
|
308
|
-
# Governance-type Object Lock in place.
|
|
309
|
-
#
|
|
463
|
+
# Governance-type Object Lock in place. To use this header, you must
|
|
464
|
+
# have the `s3:BypassGovernanceRetention` permission.
|
|
465
|
+
#
|
|
466
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
467
|
+
#
|
|
468
|
+
# </note>
|
|
469
|
+
# @option options [String] :expected_bucket_owner
|
|
470
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
471
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
472
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
473
|
+
# @option options [String] :checksum_algorithm
|
|
474
|
+
# Indicates the algorithm used to create the checksum for the object
|
|
475
|
+
# when you use the SDK. This header will not provide any additional
|
|
476
|
+
# functionality if you don't use the SDK. When you send this header,
|
|
477
|
+
# there must be a corresponding `x-amz-checksum-algorithm ` or
|
|
478
|
+
# `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
|
|
479
|
+
# with the HTTP status code `400 Bad Request`.
|
|
480
|
+
#
|
|
481
|
+
# For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
|
|
482
|
+
# the supported algorithm from the following list:
|
|
483
|
+
#
|
|
484
|
+
# * `CRC32`
|
|
485
|
+
#
|
|
486
|
+
# * `CRC32C`
|
|
487
|
+
#
|
|
488
|
+
# * `CRC64NVME`
|
|
489
|
+
#
|
|
490
|
+
# * `SHA1`
|
|
491
|
+
#
|
|
492
|
+
# * `SHA256`
|
|
493
|
+
#
|
|
494
|
+
# For more information, see [Checking object integrity][1] in the
|
|
495
|
+
# *Amazon S3 User Guide*.
|
|
496
|
+
#
|
|
497
|
+
# If the individual checksum value you provide through
|
|
498
|
+
# `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
|
|
499
|
+
# set through `x-amz-sdk-checksum-algorithm`, Amazon S3 fails the
|
|
500
|
+
# request with a `BadDigest` error.
|
|
501
|
+
#
|
|
502
|
+
# If you provide an individual checksum, Amazon S3 ignores any provided
|
|
503
|
+
# `ChecksumAlgorithm` parameter.
|
|
504
|
+
#
|
|
505
|
+
#
|
|
506
|
+
#
|
|
507
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
310
508
|
# @return [Types::DeleteObjectsOutput]
|
|
311
509
|
def delete_objects(options = {})
|
|
312
510
|
options = options.merge(bucket: @name)
|
|
313
|
-
resp =
|
|
511
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
512
|
+
@client.delete_objects(options)
|
|
513
|
+
end
|
|
314
514
|
resp.data
|
|
315
515
|
end
|
|
316
516
|
|
|
@@ -326,37 +526,78 @@ module Aws::S3
|
|
|
326
526
|
# content_length: 1,
|
|
327
527
|
# content_md5: "ContentMD5",
|
|
328
528
|
# content_type: "ContentType",
|
|
529
|
+
# checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256, CRC64NVME
|
|
530
|
+
# checksum_crc32: "ChecksumCRC32",
|
|
531
|
+
# checksum_crc32c: "ChecksumCRC32C",
|
|
532
|
+
# checksum_crc64nvme: "ChecksumCRC64NVME",
|
|
533
|
+
# checksum_sha1: "ChecksumSHA1",
|
|
534
|
+
# checksum_sha256: "ChecksumSHA256",
|
|
329
535
|
# expires: Time.now,
|
|
536
|
+
# if_match: "IfMatch",
|
|
537
|
+
# if_none_match: "IfNoneMatch",
|
|
330
538
|
# grant_full_control: "GrantFullControl",
|
|
331
539
|
# grant_read: "GrantRead",
|
|
332
540
|
# grant_read_acp: "GrantReadACP",
|
|
333
541
|
# grant_write_acp: "GrantWriteACP",
|
|
334
542
|
# key: "ObjectKey", # required
|
|
543
|
+
# write_offset_bytes: 1,
|
|
335
544
|
# metadata: {
|
|
336
545
|
# "MetadataKey" => "MetadataValue",
|
|
337
546
|
# },
|
|
338
|
-
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
|
339
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
|
|
547
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:fsx, aws:kms, aws:kms:dsse
|
|
548
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS, FSX_ONTAP
|
|
340
549
|
# website_redirect_location: "WebsiteRedirectLocation",
|
|
341
550
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
|
342
551
|
# sse_customer_key: "SSECustomerKey",
|
|
343
552
|
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
|
344
553
|
# ssekms_key_id: "SSEKMSKeyId",
|
|
345
554
|
# ssekms_encryption_context: "SSEKMSEncryptionContext",
|
|
555
|
+
# bucket_key_enabled: false,
|
|
346
556
|
# request_payer: "requester", # accepts requester
|
|
347
557
|
# tagging: "TaggingHeader",
|
|
348
558
|
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
|
349
559
|
# object_lock_retain_until_date: Time.now,
|
|
350
560
|
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
|
561
|
+
# expected_bucket_owner: "AccountId",
|
|
351
562
|
# })
|
|
352
563
|
# @param [Hash] options ({})
|
|
353
564
|
# @option options [String] :acl
|
|
354
565
|
# The canned ACL to apply to the object. For more information, see
|
|
355
|
-
# [Canned ACL][1]
|
|
566
|
+
# [Canned ACL][1] in the *Amazon S3 User Guide*.
|
|
567
|
+
#
|
|
568
|
+
# When adding a new object, you can use headers to grant ACL-based
|
|
569
|
+
# permissions to individual Amazon Web Services accounts or to
|
|
570
|
+
# predefined groups defined by Amazon S3. These permissions are then
|
|
571
|
+
# added to the ACL on the object. By default, all objects are private.
|
|
572
|
+
# Only the owner has full access control. For more information, see
|
|
573
|
+
# [Access Control List (ACL) Overview][2] and [Managing ACLs Using the
|
|
574
|
+
# REST API][3] in the *Amazon S3 User Guide*.
|
|
575
|
+
#
|
|
576
|
+
# If the bucket that you're uploading objects to uses the bucket owner
|
|
577
|
+
# enforced setting for S3 Object Ownership, ACLs are disabled and no
|
|
578
|
+
# longer affect permissions. Buckets that use this setting only accept
|
|
579
|
+
# PUT requests that don't specify an ACL or PUT requests that specify
|
|
580
|
+
# bucket owner full control ACLs, such as the
|
|
581
|
+
# `bucket-owner-full-control` canned ACL or an equivalent form of this
|
|
582
|
+
# ACL expressed in the XML format. PUT requests that contain other ACLs
|
|
583
|
+
# (for example, custom grants to certain Amazon Web Services accounts)
|
|
584
|
+
# fail and return a `400` error with the error code
|
|
585
|
+
# `AccessControlListNotSupported`. For more information, see [
|
|
586
|
+
# Controlling ownership of objects and disabling ACLs][4] in the *Amazon
|
|
587
|
+
# S3 User Guide*.
|
|
588
|
+
#
|
|
589
|
+
# <note markdown="1"> * This functionality is not supported for directory buckets.
|
|
590
|
+
#
|
|
591
|
+
# * This functionality is not supported for Amazon S3 on Outposts.
|
|
592
|
+
#
|
|
593
|
+
# </note>
|
|
356
594
|
#
|
|
357
595
|
#
|
|
358
596
|
#
|
|
359
597
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
|
598
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
|
599
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
|
600
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
360
601
|
# @option options [String, StringIO, File] :body
|
|
361
602
|
# Object data.
|
|
362
603
|
# @option options [String] :cache_control
|
|
@@ -370,32 +611,32 @@ module Aws::S3
|
|
|
370
611
|
# @option options [String] :content_disposition
|
|
371
612
|
# Specifies presentational information for the object. For more
|
|
372
613
|
# information, see
|
|
373
|
-
# [
|
|
614
|
+
# [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
|
|
374
615
|
#
|
|
375
616
|
#
|
|
376
617
|
#
|
|
377
|
-
# [1]:
|
|
618
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
|
|
378
619
|
# @option options [String] :content_encoding
|
|
379
620
|
# Specifies what content encodings have been applied to the object and
|
|
380
621
|
# thus what decoding mechanisms must be applied to obtain the media-type
|
|
381
622
|
# referenced by the Content-Type header field. For more information, see
|
|
382
|
-
# [
|
|
623
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
|
|
383
624
|
#
|
|
384
625
|
#
|
|
385
626
|
#
|
|
386
|
-
# [1]:
|
|
627
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
|
|
387
628
|
# @option options [String] :content_language
|
|
388
629
|
# The language the content is in.
|
|
389
630
|
# @option options [Integer] :content_length
|
|
390
631
|
# Size of the body in bytes. This parameter is useful when the size of
|
|
391
632
|
# the body cannot be determined automatically. For more information, see
|
|
392
|
-
# [
|
|
633
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
|
|
393
634
|
#
|
|
394
635
|
#
|
|
395
636
|
#
|
|
396
|
-
# [1]:
|
|
637
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
|
|
397
638
|
# @option options [String] :content_md5
|
|
398
|
-
# The
|
|
639
|
+
# The Base64 encoded 128-bit `MD5` digest of the message (without the
|
|
399
640
|
# headers) according to RFC 1864. This header can be used as a message
|
|
400
641
|
# integrity check to verify that the data is the same data that was
|
|
401
642
|
# originally sent. Although it is optional, we recommend using the
|
|
@@ -403,49 +644,312 @@ module Aws::S3
|
|
|
403
644
|
# information about REST request authentication, see [REST
|
|
404
645
|
# Authentication][1].
|
|
405
646
|
#
|
|
647
|
+
# <note markdown="1"> The `Content-MD5` or `x-amz-sdk-checksum-algorithm` header is required
|
|
648
|
+
# for any request to upload an object with a retention period configured
|
|
649
|
+
# using Amazon S3 Object Lock. For more information, see [Uploading
|
|
650
|
+
# objects to an Object Lock enabled bucket ][2] in the *Amazon S3 User
|
|
651
|
+
# Guide*.
|
|
652
|
+
#
|
|
653
|
+
# </note>
|
|
654
|
+
#
|
|
655
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
656
|
+
#
|
|
657
|
+
# </note>
|
|
658
|
+
#
|
|
406
659
|
#
|
|
407
660
|
#
|
|
408
661
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
|
662
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object
|
|
409
663
|
# @option options [String] :content_type
|
|
410
664
|
# A standard MIME type describing the format of the contents. For more
|
|
411
665
|
# information, see
|
|
412
|
-
# [
|
|
666
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
|
|
667
|
+
#
|
|
668
|
+
#
|
|
669
|
+
#
|
|
670
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
|
|
671
|
+
# @option options [String] :checksum_algorithm
|
|
672
|
+
# Indicates the algorithm used to create the checksum for the object
|
|
673
|
+
# when you use the SDK. This header will not provide any additional
|
|
674
|
+
# functionality if you don't use the SDK. When you send this header,
|
|
675
|
+
# there must be a corresponding `x-amz-checksum-algorithm ` or
|
|
676
|
+
# `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
|
|
677
|
+
# with the HTTP status code `400 Bad Request`.
|
|
678
|
+
#
|
|
679
|
+
# For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
|
|
680
|
+
# the supported algorithm from the following list:
|
|
681
|
+
#
|
|
682
|
+
# * `CRC32`
|
|
683
|
+
#
|
|
684
|
+
# * `CRC32C`
|
|
685
|
+
#
|
|
686
|
+
# * `CRC64NVME`
|
|
687
|
+
#
|
|
688
|
+
# * `SHA1`
|
|
689
|
+
#
|
|
690
|
+
# * `SHA256`
|
|
691
|
+
#
|
|
692
|
+
# For more information, see [Checking object integrity][1] in the
|
|
693
|
+
# *Amazon S3 User Guide*.
|
|
413
694
|
#
|
|
695
|
+
# If the individual checksum value you provide through
|
|
696
|
+
# `x-amz-checksum-algorithm ` doesn't match the checksum algorithm you
|
|
697
|
+
# set through `x-amz-sdk-checksum-algorithm`, Amazon S3 fails the
|
|
698
|
+
# request with a `BadDigest` error.
|
|
414
699
|
#
|
|
700
|
+
# <note markdown="1"> The `Content-MD5` or `x-amz-sdk-checksum-algorithm` header is required
|
|
701
|
+
# for any request to upload an object with a retention period configured
|
|
702
|
+
# using Amazon S3 Object Lock. For more information, see [Uploading
|
|
703
|
+
# objects to an Object Lock enabled bucket ][2] in the *Amazon S3 User
|
|
704
|
+
# Guide*.
|
|
415
705
|
#
|
|
416
|
-
#
|
|
706
|
+
# </note>
|
|
707
|
+
#
|
|
708
|
+
# For directory buckets, when you use Amazon Web Services SDKs, `CRC32`
|
|
709
|
+
# is the default checksum algorithm that's used for performance.
|
|
710
|
+
#
|
|
711
|
+
#
|
|
712
|
+
#
|
|
713
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
714
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-managing.html#object-lock-put-object
|
|
715
|
+
# @option options [String] :checksum_crc32
|
|
716
|
+
# This header can be used as a data integrity check to verify that the
|
|
717
|
+
# data received is the same data that was originally sent. This header
|
|
718
|
+
# specifies the Base64 encoded, 32-bit `CRC32` checksum of the object.
|
|
719
|
+
# For more information, see [Checking object integrity][1] in the
|
|
720
|
+
# *Amazon S3 User Guide*.
|
|
721
|
+
#
|
|
722
|
+
#
|
|
723
|
+
#
|
|
724
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
725
|
+
# @option options [String] :checksum_crc32c
|
|
726
|
+
# This header can be used as a data integrity check to verify that the
|
|
727
|
+
# data received is the same data that was originally sent. This header
|
|
728
|
+
# specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object.
|
|
729
|
+
# For more information, see [Checking object integrity][1] in the
|
|
730
|
+
# *Amazon S3 User Guide*.
|
|
731
|
+
#
|
|
732
|
+
#
|
|
733
|
+
#
|
|
734
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
735
|
+
# @option options [String] :checksum_crc64nvme
|
|
736
|
+
# This header can be used as a data integrity check to verify that the
|
|
737
|
+
# data received is the same data that was originally sent. This header
|
|
738
|
+
# specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the
|
|
739
|
+
# object. The `CRC64NVME` checksum is always a full object checksum. For
|
|
740
|
+
# more information, see [Checking object integrity in the Amazon S3 User
|
|
741
|
+
# Guide][1].
|
|
742
|
+
#
|
|
743
|
+
#
|
|
744
|
+
#
|
|
745
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
746
|
+
# @option options [String] :checksum_sha1
|
|
747
|
+
# This header can be used as a data integrity check to verify that the
|
|
748
|
+
# data received is the same data that was originally sent. This header
|
|
749
|
+
# specifies the Base64 encoded, 160-bit `SHA1` digest of the object. For
|
|
750
|
+
# more information, see [Checking object integrity][1] in the *Amazon S3
|
|
751
|
+
# User Guide*.
|
|
752
|
+
#
|
|
753
|
+
#
|
|
754
|
+
#
|
|
755
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
756
|
+
# @option options [String] :checksum_sha256
|
|
757
|
+
# This header can be used as a data integrity check to verify that the
|
|
758
|
+
# data received is the same data that was originally sent. This header
|
|
759
|
+
# specifies the Base64 encoded, 256-bit `SHA256` digest of the object.
|
|
760
|
+
# For more information, see [Checking object integrity][1] in the
|
|
761
|
+
# *Amazon S3 User Guide*.
|
|
762
|
+
#
|
|
763
|
+
#
|
|
764
|
+
#
|
|
765
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
417
766
|
# @option options [Time,DateTime,Date,Integer,String] :expires
|
|
418
767
|
# The date and time at which the object is no longer cacheable. For more
|
|
419
768
|
# information, see
|
|
420
|
-
# [
|
|
769
|
+
# [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
|
|
770
|
+
#
|
|
771
|
+
#
|
|
772
|
+
#
|
|
773
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
|
|
774
|
+
# @option options [String] :if_match
|
|
775
|
+
# Uploads the object only if the ETag (entity tag) value provided during
|
|
776
|
+
# the WRITE operation matches the ETag of the object in S3. If the ETag
|
|
777
|
+
# values do not match, the operation returns a `412 Precondition Failed`
|
|
778
|
+
# error.
|
|
779
|
+
#
|
|
780
|
+
# If a conflicting operation occurs during the upload S3 returns a `409
|
|
781
|
+
# ConditionalRequestConflict` response. On a 409 failure you should
|
|
782
|
+
# fetch the object's ETag and retry the upload.
|
|
783
|
+
#
|
|
784
|
+
# Expects the ETag value as a string.
|
|
785
|
+
#
|
|
786
|
+
# For more information about conditional requests, see [RFC 7232][1], or
|
|
787
|
+
# [Conditional requests][2] in the *Amazon S3 User Guide*.
|
|
788
|
+
#
|
|
789
|
+
#
|
|
790
|
+
#
|
|
791
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
|
792
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
|
793
|
+
# @option options [String] :if_none_match
|
|
794
|
+
# Uploads the object only if the object key name does not already exist
|
|
795
|
+
# in the bucket specified. Otherwise, Amazon S3 returns a `412
|
|
796
|
+
# Precondition Failed` error.
|
|
797
|
+
#
|
|
798
|
+
# If a conflicting operation occurs during the upload S3 returns a `409
|
|
799
|
+
# ConditionalRequestConflict` response. On a 409 failure you should
|
|
800
|
+
# retry the upload.
|
|
801
|
+
#
|
|
802
|
+
# Expects the '*' (asterisk) character.
|
|
421
803
|
#
|
|
804
|
+
# For more information about conditional requests, see [RFC 7232][1], or
|
|
805
|
+
# [Conditional requests][2] in the *Amazon S3 User Guide*.
|
|
422
806
|
#
|
|
423
807
|
#
|
|
424
|
-
#
|
|
808
|
+
#
|
|
809
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
|
810
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
|
425
811
|
# @option options [String] :grant_full_control
|
|
426
812
|
# Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the
|
|
427
813
|
# object.
|
|
814
|
+
#
|
|
815
|
+
# <note markdown="1"> * This functionality is not supported for directory buckets.
|
|
816
|
+
#
|
|
817
|
+
# * This functionality is not supported for Amazon S3 on Outposts.
|
|
818
|
+
#
|
|
819
|
+
# </note>
|
|
428
820
|
# @option options [String] :grant_read
|
|
429
821
|
# Allows grantee to read the object data and its metadata.
|
|
822
|
+
#
|
|
823
|
+
# <note markdown="1"> * This functionality is not supported for directory buckets.
|
|
824
|
+
#
|
|
825
|
+
# * This functionality is not supported for Amazon S3 on Outposts.
|
|
826
|
+
#
|
|
827
|
+
# </note>
|
|
430
828
|
# @option options [String] :grant_read_acp
|
|
431
829
|
# Allows grantee to read the object ACL.
|
|
830
|
+
#
|
|
831
|
+
# <note markdown="1"> * This functionality is not supported for directory buckets.
|
|
832
|
+
#
|
|
833
|
+
# * This functionality is not supported for Amazon S3 on Outposts.
|
|
834
|
+
#
|
|
835
|
+
# </note>
|
|
432
836
|
# @option options [String] :grant_write_acp
|
|
433
837
|
# Allows grantee to write the ACL for the applicable object.
|
|
838
|
+
#
|
|
839
|
+
# <note markdown="1"> * This functionality is not supported for directory buckets.
|
|
840
|
+
#
|
|
841
|
+
# * This functionality is not supported for Amazon S3 on Outposts.
|
|
842
|
+
#
|
|
843
|
+
# </note>
|
|
434
844
|
# @option options [required, String] :key
|
|
435
|
-
# Object key for which the PUT
|
|
845
|
+
# Object key for which the PUT action was initiated.
|
|
846
|
+
# @option options [Integer] :write_offset_bytes
|
|
847
|
+
# Specifies the offset for appending data to existing objects in bytes.
|
|
848
|
+
# The offset must be equal to the size of the existing object being
|
|
849
|
+
# appended to. If no object exists, setting this header to 0 will create
|
|
850
|
+
# a new object.
|
|
851
|
+
#
|
|
852
|
+
# <note markdown="1"> This functionality is only supported for objects in the Amazon S3
|
|
853
|
+
# Express One Zone storage class in directory buckets.
|
|
854
|
+
#
|
|
855
|
+
# </note>
|
|
436
856
|
# @option options [Hash<String,String>] :metadata
|
|
437
857
|
# A map of metadata to store with the object in S3.
|
|
438
858
|
# @option options [String] :server_side_encryption
|
|
439
|
-
# The server-side encryption algorithm used when
|
|
440
|
-
# Amazon S3
|
|
859
|
+
# The server-side encryption algorithm that was used when you store this
|
|
860
|
+
# object in Amazon S3 or Amazon FSx.
|
|
861
|
+
#
|
|
862
|
+
# * <b>General purpose buckets </b> - You have four mutually exclusive
|
|
863
|
+
# options to protect data using server-side encryption in Amazon S3,
|
|
864
|
+
# depending on how you choose to manage the encryption keys.
|
|
865
|
+
# Specifically, the encryption key options are Amazon S3 managed keys
|
|
866
|
+
# (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
|
|
867
|
+
# customer-provided keys (SSE-C). Amazon S3 encrypts data with
|
|
868
|
+
# server-side encryption by using Amazon S3 managed keys (SSE-S3) by
|
|
869
|
+
# default. You can optionally tell Amazon S3 to encrypt data at rest
|
|
870
|
+
# by using server-side encryption with other key options. For more
|
|
871
|
+
# information, see [Using Server-Side Encryption][1] in the *Amazon S3
|
|
872
|
+
# User Guide*.
|
|
873
|
+
#
|
|
874
|
+
# * <b>Directory buckets </b> - For directory buckets, there are only
|
|
875
|
+
# two supported options for server-side encryption: server-side
|
|
876
|
+
# encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and
|
|
877
|
+
# server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). We
|
|
878
|
+
# recommend that the bucket's default encryption uses the desired
|
|
879
|
+
# encryption configuration and you don't override the bucket default
|
|
880
|
+
# encryption in your `CreateSession` requests or `PUT` object
|
|
881
|
+
# requests. Then, new objects are automatically encrypted with the
|
|
882
|
+
# desired encryption settings. For more information, see [Protecting
|
|
883
|
+
# data with server-side encryption][2] in the *Amazon S3 User Guide*.
|
|
884
|
+
# For more information about the encryption overriding behaviors in
|
|
885
|
+
# directory buckets, see [Specifying server-side encryption with KMS
|
|
886
|
+
# for new object uploads][3].
|
|
887
|
+
#
|
|
888
|
+
# In the Zonal endpoint API calls (except [CopyObject][4] and
|
|
889
|
+
# [UploadPartCopy][5]) using the REST API, the encryption request
|
|
890
|
+
# headers must match the encryption settings that are specified in the
|
|
891
|
+
# `CreateSession` request. You can't override the values of the
|
|
892
|
+
# encryption settings (`x-amz-server-side-encryption`,
|
|
893
|
+
# `x-amz-server-side-encryption-aws-kms-key-id`,
|
|
894
|
+
# `x-amz-server-side-encryption-context`, and
|
|
895
|
+
# `x-amz-server-side-encryption-bucket-key-enabled`) that are
|
|
896
|
+
# specified in the `CreateSession` request. You don't need to
|
|
897
|
+
# explicitly specify these encryption settings values in Zonal
|
|
898
|
+
# endpoint API calls, and Amazon S3 will use the encryption settings
|
|
899
|
+
# values from the `CreateSession` request to protect new objects in
|
|
900
|
+
# the directory bucket.
|
|
901
|
+
#
|
|
902
|
+
# <note markdown="1"> When you use the CLI or the Amazon Web Services SDKs, for
|
|
903
|
+
# `CreateSession`, the session token refreshes automatically to avoid
|
|
904
|
+
# service interruptions when a session expires. The CLI or the Amazon
|
|
905
|
+
# Web Services SDKs use the bucket's default encryption configuration
|
|
906
|
+
# for the `CreateSession` request. It's not supported to override the
|
|
907
|
+
# encryption settings values in the `CreateSession` request. So in the
|
|
908
|
+
# Zonal endpoint API calls (except [CopyObject][4] and
|
|
909
|
+
# [UploadPartCopy][5]), the encryption request headers must match the
|
|
910
|
+
# default encryption configuration of the directory bucket.
|
|
911
|
+
#
|
|
912
|
+
# </note>
|
|
913
|
+
#
|
|
914
|
+
# * <b>S3 access points for Amazon FSx </b> - When accessing data stored
|
|
915
|
+
# in Amazon FSx file systems using S3 access points, the only valid
|
|
916
|
+
# server side encryption option is `aws:fsx`. All Amazon FSx file
|
|
917
|
+
# systems have encryption configured by default and are encrypted at
|
|
918
|
+
# rest. Data is automatically encrypted before being written to the
|
|
919
|
+
# file system, and automatically decrypted as it is read. These
|
|
920
|
+
# processes are handled transparently by Amazon FSx.
|
|
921
|
+
#
|
|
922
|
+
#
|
|
923
|
+
#
|
|
924
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
|
925
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
|
926
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html
|
|
927
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
|
928
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
|
441
929
|
# @option options [String] :storage_class
|
|
442
|
-
#
|
|
443
|
-
#
|
|
930
|
+
# By default, Amazon S3 uses the STANDARD Storage Class to store newly
|
|
931
|
+
# created objects. The STANDARD storage class provides high durability
|
|
932
|
+
# and high availability. Depending on performance needs, you can specify
|
|
933
|
+
# a different Storage Class. For more information, see [Storage
|
|
934
|
+
# Classes][1] in the *Amazon S3 User Guide*.
|
|
935
|
+
#
|
|
936
|
+
# <note markdown="1"> * Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One
|
|
937
|
+
# Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3
|
|
938
|
+
# One Zone-Infrequent Access storage class) in Dedicated Local Zones.
|
|
939
|
+
#
|
|
940
|
+
# * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
|
|
941
|
+
#
|
|
942
|
+
# </note>
|
|
943
|
+
#
|
|
944
|
+
#
|
|
945
|
+
#
|
|
946
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
|
444
947
|
# @option options [String] :website_redirect_location
|
|
445
948
|
# If the bucket is configured as a website, redirects requests for this
|
|
446
949
|
# object to another object in the same bucket or to an external URL.
|
|
447
950
|
# Amazon S3 stores the value of this header in the object metadata. For
|
|
448
|
-
# information about object metadata, see [Object Key and Metadata][1]
|
|
951
|
+
# information about object metadata, see [Object Key and Metadata][1] in
|
|
952
|
+
# the *Amazon S3 User Guide*.
|
|
449
953
|
#
|
|
450
954
|
# In the following example, the request header sets the redirect to an
|
|
451
955
|
# object (anotherPage.html) in the same bucket:
|
|
@@ -459,7 +963,11 @@ module Aws::S3
|
|
|
459
963
|
#
|
|
460
964
|
# For more information about website hosting in Amazon S3, see [Hosting
|
|
461
965
|
# Websites on Amazon S3][2] and [How to Configure Website Page
|
|
462
|
-
# Redirects][3]
|
|
966
|
+
# Redirects][3] in the *Amazon S3 User Guide*.
|
|
967
|
+
#
|
|
968
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
969
|
+
#
|
|
970
|
+
# </note>
|
|
463
971
|
#
|
|
464
972
|
#
|
|
465
973
|
#
|
|
@@ -467,40 +975,120 @@ module Aws::S3
|
|
|
467
975
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
|
468
976
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
|
469
977
|
# @option options [String] :sse_customer_algorithm
|
|
470
|
-
# Specifies the algorithm to use
|
|
471
|
-
# example, AES256).
|
|
978
|
+
# Specifies the algorithm to use when encrypting the object (for
|
|
979
|
+
# example, `AES256`).
|
|
980
|
+
#
|
|
981
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
982
|
+
#
|
|
983
|
+
# </note>
|
|
472
984
|
# @option options [String] :sse_customer_key
|
|
473
985
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
|
474
986
|
# encrypting data. This value is used to store the object and then it is
|
|
475
987
|
# discarded; Amazon S3 does not store the encryption key. The key must
|
|
476
988
|
# be appropriate for use with the algorithm specified in the
|
|
477
|
-
# `x-amz-server-side
|
|
989
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
|
990
|
+
#
|
|
991
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
992
|
+
#
|
|
993
|
+
# </note>
|
|
478
994
|
# @option options [String] :sse_customer_key_md5
|
|
479
995
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
|
480
996
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
|
481
997
|
# ensure that the encryption key was transmitted without error.
|
|
998
|
+
#
|
|
999
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1000
|
+
#
|
|
1001
|
+
# </note>
|
|
482
1002
|
# @option options [String] :ssekms_key_id
|
|
483
|
-
#
|
|
484
|
-
#
|
|
485
|
-
#
|
|
486
|
-
#
|
|
487
|
-
#
|
|
488
|
-
#
|
|
489
|
-
#
|
|
490
|
-
#
|
|
491
|
-
# `x-amz-server-side-encryption:aws:kms
|
|
492
|
-
# x-amz-server-side-encryption
|
|
493
|
-
#
|
|
1003
|
+
# Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for
|
|
1004
|
+
# object encryption. If the KMS key doesn't exist in the same account
|
|
1005
|
+
# that's issuing the command, you must use the full Key ARN not the Key
|
|
1006
|
+
# ID.
|
|
1007
|
+
#
|
|
1008
|
+
# **General purpose buckets** - If you specify
|
|
1009
|
+
# `x-amz-server-side-encryption` with `aws:kms` or `aws:kms:dsse`, this
|
|
1010
|
+
# header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key
|
|
1011
|
+
# to use. If you specify `x-amz-server-side-encryption:aws:kms` or
|
|
1012
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide
|
|
1013
|
+
# `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
|
1014
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data.
|
|
1015
|
+
#
|
|
1016
|
+
# **Directory buckets** - To encrypt data using SSE-KMS, it's
|
|
1017
|
+
# recommended to specify the `x-amz-server-side-encryption` header to
|
|
1018
|
+
# `aws:kms`. Then, the `x-amz-server-side-encryption-aws-kms-key-id`
|
|
1019
|
+
# header implicitly uses the bucket's default KMS customer managed key
|
|
1020
|
+
# ID. If you want to explicitly set the `
|
|
1021
|
+
# x-amz-server-side-encryption-aws-kms-key-id` header, it must match the
|
|
1022
|
+
# bucket's default customer managed key (using key ID or ARN, not
|
|
1023
|
+
# alias). Your SSE-KMS configuration can only support 1 [customer
|
|
1024
|
+
# managed key][1] per directory bucket's lifetime. The [Amazon Web
|
|
1025
|
+
# Services managed key][2] (`aws/s3`) isn't supported. Incorrect key
|
|
1026
|
+
# specification results in an HTTP `400 Bad Request` error.
|
|
1027
|
+
#
|
|
1028
|
+
#
|
|
1029
|
+
#
|
|
1030
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
|
1031
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
|
494
1032
|
# @option options [String] :ssekms_encryption_context
|
|
495
|
-
# Specifies the
|
|
496
|
-
#
|
|
497
|
-
#
|
|
1033
|
+
# Specifies the Amazon Web Services KMS Encryption Context as an
|
|
1034
|
+
# additional encryption context to use for object encryption. The value
|
|
1035
|
+
# of this header is a Base64 encoded string of a UTF-8 encoded JSON,
|
|
1036
|
+
# which contains the encryption context as key-value pairs. This value
|
|
1037
|
+
# is stored as object metadata and automatically gets passed on to
|
|
1038
|
+
# Amazon Web Services KMS for future `GetObject` operations on this
|
|
1039
|
+
# object.
|
|
1040
|
+
#
|
|
1041
|
+
# **General purpose buckets** - This value must be explicitly added
|
|
1042
|
+
# during `CopyObject` operations if you want an additional encryption
|
|
1043
|
+
# context for your object. For more information, see [Encryption
|
|
1044
|
+
# context][1] in the *Amazon S3 User Guide*.
|
|
1045
|
+
#
|
|
1046
|
+
# **Directory buckets** - You can optionally provide an explicit
|
|
1047
|
+
# encryption context value. The value must match the default encryption
|
|
1048
|
+
# context - the bucket Amazon Resource Name (ARN). An additional
|
|
1049
|
+
# encryption context value is not supported.
|
|
1050
|
+
#
|
|
1051
|
+
#
|
|
1052
|
+
#
|
|
1053
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html#encryption-context
|
|
1054
|
+
# @option options [Boolean] :bucket_key_enabled
|
|
1055
|
+
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
|
1056
|
+
# encryption with server-side encryption using Key Management Service
|
|
1057
|
+
# (KMS) keys (SSE-KMS).
|
|
1058
|
+
#
|
|
1059
|
+
# **General purpose buckets** - Setting this header to `true` causes
|
|
1060
|
+
# Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
|
|
1061
|
+
# Also, specifying this header with a PUT action doesn't affect
|
|
1062
|
+
# bucket-level settings for S3 Bucket Key.
|
|
1063
|
+
#
|
|
1064
|
+
# **Directory buckets** - S3 Bucket Keys are always enabled for `GET`
|
|
1065
|
+
# and `PUT` operations in a directory bucket and can’t be disabled. S3
|
|
1066
|
+
# Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects
|
|
1067
|
+
# from general purpose buckets to directory buckets, from directory
|
|
1068
|
+
# buckets to general purpose buckets, or between directory buckets,
|
|
1069
|
+
# through [CopyObject][1], [UploadPartCopy][2], [the Copy operation in
|
|
1070
|
+
# Batch Operations][3], or [the import jobs][4]. In this case, Amazon S3
|
|
1071
|
+
# makes a call to KMS every time a copy request is made for a
|
|
1072
|
+
# KMS-encrypted object.
|
|
1073
|
+
#
|
|
1074
|
+
#
|
|
1075
|
+
#
|
|
1076
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
|
1077
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
|
1078
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops
|
|
1079
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job
|
|
498
1080
|
# @option options [String] :request_payer
|
|
499
1081
|
# Confirms that the requester knows that they will be charged for the
|
|
500
1082
|
# request. Bucket owners need not specify this parameter in their
|
|
501
|
-
# requests.
|
|
502
|
-
#
|
|
503
|
-
#
|
|
1083
|
+
# requests. If either the source or destination S3 bucket has Requester
|
|
1084
|
+
# Pays enabled, the requester will pay for corresponding charges to copy
|
|
1085
|
+
# the object. For information about downloading objects from Requester
|
|
1086
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
|
1087
|
+
# in the *Amazon S3 User Guide*.
|
|
1088
|
+
#
|
|
1089
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1090
|
+
#
|
|
1091
|
+
# </note>
|
|
504
1092
|
#
|
|
505
1093
|
#
|
|
506
1094
|
#
|
|
@@ -508,21 +1096,45 @@ module Aws::S3
|
|
|
508
1096
|
# @option options [String] :tagging
|
|
509
1097
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
|
510
1098
|
# parameters. (For example, "Key1=Value1")
|
|
1099
|
+
#
|
|
1100
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1101
|
+
#
|
|
1102
|
+
# </note>
|
|
511
1103
|
# @option options [String] :object_lock_mode
|
|
512
1104
|
# The Object Lock mode that you want to apply to this object.
|
|
1105
|
+
#
|
|
1106
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1107
|
+
#
|
|
1108
|
+
# </note>
|
|
513
1109
|
# @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
|
514
1110
|
# The date and time when you want this object's Object Lock to expire.
|
|
1111
|
+
# Must be formatted as a timestamp parameter.
|
|
1112
|
+
#
|
|
1113
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1114
|
+
#
|
|
1115
|
+
# </note>
|
|
515
1116
|
# @option options [String] :object_lock_legal_hold_status
|
|
516
1117
|
# Specifies whether a legal hold will be applied to this object. For
|
|
517
|
-
# more information about S3 Object Lock, see [Object Lock][1]
|
|
1118
|
+
# more information about S3 Object Lock, see [Object Lock][1] in the
|
|
1119
|
+
# *Amazon S3 User Guide*.
|
|
1120
|
+
#
|
|
1121
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1122
|
+
#
|
|
1123
|
+
# </note>
|
|
518
1124
|
#
|
|
519
1125
|
#
|
|
520
1126
|
#
|
|
521
1127
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
|
1128
|
+
# @option options [String] :expected_bucket_owner
|
|
1129
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
1130
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
1131
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
522
1132
|
# @return [Object]
|
|
523
1133
|
def put_object(options = {})
|
|
524
1134
|
options = options.merge(bucket: @name)
|
|
525
|
-
|
|
1135
|
+
Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
1136
|
+
@client.put_object(options)
|
|
1137
|
+
end
|
|
526
1138
|
Object.new(
|
|
527
1139
|
bucket_name: @name,
|
|
528
1140
|
key: options[:key],
|
|
@@ -580,6 +1192,8 @@ module Aws::S3
|
|
|
580
1192
|
# key_marker: "KeyMarker",
|
|
581
1193
|
# prefix: "Prefix",
|
|
582
1194
|
# upload_id_marker: "UploadIdMarker",
|
|
1195
|
+
# expected_bucket_owner: "AccountId",
|
|
1196
|
+
# request_payer: "requester", # accepts requester
|
|
583
1197
|
# })
|
|
584
1198
|
# @param [Hash] options ({})
|
|
585
1199
|
# @option options [String] :delimiter
|
|
@@ -591,30 +1205,73 @@ module Aws::S3
|
|
|
591
1205
|
# don't specify the prefix parameter, then the substring starts at the
|
|
592
1206
|
# beginning of the key. The keys that are grouped under `CommonPrefixes`
|
|
593
1207
|
# result element are not returned elsewhere in the response.
|
|
1208
|
+
#
|
|
1209
|
+
# `CommonPrefixes` is filtered out from results if it is not
|
|
1210
|
+
# lexicographically greater than the key-marker.
|
|
1211
|
+
#
|
|
1212
|
+
# <note markdown="1"> **Directory buckets** - For directory buckets, `/` is the only
|
|
1213
|
+
# supported delimiter.
|
|
1214
|
+
#
|
|
1215
|
+
# </note>
|
|
594
1216
|
# @option options [String] :encoding_type
|
|
595
|
-
#
|
|
596
|
-
#
|
|
597
|
-
# Unicode character
|
|
598
|
-
# characters, such as characters with an ASCII value from
|
|
599
|
-
# characters that
|
|
600
|
-
# parameter to request that Amazon S3 encode the keys in the
|
|
1217
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in the
|
|
1218
|
+
# response. Responses are encoded only in UTF-8. An object key can
|
|
1219
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
|
1220
|
+
# parse certain characters, such as characters with an ASCII value from
|
|
1221
|
+
# 0 to 10. For characters that aren't supported in XML 1.0, you can add
|
|
1222
|
+
# this parameter to request that Amazon S3 encode the keys in the
|
|
1223
|
+
# response. For more information about characters to avoid in object key
|
|
1224
|
+
# names, see [Object key naming guidelines][2].
|
|
1225
|
+
#
|
|
1226
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
|
1227
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
|
1228
|
+
# code values. For example, the object `test_file(3).png` will appear as
|
|
1229
|
+
# `test_file%283%29.png`.
|
|
1230
|
+
#
|
|
1231
|
+
# </note>
|
|
1232
|
+
#
|
|
1233
|
+
#
|
|
1234
|
+
#
|
|
1235
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
|
1236
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
|
601
1237
|
# @option options [String] :key_marker
|
|
602
|
-
#
|
|
603
|
-
# upload after which listing should begin.
|
|
1238
|
+
# Specifies the multipart upload after which listing should begin.
|
|
604
1239
|
#
|
|
605
|
-
#
|
|
606
|
-
#
|
|
607
|
-
#
|
|
1240
|
+
# <note markdown="1"> * **General purpose buckets** - For general purpose buckets,
|
|
1241
|
+
# `key-marker` is an object key. Together with `upload-id-marker`,
|
|
1242
|
+
# this parameter specifies the multipart upload after which listing
|
|
1243
|
+
# should begin.
|
|
608
1244
|
#
|
|
609
|
-
#
|
|
610
|
-
#
|
|
611
|
-
#
|
|
612
|
-
#
|
|
1245
|
+
# If `upload-id-marker` is not specified, only the keys
|
|
1246
|
+
# lexicographically greater than the specified `key-marker` will be
|
|
1247
|
+
# included in the list.
|
|
1248
|
+
#
|
|
1249
|
+
# If `upload-id-marker` is specified, any multipart uploads for a key
|
|
1250
|
+
# equal to the `key-marker` might also be included, provided those
|
|
1251
|
+
# multipart uploads have upload IDs lexicographically greater than the
|
|
1252
|
+
# specified `upload-id-marker`.
|
|
1253
|
+
#
|
|
1254
|
+
# * **Directory buckets** - For directory buckets, `key-marker` is
|
|
1255
|
+
# obfuscated and isn't a real object key. The `upload-id-marker`
|
|
1256
|
+
# parameter isn't supported by directory buckets. To list the
|
|
1257
|
+
# additional multipart uploads, you only need to set the value of
|
|
1258
|
+
# `key-marker` to the `NextKeyMarker` value from the previous
|
|
1259
|
+
# response.
|
|
1260
|
+
#
|
|
1261
|
+
# In the `ListMultipartUploads` response, the multipart uploads
|
|
1262
|
+
# aren't sorted lexicographically based on the object keys.
|
|
1263
|
+
#
|
|
1264
|
+
# </note>
|
|
613
1265
|
# @option options [String] :prefix
|
|
614
1266
|
# Lists in-progress uploads only for those keys that begin with the
|
|
615
1267
|
# specified prefix. You can use prefixes to separate a bucket into
|
|
616
|
-
# different grouping of keys. (You can think of using prefix to make
|
|
617
|
-
# groups in the same way you'd use a folder in a file system.)
|
|
1268
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
|
1269
|
+
# groups in the same way that you'd use a folder in a file system.)
|
|
1270
|
+
#
|
|
1271
|
+
# <note markdown="1"> **Directory buckets** - For directory buckets, only prefixes that end
|
|
1272
|
+
# in a delimiter (`/`) are supported.
|
|
1273
|
+
#
|
|
1274
|
+
# </note>
|
|
618
1275
|
# @option options [String] :upload_id_marker
|
|
619
1276
|
# Together with key-marker, specifies the multipart upload after which
|
|
620
1277
|
# listing should begin. If key-marker is not specified, the
|
|
@@ -622,11 +1279,37 @@ module Aws::S3
|
|
|
622
1279
|
# uploads for a key equal to the key-marker might be included in the
|
|
623
1280
|
# list only if they have an upload ID lexicographically greater than the
|
|
624
1281
|
# specified `upload-id-marker`.
|
|
1282
|
+
#
|
|
1283
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1284
|
+
#
|
|
1285
|
+
# </note>
|
|
1286
|
+
# @option options [String] :expected_bucket_owner
|
|
1287
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
1288
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
1289
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
1290
|
+
# @option options [String] :request_payer
|
|
1291
|
+
# Confirms that the requester knows that they will be charged for the
|
|
1292
|
+
# request. Bucket owners need not specify this parameter in their
|
|
1293
|
+
# requests. If either the source or destination S3 bucket has Requester
|
|
1294
|
+
# Pays enabled, the requester will pay for corresponding charges to copy
|
|
1295
|
+
# the object. For information about downloading objects from Requester
|
|
1296
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
|
1297
|
+
# in the *Amazon S3 User Guide*.
|
|
1298
|
+
#
|
|
1299
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1300
|
+
#
|
|
1301
|
+
# </note>
|
|
1302
|
+
#
|
|
1303
|
+
#
|
|
1304
|
+
#
|
|
1305
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
625
1306
|
# @return [MultipartUpload::Collection]
|
|
626
1307
|
def multipart_uploads(options = {})
|
|
627
1308
|
batches = Enumerator.new do |y|
|
|
628
1309
|
options = options.merge(bucket: @name)
|
|
629
|
-
resp =
|
|
1310
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
1311
|
+
@client.list_multipart_uploads(options)
|
|
1312
|
+
end
|
|
630
1313
|
resp.each_page do |page|
|
|
631
1314
|
batch = []
|
|
632
1315
|
page.data.uploads.each do |u|
|
|
@@ -670,38 +1353,83 @@ module Aws::S3
|
|
|
670
1353
|
# key_marker: "KeyMarker",
|
|
671
1354
|
# prefix: "Prefix",
|
|
672
1355
|
# version_id_marker: "VersionIdMarker",
|
|
1356
|
+
# expected_bucket_owner: "AccountId",
|
|
1357
|
+
# request_payer: "requester", # accepts requester
|
|
1358
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
|
673
1359
|
# })
|
|
674
1360
|
# @param [Hash] options ({})
|
|
675
1361
|
# @option options [String] :delimiter
|
|
676
1362
|
# A delimiter is a character that you specify to group keys. All keys
|
|
677
1363
|
# that contain the same string between the `prefix` and the first
|
|
678
1364
|
# occurrence of the delimiter are grouped under a single result element
|
|
679
|
-
# in CommonPrefixes
|
|
680
|
-
# max-keys limitation. These keys are not returned elsewhere in
|
|
681
|
-
# response.
|
|
1365
|
+
# in `CommonPrefixes`. These groups are counted as one result against
|
|
1366
|
+
# the `max-keys` limitation. These keys are not returned elsewhere in
|
|
1367
|
+
# the response.
|
|
1368
|
+
#
|
|
1369
|
+
# `CommonPrefixes` is filtered out from results if it is not
|
|
1370
|
+
# lexicographically greater than the key-marker.
|
|
682
1371
|
# @option options [String] :encoding_type
|
|
683
|
-
#
|
|
684
|
-
#
|
|
685
|
-
# Unicode character
|
|
686
|
-
# characters, such as characters with an ASCII value from
|
|
687
|
-
# characters that
|
|
688
|
-
# parameter to request that Amazon S3 encode the keys in the
|
|
1372
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in the
|
|
1373
|
+
# response. Responses are encoded only in UTF-8. An object key can
|
|
1374
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
|
1375
|
+
# parse certain characters, such as characters with an ASCII value from
|
|
1376
|
+
# 0 to 10. For characters that aren't supported in XML 1.0, you can add
|
|
1377
|
+
# this parameter to request that Amazon S3 encode the keys in the
|
|
1378
|
+
# response. For more information about characters to avoid in object key
|
|
1379
|
+
# names, see [Object key naming guidelines][2].
|
|
1380
|
+
#
|
|
1381
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
|
1382
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
|
1383
|
+
# code values. For example, the object `test_file(3).png` will appear as
|
|
1384
|
+
# `test_file%283%29.png`.
|
|
1385
|
+
#
|
|
1386
|
+
# </note>
|
|
1387
|
+
#
|
|
1388
|
+
#
|
|
1389
|
+
#
|
|
1390
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
|
1391
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
|
689
1392
|
# @option options [String] :key_marker
|
|
690
1393
|
# Specifies the key to start with when listing objects in a bucket.
|
|
691
1394
|
# @option options [String] :prefix
|
|
692
1395
|
# Use this parameter to select only those keys that begin with the
|
|
693
1396
|
# specified prefix. You can use prefixes to separate a bucket into
|
|
694
|
-
# different groupings of keys. (You can think of using prefix to make
|
|
695
|
-
# groups in the same way you'd use a folder in a file system.) You
|
|
696
|
-
# use prefix with delimiter to roll up numerous objects into a
|
|
697
|
-
# result under CommonPrefixes
|
|
1397
|
+
# different groupings of keys. (You can think of using `prefix` to make
|
|
1398
|
+
# groups in the same way that you'd use a folder in a file system.) You
|
|
1399
|
+
# can use `prefix` with `delimiter` to roll up numerous objects into a
|
|
1400
|
+
# single result under `CommonPrefixes`.
|
|
698
1401
|
# @option options [String] :version_id_marker
|
|
699
1402
|
# Specifies the object version you want to start listing from.
|
|
1403
|
+
# @option options [String] :expected_bucket_owner
|
|
1404
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
1405
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
1406
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
1407
|
+
# @option options [String] :request_payer
|
|
1408
|
+
# Confirms that the requester knows that they will be charged for the
|
|
1409
|
+
# request. Bucket owners need not specify this parameter in their
|
|
1410
|
+
# requests. If either the source or destination S3 bucket has Requester
|
|
1411
|
+
# Pays enabled, the requester will pay for corresponding charges to copy
|
|
1412
|
+
# the object. For information about downloading objects from Requester
|
|
1413
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
|
1414
|
+
# in the *Amazon S3 User Guide*.
|
|
1415
|
+
#
|
|
1416
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1417
|
+
#
|
|
1418
|
+
# </note>
|
|
1419
|
+
#
|
|
1420
|
+
#
|
|
1421
|
+
#
|
|
1422
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
1423
|
+
# @option options [Array<String>] :optional_object_attributes
|
|
1424
|
+
# Specifies the optional fields that you want returned in the response.
|
|
1425
|
+
# Fields that you do not specify are not returned.
|
|
700
1426
|
# @return [ObjectVersion::Collection]
|
|
701
1427
|
def object_versions(options = {})
|
|
702
1428
|
batches = Enumerator.new do |y|
|
|
703
1429
|
options = options.merge(bucket: @name)
|
|
704
|
-
resp =
|
|
1430
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
1431
|
+
@client.list_object_versions(options)
|
|
1432
|
+
end
|
|
705
1433
|
resp.each_page do |page|
|
|
706
1434
|
batch = []
|
|
707
1435
|
page.data.versions_delete_markers.each do |v|
|
|
@@ -728,31 +1456,102 @@ module Aws::S3
|
|
|
728
1456
|
# fetch_owner: false,
|
|
729
1457
|
# start_after: "StartAfter",
|
|
730
1458
|
# request_payer: "requester", # accepts requester
|
|
1459
|
+
# expected_bucket_owner: "AccountId",
|
|
1460
|
+
# optional_object_attributes: ["RestoreStatus"], # accepts RestoreStatus
|
|
731
1461
|
# })
|
|
732
1462
|
# @param [Hash] options ({})
|
|
733
1463
|
# @option options [String] :delimiter
|
|
734
|
-
# A delimiter is a character you use to group keys.
|
|
1464
|
+
# A delimiter is a character that you use to group keys.
|
|
1465
|
+
#
|
|
1466
|
+
# `CommonPrefixes` is filtered out from results if it is not
|
|
1467
|
+
# lexicographically greater than the `StartAfter` value.
|
|
1468
|
+
#
|
|
1469
|
+
# <note markdown="1"> * **Directory buckets** - For directory buckets, `/` is the only
|
|
1470
|
+
# supported delimiter.
|
|
1471
|
+
#
|
|
1472
|
+
# * <b>Directory buckets </b> - When you query `ListObjectsV2` with a
|
|
1473
|
+
# delimiter during in-progress multipart uploads, the `CommonPrefixes`
|
|
1474
|
+
# response parameter contains the prefixes that are associated with
|
|
1475
|
+
# the in-progress multipart uploads. For more information about
|
|
1476
|
+
# multipart uploads, see [Multipart Upload Overview][1] in the *Amazon
|
|
1477
|
+
# S3 User Guide*.
|
|
1478
|
+
#
|
|
1479
|
+
# </note>
|
|
1480
|
+
#
|
|
1481
|
+
#
|
|
1482
|
+
#
|
|
1483
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
|
735
1484
|
# @option options [String] :encoding_type
|
|
736
|
-
# Encoding type used by Amazon S3 to encode object keys in the
|
|
1485
|
+
# Encoding type used by Amazon S3 to encode the [object keys][1] in the
|
|
1486
|
+
# response. Responses are encoded only in UTF-8. An object key can
|
|
1487
|
+
# contain any Unicode character. However, the XML 1.0 parser can't
|
|
1488
|
+
# parse certain characters, such as characters with an ASCII value from
|
|
1489
|
+
# 0 to 10. For characters that aren't supported in XML 1.0, you can add
|
|
1490
|
+
# this parameter to request that Amazon S3 encode the keys in the
|
|
1491
|
+
# response. For more information about characters to avoid in object key
|
|
1492
|
+
# names, see [Object key naming guidelines][2].
|
|
1493
|
+
#
|
|
1494
|
+
# <note markdown="1"> When using the URL encoding type, non-ASCII characters that are used
|
|
1495
|
+
# in an object's key name will be percent-encoded according to UTF-8
|
|
1496
|
+
# code values. For example, the object `test_file(3).png` will appear as
|
|
1497
|
+
# `test_file%283%29.png`.
|
|
1498
|
+
#
|
|
1499
|
+
# </note>
|
|
1500
|
+
#
|
|
1501
|
+
#
|
|
1502
|
+
#
|
|
1503
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
|
|
1504
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines
|
|
737
1505
|
# @option options [String] :prefix
|
|
738
1506
|
# Limits the response to keys that begin with the specified prefix.
|
|
1507
|
+
#
|
|
1508
|
+
# <note markdown="1"> **Directory buckets** - For directory buckets, only prefixes that end
|
|
1509
|
+
# in a delimiter (`/`) are supported.
|
|
1510
|
+
#
|
|
1511
|
+
# </note>
|
|
739
1512
|
# @option options [Boolean] :fetch_owner
|
|
740
|
-
# The owner field is not present in
|
|
741
|
-
# return owner field with each key in the result then set
|
|
742
|
-
#
|
|
1513
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
|
1514
|
+
# want to return the owner field with each key in the result, then set
|
|
1515
|
+
# the `FetchOwner` field to `true`.
|
|
1516
|
+
#
|
|
1517
|
+
# <note markdown="1"> **Directory buckets** - For directory buckets, the bucket owner is
|
|
1518
|
+
# returned as the object owner for all objects.
|
|
1519
|
+
#
|
|
1520
|
+
# </note>
|
|
743
1521
|
# @option options [String] :start_after
|
|
744
1522
|
# StartAfter is where you want Amazon S3 to start listing from. Amazon
|
|
745
1523
|
# S3 starts listing after this specified key. StartAfter can be any key
|
|
746
1524
|
# in the bucket.
|
|
1525
|
+
#
|
|
1526
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1527
|
+
#
|
|
1528
|
+
# </note>
|
|
747
1529
|
# @option options [String] :request_payer
|
|
748
1530
|
# Confirms that the requester knows that she or he will be charged for
|
|
749
1531
|
# the list objects request in V2 style. Bucket owners need not specify
|
|
750
1532
|
# this parameter in their requests.
|
|
1533
|
+
#
|
|
1534
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1535
|
+
#
|
|
1536
|
+
# </note>
|
|
1537
|
+
# @option options [String] :expected_bucket_owner
|
|
1538
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
1539
|
+
# you provide does not match the actual owner of the bucket, the request
|
|
1540
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
1541
|
+
# @option options [Array<String>] :optional_object_attributes
|
|
1542
|
+
# Specifies the optional fields that you want returned in the response.
|
|
1543
|
+
# Fields that you do not specify are not returned.
|
|
1544
|
+
#
|
|
1545
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1546
|
+
#
|
|
1547
|
+
# </note>
|
|
751
1548
|
# @return [ObjectSummary::Collection]
|
|
752
1549
|
def objects(options = {})
|
|
753
1550
|
batches = Enumerator.new do |y|
|
|
754
1551
|
options = options.merge(bucket: @name)
|
|
755
|
-
resp =
|
|
1552
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
|
1553
|
+
@client.list_objects_v2(options)
|
|
1554
|
+
end
|
|
756
1555
|
resp.each_page do |page|
|
|
757
1556
|
batch = []
|
|
758
1557
|
page.data.contents.each do |c|
|
|
@@ -859,3 +1658,6 @@ module Aws::S3
|
|
|
859
1658
|
class Collection < Aws::Resources::Collection; end
|
|
860
1659
|
end
|
|
861
1660
|
end
|
|
1661
|
+
|
|
1662
|
+
# Load customizations if they exist
|
|
1663
|
+
require 'aws-sdk-s3/customizations/bucket'
|