aws-sdk-s3 1.205.0 → 1.216.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 +68 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +45 -17
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -1
- data/lib/aws-sdk-s3/client.rb +532 -345
- data/lib/aws-sdk-s3/client_api.rb +56 -0
- data/lib/aws-sdk-s3/customizations.rb +9 -2
- data/lib/aws-sdk-s3/directory_download_error.rb +16 -0
- data/lib/aws-sdk-s3/directory_downloader.rb +230 -0
- data/lib/aws-sdk-s3/directory_upload_error.rb +16 -0
- data/lib/aws-sdk-s3/directory_uploader.rb +270 -0
- data/lib/aws-sdk-s3/encryption/client.rb +2 -2
- 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 +2 -0
- data/lib/aws-sdk-s3/encryptionV2/client.rb +98 -23
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +7 -162
- data/lib/aws-sdk-s3/encryptionV2/decryption.rb +205 -0
- data/lib/aws-sdk-s3/encryptionV2/default_cipher_provider.rb +17 -0
- data/lib/aws-sdk-s3/encryptionV2/encrypt_handler.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/io_encrypter.rb +2 -0
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +8 -0
- 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_provider.rb +21 -18
- data/lib/aws-sdk-s3/endpoints.rb +13 -0
- data/lib/aws-sdk-s3/errors.rb +11 -0
- data/lib/aws-sdk-s3/file_uploader.rb +9 -1
- data/lib/aws-sdk-s3/multipart_file_uploader.rb +4 -1
- data/lib/aws-sdk-s3/multipart_upload.rb +12 -12
- data/lib/aws-sdk-s3/multipart_upload_part.rb +8 -8
- data/lib/aws-sdk-s3/object.rb +36 -36
- data/lib/aws-sdk-s3/object_acl.rb +5 -5
- data/lib/aws-sdk-s3/object_summary.rb +32 -32
- data/lib/aws-sdk-s3/object_version.rb +16 -16
- data/lib/aws-sdk-s3/plugins/checksum_algorithm.rb +18 -5
- data/lib/aws-sdk-s3/plugins/http_200_errors.rb +58 -34
- data/lib/aws-sdk-s3/resource.rb +28 -0
- data/lib/aws-sdk-s3/transfer_manager.rb +244 -7
- data/lib/aws-sdk-s3/types.rb +373 -223
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +3 -2
- data/sig/client.rbs +35 -12
- data/sig/errors.rbs +2 -0
- data/sig/multipart_upload.rbs +1 -1
- data/sig/object.rbs +5 -5
- data/sig/object_summary.rbs +5 -5
- data/sig/resource.rbs +2 -1
- data/sig/types.rbs +52 -14
- metadata +23 -3
data/lib/aws-sdk-s3/client.rb
CHANGED
|
@@ -721,10 +721,10 @@ module Aws::S3
|
|
|
721
721
|
# Confirms that the requester knows that they will be charged for the
|
|
722
722
|
# request. Bucket owners need not specify this parameter in their
|
|
723
723
|
# requests. If either the source or destination S3 bucket has Requester
|
|
724
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
725
|
-
#
|
|
726
|
-
#
|
|
727
|
-
#
|
|
724
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
725
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
726
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
727
|
+
# S3 User Guide*.
|
|
728
728
|
#
|
|
729
729
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
730
730
|
#
|
|
@@ -1079,10 +1079,10 @@ module Aws::S3
|
|
|
1079
1079
|
# Confirms that the requester knows that they will be charged for the
|
|
1080
1080
|
# request. Bucket owners need not specify this parameter in their
|
|
1081
1081
|
# requests. If either the source or destination S3 bucket has Requester
|
|
1082
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
1083
|
-
#
|
|
1084
|
-
#
|
|
1085
|
-
#
|
|
1082
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
1083
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
1084
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
1085
|
+
# S3 User Guide*.
|
|
1086
1086
|
#
|
|
1087
1087
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
1088
1088
|
#
|
|
@@ -1308,7 +1308,7 @@ module Aws::S3
|
|
|
1308
1308
|
# (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe
|
|
1309
1309
|
# (Ireland), and South America (São Paulo).
|
|
1310
1310
|
#
|
|
1311
|
-
# <note markdown="1"> You can store individual objects of up to
|
|
1311
|
+
# <note markdown="1"> You can store individual objects of up to 50 TB in Amazon S3. You
|
|
1312
1312
|
# create a copy of your object up to 5 GB in size in a single atomic
|
|
1313
1313
|
# action using this API. However, to copy an object greater than 5 GB,
|
|
1314
1314
|
# you must use the multipart upload Upload Part - Copy (UploadPartCopy)
|
|
@@ -1392,10 +1392,13 @@ module Aws::S3
|
|
|
1392
1392
|
# * If the source object that you want to copy is in a directory
|
|
1393
1393
|
# bucket, you must have the <b>
|
|
1394
1394
|
# <code>s3express:CreateSession</code> </b> permission in the
|
|
1395
|
-
# `Action` element of a policy to read the object.
|
|
1396
|
-
#
|
|
1397
|
-
#
|
|
1398
|
-
#
|
|
1395
|
+
# `Action` element of a policy to read the object. If no session
|
|
1396
|
+
# mode is specified, the session will be created with the maximum
|
|
1397
|
+
# allowable privilege, attempting `ReadWrite` first, then
|
|
1398
|
+
# `ReadOnly` if `ReadWrite` is not permitted. If you want to
|
|
1399
|
+
# explicitly restrict the access to be read-only, you can set the
|
|
1400
|
+
# `s3express:SessionMode` condition key to `ReadOnly` on the copy
|
|
1401
|
+
# source bucket.
|
|
1399
1402
|
#
|
|
1400
1403
|
# * If the copy destination is a directory bucket, you must have the
|
|
1401
1404
|
# <b> <code>s3express:CreateSession</code> </b> permission in the
|
|
@@ -2209,10 +2212,10 @@ module Aws::S3
|
|
|
2209
2212
|
# Confirms that the requester knows that they will be charged for the
|
|
2210
2213
|
# request. Bucket owners need not specify this parameter in their
|
|
2211
2214
|
# requests. If either the source or destination S3 bucket has Requester
|
|
2212
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
2213
|
-
#
|
|
2214
|
-
#
|
|
2215
|
-
#
|
|
2215
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
2216
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
2217
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
2218
|
+
# S3 User Guide*.
|
|
2216
2219
|
#
|
|
2217
2220
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
2218
2221
|
#
|
|
@@ -2370,7 +2373,7 @@ module Aws::S3
|
|
|
2370
2373
|
# metadata_directive: "COPY", # accepts COPY, REPLACE
|
|
2371
2374
|
# tagging_directive: "COPY", # accepts COPY, REPLACE
|
|
2372
2375
|
# server_side_encryption: "AES256", # accepts AES256, aws:fsx, aws:kms, aws:kms:dsse
|
|
2373
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
2376
|
+
# 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
|
|
2374
2377
|
# website_redirect_location: "WebsiteRedirectLocation",
|
|
2375
2378
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
|
2376
2379
|
# sse_customer_key: "SSECustomerKey",
|
|
@@ -2420,18 +2423,6 @@ module Aws::S3
|
|
|
2420
2423
|
req.send_request(options)
|
|
2421
2424
|
end
|
|
2422
2425
|
|
|
2423
|
-
# End of support notice: As of October 1, 2025, Amazon S3 has
|
|
2424
|
-
# discontinued support for Email Grantee Access Control Lists (ACLs). If
|
|
2425
|
-
# you attempt to use an Email Grantee ACL in a request after October 1,
|
|
2426
|
-
# 2025, the request will receive an `HTTP 405` (Method Not Allowed)
|
|
2427
|
-
# error.
|
|
2428
|
-
#
|
|
2429
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
2430
|
-
# East
|
|
2431
|
-
# (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific
|
|
2432
|
-
# (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe
|
|
2433
|
-
# (Ireland), and South America (São Paulo).
|
|
2434
|
-
#
|
|
2435
2426
|
# <note markdown="1"> This action creates an Amazon S3 bucket. To create an Amazon S3 on
|
|
2436
2427
|
# Outposts bucket, see [ `CreateBucket` ][1].
|
|
2437
2428
|
#
|
|
@@ -2447,6 +2438,20 @@ module Aws::S3
|
|
|
2447
2438
|
# configuring, and working with Amazon S3 buckets][2] in the *Amazon S3
|
|
2448
2439
|
# User Guide*.
|
|
2449
2440
|
#
|
|
2441
|
+
# General purpose buckets exist in a global namespace, which means that
|
|
2442
|
+
# each bucket name must be unique across all Amazon Web Services
|
|
2443
|
+
# accounts in all the Amazon Web Services Regions within a partition. A
|
|
2444
|
+
# partition is a grouping of Regions. Amazon Web Services currently has
|
|
2445
|
+
# four partitions: `aws` (Standard Regions), `aws-cn` (China Regions),
|
|
2446
|
+
# `aws-us-gov` (Amazon Web Services GovCloud (US)), and `aws-eusc`
|
|
2447
|
+
# (European Sovereign Cloud). When you create a general purpose bucket,
|
|
2448
|
+
# you can choose to create a bucket in the shared global namespace or
|
|
2449
|
+
# you can choose to create a bucket in your account regional namespace.
|
|
2450
|
+
# Your account regional namespace is a subdivision of the global
|
|
2451
|
+
# namespace that only your account can create buckets in. For more
|
|
2452
|
+
# information on account regional namespaces, see [Namespaces for
|
|
2453
|
+
# general purpose buckets][3].
|
|
2454
|
+
#
|
|
2450
2455
|
# <note markdown="1"> * **General purpose buckets** - If you send your `CreateBucket`
|
|
2451
2456
|
# request to the `s3.amazonaws.com` global endpoint, the request goes
|
|
2452
2457
|
# to the `us-east-1` Region. So the signature calculations in
|
|
@@ -2455,7 +2460,7 @@ module Aws::S3
|
|
|
2455
2460
|
# the bucket is to be created. If you create a bucket in a Region
|
|
2456
2461
|
# other than US East (N. Virginia), your application must be able to
|
|
2457
2462
|
# handle 307 redirect. For more information, see [Virtual hosting of
|
|
2458
|
-
# buckets][
|
|
2463
|
+
# buckets][4] in the *Amazon S3 User Guide*.
|
|
2459
2464
|
#
|
|
2460
2465
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
|
2461
2466
|
# requests for this API operation to the Regional endpoint. These
|
|
@@ -2463,9 +2468,9 @@ module Aws::S3
|
|
|
2463
2468
|
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
|
2464
2469
|
# Virtual-hosted-style requests aren't supported. For more
|
|
2465
2470
|
# information about endpoints in Availability Zones, see [Regional and
|
|
2466
|
-
# Zonal endpoints for directory buckets in Availability Zones][
|
|
2471
|
+
# Zonal endpoints for directory buckets in Availability Zones][5] in
|
|
2467
2472
|
# the *Amazon S3 User Guide*. For more information about endpoints in
|
|
2468
|
-
# Local Zones, see [Concepts for directory buckets in Local Zones][
|
|
2473
|
+
# Local Zones, see [Concepts for directory buckets in Local Zones][6]
|
|
2469
2474
|
# in the *Amazon S3 User Guide*.
|
|
2470
2475
|
#
|
|
2471
2476
|
# </note>
|
|
@@ -2508,17 +2513,17 @@ module Aws::S3
|
|
|
2508
2513
|
# disabled. If you would like to share data with users outside of
|
|
2509
2514
|
# your account, you can use bucket policies as needed. For more
|
|
2510
2515
|
# information, see [Controlling ownership of objects and disabling
|
|
2511
|
-
# ACLs for your bucket ][
|
|
2512
|
-
# Amazon S3 storage ][
|
|
2516
|
+
# ACLs for your bucket ][7] and [Blocking public access to your
|
|
2517
|
+
# Amazon S3 storage ][8] in the *Amazon S3 User Guide*.
|
|
2513
2518
|
#
|
|
2514
2519
|
# * **S3 Block Public Access** - If your specific use case requires
|
|
2515
2520
|
# granting public access to your S3 resources, you can disable
|
|
2516
2521
|
# Block Public Access. Specifically, you can create a new bucket
|
|
2517
2522
|
# with Block Public Access enabled, then separately call the [
|
|
2518
|
-
# `DeletePublicAccessBlock` ][
|
|
2523
|
+
# `DeletePublicAccessBlock` ][9] API. To use this operation, you
|
|
2519
2524
|
# must have the `s3:PutBucketPublicAccessBlock` permission. For
|
|
2520
2525
|
# more information about S3 Block Public Access, see [Blocking
|
|
2521
|
-
# public access to your Amazon S3 storage ][
|
|
2526
|
+
# public access to your Amazon S3 storage ][8] in the *Amazon S3
|
|
2522
2527
|
# User Guide*.
|
|
2523
2528
|
# * **Directory bucket permissions** - You must have the
|
|
2524
2529
|
# `s3express:CreateBucket` permission in an IAM identity-based
|
|
@@ -2527,7 +2532,7 @@ module Aws::S3
|
|
|
2527
2532
|
# performed by the Amazon Web Services account that owns the
|
|
2528
2533
|
# resource. For more information about directory bucket policies and
|
|
2529
2534
|
# permissions, see [Amazon Web Services Identity and Access
|
|
2530
|
-
# Management (IAM) for S3 Express One Zone][
|
|
2535
|
+
# Management (IAM) for S3 Express One Zone][10] in the *Amazon S3
|
|
2531
2536
|
# User Guide*.
|
|
2532
2537
|
#
|
|
2533
2538
|
# The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
|
|
@@ -2537,9 +2542,9 @@ module Aws::S3
|
|
|
2537
2542
|
# enforced (ACLs disabled). These settings can't be modified.
|
|
2538
2543
|
#
|
|
2539
2544
|
# For more information about permissions for creating and working
|
|
2540
|
-
# with directory buckets, see [Directory buckets][
|
|
2545
|
+
# with directory buckets, see [Directory buckets][11] in the *Amazon
|
|
2541
2546
|
# S3 User Guide*. For more information about supported S3 features
|
|
2542
|
-
# for directory buckets, see [Features of S3 Express One Zone][
|
|
2547
|
+
# for directory buckets, see [Features of S3 Express One Zone][12]
|
|
2543
2548
|
# in the *Amazon S3 User Guide*.
|
|
2544
2549
|
#
|
|
2545
2550
|
# HTTP Host header syntax
|
|
@@ -2549,9 +2554,9 @@ module Aws::S3
|
|
|
2549
2554
|
#
|
|
2550
2555
|
# The following operations are related to `CreateBucket`:
|
|
2551
2556
|
#
|
|
2552
|
-
# * [PutObject][
|
|
2557
|
+
# * [PutObject][13]
|
|
2553
2558
|
#
|
|
2554
|
-
# * [DeleteBucket][
|
|
2559
|
+
# * [DeleteBucket][14]
|
|
2555
2560
|
#
|
|
2556
2561
|
# You must URL encode any signed header values that contain spaces. For
|
|
2557
2562
|
# example, if your header value is `my file.txt`, containing two spaces
|
|
@@ -2561,17 +2566,18 @@ module Aws::S3
|
|
|
2561
2566
|
#
|
|
2562
2567
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
|
2563
2568
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html
|
|
2564
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2565
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2566
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2567
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2568
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2569
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2570
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2571
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2572
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2573
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2574
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
2569
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/gpbucketnamespaces.html
|
|
2570
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
|
2571
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
|
2572
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
|
2573
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
2574
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html
|
|
2575
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
|
2576
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
|
2577
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html
|
|
2578
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features
|
|
2579
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
|
2580
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
|
2575
2581
|
#
|
|
2576
2582
|
# @option params [String] :acl
|
|
2577
2583
|
# The canned ACL to apply to the bucket.
|
|
@@ -2688,6 +2694,34 @@ module Aws::S3
|
|
|
2688
2694
|
#
|
|
2689
2695
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
2690
2696
|
#
|
|
2697
|
+
# @option params [String] :bucket_namespace
|
|
2698
|
+
# Specifies the namespace where you want to create your general purpose
|
|
2699
|
+
# bucket. When you create a general purpose bucket, you can choose to
|
|
2700
|
+
# create a bucket in the shared global namespace or you can choose to
|
|
2701
|
+
# create a bucket in your account regional namespace. Your account
|
|
2702
|
+
# regional namespace is a subdivision of the global namespace that only
|
|
2703
|
+
# your account can create buckets in. For more information on bucket
|
|
2704
|
+
# namespaces, see [Namespaces for general purpose buckets][1].
|
|
2705
|
+
#
|
|
2706
|
+
# General purpose buckets in your account regional namespace must follow
|
|
2707
|
+
# a specific naming convention. These buckets consist of a bucket name
|
|
2708
|
+
# prefix that you create, and a suffix that contains your 12-digit
|
|
2709
|
+
# Amazon Web Services Account ID, the Amazon Web Services Region code,
|
|
2710
|
+
# and ends with `-an`. Bucket names must follow the format
|
|
2711
|
+
# `bucket-name-prefix-accountId-region-an` (for example,
|
|
2712
|
+
# `amzn-s3-demo-bucket-111122223333-us-west-2-an`). For information
|
|
2713
|
+
# about bucket naming restrictions, see [Account regional namespace
|
|
2714
|
+
# naming rules][2] in the *Amazon S3 User Guide*.
|
|
2715
|
+
#
|
|
2716
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
2717
|
+
#
|
|
2718
|
+
# </note>
|
|
2719
|
+
#
|
|
2720
|
+
#
|
|
2721
|
+
#
|
|
2722
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/gpbucketnamespaces.html
|
|
2723
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html#account-regional-naming-rules
|
|
2724
|
+
#
|
|
2691
2725
|
# @return [Types::CreateBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2692
2726
|
#
|
|
2693
2727
|
# * {Types::CreateBucketOutput#location #location} => String
|
|
@@ -2752,6 +2786,7 @@ module Aws::S3
|
|
|
2752
2786
|
# grant_write_acp: "GrantWriteACP",
|
|
2753
2787
|
# object_lock_enabled_for_bucket: false,
|
|
2754
2788
|
# object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
|
|
2789
|
+
# bucket_namespace: "account-regional", # accepts account-regional, global
|
|
2755
2790
|
# })
|
|
2756
2791
|
#
|
|
2757
2792
|
# @example Response structure
|
|
@@ -3822,10 +3857,10 @@ module Aws::S3
|
|
|
3822
3857
|
# Confirms that the requester knows that they will be charged for the
|
|
3823
3858
|
# request. Bucket owners need not specify this parameter in their
|
|
3824
3859
|
# requests. If either the source or destination S3 bucket has Requester
|
|
3825
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
3826
|
-
#
|
|
3827
|
-
#
|
|
3828
|
-
#
|
|
3860
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
3861
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
3862
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
3863
|
+
# S3 User Guide*.
|
|
3829
3864
|
#
|
|
3830
3865
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
3831
3866
|
#
|
|
@@ -3943,7 +3978,7 @@ module Aws::S3
|
|
|
3943
3978
|
# "MetadataKey" => "MetadataValue",
|
|
3944
3979
|
# },
|
|
3945
3980
|
# server_side_encryption: "AES256", # accepts AES256, aws:fsx, aws:kms, aws:kms:dsse
|
|
3946
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
3981
|
+
# 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
|
|
3947
3982
|
# website_redirect_location: "WebsiteRedirectLocation",
|
|
3948
3983
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
|
3949
3984
|
# sse_customer_key: "SSECustomerKey",
|
|
@@ -4158,12 +4193,17 @@ module Aws::S3
|
|
|
4158
4193
|
#
|
|
4159
4194
|
# @option params [String] :session_mode
|
|
4160
4195
|
# Specifies the mode of the session that will be created, either
|
|
4161
|
-
# `ReadWrite` or `ReadOnly`.
|
|
4162
|
-
#
|
|
4163
|
-
#
|
|
4164
|
-
#
|
|
4165
|
-
#
|
|
4166
|
-
# `
|
|
4196
|
+
# `ReadWrite` or `ReadOnly`. If no session mode is specified, the
|
|
4197
|
+
# default behavior attempts to create a session with the maximum
|
|
4198
|
+
# allowable privilege. It will first attempt to create a `ReadWrite`
|
|
4199
|
+
# session, and if that is not allowed by permissions, it will attempt to
|
|
4200
|
+
# create a `ReadOnly` session. If neither session type is allowed, the
|
|
4201
|
+
# request will return an Access Denied error. A `ReadWrite` session is
|
|
4202
|
+
# capable of executing all the Zonal endpoint API operations on a
|
|
4203
|
+
# directory bucket. A `ReadOnly` session is constrained to execute the
|
|
4204
|
+
# following Zonal endpoint API operations: `GetObject`, `HeadObject`,
|
|
4205
|
+
# `ListObjectsV2`, `GetObjectAttributes`, `ListParts`, and
|
|
4206
|
+
# `ListMultipartUploads`.
|
|
4167
4207
|
#
|
|
4168
4208
|
# @option params [required, String] :bucket
|
|
4169
4209
|
# The name of the bucket that you create a session for.
|
|
@@ -5410,10 +5450,6 @@ module Aws::S3
|
|
|
5410
5450
|
# for a general purpose bucket][1], you can no longer use this operation
|
|
5411
5451
|
# for that bucket and must use [UntagResource][2] instead.
|
|
5412
5452
|
#
|
|
5413
|
-
# if ABAC is not enabled for the bucket. When you [enable ABAC for a
|
|
5414
|
-
# general purpose bucket][1], you can no longer use this operation for
|
|
5415
|
-
# that bucket and must use [UntagResource][2] instead.
|
|
5416
|
-
#
|
|
5417
5453
|
# To use this operation, you must have permission to perform the
|
|
5418
5454
|
# `s3:PutBucketTagging` action. By default, the bucket owner has this
|
|
5419
5455
|
# permission and can grant this permission to others.
|
|
@@ -5746,10 +5782,10 @@ module Aws::S3
|
|
|
5746
5782
|
# Confirms that the requester knows that they will be charged for the
|
|
5747
5783
|
# request. Bucket owners need not specify this parameter in their
|
|
5748
5784
|
# requests. If either the source or destination S3 bucket has Requester
|
|
5749
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
5750
|
-
#
|
|
5751
|
-
#
|
|
5752
|
-
#
|
|
5785
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
5786
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
5787
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
5788
|
+
# S3 User Guide*.
|
|
5753
5789
|
#
|
|
5754
5790
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
5755
5791
|
#
|
|
@@ -6208,10 +6244,10 @@ module Aws::S3
|
|
|
6208
6244
|
# Confirms that the requester knows that they will be charged for the
|
|
6209
6245
|
# request. Bucket owners need not specify this parameter in their
|
|
6210
6246
|
# requests. If either the source or destination S3 bucket has Requester
|
|
6211
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
6212
|
-
#
|
|
6213
|
-
#
|
|
6214
|
-
#
|
|
6247
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
6248
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
6249
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
6250
|
+
# S3 User Guide*.
|
|
6215
6251
|
#
|
|
6216
6252
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
6217
6253
|
#
|
|
@@ -6401,7 +6437,10 @@ module Aws::S3
|
|
|
6401
6437
|
# </note>
|
|
6402
6438
|
#
|
|
6403
6439
|
# Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket.
|
|
6404
|
-
#
|
|
6440
|
+
# This operation removes the bucket-level configuration only. The
|
|
6441
|
+
# effective public access behavior will still be governed by
|
|
6442
|
+
# account-level settings (which may inherit from organization-level
|
|
6443
|
+
# policies). To use this operation, you must have the
|
|
6405
6444
|
# `s3:PutBucketPublicAccessBlock` permission. For more information about
|
|
6406
6445
|
# permissions, see [Permissions Related to Bucket Subresource
|
|
6407
6446
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
|
@@ -6458,16 +6497,13 @@ module Aws::S3
|
|
|
6458
6497
|
end
|
|
6459
6498
|
|
|
6460
6499
|
# Returns the attribute-based access control (ABAC) property of the
|
|
6461
|
-
# general purpose bucket. If
|
|
6462
|
-
# tags
|
|
6463
|
-
# ABAC in general purpose buckets][1].
|
|
6464
|
-
# disabled, you can use tags for cost tracking. For more information,
|
|
6465
|
-
# see [Using tags with S3 general purpose buckets][2].
|
|
6500
|
+
# general purpose bucket. If ABAC is enabled on your bucket, you can use
|
|
6501
|
+
# tags on the bucket for access control. For more information, see
|
|
6502
|
+
# [Enabling ABAC in general purpose buckets][1].
|
|
6466
6503
|
#
|
|
6467
6504
|
#
|
|
6468
6505
|
#
|
|
6469
6506
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html
|
|
6470
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html
|
|
6471
6507
|
#
|
|
6472
6508
|
# @option params [required, String] :bucket
|
|
6473
6509
|
# The name of the general purpose bucket.
|
|
@@ -6560,10 +6596,10 @@ module Aws::S3
|
|
|
6560
6596
|
# Confirms that the requester knows that they will be charged for the
|
|
6561
6597
|
# request. Bucket owners need not specify this parameter in their
|
|
6562
6598
|
# requests. If either the source or destination S3 bucket has Requester
|
|
6563
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
6564
|
-
#
|
|
6565
|
-
#
|
|
6566
|
-
#
|
|
6599
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
6600
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
6601
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
6602
|
+
# S3 User Guide*.
|
|
6567
6603
|
#
|
|
6568
6604
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
6569
6605
|
#
|
|
@@ -6600,19 +6636,6 @@ module Aws::S3
|
|
|
6600
6636
|
req.send_request(options)
|
|
6601
6637
|
end
|
|
6602
6638
|
|
|
6603
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
6604
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
6605
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
6606
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
6607
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
6608
|
-
#
|
|
6609
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
6610
|
-
# East
|
|
6611
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
6612
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
6613
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
6614
|
-
# America (São Paulo) Region.
|
|
6615
|
-
#
|
|
6616
6639
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
6617
6640
|
#
|
|
6618
6641
|
# </note>
|
|
@@ -6982,8 +7005,8 @@ module Aws::S3
|
|
|
6982
7005
|
#
|
|
6983
7006
|
#
|
|
6984
7007
|
#
|
|
6985
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
6986
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
7008
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ServerSideEncryptionRule.html#AmazonS3-Type-ServerSideEncryptionRule-BucketKeyEnabled
|
|
7009
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ServerSideEncryptionRule.html#AmazonS3-Type-ServerSideEncryptionRule-BlockedEncryptionTypes
|
|
6987
7010
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html
|
|
6988
7011
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-bucket-encryption.html
|
|
6989
7012
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
|
@@ -7220,7 +7243,7 @@ module Aws::S3
|
|
|
7220
7243
|
# resp.inventory_configuration.id #=> String
|
|
7221
7244
|
# resp.inventory_configuration.included_object_versions #=> String, one of "All", "Current"
|
|
7222
7245
|
# resp.inventory_configuration.optional_fields #=> Array
|
|
7223
|
-
# resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner"
|
|
7246
|
+
# resp.inventory_configuration.optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner", "LifecycleExpirationDate"
|
|
7224
7247
|
# resp.inventory_configuration.schedule.frequency #=> String, one of "Daily", "Weekly"
|
|
7225
7248
|
#
|
|
7226
7249
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration AWS API Documentation
|
|
@@ -7655,19 +7678,6 @@ module Aws::S3
|
|
|
7655
7678
|
req.send_request(options)
|
|
7656
7679
|
end
|
|
7657
7680
|
|
|
7658
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
7659
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
7660
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
7661
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
7662
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
7663
|
-
#
|
|
7664
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
7665
|
-
# East
|
|
7666
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
7667
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
7668
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
7669
|
-
# America (São Paulo) Region.
|
|
7670
|
-
#
|
|
7671
7681
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
7672
7682
|
#
|
|
7673
7683
|
# </note>
|
|
@@ -8682,7 +8692,7 @@ module Aws::S3
|
|
|
8682
8692
|
# resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled"
|
|
8683
8693
|
# resp.replication_configuration.rules[0].destination.bucket #=> String
|
|
8684
8694
|
# resp.replication_configuration.rules[0].destination.account #=> String
|
|
8685
|
-
# resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
8695
|
+
# resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
8686
8696
|
# resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination"
|
|
8687
8697
|
# resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String
|
|
8688
8698
|
# resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled"
|
|
@@ -8776,10 +8786,6 @@ module Aws::S3
|
|
|
8776
8786
|
#
|
|
8777
8787
|
# Returns the tag set associated with the general purpose bucket.
|
|
8778
8788
|
#
|
|
8779
|
-
# if ABAC is not enabled for the bucket. When you [enable ABAC for a
|
|
8780
|
-
# general purpose bucket][1], you can no longer use this operation for
|
|
8781
|
-
# that bucket and must use [ListTagsForResource][2] instead.
|
|
8782
|
-
#
|
|
8783
8789
|
# To use this operation, you must have permission to perform the
|
|
8784
8790
|
# `s3:GetBucketTagging` action. By default, the bucket owner has this
|
|
8785
8791
|
# permission and can grant this permission to others.
|
|
@@ -8794,9 +8800,9 @@ module Aws::S3
|
|
|
8794
8800
|
#
|
|
8795
8801
|
# The following operations are related to `GetBucketTagging`:
|
|
8796
8802
|
#
|
|
8797
|
-
# * [PutBucketTagging][
|
|
8803
|
+
# * [PutBucketTagging][1]
|
|
8798
8804
|
#
|
|
8799
|
-
# * [DeleteBucketTagging][
|
|
8805
|
+
# * [DeleteBucketTagging][2]
|
|
8800
8806
|
#
|
|
8801
8807
|
# You must URL encode any signed header values that contain spaces. For
|
|
8802
8808
|
# example, if your header value is `my file.txt`, containing two spaces
|
|
@@ -8804,10 +8810,8 @@ module Aws::S3
|
|
|
8804
8810
|
#
|
|
8805
8811
|
#
|
|
8806
8812
|
#
|
|
8807
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
8808
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
8809
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
|
8810
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
|
8813
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
|
8814
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
|
8811
8815
|
#
|
|
8812
8816
|
# @option params [required, String] :bucket
|
|
8813
8817
|
# The name of the bucket for which to get the tagging information.
|
|
@@ -9492,10 +9496,10 @@ module Aws::S3
|
|
|
9492
9496
|
# Confirms that the requester knows that they will be charged for the
|
|
9493
9497
|
# request. Bucket owners need not specify this parameter in their
|
|
9494
9498
|
# requests. If either the source or destination S3 bucket has Requester
|
|
9495
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
9496
|
-
#
|
|
9497
|
-
#
|
|
9498
|
-
#
|
|
9499
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
9500
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
9501
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
9502
|
+
# S3 User Guide*.
|
|
9499
9503
|
#
|
|
9500
9504
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
9501
9505
|
#
|
|
@@ -9697,7 +9701,7 @@ module Aws::S3
|
|
|
9697
9701
|
# resp.sse_customer_key_md5 #=> String
|
|
9698
9702
|
# resp.ssekms_key_id #=> String
|
|
9699
9703
|
# resp.bucket_key_enabled #=> Boolean
|
|
9700
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
9704
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
9701
9705
|
# resp.request_charged #=> String, one of "requester"
|
|
9702
9706
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED"
|
|
9703
9707
|
# resp.parts_count #=> Integer
|
|
@@ -9715,19 +9719,6 @@ module Aws::S3
|
|
|
9715
9719
|
req.send_request(options, &block)
|
|
9716
9720
|
end
|
|
9717
9721
|
|
|
9718
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
9719
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
9720
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
9721
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
9722
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
9723
|
-
#
|
|
9724
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
9725
|
-
# East
|
|
9726
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
9727
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
9728
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
9729
|
-
# America (São Paulo) Region.
|
|
9730
|
-
#
|
|
9731
9722
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
9732
9723
|
#
|
|
9733
9724
|
# </note>
|
|
@@ -9810,10 +9801,10 @@ module Aws::S3
|
|
|
9810
9801
|
# Confirms that the requester knows that they will be charged for the
|
|
9811
9802
|
# request. Bucket owners need not specify this parameter in their
|
|
9812
9803
|
# requests. If either the source or destination S3 bucket has Requester
|
|
9813
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
9814
|
-
#
|
|
9815
|
-
#
|
|
9816
|
-
#
|
|
9804
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
9805
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
9806
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
9807
|
+
# S3 User Guide*.
|
|
9817
9808
|
#
|
|
9818
9809
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
9819
9810
|
#
|
|
@@ -10221,10 +10212,10 @@ module Aws::S3
|
|
|
10221
10212
|
# Confirms that the requester knows that they will be charged for the
|
|
10222
10213
|
# request. Bucket owners need not specify this parameter in their
|
|
10223
10214
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10224
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10225
|
-
#
|
|
10226
|
-
#
|
|
10227
|
-
#
|
|
10215
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
10216
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
10217
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
10218
|
+
# S3 User Guide*.
|
|
10228
10219
|
#
|
|
10229
10220
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10230
10221
|
#
|
|
@@ -10297,7 +10288,7 @@ module Aws::S3
|
|
|
10297
10288
|
# resp.object_parts.parts[0].checksum_crc64nvme #=> String
|
|
10298
10289
|
# resp.object_parts.parts[0].checksum_sha1 #=> String
|
|
10299
10290
|
# resp.object_parts.parts[0].checksum_sha256 #=> String
|
|
10300
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
10291
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
10301
10292
|
# resp.object_size #=> Integer
|
|
10302
10293
|
#
|
|
10303
10294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes AWS API Documentation
|
|
@@ -10366,10 +10357,10 @@ module Aws::S3
|
|
|
10366
10357
|
# Confirms that the requester knows that they will be charged for the
|
|
10367
10358
|
# request. Bucket owners need not specify this parameter in their
|
|
10368
10359
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10369
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10370
|
-
#
|
|
10371
|
-
#
|
|
10372
|
-
#
|
|
10360
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
10361
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
10362
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
10363
|
+
# S3 User Guide*.
|
|
10373
10364
|
#
|
|
10374
10365
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10375
10366
|
#
|
|
@@ -10544,10 +10535,10 @@ module Aws::S3
|
|
|
10544
10535
|
# Confirms that the requester knows that they will be charged for the
|
|
10545
10536
|
# request. Bucket owners need not specify this parameter in their
|
|
10546
10537
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10547
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10548
|
-
#
|
|
10549
|
-
#
|
|
10550
|
-
#
|
|
10538
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
10539
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
10540
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
10541
|
+
# S3 User Guide*.
|
|
10551
10542
|
#
|
|
10552
10543
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10553
10544
|
#
|
|
@@ -10675,10 +10666,10 @@ module Aws::S3
|
|
|
10675
10666
|
# Confirms that the requester knows that they will be charged for the
|
|
10676
10667
|
# request. Bucket owners need not specify this parameter in their
|
|
10677
10668
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10678
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10679
|
-
#
|
|
10680
|
-
#
|
|
10681
|
-
#
|
|
10669
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
10670
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
10671
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
10672
|
+
# S3 User Guide*.
|
|
10682
10673
|
#
|
|
10683
10674
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10684
10675
|
#
|
|
@@ -10810,10 +10801,10 @@ module Aws::S3
|
|
|
10810
10801
|
# Confirms that the requester knows that they will be charged for the
|
|
10811
10802
|
# request. Bucket owners need not specify this parameter in their
|
|
10812
10803
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10813
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10814
|
-
#
|
|
10815
|
-
#
|
|
10816
|
-
#
|
|
10804
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
10805
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
10806
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
10807
|
+
# S3 User Guide*.
|
|
10817
10808
|
#
|
|
10818
10809
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10819
10810
|
#
|
|
@@ -10875,17 +10866,21 @@ module Aws::S3
|
|
|
10875
10866
|
# </note>
|
|
10876
10867
|
#
|
|
10877
10868
|
# Retrieves the `PublicAccessBlock` configuration for an Amazon S3
|
|
10878
|
-
# bucket.
|
|
10869
|
+
# bucket. This operation returns the bucket-level configuration only. To
|
|
10870
|
+
# understand the effective public access behavior, you must also
|
|
10871
|
+
# consider account-level settings (which may inherit from
|
|
10872
|
+
# organization-level policies). To use this operation, you must have the
|
|
10879
10873
|
# `s3:GetBucketPublicAccessBlock` permission. For more information about
|
|
10880
10874
|
# Amazon S3 permissions, see [Specifying Permissions in a Policy][1].
|
|
10881
10875
|
#
|
|
10882
10876
|
# When Amazon S3 evaluates the `PublicAccessBlock` configuration for a
|
|
10883
10877
|
# bucket or an object, it checks the `PublicAccessBlock` configuration
|
|
10884
10878
|
# for both the bucket (or the bucket that contains the object) and the
|
|
10885
|
-
# bucket owner's account.
|
|
10886
|
-
#
|
|
10887
|
-
#
|
|
10888
|
-
#
|
|
10879
|
+
# bucket owner's account. Account-level settings automatically inherit
|
|
10880
|
+
# from organization-level policies when present. If the
|
|
10881
|
+
# `PublicAccessBlock` settings are different between the bucket and the
|
|
10882
|
+
# account, Amazon S3 uses the most restrictive combination of the
|
|
10883
|
+
# bucket-level and account-level settings.
|
|
10889
10884
|
#
|
|
10890
10885
|
# For more information about when Amazon S3 considers a bucket or an
|
|
10891
10886
|
# object public, see [The Meaning of "Public"][2].
|
|
@@ -10997,10 +10992,12 @@ module Aws::S3
|
|
|
10997
10992
|
#
|
|
10998
10993
|
# * **Directory bucket permissions** - You must have the <b>
|
|
10999
10994
|
# <code>s3express:CreateSession</code> </b> permission in the
|
|
11000
|
-
# `Action` element of a policy.
|
|
11001
|
-
#
|
|
11002
|
-
#
|
|
11003
|
-
#
|
|
10995
|
+
# `Action` element of a policy. If no session mode is specified, the
|
|
10996
|
+
# session will be created with the maximum allowable privilege,
|
|
10997
|
+
# attempting `ReadWrite` first, then `ReadOnly` if `ReadWrite` is
|
|
10998
|
+
# not permitted. If you want to explicitly restrict the access to be
|
|
10999
|
+
# read-only, you can set the `s3express:SessionMode` condition key
|
|
11000
|
+
# to `ReadOnly` on the bucket.
|
|
11004
11001
|
#
|
|
11005
11002
|
# For more information about example bucket policies, see [Example
|
|
11006
11003
|
# bucket policies for S3 Express One Zone][3] and [Amazon Web
|
|
@@ -11493,10 +11490,10 @@ module Aws::S3
|
|
|
11493
11490
|
# Confirms that the requester knows that they will be charged for the
|
|
11494
11491
|
# request. Bucket owners need not specify this parameter in their
|
|
11495
11492
|
# requests. If either the source or destination S3 bucket has Requester
|
|
11496
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
11497
|
-
#
|
|
11498
|
-
#
|
|
11499
|
-
#
|
|
11493
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
11494
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
11495
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
11496
|
+
# S3 User Guide*.
|
|
11500
11497
|
#
|
|
11501
11498
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
11502
11499
|
#
|
|
@@ -11659,7 +11656,7 @@ module Aws::S3
|
|
|
11659
11656
|
# resp.sse_customer_key_md5 #=> String
|
|
11660
11657
|
# resp.ssekms_key_id #=> String
|
|
11661
11658
|
# resp.bucket_key_enabled #=> Boolean
|
|
11662
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
11659
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
11663
11660
|
# resp.request_charged #=> String, one of "requester"
|
|
11664
11661
|
# resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED"
|
|
11665
11662
|
# resp.parts_count #=> Integer
|
|
@@ -11982,7 +11979,7 @@ module Aws::S3
|
|
|
11982
11979
|
# resp.inventory_configuration_list[0].id #=> String
|
|
11983
11980
|
# resp.inventory_configuration_list[0].included_object_versions #=> String, one of "All", "Current"
|
|
11984
11981
|
# resp.inventory_configuration_list[0].optional_fields #=> Array
|
|
11985
|
-
# resp.inventory_configuration_list[0].optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner"
|
|
11982
|
+
# resp.inventory_configuration_list[0].optional_fields[0] #=> String, one of "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus", "EncryptionStatus", "ObjectLockRetainUntilDate", "ObjectLockMode", "ObjectLockLegalHoldStatus", "IntelligentTieringAccessTier", "BucketKeyStatus", "ChecksumAlgorithm", "ObjectAccessControlList", "ObjectOwner", "LifecycleExpirationDate"
|
|
11986
11983
|
# resp.inventory_configuration_list[0].schedule.frequency #=> String, one of "Daily", "Weekly"
|
|
11987
11984
|
# resp.is_truncated #=> Boolean
|
|
11988
11985
|
# resp.next_continuation_token #=> String
|
|
@@ -12102,19 +12099,6 @@ module Aws::S3
|
|
|
12102
12099
|
req.send_request(options)
|
|
12103
12100
|
end
|
|
12104
12101
|
|
|
12105
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
12106
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
12107
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
12108
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
12109
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
12110
|
-
#
|
|
12111
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
12112
|
-
# East
|
|
12113
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
12114
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
12115
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
12116
|
-
# America (São Paulo) Region.
|
|
12117
|
-
#
|
|
12118
12102
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
12119
12103
|
#
|
|
12120
12104
|
# </note>
|
|
@@ -12351,19 +12335,6 @@ module Aws::S3
|
|
|
12351
12335
|
req.send_request(options)
|
|
12352
12336
|
end
|
|
12353
12337
|
|
|
12354
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
12355
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
12356
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
12357
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
12358
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
12359
|
-
#
|
|
12360
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
12361
|
-
# East
|
|
12362
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
12363
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
12364
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
12365
|
-
# America (São Paulo) Region.
|
|
12366
|
-
#
|
|
12367
12338
|
# This operation lists in-progress multipart uploads in a bucket. An
|
|
12368
12339
|
# in-progress multipart upload is a multipart upload that has been
|
|
12369
12340
|
# initiated by the `CreateMultipartUpload` request, but has not yet been
|
|
@@ -12640,10 +12611,10 @@ module Aws::S3
|
|
|
12640
12611
|
# Confirms that the requester knows that they will be charged for the
|
|
12641
12612
|
# request. Bucket owners need not specify this parameter in their
|
|
12642
12613
|
# requests. If either the source or destination S3 bucket has Requester
|
|
12643
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
12644
|
-
#
|
|
12645
|
-
#
|
|
12646
|
-
#
|
|
12614
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
12615
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
12616
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
12617
|
+
# S3 User Guide*.
|
|
12647
12618
|
#
|
|
12648
12619
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
12649
12620
|
#
|
|
@@ -12796,7 +12767,7 @@ module Aws::S3
|
|
|
12796
12767
|
# resp.uploads[0].upload_id #=> String
|
|
12797
12768
|
# resp.uploads[0].key #=> String
|
|
12798
12769
|
# resp.uploads[0].initiated #=> Time
|
|
12799
|
-
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
12770
|
+
# resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
12800
12771
|
# resp.uploads[0].owner.display_name #=> String
|
|
12801
12772
|
# resp.uploads[0].owner.id #=> String
|
|
12802
12773
|
# resp.uploads[0].initiator.id #=> String
|
|
@@ -12817,19 +12788,6 @@ module Aws::S3
|
|
|
12817
12788
|
req.send_request(options)
|
|
12818
12789
|
end
|
|
12819
12790
|
|
|
12820
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
12821
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
12822
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
12823
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
12824
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
12825
|
-
#
|
|
12826
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
12827
|
-
# East
|
|
12828
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
12829
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
12830
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
12831
|
-
# America (São Paulo) Region.
|
|
12832
|
-
#
|
|
12833
12791
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
12834
12792
|
#
|
|
12835
12793
|
# </note>
|
|
@@ -12937,10 +12895,10 @@ module Aws::S3
|
|
|
12937
12895
|
# Confirms that the requester knows that they will be charged for the
|
|
12938
12896
|
# request. Bucket owners need not specify this parameter in their
|
|
12939
12897
|
# requests. If either the source or destination S3 bucket has Requester
|
|
12940
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
12941
|
-
#
|
|
12942
|
-
#
|
|
12943
|
-
#
|
|
12898
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
12899
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
12900
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
12901
|
+
# S3 User Guide*.
|
|
12944
12902
|
#
|
|
12945
12903
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
12946
12904
|
#
|
|
@@ -13077,19 +13035,6 @@ module Aws::S3
|
|
|
13077
13035
|
req.send_request(options)
|
|
13078
13036
|
end
|
|
13079
13037
|
|
|
13080
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
13081
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
13082
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
13083
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
13084
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
13085
|
-
#
|
|
13086
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
13087
|
-
# East
|
|
13088
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
13089
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
13090
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
13091
|
-
# America (São Paulo) Region.
|
|
13092
|
-
#
|
|
13093
13038
|
# <note markdown="1"> This operation is not supported for directory buckets.
|
|
13094
13039
|
#
|
|
13095
13040
|
# </note>
|
|
@@ -13310,7 +13255,7 @@ module Aws::S3
|
|
|
13310
13255
|
# resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256", "CRC64NVME"
|
|
13311
13256
|
# resp.contents[0].checksum_type #=> String, one of "COMPOSITE", "FULL_OBJECT"
|
|
13312
13257
|
# resp.contents[0].size #=> Integer
|
|
13313
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
13258
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
13314
13259
|
# resp.contents[0].owner.display_name #=> String
|
|
13315
13260
|
# resp.contents[0].owner.id #=> String
|
|
13316
13261
|
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
|
@@ -13333,19 +13278,6 @@ module Aws::S3
|
|
|
13333
13278
|
req.send_request(options)
|
|
13334
13279
|
end
|
|
13335
13280
|
|
|
13336
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
13337
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
13338
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
13339
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
13340
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
13341
|
-
#
|
|
13342
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
13343
|
-
# East
|
|
13344
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
13345
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
13346
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
13347
|
-
# America (São Paulo) Region.
|
|
13348
|
-
#
|
|
13349
13281
|
# Returns some or all (up to 1,000) of the objects in a bucket with each
|
|
13350
13282
|
# request. You can use the request parameters as selection criteria to
|
|
13351
13283
|
# return a subset of the objects in a bucket. A `200 OK` response can
|
|
@@ -13673,7 +13605,7 @@ module Aws::S3
|
|
|
13673
13605
|
# resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256", "CRC64NVME"
|
|
13674
13606
|
# resp.contents[0].checksum_type #=> String, one of "COMPOSITE", "FULL_OBJECT"
|
|
13675
13607
|
# resp.contents[0].size #=> Integer
|
|
13676
|
-
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
13608
|
+
# resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
13677
13609
|
# resp.contents[0].owner.display_name #=> String
|
|
13678
13610
|
# resp.contents[0].owner.id #=> String
|
|
13679
13611
|
# resp.contents[0].restore_status.is_restore_in_progress #=> Boolean
|
|
@@ -13700,19 +13632,6 @@ module Aws::S3
|
|
|
13700
13632
|
req.send_request(options)
|
|
13701
13633
|
end
|
|
13702
13634
|
|
|
13703
|
-
# End of support notice: Beginning November 21, 2025, Amazon S3 will
|
|
13704
|
-
# stop returning `DisplayName`. Update your applications to use
|
|
13705
|
-
# canonical IDs (unique identifier for Amazon Web Services accounts),
|
|
13706
|
-
# Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full
|
|
13707
|
-
# resource naming) as a direct replacement of `DisplayName`.
|
|
13708
|
-
#
|
|
13709
|
-
# This change affects the following Amazon Web Services Regions: US
|
|
13710
|
-
# East
|
|
13711
|
-
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
|
13712
|
-
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
|
13713
|
-
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
|
13714
|
-
# America (São Paulo) Region.
|
|
13715
|
-
#
|
|
13716
13635
|
# Lists the parts that have been uploaded for a specific multipart
|
|
13717
13636
|
# upload.
|
|
13718
13637
|
#
|
|
@@ -13873,10 +13792,10 @@ module Aws::S3
|
|
|
13873
13792
|
# Confirms that the requester knows that they will be charged for the
|
|
13874
13793
|
# request. Bucket owners need not specify this parameter in their
|
|
13875
13794
|
# requests. If either the source or destination S3 bucket has Requester
|
|
13876
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
13877
|
-
#
|
|
13878
|
-
#
|
|
13879
|
-
#
|
|
13795
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
13796
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
13797
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
13798
|
+
# S3 User Guide*.
|
|
13880
13799
|
#
|
|
13881
13800
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
13882
13801
|
#
|
|
@@ -14032,7 +13951,7 @@ module Aws::S3
|
|
|
14032
13951
|
# resp.initiator.display_name #=> String
|
|
14033
13952
|
# resp.owner.display_name #=> String
|
|
14034
13953
|
# resp.owner.id #=> String
|
|
14035
|
-
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS"
|
|
13954
|
+
# resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE", "FSX_OPENZFS", "FSX_ONTAP"
|
|
14036
13955
|
# resp.request_charged #=> String, one of "requester"
|
|
14037
13956
|
# resp.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256", "CRC64NVME"
|
|
14038
13957
|
# resp.checksum_type #=> String, one of "COMPOSITE", "FULL_OBJECT"
|
|
@@ -14047,23 +13966,21 @@ module Aws::S3
|
|
|
14047
13966
|
end
|
|
14048
13967
|
|
|
14049
13968
|
# Sets the attribute-based access control (ABAC) property of the general
|
|
14050
|
-
# purpose bucket.
|
|
14051
|
-
#
|
|
14052
|
-
#
|
|
14053
|
-
# actions to manage
|
|
14054
|
-
# [PutBucketTagging][
|
|
14055
|
-
#
|
|
14056
|
-
#
|
|
14057
|
-
# buckets][6].
|
|
13969
|
+
# purpose bucket. You must have `s3:PutBucketABAC` permission to perform
|
|
13970
|
+
# this action. When you enable ABAC, you can use tags for access control
|
|
13971
|
+
# on your buckets. Additionally, when ABAC is enabled, you must use the
|
|
13972
|
+
# [TagResource][1] and [UntagResource][2] actions to manage tags on your
|
|
13973
|
+
# buckets. You can nolonger use the [PutBucketTagging][3] and
|
|
13974
|
+
# [DeleteBucketTagging][4] actions to tag your bucket. For more
|
|
13975
|
+
# information, see [Enabling ABAC in general purpose buckets][5].
|
|
14058
13976
|
#
|
|
14059
13977
|
#
|
|
14060
13978
|
#
|
|
14061
13979
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_TagResource.html
|
|
14062
13980
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UntagResource.html
|
|
14063
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
14064
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
14065
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
14066
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html
|
|
13981
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
|
13982
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html
|
|
13983
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging-enable-abac.html
|
|
14067
13984
|
#
|
|
14068
13985
|
# @option params [required, String] :bucket
|
|
14069
13986
|
# The name of the general purpose bucket.
|
|
@@ -15381,7 +15298,7 @@ module Aws::S3
|
|
|
15381
15298
|
# },
|
|
15382
15299
|
# id: "InventoryId", # required
|
|
15383
15300
|
# included_object_versions: "All", # required, accepts All, Current
|
|
15384
|
-
# optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus, ChecksumAlgorithm, ObjectAccessControlList, ObjectOwner
|
|
15301
|
+
# optional_fields: ["Size"], # accepts Size, LastModifiedDate, StorageClass, ETag, IsMultipartUploaded, ReplicationStatus, EncryptionStatus, ObjectLockRetainUntilDate, ObjectLockMode, ObjectLockLegalHoldStatus, IntelligentTieringAccessTier, BucketKeyStatus, ChecksumAlgorithm, ObjectAccessControlList, ObjectOwner, LifecycleExpirationDate
|
|
15385
15302
|
# schedule: { # required
|
|
15386
15303
|
# frequency: "Daily", # required, accepts Daily, Weekly
|
|
15387
15304
|
# },
|
|
@@ -15575,8 +15492,6 @@ module Aws::S3
|
|
|
15575
15492
|
# </note>
|
|
15576
15493
|
#
|
|
15577
15494
|
# Rules
|
|
15578
|
-
# Permissions
|
|
15579
|
-
# HTTP Host header syntax
|
|
15580
15495
|
#
|
|
15581
15496
|
# : You specify the lifecycle configuration in your request body. The
|
|
15582
15497
|
# lifecycle configuration is specified as XML consisting of one or
|
|
@@ -15615,6 +15530,8 @@ module Aws::S3
|
|
|
15615
15530
|
#
|
|
15616
15531
|
# For more information, see [Object Lifecycle Management][3] and
|
|
15617
15532
|
# [Lifecycle Configuration Elements][4].
|
|
15533
|
+
#
|
|
15534
|
+
# Permissions
|
|
15618
15535
|
# : * **General purpose bucket permissions** - By default, all Amazon S3
|
|
15619
15536
|
# resources are private, including buckets, objects, and related
|
|
15620
15537
|
# subresources (for example, lifecycle configuration and website
|
|
@@ -15664,6 +15581,8 @@ module Aws::S3
|
|
|
15664
15581
|
#
|
|
15665
15582
|
# </note>
|
|
15666
15583
|
#
|
|
15584
|
+
# HTTP Host header syntax
|
|
15585
|
+
#
|
|
15667
15586
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
|
15668
15587
|
# `s3express-control.region.amazonaws.com`.
|
|
15669
15588
|
#
|
|
@@ -16944,7 +16863,7 @@ module Aws::S3
|
|
|
16944
16863
|
# destination: { # required
|
|
16945
16864
|
# bucket: "BucketName", # required
|
|
16946
16865
|
# account: "AccountId",
|
|
16947
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
16866
|
+
# 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
|
|
16948
16867
|
# access_control_translation: {
|
|
16949
16868
|
# owner: "Destination", # required, accepts Destination
|
|
16950
16869
|
# },
|
|
@@ -17094,10 +17013,6 @@ module Aws::S3
|
|
|
17094
17013
|
# for that bucket and must use the [TagResource][2] or
|
|
17095
17014
|
# [UntagResource][3] operations instead.
|
|
17096
17015
|
#
|
|
17097
|
-
# if ABAC is not enabled for the bucket. When you [enable ABAC for a
|
|
17098
|
-
# general purpose bucket][1], you can no longer use this operation for
|
|
17099
|
-
# that bucket and must use [TagResource][2] instead.
|
|
17100
|
-
#
|
|
17101
17016
|
# Use tags to organize your Amazon Web Services bill to reflect your own
|
|
17102
17017
|
# cost structure. To do this, sign up to get your Amazon Web Services
|
|
17103
17018
|
# account bill with tag key values included. Then, to see the cost of
|
|
@@ -17728,6 +17643,20 @@ module Aws::S3
|
|
|
17728
17643
|
#
|
|
17729
17644
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
|
17730
17645
|
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
|
17646
|
+
# ^
|
|
17647
|
+
#
|
|
17648
|
+
# Errors
|
|
17649
|
+
# : * You might receive an `InvalidRequest` error for several reasons.
|
|
17650
|
+
# Depending on the reason for the error, you might receive one of
|
|
17651
|
+
# the following messages:
|
|
17652
|
+
#
|
|
17653
|
+
# * Cannot specify both a write offset value and user-defined object
|
|
17654
|
+
# metadata for existing objects.
|
|
17655
|
+
#
|
|
17656
|
+
# * Checksum Type mismatch occurred, expected checksum Type: sha1,
|
|
17657
|
+
# actual checksum Type: crc32c.
|
|
17658
|
+
#
|
|
17659
|
+
# * Request body cannot be empty when 'write offset' is specified.
|
|
17731
17660
|
#
|
|
17732
17661
|
# For more information about related Amazon S3 APIs, see the following:
|
|
17733
17662
|
#
|
|
@@ -17790,7 +17719,7 @@ module Aws::S3
|
|
|
17790
17719
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
|
17791
17720
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
17792
17721
|
#
|
|
17793
|
-
# @option params [String,
|
|
17722
|
+
# @option params [String, IO] :body
|
|
17794
17723
|
# Object data.
|
|
17795
17724
|
#
|
|
17796
17725
|
# @option params [required, String] :bucket
|
|
@@ -18351,10 +18280,10 @@ module Aws::S3
|
|
|
18351
18280
|
# Confirms that the requester knows that they will be charged for the
|
|
18352
18281
|
# request. Bucket owners need not specify this parameter in their
|
|
18353
18282
|
# requests. If either the source or destination S3 bucket has Requester
|
|
18354
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
18355
|
-
#
|
|
18356
|
-
#
|
|
18357
|
-
#
|
|
18283
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
18284
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
18285
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
18286
|
+
# S3 User Guide*.
|
|
18358
18287
|
#
|
|
18359
18288
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
18360
18289
|
#
|
|
@@ -18594,7 +18523,7 @@ module Aws::S3
|
|
|
18594
18523
|
# "MetadataKey" => "MetadataValue",
|
|
18595
18524
|
# },
|
|
18596
18525
|
# server_side_encryption: "AES256", # accepts AES256, aws:fsx, aws:kms, aws:kms:dsse
|
|
18597
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
18526
|
+
# 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
|
|
18598
18527
|
# website_redirect_location: "WebsiteRedirectLocation",
|
|
18599
18528
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
|
18600
18529
|
# sse_customer_key: "SSECustomerKey",
|
|
@@ -18933,10 +18862,10 @@ module Aws::S3
|
|
|
18933
18862
|
# Confirms that the requester knows that they will be charged for the
|
|
18934
18863
|
# request. Bucket owners need not specify this parameter in their
|
|
18935
18864
|
# requests. If either the source or destination S3 bucket has Requester
|
|
18936
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
18937
|
-
#
|
|
18938
|
-
#
|
|
18939
|
-
#
|
|
18865
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
18866
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
18867
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
18868
|
+
# S3 User Guide*.
|
|
18940
18869
|
#
|
|
18941
18870
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
18942
18871
|
#
|
|
@@ -19079,10 +19008,10 @@ module Aws::S3
|
|
|
19079
19008
|
# Confirms that the requester knows that they will be charged for the
|
|
19080
19009
|
# request. Bucket owners need not specify this parameter in their
|
|
19081
19010
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19082
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19083
|
-
#
|
|
19084
|
-
#
|
|
19085
|
-
#
|
|
19011
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
19012
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
19013
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
19014
|
+
# S3 User Guide*.
|
|
19086
19015
|
#
|
|
19087
19016
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19088
19017
|
#
|
|
@@ -19196,10 +19125,10 @@ module Aws::S3
|
|
|
19196
19125
|
# Confirms that the requester knows that they will be charged for the
|
|
19197
19126
|
# request. Bucket owners need not specify this parameter in their
|
|
19198
19127
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19199
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19200
|
-
#
|
|
19201
|
-
#
|
|
19202
|
-
#
|
|
19128
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
19129
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
19130
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
19131
|
+
# S3 User Guide*.
|
|
19203
19132
|
#
|
|
19204
19133
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19205
19134
|
#
|
|
@@ -19330,10 +19259,10 @@ module Aws::S3
|
|
|
19330
19259
|
# Confirms that the requester knows that they will be charged for the
|
|
19331
19260
|
# request. Bucket owners need not specify this parameter in their
|
|
19332
19261
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19333
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19334
|
-
#
|
|
19335
|
-
#
|
|
19336
|
-
#
|
|
19262
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
19263
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
19264
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
19265
|
+
# S3 User Guide*.
|
|
19337
19266
|
#
|
|
19338
19267
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19339
19268
|
#
|
|
@@ -19618,10 +19547,11 @@ module Aws::S3
|
|
|
19618
19547
|
# When Amazon S3 evaluates the `PublicAccessBlock` configuration for a
|
|
19619
19548
|
# bucket or an object, it checks the `PublicAccessBlock` configuration
|
|
19620
19549
|
# for both the bucket (or the bucket that contains the object) and the
|
|
19621
|
-
# bucket owner's account.
|
|
19622
|
-
#
|
|
19623
|
-
#
|
|
19624
|
-
#
|
|
19550
|
+
# bucket owner's account. Account-level settings automatically inherit
|
|
19551
|
+
# from organization-level policies when present. If the
|
|
19552
|
+
# `PublicAccessBlock` configurations are different between the bucket
|
|
19553
|
+
# and the account, Amazon S3 uses the most restrictive combination of
|
|
19554
|
+
# the bucket-level and account-level settings.
|
|
19625
19555
|
#
|
|
19626
19556
|
# For more information about when Amazon S3 considers a bucket or an
|
|
19627
19557
|
# object public, see [The Meaning of "Public"][2].
|
|
@@ -20118,10 +20048,10 @@ module Aws::S3
|
|
|
20118
20048
|
# Confirms that the requester knows that they will be charged for the
|
|
20119
20049
|
# request. Bucket owners need not specify this parameter in their
|
|
20120
20050
|
# requests. If either the source or destination S3 bucket has Requester
|
|
20121
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
20122
|
-
#
|
|
20123
|
-
#
|
|
20124
|
-
#
|
|
20051
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
20052
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
20053
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
20054
|
+
# S3 User Guide*.
|
|
20125
20055
|
#
|
|
20126
20056
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
20127
20057
|
#
|
|
@@ -20260,7 +20190,7 @@ module Aws::S3
|
|
|
20260
20190
|
# value: "MetadataValue",
|
|
20261
20191
|
# },
|
|
20262
20192
|
# ],
|
|
20263
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
20193
|
+
# 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
|
|
20264
20194
|
# },
|
|
20265
20195
|
# },
|
|
20266
20196
|
# },
|
|
@@ -20892,6 +20822,260 @@ module Aws::S3
|
|
|
20892
20822
|
req.send_request(options)
|
|
20893
20823
|
end
|
|
20894
20824
|
|
|
20825
|
+
# <note markdown="1"> This operation is not supported for directory buckets or Amazon S3 on
|
|
20826
|
+
# Outposts buckets.
|
|
20827
|
+
#
|
|
20828
|
+
# </note>
|
|
20829
|
+
#
|
|
20830
|
+
# Updates the server-side encryption type of an existing encrypted
|
|
20831
|
+
# object in a general purpose bucket. You can use the
|
|
20832
|
+
# `UpdateObjectEncryption` operation to change encrypted objects from
|
|
20833
|
+
# server-side encryption with Amazon S3 managed keys (SSE-S3) to
|
|
20834
|
+
# server-side encryption with Key Management Service (KMS) keys
|
|
20835
|
+
# (SSE-KMS), or to apply S3 Bucket Keys. You can also use the
|
|
20836
|
+
# `UpdateObjectEncryption` operation to change the customer-managed KMS
|
|
20837
|
+
# key used to encrypt your data so that you can comply with custom
|
|
20838
|
+
# key-rotation standards.
|
|
20839
|
+
#
|
|
20840
|
+
# Using the `UpdateObjectEncryption` operation, you can atomically
|
|
20841
|
+
# update the server-side encryption type of an existing object in a
|
|
20842
|
+
# general purpose bucket without any data movement. The
|
|
20843
|
+
# `UpdateObjectEncryption` operation uses envelope encryption to
|
|
20844
|
+
# re-encrypt the data key used to encrypt and decrypt your object with
|
|
20845
|
+
# your newly specified server-side encryption type. In other words, when
|
|
20846
|
+
# you use the `UpdateObjectEncryption` operation, your data isn't
|
|
20847
|
+
# copied, archived objects in the S3 Glacier Flexible Retrieval and S3
|
|
20848
|
+
# Glacier Deep Archive storage classes aren't restored, and objects in
|
|
20849
|
+
# the S3 Intelligent-Tiering storage class aren't moved between tiers.
|
|
20850
|
+
# Additionally, the `UpdateObjectEncryption` operation preserves all
|
|
20851
|
+
# object metadata properties, including the storage class, creation
|
|
20852
|
+
# date, last modified date, ETag, and checksum properties. For more
|
|
20853
|
+
# information, see [ Updating server-side encryption for existing
|
|
20854
|
+
# objects][1] in the *Amazon S3 User Guide*.
|
|
20855
|
+
#
|
|
20856
|
+
# By default, all `UpdateObjectEncryption` requests that specify a
|
|
20857
|
+
# customer-managed KMS key are restricted to KMS keys that are owned by
|
|
20858
|
+
# the bucket owner's Amazon Web Services account. If you're using
|
|
20859
|
+
# Organizations, you can request the ability to use KMS keys owned by
|
|
20860
|
+
# other member accounts within your organization by contacting Amazon
|
|
20861
|
+
# Web Services Support.
|
|
20862
|
+
#
|
|
20863
|
+
# <note markdown="1"> Source objects that are unencrypted, or encrypted with either
|
|
20864
|
+
# dual-layer server-side encryption with KMS keys (DSSE-KMS) or
|
|
20865
|
+
# server-side encryption with customer-provided keys (SSE-C) aren't
|
|
20866
|
+
# supported by this operation. Additionally, you cannot specify SSE-S3
|
|
20867
|
+
# encryption as the requested new encryption type
|
|
20868
|
+
# `UpdateObjectEncryption` request.
|
|
20869
|
+
#
|
|
20870
|
+
# </note>
|
|
20871
|
+
#
|
|
20872
|
+
# Permissions
|
|
20873
|
+
# : * To use the `UpdateObjectEncryption` operation, you must have the
|
|
20874
|
+
# following permissions:
|
|
20875
|
+
#
|
|
20876
|
+
# * `s3:PutObject`
|
|
20877
|
+
#
|
|
20878
|
+
# * `s3:UpdateObjectEncryption`
|
|
20879
|
+
#
|
|
20880
|
+
# * `kms:Encrypt`
|
|
20881
|
+
#
|
|
20882
|
+
# * `kms:Decrypt`
|
|
20883
|
+
#
|
|
20884
|
+
# * `kms:GenerateDataKey`
|
|
20885
|
+
#
|
|
20886
|
+
# * `kms:ReEncrypt*`
|
|
20887
|
+
# * If you're using Organizations, to use this operation with
|
|
20888
|
+
# customer-managed KMS keys from other Amazon Web Services accounts
|
|
20889
|
+
# within your organization, you must have the
|
|
20890
|
+
# `organizations:DescribeAccount` permission.
|
|
20891
|
+
# ^
|
|
20892
|
+
#
|
|
20893
|
+
# Errors
|
|
20894
|
+
# : * You might receive an `InvalidRequest` error for several reasons.
|
|
20895
|
+
# Depending on the reason for the error, you might receive one of
|
|
20896
|
+
# the following messages:
|
|
20897
|
+
#
|
|
20898
|
+
# * The `UpdateObjectEncryption` operation doesn't supported
|
|
20899
|
+
# unencrypted source objects. Only source objects encrypted with
|
|
20900
|
+
# SSE-S3 or SSE-KMS are supported.
|
|
20901
|
+
#
|
|
20902
|
+
# * The `UpdateObjectEncryption` operation doesn't support source
|
|
20903
|
+
# objects with the encryption type DSSE-KMS or SSE-C. Only source
|
|
20904
|
+
# objects encrypted with SSE-S3 or SSE-KMS are supported.
|
|
20905
|
+
#
|
|
20906
|
+
# * The `UpdateObjectEncryption` operation doesn't support updating
|
|
20907
|
+
# the encryption type to DSSE-KMS or SSE-C. Modify the request to
|
|
20908
|
+
# specify SSE-KMS for the updated encryption type, and then try
|
|
20909
|
+
# again.
|
|
20910
|
+
#
|
|
20911
|
+
# * Requests that modify an object encryption configuration require
|
|
20912
|
+
# Amazon Web Services Signature Version 4. Modify the request to
|
|
20913
|
+
# use Amazon Web Services Signature Version 4, and then try again.
|
|
20914
|
+
#
|
|
20915
|
+
# * Requests that modify an object encryption configuration require
|
|
20916
|
+
# a valid new encryption type. Valid values are `SSEKMS`. Modify
|
|
20917
|
+
# the request to specify SSE-KMS for the updated encryption type,
|
|
20918
|
+
# and then try again.
|
|
20919
|
+
#
|
|
20920
|
+
# * Requests that modify an object's encryption type to SSE-KMS
|
|
20921
|
+
# require an Amazon Web Services KMS key Amazon Resource Name
|
|
20922
|
+
# (ARN). Modify the request to specify a KMS key ARN, and then try
|
|
20923
|
+
# again.
|
|
20924
|
+
#
|
|
20925
|
+
# * Requests that modify an object's encryption type to SSE-KMS
|
|
20926
|
+
# require a valid Amazon Web Services KMS key Amazon Resource Name
|
|
20927
|
+
# (ARN). Confirm that you have a correctly formatted KMS key ARN
|
|
20928
|
+
# in your request, and then try again.
|
|
20929
|
+
#
|
|
20930
|
+
# * The `BucketKeyEnabled` value isn't valid. Valid values are
|
|
20931
|
+
# `true` or `false`. Modify the request to specify a valid value,
|
|
20932
|
+
# and then try again.
|
|
20933
|
+
# * You might receive an `AccessDenied` error for several reasons.
|
|
20934
|
+
# Depending on the reason for the error, you might receive one of
|
|
20935
|
+
# the following messages:
|
|
20936
|
+
#
|
|
20937
|
+
# * The Amazon Web Services KMS key in the request must be owned by
|
|
20938
|
+
# the same account as the bucket. Modify the request to specify a
|
|
20939
|
+
# KMS key from the same account, and then try again.
|
|
20940
|
+
#
|
|
20941
|
+
# * The bucket owner's account was approved to make
|
|
20942
|
+
# `UpdateObjectEncryption` requests that use any Amazon Web
|
|
20943
|
+
# Services KMS key in their organization, but the bucket owner's
|
|
20944
|
+
# account isn't part of an organization in Organizations. Make
|
|
20945
|
+
# sure that the bucket owner's account and the specified KMS key
|
|
20946
|
+
# belong to the same organization, and then try again.
|
|
20947
|
+
#
|
|
20948
|
+
# * The specified Amazon Web Services KMS key must be from the same
|
|
20949
|
+
# organization in Organizations as the bucket. Specify a KMS key
|
|
20950
|
+
# that belongs to the same organization as the bucket, and then
|
|
20951
|
+
# try again.
|
|
20952
|
+
#
|
|
20953
|
+
# * The encryption type for the specified object can’t be updated
|
|
20954
|
+
# because that object is protected by S3 Object Lock. If the
|
|
20955
|
+
# object has a governance-mode retention period or a legal hold,
|
|
20956
|
+
# you must first remove the Object Lock status on the object
|
|
20957
|
+
# before you issue your `UpdateObjectEncryption` request. You
|
|
20958
|
+
# can't use the `UpdateObjectEncryption` operation with objects
|
|
20959
|
+
# that have an Object Lock compliance mode retention period
|
|
20960
|
+
# applied to them.
|
|
20961
|
+
#
|
|
20962
|
+
#
|
|
20963
|
+
#
|
|
20964
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/update-sse-encryption.html
|
|
20965
|
+
#
|
|
20966
|
+
# @option params [required, String] :bucket
|
|
20967
|
+
# The name of the general purpose bucket that contains the specified
|
|
20968
|
+
# object key name.
|
|
20969
|
+
#
|
|
20970
|
+
# When you use this operation with an access point attached to a general
|
|
20971
|
+
# purpose bucket, you must either provide the alias of the access point
|
|
20972
|
+
# in place of the bucket name or you must specify the access point
|
|
20973
|
+
# Amazon Resource Name (ARN). When using the access point ARN, you must
|
|
20974
|
+
# direct requests to the access point hostname. The access point
|
|
20975
|
+
# hostname takes the form `
|
|
20976
|
+
# AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com`. When
|
|
20977
|
+
# using this operation with an access point through the Amazon Web
|
|
20978
|
+
# Services SDKs, you provide the access point ARN in place of the bucket
|
|
20979
|
+
# name. For more information about access point ARNs, see [ Referencing
|
|
20980
|
+
# access points][1] in the *Amazon S3 User Guide*.
|
|
20981
|
+
#
|
|
20982
|
+
#
|
|
20983
|
+
#
|
|
20984
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-naming.html
|
|
20985
|
+
#
|
|
20986
|
+
# @option params [required, String] :key
|
|
20987
|
+
# The key name of the object that you want to update the server-side
|
|
20988
|
+
# encryption type for.
|
|
20989
|
+
#
|
|
20990
|
+
# @option params [String] :version_id
|
|
20991
|
+
# The version ID of the object that you want to update the server-side
|
|
20992
|
+
# encryption type for.
|
|
20993
|
+
#
|
|
20994
|
+
# @option params [required, Types::ObjectEncryption] :object_encryption
|
|
20995
|
+
# The updated server-side encryption type for this object. The
|
|
20996
|
+
# `UpdateObjectEncryption` operation supports the SSE-S3 and SSE-KMS
|
|
20997
|
+
# encryption types.
|
|
20998
|
+
#
|
|
20999
|
+
# Valid Values: `SSES3` \| `SSEKMS`
|
|
21000
|
+
#
|
|
21001
|
+
# @option params [String] :request_payer
|
|
21002
|
+
# Confirms that the requester knows that they will be charged for the
|
|
21003
|
+
# request. Bucket owners need not specify this parameter in their
|
|
21004
|
+
# requests. If either the source or destination S3 bucket has Requester
|
|
21005
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
21006
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
21007
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
21008
|
+
# S3 User Guide*.
|
|
21009
|
+
#
|
|
21010
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
21011
|
+
#
|
|
21012
|
+
# </note>
|
|
21013
|
+
#
|
|
21014
|
+
#
|
|
21015
|
+
#
|
|
21016
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
21017
|
+
#
|
|
21018
|
+
# @option params [String] :expected_bucket_owner
|
|
21019
|
+
# The account ID of the expected bucket owner. If the account ID that
|
|
21020
|
+
# you provide doesn't match the actual owner of the bucket, the request
|
|
21021
|
+
# fails with the HTTP status code `403 Forbidden` (access denied).
|
|
21022
|
+
#
|
|
21023
|
+
# @option params [String] :content_md5
|
|
21024
|
+
# The MD5 hash for the request body. For requests made using the Amazon
|
|
21025
|
+
# Web Services Command Line Interface (CLI) or Amazon Web Services SDKs,
|
|
21026
|
+
# this field is calculated automatically.
|
|
21027
|
+
#
|
|
21028
|
+
# @option params [String] :checksum_algorithm
|
|
21029
|
+
# Indicates the algorithm used to create the checksum for the object
|
|
21030
|
+
# when you use an Amazon Web Services SDK. This header doesn't provide
|
|
21031
|
+
# any additional functionality if you don't use the SDK. When you send
|
|
21032
|
+
# this header, there must be a corresponding `x-amz-checksum` or
|
|
21033
|
+
# `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request
|
|
21034
|
+
# with the HTTP status code `400 Bad Request`. For more information, see
|
|
21035
|
+
# [ Checking object integrity ][1] in the *Amazon S3 User Guide*.
|
|
21036
|
+
#
|
|
21037
|
+
# If you provide an individual checksum, Amazon S3 ignores any provided
|
|
21038
|
+
# `ChecksumAlgorithm` parameter.
|
|
21039
|
+
#
|
|
21040
|
+
#
|
|
21041
|
+
#
|
|
21042
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
|
|
21043
|
+
#
|
|
21044
|
+
# @return [Types::UpdateObjectEncryptionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
21045
|
+
#
|
|
21046
|
+
# * {Types::UpdateObjectEncryptionResponse#request_charged #request_charged} => String
|
|
21047
|
+
#
|
|
21048
|
+
# @example Request syntax with placeholder values
|
|
21049
|
+
#
|
|
21050
|
+
# resp = client.update_object_encryption({
|
|
21051
|
+
# bucket: "BucketName", # required
|
|
21052
|
+
# key: "ObjectKey", # required
|
|
21053
|
+
# version_id: "ObjectVersionId",
|
|
21054
|
+
# object_encryption: { # required
|
|
21055
|
+
# ssekms: {
|
|
21056
|
+
# kms_key_arn: "NonEmptyKmsKeyArnString", # required
|
|
21057
|
+
# bucket_key_enabled: false,
|
|
21058
|
+
# },
|
|
21059
|
+
# },
|
|
21060
|
+
# request_payer: "requester", # accepts requester
|
|
21061
|
+
# expected_bucket_owner: "AccountId",
|
|
21062
|
+
# content_md5: "ContentMD5",
|
|
21063
|
+
# checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256, CRC64NVME
|
|
21064
|
+
# })
|
|
21065
|
+
#
|
|
21066
|
+
# @example Response structure
|
|
21067
|
+
#
|
|
21068
|
+
# resp.request_charged #=> String, one of "requester"
|
|
21069
|
+
#
|
|
21070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UpdateObjectEncryption AWS API Documentation
|
|
21071
|
+
#
|
|
21072
|
+
# @overload update_object_encryption(params = {})
|
|
21073
|
+
# @param [Hash] params ({})
|
|
21074
|
+
def update_object_encryption(params = {}, options = {})
|
|
21075
|
+
req = build_request(:update_object_encryption, params)
|
|
21076
|
+
req.send_request(options)
|
|
21077
|
+
end
|
|
21078
|
+
|
|
20895
21079
|
# Uploads a part in a multipart upload.
|
|
20896
21080
|
#
|
|
20897
21081
|
# <note markdown="1"> In this operation, you provide new data as a part of an object in your
|
|
@@ -21098,7 +21282,7 @@ module Aws::S3
|
|
|
21098
21282
|
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
|
21099
21283
|
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
|
21100
21284
|
#
|
|
21101
|
-
# @option params [String,
|
|
21285
|
+
# @option params [String, IO] :body
|
|
21102
21286
|
# Object data.
|
|
21103
21287
|
#
|
|
21104
21288
|
# @option params [required, String] :bucket
|
|
@@ -21278,10 +21462,10 @@ module Aws::S3
|
|
|
21278
21462
|
# Confirms that the requester knows that they will be charged for the
|
|
21279
21463
|
# request. Bucket owners need not specify this parameter in their
|
|
21280
21464
|
# requests. If either the source or destination S3 bucket has Requester
|
|
21281
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
21282
|
-
#
|
|
21283
|
-
#
|
|
21284
|
-
#
|
|
21465
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
21466
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
21467
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
21468
|
+
# S3 User Guide*.
|
|
21285
21469
|
#
|
|
21286
21470
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
21287
21471
|
#
|
|
@@ -21470,10 +21654,13 @@ module Aws::S3
|
|
|
21470
21654
|
# * If the source object that you want to copy is in a directory
|
|
21471
21655
|
# bucket, you must have the <b>
|
|
21472
21656
|
# <code>s3express:CreateSession</code> </b> permission in the
|
|
21473
|
-
# `Action` element of a policy to read the object.
|
|
21474
|
-
#
|
|
21475
|
-
#
|
|
21476
|
-
#
|
|
21657
|
+
# `Action` element of a policy to read the object. If no session
|
|
21658
|
+
# mode is specified, the session will be created with the maximum
|
|
21659
|
+
# allowable privilege, attempting `ReadWrite` first, then
|
|
21660
|
+
# `ReadOnly` if `ReadWrite` is not permitted. If you want to
|
|
21661
|
+
# explicitly restrict the access to be read-only, you can set the
|
|
21662
|
+
# `s3express:SessionMode` condition key to `ReadOnly` on the copy
|
|
21663
|
+
# source bucket.
|
|
21477
21664
|
#
|
|
21478
21665
|
# * If the copy destination is a directory bucket, you must have the
|
|
21479
21666
|
# <b> <code>s3express:CreateSession</code> </b> permission in the
|
|
@@ -21843,10 +22030,10 @@ module Aws::S3
|
|
|
21843
22030
|
# Confirms that the requester knows that they will be charged for the
|
|
21844
22031
|
# request. Bucket owners need not specify this parameter in their
|
|
21845
22032
|
# requests. If either the source or destination S3 bucket has Requester
|
|
21846
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
21847
|
-
#
|
|
21848
|
-
#
|
|
21849
|
-
#
|
|
22033
|
+
# Pays enabled, the requester will pay for the corresponding charges.
|
|
22034
|
+
# For information about downloading objects from Requester Pays buckets,
|
|
22035
|
+
# see [Downloading Objects in Requester Pays Buckets][1] in the *Amazon
|
|
22036
|
+
# S3 User Guide*.
|
|
21850
22037
|
#
|
|
21851
22038
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
21852
22039
|
#
|
|
@@ -22380,7 +22567,7 @@ module Aws::S3
|
|
|
22380
22567
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
|
22381
22568
|
# ssekms_key_id: "SSEKMSKeyId",
|
|
22382
22569
|
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
|
22383
|
-
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE, FSX_OPENZFS
|
|
22570
|
+
# 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
|
|
22384
22571
|
# tag_count: 1,
|
|
22385
22572
|
# version_id: "ObjectVersionId",
|
|
22386
22573
|
# bucket_key_enabled: false,
|
|
@@ -22413,7 +22600,7 @@ module Aws::S3
|
|
|
22413
22600
|
tracer: tracer
|
|
22414
22601
|
)
|
|
22415
22602
|
context[:gem_name] = 'aws-sdk-s3'
|
|
22416
|
-
context[:gem_version] = '1.
|
|
22603
|
+
context[:gem_version] = '1.216.0'
|
|
22417
22604
|
Seahorse::Client::Request.new(handlers, context)
|
|
22418
22605
|
end
|
|
22419
22606
|
|