aws-sdk-s3 1.211.0 → 1.217.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 +32 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +44 -16
- data/lib/aws-sdk-s3/client.rb +479 -162
- data/lib/aws-sdk-s3/client_api.rb +54 -0
- data/lib/aws-sdk-s3/customizations.rb +8 -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/endpoints.rb +13 -0
- data/lib/aws-sdk-s3/errors.rb +11 -0
- 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 +32 -32
- data/lib/aws-sdk-s3/object_acl.rb +4 -4
- data/lib/aws-sdk-s3/object_summary.rb +28 -28
- data/lib/aws-sdk-s3/object_version.rb +16 -16
- data/lib/aws-sdk-s3/resource.rb +28 -0
- data/lib/aws-sdk-s3/transfer_manager.rb +237 -18
- data/lib/aws-sdk-s3/types.rb +350 -121
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +2 -1
- data/sig/client.rbs +24 -1
- data/sig/errors.rbs +2 -0
- data/sig/resource.rbs +2 -1
- data/sig/types.rbs +38 -0
- metadata +7 -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
|
#
|
|
@@ -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
|
#
|
|
@@ -2435,6 +2438,20 @@ module Aws::S3
|
|
|
2435
2438
|
# configuring, and working with Amazon S3 buckets][2] in the *Amazon S3
|
|
2436
2439
|
# User Guide*.
|
|
2437
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
|
+
#
|
|
2438
2455
|
# <note markdown="1"> * **General purpose buckets** - If you send your `CreateBucket`
|
|
2439
2456
|
# request to the `s3.amazonaws.com` global endpoint, the request goes
|
|
2440
2457
|
# to the `us-east-1` Region. So the signature calculations in
|
|
@@ -2443,7 +2460,7 @@ module Aws::S3
|
|
|
2443
2460
|
# the bucket is to be created. If you create a bucket in a Region
|
|
2444
2461
|
# other than US East (N. Virginia), your application must be able to
|
|
2445
2462
|
# handle 307 redirect. For more information, see [Virtual hosting of
|
|
2446
|
-
# buckets][
|
|
2463
|
+
# buckets][4] in the *Amazon S3 User Guide*.
|
|
2447
2464
|
#
|
|
2448
2465
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
|
2449
2466
|
# requests for this API operation to the Regional endpoint. These
|
|
@@ -2451,9 +2468,9 @@ module Aws::S3
|
|
|
2451
2468
|
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
|
2452
2469
|
# Virtual-hosted-style requests aren't supported. For more
|
|
2453
2470
|
# information about endpoints in Availability Zones, see [Regional and
|
|
2454
|
-
# Zonal endpoints for directory buckets in Availability Zones][
|
|
2471
|
+
# Zonal endpoints for directory buckets in Availability Zones][5] in
|
|
2455
2472
|
# the *Amazon S3 User Guide*. For more information about endpoints in
|
|
2456
|
-
# Local Zones, see [Concepts for directory buckets in Local Zones][
|
|
2473
|
+
# Local Zones, see [Concepts for directory buckets in Local Zones][6]
|
|
2457
2474
|
# in the *Amazon S3 User Guide*.
|
|
2458
2475
|
#
|
|
2459
2476
|
# </note>
|
|
@@ -2496,17 +2513,17 @@ module Aws::S3
|
|
|
2496
2513
|
# disabled. If you would like to share data with users outside of
|
|
2497
2514
|
# your account, you can use bucket policies as needed. For more
|
|
2498
2515
|
# information, see [Controlling ownership of objects and disabling
|
|
2499
|
-
# ACLs for your bucket ][
|
|
2500
|
-
# 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*.
|
|
2501
2518
|
#
|
|
2502
2519
|
# * **S3 Block Public Access** - If your specific use case requires
|
|
2503
2520
|
# granting public access to your S3 resources, you can disable
|
|
2504
2521
|
# Block Public Access. Specifically, you can create a new bucket
|
|
2505
2522
|
# with Block Public Access enabled, then separately call the [
|
|
2506
|
-
# `DeletePublicAccessBlock` ][
|
|
2523
|
+
# `DeletePublicAccessBlock` ][9] API. To use this operation, you
|
|
2507
2524
|
# must have the `s3:PutBucketPublicAccessBlock` permission. For
|
|
2508
2525
|
# more information about S3 Block Public Access, see [Blocking
|
|
2509
|
-
# public access to your Amazon S3 storage ][
|
|
2526
|
+
# public access to your Amazon S3 storage ][8] in the *Amazon S3
|
|
2510
2527
|
# User Guide*.
|
|
2511
2528
|
# * **Directory bucket permissions** - You must have the
|
|
2512
2529
|
# `s3express:CreateBucket` permission in an IAM identity-based
|
|
@@ -2515,7 +2532,7 @@ module Aws::S3
|
|
|
2515
2532
|
# performed by the Amazon Web Services account that owns the
|
|
2516
2533
|
# resource. For more information about directory bucket policies and
|
|
2517
2534
|
# permissions, see [Amazon Web Services Identity and Access
|
|
2518
|
-
# Management (IAM) for S3 Express One Zone][
|
|
2535
|
+
# Management (IAM) for S3 Express One Zone][10] in the *Amazon S3
|
|
2519
2536
|
# User Guide*.
|
|
2520
2537
|
#
|
|
2521
2538
|
# The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
|
|
@@ -2525,9 +2542,9 @@ module Aws::S3
|
|
|
2525
2542
|
# enforced (ACLs disabled). These settings can't be modified.
|
|
2526
2543
|
#
|
|
2527
2544
|
# For more information about permissions for creating and working
|
|
2528
|
-
# with directory buckets, see [Directory buckets][
|
|
2545
|
+
# with directory buckets, see [Directory buckets][11] in the *Amazon
|
|
2529
2546
|
# S3 User Guide*. For more information about supported S3 features
|
|
2530
|
-
# for directory buckets, see [Features of S3 Express One Zone][
|
|
2547
|
+
# for directory buckets, see [Features of S3 Express One Zone][12]
|
|
2531
2548
|
# in the *Amazon S3 User Guide*.
|
|
2532
2549
|
#
|
|
2533
2550
|
# HTTP Host header syntax
|
|
@@ -2537,9 +2554,9 @@ module Aws::S3
|
|
|
2537
2554
|
#
|
|
2538
2555
|
# The following operations are related to `CreateBucket`:
|
|
2539
2556
|
#
|
|
2540
|
-
# * [PutObject][
|
|
2557
|
+
# * [PutObject][13]
|
|
2541
2558
|
#
|
|
2542
|
-
# * [DeleteBucket][
|
|
2559
|
+
# * [DeleteBucket][14]
|
|
2543
2560
|
#
|
|
2544
2561
|
# You must URL encode any signed header values that contain spaces. For
|
|
2545
2562
|
# example, if your header value is `my file.txt`, containing two spaces
|
|
@@ -2549,17 +2566,18 @@ module Aws::S3
|
|
|
2549
2566
|
#
|
|
2550
2567
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
|
2551
2568
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html
|
|
2552
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2553
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2554
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2555
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2556
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2557
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2558
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2559
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2560
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
|
2561
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
2562
|
-
# [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
|
|
2563
2581
|
#
|
|
2564
2582
|
# @option params [String] :acl
|
|
2565
2583
|
# The canned ACL to apply to the bucket.
|
|
@@ -2676,6 +2694,34 @@ module Aws::S3
|
|
|
2676
2694
|
#
|
|
2677
2695
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
|
2678
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
|
+
#
|
|
2679
2725
|
# @return [Types::CreateBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2680
2726
|
#
|
|
2681
2727
|
# * {Types::CreateBucketOutput#location #location} => String
|
|
@@ -2740,6 +2786,7 @@ module Aws::S3
|
|
|
2740
2786
|
# grant_write_acp: "GrantWriteACP",
|
|
2741
2787
|
# object_lock_enabled_for_bucket: false,
|
|
2742
2788
|
# object_ownership: "BucketOwnerPreferred", # accepts BucketOwnerPreferred, ObjectWriter, BucketOwnerEnforced
|
|
2789
|
+
# bucket_namespace: "account-regional", # accepts account-regional, global
|
|
2743
2790
|
# })
|
|
2744
2791
|
#
|
|
2745
2792
|
# @example Response structure
|
|
@@ -3810,10 +3857,10 @@ module Aws::S3
|
|
|
3810
3857
|
# Confirms that the requester knows that they will be charged for the
|
|
3811
3858
|
# request. Bucket owners need not specify this parameter in their
|
|
3812
3859
|
# requests. If either the source or destination S3 bucket has Requester
|
|
3813
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
3814
|
-
#
|
|
3815
|
-
#
|
|
3816
|
-
#
|
|
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*.
|
|
3817
3864
|
#
|
|
3818
3865
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
3819
3866
|
#
|
|
@@ -4146,12 +4193,17 @@ module Aws::S3
|
|
|
4146
4193
|
#
|
|
4147
4194
|
# @option params [String] :session_mode
|
|
4148
4195
|
# Specifies the mode of the session that will be created, either
|
|
4149
|
-
# `ReadWrite` or `ReadOnly`.
|
|
4150
|
-
#
|
|
4151
|
-
#
|
|
4152
|
-
#
|
|
4153
|
-
#
|
|
4154
|
-
# `
|
|
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`.
|
|
4155
4207
|
#
|
|
4156
4208
|
# @option params [required, String] :bucket
|
|
4157
4209
|
# The name of the bucket that you create a session for.
|
|
@@ -5398,10 +5450,6 @@ module Aws::S3
|
|
|
5398
5450
|
# for a general purpose bucket][1], you can no longer use this operation
|
|
5399
5451
|
# for that bucket and must use [UntagResource][2] instead.
|
|
5400
5452
|
#
|
|
5401
|
-
# if ABAC is not enabled for the bucket. When you [enable ABAC for a
|
|
5402
|
-
# general purpose bucket][1], you can no longer use this operation for
|
|
5403
|
-
# that bucket and must use [UntagResource][2] instead.
|
|
5404
|
-
#
|
|
5405
5453
|
# To use this operation, you must have permission to perform the
|
|
5406
5454
|
# `s3:PutBucketTagging` action. By default, the bucket owner has this
|
|
5407
5455
|
# permission and can grant this permission to others.
|
|
@@ -5734,10 +5782,10 @@ module Aws::S3
|
|
|
5734
5782
|
# Confirms that the requester knows that they will be charged for the
|
|
5735
5783
|
# request. Bucket owners need not specify this parameter in their
|
|
5736
5784
|
# requests. If either the source or destination S3 bucket has Requester
|
|
5737
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
5738
|
-
#
|
|
5739
|
-
#
|
|
5740
|
-
#
|
|
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*.
|
|
5741
5789
|
#
|
|
5742
5790
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
5743
5791
|
#
|
|
@@ -6196,10 +6244,10 @@ module Aws::S3
|
|
|
6196
6244
|
# Confirms that the requester knows that they will be charged for the
|
|
6197
6245
|
# request. Bucket owners need not specify this parameter in their
|
|
6198
6246
|
# requests. If either the source or destination S3 bucket has Requester
|
|
6199
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
6200
|
-
#
|
|
6201
|
-
#
|
|
6202
|
-
#
|
|
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*.
|
|
6203
6251
|
#
|
|
6204
6252
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
6205
6253
|
#
|
|
@@ -6548,10 +6596,10 @@ module Aws::S3
|
|
|
6548
6596
|
# Confirms that the requester knows that they will be charged for the
|
|
6549
6597
|
# request. Bucket owners need not specify this parameter in their
|
|
6550
6598
|
# requests. If either the source or destination S3 bucket has Requester
|
|
6551
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
6552
|
-
#
|
|
6553
|
-
#
|
|
6554
|
-
#
|
|
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*.
|
|
6555
6603
|
#
|
|
6556
6604
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
6557
6605
|
#
|
|
@@ -8738,10 +8786,6 @@ module Aws::S3
|
|
|
8738
8786
|
#
|
|
8739
8787
|
# Returns the tag set associated with the general purpose bucket.
|
|
8740
8788
|
#
|
|
8741
|
-
# if ABAC is not enabled for the bucket. When you [enable ABAC for a
|
|
8742
|
-
# general purpose bucket][1], you can no longer use this operation for
|
|
8743
|
-
# that bucket and must use [ListTagsForResource][2] instead.
|
|
8744
|
-
#
|
|
8745
8789
|
# To use this operation, you must have permission to perform the
|
|
8746
8790
|
# `s3:GetBucketTagging` action. By default, the bucket owner has this
|
|
8747
8791
|
# permission and can grant this permission to others.
|
|
@@ -8756,9 +8800,9 @@ module Aws::S3
|
|
|
8756
8800
|
#
|
|
8757
8801
|
# The following operations are related to `GetBucketTagging`:
|
|
8758
8802
|
#
|
|
8759
|
-
# * [PutBucketTagging][
|
|
8803
|
+
# * [PutBucketTagging][1]
|
|
8760
8804
|
#
|
|
8761
|
-
# * [DeleteBucketTagging][
|
|
8805
|
+
# * [DeleteBucketTagging][2]
|
|
8762
8806
|
#
|
|
8763
8807
|
# You must URL encode any signed header values that contain spaces. For
|
|
8764
8808
|
# example, if your header value is `my file.txt`, containing two spaces
|
|
@@ -8766,10 +8810,8 @@ module Aws::S3
|
|
|
8766
8810
|
#
|
|
8767
8811
|
#
|
|
8768
8812
|
#
|
|
8769
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
8770
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
|
8771
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html
|
|
8772
|
-
# [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
|
|
8773
8815
|
#
|
|
8774
8816
|
# @option params [required, String] :bucket
|
|
8775
8817
|
# The name of the bucket for which to get the tagging information.
|
|
@@ -9454,10 +9496,10 @@ module Aws::S3
|
|
|
9454
9496
|
# Confirms that the requester knows that they will be charged for the
|
|
9455
9497
|
# request. Bucket owners need not specify this parameter in their
|
|
9456
9498
|
# requests. If either the source or destination S3 bucket has Requester
|
|
9457
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
9458
|
-
#
|
|
9459
|
-
#
|
|
9460
|
-
#
|
|
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*.
|
|
9461
9503
|
#
|
|
9462
9504
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
9463
9505
|
#
|
|
@@ -9759,10 +9801,10 @@ module Aws::S3
|
|
|
9759
9801
|
# Confirms that the requester knows that they will be charged for the
|
|
9760
9802
|
# request. Bucket owners need not specify this parameter in their
|
|
9761
9803
|
# requests. If either the source or destination S3 bucket has Requester
|
|
9762
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
9763
|
-
#
|
|
9764
|
-
#
|
|
9765
|
-
#
|
|
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*.
|
|
9766
9808
|
#
|
|
9767
9809
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
9768
9810
|
#
|
|
@@ -10170,10 +10212,10 @@ module Aws::S3
|
|
|
10170
10212
|
# Confirms that the requester knows that they will be charged for the
|
|
10171
10213
|
# request. Bucket owners need not specify this parameter in their
|
|
10172
10214
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10173
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10174
|
-
#
|
|
10175
|
-
#
|
|
10176
|
-
#
|
|
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*.
|
|
10177
10219
|
#
|
|
10178
10220
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10179
10221
|
#
|
|
@@ -10315,10 +10357,10 @@ module Aws::S3
|
|
|
10315
10357
|
# Confirms that the requester knows that they will be charged for the
|
|
10316
10358
|
# request. Bucket owners need not specify this parameter in their
|
|
10317
10359
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10318
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10319
|
-
#
|
|
10320
|
-
#
|
|
10321
|
-
#
|
|
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*.
|
|
10322
10364
|
#
|
|
10323
10365
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10324
10366
|
#
|
|
@@ -10493,10 +10535,10 @@ module Aws::S3
|
|
|
10493
10535
|
# Confirms that the requester knows that they will be charged for the
|
|
10494
10536
|
# request. Bucket owners need not specify this parameter in their
|
|
10495
10537
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10496
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10497
|
-
#
|
|
10498
|
-
#
|
|
10499
|
-
#
|
|
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*.
|
|
10500
10542
|
#
|
|
10501
10543
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10502
10544
|
#
|
|
@@ -10624,10 +10666,10 @@ module Aws::S3
|
|
|
10624
10666
|
# Confirms that the requester knows that they will be charged for the
|
|
10625
10667
|
# request. Bucket owners need not specify this parameter in their
|
|
10626
10668
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10627
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10628
|
-
#
|
|
10629
|
-
#
|
|
10630
|
-
#
|
|
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*.
|
|
10631
10673
|
#
|
|
10632
10674
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10633
10675
|
#
|
|
@@ -10759,10 +10801,10 @@ module Aws::S3
|
|
|
10759
10801
|
# Confirms that the requester knows that they will be charged for the
|
|
10760
10802
|
# request. Bucket owners need not specify this parameter in their
|
|
10761
10803
|
# requests. If either the source or destination S3 bucket has Requester
|
|
10762
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
10763
|
-
#
|
|
10764
|
-
#
|
|
10765
|
-
#
|
|
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*.
|
|
10766
10808
|
#
|
|
10767
10809
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
10768
10810
|
#
|
|
@@ -10950,10 +10992,12 @@ module Aws::S3
|
|
|
10950
10992
|
#
|
|
10951
10993
|
# * **Directory bucket permissions** - You must have the <b>
|
|
10952
10994
|
# <code>s3express:CreateSession</code> </b> permission in the
|
|
10953
|
-
# `Action` element of a policy.
|
|
10954
|
-
#
|
|
10955
|
-
#
|
|
10956
|
-
#
|
|
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.
|
|
10957
11001
|
#
|
|
10958
11002
|
# For more information about example bucket policies, see [Example
|
|
10959
11003
|
# bucket policies for S3 Express One Zone][3] and [Amazon Web
|
|
@@ -11446,10 +11490,10 @@ module Aws::S3
|
|
|
11446
11490
|
# Confirms that the requester knows that they will be charged for the
|
|
11447
11491
|
# request. Bucket owners need not specify this parameter in their
|
|
11448
11492
|
# requests. If either the source or destination S3 bucket has Requester
|
|
11449
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
11450
|
-
#
|
|
11451
|
-
#
|
|
11452
|
-
#
|
|
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*.
|
|
11453
11497
|
#
|
|
11454
11498
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
11455
11499
|
#
|
|
@@ -12567,10 +12611,10 @@ module Aws::S3
|
|
|
12567
12611
|
# Confirms that the requester knows that they will be charged for the
|
|
12568
12612
|
# request. Bucket owners need not specify this parameter in their
|
|
12569
12613
|
# requests. If either the source or destination S3 bucket has Requester
|
|
12570
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
12571
|
-
#
|
|
12572
|
-
#
|
|
12573
|
-
#
|
|
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*.
|
|
12574
12618
|
#
|
|
12575
12619
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
12576
12620
|
#
|
|
@@ -12851,10 +12895,10 @@ module Aws::S3
|
|
|
12851
12895
|
# Confirms that the requester knows that they will be charged for the
|
|
12852
12896
|
# request. Bucket owners need not specify this parameter in their
|
|
12853
12897
|
# requests. If either the source or destination S3 bucket has Requester
|
|
12854
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
12855
|
-
#
|
|
12856
|
-
#
|
|
12857
|
-
#
|
|
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*.
|
|
12858
12902
|
#
|
|
12859
12903
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
12860
12904
|
#
|
|
@@ -13748,10 +13792,10 @@ module Aws::S3
|
|
|
13748
13792
|
# Confirms that the requester knows that they will be charged for the
|
|
13749
13793
|
# request. Bucket owners need not specify this parameter in their
|
|
13750
13794
|
# requests. If either the source or destination S3 bucket has Requester
|
|
13751
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
13752
|
-
#
|
|
13753
|
-
#
|
|
13754
|
-
#
|
|
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*.
|
|
13755
13799
|
#
|
|
13756
13800
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
13757
13801
|
#
|
|
@@ -15448,8 +15492,6 @@ module Aws::S3
|
|
|
15448
15492
|
# </note>
|
|
15449
15493
|
#
|
|
15450
15494
|
# Rules
|
|
15451
|
-
# Permissions
|
|
15452
|
-
# HTTP Host header syntax
|
|
15453
15495
|
#
|
|
15454
15496
|
# : You specify the lifecycle configuration in your request body. The
|
|
15455
15497
|
# lifecycle configuration is specified as XML consisting of one or
|
|
@@ -15488,6 +15530,8 @@ module Aws::S3
|
|
|
15488
15530
|
#
|
|
15489
15531
|
# For more information, see [Object Lifecycle Management][3] and
|
|
15490
15532
|
# [Lifecycle Configuration Elements][4].
|
|
15533
|
+
#
|
|
15534
|
+
# Permissions
|
|
15491
15535
|
# : * **General purpose bucket permissions** - By default, all Amazon S3
|
|
15492
15536
|
# resources are private, including buckets, objects, and related
|
|
15493
15537
|
# subresources (for example, lifecycle configuration and website
|
|
@@ -15537,6 +15581,8 @@ module Aws::S3
|
|
|
15537
15581
|
#
|
|
15538
15582
|
# </note>
|
|
15539
15583
|
#
|
|
15584
|
+
# HTTP Host header syntax
|
|
15585
|
+
#
|
|
15540
15586
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
|
15541
15587
|
# `s3express-control.region.amazonaws.com`.
|
|
15542
15588
|
#
|
|
@@ -17597,6 +17643,20 @@ module Aws::S3
|
|
|
17597
17643
|
#
|
|
17598
17644
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
|
17599
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.
|
|
17600
17660
|
#
|
|
17601
17661
|
# For more information about related Amazon S3 APIs, see the following:
|
|
17602
17662
|
#
|
|
@@ -18220,10 +18280,10 @@ module Aws::S3
|
|
|
18220
18280
|
# Confirms that the requester knows that they will be charged for the
|
|
18221
18281
|
# request. Bucket owners need not specify this parameter in their
|
|
18222
18282
|
# requests. If either the source or destination S3 bucket has Requester
|
|
18223
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
18224
|
-
#
|
|
18225
|
-
#
|
|
18226
|
-
#
|
|
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*.
|
|
18227
18287
|
#
|
|
18228
18288
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
18229
18289
|
#
|
|
@@ -18802,10 +18862,10 @@ module Aws::S3
|
|
|
18802
18862
|
# Confirms that the requester knows that they will be charged for the
|
|
18803
18863
|
# request. Bucket owners need not specify this parameter in their
|
|
18804
18864
|
# requests. If either the source or destination S3 bucket has Requester
|
|
18805
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
18806
|
-
#
|
|
18807
|
-
#
|
|
18808
|
-
#
|
|
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*.
|
|
18809
18869
|
#
|
|
18810
18870
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
18811
18871
|
#
|
|
@@ -18948,10 +19008,10 @@ module Aws::S3
|
|
|
18948
19008
|
# Confirms that the requester knows that they will be charged for the
|
|
18949
19009
|
# request. Bucket owners need not specify this parameter in their
|
|
18950
19010
|
# requests. If either the source or destination S3 bucket has Requester
|
|
18951
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
18952
|
-
#
|
|
18953
|
-
#
|
|
18954
|
-
#
|
|
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*.
|
|
18955
19015
|
#
|
|
18956
19016
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
18957
19017
|
#
|
|
@@ -19065,10 +19125,10 @@ module Aws::S3
|
|
|
19065
19125
|
# Confirms that the requester knows that they will be charged for the
|
|
19066
19126
|
# request. Bucket owners need not specify this parameter in their
|
|
19067
19127
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19068
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19069
|
-
#
|
|
19070
|
-
#
|
|
19071
|
-
#
|
|
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*.
|
|
19072
19132
|
#
|
|
19073
19133
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19074
19134
|
#
|
|
@@ -19199,10 +19259,10 @@ module Aws::S3
|
|
|
19199
19259
|
# Confirms that the requester knows that they will be charged for the
|
|
19200
19260
|
# request. Bucket owners need not specify this parameter in their
|
|
19201
19261
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19202
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19203
|
-
#
|
|
19204
|
-
#
|
|
19205
|
-
#
|
|
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*.
|
|
19206
19266
|
#
|
|
19207
19267
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19208
19268
|
#
|
|
@@ -19988,10 +20048,10 @@ module Aws::S3
|
|
|
19988
20048
|
# Confirms that the requester knows that they will be charged for the
|
|
19989
20049
|
# request. Bucket owners need not specify this parameter in their
|
|
19990
20050
|
# requests. If either the source or destination S3 bucket has Requester
|
|
19991
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
19992
|
-
#
|
|
19993
|
-
#
|
|
19994
|
-
#
|
|
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*.
|
|
19995
20055
|
#
|
|
19996
20056
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
19997
20057
|
#
|
|
@@ -20762,6 +20822,260 @@ module Aws::S3
|
|
|
20762
20822
|
req.send_request(options)
|
|
20763
20823
|
end
|
|
20764
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
|
+
|
|
20765
21079
|
# Uploads a part in a multipart upload.
|
|
20766
21080
|
#
|
|
20767
21081
|
# <note markdown="1"> In this operation, you provide new data as a part of an object in your
|
|
@@ -21148,10 +21462,10 @@ module Aws::S3
|
|
|
21148
21462
|
# Confirms that the requester knows that they will be charged for the
|
|
21149
21463
|
# request. Bucket owners need not specify this parameter in their
|
|
21150
21464
|
# requests. If either the source or destination S3 bucket has Requester
|
|
21151
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
21152
|
-
#
|
|
21153
|
-
#
|
|
21154
|
-
#
|
|
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*.
|
|
21155
21469
|
#
|
|
21156
21470
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
21157
21471
|
#
|
|
@@ -21340,10 +21654,13 @@ module Aws::S3
|
|
|
21340
21654
|
# * If the source object that you want to copy is in a directory
|
|
21341
21655
|
# bucket, you must have the <b>
|
|
21342
21656
|
# <code>s3express:CreateSession</code> </b> permission in the
|
|
21343
|
-
# `Action` element of a policy to read the object.
|
|
21344
|
-
#
|
|
21345
|
-
#
|
|
21346
|
-
#
|
|
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.
|
|
21347
21664
|
#
|
|
21348
21665
|
# * If the copy destination is a directory bucket, you must have the
|
|
21349
21666
|
# <b> <code>s3express:CreateSession</code> </b> permission in the
|
|
@@ -21713,10 +22030,10 @@ module Aws::S3
|
|
|
21713
22030
|
# Confirms that the requester knows that they will be charged for the
|
|
21714
22031
|
# request. Bucket owners need not specify this parameter in their
|
|
21715
22032
|
# requests. If either the source or destination S3 bucket has Requester
|
|
21716
|
-
# Pays enabled, the requester will pay for corresponding charges
|
|
21717
|
-
#
|
|
21718
|
-
#
|
|
21719
|
-
#
|
|
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*.
|
|
21720
22037
|
#
|
|
21721
22038
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
|
21722
22039
|
#
|
|
@@ -22283,7 +22600,7 @@ module Aws::S3
|
|
|
22283
22600
|
tracer: tracer
|
|
22284
22601
|
)
|
|
22285
22602
|
context[:gem_name] = 'aws-sdk-s3'
|
|
22286
|
-
context[:gem_version] = '1.
|
|
22603
|
+
context[:gem_version] = '1.217.0'
|
|
22287
22604
|
Seahorse::Client::Request.new(handlers, context)
|
|
22288
22605
|
end
|
|
22289
22606
|
|