aws-sdk-s3 1.189.1 → 1.191.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +11 -4
- data/lib/aws-sdk-s3/client.rb +511 -61
- data/lib/aws-sdk-s3/client_api.rb +41 -0
- data/lib/aws-sdk-s3/endpoints.rb +14 -0
- data/lib/aws-sdk-s3/errors.rb +11 -0
- data/lib/aws-sdk-s3/object.rb +58 -12
- data/lib/aws-sdk-s3/object_summary.rb +34 -11
- data/lib/aws-sdk-s3/types.rb +325 -22
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +2 -2
- data/sig/client.rbs +54 -29
- data/sig/errors.rbs +2 -0
- data/sig/multipart_upload.rbs +1 -1
- data/sig/object.rbs +13 -10
- data/sig/object_summary.rbs +9 -9
- data/sig/types.rbs +56 -29
- metadata +1 -1
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -945,7 +945,13 @@ module Aws::S3
|
|
945
945
|
#
|
946
946
|
# @!attribute [rw] server_side_encryption
|
947
947
|
# The server-side encryption algorithm used when storing this object
|
948
|
-
# in Amazon S3
|
948
|
+
# in Amazon S3.
|
949
|
+
#
|
950
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
951
|
+
# access points, the only valid server side encryption option is
|
952
|
+
# `aws:fsx`.
|
953
|
+
#
|
954
|
+
# </note>
|
949
955
|
# @return [String]
|
950
956
|
#
|
951
957
|
# @!attribute [rw] version_id
|
@@ -1481,7 +1487,13 @@ module Aws::S3
|
|
1481
1487
|
#
|
1482
1488
|
# @!attribute [rw] server_side_encryption
|
1483
1489
|
# The server-side encryption algorithm used when you store this object
|
1484
|
-
# in Amazon S3
|
1490
|
+
# in Amazon S3 or Amazon FSx.
|
1491
|
+
#
|
1492
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
1493
|
+
# access points, the only valid server side encryption option is
|
1494
|
+
# `aws:fsx`.
|
1495
|
+
#
|
1496
|
+
# </note>
|
1485
1497
|
# @return [String]
|
1486
1498
|
#
|
1487
1499
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -2038,6 +2050,14 @@ module Aws::S3
|
|
2038
2050
|
# key is the same customer managed key that you specified for the
|
2039
2051
|
# directory bucket's default encryption configuration.
|
2040
2052
|
#
|
2053
|
+
# * <b>S3 access points for Amazon FSx </b> - When accessing data
|
2054
|
+
# stored in Amazon FSx file systems using S3 access points, the only
|
2055
|
+
# valid server side encryption option is `aws:fsx`. All Amazon FSx
|
2056
|
+
# file systems have encryption configured by default and are
|
2057
|
+
# encrypted at rest. Data is automatically encrypted before being
|
2058
|
+
# written to the file system, and automatically decrypted as it is
|
2059
|
+
# read. These processes are handled transparently by Amazon FSx.
|
2060
|
+
#
|
2041
2061
|
#
|
2042
2062
|
#
|
2043
2063
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
@@ -2912,7 +2932,13 @@ module Aws::S3
|
|
2912
2932
|
#
|
2913
2933
|
# @!attribute [rw] server_side_encryption
|
2914
2934
|
# The server-side encryption algorithm used when you store this object
|
2915
|
-
# in Amazon S3
|
2935
|
+
# in Amazon S3 or Amazon FSx.
|
2936
|
+
#
|
2937
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
2938
|
+
# access points, the only valid server side encryption option is
|
2939
|
+
# `aws:fsx`.
|
2940
|
+
#
|
2941
|
+
# </note>
|
2916
2942
|
# @return [String]
|
2917
2943
|
#
|
2918
2944
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -3380,7 +3406,7 @@ module Aws::S3
|
|
3380
3406
|
#
|
3381
3407
|
# @!attribute [rw] server_side_encryption
|
3382
3408
|
# The server-side encryption algorithm used when you store this object
|
3383
|
-
# in Amazon S3
|
3409
|
+
# in Amazon S3 or Amazon FSx.
|
3384
3410
|
#
|
3385
3411
|
# * <b>Directory buckets </b> - For directory buckets, there are only
|
3386
3412
|
# two supported options for server-side encryption: server-side
|
@@ -3423,6 +3449,14 @@ module Aws::S3
|
|
3423
3449
|
#
|
3424
3450
|
# </note>
|
3425
3451
|
#
|
3452
|
+
# * <b>S3 access points for Amazon FSx </b> - When accessing data
|
3453
|
+
# stored in Amazon FSx file systems using S3 access points, the only
|
3454
|
+
# valid server side encryption option is `aws:fsx`. All Amazon FSx
|
3455
|
+
# file systems have encryption configured by default and are
|
3456
|
+
# encrypted at rest. Data is automatically encrypted before being
|
3457
|
+
# written to the file system, and automatically decrypted as it is
|
3458
|
+
# read. These processes are handled transparently by Amazon FSx.
|
3459
|
+
#
|
3426
3460
|
#
|
3427
3461
|
#
|
3428
3462
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
@@ -3689,6 +3723,12 @@ module Aws::S3
|
|
3689
3723
|
# @!attribute [rw] server_side_encryption
|
3690
3724
|
# The server-side encryption algorithm used when you store objects in
|
3691
3725
|
# the directory bucket.
|
3726
|
+
#
|
3727
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
3728
|
+
# access points, the only valid server side encryption option is
|
3729
|
+
# `aws:fsx`.
|
3730
|
+
#
|
3731
|
+
# </note>
|
3692
3732
|
# @return [String]
|
3693
3733
|
#
|
3694
3734
|
# @!attribute [rw] ssekms_key_id
|
@@ -3753,6 +3793,14 @@ module Aws::S3
|
|
3753
3793
|
# SSE-S3. For more information, see [Protecting data with server-side
|
3754
3794
|
# encryption][1] in the *Amazon S3 User Guide*.
|
3755
3795
|
#
|
3796
|
+
# <b>S3 access points for Amazon FSx </b> - When accessing data stored
|
3797
|
+
# in Amazon FSx file systems using S3 access points, the only valid
|
3798
|
+
# server side encryption option is `aws:fsx`. All Amazon FSx file
|
3799
|
+
# systems have encryption configured by default and are encrypted at
|
3800
|
+
# rest. Data is automatically encrypted before being written to the
|
3801
|
+
# file system, and automatically decrypted as it is read. These
|
3802
|
+
# processes are handled transparently by Amazon FSx.
|
3803
|
+
#
|
3756
3804
|
#
|
3757
3805
|
#
|
3758
3806
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html
|
@@ -4000,11 +4048,19 @@ module Aws::S3
|
|
4000
4048
|
# The ID used to identify the S3 Intelligent-Tiering configuration.
|
4001
4049
|
# @return [String]
|
4002
4050
|
#
|
4051
|
+
# @!attribute [rw] expected_bucket_owner
|
4052
|
+
# The account ID of the expected bucket owner. If the account ID that
|
4053
|
+
# you provide does not match the actual owner of the bucket, the
|
4054
|
+
# request fails with the HTTP status code `403 Forbidden` (access
|
4055
|
+
# denied).
|
4056
|
+
# @return [String]
|
4057
|
+
#
|
4003
4058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfigurationRequest AWS API Documentation
|
4004
4059
|
#
|
4005
4060
|
class DeleteBucketIntelligentTieringConfigurationRequest < Struct.new(
|
4006
4061
|
:bucket,
|
4007
|
-
:id
|
4062
|
+
:id,
|
4063
|
+
:expected_bucket_owner)
|
4008
4064
|
SENSITIVE = []
|
4009
4065
|
include Aws::Structure
|
4010
4066
|
end
|
@@ -6292,11 +6348,19 @@ module Aws::S3
|
|
6292
6348
|
# The ID used to identify the S3 Intelligent-Tiering configuration.
|
6293
6349
|
# @return [String]
|
6294
6350
|
#
|
6351
|
+
# @!attribute [rw] expected_bucket_owner
|
6352
|
+
# The account ID of the expected bucket owner. If the account ID that
|
6353
|
+
# you provide does not match the actual owner of the bucket, the
|
6354
|
+
# request fails with the HTTP status code `403 Forbidden` (access
|
6355
|
+
# denied).
|
6356
|
+
# @return [String]
|
6357
|
+
#
|
6295
6358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfigurationRequest AWS API Documentation
|
6296
6359
|
#
|
6297
6360
|
class GetBucketIntelligentTieringConfigurationRequest < Struct.new(
|
6298
6361
|
:bucket,
|
6299
|
-
:id
|
6362
|
+
:id,
|
6363
|
+
:expected_bucket_owner)
|
6300
6364
|
SENSITIVE = []
|
6301
6365
|
include Aws::Structure
|
6302
6366
|
end
|
@@ -7222,15 +7286,15 @@ module Aws::S3
|
|
7222
7286
|
# A container for elements related to a particular part. A response
|
7223
7287
|
# can contain zero or more `Parts` elements.
|
7224
7288
|
#
|
7225
|
-
# <note markdown="1"> * **General purpose buckets** - For `GetObjectAttributes`, if
|
7289
|
+
# <note markdown="1"> * **General purpose buckets** - For `GetObjectAttributes`, if an
|
7226
7290
|
# additional checksum (including `x-amz-checksum-crc32`,
|
7227
7291
|
# `x-amz-checksum-crc32c`, `x-amz-checksum-sha1`, or
|
7228
7292
|
# `x-amz-checksum-sha256`) isn't applied to the object specified in
|
7229
|
-
# the request, the response doesn't return `Part
|
7293
|
+
# the request, the response doesn't return the `Part` element.
|
7230
7294
|
#
|
7231
|
-
# * **Directory buckets** - For `GetObjectAttributes`,
|
7232
|
-
# whether
|
7233
|
-
# in the request, the response returns `Part
|
7295
|
+
# * **Directory buckets** - For `GetObjectAttributes`, regardless of
|
7296
|
+
# whether an additional checksum is applied to the object specified
|
7297
|
+
# in the request, the response returns the `Part` element.
|
7234
7298
|
#
|
7235
7299
|
# </note>
|
7236
7300
|
# @return [Array<Types::ObjectPart>]
|
@@ -7747,7 +7811,13 @@ module Aws::S3
|
|
7747
7811
|
#
|
7748
7812
|
# @!attribute [rw] server_side_encryption
|
7749
7813
|
# The server-side encryption algorithm used when you store this object
|
7750
|
-
# in Amazon S3.
|
7814
|
+
# in Amazon S3 or Amazon FSx.
|
7815
|
+
#
|
7816
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
7817
|
+
# access points, the only valid server side encryption option is
|
7818
|
+
# `aws:fsx`.
|
7819
|
+
#
|
7820
|
+
# </note>
|
7751
7821
|
# @return [String]
|
7752
7822
|
#
|
7753
7823
|
# @!attribute [rw] metadata
|
@@ -8995,7 +9065,13 @@ module Aws::S3
|
|
8995
9065
|
#
|
8996
9066
|
# @!attribute [rw] server_side_encryption
|
8997
9067
|
# The server-side encryption algorithm used when you store this object
|
8998
|
-
# in Amazon S3
|
9068
|
+
# in Amazon S3 or Amazon FSx.
|
9069
|
+
#
|
9070
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
9071
|
+
# access points, the only valid server side encryption option is
|
9072
|
+
# `aws:fsx`.
|
9073
|
+
#
|
9074
|
+
# </note>
|
8999
9075
|
# @return [String]
|
9000
9076
|
#
|
9001
9077
|
# @!attribute [rw] metadata
|
@@ -9121,6 +9197,22 @@ module Aws::S3
|
|
9121
9197
|
# as a multipart upload.
|
9122
9198
|
# @return [Integer]
|
9123
9199
|
#
|
9200
|
+
# @!attribute [rw] tag_count
|
9201
|
+
# The number of tags, if any, on the object, when you have the
|
9202
|
+
# relevant permission to read object tags.
|
9203
|
+
#
|
9204
|
+
# You can use [GetObjectTagging][1] to retrieve the tag set associated
|
9205
|
+
# with an object.
|
9206
|
+
#
|
9207
|
+
# <note markdown="1"> This functionality is not supported for directory buckets.
|
9208
|
+
#
|
9209
|
+
# </note>
|
9210
|
+
#
|
9211
|
+
#
|
9212
|
+
#
|
9213
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
9214
|
+
# @return [Integer]
|
9215
|
+
#
|
9124
9216
|
# @!attribute [rw] object_lock_mode
|
9125
9217
|
# The Object Lock mode, if any, that's in effect for this object.
|
9126
9218
|
# This header is only returned if the requester has the
|
@@ -9201,6 +9293,7 @@ module Aws::S3
|
|
9201
9293
|
:request_charged,
|
9202
9294
|
:replication_status,
|
9203
9295
|
:parts_count,
|
9296
|
+
:tag_count,
|
9204
9297
|
:object_lock_mode,
|
9205
9298
|
:object_lock_retain_until_date,
|
9206
9299
|
:object_lock_legal_hold_status)
|
@@ -9489,6 +9582,27 @@ module Aws::S3
|
|
9489
9582
|
include Aws::Structure
|
9490
9583
|
end
|
9491
9584
|
|
9585
|
+
# Parameters on this idempotent request are inconsistent with parameters
|
9586
|
+
# used in previous request(s).
|
9587
|
+
#
|
9588
|
+
# For a list of error codes and more information on Amazon S3 errors,
|
9589
|
+
# see [Error codes][1].
|
9590
|
+
#
|
9591
|
+
# <note markdown="1"> Idempotency ensures that an API request completes no more than one
|
9592
|
+
# time. With an idempotent request, if the original request completes
|
9593
|
+
# successfully, any subsequent retries complete successfully without
|
9594
|
+
# performing any further actions.
|
9595
|
+
#
|
9596
|
+
# </note>
|
9597
|
+
#
|
9598
|
+
#
|
9599
|
+
#
|
9600
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
9601
|
+
#
|
9602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IdempotencyParameterMismatch AWS API Documentation
|
9603
|
+
#
|
9604
|
+
class IdempotencyParameterMismatch < Aws::EmptyStructure; end
|
9605
|
+
|
9492
9606
|
# Container for the `Suffix` element.
|
9493
9607
|
#
|
9494
9608
|
# @!attribute [rw] suffix
|
@@ -10076,9 +10190,16 @@ module Aws::S3
|
|
10076
10190
|
# `Filter` is required if the `LifecycleRule` does not contain a
|
10077
10191
|
# `Prefix` element.
|
10078
10192
|
#
|
10193
|
+
# For more information about `Tag` filters, see [Adding filters to
|
10194
|
+
# Lifecycle rules][1] in the *Amazon S3 User Guide*.
|
10195
|
+
#
|
10079
10196
|
# <note markdown="1"> `Tag` filters are not supported for directory buckets.
|
10080
10197
|
#
|
10081
10198
|
# </note>
|
10199
|
+
#
|
10200
|
+
#
|
10201
|
+
#
|
10202
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-filters.html
|
10082
10203
|
# @return [Types::LifecycleRuleFilter]
|
10083
10204
|
#
|
10084
10205
|
# @!attribute [rw] status
|
@@ -10344,11 +10465,19 @@ module Aws::S3
|
|
10344
10465
|
# this request should begin.
|
10345
10466
|
# @return [String]
|
10346
10467
|
#
|
10468
|
+
# @!attribute [rw] expected_bucket_owner
|
10469
|
+
# The account ID of the expected bucket owner. If the account ID that
|
10470
|
+
# you provide does not match the actual owner of the bucket, the
|
10471
|
+
# request fails with the HTTP status code `403 Forbidden` (access
|
10472
|
+
# denied).
|
10473
|
+
# @return [String]
|
10474
|
+
#
|
10347
10475
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurationsRequest AWS API Documentation
|
10348
10476
|
#
|
10349
10477
|
class ListBucketIntelligentTieringConfigurationsRequest < Struct.new(
|
10350
10478
|
:bucket,
|
10351
|
-
:continuation_token
|
10479
|
+
:continuation_token,
|
10480
|
+
:expected_bucket_owner)
|
10352
10481
|
SENSITIVE = []
|
10353
10482
|
include Aws::Structure
|
10354
10483
|
end
|
@@ -11517,8 +11646,7 @@ module Aws::S3
|
|
11517
11646
|
# @!attribute [rw] continuation_token
|
11518
11647
|
# If `ContinuationToken` was sent with the request, it is included in
|
11519
11648
|
# the response. You can use the returned `ContinuationToken` for
|
11520
|
-
# pagination of the list response.
|
11521
|
-
# `ContinuationToken` for pagination of the list results.
|
11649
|
+
# pagination of the list response.
|
11522
11650
|
# @return [String]
|
11523
11651
|
#
|
11524
11652
|
# @!attribute [rw] next_continuation_token
|
@@ -13055,6 +13183,19 @@ module Aws::S3
|
|
13055
13183
|
include Aws::Structure
|
13056
13184
|
end
|
13057
13185
|
|
13186
|
+
# End of support notice: Beginning October 1, 2025, Amazon S3 will stop
|
13187
|
+
# returning `DisplayName`. Update your applications to use canonical IDs
|
13188
|
+
# (unique identifier for Amazon Web Services accounts), Amazon Web
|
13189
|
+
# Services account ID (12 digit identifier) or IAM ARNs (full resource
|
13190
|
+
# naming) as a direct replacement of `DisplayName`.
|
13191
|
+
#
|
13192
|
+
# This change affects the following Amazon Web Services Regions: US
|
13193
|
+
# East
|
13194
|
+
# (N. Virginia) Region, US West (N. California) Region, US West (Oregon)
|
13195
|
+
# Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region,
|
13196
|
+
# Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South
|
13197
|
+
# America (São Paulo) Region.
|
13198
|
+
#
|
13058
13199
|
# Container for the owner's display name and ID.
|
13059
13200
|
#
|
13060
13201
|
# @!attribute [rw] display_name
|
@@ -13736,6 +13877,13 @@ module Aws::S3
|
|
13736
13877
|
# The ID used to identify the S3 Intelligent-Tiering configuration.
|
13737
13878
|
# @return [String]
|
13738
13879
|
#
|
13880
|
+
# @!attribute [rw] expected_bucket_owner
|
13881
|
+
# The account ID of the expected bucket owner. If the account ID that
|
13882
|
+
# you provide does not match the actual owner of the bucket, the
|
13883
|
+
# request fails with the HTTP status code `403 Forbidden` (access
|
13884
|
+
# denied).
|
13885
|
+
# @return [String]
|
13886
|
+
#
|
13739
13887
|
# @!attribute [rw] intelligent_tiering_configuration
|
13740
13888
|
# Container for S3 Intelligent-Tiering configuration.
|
13741
13889
|
# @return [Types::IntelligentTieringConfiguration]
|
@@ -13745,6 +13893,7 @@ module Aws::S3
|
|
13745
13893
|
class PutBucketIntelligentTieringConfigurationRequest < Struct.new(
|
13746
13894
|
:bucket,
|
13747
13895
|
:id,
|
13896
|
+
:expected_bucket_owner,
|
13748
13897
|
:intelligent_tiering_configuration)
|
13749
13898
|
SENSITIVE = []
|
13750
13899
|
include Aws::Structure
|
@@ -15115,7 +15264,13 @@ module Aws::S3
|
|
15115
15264
|
#
|
15116
15265
|
# @!attribute [rw] server_side_encryption
|
15117
15266
|
# The server-side encryption algorithm used when you store this object
|
15118
|
-
# in Amazon S3.
|
15267
|
+
# in Amazon S3 or Amazon FSx.
|
15268
|
+
#
|
15269
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
15270
|
+
# access points, the only valid server side encryption option is
|
15271
|
+
# `aws:fsx`.
|
15272
|
+
#
|
15273
|
+
# </note>
|
15119
15274
|
# @return [String]
|
15120
15275
|
#
|
15121
15276
|
# @!attribute [rw] version_id
|
@@ -15627,8 +15782,7 @@ module Aws::S3
|
|
15627
15782
|
#
|
15628
15783
|
# @!attribute [rw] server_side_encryption
|
15629
15784
|
# The server-side encryption algorithm that was used when you store
|
15630
|
-
# this object in Amazon S3
|
15631
|
-
# `aws:kms:dsse`).
|
15785
|
+
# this object in Amazon S3 or Amazon FSx.
|
15632
15786
|
#
|
15633
15787
|
# * <b>General purpose buckets </b> - You have four mutually exclusive
|
15634
15788
|
# options to protect data using server-side encryption in Amazon S3,
|
@@ -15683,6 +15837,14 @@ module Aws::S3
|
|
15683
15837
|
#
|
15684
15838
|
# </note>
|
15685
15839
|
#
|
15840
|
+
# * <b>S3 access points for Amazon FSx </b> - When accessing data
|
15841
|
+
# stored in Amazon FSx file systems using S3 access points, the only
|
15842
|
+
# valid server side encryption option is `aws:fsx`. All Amazon FSx
|
15843
|
+
# file systems have encryption configured by default and are
|
15844
|
+
# encrypted at rest. Data is automatically encrypted before being
|
15845
|
+
# written to the file system, and automatically decrypted as it is
|
15846
|
+
# read. These processes are handled transparently by Amazon FSx.
|
15847
|
+
#
|
15686
15848
|
#
|
15687
15849
|
#
|
15688
15850
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
@@ -16474,6 +16636,129 @@ module Aws::S3
|
|
16474
16636
|
include Aws::Structure
|
16475
16637
|
end
|
16476
16638
|
|
16639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RenameObjectOutput AWS API Documentation
|
16640
|
+
#
|
16641
|
+
class RenameObjectOutput < Aws::EmptyStructure; end
|
16642
|
+
|
16643
|
+
# @!attribute [rw] bucket
|
16644
|
+
# The bucket name of the directory bucket containing the object.
|
16645
|
+
#
|
16646
|
+
# You must use virtual-hosted-style requests in the format
|
16647
|
+
# `Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
16648
|
+
# Path-style requests are not supported. Directory bucket names must
|
16649
|
+
# be unique in the chosen Availability Zone. Bucket names must follow
|
16650
|
+
# the format `bucket-base-name--zone-id--x-s3 ` (for example,
|
16651
|
+
# `amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
16652
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
16653
|
+
# *Amazon S3 User Guide*.
|
16654
|
+
#
|
16655
|
+
#
|
16656
|
+
#
|
16657
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html
|
16658
|
+
# @return [String]
|
16659
|
+
#
|
16660
|
+
# @!attribute [rw] key
|
16661
|
+
# Key name of the object to rename.
|
16662
|
+
# @return [String]
|
16663
|
+
#
|
16664
|
+
# @!attribute [rw] rename_source
|
16665
|
+
# Specifies the source for the rename operation. The value must be URL
|
16666
|
+
# encoded.
|
16667
|
+
# @return [String]
|
16668
|
+
#
|
16669
|
+
# @!attribute [rw] destination_if_match
|
16670
|
+
# Renames the object only if the ETag (entity tag) value provided
|
16671
|
+
# during the operation matches the ETag of the object in S3. The
|
16672
|
+
# `If-Match` header field makes the request method conditional on
|
16673
|
+
# ETags. If the ETag values do not match, the operation returns a `412
|
16674
|
+
# Precondition Failed` error.
|
16675
|
+
#
|
16676
|
+
# Expects the ETag value as a string.
|
16677
|
+
# @return [String]
|
16678
|
+
#
|
16679
|
+
# @!attribute [rw] destination_if_none_match
|
16680
|
+
# Renames the object only if the destination does not already exist in
|
16681
|
+
# the specified directory bucket. If the object does exist when you
|
16682
|
+
# send a request with `If-None-Match:*`, the S3 API will return a `412
|
16683
|
+
# Precondition Failed` error, preventing an overwrite. The
|
16684
|
+
# `If-None-Match` header prevents overwrites of existing data by
|
16685
|
+
# validating that there's not an object with the same key name
|
16686
|
+
# already in your directory bucket.
|
16687
|
+
#
|
16688
|
+
# Expects the `*` character (asterisk).
|
16689
|
+
# @return [String]
|
16690
|
+
#
|
16691
|
+
# @!attribute [rw] destination_if_modified_since
|
16692
|
+
# Renames the object if the destination exists and if it has been
|
16693
|
+
# modified since the specified time.
|
16694
|
+
# @return [Time]
|
16695
|
+
#
|
16696
|
+
# @!attribute [rw] destination_if_unmodified_since
|
16697
|
+
# Renames the object if it hasn't been modified since the specified
|
16698
|
+
# time.
|
16699
|
+
# @return [Time]
|
16700
|
+
#
|
16701
|
+
# @!attribute [rw] source_if_match
|
16702
|
+
# Renames the object if the source exists and if its entity tag (ETag)
|
16703
|
+
# matches the specified ETag.
|
16704
|
+
# @return [String]
|
16705
|
+
#
|
16706
|
+
# @!attribute [rw] source_if_none_match
|
16707
|
+
# Renames the object if the source exists and if its entity tag (ETag)
|
16708
|
+
# is different than the specified ETag. If an asterisk (`*`) character
|
16709
|
+
# is provided, the operation will fail and return a `412 Precondition
|
16710
|
+
# Failed` error.
|
16711
|
+
# @return [String]
|
16712
|
+
#
|
16713
|
+
# @!attribute [rw] source_if_modified_since
|
16714
|
+
# Renames the object if the source exists and if it has been modified
|
16715
|
+
# since the specified time.
|
16716
|
+
# @return [Time]
|
16717
|
+
#
|
16718
|
+
# @!attribute [rw] source_if_unmodified_since
|
16719
|
+
# Renames the object if the source exists and hasn't been modified
|
16720
|
+
# since the specified time.
|
16721
|
+
# @return [Time]
|
16722
|
+
#
|
16723
|
+
# @!attribute [rw] client_token
|
16724
|
+
# A unique string with a max of 64 ASCII characters in the ASCII range
|
16725
|
+
# of 33 - 126.
|
16726
|
+
#
|
16727
|
+
# <note markdown="1"> `RenameObject` supports idempotency using a client token. To make an
|
16728
|
+
# idempotent API request using `RenameObject`, specify a client token
|
16729
|
+
# in the request. You should not reuse the same client token for other
|
16730
|
+
# API requests. If you retry a request that completed successfully
|
16731
|
+
# using the same client token and the same parameters, the retry
|
16732
|
+
# succeeds without performing any further actions. If you retry a
|
16733
|
+
# successful request using the same client token, but one or more of
|
16734
|
+
# the parameters are different, the retry fails and an
|
16735
|
+
# `IdempotentParameterMismatch` error is returned.
|
16736
|
+
#
|
16737
|
+
# </note>
|
16738
|
+
#
|
16739
|
+
# **A suitable default value is auto-generated.** You should normally
|
16740
|
+
# not need to pass this option.
|
16741
|
+
# @return [String]
|
16742
|
+
#
|
16743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RenameObjectRequest AWS API Documentation
|
16744
|
+
#
|
16745
|
+
class RenameObjectRequest < Struct.new(
|
16746
|
+
:bucket,
|
16747
|
+
:key,
|
16748
|
+
:rename_source,
|
16749
|
+
:destination_if_match,
|
16750
|
+
:destination_if_none_match,
|
16751
|
+
:destination_if_modified_since,
|
16752
|
+
:destination_if_unmodified_since,
|
16753
|
+
:source_if_match,
|
16754
|
+
:source_if_none_match,
|
16755
|
+
:source_if_modified_since,
|
16756
|
+
:source_if_unmodified_since,
|
16757
|
+
:client_token)
|
16758
|
+
SENSITIVE = []
|
16759
|
+
include Aws::Structure
|
16760
|
+
end
|
16761
|
+
|
16477
16762
|
# A filter that you can specify for selection for modifications on
|
16478
16763
|
# replicas. Amazon S3 doesn't replicate replica modifications by
|
16479
16764
|
# default. In the latest version of replication configuration (when
|
@@ -18189,7 +18474,13 @@ module Aws::S3
|
|
18189
18474
|
#
|
18190
18475
|
# @!attribute [rw] server_side_encryption
|
18191
18476
|
# The server-side encryption algorithm used when you store this object
|
18192
|
-
# in Amazon S3
|
18477
|
+
# in Amazon S3 or Amazon FSx.
|
18478
|
+
#
|
18479
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
18480
|
+
# access points, the only valid server side encryption option is
|
18481
|
+
# `aws:fsx`.
|
18482
|
+
#
|
18483
|
+
# </note>
|
18193
18484
|
# @return [String]
|
18194
18485
|
#
|
18195
18486
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -18587,7 +18878,13 @@ module Aws::S3
|
|
18587
18878
|
|
18588
18879
|
# @!attribute [rw] server_side_encryption
|
18589
18880
|
# The server-side encryption algorithm used when you store this object
|
18590
|
-
# in Amazon S3
|
18881
|
+
# in Amazon S3 or Amazon FSx.
|
18882
|
+
#
|
18883
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
18884
|
+
# access points, the only valid server side encryption option is
|
18885
|
+
# `aws:fsx`.
|
18886
|
+
#
|
18887
|
+
# </note>
|
18591
18888
|
# @return [String]
|
18592
18889
|
#
|
18593
18890
|
# @!attribute [rw] etag
|
@@ -19320,7 +19617,13 @@ module Aws::S3
|
|
19320
19617
|
#
|
19321
19618
|
# @!attribute [rw] server_side_encryption
|
19322
19619
|
# The server-side encryption algorithm used when storing requested
|
19323
|
-
# object in Amazon S3
|
19620
|
+
# object in Amazon S3 or Amazon FSx.
|
19621
|
+
#
|
19622
|
+
# <note markdown="1"> When accessing data stored in Amazon FSx file systems using S3
|
19623
|
+
# access points, the only valid server side encryption option is
|
19624
|
+
# `aws:fsx`.
|
19625
|
+
#
|
19626
|
+
# </note>
|
19324
19627
|
# @return [String]
|
19325
19628
|
#
|
19326
19629
|
# @!attribute [rw] sse_customer_algorithm
|
data/lib/aws-sdk-s3.rb
CHANGED
data/sig/bucket.rbs
CHANGED
@@ -123,8 +123,8 @@ module Aws
|
|
123
123
|
key: ::String,
|
124
124
|
?write_offset_bytes: ::Integer,
|
125
125
|
?metadata: Hash[::String, ::String],
|
126
|
-
?server_side_encryption: ("AES256" | "aws:kms" | "aws:kms:dsse"),
|
127
|
-
?storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE"),
|
126
|
+
?server_side_encryption: ("AES256" | "aws:fsx" | "aws:kms" | "aws:kms:dsse"),
|
127
|
+
?storage_class: ("STANDARD" | "REDUCED_REDUNDANCY" | "STANDARD_IA" | "ONEZONE_IA" | "INTELLIGENT_TIERING" | "GLACIER" | "DEEP_ARCHIVE" | "OUTPOSTS" | "GLACIER_IR" | "SNOW" | "EXPRESS_ONEZONE" | "FSX_OPENZFS"),
|
128
128
|
?website_redirect_location: ::String,
|
129
129
|
?sse_customer_algorithm: ::String,
|
130
130
|
?sse_customer_key: ::String,
|