aws-sdk-s3 1.122.0 → 1.136.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +94 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +108 -49
- data/lib/aws-sdk-s3/bucket_acl.rb +9 -3
- data/lib/aws-sdk-s3/bucket_cors.rb +12 -4
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +12 -4
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +12 -4
- data/lib/aws-sdk-s3/bucket_logging.rb +9 -3
- data/lib/aws-sdk-s3/bucket_notification.rb +9 -3
- data/lib/aws-sdk-s3/bucket_policy.rb +12 -4
- data/lib/aws-sdk-s3/bucket_request_payment.rb +9 -3
- data/lib/aws-sdk-s3/bucket_tagging.rb +12 -4
- data/lib/aws-sdk-s3/bucket_versioning.rb +15 -5
- data/lib/aws-sdk-s3/bucket_website.rb +12 -4
- data/lib/aws-sdk-s3/client.rb +727 -626
- data/lib/aws-sdk-s3/client_api.rb +24 -0
- data/lib/aws-sdk-s3/customizations/bucket.rb +3 -1
- data/lib/aws-sdk-s3/customizations/errors.rb +1 -1
- data/lib/aws-sdk-s3/customizations/object.rb +91 -18
- data/lib/aws-sdk-s3/encryption/client.rb +6 -2
- data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +13 -9
- data/lib/aws-sdk-s3/encryptionV2/client.rb +6 -2
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +1 -0
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +10 -6
- data/lib/aws-sdk-s3/endpoint_parameters.rb +4 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +22 -246
- data/lib/aws-sdk-s3/endpoints.rb +1 -0
- data/lib/aws-sdk-s3/file_downloader.rb +170 -44
- data/lib/aws-sdk-s3/file_uploader.rb +8 -6
- data/lib/aws-sdk-s3/multipart_stream_uploader.rb +5 -3
- data/lib/aws-sdk-s3/multipart_upload.rb +27 -13
- data/lib/aws-sdk-s3/multipart_upload_part.rb +19 -9
- data/lib/aws-sdk-s3/object.rb +125 -84
- data/lib/aws-sdk-s3/object_acl.rb +14 -6
- data/lib/aws-sdk-s3/object_copier.rb +7 -5
- data/lib/aws-sdk-s3/object_multipart_copier.rb +33 -17
- data/lib/aws-sdk-s3/object_summary.rb +123 -74
- data/lib/aws-sdk-s3/object_version.rb +49 -17
- data/lib/aws-sdk-s3/presigned_post.rb +52 -43
- data/lib/aws-sdk-s3/presigner.rb +4 -2
- data/lib/aws-sdk-s3/resource.rb +7 -3
- data/lib/aws-sdk-s3/types.rb +529 -299
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +6 -6
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -65,7 +65,7 @@ module Aws::S3
|
|
65
65
|
# When you use this action with S3 on Outposts through the Amazon Web
|
66
66
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
67
67
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
68
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
68
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
69
69
|
#
|
70
70
|
#
|
71
71
|
#
|
@@ -84,9 +84,11 @@ module Aws::S3
|
|
84
84
|
# @!attribute [rw] request_payer
|
85
85
|
# Confirms that the requester knows that they will be charged for the
|
86
86
|
# request. Bucket owners need not specify this parameter in their
|
87
|
-
# requests.
|
88
|
-
# Pays
|
89
|
-
#
|
87
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
88
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
89
|
+
# charges to copy the object. For information about downloading
|
90
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
91
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
90
92
|
#
|
91
93
|
#
|
92
94
|
#
|
@@ -718,7 +720,7 @@ module Aws::S3
|
|
718
720
|
# When you use this action with S3 on Outposts through the Amazon Web
|
719
721
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
720
722
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
721
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
723
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
722
724
|
#
|
723
725
|
#
|
724
726
|
#
|
@@ -806,7 +808,7 @@ module Aws::S3
|
|
806
808
|
#
|
807
809
|
# @!attribute [rw] server_side_encryption
|
808
810
|
# The server-side encryption algorithm used when storing this object
|
809
|
-
# in Amazon S3 (for example, AES256
|
811
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
810
812
|
# @return [String]
|
811
813
|
#
|
812
814
|
# @!attribute [rw] version_id
|
@@ -815,14 +817,15 @@ module Aws::S3
|
|
815
817
|
# @return [String]
|
816
818
|
#
|
817
819
|
# @!attribute [rw] ssekms_key_id
|
818
|
-
# If present, specifies the ID of the
|
819
|
-
#
|
820
|
-
#
|
820
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
821
|
+
# symmetric encryption customer managed key that was used for the
|
822
|
+
# object.
|
821
823
|
# @return [String]
|
822
824
|
#
|
823
825
|
# @!attribute [rw] bucket_key_enabled
|
824
826
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
825
|
-
# server-side encryption with
|
827
|
+
# server-side encryption with Key Management Service (KMS) keys
|
828
|
+
# (SSE-KMS).
|
826
829
|
# @return [Boolean]
|
827
830
|
#
|
828
831
|
# @!attribute [rw] request_charged
|
@@ -870,7 +873,7 @@ module Aws::S3
|
|
870
873
|
# When you use this action with S3 on Outposts through the Amazon Web
|
871
874
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
872
875
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
873
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
876
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
874
877
|
#
|
875
878
|
#
|
876
879
|
#
|
@@ -941,9 +944,11 @@ module Aws::S3
|
|
941
944
|
# @!attribute [rw] request_payer
|
942
945
|
# Confirms that the requester knows that they will be charged for the
|
943
946
|
# request. Bucket owners need not specify this parameter in their
|
944
|
-
# requests.
|
945
|
-
# Pays
|
946
|
-
#
|
947
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
948
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
949
|
+
# charges to copy the object. For information about downloading
|
950
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
951
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
947
952
|
#
|
948
953
|
#
|
949
954
|
#
|
@@ -1172,7 +1177,7 @@ module Aws::S3
|
|
1172
1177
|
#
|
1173
1178
|
# @!attribute [rw] server_side_encryption
|
1174
1179
|
# The server-side encryption algorithm used when storing this object
|
1175
|
-
# in Amazon S3 (for example, AES256
|
1180
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1176
1181
|
# @return [String]
|
1177
1182
|
#
|
1178
1183
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1189,9 +1194,9 @@ module Aws::S3
|
|
1189
1194
|
# @return [String]
|
1190
1195
|
#
|
1191
1196
|
# @!attribute [rw] ssekms_key_id
|
1192
|
-
# If present, specifies the ID of the
|
1193
|
-
#
|
1194
|
-
#
|
1197
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1198
|
+
# symmetric encryption customer managed key that was used for the
|
1199
|
+
# object.
|
1195
1200
|
# @return [String]
|
1196
1201
|
#
|
1197
1202
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1203,7 +1208,8 @@ module Aws::S3
|
|
1203
1208
|
#
|
1204
1209
|
# @!attribute [rw] bucket_key_enabled
|
1205
1210
|
# Indicates whether the copied object uses an S3 Bucket Key for
|
1206
|
-
# server-side encryption with
|
1211
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1212
|
+
# (SSE-KMS).
|
1207
1213
|
# @return [Boolean]
|
1208
1214
|
#
|
1209
1215
|
# @!attribute [rw] request_charged
|
@@ -1254,7 +1260,7 @@ module Aws::S3
|
|
1254
1260
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1255
1261
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1256
1262
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1257
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1263
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1258
1264
|
#
|
1259
1265
|
#
|
1260
1266
|
#
|
@@ -1410,15 +1416,16 @@ module Aws::S3
|
|
1410
1416
|
#
|
1411
1417
|
# @!attribute [rw] server_side_encryption
|
1412
1418
|
# The server-side encryption algorithm used when storing this object
|
1413
|
-
# in Amazon S3 (for example, AES256
|
1419
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1414
1420
|
# @return [String]
|
1415
1421
|
#
|
1416
1422
|
# @!attribute [rw] storage_class
|
1417
|
-
#
|
1418
|
-
#
|
1419
|
-
#
|
1420
|
-
#
|
1421
|
-
#
|
1423
|
+
# If the `x-amz-storage-class` header is not used, the copied object
|
1424
|
+
# will be stored in the STANDARD Storage Class by default. The
|
1425
|
+
# STANDARD storage class provides high durability and high
|
1426
|
+
# availability. Depending on performance needs, you can specify a
|
1427
|
+
# different Storage Class. Amazon S3 on Outposts only uses the
|
1428
|
+
# OUTPOSTS Storage Class. For more information, see [Storage
|
1422
1429
|
# Classes][1] in the *Amazon S3 User Guide*.
|
1423
1430
|
#
|
1424
1431
|
#
|
@@ -1455,13 +1462,13 @@ module Aws::S3
|
|
1455
1462
|
# @return [String]
|
1456
1463
|
#
|
1457
1464
|
# @!attribute [rw] ssekms_key_id
|
1458
|
-
# Specifies the
|
1459
|
-
# encryption. All GET and PUT requests for an object protected
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1463
|
-
#
|
1464
|
-
#
|
1465
|
+
# Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for
|
1466
|
+
# object encryption. All GET and PUT requests for an object protected
|
1467
|
+
# by KMS will fail if they're not made via SSL or using SigV4. For
|
1468
|
+
# information about configuring any of the officially supported Amazon
|
1469
|
+
# Web Services SDKs and Amazon Web Services CLI, see [Specifying the
|
1470
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1471
|
+
# User Guide*.
|
1465
1472
|
#
|
1466
1473
|
#
|
1467
1474
|
#
|
@@ -1477,9 +1484,9 @@ module Aws::S3
|
|
1477
1484
|
#
|
1478
1485
|
# @!attribute [rw] bucket_key_enabled
|
1479
1486
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
1480
|
-
# encryption with server-side encryption using
|
1481
|
-
# Setting this header to `true` causes Amazon S3
|
1482
|
-
# Key for object encryption with SSE-KMS.
|
1487
|
+
# encryption with server-side encryption using Key Management Service
|
1488
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
1489
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
1483
1490
|
#
|
1484
1491
|
# Specifying this header with a COPY action doesn’t affect
|
1485
1492
|
# bucket-level settings for S3 Bucket Key.
|
@@ -1505,9 +1512,11 @@ module Aws::S3
|
|
1505
1512
|
# @!attribute [rw] request_payer
|
1506
1513
|
# Confirms that the requester knows that they will be charged for the
|
1507
1514
|
# request. Bucket owners need not specify this parameter in their
|
1508
|
-
# requests.
|
1509
|
-
# Pays
|
1510
|
-
#
|
1515
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
1516
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
1517
|
+
# charges to copy the object. For information about downloading
|
1518
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
1519
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
1511
1520
|
#
|
1512
1521
|
#
|
1513
1522
|
#
|
@@ -1894,7 +1903,7 @@ module Aws::S3
|
|
1894
1903
|
# When you use this action with S3 on Outposts through the Amazon Web
|
1895
1904
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
1896
1905
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1897
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
1906
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1898
1907
|
#
|
1899
1908
|
#
|
1900
1909
|
#
|
@@ -1912,7 +1921,7 @@ module Aws::S3
|
|
1912
1921
|
#
|
1913
1922
|
# @!attribute [rw] server_side_encryption
|
1914
1923
|
# The server-side encryption algorithm used when storing this object
|
1915
|
-
# in Amazon S3 (for example, AES256
|
1924
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
1916
1925
|
# @return [String]
|
1917
1926
|
#
|
1918
1927
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1929,9 +1938,9 @@ module Aws::S3
|
|
1929
1938
|
# @return [String]
|
1930
1939
|
#
|
1931
1940
|
# @!attribute [rw] ssekms_key_id
|
1932
|
-
# If present, specifies the ID of the
|
1933
|
-
#
|
1934
|
-
#
|
1941
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1942
|
+
# symmetric encryption customer managed key that was used for the
|
1943
|
+
# object.
|
1935
1944
|
# @return [String]
|
1936
1945
|
#
|
1937
1946
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1943,7 +1952,8 @@ module Aws::S3
|
|
1943
1952
|
#
|
1944
1953
|
# @!attribute [rw] bucket_key_enabled
|
1945
1954
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
1946
|
-
# server-side encryption with
|
1955
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1956
|
+
# (SSE-KMS).
|
1947
1957
|
# @return [Boolean]
|
1948
1958
|
#
|
1949
1959
|
# @!attribute [rw] request_charged
|
@@ -2000,7 +2010,7 @@ module Aws::S3
|
|
2000
2010
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2001
2011
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2002
2012
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2003
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2013
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2004
2014
|
#
|
2005
2015
|
#
|
2006
2016
|
#
|
@@ -2069,7 +2079,7 @@ module Aws::S3
|
|
2069
2079
|
#
|
2070
2080
|
# @!attribute [rw] server_side_encryption
|
2071
2081
|
# The server-side encryption algorithm used when storing this object
|
2072
|
-
# in Amazon S3 (for example, AES256
|
2082
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
2073
2083
|
# @return [String]
|
2074
2084
|
#
|
2075
2085
|
# @!attribute [rw] storage_class
|
@@ -2112,13 +2122,13 @@ module Aws::S3
|
|
2112
2122
|
# @return [String]
|
2113
2123
|
#
|
2114
2124
|
# @!attribute [rw] ssekms_key_id
|
2115
|
-
# Specifies the ID
|
2116
|
-
# use for object encryption. All
|
2117
|
-
#
|
2118
|
-
# or using SigV4. For information about
|
2119
|
-
# officially supported Amazon Web Services SDKs
|
2120
|
-
# Services CLI, see [Specifying the Signature Version
|
2121
|
-
# Authentication][1] in the *Amazon S3 User Guide*.
|
2125
|
+
# Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric
|
2126
|
+
# encryption customer managed key to use for object encryption. All
|
2127
|
+
# GET and PUT requests for an object protected by KMS will fail if
|
2128
|
+
# they're not made via SSL or using SigV4. For information about
|
2129
|
+
# configuring any of the officially supported Amazon Web Services SDKs
|
2130
|
+
# and Amazon Web Services CLI, see [Specifying the Signature Version
|
2131
|
+
# in Request Authentication][1] in the *Amazon S3 User Guide*.
|
2122
2132
|
#
|
2123
2133
|
#
|
2124
2134
|
#
|
@@ -2134,9 +2144,9 @@ module Aws::S3
|
|
2134
2144
|
#
|
2135
2145
|
# @!attribute [rw] bucket_key_enabled
|
2136
2146
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
2137
|
-
# encryption with server-side encryption using
|
2138
|
-
# Setting this header to `true` causes Amazon S3
|
2139
|
-
# Key for object encryption with SSE-KMS.
|
2147
|
+
# encryption with server-side encryption using Key Management Service
|
2148
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
2149
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
2140
2150
|
#
|
2141
2151
|
# Specifying this header with an object action doesn’t affect
|
2142
2152
|
# bucket-level settings for S3 Bucket Key.
|
@@ -2145,9 +2155,11 @@ module Aws::S3
|
|
2145
2155
|
# @!attribute [rw] request_payer
|
2146
2156
|
# Confirms that the requester knows that they will be charged for the
|
2147
2157
|
# request. Bucket owners need not specify this parameter in their
|
2148
|
-
# requests.
|
2149
|
-
# Pays
|
2150
|
-
#
|
2158
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2159
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2160
|
+
# charges to copy the object. For information about downloading
|
2161
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2162
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2151
2163
|
#
|
2152
2164
|
#
|
2153
2165
|
#
|
@@ -2266,7 +2278,7 @@ module Aws::S3
|
|
2266
2278
|
# Container for the objects to delete.
|
2267
2279
|
#
|
2268
2280
|
# @!attribute [rw] objects
|
2269
|
-
# The
|
2281
|
+
# The object to delete.
|
2270
2282
|
# @return [Array<Types::ObjectIdentifier>]
|
2271
2283
|
#
|
2272
2284
|
# @!attribute [rw] quiet
|
@@ -2626,8 +2638,10 @@ module Aws::S3
|
|
2626
2638
|
end
|
2627
2639
|
|
2628
2640
|
# @!attribute [rw] delete_marker
|
2629
|
-
#
|
2630
|
-
# was (true) or was not (false) a delete marker
|
2641
|
+
# Indicates whether the specified object version that was permanently
|
2642
|
+
# deleted was (true) or was not (false) a delete marker before
|
2643
|
+
# deletion. In a simple DELETE, this header indicates whether (true)
|
2644
|
+
# or not (false) the current version of the object is a delete marker.
|
2631
2645
|
# @return [Boolean]
|
2632
2646
|
#
|
2633
2647
|
# @!attribute [rw] version_id
|
@@ -2669,7 +2683,7 @@ module Aws::S3
|
|
2669
2683
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2670
2684
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2671
2685
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2672
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2686
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2673
2687
|
#
|
2674
2688
|
#
|
2675
2689
|
#
|
@@ -2695,9 +2709,11 @@ module Aws::S3
|
|
2695
2709
|
# @!attribute [rw] request_payer
|
2696
2710
|
# Confirms that the requester knows that they will be charged for the
|
2697
2711
|
# request. Bucket owners need not specify this parameter in their
|
2698
|
-
# requests.
|
2699
|
-
# Pays
|
2700
|
-
#
|
2712
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2713
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2714
|
+
# charges to copy the object. For information about downloading
|
2715
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2716
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2701
2717
|
#
|
2702
2718
|
#
|
2703
2719
|
#
|
@@ -2762,7 +2778,7 @@ module Aws::S3
|
|
2762
2778
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2763
2779
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2764
2780
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2765
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2781
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2766
2782
|
#
|
2767
2783
|
#
|
2768
2784
|
#
|
@@ -2840,7 +2856,7 @@ module Aws::S3
|
|
2840
2856
|
# When you use this action with S3 on Outposts through the Amazon Web
|
2841
2857
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
2842
2858
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2843
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
2859
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2844
2860
|
#
|
2845
2861
|
#
|
2846
2862
|
#
|
@@ -2862,9 +2878,11 @@ module Aws::S3
|
|
2862
2878
|
# @!attribute [rw] request_payer
|
2863
2879
|
# Confirms that the requester knows that they will be charged for the
|
2864
2880
|
# request. Bucket owners need not specify this parameter in their
|
2865
|
-
# requests.
|
2866
|
-
# Pays
|
2867
|
-
#
|
2881
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2882
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2883
|
+
# charges to copy the object. For information about downloading
|
2884
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2885
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2868
2886
|
#
|
2869
2887
|
#
|
2870
2888
|
#
|
@@ -2948,10 +2966,10 @@ module Aws::S3
|
|
2948
2966
|
# @return [String]
|
2949
2967
|
#
|
2950
2968
|
# @!attribute [rw] delete_marker
|
2951
|
-
#
|
2952
|
-
# was (true) or was not (false) a delete marker
|
2953
|
-
# this header indicates whether (true)
|
2954
|
-
#
|
2969
|
+
# Indicates whether the specified object version that was permanently
|
2970
|
+
# deleted was (true) or was not (false) a delete marker before
|
2971
|
+
# deletion. In a simple DELETE, this header indicates whether (true)
|
2972
|
+
# or not (false) the current version of the object is a delete marker.
|
2955
2973
|
# @return [Boolean]
|
2956
2974
|
#
|
2957
2975
|
# @!attribute [rw] delete_marker_version_id
|
@@ -3061,8 +3079,8 @@ module Aws::S3
|
|
3061
3079
|
# the ID of the symmetric encryption customer managed key to use for
|
3062
3080
|
# encryption of job results. Amazon S3 only supports symmetric
|
3063
3081
|
# encryption KMS keys. For more information, see [Asymmetric keys in
|
3064
|
-
#
|
3065
|
-
#
|
3082
|
+
# KMS][1] in the *Amazon Web Services Key Management Service Developer
|
3083
|
+
# Guide*.
|
3066
3084
|
#
|
3067
3085
|
#
|
3068
3086
|
#
|
@@ -4040,10 +4058,16 @@ module Aws::S3
|
|
4040
4058
|
# The accelerate configuration of the bucket.
|
4041
4059
|
# @return [String]
|
4042
4060
|
#
|
4061
|
+
# @!attribute [rw] request_charged
|
4062
|
+
# If present, indicates that the requester was successfully charged
|
4063
|
+
# for the request.
|
4064
|
+
# @return [String]
|
4065
|
+
#
|
4043
4066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationOutput AWS API Documentation
|
4044
4067
|
#
|
4045
4068
|
class GetBucketAccelerateConfigurationOutput < Struct.new(
|
4046
|
-
:status
|
4069
|
+
:status,
|
4070
|
+
:request_charged)
|
4047
4071
|
SENSITIVE = []
|
4048
4072
|
include Aws::Structure
|
4049
4073
|
end
|
@@ -4059,11 +4083,26 @@ module Aws::S3
|
|
4059
4083
|
# `403 Forbidden` (access denied).
|
4060
4084
|
# @return [String]
|
4061
4085
|
#
|
4086
|
+
# @!attribute [rw] request_payer
|
4087
|
+
# Confirms that the requester knows that they will be charged for the
|
4088
|
+
# request. Bucket owners need not specify this parameter in their
|
4089
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
4090
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
4091
|
+
# charges to copy the object. For information about downloading
|
4092
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
4093
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
4094
|
+
#
|
4095
|
+
#
|
4096
|
+
#
|
4097
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4098
|
+
# @return [String]
|
4099
|
+
#
|
4062
4100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationRequest AWS API Documentation
|
4063
4101
|
#
|
4064
4102
|
class GetBucketAccelerateConfigurationRequest < Struct.new(
|
4065
4103
|
:bucket,
|
4066
|
-
:expected_bucket_owner
|
4104
|
+
:expected_bucket_owner,
|
4105
|
+
:request_payer)
|
4067
4106
|
SENSITIVE = []
|
4068
4107
|
include Aws::Structure
|
4069
4108
|
end
|
@@ -4870,9 +4909,11 @@ module Aws::S3
|
|
4870
4909
|
# @!attribute [rw] request_payer
|
4871
4910
|
# Confirms that the requester knows that they will be charged for the
|
4872
4911
|
# request. Bucket owners need not specify this parameter in their
|
4873
|
-
# requests.
|
4874
|
-
# Pays
|
4875
|
-
#
|
4912
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
4913
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
4914
|
+
# charges to copy the object. For information about downloading
|
4915
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
4916
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
4876
4917
|
#
|
4877
4918
|
#
|
4878
4919
|
#
|
@@ -5025,7 +5066,7 @@ module Aws::S3
|
|
5025
5066
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5026
5067
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5027
5068
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5028
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5069
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5029
5070
|
#
|
5030
5071
|
#
|
5031
5072
|
#
|
@@ -5072,9 +5113,11 @@ module Aws::S3
|
|
5072
5113
|
# @!attribute [rw] request_payer
|
5073
5114
|
# Confirms that the requester knows that they will be charged for the
|
5074
5115
|
# request. Bucket owners need not specify this parameter in their
|
5075
|
-
# requests.
|
5076
|
-
# Pays
|
5077
|
-
#
|
5116
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5117
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5118
|
+
# charges to copy the object. For information about downloading
|
5119
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5120
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5078
5121
|
#
|
5079
5122
|
#
|
5080
5123
|
#
|
@@ -5088,9 +5131,8 @@ module Aws::S3
|
|
5088
5131
|
# @return [String]
|
5089
5132
|
#
|
5090
5133
|
# @!attribute [rw] object_attributes
|
5091
|
-
#
|
5092
|
-
#
|
5093
|
-
# not returned.
|
5134
|
+
# Specifies the fields at the root level that you want returned in the
|
5135
|
+
# response. Fields that you do not specify are not returned.
|
5094
5136
|
# @return [Array<String>]
|
5095
5137
|
#
|
5096
5138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation
|
@@ -5154,9 +5196,11 @@ module Aws::S3
|
|
5154
5196
|
# @!attribute [rw] request_payer
|
5155
5197
|
# Confirms that the requester knows that they will be charged for the
|
5156
5198
|
# request. Bucket owners need not specify this parameter in their
|
5157
|
-
# requests.
|
5158
|
-
# Pays
|
5159
|
-
#
|
5199
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5200
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5201
|
+
# charges to copy the object. For information about downloading
|
5202
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5203
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5160
5204
|
#
|
5161
5205
|
#
|
5162
5206
|
#
|
@@ -5370,7 +5414,7 @@ module Aws::S3
|
|
5370
5414
|
#
|
5371
5415
|
# @!attribute [rw] server_side_encryption
|
5372
5416
|
# The server-side encryption algorithm used when storing this object
|
5373
|
-
# in Amazon S3 (for example, AES256
|
5417
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
5374
5418
|
# @return [String]
|
5375
5419
|
#
|
5376
5420
|
# @!attribute [rw] metadata
|
@@ -5391,14 +5435,14 @@ module Aws::S3
|
|
5391
5435
|
# @return [String]
|
5392
5436
|
#
|
5393
5437
|
# @!attribute [rw] ssekms_key_id
|
5394
|
-
# If present, specifies the ID of the
|
5395
|
-
#
|
5396
|
-
#
|
5438
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
5439
|
+
# symmetric encryption customer managed key that was used for the
|
5440
|
+
# object.
|
5397
5441
|
# @return [String]
|
5398
5442
|
#
|
5399
5443
|
# @!attribute [rw] bucket_key_enabled
|
5400
5444
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
5401
|
-
# encryption with
|
5445
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
5402
5446
|
# @return [Boolean]
|
5403
5447
|
#
|
5404
5448
|
# @!attribute [rw] storage_class
|
@@ -5507,7 +5551,7 @@ module Aws::S3
|
|
5507
5551
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5508
5552
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5509
5553
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5510
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5554
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5511
5555
|
#
|
5512
5556
|
#
|
5513
5557
|
#
|
@@ -5604,9 +5648,11 @@ module Aws::S3
|
|
5604
5648
|
# @!attribute [rw] request_payer
|
5605
5649
|
# Confirms that the requester knows that they will be charged for the
|
5606
5650
|
# request. Bucket owners need not specify this parameter in their
|
5607
|
-
# requests.
|
5608
|
-
# Pays
|
5609
|
-
#
|
5651
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5652
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5653
|
+
# charges to copy the object. For information about downloading
|
5654
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5655
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5610
5656
|
#
|
5611
5657
|
#
|
5612
5658
|
#
|
@@ -5701,9 +5747,11 @@ module Aws::S3
|
|
5701
5747
|
# @!attribute [rw] request_payer
|
5702
5748
|
# Confirms that the requester knows that they will be charged for the
|
5703
5749
|
# request. Bucket owners need not specify this parameter in their
|
5704
|
-
# requests.
|
5705
|
-
# Pays
|
5706
|
-
#
|
5750
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5751
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5752
|
+
# charges to copy the object. For information about downloading
|
5753
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5754
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5707
5755
|
#
|
5708
5756
|
#
|
5709
5757
|
#
|
@@ -5766,7 +5814,7 @@ module Aws::S3
|
|
5766
5814
|
# When you use this action with S3 on Outposts through the Amazon Web
|
5767
5815
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
5768
5816
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5769
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
5817
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5770
5818
|
#
|
5771
5819
|
#
|
5772
5820
|
#
|
@@ -5792,9 +5840,11 @@ module Aws::S3
|
|
5792
5840
|
# @!attribute [rw] request_payer
|
5793
5841
|
# Confirms that the requester knows that they will be charged for the
|
5794
5842
|
# request. Bucket owners need not specify this parameter in their
|
5795
|
-
# requests.
|
5796
|
-
# Pays
|
5797
|
-
#
|
5843
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5844
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5845
|
+
# charges to copy the object. For information about downloading
|
5846
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5847
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5798
5848
|
#
|
5799
5849
|
#
|
5800
5850
|
#
|
@@ -5843,9 +5893,11 @@ module Aws::S3
|
|
5843
5893
|
# @!attribute [rw] request_payer
|
5844
5894
|
# Confirms that the requester knows that they will be charged for the
|
5845
5895
|
# request. Bucket owners need not specify this parameter in their
|
5846
|
-
# requests.
|
5847
|
-
# Pays
|
5848
|
-
#
|
5896
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5897
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5898
|
+
# charges to copy the object. For information about downloading
|
5899
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5900
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5849
5901
|
#
|
5850
5902
|
#
|
5851
5903
|
#
|
@@ -6024,7 +6076,7 @@ module Aws::S3
|
|
6024
6076
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6025
6077
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6026
6078
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6027
|
-
# [What is S3 on Outposts][3] in the *Amazon S3 User Guide*.
|
6079
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
6028
6080
|
#
|
6029
6081
|
#
|
6030
6082
|
#
|
@@ -6208,7 +6260,7 @@ module Aws::S3
|
|
6208
6260
|
#
|
6209
6261
|
# @!attribute [rw] server_side_encryption
|
6210
6262
|
# The server-side encryption algorithm used when storing this object
|
6211
|
-
# in Amazon S3 (for example, AES256
|
6263
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
6212
6264
|
# @return [String]
|
6213
6265
|
#
|
6214
6266
|
# @!attribute [rw] metadata
|
@@ -6229,14 +6281,14 @@ module Aws::S3
|
|
6229
6281
|
# @return [String]
|
6230
6282
|
#
|
6231
6283
|
# @!attribute [rw] ssekms_key_id
|
6232
|
-
# If present, specifies the ID of the
|
6233
|
-
#
|
6234
|
-
#
|
6284
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
6285
|
+
# symmetric encryption customer managed key that was used for the
|
6286
|
+
# object.
|
6235
6287
|
# @return [String]
|
6236
6288
|
#
|
6237
6289
|
# @!attribute [rw] bucket_key_enabled
|
6238
6290
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
6239
|
-
# encryption with
|
6291
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
6240
6292
|
# @return [Boolean]
|
6241
6293
|
#
|
6242
6294
|
# @!attribute [rw] storage_class
|
@@ -6397,7 +6449,7 @@ module Aws::S3
|
|
6397
6449
|
# When you use this action with S3 on Outposts through the Amazon Web
|
6398
6450
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
6399
6451
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6400
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
6452
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6401
6453
|
#
|
6402
6454
|
#
|
6403
6455
|
#
|
@@ -6462,9 +6514,11 @@ module Aws::S3
|
|
6462
6514
|
# @!attribute [rw] request_payer
|
6463
6515
|
# Confirms that the requester knows that they will be charged for the
|
6464
6516
|
# request. Bucket owners need not specify this parameter in their
|
6465
|
-
# requests.
|
6466
|
-
# Pays
|
6467
|
-
#
|
6517
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6518
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6519
|
+
# charges to copy the object. For information about downloading
|
6520
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
6521
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6468
6522
|
#
|
6469
6523
|
#
|
6470
6524
|
#
|
@@ -7221,8 +7275,8 @@ module Aws::S3
|
|
7221
7275
|
# @return [String]
|
7222
7276
|
#
|
7223
7277
|
# @!attribute [rw] continuation_token
|
7224
|
-
# The ContinuationToken that represents a placeholder from where
|
7225
|
-
# request should begin.
|
7278
|
+
# The `ContinuationToken` that represents a placeholder from where
|
7279
|
+
# this request should begin.
|
7226
7280
|
# @return [String]
|
7227
7281
|
#
|
7228
7282
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7334,9 +7388,9 @@ module Aws::S3
|
|
7334
7388
|
#
|
7335
7389
|
# @!attribute [rw] continuation_token
|
7336
7390
|
# The marker used to continue an inventory configuration listing that
|
7337
|
-
# has been truncated. Use the NextContinuationToken from a
|
7338
|
-
# truncated list response to continue the listing. The
|
7339
|
-
# token is an opaque value that Amazon S3 understands.
|
7391
|
+
# has been truncated. Use the `NextContinuationToken` from a
|
7392
|
+
# previously truncated list response to continue the listing. The
|
7393
|
+
# continuation token is an opaque value that Amazon S3 understands.
|
7340
7394
|
# @return [String]
|
7341
7395
|
#
|
7342
7396
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7397,7 +7451,7 @@ module Aws::S3
|
|
7397
7451
|
#
|
7398
7452
|
# @!attribute [rw] continuation_token
|
7399
7453
|
# The marker that is used to continue a metrics configuration listing
|
7400
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7454
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7401
7455
|
# previously truncated list response to continue the listing. The
|
7402
7456
|
# continuation token is an opaque value that Amazon S3 understands.
|
7403
7457
|
# @return [String]
|
@@ -7500,13 +7554,18 @@ module Aws::S3
|
|
7500
7554
|
# Encoding type used by Amazon S3 to encode object keys in the
|
7501
7555
|
# response.
|
7502
7556
|
#
|
7503
|
-
# If you specify `encoding-type` request parameter, Amazon S3
|
7504
|
-
# this element in the response, and returns encoded key name
|
7505
|
-
# the following response elements:
|
7557
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7558
|
+
# includes this element in the response, and returns encoded key name
|
7559
|
+
# values in the following response elements:
|
7506
7560
|
#
|
7507
7561
|
# `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.
|
7508
7562
|
# @return [String]
|
7509
7563
|
#
|
7564
|
+
# @!attribute [rw] request_charged
|
7565
|
+
# If present, indicates that the requester was successfully charged
|
7566
|
+
# for the request.
|
7567
|
+
# @return [String]
|
7568
|
+
#
|
7510
7569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsOutput AWS API Documentation
|
7511
7570
|
#
|
7512
7571
|
class ListMultipartUploadsOutput < Struct.new(
|
@@ -7521,7 +7580,8 @@ module Aws::S3
|
|
7521
7580
|
:is_truncated,
|
7522
7581
|
:uploads,
|
7523
7582
|
:common_prefixes,
|
7524
|
-
:encoding_type
|
7583
|
+
:encoding_type,
|
7584
|
+
:request_charged)
|
7525
7585
|
SENSITIVE = []
|
7526
7586
|
include Aws::Structure
|
7527
7587
|
end
|
@@ -7545,7 +7605,7 @@ module Aws::S3
|
|
7545
7605
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7546
7606
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7547
7607
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7548
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
7608
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7549
7609
|
#
|
7550
7610
|
#
|
7551
7611
|
#
|
@@ -7567,15 +7627,15 @@ module Aws::S3
|
|
7567
7627
|
#
|
7568
7628
|
# @!attribute [rw] encoding_type
|
7569
7629
|
# Requests Amazon S3 to encode the object keys in the response and
|
7570
|
-
# specifies the encoding method to use. An object key
|
7571
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7630
|
+
# specifies the encoding method to use. An object key can contain any
|
7631
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7572
7632
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7573
7633
|
# characters that are not supported in XML 1.0, you can add this
|
7574
7634
|
# parameter to request that Amazon S3 encode the keys in the response.
|
7575
7635
|
# @return [String]
|
7576
7636
|
#
|
7577
7637
|
# @!attribute [rw] key_marker
|
7578
|
-
# Together with upload-id-marker
|
7638
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
7579
7639
|
# multipart upload after which listing should begin.
|
7580
7640
|
#
|
7581
7641
|
# If `upload-id-marker` is not specified, only the keys
|
@@ -7597,8 +7657,8 @@ module Aws::S3
|
|
7597
7657
|
# @!attribute [rw] prefix
|
7598
7658
|
# Lists in-progress uploads only for those keys that begin with the
|
7599
7659
|
# specified prefix. You can use prefixes to separate a bucket into
|
7600
|
-
# different grouping of keys. (You can think of using prefix to make
|
7601
|
-
# groups in the same way you'd use a folder in a file system.)
|
7660
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
7661
|
+
# groups in the same way that you'd use a folder in a file system.)
|
7602
7662
|
# @return [String]
|
7603
7663
|
#
|
7604
7664
|
# @!attribute [rw] upload_id_marker
|
@@ -7616,6 +7676,20 @@ module Aws::S3
|
|
7616
7676
|
# `403 Forbidden` (access denied).
|
7617
7677
|
# @return [String]
|
7618
7678
|
#
|
7679
|
+
# @!attribute [rw] request_payer
|
7680
|
+
# Confirms that the requester knows that they will be charged for the
|
7681
|
+
# request. Bucket owners need not specify this parameter in their
|
7682
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
7683
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
7684
|
+
# charges to copy the object. For information about downloading
|
7685
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
7686
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
7687
|
+
#
|
7688
|
+
#
|
7689
|
+
#
|
7690
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7691
|
+
# @return [String]
|
7692
|
+
#
|
7619
7693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation
|
7620
7694
|
#
|
7621
7695
|
class ListMultipartUploadsRequest < Struct.new(
|
@@ -7626,7 +7700,8 @@ module Aws::S3
|
|
7626
7700
|
:max_uploads,
|
7627
7701
|
:prefix,
|
7628
7702
|
:upload_id_marker,
|
7629
|
-
:expected_bucket_owner
|
7703
|
+
:expected_bucket_owner,
|
7704
|
+
:request_payer)
|
7630
7705
|
SENSITIVE = []
|
7631
7706
|
include Aws::Structure
|
7632
7707
|
end
|
@@ -7634,9 +7709,9 @@ module Aws::S3
|
|
7634
7709
|
# @!attribute [rw] is_truncated
|
7635
7710
|
# A flag that indicates whether Amazon S3 returned all of the results
|
7636
7711
|
# that satisfied the search criteria. If your results were truncated,
|
7637
|
-
# you can make a follow-up paginated request using the
|
7638
|
-
# and NextVersionIdMarker response parameters as a
|
7639
|
-
# another request to return the rest of the results.
|
7712
|
+
# you can make a follow-up paginated request by using the
|
7713
|
+
# `NextKeyMarker` and `NextVersionIdMarker` response parameters as a
|
7714
|
+
# starting place in another request to return the rest of the results.
|
7640
7715
|
# @return [Boolean]
|
7641
7716
|
#
|
7642
7717
|
# @!attribute [rw] key_marker
|
@@ -7658,7 +7733,7 @@ module Aws::S3
|
|
7658
7733
|
# When the number of responses exceeds the value of `MaxKeys`,
|
7659
7734
|
# `NextVersionIdMarker` specifies the first object version not
|
7660
7735
|
# returned that satisfies the search criteria. Use this value for the
|
7661
|
-
# version-id-marker request parameter in a subsequent request.
|
7736
|
+
# `version-id-marker` request parameter in a subsequent request.
|
7662
7737
|
# @return [String]
|
7663
7738
|
#
|
7664
7739
|
# @!attribute [rw] versions
|
@@ -7683,7 +7758,7 @@ module Aws::S3
|
|
7683
7758
|
# that you specify to group keys. All keys that contain the same
|
7684
7759
|
# string between the prefix and the first occurrence of the delimiter
|
7685
7760
|
# are grouped under a single result element in `CommonPrefixes`. These
|
7686
|
-
# groups are counted as one result against the max-keys limitation.
|
7761
|
+
# groups are counted as one result against the `max-keys` limitation.
|
7687
7762
|
# These keys are not returned elsewhere in the response.
|
7688
7763
|
# @return [String]
|
7689
7764
|
#
|
@@ -7700,13 +7775,18 @@ module Aws::S3
|
|
7700
7775
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7701
7776
|
# XML response.
|
7702
7777
|
#
|
7703
|
-
# If you specify encoding-type request parameter, Amazon S3
|
7704
|
-
# this element in the response, and returns encoded key name
|
7705
|
-
# the following response elements:
|
7778
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7779
|
+
# includes this element in the response, and returns encoded key name
|
7780
|
+
# values in the following response elements:
|
7706
7781
|
#
|
7707
7782
|
# `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.
|
7708
7783
|
# @return [String]
|
7709
7784
|
#
|
7785
|
+
# @!attribute [rw] request_charged
|
7786
|
+
# If present, indicates that the requester was successfully charged
|
7787
|
+
# for the request.
|
7788
|
+
# @return [String]
|
7789
|
+
#
|
7710
7790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsOutput AWS API Documentation
|
7711
7791
|
#
|
7712
7792
|
class ListObjectVersionsOutput < Struct.new(
|
@@ -7722,7 +7802,8 @@ module Aws::S3
|
|
7722
7802
|
:delimiter,
|
7723
7803
|
:max_keys,
|
7724
7804
|
:common_prefixes,
|
7725
|
-
:encoding_type
|
7805
|
+
:encoding_type,
|
7806
|
+
:request_charged)
|
7726
7807
|
SENSITIVE = []
|
7727
7808
|
include Aws::Structure
|
7728
7809
|
end
|
@@ -7735,15 +7816,15 @@ module Aws::S3
|
|
7735
7816
|
# A delimiter is a character that you specify to group keys. All keys
|
7736
7817
|
# that contain the same string between the `prefix` and the first
|
7737
7818
|
# occurrence of the delimiter are grouped under a single result
|
7738
|
-
# element in CommonPrefixes
|
7739
|
-
# against the max-keys limitation. These keys are not returned
|
7819
|
+
# element in `CommonPrefixes`. These groups are counted as one result
|
7820
|
+
# against the `max-keys` limitation. These keys are not returned
|
7740
7821
|
# elsewhere in the response.
|
7741
7822
|
# @return [String]
|
7742
7823
|
#
|
7743
7824
|
# @!attribute [rw] encoding_type
|
7744
7825
|
# Requests Amazon S3 to encode the object keys in the response and
|
7745
|
-
# specifies the encoding method to use. An object key
|
7746
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7826
|
+
# specifies the encoding method to use. An object key can contain any
|
7827
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7747
7828
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7748
7829
|
# characters that are not supported in XML 1.0, you can add this
|
7749
7830
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7754,22 +7835,22 @@ module Aws::S3
|
|
7754
7835
|
# @return [String]
|
7755
7836
|
#
|
7756
7837
|
# @!attribute [rw] max_keys
|
7757
|
-
# Sets the maximum number of keys returned in the response. By
|
7758
|
-
# the action returns up to 1,000 key names. The response
|
7759
|
-
# fewer keys but will never contain more. If additional
|
7760
|
-
# the search criteria, but were not returned because
|
7761
|
-
# exceeded, the response contains
|
7762
|
-
#
|
7763
|
-
#
|
7838
|
+
# Sets the maximum number of keys returned in the response. By
|
7839
|
+
# default, the action returns up to 1,000 key names. The response
|
7840
|
+
# might contain fewer keys but will never contain more. If additional
|
7841
|
+
# keys satisfy the search criteria, but were not returned because
|
7842
|
+
# `max-keys` was exceeded, the response contains
|
7843
|
+
# `<isTruncated>true</isTruncated>`. To return the additional keys,
|
7844
|
+
# see `key-marker` and `version-id-marker`.
|
7764
7845
|
# @return [Integer]
|
7765
7846
|
#
|
7766
7847
|
# @!attribute [rw] prefix
|
7767
7848
|
# Use this parameter to select only those keys that begin with the
|
7768
7849
|
# specified prefix. You can use prefixes to separate a bucket into
|
7769
|
-
# different groupings of keys. (You can think of using prefix to
|
7770
|
-
# groups in the same way you'd use a folder in a file
|
7771
|
-
# can use prefix with delimiter to roll up numerous
|
7772
|
-
# single result under CommonPrefixes
|
7850
|
+
# different groupings of keys. (You can think of using `prefix` to
|
7851
|
+
# make groups in the same way that you'd use a folder in a file
|
7852
|
+
# system.) You can use `prefix` with `delimiter` to roll up numerous
|
7853
|
+
# objects into a single result under `CommonPrefixes`.
|
7773
7854
|
# @return [String]
|
7774
7855
|
#
|
7775
7856
|
# @!attribute [rw] version_id_marker
|
@@ -7782,6 +7863,25 @@ module Aws::S3
|
|
7782
7863
|
# `403 Forbidden` (access denied).
|
7783
7864
|
# @return [String]
|
7784
7865
|
#
|
7866
|
+
# @!attribute [rw] request_payer
|
7867
|
+
# Confirms that the requester knows that they will be charged for the
|
7868
|
+
# request. Bucket owners need not specify this parameter in their
|
7869
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
7870
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
7871
|
+
# charges to copy the object. For information about downloading
|
7872
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
7873
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
7874
|
+
#
|
7875
|
+
#
|
7876
|
+
#
|
7877
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7878
|
+
# @return [String]
|
7879
|
+
#
|
7880
|
+
# @!attribute [rw] optional_object_attributes
|
7881
|
+
# Specifies the optional fields that you want returned in the
|
7882
|
+
# response. Fields that you do not specify are not returned.
|
7883
|
+
# @return [Array<String>]
|
7884
|
+
#
|
7785
7885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
|
7786
7886
|
#
|
7787
7887
|
class ListObjectVersionsRequest < Struct.new(
|
@@ -7792,7 +7892,9 @@ module Aws::S3
|
|
7792
7892
|
:max_keys,
|
7793
7893
|
:prefix,
|
7794
7894
|
:version_id_marker,
|
7795
|
-
:expected_bucket_owner
|
7895
|
+
:expected_bucket_owner,
|
7896
|
+
:request_payer,
|
7897
|
+
:optional_object_attributes)
|
7796
7898
|
SENSITIVE = []
|
7797
7899
|
include Aws::Structure
|
7798
7900
|
end
|
@@ -7808,14 +7910,18 @@ module Aws::S3
|
|
7808
7910
|
# @return [String]
|
7809
7911
|
#
|
7810
7912
|
# @!attribute [rw] next_marker
|
7811
|
-
# When response is truncated (the IsTruncated element value in
|
7812
|
-
# response is true), you can use the key name in this field as
|
7813
|
-
# in the subsequent request to get next set
|
7814
|
-
# lists objects in alphabetical order
|
7815
|
-
#
|
7816
|
-
#
|
7817
|
-
#
|
7818
|
-
#
|
7913
|
+
# When the response is truncated (the `IsTruncated` element value in
|
7914
|
+
# the response is `true`), you can use the key name in this field as
|
7915
|
+
# the `marker` parameter in the subsequent request to get the next set
|
7916
|
+
# of objects. Amazon S3 lists objects in alphabetical order.
|
7917
|
+
#
|
7918
|
+
# <note markdown="1"> This element is returned only if you have the `delimiter` request
|
7919
|
+
# parameter specified. If the response does not include the
|
7920
|
+
# `NextMarker` element and it is truncated, you can use the value of
|
7921
|
+
# the last `Key` element in the response as the `marker` parameter in
|
7922
|
+
# the subsequent request to get the next set of object keys.
|
7923
|
+
#
|
7924
|
+
# </note>
|
7819
7925
|
# @return [String]
|
7820
7926
|
#
|
7821
7927
|
# @!attribute [rw] contents
|
@@ -7846,19 +7952,20 @@ module Aws::S3
|
|
7846
7952
|
# All of the keys (up to 1,000) rolled up in a common prefix count as
|
7847
7953
|
# a single return when calculating the number of returns.
|
7848
7954
|
#
|
7849
|
-
# A response can contain CommonPrefixes only if you specify a
|
7955
|
+
# A response can contain `CommonPrefixes` only if you specify a
|
7850
7956
|
# delimiter.
|
7851
7957
|
#
|
7852
|
-
# CommonPrefixes contains all (if there are any) keys between
|
7853
|
-
# and the next occurrence of the string specified by the
|
7958
|
+
# `CommonPrefixes` contains all (if there are any) keys between
|
7959
|
+
# `Prefix` and the next occurrence of the string specified by the
|
7960
|
+
# delimiter.
|
7854
7961
|
#
|
7855
|
-
# CommonPrefixes lists keys that act like subdirectories in the
|
7856
|
-
# directory specified by Prefix
|
7962
|
+
# `CommonPrefixes` lists keys that act like subdirectories in the
|
7963
|
+
# directory specified by `Prefix`.
|
7857
7964
|
#
|
7858
|
-
# For example, if the prefix is notes
|
7859
|
-
# (
|
7860
|
-
# of the keys that roll up into a common prefix
|
7861
|
-
# return when calculating the number of returns.
|
7965
|
+
# For example, if the prefix is `notes/` and the delimiter is a slash
|
7966
|
+
# (`/`), as in `notes/summer/july`, the common prefix is
|
7967
|
+
# `notes/summer/`. All of the keys that roll up into a common prefix
|
7968
|
+
# count as a single return when calculating the number of returns.
|
7862
7969
|
# @return [Array<Types::CommonPrefix>]
|
7863
7970
|
#
|
7864
7971
|
# @!attribute [rw] encoding_type
|
@@ -7866,6 +7973,11 @@ module Aws::S3
|
|
7866
7973
|
# response.
|
7867
7974
|
# @return [String]
|
7868
7975
|
#
|
7976
|
+
# @!attribute [rw] request_charged
|
7977
|
+
# If present, indicates that the requester was successfully charged
|
7978
|
+
# for the request.
|
7979
|
+
# @return [String]
|
7980
|
+
#
|
7869
7981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation
|
7870
7982
|
#
|
7871
7983
|
class ListObjectsOutput < Struct.new(
|
@@ -7878,7 +7990,8 @@ module Aws::S3
|
|
7878
7990
|
:delimiter,
|
7879
7991
|
:max_keys,
|
7880
7992
|
:common_prefixes,
|
7881
|
-
:encoding_type
|
7993
|
+
:encoding_type,
|
7994
|
+
:request_charged)
|
7882
7995
|
SENSITIVE = []
|
7883
7996
|
include Aws::Structure
|
7884
7997
|
end
|
@@ -7902,7 +8015,7 @@ module Aws::S3
|
|
7902
8015
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7903
8016
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7904
8017
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7905
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8018
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7906
8019
|
#
|
7907
8020
|
#
|
7908
8021
|
#
|
@@ -7911,13 +8024,13 @@ module Aws::S3
|
|
7911
8024
|
# @return [String]
|
7912
8025
|
#
|
7913
8026
|
# @!attribute [rw] delimiter
|
7914
|
-
# A delimiter is a character you use to group keys.
|
8027
|
+
# A delimiter is a character that you use to group keys.
|
7915
8028
|
# @return [String]
|
7916
8029
|
#
|
7917
8030
|
# @!attribute [rw] encoding_type
|
7918
8031
|
# Requests Amazon S3 to encode the object keys in the response and
|
7919
|
-
# specifies the encoding method to use. An object key
|
7920
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8032
|
+
# specifies the encoding method to use. An object key can contain any
|
8033
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7921
8034
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7922
8035
|
# characters that are not supported in XML 1.0, you can add this
|
7923
8036
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7930,9 +8043,9 @@ module Aws::S3
|
|
7930
8043
|
# @return [String]
|
7931
8044
|
#
|
7932
8045
|
# @!attribute [rw] max_keys
|
7933
|
-
# Sets the maximum number of keys returned in the response. By
|
7934
|
-
# the action returns up to 1,000 key names. The response
|
7935
|
-
# fewer keys but will never contain more.
|
8046
|
+
# Sets the maximum number of keys returned in the response. By
|
8047
|
+
# default, the action returns up to 1,000 key names. The response
|
8048
|
+
# might contain fewer keys but will never contain more.
|
7936
8049
|
# @return [Integer]
|
7937
8050
|
#
|
7938
8051
|
# @!attribute [rw] prefix
|
@@ -7951,6 +8064,11 @@ module Aws::S3
|
|
7951
8064
|
# `403 Forbidden` (access denied).
|
7952
8065
|
# @return [String]
|
7953
8066
|
#
|
8067
|
+
# @!attribute [rw] optional_object_attributes
|
8068
|
+
# Specifies the optional fields that you want returned in the
|
8069
|
+
# response. Fields that you do not specify are not returned.
|
8070
|
+
# @return [Array<String>]
|
8071
|
+
#
|
7954
8072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
|
7955
8073
|
#
|
7956
8074
|
class ListObjectsRequest < Struct.new(
|
@@ -7961,15 +8079,17 @@ module Aws::S3
|
|
7961
8079
|
:max_keys,
|
7962
8080
|
:prefix,
|
7963
8081
|
:request_payer,
|
7964
|
-
:expected_bucket_owner
|
8082
|
+
:expected_bucket_owner,
|
8083
|
+
:optional_object_attributes)
|
7965
8084
|
SENSITIVE = []
|
7966
8085
|
include Aws::Structure
|
7967
8086
|
end
|
7968
8087
|
|
7969
8088
|
# @!attribute [rw] is_truncated
|
7970
|
-
# Set to false if all of the results were returned. Set to true if
|
8089
|
+
# Set to `false` if all of the results were returned. Set to `true` if
|
7971
8090
|
# more keys are available to return. If the number of results exceeds
|
7972
|
-
# that specified by MaxKeys
|
8091
|
+
# that specified by `MaxKeys`, all of the results might not be
|
8092
|
+
# returned.
|
7973
8093
|
# @return [Boolean]
|
7974
8094
|
#
|
7975
8095
|
# @!attribute [rw] contents
|
@@ -7995,7 +8115,7 @@ module Aws::S3
|
|
7995
8115
|
# When you use this action with S3 on Outposts through the Amazon Web
|
7996
8116
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
7997
8117
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7998
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8118
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7999
8119
|
#
|
8000
8120
|
#
|
8001
8121
|
#
|
@@ -8008,17 +8128,17 @@ module Aws::S3
|
|
8008
8128
|
# @return [String]
|
8009
8129
|
#
|
8010
8130
|
# @!attribute [rw] delimiter
|
8011
|
-
# Causes keys that contain the same string between the prefix and
|
8012
|
-
# first occurrence of the delimiter to be rolled up into a single
|
8013
|
-
# result element in the CommonPrefixes collection. These rolled-up
|
8131
|
+
# Causes keys that contain the same string between the `prefix` and
|
8132
|
+
# the first occurrence of the delimiter to be rolled up into a single
|
8133
|
+
# result element in the `CommonPrefixes` collection. These rolled-up
|
8014
8134
|
# keys are not returned elsewhere in the response. Each rolled-up
|
8015
8135
|
# result counts as only one return against the `MaxKeys` value.
|
8016
8136
|
# @return [String]
|
8017
8137
|
#
|
8018
8138
|
# @!attribute [rw] max_keys
|
8019
|
-
# Sets the maximum number of keys returned in the response. By
|
8020
|
-
# the action returns up to 1,000 key names. The response
|
8021
|
-
# fewer keys but will never contain more.
|
8139
|
+
# Sets the maximum number of keys returned in the response. By
|
8140
|
+
# default, the action returns up to 1,000 key names. The response
|
8141
|
+
# might contain fewer keys but will never contain more.
|
8022
8142
|
# @return [Integer]
|
8023
8143
|
#
|
8024
8144
|
# @!attribute [rw] common_prefixes
|
@@ -8045,7 +8165,7 @@ module Aws::S3
|
|
8045
8165
|
# Encoding type used by Amazon S3 to encode object key names in the
|
8046
8166
|
# XML response.
|
8047
8167
|
#
|
8048
|
-
# If you specify the encoding-type request parameter, Amazon S3
|
8168
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
8049
8169
|
# includes this element in the response, and returns encoded key name
|
8050
8170
|
# values in the following response elements:
|
8051
8171
|
#
|
@@ -8053,13 +8173,14 @@ module Aws::S3
|
|
8053
8173
|
# @return [String]
|
8054
8174
|
#
|
8055
8175
|
# @!attribute [rw] key_count
|
8056
|
-
# KeyCount is the number of keys returned with this request.
|
8057
|
-
# will always be less than or equal to the `MaxKeys` field.
|
8058
|
-
# ask for 50 keys, your result will include 50
|
8176
|
+
# `KeyCount` is the number of keys returned with this request.
|
8177
|
+
# `KeyCount` will always be less than or equal to the `MaxKeys` field.
|
8178
|
+
# For example, if you ask for 50 keys, your result will include 50
|
8179
|
+
# keys or fewer.
|
8059
8180
|
# @return [Integer]
|
8060
8181
|
#
|
8061
8182
|
# @!attribute [rw] continuation_token
|
8062
|
-
# If ContinuationToken was sent with the request, it is included in
|
8183
|
+
# If `ContinuationToken` was sent with the request, it is included in
|
8063
8184
|
# the response.
|
8064
8185
|
# @return [String]
|
8065
8186
|
#
|
@@ -8076,6 +8197,11 @@ module Aws::S3
|
|
8076
8197
|
# response.
|
8077
8198
|
# @return [String]
|
8078
8199
|
#
|
8200
|
+
# @!attribute [rw] request_charged
|
8201
|
+
# If present, indicates that the requester was successfully charged
|
8202
|
+
# for the request.
|
8203
|
+
# @return [String]
|
8204
|
+
#
|
8079
8205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Output AWS API Documentation
|
8080
8206
|
#
|
8081
8207
|
class ListObjectsV2Output < Struct.new(
|
@@ -8090,7 +8216,8 @@ module Aws::S3
|
|
8090
8216
|
:key_count,
|
8091
8217
|
:continuation_token,
|
8092
8218
|
:next_continuation_token,
|
8093
|
-
:start_after
|
8219
|
+
:start_after,
|
8220
|
+
:request_charged)
|
8094
8221
|
SENSITIVE = []
|
8095
8222
|
include Aws::Structure
|
8096
8223
|
end
|
@@ -8114,7 +8241,7 @@ module Aws::S3
|
|
8114
8241
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8115
8242
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8116
8243
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8117
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8244
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8118
8245
|
#
|
8119
8246
|
#
|
8120
8247
|
#
|
@@ -8123,7 +8250,7 @@ module Aws::S3
|
|
8123
8250
|
# @return [String]
|
8124
8251
|
#
|
8125
8252
|
# @!attribute [rw] delimiter
|
8126
|
-
# A delimiter is a character you use to group keys.
|
8253
|
+
# A delimiter is a character that you use to group keys.
|
8127
8254
|
# @return [String]
|
8128
8255
|
#
|
8129
8256
|
# @!attribute [rw] encoding_type
|
@@ -8132,9 +8259,9 @@ module Aws::S3
|
|
8132
8259
|
# @return [String]
|
8133
8260
|
#
|
8134
8261
|
# @!attribute [rw] max_keys
|
8135
|
-
# Sets the maximum number of keys returned in the response. By
|
8136
|
-
# the action returns up to 1,000 key names. The response
|
8137
|
-
# fewer keys but will never contain more.
|
8262
|
+
# Sets the maximum number of keys returned in the response. By
|
8263
|
+
# default, the action returns up to 1,000 key names. The response
|
8264
|
+
# might contain fewer keys but will never contain more.
|
8138
8265
|
# @return [Integer]
|
8139
8266
|
#
|
8140
8267
|
# @!attribute [rw] prefix
|
@@ -8142,15 +8269,15 @@ module Aws::S3
|
|
8142
8269
|
# @return [String]
|
8143
8270
|
#
|
8144
8271
|
# @!attribute [rw] continuation_token
|
8145
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8146
|
-
# continued on this bucket with a token. ContinuationToken is
|
8272
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8273
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8147
8274
|
# obfuscated and is not a real key.
|
8148
8275
|
# @return [String]
|
8149
8276
|
#
|
8150
8277
|
# @!attribute [rw] fetch_owner
|
8151
|
-
# The owner field is not present in
|
8152
|
-
# return owner field with each key in the result then set
|
8153
|
-
#
|
8278
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8279
|
+
# want to return the owner field with each key in the result, then set
|
8280
|
+
# the `FetchOwner` field to `true`.
|
8154
8281
|
# @return [Boolean]
|
8155
8282
|
#
|
8156
8283
|
# @!attribute [rw] start_after
|
@@ -8171,6 +8298,11 @@ module Aws::S3
|
|
8171
8298
|
# `403 Forbidden` (access denied).
|
8172
8299
|
# @return [String]
|
8173
8300
|
#
|
8301
|
+
# @!attribute [rw] optional_object_attributes
|
8302
|
+
# Specifies the optional fields that you want returned in the
|
8303
|
+
# response. Fields that you do not specify are not returned.
|
8304
|
+
# @return [Array<String>]
|
8305
|
+
#
|
8174
8306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
|
8175
8307
|
#
|
8176
8308
|
class ListObjectsV2Request < Struct.new(
|
@@ -8183,7 +8315,8 @@ module Aws::S3
|
|
8183
8315
|
:fetch_owner,
|
8184
8316
|
:start_after,
|
8185
8317
|
:request_payer,
|
8186
|
-
:expected_bucket_owner
|
8318
|
+
:expected_bucket_owner,
|
8319
|
+
:optional_object_attributes)
|
8187
8320
|
SENSITIVE = []
|
8188
8321
|
include Aws::Structure
|
8189
8322
|
end
|
@@ -8234,7 +8367,7 @@ module Aws::S3
|
|
8234
8367
|
#
|
8235
8368
|
# @!attribute [rw] next_part_number_marker
|
8236
8369
|
# When a list is truncated, this element specifies the last part in
|
8237
|
-
# the list, as well as the value to use for the part-number-marker
|
8370
|
+
# the list, as well as the value to use for the `part-number-marker`
|
8238
8371
|
# request parameter in a subsequent request.
|
8239
8372
|
# @return [Integer]
|
8240
8373
|
#
|
@@ -8323,7 +8456,7 @@ module Aws::S3
|
|
8323
8456
|
# When you use this action with S3 on Outposts through the Amazon Web
|
8324
8457
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
8325
8458
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8326
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
8459
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8327
8460
|
#
|
8328
8461
|
#
|
8329
8462
|
#
|
@@ -8352,9 +8485,11 @@ module Aws::S3
|
|
8352
8485
|
# @!attribute [rw] request_payer
|
8353
8486
|
# Confirms that the requester knows that they will be charged for the
|
8354
8487
|
# request. Bucket owners need not specify this parameter in their
|
8355
|
-
# requests.
|
8356
|
-
# Pays
|
8357
|
-
#
|
8488
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
8489
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
8490
|
+
# charges to copy the object. For information about downloading
|
8491
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
8492
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
8358
8493
|
#
|
8359
8494
|
#
|
8360
8495
|
#
|
@@ -8467,11 +8602,11 @@ module Aws::S3
|
|
8467
8602
|
# A metadata key-value pair to store with an object.
|
8468
8603
|
#
|
8469
8604
|
# @!attribute [rw] name
|
8470
|
-
# Name of the
|
8605
|
+
# Name of the object.
|
8471
8606
|
# @return [String]
|
8472
8607
|
#
|
8473
8608
|
# @!attribute [rw] value
|
8474
|
-
# Value of the
|
8609
|
+
# Value of the object.
|
8475
8610
|
# @return [String]
|
8476
8611
|
#
|
8477
8612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation
|
@@ -8886,6 +9021,18 @@ module Aws::S3
|
|
8886
9021
|
# The owner of the object
|
8887
9022
|
# @return [Types::Owner]
|
8888
9023
|
#
|
9024
|
+
# @!attribute [rw] restore_status
|
9025
|
+
# Specifies the restoration status of an object. Objects in certain
|
9026
|
+
# storage classes must be restored before they can be retrieved. For
|
9027
|
+
# more information about these storage classes and how to work with
|
9028
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9029
|
+
# *Amazon S3 User Guide*.
|
9030
|
+
#
|
9031
|
+
#
|
9032
|
+
#
|
9033
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9034
|
+
# @return [Types::RestoreStatus]
|
9035
|
+
#
|
8889
9036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation
|
8890
9037
|
#
|
8891
9038
|
class Object < Struct.new(
|
@@ -8895,7 +9042,8 @@ module Aws::S3
|
|
8895
9042
|
:checksum_algorithm,
|
8896
9043
|
:size,
|
8897
9044
|
:storage_class,
|
8898
|
-
:owner
|
9045
|
+
:owner,
|
9046
|
+
:restore_status)
|
8899
9047
|
SENSITIVE = []
|
8900
9048
|
include Aws::Structure
|
8901
9049
|
end
|
@@ -9130,6 +9278,18 @@ module Aws::S3
|
|
9130
9278
|
# Specifies the owner of the object.
|
9131
9279
|
# @return [Types::Owner]
|
9132
9280
|
#
|
9281
|
+
# @!attribute [rw] restore_status
|
9282
|
+
# Specifies the restoration status of an object. Objects in certain
|
9283
|
+
# storage classes must be restored before they can be retrieved. For
|
9284
|
+
# more information about these storage classes and how to work with
|
9285
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9286
|
+
# *Amazon S3 User Guide*.
|
9287
|
+
#
|
9288
|
+
#
|
9289
|
+
#
|
9290
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9291
|
+
# @return [Types::RestoreStatus]
|
9292
|
+
#
|
9133
9293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
|
9134
9294
|
#
|
9135
9295
|
class ObjectVersion < Struct.new(
|
@@ -9141,7 +9301,8 @@ module Aws::S3
|
|
9141
9301
|
:version_id,
|
9142
9302
|
:is_latest,
|
9143
9303
|
:last_modified,
|
9144
|
-
:owner
|
9304
|
+
:owner,
|
9305
|
+
:restore_status)
|
9145
9306
|
SENSITIVE = []
|
9146
9307
|
include Aws::Structure
|
9147
9308
|
end
|
@@ -10597,7 +10758,7 @@ module Aws::S3
|
|
10597
10758
|
# When you use this action with S3 on Outposts through the Amazon Web
|
10598
10759
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
10599
10760
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
10600
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
10761
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10601
10762
|
#
|
10602
10763
|
#
|
10603
10764
|
#
|
@@ -10608,9 +10769,11 @@ module Aws::S3
|
|
10608
10769
|
# @!attribute [rw] request_payer
|
10609
10770
|
# Confirms that the requester knows that they will be charged for the
|
10610
10771
|
# request. Bucket owners need not specify this parameter in their
|
10611
|
-
# requests.
|
10612
|
-
# Pays
|
10613
|
-
#
|
10772
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10773
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10774
|
+
# charges to copy the object. For information about downloading
|
10775
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10776
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10614
10777
|
#
|
10615
10778
|
#
|
10616
10779
|
#
|
@@ -10691,9 +10854,11 @@ module Aws::S3
|
|
10691
10854
|
# @!attribute [rw] request_payer
|
10692
10855
|
# Confirms that the requester knows that they will be charged for the
|
10693
10856
|
# request. Bucket owners need not specify this parameter in their
|
10694
|
-
# requests.
|
10695
|
-
# Pays
|
10696
|
-
#
|
10857
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10858
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10859
|
+
# charges to copy the object. For information about downloading
|
10860
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10861
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10697
10862
|
#
|
10698
10863
|
#
|
10699
10864
|
#
|
@@ -10776,9 +10941,11 @@ module Aws::S3
|
|
10776
10941
|
# @!attribute [rw] request_payer
|
10777
10942
|
# Confirms that the requester knows that they will be charged for the
|
10778
10943
|
# request. Bucket owners need not specify this parameter in their
|
10779
|
-
# requests.
|
10780
|
-
# Pays
|
10781
|
-
#
|
10944
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10945
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10946
|
+
# charges to copy the object. For information about downloading
|
10947
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10948
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10782
10949
|
#
|
10783
10950
|
#
|
10784
10951
|
#
|
@@ -10904,7 +11071,7 @@ module Aws::S3
|
|
10904
11071
|
#
|
10905
11072
|
# @!attribute [rw] server_side_encryption
|
10906
11073
|
# The server-side encryption algorithm used when storing this object
|
10907
|
-
# in Amazon S3 (for example, AES256
|
11074
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
10908
11075
|
# @return [String]
|
10909
11076
|
#
|
10910
11077
|
# @!attribute [rw] version_id
|
@@ -10925,10 +11092,10 @@ module Aws::S3
|
|
10925
11092
|
# @return [String]
|
10926
11093
|
#
|
10927
11094
|
# @!attribute [rw] ssekms_key_id
|
10928
|
-
# If `x-amz-server-side-encryption`
|
10929
|
-
# this header specifies the ID of the
|
10930
|
-
#
|
10931
|
-
#
|
11095
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11096
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11097
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11098
|
+
# used for the object.
|
10932
11099
|
# @return [String]
|
10933
11100
|
#
|
10934
11101
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -10942,7 +11109,8 @@ module Aws::S3
|
|
10942
11109
|
#
|
10943
11110
|
# @!attribute [rw] bucket_key_enabled
|
10944
11111
|
# Indicates whether the uploaded object uses an S3 Bucket Key for
|
10945
|
-
# server-side encryption with
|
11112
|
+
# server-side encryption with Key Management Service (KMS) keys
|
11113
|
+
# (SSE-KMS).
|
10946
11114
|
# @return [Boolean]
|
10947
11115
|
#
|
10948
11116
|
# @!attribute [rw] request_charged
|
@@ -11005,7 +11173,7 @@ module Aws::S3
|
|
11005
11173
|
# When you use this action with S3 on Outposts through the Amazon Web
|
11006
11174
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
11007
11175
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11008
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
11176
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11009
11177
|
#
|
11010
11178
|
#
|
11011
11179
|
#
|
@@ -11194,7 +11362,7 @@ module Aws::S3
|
|
11194
11362
|
#
|
11195
11363
|
# @!attribute [rw] server_side_encryption
|
11196
11364
|
# The server-side encryption algorithm used when storing this object
|
11197
|
-
# in Amazon S3 (for example, AES256
|
11365
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
11198
11366
|
# @return [String]
|
11199
11367
|
#
|
11200
11368
|
# @!attribute [rw] storage_class
|
@@ -11258,15 +11426,16 @@ module Aws::S3
|
|
11258
11426
|
# @return [String]
|
11259
11427
|
#
|
11260
11428
|
# @!attribute [rw] ssekms_key_id
|
11261
|
-
# If `x-amz-server-side-encryption` has a valid value of `aws:kms
|
11262
|
-
# this header specifies the ID
|
11263
|
-
# Management Service (
|
11429
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11430
|
+
# `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or
|
11431
|
+
# Key Alias) of the Key Management Service (KMS) symmetric encryption
|
11264
11432
|
# customer managed key that was used for the object. If you specify
|
11265
|
-
# `x-amz-server-side-encryption:aws:kms
|
11433
|
+
# `x-amz-server-side-encryption:aws:kms` or
|
11434
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
11266
11435
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
11267
|
-
# Amazon Web Services managed key to protect the data. If
|
11268
|
-
# does not exist in the same account issuing the
|
11269
|
-
# the full ARN and not just the ID.
|
11436
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data. If
|
11437
|
+
# the KMS key does not exist in the same account that's issuing the
|
11438
|
+
# command, you must use the full ARN and not just the ID.
|
11270
11439
|
# @return [String]
|
11271
11440
|
#
|
11272
11441
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -11280,9 +11449,9 @@ module Aws::S3
|
|
11280
11449
|
#
|
11281
11450
|
# @!attribute [rw] bucket_key_enabled
|
11282
11451
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
11283
|
-
# encryption with server-side encryption using
|
11284
|
-
# Setting this header to `true` causes Amazon S3
|
11285
|
-
# Key for object encryption with SSE-KMS.
|
11452
|
+
# encryption with server-side encryption using Key Management Service
|
11453
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
11454
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
11286
11455
|
#
|
11287
11456
|
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11288
11457
|
# settings for S3 Bucket Key.
|
@@ -11291,9 +11460,11 @@ module Aws::S3
|
|
11291
11460
|
# @!attribute [rw] request_payer
|
11292
11461
|
# Confirms that the requester knows that they will be charged for the
|
11293
11462
|
# request. Bucket owners need not specify this parameter in their
|
11294
|
-
# requests.
|
11295
|
-
# Pays
|
11296
|
-
#
|
11463
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11464
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11465
|
+
# charges to copy the object. For information about downloading
|
11466
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11467
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11297
11468
|
#
|
11298
11469
|
#
|
11299
11470
|
#
|
@@ -11416,9 +11587,11 @@ module Aws::S3
|
|
11416
11587
|
# @!attribute [rw] request_payer
|
11417
11588
|
# Confirms that the requester knows that they will be charged for the
|
11418
11589
|
# request. Bucket owners need not specify this parameter in their
|
11419
|
-
# requests.
|
11420
|
-
# Pays
|
11421
|
-
#
|
11590
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11591
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11592
|
+
# charges to copy the object. For information about downloading
|
11593
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11594
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11422
11595
|
#
|
11423
11596
|
#
|
11424
11597
|
#
|
@@ -11513,7 +11686,7 @@ module Aws::S3
|
|
11513
11686
|
# When you use this action with S3 on Outposts through the Amazon Web
|
11514
11687
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
11515
11688
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11516
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
11689
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11517
11690
|
#
|
11518
11691
|
#
|
11519
11692
|
#
|
@@ -11567,9 +11740,11 @@ module Aws::S3
|
|
11567
11740
|
# @!attribute [rw] request_payer
|
11568
11741
|
# Confirms that the requester knows that they will be charged for the
|
11569
11742
|
# request. Bucket owners need not specify this parameter in their
|
11570
|
-
# requests.
|
11571
|
-
# Pays
|
11572
|
-
#
|
11743
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11744
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11745
|
+
# charges to copy the object. For information about downloading
|
11746
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11747
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11573
11748
|
#
|
11574
11749
|
#
|
11575
11750
|
#
|
@@ -12181,7 +12356,7 @@ module Aws::S3
|
|
12181
12356
|
# When you use this action with S3 on Outposts through the Amazon Web
|
12182
12357
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
12183
12358
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12184
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
12359
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12185
12360
|
#
|
12186
12361
|
#
|
12187
12362
|
#
|
@@ -12204,9 +12379,11 @@ module Aws::S3
|
|
12204
12379
|
# @!attribute [rw] request_payer
|
12205
12380
|
# Confirms that the requester knows that they will be charged for the
|
12206
12381
|
# request. Bucket owners need not specify this parameter in their
|
12207
|
-
# requests.
|
12208
|
-
# Pays
|
12209
|
-
#
|
12382
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
12383
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
12384
|
+
# charges to copy the object. For information about downloading
|
12385
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
12386
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
12210
12387
|
#
|
12211
12388
|
#
|
12212
12389
|
#
|
@@ -12299,6 +12476,49 @@ module Aws::S3
|
|
12299
12476
|
include Aws::Structure
|
12300
12477
|
end
|
12301
12478
|
|
12479
|
+
# Specifies the restoration status of an object. Objects in certain
|
12480
|
+
# storage classes must be restored before they can be retrieved. For
|
12481
|
+
# more information about these storage classes and how to work with
|
12482
|
+
# archived objects, see [ Working with archived objects][1] in the
|
12483
|
+
# *Amazon S3 User Guide*.
|
12484
|
+
#
|
12485
|
+
#
|
12486
|
+
#
|
12487
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
12488
|
+
#
|
12489
|
+
# @!attribute [rw] is_restore_in_progress
|
12490
|
+
# Specifies whether the object is currently being restored. If the
|
12491
|
+
# object restoration is in progress, the header returns the value
|
12492
|
+
# `TRUE`. For example:
|
12493
|
+
#
|
12494
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="true"`
|
12495
|
+
#
|
12496
|
+
# If the object restoration has completed, the header returns the
|
12497
|
+
# value `FALSE`. For example:
|
12498
|
+
#
|
12499
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12500
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12501
|
+
#
|
12502
|
+
# If the object hasn't been restored, there is no header response.
|
12503
|
+
# @return [Boolean]
|
12504
|
+
#
|
12505
|
+
# @!attribute [rw] restore_expiry_date
|
12506
|
+
# Indicates when the restored copy will expire. This value is
|
12507
|
+
# populated only if the object has already been restored. For example:
|
12508
|
+
#
|
12509
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12510
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12511
|
+
# @return [Time]
|
12512
|
+
#
|
12513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation
|
12514
|
+
#
|
12515
|
+
class RestoreStatus < Struct.new(
|
12516
|
+
:is_restore_in_progress,
|
12517
|
+
:restore_expiry_date)
|
12518
|
+
SENSITIVE = []
|
12519
|
+
include Aws::Structure
|
12520
|
+
end
|
12521
|
+
|
12302
12522
|
# Specifies the redirect behavior and when a redirect is applied. For
|
12303
12523
|
# more information about routing rules, see [Configuring advanced
|
12304
12524
|
# conditional redirects][1] in the *Amazon S3 User Guide*.
|
@@ -12495,9 +12715,9 @@ module Aws::S3
|
|
12495
12715
|
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
12496
12716
|
#
|
12497
12717
|
# @!attribute [rw] key_id
|
12498
|
-
# Specifies the ID of the
|
12499
|
-
#
|
12500
|
-
#
|
12718
|
+
# Specifies the ID of the Key Management Service (KMS) symmetric
|
12719
|
+
# encryption customer managed key to use for encrypting inventory
|
12720
|
+
# reports.
|
12501
12721
|
# @return [String]
|
12502
12722
|
#
|
12503
12723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation
|
@@ -12735,20 +12955,24 @@ module Aws::S3
|
|
12735
12955
|
# parameter is allowed if and only if `SSEAlgorithm` is set to
|
12736
12956
|
# `aws:kms`.
|
12737
12957
|
#
|
12738
|
-
# You can specify the key ID or the Amazon Resource Name
|
12739
|
-
#
|
12740
|
-
# undeliverable error when creating a VPC flow log.
|
12741
|
-
#
|
12742
|
-
# If you are using encryption with cross-account or Amazon Web
|
12743
|
-
# Services service operations you must use a fully qualified KMS key
|
12744
|
-
# ARN. For more information, see [Using encryption for cross-account
|
12745
|
-
# operations][1].
|
12958
|
+
# You can specify the key ID, key alias, or the Amazon Resource Name
|
12959
|
+
# (ARN) of the KMS key.
|
12746
12960
|
#
|
12747
12961
|
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
12748
12962
|
#
|
12749
12963
|
# * Key ARN:
|
12750
12964
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
12751
12965
|
#
|
12966
|
+
# * Key Alias: `alias/alias-name`
|
12967
|
+
#
|
12968
|
+
# If you use a key ID, you can run into a LogDestination undeliverable
|
12969
|
+
# error when creating a VPC flow log.
|
12970
|
+
#
|
12971
|
+
# If you are using encryption with cross-account or Amazon Web
|
12972
|
+
# Services service operations you must use a fully qualified KMS key
|
12973
|
+
# ARN. For more information, see [Using encryption for cross-account
|
12974
|
+
# operations][1].
|
12975
|
+
#
|
12752
12976
|
# Amazon S3 only supports symmetric encryption KMS keys. For more
|
12753
12977
|
# information, see [Asymmetric keys in Amazon Web Services KMS][2] in
|
12754
12978
|
# the *Amazon Web Services Key Management Service Developer Guide*.
|
@@ -13171,7 +13395,7 @@ module Aws::S3
|
|
13171
13395
|
#
|
13172
13396
|
# @!attribute [rw] server_side_encryption
|
13173
13397
|
# The server-side encryption algorithm used when storing this object
|
13174
|
-
# in Amazon S3 (for example, AES256
|
13398
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13175
13399
|
# @return [String]
|
13176
13400
|
#
|
13177
13401
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13188,14 +13412,15 @@ module Aws::S3
|
|
13188
13412
|
# @return [String]
|
13189
13413
|
#
|
13190
13414
|
# @!attribute [rw] ssekms_key_id
|
13191
|
-
# If present, specifies the ID of the
|
13192
|
-
#
|
13193
|
-
#
|
13415
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13416
|
+
# symmetric encryption customer managed key that was used for the
|
13417
|
+
# object.
|
13194
13418
|
# @return [String]
|
13195
13419
|
#
|
13196
13420
|
# @!attribute [rw] bucket_key_enabled
|
13197
13421
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13198
|
-
# server-side encryption with
|
13422
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13423
|
+
# (SSE-KMS).
|
13199
13424
|
# @return [Boolean]
|
13200
13425
|
#
|
13201
13426
|
# @!attribute [rw] request_charged
|
@@ -13237,7 +13462,7 @@ module Aws::S3
|
|
13237
13462
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13238
13463
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13239
13464
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13240
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13465
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13241
13466
|
#
|
13242
13467
|
#
|
13243
13468
|
#
|
@@ -13375,9 +13600,11 @@ module Aws::S3
|
|
13375
13600
|
# @!attribute [rw] request_payer
|
13376
13601
|
# Confirms that the requester knows that they will be charged for the
|
13377
13602
|
# request. Bucket owners need not specify this parameter in their
|
13378
|
-
# requests.
|
13379
|
-
# Pays
|
13380
|
-
#
|
13603
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13604
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13605
|
+
# charges to copy the object. For information about downloading
|
13606
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
13607
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13381
13608
|
#
|
13382
13609
|
#
|
13383
13610
|
#
|
@@ -13424,7 +13651,7 @@ module Aws::S3
|
|
13424
13651
|
|
13425
13652
|
# @!attribute [rw] server_side_encryption
|
13426
13653
|
# The server-side encryption algorithm used when storing this object
|
13427
|
-
# in Amazon S3 (for example, AES256
|
13654
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13428
13655
|
# @return [String]
|
13429
13656
|
#
|
13430
13657
|
# @!attribute [rw] etag
|
@@ -13497,14 +13724,14 @@ module Aws::S3
|
|
13497
13724
|
# @return [String]
|
13498
13725
|
#
|
13499
13726
|
# @!attribute [rw] ssekms_key_id
|
13500
|
-
# If present, specifies the ID of the
|
13501
|
-
#
|
13502
|
-
# customer managed key was used for the object.
|
13727
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13728
|
+
# symmetric encryption customer managed key was used for the object.
|
13503
13729
|
# @return [String]
|
13504
13730
|
#
|
13505
13731
|
# @!attribute [rw] bucket_key_enabled
|
13506
13732
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13507
|
-
# server-side encryption with
|
13733
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13734
|
+
# (SSE-KMS).
|
13508
13735
|
# @return [Boolean]
|
13509
13736
|
#
|
13510
13737
|
# @!attribute [rw] request_charged
|
@@ -13553,7 +13780,7 @@ module Aws::S3
|
|
13553
13780
|
# When you use this action with S3 on Outposts through the Amazon Web
|
13554
13781
|
# Services SDKs, you provide the Outposts access point ARN in place of
|
13555
13782
|
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13556
|
-
# [What is S3 on Outposts][2] in the *Amazon S3 User Guide*.
|
13783
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13557
13784
|
#
|
13558
13785
|
#
|
13559
13786
|
#
|
@@ -13678,9 +13905,11 @@ module Aws::S3
|
|
13678
13905
|
# @!attribute [rw] request_payer
|
13679
13906
|
# Confirms that the requester knows that they will be charged for the
|
13680
13907
|
# request. Bucket owners need not specify this parameter in their
|
13681
|
-
# requests.
|
13682
|
-
# Pays
|
13683
|
-
#
|
13908
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13909
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13910
|
+
# charges to copy the object. For information about downloading
|
13911
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
13912
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13684
13913
|
#
|
13685
13914
|
#
|
13686
13915
|
#
|
@@ -14045,9 +14274,10 @@ module Aws::S3
|
|
14045
14274
|
# @return [String]
|
14046
14275
|
#
|
14047
14276
|
# @!attribute [rw] ssekms_key_id
|
14048
|
-
# If present, specifies the ID
|
14049
|
-
# Management Service (Amazon Web Services KMS)
|
14050
|
-
# customer managed key that was used for stored
|
14277
|
+
# If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the
|
14278
|
+
# Amazon Web Services Key Management Service (Amazon Web Services KMS)
|
14279
|
+
# symmetric encryption customer managed key that was used for stored
|
14280
|
+
# in Amazon S3 object.
|
14051
14281
|
# @return [String]
|
14052
14282
|
#
|
14053
14283
|
# @!attribute [rw] sse_customer_key_md5
|