aws-sdk-s3 1.119.1 → 1.132.1
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 +97 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +108 -55
- 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 +1740 -1441
- 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 +27 -0
- data/lib/aws-sdk-s3/customizations/object.rb +49 -18
- data/lib/aws-sdk-s3/customizations/types/permanent_redirect.rb +26 -0
- data/lib/aws-sdk-s3/customizations.rb +2 -0
- 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 +103 -327
- data/lib/aws-sdk-s3/endpoints.rb +1 -0
- data/lib/aws-sdk-s3/file_downloader.rb +61 -25
- 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 +12 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +10 -4
- data/lib/aws-sdk-s3/object.rb +105 -77
- data/lib/aws-sdk-s3/object_acl.rb +9 -3
- 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 +103 -64
- data/lib/aws-sdk-s3/object_version.rb +35 -9
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +13 -11
- 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 +711 -405
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +8 -6
data/lib/aws-sdk-s3/types.rb
CHANGED
@@ -13,8 +13,8 @@ module Aws::S3
|
|
13
13
|
# Specifies the days since the initiation of an incomplete multipart
|
14
14
|
# upload that Amazon S3 will wait before permanently removing all parts
|
15
15
|
# of the upload. For more information, see [ Aborting Incomplete
|
16
|
-
# Multipart Uploads Using a Bucket Lifecycle
|
17
|
-
# S3 User Guide*.
|
16
|
+
# Multipart Uploads Using a Bucket Lifecycle Configuration][1] in the
|
17
|
+
# *Amazon S3 User Guide*.
|
18
18
|
#
|
19
19
|
#
|
20
20
|
#
|
@@ -58,14 +58,14 @@ module Aws::S3
|
|
58
58
|
# bucket name. For more information about access point ARNs, see
|
59
59
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
60
60
|
#
|
61
|
-
# When
|
61
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
62
62
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
63
63
|
# takes the form `
|
64
64
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
65
|
-
# When
|
66
|
-
# Services SDKs, you provide the Outposts
|
67
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
68
|
-
# [
|
65
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
66
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
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*.
|
69
69
|
#
|
70
70
|
#
|
71
71
|
#
|
@@ -460,22 +460,24 @@ module Aws::S3
|
|
460
460
|
# @!attribute [rw] file_header_info
|
461
461
|
# Describes the first line of input. Valid values are:
|
462
462
|
#
|
463
|
-
# * `NONE
|
463
|
+
# * `NONE`: First line is not a header.
|
464
464
|
#
|
465
|
-
# * `IGNORE
|
465
|
+
# * `IGNORE`: First line is a header, but you can't use the header
|
466
466
|
# values to indicate the column in an expression. You can use column
|
467
467
|
# position (such as \_1, \_2, …) to indicate the column (`SELECT
|
468
468
|
# s._1 FROM OBJECT s`).
|
469
469
|
#
|
470
|
-
# * `Use
|
471
|
-
#
|
472
|
-
# OBJECT`).
|
470
|
+
# * `Use`: First line is a header, and you can use the header value to
|
471
|
+
# identify a column in an expression (`SELECT "name" FROM OBJECT`).
|
473
472
|
# @return [String]
|
474
473
|
#
|
475
474
|
# @!attribute [rw] comments
|
476
475
|
# A single character used to indicate that a row should be ignored
|
477
476
|
# when the character is present at the start of that row. You can
|
478
|
-
# specify any character to indicate a comment line.
|
477
|
+
# specify any character to indicate a comment line. The default
|
478
|
+
# character is `#`.
|
479
|
+
#
|
480
|
+
# Default: `#`
|
479
481
|
# @return [String]
|
480
482
|
#
|
481
483
|
# @!attribute [rw] quote_escape_character
|
@@ -533,9 +535,9 @@ module Aws::S3
|
|
533
535
|
# @!attribute [rw] quote_fields
|
534
536
|
# Indicates whether to use quotation marks around output fields.
|
535
537
|
#
|
536
|
-
# * `ALWAYS
|
538
|
+
# * `ALWAYS`: Always use quotation marks for output fields.
|
537
539
|
#
|
538
|
-
# * `ASNEEDED
|
540
|
+
# * `ASNEEDED`: Use quotation marks for output fields when needed.
|
539
541
|
# @return [String]
|
540
542
|
#
|
541
543
|
# @!attribute [rw] quote_escape_character
|
@@ -709,14 +711,14 @@ module Aws::S3
|
|
709
711
|
# bucket name. For more information about access point ARNs, see
|
710
712
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
711
713
|
#
|
712
|
-
# When
|
714
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
713
715
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
714
716
|
# takes the form `
|
715
717
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
716
|
-
# When
|
717
|
-
# Services SDKs, you provide the Outposts
|
718
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
719
|
-
# [
|
718
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
719
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
720
|
+
# 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*.
|
720
722
|
#
|
721
723
|
#
|
722
724
|
#
|
@@ -803,11 +805,8 @@ module Aws::S3
|
|
803
805
|
# @return [String]
|
804
806
|
#
|
805
807
|
# @!attribute [rw] server_side_encryption
|
806
|
-
#
|
807
|
-
#
|
808
|
-
# initiate multipart upload request, the response includes this
|
809
|
-
# header. It confirms the encryption algorithm that Amazon S3 used to
|
810
|
-
# encrypt the object.
|
808
|
+
# The server-side encryption algorithm used when storing this object
|
809
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
811
810
|
# @return [String]
|
812
811
|
#
|
813
812
|
# @!attribute [rw] version_id
|
@@ -816,14 +815,15 @@ module Aws::S3
|
|
816
815
|
# @return [String]
|
817
816
|
#
|
818
817
|
# @!attribute [rw] ssekms_key_id
|
819
|
-
# If present, specifies the ID of the
|
820
|
-
#
|
821
|
-
#
|
818
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
819
|
+
# symmetric encryption customer managed key that was used for the
|
820
|
+
# object.
|
822
821
|
# @return [String]
|
823
822
|
#
|
824
823
|
# @!attribute [rw] bucket_key_enabled
|
825
824
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
826
|
-
# server-side encryption with
|
825
|
+
# server-side encryption with Key Management Service (KMS) keys
|
826
|
+
# (SSE-KMS).
|
827
827
|
# @return [Boolean]
|
828
828
|
#
|
829
829
|
# @!attribute [rw] request_charged
|
@@ -864,14 +864,14 @@ module Aws::S3
|
|
864
864
|
# bucket name. For more information about access point ARNs, see
|
865
865
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
866
866
|
#
|
867
|
-
# When
|
867
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
868
868
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
869
869
|
# takes the form `
|
870
870
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
871
|
-
# When
|
872
|
-
# Services SDKs, you provide the Outposts
|
873
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
874
|
-
# [
|
871
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
872
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
873
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
874
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
875
875
|
#
|
876
876
|
#
|
877
877
|
#
|
@@ -1173,7 +1173,7 @@ module Aws::S3
|
|
1173
1173
|
#
|
1174
1174
|
# @!attribute [rw] server_side_encryption
|
1175
1175
|
# The server-side encryption algorithm used when storing this object
|
1176
|
-
# in Amazon S3 (for example, AES256
|
1176
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1177
1177
|
# @return [String]
|
1178
1178
|
#
|
1179
1179
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1190,9 +1190,9 @@ module Aws::S3
|
|
1190
1190
|
# @return [String]
|
1191
1191
|
#
|
1192
1192
|
# @!attribute [rw] ssekms_key_id
|
1193
|
-
# If present, specifies the ID of the
|
1194
|
-
#
|
1195
|
-
#
|
1193
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1194
|
+
# symmetric encryption customer managed key that was used for the
|
1195
|
+
# object.
|
1196
1196
|
# @return [String]
|
1197
1197
|
#
|
1198
1198
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1204,7 +1204,8 @@ module Aws::S3
|
|
1204
1204
|
#
|
1205
1205
|
# @!attribute [rw] bucket_key_enabled
|
1206
1206
|
# Indicates whether the copied object uses an S3 Bucket Key for
|
1207
|
-
# server-side encryption with
|
1207
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1208
|
+
# (SSE-KMS).
|
1208
1209
|
# @return [Boolean]
|
1209
1210
|
#
|
1210
1211
|
# @!attribute [rw] request_charged
|
@@ -1248,14 +1249,14 @@ module Aws::S3
|
|
1248
1249
|
# bucket name. For more information about access point ARNs, see
|
1249
1250
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1250
1251
|
#
|
1251
|
-
# When
|
1252
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1252
1253
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1253
1254
|
# takes the form `
|
1254
1255
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1255
|
-
# When
|
1256
|
-
# Services SDKs, you provide the Outposts
|
1257
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
1258
|
-
# [
|
1256
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
1257
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
1258
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1259
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1259
1260
|
#
|
1260
1261
|
#
|
1261
1262
|
#
|
@@ -1298,7 +1299,7 @@ module Aws::S3
|
|
1298
1299
|
# @!attribute [rw] copy_source
|
1299
1300
|
# Specifies the source object for the copy operation. You specify the
|
1300
1301
|
# value in one of two formats, depending on whether you want to access
|
1301
|
-
# the source object through an [access point][1]
|
1302
|
+
# the source object through an [access point][1]:
|
1302
1303
|
#
|
1303
1304
|
# * For objects not accessed through an access point, specify the name
|
1304
1305
|
# of the source bucket and the key of the source object, separated
|
@@ -1411,7 +1412,7 @@ module Aws::S3
|
|
1411
1412
|
#
|
1412
1413
|
# @!attribute [rw] server_side_encryption
|
1413
1414
|
# The server-side encryption algorithm used when storing this object
|
1414
|
-
# in Amazon S3 (for example, AES256
|
1415
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1415
1416
|
# @return [String]
|
1416
1417
|
#
|
1417
1418
|
# @!attribute [rw] storage_class
|
@@ -1431,7 +1432,9 @@ module Aws::S3
|
|
1431
1432
|
# If the bucket is configured as a website, redirects requests for
|
1432
1433
|
# this object to another object in the same bucket or to an external
|
1433
1434
|
# URL. Amazon S3 stores the value of this header in the object
|
1434
|
-
# metadata.
|
1435
|
+
# metadata. This value is unique to each object and is not copied when
|
1436
|
+
# using the `x-amz-metadata-directive` header. Instead, you may opt to
|
1437
|
+
# provide this header in combination with the directive.
|
1435
1438
|
# @return [String]
|
1436
1439
|
#
|
1437
1440
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1454,13 +1457,12 @@ module Aws::S3
|
|
1454
1457
|
# @return [String]
|
1455
1458
|
#
|
1456
1459
|
# @!attribute [rw] ssekms_key_id
|
1457
|
-
# Specifies the
|
1458
|
-
#
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
# [
|
1463
|
-
# the *Amazon S3 User Guide*.
|
1460
|
+
# Specifies the KMS key ID to use for object encryption. All GET and
|
1461
|
+
# PUT requests for an object protected by KMS will fail if they're
|
1462
|
+
# not made via SSL or using SigV4. For information about configuring
|
1463
|
+
# any of the officially supported Amazon Web Services SDKs and Amazon
|
1464
|
+
# Web Services CLI, see [Specifying the Signature Version in Request
|
1465
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
1464
1466
|
#
|
1465
1467
|
#
|
1466
1468
|
#
|
@@ -1476,9 +1478,9 @@ module Aws::S3
|
|
1476
1478
|
#
|
1477
1479
|
# @!attribute [rw] bucket_key_enabled
|
1478
1480
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
1479
|
-
# encryption with server-side encryption using
|
1480
|
-
# Setting this header to `true` causes Amazon S3
|
1481
|
-
# Key for object encryption with SSE-KMS.
|
1481
|
+
# encryption with server-side encryption using Key Management Service
|
1482
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
1483
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
1482
1484
|
#
|
1483
1485
|
# Specifying this header with a COPY action doesn’t affect
|
1484
1486
|
# bucket-level settings for S3 Bucket Key.
|
@@ -1856,7 +1858,7 @@ module Aws::S3
|
|
1856
1858
|
# this header. The header indicates when the initiated multipart
|
1857
1859
|
# upload becomes eligible for an abort operation. For more
|
1858
1860
|
# information, see [ Aborting Incomplete Multipart Uploads Using a
|
1859
|
-
# Bucket Lifecycle
|
1861
|
+
# Bucket Lifecycle Configuration][1].
|
1860
1862
|
#
|
1861
1863
|
# The response also includes the `x-amz-abort-rule-id` header that
|
1862
1864
|
# provides the ID of the lifecycle configuration rule that defines
|
@@ -1886,14 +1888,14 @@ module Aws::S3
|
|
1886
1888
|
# bucket name. For more information about access point ARNs, see
|
1887
1889
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1888
1890
|
#
|
1889
|
-
# When
|
1891
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1890
1892
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1891
1893
|
# takes the form `
|
1892
1894
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1893
|
-
# When
|
1894
|
-
# Services SDKs, you provide the Outposts
|
1895
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
1896
|
-
# [
|
1895
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
1896
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
1897
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1898
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1897
1899
|
#
|
1898
1900
|
#
|
1899
1901
|
#
|
@@ -1911,7 +1913,7 @@ module Aws::S3
|
|
1911
1913
|
#
|
1912
1914
|
# @!attribute [rw] server_side_encryption
|
1913
1915
|
# The server-side encryption algorithm used when storing this object
|
1914
|
-
# in Amazon S3 (for example, AES256
|
1916
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
1915
1917
|
# @return [String]
|
1916
1918
|
#
|
1917
1919
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1928,9 +1930,9 @@ module Aws::S3
|
|
1928
1930
|
# @return [String]
|
1929
1931
|
#
|
1930
1932
|
# @!attribute [rw] ssekms_key_id
|
1931
|
-
# If present, specifies the ID of the
|
1932
|
-
#
|
1933
|
-
#
|
1933
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1934
|
+
# symmetric encryption customer managed key that was used for the
|
1935
|
+
# object.
|
1934
1936
|
# @return [String]
|
1935
1937
|
#
|
1936
1938
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1942,7 +1944,8 @@ module Aws::S3
|
|
1942
1944
|
#
|
1943
1945
|
# @!attribute [rw] bucket_key_enabled
|
1944
1946
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
1945
|
-
# server-side encryption with
|
1947
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1948
|
+
# (SSE-KMS).
|
1946
1949
|
# @return [Boolean]
|
1947
1950
|
#
|
1948
1951
|
# @!attribute [rw] request_charged
|
@@ -1992,14 +1995,14 @@ module Aws::S3
|
|
1992
1995
|
# bucket name. For more information about access point ARNs, see
|
1993
1996
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1994
1997
|
#
|
1995
|
-
# When
|
1998
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1996
1999
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1997
2000
|
# takes the form `
|
1998
2001
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1999
|
-
# When
|
2000
|
-
# Services SDKs, you provide the Outposts
|
2001
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2002
|
-
# [
|
2002
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2003
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2004
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2005
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2003
2006
|
#
|
2004
2007
|
#
|
2005
2008
|
#
|
@@ -2068,7 +2071,7 @@ module Aws::S3
|
|
2068
2071
|
#
|
2069
2072
|
# @!attribute [rw] server_side_encryption
|
2070
2073
|
# The server-side encryption algorithm used when storing this object
|
2071
|
-
# in Amazon S3 (for example, AES256
|
2074
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
2072
2075
|
# @return [String]
|
2073
2076
|
#
|
2074
2077
|
# @!attribute [rw] storage_class
|
@@ -2111,10 +2114,10 @@ module Aws::S3
|
|
2111
2114
|
# @return [String]
|
2112
2115
|
#
|
2113
2116
|
# @!attribute [rw] ssekms_key_id
|
2114
|
-
# Specifies the ID of the symmetric customer managed key to
|
2115
|
-
# object encryption. All GET and PUT requests for an object
|
2116
|
-
# by
|
2117
|
-
# SigV4. For information about configuring
|
2117
|
+
# Specifies the ID of the symmetric encryption customer managed key to
|
2118
|
+
# use for object encryption. All GET and PUT requests for an object
|
2119
|
+
# protected by KMS will fail if they're not made via SSL or using
|
2120
|
+
# SigV4. For information about configuring any of the officially
|
2118
2121
|
# supported Amazon Web Services SDKs and Amazon Web Services CLI, see
|
2119
2122
|
# [Specifying the Signature Version in Request Authentication][1] in
|
2120
2123
|
# the *Amazon S3 User Guide*.
|
@@ -2133,9 +2136,9 @@ module Aws::S3
|
|
2133
2136
|
#
|
2134
2137
|
# @!attribute [rw] bucket_key_enabled
|
2135
2138
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
2136
|
-
# encryption with server-side encryption using
|
2137
|
-
# Setting this header to `true` causes Amazon S3
|
2138
|
-
# Key for object encryption with SSE-KMS.
|
2139
|
+
# encryption with server-side encryption using Key Management Service
|
2140
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
2141
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
2139
2142
|
#
|
2140
2143
|
# Specifying this header with an object action doesn’t affect
|
2141
2144
|
# bucket-level settings for S3 Bucket Key.
|
@@ -2265,7 +2268,7 @@ module Aws::S3
|
|
2265
2268
|
# Container for the objects to delete.
|
2266
2269
|
#
|
2267
2270
|
# @!attribute [rw] objects
|
2268
|
-
# The
|
2271
|
+
# The object to delete.
|
2269
2272
|
# @return [Array<Types::ObjectIdentifier>]
|
2270
2273
|
#
|
2271
2274
|
# @!attribute [rw] quiet
|
@@ -2414,7 +2417,9 @@ module Aws::S3
|
|
2414
2417
|
# @return [String]
|
2415
2418
|
#
|
2416
2419
|
# @!attribute [rw] id
|
2417
|
-
# The ID used to identify the metrics configuration.
|
2420
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
2421
|
+
# character limit and can only contain letters, numbers, periods,
|
2422
|
+
# dashes, and underscores.
|
2418
2423
|
# @return [String]
|
2419
2424
|
#
|
2420
2425
|
# @!attribute [rw] expected_bucket_owner
|
@@ -2659,14 +2664,14 @@ module Aws::S3
|
|
2659
2664
|
# bucket name. For more information about access point ARNs, see
|
2660
2665
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2661
2666
|
#
|
2662
|
-
# When
|
2667
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2663
2668
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2664
2669
|
# takes the form `
|
2665
2670
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2666
|
-
# When
|
2667
|
-
# Services SDKs, you provide the Outposts
|
2668
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2669
|
-
# [
|
2671
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2672
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2673
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2674
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2670
2675
|
#
|
2671
2676
|
#
|
2672
2677
|
#
|
@@ -2752,14 +2757,14 @@ module Aws::S3
|
|
2752
2757
|
# bucket name. For more information about access point ARNs, see
|
2753
2758
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2754
2759
|
#
|
2755
|
-
# When
|
2760
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2756
2761
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2757
2762
|
# takes the form `
|
2758
2763
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2759
|
-
# When
|
2760
|
-
# Services SDKs, you provide the Outposts
|
2761
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2762
|
-
# [
|
2764
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2765
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2766
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2767
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2763
2768
|
#
|
2764
2769
|
#
|
2765
2770
|
#
|
@@ -2830,14 +2835,14 @@ module Aws::S3
|
|
2830
2835
|
# bucket name. For more information about access point ARNs, see
|
2831
2836
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2832
2837
|
#
|
2833
|
-
# When
|
2838
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2834
2839
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2835
2840
|
# takes the form `
|
2836
2841
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2837
|
-
# When
|
2838
|
-
# Services SDKs, you provide the Outposts
|
2839
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2840
|
-
# [
|
2842
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2843
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2844
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2845
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2841
2846
|
#
|
2842
2847
|
#
|
2843
2848
|
#
|
@@ -3050,15 +3055,16 @@ module Aws::S3
|
|
3050
3055
|
#
|
3051
3056
|
# @!attribute [rw] encryption_type
|
3052
3057
|
# The server-side encryption algorithm used when storing job results
|
3053
|
-
# in Amazon S3 (for example, AES256, aws:kms).
|
3058
|
+
# in Amazon S3 (for example, AES256, `aws:kms`).
|
3054
3059
|
# @return [String]
|
3055
3060
|
#
|
3056
3061
|
# @!attribute [rw] kms_key_id
|
3057
3062
|
# If the encryption type is `aws:kms`, this optional value specifies
|
3058
|
-
# the ID of the symmetric customer managed key to use for
|
3059
|
-
# of job results. Amazon S3 only supports symmetric
|
3060
|
-
# information, see [
|
3061
|
-
# *Amazon Web Services Key Management Service Developer
|
3063
|
+
# the ID of the symmetric encryption customer managed key to use for
|
3064
|
+
# encryption of job results. Amazon S3 only supports symmetric
|
3065
|
+
# encryption KMS keys. For more information, see [Asymmetric keys in
|
3066
|
+
# KMS][1] in the *Amazon Web Services Key Management Service Developer
|
3067
|
+
# Guide*.
|
3062
3068
|
#
|
3063
3069
|
#
|
3064
3070
|
#
|
@@ -3088,9 +3094,9 @@ module Aws::S3
|
|
3088
3094
|
# Amazon Web Services KMS key stored in Amazon Web Services Key
|
3089
3095
|
# Management Service (KMS) for the destination bucket. Amazon S3 uses
|
3090
3096
|
# this key to encrypt replica objects. Amazon S3 only supports
|
3091
|
-
# symmetric
|
3092
|
-
#
|
3093
|
-
#
|
3097
|
+
# symmetric encryption KMS keys. For more information, see [Asymmetric
|
3098
|
+
# keys in Amazon Web Services KMS][1] in the *Amazon Web Services Key
|
3099
|
+
# Management Service Developer Guide*.
|
3094
3100
|
#
|
3095
3101
|
#
|
3096
3102
|
#
|
@@ -3130,9 +3136,8 @@ module Aws::S3
|
|
3130
3136
|
# @!attribute [rw] code
|
3131
3137
|
# The error code is a string that uniquely identifies an error
|
3132
3138
|
# condition. It is meant to be read and understood by programs that
|
3133
|
-
# detect and handle errors by type.
|
3134
|
-
#
|
3135
|
-
# **Amazon S3 error codes**
|
3139
|
+
# detect and handle errors by type. The following is a list of Amazon
|
3140
|
+
# S3 error codes. For more information, see [Error responses][1].
|
3136
3141
|
#
|
3137
3142
|
# * * *Code:* AccessDenied
|
3138
3143
|
#
|
@@ -3371,7 +3376,7 @@ module Aws::S3
|
|
3371
3376
|
#
|
3372
3377
|
# * *Description:* The specified location constraint is not valid.
|
3373
3378
|
# For more information about Regions, see [How to Select a Region
|
3374
|
-
# for Your Buckets][
|
3379
|
+
# for Your Buckets][2].
|
3375
3380
|
#
|
3376
3381
|
# * *HTTP Status Code:* 400 Bad Request
|
3377
3382
|
#
|
@@ -3756,7 +3761,7 @@ module Aws::S3
|
|
3756
3761
|
#
|
3757
3762
|
# * *Description:* Your account is not signed up for the Amazon S3
|
3758
3763
|
# service. You must sign up before you can use Amazon S3. You can
|
3759
|
-
# sign up at the following URL: [Amazon S3][
|
3764
|
+
# sign up at the following URL: [Amazon S3][3]
|
3760
3765
|
#
|
3761
3766
|
# * *HTTP Status Code:* 403 Forbidden
|
3762
3767
|
#
|
@@ -3847,7 +3852,7 @@ module Aws::S3
|
|
3847
3852
|
# * *Description:* The request signature we calculated does not
|
3848
3853
|
# match the signature you provided. Check your Amazon Web Services
|
3849
3854
|
# secret access key and signing method. For more information, see
|
3850
|
-
# [REST Authentication][
|
3855
|
+
# [REST Authentication][4] and [SOAP Authentication][5] for
|
3851
3856
|
# details.
|
3852
3857
|
#
|
3853
3858
|
# * *HTTP Status Code:* 403 Forbidden
|
@@ -3856,7 +3861,7 @@ module Aws::S3
|
|
3856
3861
|
#
|
3857
3862
|
# * * *Code:* ServiceUnavailable
|
3858
3863
|
#
|
3859
|
-
# * *Description:*
|
3864
|
+
# * *Description:* Service is unable to handle request.
|
3860
3865
|
#
|
3861
3866
|
# * *HTTP Status Code:* 503 Service Unavailable
|
3862
3867
|
#
|
@@ -3926,10 +3931,11 @@ module Aws::S3
|
|
3926
3931
|
#
|
3927
3932
|
#
|
3928
3933
|
#
|
3929
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3930
|
-
# [2]:
|
3931
|
-
# [3]:
|
3932
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
3934
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
|
3935
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
3936
|
+
# [3]: http://aws.amazon.com/s3
|
3937
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
3938
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html
|
3933
3939
|
# @return [String]
|
3934
3940
|
#
|
3935
3941
|
# @!attribute [rw] message
|
@@ -3992,6 +3998,8 @@ module Aws::S3
|
|
3992
3998
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
|
3993
3999
|
#
|
3994
4000
|
# @!attribute [rw] status
|
4001
|
+
# Specifies whether Amazon S3 replicates existing source bucket
|
4002
|
+
# objects.
|
3995
4003
|
# @return [String]
|
3996
4004
|
#
|
3997
4005
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ExistingObjectReplication AWS API Documentation
|
@@ -4034,10 +4042,16 @@ module Aws::S3
|
|
4034
4042
|
# The accelerate configuration of the bucket.
|
4035
4043
|
# @return [String]
|
4036
4044
|
#
|
4045
|
+
# @!attribute [rw] request_charged
|
4046
|
+
# If present, indicates that the requester was successfully charged
|
4047
|
+
# for the request.
|
4048
|
+
# @return [String]
|
4049
|
+
#
|
4037
4050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationOutput AWS API Documentation
|
4038
4051
|
#
|
4039
4052
|
class GetBucketAccelerateConfigurationOutput < Struct.new(
|
4040
|
-
:status
|
4053
|
+
:status,
|
4054
|
+
:request_charged)
|
4041
4055
|
SENSITIVE = []
|
4042
4056
|
include Aws::Structure
|
4043
4057
|
end
|
@@ -4053,11 +4067,24 @@ module Aws::S3
|
|
4053
4067
|
# `403 Forbidden` (access denied).
|
4054
4068
|
# @return [String]
|
4055
4069
|
#
|
4070
|
+
# @!attribute [rw] request_payer
|
4071
|
+
# Confirms that the requester knows that they will be charged for the
|
4072
|
+
# request. Bucket owners need not specify this parameter in their
|
4073
|
+
# requests. For information about downloading objects from Requester
|
4074
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
4075
|
+
# in the *Amazon S3 User Guide*.
|
4076
|
+
#
|
4077
|
+
#
|
4078
|
+
#
|
4079
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4080
|
+
# @return [String]
|
4081
|
+
#
|
4056
4082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationRequest AWS API Documentation
|
4057
4083
|
#
|
4058
4084
|
class GetBucketAccelerateConfigurationRequest < Struct.new(
|
4059
4085
|
:bucket,
|
4060
|
-
:expected_bucket_owner
|
4086
|
+
:expected_bucket_owner,
|
4087
|
+
:request_payer)
|
4061
4088
|
SENSITIVE = []
|
4062
4089
|
include Aws::Structure
|
4063
4090
|
end
|
@@ -4081,6 +4108,20 @@ module Aws::S3
|
|
4081
4108
|
|
4082
4109
|
# @!attribute [rw] bucket
|
4083
4110
|
# Specifies the S3 bucket whose ACL is being requested.
|
4111
|
+
#
|
4112
|
+
# To use this API operation against an access point, provide the alias
|
4113
|
+
# of the access point in place of the bucket name.
|
4114
|
+
#
|
4115
|
+
# To use this API operation against an Object Lambda access point,
|
4116
|
+
# provide the alias of the Object Lambda access point in place of the
|
4117
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4118
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4119
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4120
|
+
# see [List of Error Codes][1].
|
4121
|
+
#
|
4122
|
+
#
|
4123
|
+
#
|
4124
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4084
4125
|
# @return [String]
|
4085
4126
|
#
|
4086
4127
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4150,6 +4191,20 @@ module Aws::S3
|
|
4150
4191
|
|
4151
4192
|
# @!attribute [rw] bucket
|
4152
4193
|
# The bucket name for which to get the cors configuration.
|
4194
|
+
#
|
4195
|
+
# To use this API operation against an access point, provide the alias
|
4196
|
+
# of the access point in place of the bucket name.
|
4197
|
+
#
|
4198
|
+
# To use this API operation against an Object Lambda access point,
|
4199
|
+
# provide the alias of the Object Lambda access point in place of the
|
4200
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4201
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4202
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4203
|
+
# see [List of Error Codes][1].
|
4204
|
+
#
|
4205
|
+
#
|
4206
|
+
#
|
4207
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4153
4208
|
# @return [String]
|
4154
4209
|
#
|
4155
4210
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4349,6 +4404,20 @@ module Aws::S3
|
|
4349
4404
|
|
4350
4405
|
# @!attribute [rw] bucket
|
4351
4406
|
# The name of the bucket for which to get the location.
|
4407
|
+
#
|
4408
|
+
# To use this API operation against an access point, provide the alias
|
4409
|
+
# of the access point in place of the bucket name.
|
4410
|
+
#
|
4411
|
+
# To use this API operation against an Object Lambda access point,
|
4412
|
+
# provide the alias of the Object Lambda access point in place of the
|
4413
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4414
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4415
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4416
|
+
# see [List of Error Codes][1].
|
4417
|
+
#
|
4418
|
+
#
|
4419
|
+
#
|
4420
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4352
4421
|
# @return [String]
|
4353
4422
|
#
|
4354
4423
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4421,7 +4490,9 @@ module Aws::S3
|
|
4421
4490
|
# @return [String]
|
4422
4491
|
#
|
4423
4492
|
# @!attribute [rw] id
|
4424
|
-
# The ID used to identify the metrics configuration.
|
4493
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
4494
|
+
# character limit and can only contain letters, numbers, periods,
|
4495
|
+
# dashes, and underscores.
|
4425
4496
|
# @return [String]
|
4426
4497
|
#
|
4427
4498
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4443,6 +4514,20 @@ module Aws::S3
|
|
4443
4514
|
# @!attribute [rw] bucket
|
4444
4515
|
# The name of the bucket for which to get the notification
|
4445
4516
|
# configuration.
|
4517
|
+
#
|
4518
|
+
# To use this API operation against an access point, provide the alias
|
4519
|
+
# of the access point in place of the bucket name.
|
4520
|
+
#
|
4521
|
+
# To use this API operation against an Object Lambda access point,
|
4522
|
+
# provide the alias of the Object Lambda access point in place of the
|
4523
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4524
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4525
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4526
|
+
# see [List of Error Codes][1].
|
4527
|
+
#
|
4528
|
+
#
|
4529
|
+
#
|
4530
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4446
4531
|
# @return [String]
|
4447
4532
|
#
|
4448
4533
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4507,6 +4592,20 @@ module Aws::S3
|
|
4507
4592
|
|
4508
4593
|
# @!attribute [rw] bucket
|
4509
4594
|
# The bucket name for which to get the bucket policy.
|
4595
|
+
#
|
4596
|
+
# To use this API operation against an access point, provide the alias
|
4597
|
+
# of the access point in place of the bucket name.
|
4598
|
+
#
|
4599
|
+
# To use this API operation against an Object Lambda access point,
|
4600
|
+
# provide the alias of the Object Lambda access point in place of the
|
4601
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4602
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4603
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4604
|
+
# see [List of Error Codes][1].
|
4605
|
+
#
|
4606
|
+
#
|
4607
|
+
#
|
4608
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4510
4609
|
# @return [String]
|
4511
4610
|
#
|
4512
4611
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4940,14 +5039,14 @@ module Aws::S3
|
|
4940
5039
|
# bucket name. For more information about access point ARNs, see
|
4941
5040
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
4942
5041
|
#
|
4943
|
-
# When
|
5042
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
4944
5043
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
4945
5044
|
# takes the form `
|
4946
5045
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
4947
|
-
# When
|
4948
|
-
# Services SDKs, you provide the Outposts
|
4949
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
4950
|
-
# [
|
5046
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5047
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5048
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5049
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
4951
5050
|
#
|
4952
5051
|
#
|
4953
5052
|
#
|
@@ -5010,9 +5109,8 @@ module Aws::S3
|
|
5010
5109
|
# @return [String]
|
5011
5110
|
#
|
5012
5111
|
# @!attribute [rw] object_attributes
|
5013
|
-
#
|
5014
|
-
#
|
5015
|
-
# not returned.
|
5112
|
+
# Specifies the fields at the root level that you want returned in the
|
5113
|
+
# response. Fields that you do not specify are not returned.
|
5016
5114
|
# @return [Array<String>]
|
5017
5115
|
#
|
5018
5116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation
|
@@ -5292,7 +5390,7 @@ module Aws::S3
|
|
5292
5390
|
#
|
5293
5391
|
# @!attribute [rw] server_side_encryption
|
5294
5392
|
# The server-side encryption algorithm used when storing this object
|
5295
|
-
# in Amazon S3 (for example, AES256
|
5393
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
5296
5394
|
# @return [String]
|
5297
5395
|
#
|
5298
5396
|
# @!attribute [rw] metadata
|
@@ -5313,14 +5411,14 @@ module Aws::S3
|
|
5313
5411
|
# @return [String]
|
5314
5412
|
#
|
5315
5413
|
# @!attribute [rw] ssekms_key_id
|
5316
|
-
# If present, specifies the ID of the
|
5317
|
-
#
|
5318
|
-
#
|
5414
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
5415
|
+
# symmetric encryption customer managed key that was used for the
|
5416
|
+
# object.
|
5319
5417
|
# @return [String]
|
5320
5418
|
#
|
5321
5419
|
# @!attribute [rw] bucket_key_enabled
|
5322
5420
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
5323
|
-
# encryption with
|
5421
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
5324
5422
|
# @return [Boolean]
|
5325
5423
|
#
|
5326
5424
|
# @!attribute [rw] storage_class
|
@@ -5422,14 +5520,14 @@ module Aws::S3
|
|
5422
5520
|
# When using an Object Lambda access point the hostname takes the form
|
5423
5521
|
# *AccessPointName*-*AccountId*.s3-object-lambda.*Region*.amazonaws.com.
|
5424
5522
|
#
|
5425
|
-
# When
|
5523
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5426
5524
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5427
5525
|
# takes the form `
|
5428
5526
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5429
|
-
# When
|
5430
|
-
# Services SDKs, you provide the Outposts
|
5431
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5432
|
-
# [
|
5527
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5528
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5529
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5530
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5433
5531
|
#
|
5434
5532
|
#
|
5435
5533
|
#
|
@@ -5464,7 +5562,7 @@ module Aws::S3
|
|
5464
5562
|
# @!attribute [rw] range
|
5465
5563
|
# Downloads the specified range bytes of an object. For more
|
5466
5564
|
# information about the HTTP Range header, see
|
5467
|
-
# [https://www.
|
5565
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-range][1].
|
5468
5566
|
#
|
5469
5567
|
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
5470
5568
|
# `GET` request.
|
@@ -5473,7 +5571,7 @@ module Aws::S3
|
|
5473
5571
|
#
|
5474
5572
|
#
|
5475
5573
|
#
|
5476
|
-
# [1]: https://www.
|
5574
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-range
|
5477
5575
|
# @return [String]
|
5478
5576
|
#
|
5479
5577
|
# @!attribute [rw] response_cache_control
|
@@ -5681,14 +5779,14 @@ module Aws::S3
|
|
5681
5779
|
# bucket name. For more information about access point ARNs, see
|
5682
5780
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
5683
5781
|
#
|
5684
|
-
# When
|
5782
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5685
5783
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5686
5784
|
# takes the form `
|
5687
5785
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5688
|
-
# When
|
5689
|
-
# Services SDKs, you provide the Outposts
|
5690
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5691
|
-
# [
|
5786
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5787
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5788
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5789
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5692
5790
|
#
|
5693
5791
|
#
|
5694
5792
|
#
|
@@ -5932,19 +6030,27 @@ module Aws::S3
|
|
5932
6030
|
# bucket name. For more information about access point ARNs, see
|
5933
6031
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
5934
6032
|
#
|
5935
|
-
# When
|
6033
|
+
# When you use this action with an Object Lambda access point, provide
|
6034
|
+
# the alias of the Object Lambda access point in place of the bucket
|
6035
|
+
# name. If the Object Lambda access point alias in a request is not
|
6036
|
+
# valid, the error code `InvalidAccessPointAliasError` is returned.
|
6037
|
+
# For more information about `InvalidAccessPointAliasError`, see [List
|
6038
|
+
# of Error Codes][2].
|
6039
|
+
#
|
6040
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5936
6041
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5937
6042
|
# takes the form `
|
5938
6043
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5939
|
-
# When
|
5940
|
-
# Services SDKs, you provide the Outposts
|
5941
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5942
|
-
# [
|
6044
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
6045
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
6046
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6047
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
5943
6048
|
#
|
5944
6049
|
#
|
5945
6050
|
#
|
5946
6051
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5947
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6052
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
6053
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5948
6054
|
# @return [String]
|
5949
6055
|
#
|
5950
6056
|
# @!attribute [rw] expected_bucket_owner
|
@@ -6121,11 +6227,8 @@ module Aws::S3
|
|
6121
6227
|
# @return [String]
|
6122
6228
|
#
|
6123
6229
|
# @!attribute [rw] server_side_encryption
|
6124
|
-
#
|
6125
|
-
# Amazon
|
6126
|
-
# the response includes this header with the value of the server-side
|
6127
|
-
# encryption algorithm used when storing this object in Amazon S3 (for
|
6128
|
-
# example, AES256, aws:kms).
|
6230
|
+
# The server-side encryption algorithm used when storing this object
|
6231
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
6129
6232
|
# @return [String]
|
6130
6233
|
#
|
6131
6234
|
# @!attribute [rw] metadata
|
@@ -6146,14 +6249,14 @@ module Aws::S3
|
|
6146
6249
|
# @return [String]
|
6147
6250
|
#
|
6148
6251
|
# @!attribute [rw] ssekms_key_id
|
6149
|
-
# If present, specifies the ID of the
|
6150
|
-
#
|
6151
|
-
#
|
6252
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
6253
|
+
# symmetric encryption customer managed key that was used for the
|
6254
|
+
# object.
|
6152
6255
|
# @return [String]
|
6153
6256
|
#
|
6154
6257
|
# @!attribute [rw] bucket_key_enabled
|
6155
6258
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
6156
|
-
# encryption with
|
6259
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
6157
6260
|
# @return [Boolean]
|
6158
6261
|
#
|
6159
6262
|
# @!attribute [rw] storage_class
|
@@ -6307,14 +6410,14 @@ module Aws::S3
|
|
6307
6410
|
# bucket name. For more information about access point ARNs, see
|
6308
6411
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
6309
6412
|
#
|
6310
|
-
# When
|
6413
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
6311
6414
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6312
6415
|
# takes the form `
|
6313
6416
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
6314
|
-
# When
|
6315
|
-
# Services SDKs, you provide the Outposts
|
6316
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
6317
|
-
# [
|
6417
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
6418
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
6419
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6420
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6318
6421
|
#
|
6319
6422
|
#
|
6320
6423
|
#
|
@@ -6347,8 +6450,10 @@ module Aws::S3
|
|
6347
6450
|
# @return [String]
|
6348
6451
|
#
|
6349
6452
|
# @!attribute [rw] range
|
6350
|
-
#
|
6351
|
-
#
|
6453
|
+
# HeadObject returns only the metadata for an object. If the Range is
|
6454
|
+
# satisfiable, only the `ContentLength` is affected in the response.
|
6455
|
+
# If the Range is not satisfiable, S3 returns a `416 - Requested Range
|
6456
|
+
# Not Satisfiable` error.
|
6352
6457
|
# @return [String]
|
6353
6458
|
#
|
6354
6459
|
# @!attribute [rw] version_id
|
@@ -6844,12 +6949,12 @@ module Aws::S3
|
|
6844
6949
|
#
|
6845
6950
|
# @!attribute [rw] filter
|
6846
6951
|
# Specifies object key name filtering rules. For information about key
|
6847
|
-
# name filtering, see [Configuring
|
6848
|
-
# *Amazon S3 User Guide*.
|
6952
|
+
# name filtering, see [Configuring event notifications using object
|
6953
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
6849
6954
|
#
|
6850
6955
|
#
|
6851
6956
|
#
|
6852
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6957
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
6853
6958
|
# @return [Types::NotificationConfigurationFilter]
|
6854
6959
|
#
|
6855
6960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LambdaFunctionConfiguration AWS API Documentation
|
@@ -6865,6 +6970,13 @@ module Aws::S3
|
|
6865
6970
|
|
6866
6971
|
# Container for lifecycle rules. You can add as many as 1000 rules.
|
6867
6972
|
#
|
6973
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
6974
|
+
# *Amazon S3 User Guide*.
|
6975
|
+
#
|
6976
|
+
#
|
6977
|
+
#
|
6978
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
6979
|
+
#
|
6868
6980
|
# @!attribute [rw] rules
|
6869
6981
|
# Specifies lifecycle configuration rules for an Amazon S3 bucket.
|
6870
6982
|
# @return [Array<Types::Rule>]
|
@@ -6879,9 +6991,17 @@ module Aws::S3
|
|
6879
6991
|
|
6880
6992
|
# Container for the expiration for the lifecycle of the object.
|
6881
6993
|
#
|
6994
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
6995
|
+
# *Amazon S3 User Guide*.
|
6996
|
+
#
|
6997
|
+
#
|
6998
|
+
#
|
6999
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
7000
|
+
#
|
6882
7001
|
# @!attribute [rw] date
|
6883
|
-
# Indicates at what date the object is to be moved or deleted.
|
6884
|
-
#
|
7002
|
+
# Indicates at what date the object is to be moved or deleted. The
|
7003
|
+
# date value must conform to the ISO 8601 format. The time is always
|
7004
|
+
# midnight UTC.
|
6885
7005
|
# @return [Time]
|
6886
7006
|
#
|
6887
7007
|
# @!attribute [rw] days
|
@@ -6908,6 +7028,13 @@ module Aws::S3
|
|
6908
7028
|
|
6909
7029
|
# A lifecycle rule for individual objects in an Amazon S3 bucket.
|
6910
7030
|
#
|
7031
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
7032
|
+
# *Amazon S3 User Guide*.
|
7033
|
+
#
|
7034
|
+
#
|
7035
|
+
#
|
7036
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
7037
|
+
#
|
6911
7038
|
# @!attribute [rw] expiration
|
6912
7039
|
# Specifies the expiration for the lifecycle of the object in the form
|
6913
7040
|
# of date, days and, whether the object has a delete marker.
|
@@ -6970,8 +7097,8 @@ module Aws::S3
|
|
6970
7097
|
# Specifies the days since the initiation of an incomplete multipart
|
6971
7098
|
# upload that Amazon S3 will wait before permanently removing all
|
6972
7099
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
6973
|
-
# Multipart Uploads Using a Bucket Lifecycle
|
6974
|
-
# S3 User Guide*.
|
7100
|
+
# Multipart Uploads Using a Bucket Lifecycle Configuration][1] in the
|
7101
|
+
# *Amazon S3 User Guide*.
|
6975
7102
|
#
|
6976
7103
|
#
|
6977
7104
|
#
|
@@ -7114,8 +7241,8 @@ module Aws::S3
|
|
7114
7241
|
# @return [String]
|
7115
7242
|
#
|
7116
7243
|
# @!attribute [rw] continuation_token
|
7117
|
-
# The ContinuationToken that represents a placeholder from where
|
7118
|
-
# request should begin.
|
7244
|
+
# The `ContinuationToken` that represents a placeholder from where
|
7245
|
+
# this request should begin.
|
7119
7246
|
# @return [String]
|
7120
7247
|
#
|
7121
7248
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7227,9 +7354,9 @@ module Aws::S3
|
|
7227
7354
|
#
|
7228
7355
|
# @!attribute [rw] continuation_token
|
7229
7356
|
# The marker used to continue an inventory configuration listing that
|
7230
|
-
# has been truncated. Use the NextContinuationToken from a
|
7231
|
-
# truncated list response to continue the listing. The
|
7232
|
-
# token is an opaque value that Amazon S3 understands.
|
7357
|
+
# has been truncated. Use the `NextContinuationToken` from a
|
7358
|
+
# previously truncated list response to continue the listing. The
|
7359
|
+
# continuation token is an opaque value that Amazon S3 understands.
|
7233
7360
|
# @return [String]
|
7234
7361
|
#
|
7235
7362
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7290,7 +7417,7 @@ module Aws::S3
|
|
7290
7417
|
#
|
7291
7418
|
# @!attribute [rw] continuation_token
|
7292
7419
|
# The marker that is used to continue a metrics configuration listing
|
7293
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7420
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7294
7421
|
# previously truncated list response to continue the listing. The
|
7295
7422
|
# continuation token is an opaque value that Amazon S3 understands.
|
7296
7423
|
# @return [String]
|
@@ -7393,13 +7520,18 @@ module Aws::S3
|
|
7393
7520
|
# Encoding type used by Amazon S3 to encode object keys in the
|
7394
7521
|
# response.
|
7395
7522
|
#
|
7396
|
-
# If you specify `encoding-type` request parameter, Amazon S3
|
7397
|
-
# this element in the response, and returns encoded key name
|
7398
|
-
# the following response elements:
|
7523
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7524
|
+
# includes this element in the response, and returns encoded key name
|
7525
|
+
# values in the following response elements:
|
7399
7526
|
#
|
7400
7527
|
# `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.
|
7401
7528
|
# @return [String]
|
7402
7529
|
#
|
7530
|
+
# @!attribute [rw] request_charged
|
7531
|
+
# If present, indicates that the requester was successfully charged
|
7532
|
+
# for the request.
|
7533
|
+
# @return [String]
|
7534
|
+
#
|
7403
7535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsOutput AWS API Documentation
|
7404
7536
|
#
|
7405
7537
|
class ListMultipartUploadsOutput < Struct.new(
|
@@ -7414,7 +7546,8 @@ module Aws::S3
|
|
7414
7546
|
:is_truncated,
|
7415
7547
|
:uploads,
|
7416
7548
|
:common_prefixes,
|
7417
|
-
:encoding_type
|
7549
|
+
:encoding_type,
|
7550
|
+
:request_charged)
|
7418
7551
|
SENSITIVE = []
|
7419
7552
|
include Aws::Structure
|
7420
7553
|
end
|
@@ -7431,14 +7564,14 @@ module Aws::S3
|
|
7431
7564
|
# bucket name. For more information about access point ARNs, see
|
7432
7565
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7433
7566
|
#
|
7434
|
-
# When
|
7567
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7435
7568
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7436
7569
|
# takes the form `
|
7437
7570
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7438
|
-
# When
|
7439
|
-
# Services SDKs, you provide the Outposts
|
7440
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7441
|
-
# [
|
7571
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
7572
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
7573
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7574
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7442
7575
|
#
|
7443
7576
|
#
|
7444
7577
|
#
|
@@ -7460,15 +7593,15 @@ module Aws::S3
|
|
7460
7593
|
#
|
7461
7594
|
# @!attribute [rw] encoding_type
|
7462
7595
|
# Requests Amazon S3 to encode the object keys in the response and
|
7463
|
-
# specifies the encoding method to use. An object key
|
7464
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7596
|
+
# specifies the encoding method to use. An object key can contain any
|
7597
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7465
7598
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7466
7599
|
# characters that are not supported in XML 1.0, you can add this
|
7467
7600
|
# parameter to request that Amazon S3 encode the keys in the response.
|
7468
7601
|
# @return [String]
|
7469
7602
|
#
|
7470
7603
|
# @!attribute [rw] key_marker
|
7471
|
-
# Together with upload-id-marker
|
7604
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
7472
7605
|
# multipart upload after which listing should begin.
|
7473
7606
|
#
|
7474
7607
|
# If `upload-id-marker` is not specified, only the keys
|
@@ -7490,8 +7623,8 @@ module Aws::S3
|
|
7490
7623
|
# @!attribute [rw] prefix
|
7491
7624
|
# Lists in-progress uploads only for those keys that begin with the
|
7492
7625
|
# specified prefix. You can use prefixes to separate a bucket into
|
7493
|
-
# different grouping of keys. (You can think of using prefix to make
|
7494
|
-
# groups in the same way you'd use a folder in a file system.)
|
7626
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
7627
|
+
# groups in the same way that you'd use a folder in a file system.)
|
7495
7628
|
# @return [String]
|
7496
7629
|
#
|
7497
7630
|
# @!attribute [rw] upload_id_marker
|
@@ -7509,6 +7642,18 @@ module Aws::S3
|
|
7509
7642
|
# `403 Forbidden` (access denied).
|
7510
7643
|
# @return [String]
|
7511
7644
|
#
|
7645
|
+
# @!attribute [rw] request_payer
|
7646
|
+
# Confirms that the requester knows that they will be charged for the
|
7647
|
+
# request. Bucket owners need not specify this parameter in their
|
7648
|
+
# requests. For information about downloading objects from Requester
|
7649
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
7650
|
+
# in the *Amazon S3 User Guide*.
|
7651
|
+
#
|
7652
|
+
#
|
7653
|
+
#
|
7654
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7655
|
+
# @return [String]
|
7656
|
+
#
|
7512
7657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation
|
7513
7658
|
#
|
7514
7659
|
class ListMultipartUploadsRequest < Struct.new(
|
@@ -7519,7 +7664,8 @@ module Aws::S3
|
|
7519
7664
|
:max_uploads,
|
7520
7665
|
:prefix,
|
7521
7666
|
:upload_id_marker,
|
7522
|
-
:expected_bucket_owner
|
7667
|
+
:expected_bucket_owner,
|
7668
|
+
:request_payer)
|
7523
7669
|
SENSITIVE = []
|
7524
7670
|
include Aws::Structure
|
7525
7671
|
end
|
@@ -7527,9 +7673,9 @@ module Aws::S3
|
|
7527
7673
|
# @!attribute [rw] is_truncated
|
7528
7674
|
# A flag that indicates whether Amazon S3 returned all of the results
|
7529
7675
|
# that satisfied the search criteria. If your results were truncated,
|
7530
|
-
# you can make a follow-up paginated request using the
|
7531
|
-
# and NextVersionIdMarker response parameters as a
|
7532
|
-
# another request to return the rest of the results.
|
7676
|
+
# you can make a follow-up paginated request by using the
|
7677
|
+
# `NextKeyMarker` and `NextVersionIdMarker` response parameters as a
|
7678
|
+
# starting place in another request to return the rest of the results.
|
7533
7679
|
# @return [Boolean]
|
7534
7680
|
#
|
7535
7681
|
# @!attribute [rw] key_marker
|
@@ -7551,7 +7697,7 @@ module Aws::S3
|
|
7551
7697
|
# When the number of responses exceeds the value of `MaxKeys`,
|
7552
7698
|
# `NextVersionIdMarker` specifies the first object version not
|
7553
7699
|
# returned that satisfies the search criteria. Use this value for the
|
7554
|
-
# version-id-marker request parameter in a subsequent request.
|
7700
|
+
# `version-id-marker` request parameter in a subsequent request.
|
7555
7701
|
# @return [String]
|
7556
7702
|
#
|
7557
7703
|
# @!attribute [rw] versions
|
@@ -7576,7 +7722,7 @@ module Aws::S3
|
|
7576
7722
|
# that you specify to group keys. All keys that contain the same
|
7577
7723
|
# string between the prefix and the first occurrence of the delimiter
|
7578
7724
|
# are grouped under a single result element in `CommonPrefixes`. These
|
7579
|
-
# groups are counted as one result against the max-keys limitation.
|
7725
|
+
# groups are counted as one result against the `max-keys` limitation.
|
7580
7726
|
# These keys are not returned elsewhere in the response.
|
7581
7727
|
# @return [String]
|
7582
7728
|
#
|
@@ -7593,13 +7739,18 @@ module Aws::S3
|
|
7593
7739
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7594
7740
|
# XML response.
|
7595
7741
|
#
|
7596
|
-
# If you specify encoding-type request parameter, Amazon S3
|
7597
|
-
# this element in the response, and returns encoded key name
|
7598
|
-
# the following response elements:
|
7742
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7743
|
+
# includes this element in the response, and returns encoded key name
|
7744
|
+
# values in the following response elements:
|
7599
7745
|
#
|
7600
7746
|
# `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.
|
7601
7747
|
# @return [String]
|
7602
7748
|
#
|
7749
|
+
# @!attribute [rw] request_charged
|
7750
|
+
# If present, indicates that the requester was successfully charged
|
7751
|
+
# for the request.
|
7752
|
+
# @return [String]
|
7753
|
+
#
|
7603
7754
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsOutput AWS API Documentation
|
7604
7755
|
#
|
7605
7756
|
class ListObjectVersionsOutput < Struct.new(
|
@@ -7615,7 +7766,8 @@ module Aws::S3
|
|
7615
7766
|
:delimiter,
|
7616
7767
|
:max_keys,
|
7617
7768
|
:common_prefixes,
|
7618
|
-
:encoding_type
|
7769
|
+
:encoding_type,
|
7770
|
+
:request_charged)
|
7619
7771
|
SENSITIVE = []
|
7620
7772
|
include Aws::Structure
|
7621
7773
|
end
|
@@ -7628,15 +7780,15 @@ module Aws::S3
|
|
7628
7780
|
# A delimiter is a character that you specify to group keys. All keys
|
7629
7781
|
# that contain the same string between the `prefix` and the first
|
7630
7782
|
# occurrence of the delimiter are grouped under a single result
|
7631
|
-
# element in CommonPrefixes
|
7632
|
-
# against the max-keys limitation. These keys are not returned
|
7783
|
+
# element in `CommonPrefixes`. These groups are counted as one result
|
7784
|
+
# against the `max-keys` limitation. These keys are not returned
|
7633
7785
|
# elsewhere in the response.
|
7634
7786
|
# @return [String]
|
7635
7787
|
#
|
7636
7788
|
# @!attribute [rw] encoding_type
|
7637
7789
|
# Requests Amazon S3 to encode the object keys in the response and
|
7638
|
-
# specifies the encoding method to use. An object key
|
7639
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7790
|
+
# specifies the encoding method to use. An object key can contain any
|
7791
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7640
7792
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7641
7793
|
# characters that are not supported in XML 1.0, you can add this
|
7642
7794
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7647,22 +7799,22 @@ module Aws::S3
|
|
7647
7799
|
# @return [String]
|
7648
7800
|
#
|
7649
7801
|
# @!attribute [rw] max_keys
|
7650
|
-
# Sets the maximum number of keys returned in the response. By
|
7651
|
-
# the action returns up to 1,000 key names. The response
|
7652
|
-
# fewer keys but will never contain more. If additional
|
7653
|
-
# the search criteria, but were not returned because
|
7654
|
-
# exceeded, the response contains
|
7655
|
-
#
|
7656
|
-
#
|
7802
|
+
# Sets the maximum number of keys returned in the response. By
|
7803
|
+
# default, the action returns up to 1,000 key names. The response
|
7804
|
+
# might contain fewer keys but will never contain more. If additional
|
7805
|
+
# keys satisfy the search criteria, but were not returned because
|
7806
|
+
# `max-keys` was exceeded, the response contains
|
7807
|
+
# `<isTruncated>true</isTruncated>`. To return the additional keys,
|
7808
|
+
# see `key-marker` and `version-id-marker`.
|
7657
7809
|
# @return [Integer]
|
7658
7810
|
#
|
7659
7811
|
# @!attribute [rw] prefix
|
7660
7812
|
# Use this parameter to select only those keys that begin with the
|
7661
7813
|
# specified prefix. You can use prefixes to separate a bucket into
|
7662
|
-
# different groupings of keys. (You can think of using prefix to
|
7663
|
-
# groups in the same way you'd use a folder in a file
|
7664
|
-
# can use prefix with delimiter to roll up numerous
|
7665
|
-
# single result under CommonPrefixes
|
7814
|
+
# different groupings of keys. (You can think of using `prefix` to
|
7815
|
+
# make groups in the same way that you'd use a folder in a file
|
7816
|
+
# system.) You can use `prefix` with `delimiter` to roll up numerous
|
7817
|
+
# objects into a single result under `CommonPrefixes`.
|
7666
7818
|
# @return [String]
|
7667
7819
|
#
|
7668
7820
|
# @!attribute [rw] version_id_marker
|
@@ -7675,6 +7827,23 @@ module Aws::S3
|
|
7675
7827
|
# `403 Forbidden` (access denied).
|
7676
7828
|
# @return [String]
|
7677
7829
|
#
|
7830
|
+
# @!attribute [rw] request_payer
|
7831
|
+
# Confirms that the requester knows that they will be charged for the
|
7832
|
+
# request. Bucket owners need not specify this parameter in their
|
7833
|
+
# requests. For information about downloading objects from Requester
|
7834
|
+
# Pays buckets, see [Downloading Objects in Requester Pays Buckets][1]
|
7835
|
+
# in the *Amazon S3 User Guide*.
|
7836
|
+
#
|
7837
|
+
#
|
7838
|
+
#
|
7839
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7840
|
+
# @return [String]
|
7841
|
+
#
|
7842
|
+
# @!attribute [rw] optional_object_attributes
|
7843
|
+
# Specifies the optional fields that you want returned in the
|
7844
|
+
# response. Fields that you do not specify are not returned.
|
7845
|
+
# @return [Array<String>]
|
7846
|
+
#
|
7678
7847
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
|
7679
7848
|
#
|
7680
7849
|
class ListObjectVersionsRequest < Struct.new(
|
@@ -7685,7 +7854,9 @@ module Aws::S3
|
|
7685
7854
|
:max_keys,
|
7686
7855
|
:prefix,
|
7687
7856
|
:version_id_marker,
|
7688
|
-
:expected_bucket_owner
|
7857
|
+
:expected_bucket_owner,
|
7858
|
+
:request_payer,
|
7859
|
+
:optional_object_attributes)
|
7689
7860
|
SENSITIVE = []
|
7690
7861
|
include Aws::Structure
|
7691
7862
|
end
|
@@ -7701,14 +7872,18 @@ module Aws::S3
|
|
7701
7872
|
# @return [String]
|
7702
7873
|
#
|
7703
7874
|
# @!attribute [rw] next_marker
|
7704
|
-
# When response is truncated (the IsTruncated element value in
|
7705
|
-
# response is true), you can use the key name in this field as
|
7706
|
-
# in the subsequent request to get next set
|
7707
|
-
# lists objects in alphabetical order
|
7708
|
-
#
|
7709
|
-
#
|
7710
|
-
#
|
7711
|
-
#
|
7875
|
+
# When the response is truncated (the `IsTruncated` element value in
|
7876
|
+
# the response is `true`), you can use the key name in this field as
|
7877
|
+
# the `marker` parameter in the subsequent request to get the next set
|
7878
|
+
# of objects. Amazon S3 lists objects in alphabetical order.
|
7879
|
+
#
|
7880
|
+
# <note markdown="1"> This element is returned only if you have the `delimiter` request
|
7881
|
+
# parameter specified. If the response does not include the
|
7882
|
+
# `NextMarker` element and it is truncated, you can use the value of
|
7883
|
+
# the last `Key` element in the response as the `marker` parameter in
|
7884
|
+
# the subsequent request to get the next set of object keys.
|
7885
|
+
#
|
7886
|
+
# </note>
|
7712
7887
|
# @return [String]
|
7713
7888
|
#
|
7714
7889
|
# @!attribute [rw] contents
|
@@ -7739,19 +7914,20 @@ module Aws::S3
|
|
7739
7914
|
# All of the keys (up to 1,000) rolled up in a common prefix count as
|
7740
7915
|
# a single return when calculating the number of returns.
|
7741
7916
|
#
|
7742
|
-
# A response can contain CommonPrefixes only if you specify a
|
7917
|
+
# A response can contain `CommonPrefixes` only if you specify a
|
7743
7918
|
# delimiter.
|
7744
7919
|
#
|
7745
|
-
# CommonPrefixes contains all (if there are any) keys between
|
7746
|
-
# and the next occurrence of the string specified by the
|
7920
|
+
# `CommonPrefixes` contains all (if there are any) keys between
|
7921
|
+
# `Prefix` and the next occurrence of the string specified by the
|
7922
|
+
# delimiter.
|
7747
7923
|
#
|
7748
|
-
# CommonPrefixes lists keys that act like subdirectories in the
|
7749
|
-
# directory specified by Prefix
|
7924
|
+
# `CommonPrefixes` lists keys that act like subdirectories in the
|
7925
|
+
# directory specified by `Prefix`.
|
7750
7926
|
#
|
7751
|
-
# For example, if the prefix is notes
|
7752
|
-
# (
|
7753
|
-
# of the keys that roll up into a common prefix
|
7754
|
-
# return when calculating the number of returns.
|
7927
|
+
# For example, if the prefix is `notes/` and the delimiter is a slash
|
7928
|
+
# (`/`), as in `notes/summer/july`, the common prefix is
|
7929
|
+
# `notes/summer/`. All of the keys that roll up into a common prefix
|
7930
|
+
# count as a single return when calculating the number of returns.
|
7755
7931
|
# @return [Array<Types::CommonPrefix>]
|
7756
7932
|
#
|
7757
7933
|
# @!attribute [rw] encoding_type
|
@@ -7759,6 +7935,11 @@ module Aws::S3
|
|
7759
7935
|
# response.
|
7760
7936
|
# @return [String]
|
7761
7937
|
#
|
7938
|
+
# @!attribute [rw] request_charged
|
7939
|
+
# If present, indicates that the requester was successfully charged
|
7940
|
+
# for the request.
|
7941
|
+
# @return [String]
|
7942
|
+
#
|
7762
7943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation
|
7763
7944
|
#
|
7764
7945
|
class ListObjectsOutput < Struct.new(
|
@@ -7771,7 +7952,8 @@ module Aws::S3
|
|
7771
7952
|
:delimiter,
|
7772
7953
|
:max_keys,
|
7773
7954
|
:common_prefixes,
|
7774
|
-
:encoding_type
|
7955
|
+
:encoding_type,
|
7956
|
+
:request_charged)
|
7775
7957
|
SENSITIVE = []
|
7776
7958
|
include Aws::Structure
|
7777
7959
|
end
|
@@ -7788,14 +7970,14 @@ module Aws::S3
|
|
7788
7970
|
# bucket name. For more information about access point ARNs, see
|
7789
7971
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7790
7972
|
#
|
7791
|
-
# When
|
7973
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7792
7974
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7793
7975
|
# takes the form `
|
7794
7976
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7795
|
-
# When
|
7796
|
-
# Services SDKs, you provide the Outposts
|
7797
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7798
|
-
# [
|
7977
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
7978
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
7979
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7980
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7799
7981
|
#
|
7800
7982
|
#
|
7801
7983
|
#
|
@@ -7804,13 +7986,13 @@ module Aws::S3
|
|
7804
7986
|
# @return [String]
|
7805
7987
|
#
|
7806
7988
|
# @!attribute [rw] delimiter
|
7807
|
-
# A delimiter is a character you use to group keys.
|
7989
|
+
# A delimiter is a character that you use to group keys.
|
7808
7990
|
# @return [String]
|
7809
7991
|
#
|
7810
7992
|
# @!attribute [rw] encoding_type
|
7811
7993
|
# Requests Amazon S3 to encode the object keys in the response and
|
7812
|
-
# specifies the encoding method to use. An object key
|
7813
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7994
|
+
# specifies the encoding method to use. An object key can contain any
|
7995
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7814
7996
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7815
7997
|
# characters that are not supported in XML 1.0, you can add this
|
7816
7998
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7823,9 +8005,9 @@ module Aws::S3
|
|
7823
8005
|
# @return [String]
|
7824
8006
|
#
|
7825
8007
|
# @!attribute [rw] max_keys
|
7826
|
-
# Sets the maximum number of keys returned in the response. By
|
7827
|
-
# the action returns up to 1,000 key names. The response
|
7828
|
-
# fewer keys but will never contain more.
|
8008
|
+
# Sets the maximum number of keys returned in the response. By
|
8009
|
+
# default, the action returns up to 1,000 key names. The response
|
8010
|
+
# might contain fewer keys but will never contain more.
|
7829
8011
|
# @return [Integer]
|
7830
8012
|
#
|
7831
8013
|
# @!attribute [rw] prefix
|
@@ -7844,6 +8026,11 @@ module Aws::S3
|
|
7844
8026
|
# `403 Forbidden` (access denied).
|
7845
8027
|
# @return [String]
|
7846
8028
|
#
|
8029
|
+
# @!attribute [rw] optional_object_attributes
|
8030
|
+
# Specifies the optional fields that you want returned in the
|
8031
|
+
# response. Fields that you do not specify are not returned.
|
8032
|
+
# @return [Array<String>]
|
8033
|
+
#
|
7847
8034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
|
7848
8035
|
#
|
7849
8036
|
class ListObjectsRequest < Struct.new(
|
@@ -7854,15 +8041,17 @@ module Aws::S3
|
|
7854
8041
|
:max_keys,
|
7855
8042
|
:prefix,
|
7856
8043
|
:request_payer,
|
7857
|
-
:expected_bucket_owner
|
8044
|
+
:expected_bucket_owner,
|
8045
|
+
:optional_object_attributes)
|
7858
8046
|
SENSITIVE = []
|
7859
8047
|
include Aws::Structure
|
7860
8048
|
end
|
7861
8049
|
|
7862
8050
|
# @!attribute [rw] is_truncated
|
7863
|
-
# Set to false if all of the results were returned. Set to true if
|
8051
|
+
# Set to `false` if all of the results were returned. Set to `true` if
|
7864
8052
|
# more keys are available to return. If the number of results exceeds
|
7865
|
-
# that specified by MaxKeys
|
8053
|
+
# that specified by `MaxKeys`, all of the results might not be
|
8054
|
+
# returned.
|
7866
8055
|
# @return [Boolean]
|
7867
8056
|
#
|
7868
8057
|
# @!attribute [rw] contents
|
@@ -7881,14 +8070,14 @@ module Aws::S3
|
|
7881
8070
|
# bucket name. For more information about access point ARNs, see
|
7882
8071
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7883
8072
|
#
|
7884
|
-
# When
|
8073
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7885
8074
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7886
8075
|
# takes the form `
|
7887
8076
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7888
|
-
# When
|
7889
|
-
# Services SDKs, you provide the Outposts
|
7890
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7891
|
-
# [
|
8077
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8078
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8079
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8080
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7892
8081
|
#
|
7893
8082
|
#
|
7894
8083
|
#
|
@@ -7901,17 +8090,17 @@ module Aws::S3
|
|
7901
8090
|
# @return [String]
|
7902
8091
|
#
|
7903
8092
|
# @!attribute [rw] delimiter
|
7904
|
-
# Causes keys that contain the same string between the prefix and
|
7905
|
-
# first occurrence of the delimiter to be rolled up into a single
|
7906
|
-
# result element in the CommonPrefixes collection. These rolled-up
|
8093
|
+
# Causes keys that contain the same string between the `prefix` and
|
8094
|
+
# the first occurrence of the delimiter to be rolled up into a single
|
8095
|
+
# result element in the `CommonPrefixes` collection. These rolled-up
|
7907
8096
|
# keys are not returned elsewhere in the response. Each rolled-up
|
7908
8097
|
# result counts as only one return against the `MaxKeys` value.
|
7909
8098
|
# @return [String]
|
7910
8099
|
#
|
7911
8100
|
# @!attribute [rw] max_keys
|
7912
|
-
# Sets the maximum number of keys returned in the response. By
|
7913
|
-
# the action returns up to 1,000 key names. The response
|
7914
|
-
# fewer keys but will never contain more.
|
8101
|
+
# Sets the maximum number of keys returned in the response. By
|
8102
|
+
# default, the action returns up to 1,000 key names. The response
|
8103
|
+
# might contain fewer keys but will never contain more.
|
7915
8104
|
# @return [Integer]
|
7916
8105
|
#
|
7917
8106
|
# @!attribute [rw] common_prefixes
|
@@ -7938,7 +8127,7 @@ module Aws::S3
|
|
7938
8127
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7939
8128
|
# XML response.
|
7940
8129
|
#
|
7941
|
-
# If you specify the encoding-type request parameter, Amazon S3
|
8130
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7942
8131
|
# includes this element in the response, and returns encoded key name
|
7943
8132
|
# values in the following response elements:
|
7944
8133
|
#
|
@@ -7946,13 +8135,14 @@ module Aws::S3
|
|
7946
8135
|
# @return [String]
|
7947
8136
|
#
|
7948
8137
|
# @!attribute [rw] key_count
|
7949
|
-
# KeyCount is the number of keys returned with this request.
|
7950
|
-
# will always be less than or
|
7951
|
-
# 50 keys, your result will include
|
8138
|
+
# `KeyCount` is the number of keys returned with this request.
|
8139
|
+
# `KeyCount` will always be less than or equal to the `MaxKeys` field.
|
8140
|
+
# For example, if you ask for 50 keys, your result will include 50
|
8141
|
+
# keys or fewer.
|
7952
8142
|
# @return [Integer]
|
7953
8143
|
#
|
7954
8144
|
# @!attribute [rw] continuation_token
|
7955
|
-
# If ContinuationToken was sent with the request, it is included in
|
8145
|
+
# If `ContinuationToken` was sent with the request, it is included in
|
7956
8146
|
# the response.
|
7957
8147
|
# @return [String]
|
7958
8148
|
#
|
@@ -7969,6 +8159,11 @@ module Aws::S3
|
|
7969
8159
|
# response.
|
7970
8160
|
# @return [String]
|
7971
8161
|
#
|
8162
|
+
# @!attribute [rw] request_charged
|
8163
|
+
# If present, indicates that the requester was successfully charged
|
8164
|
+
# for the request.
|
8165
|
+
# @return [String]
|
8166
|
+
#
|
7972
8167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Output AWS API Documentation
|
7973
8168
|
#
|
7974
8169
|
class ListObjectsV2Output < Struct.new(
|
@@ -7983,7 +8178,8 @@ module Aws::S3
|
|
7983
8178
|
:key_count,
|
7984
8179
|
:continuation_token,
|
7985
8180
|
:next_continuation_token,
|
7986
|
-
:start_after
|
8181
|
+
:start_after,
|
8182
|
+
:request_charged)
|
7987
8183
|
SENSITIVE = []
|
7988
8184
|
include Aws::Structure
|
7989
8185
|
end
|
@@ -8000,14 +8196,14 @@ module Aws::S3
|
|
8000
8196
|
# bucket name. For more information about access point ARNs, see
|
8001
8197
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
8002
8198
|
#
|
8003
|
-
# When
|
8199
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
8004
8200
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8005
8201
|
# takes the form `
|
8006
8202
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8007
|
-
# When
|
8008
|
-
# Services SDKs, you provide the Outposts
|
8009
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
8010
|
-
# [
|
8203
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8204
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8205
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8206
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8011
8207
|
#
|
8012
8208
|
#
|
8013
8209
|
#
|
@@ -8016,7 +8212,7 @@ module Aws::S3
|
|
8016
8212
|
# @return [String]
|
8017
8213
|
#
|
8018
8214
|
# @!attribute [rw] delimiter
|
8019
|
-
# A delimiter is a character you use to group keys.
|
8215
|
+
# A delimiter is a character that you use to group keys.
|
8020
8216
|
# @return [String]
|
8021
8217
|
#
|
8022
8218
|
# @!attribute [rw] encoding_type
|
@@ -8025,9 +8221,9 @@ module Aws::S3
|
|
8025
8221
|
# @return [String]
|
8026
8222
|
#
|
8027
8223
|
# @!attribute [rw] max_keys
|
8028
|
-
# Sets the maximum number of keys returned in the response. By
|
8029
|
-
# the action returns up to 1,000 key names. The response
|
8030
|
-
# fewer keys but will never contain more.
|
8224
|
+
# Sets the maximum number of keys returned in the response. By
|
8225
|
+
# default, the action returns up to 1,000 key names. The response
|
8226
|
+
# might contain fewer keys but will never contain more.
|
8031
8227
|
# @return [Integer]
|
8032
8228
|
#
|
8033
8229
|
# @!attribute [rw] prefix
|
@@ -8035,15 +8231,15 @@ module Aws::S3
|
|
8035
8231
|
# @return [String]
|
8036
8232
|
#
|
8037
8233
|
# @!attribute [rw] continuation_token
|
8038
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8039
|
-
# continued on this bucket with a token. ContinuationToken is
|
8234
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8235
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8040
8236
|
# obfuscated and is not a real key.
|
8041
8237
|
# @return [String]
|
8042
8238
|
#
|
8043
8239
|
# @!attribute [rw] fetch_owner
|
8044
|
-
# The owner field is not present in
|
8045
|
-
# return owner field with each key in the result then set
|
8046
|
-
#
|
8240
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8241
|
+
# want to return the owner field with each key in the result, then set
|
8242
|
+
# the `FetchOwner` field to `true`.
|
8047
8243
|
# @return [Boolean]
|
8048
8244
|
#
|
8049
8245
|
# @!attribute [rw] start_after
|
@@ -8064,6 +8260,11 @@ module Aws::S3
|
|
8064
8260
|
# `403 Forbidden` (access denied).
|
8065
8261
|
# @return [String]
|
8066
8262
|
#
|
8263
|
+
# @!attribute [rw] optional_object_attributes
|
8264
|
+
# Specifies the optional fields that you want returned in the
|
8265
|
+
# response. Fields that you do not specify are not returned.
|
8266
|
+
# @return [Array<String>]
|
8267
|
+
#
|
8067
8268
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
|
8068
8269
|
#
|
8069
8270
|
class ListObjectsV2Request < Struct.new(
|
@@ -8076,7 +8277,8 @@ module Aws::S3
|
|
8076
8277
|
:fetch_owner,
|
8077
8278
|
:start_after,
|
8078
8279
|
:request_payer,
|
8079
|
-
:expected_bucket_owner
|
8280
|
+
:expected_bucket_owner,
|
8281
|
+
:optional_object_attributes)
|
8080
8282
|
SENSITIVE = []
|
8081
8283
|
include Aws::Structure
|
8082
8284
|
end
|
@@ -8088,7 +8290,7 @@ module Aws::S3
|
|
8088
8290
|
# includes this header indicating when the initiated multipart upload
|
8089
8291
|
# will become eligible for abort operation. For more information, see
|
8090
8292
|
# [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
8091
|
-
#
|
8293
|
+
# Configuration][1].
|
8092
8294
|
#
|
8093
8295
|
# The response will also include the `x-amz-abort-rule-id` header that
|
8094
8296
|
# will provide the ID of the lifecycle configuration rule that defines
|
@@ -8127,7 +8329,7 @@ module Aws::S3
|
|
8127
8329
|
#
|
8128
8330
|
# @!attribute [rw] next_part_number_marker
|
8129
8331
|
# When a list is truncated, this element specifies the last part in
|
8130
|
-
# the list, as well as the value to use for the part-number-marker
|
8332
|
+
# the list, as well as the value to use for the `part-number-marker`
|
8131
8333
|
# request parameter in a subsequent request.
|
8132
8334
|
# @return [Integer]
|
8133
8335
|
#
|
@@ -8209,14 +8411,14 @@ module Aws::S3
|
|
8209
8411
|
# bucket name. For more information about access point ARNs, see
|
8210
8412
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
8211
8413
|
#
|
8212
|
-
# When
|
8414
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
8213
8415
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8214
8416
|
# takes the form `
|
8215
8417
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8216
|
-
# When
|
8217
|
-
# Services SDKs, you provide the Outposts
|
8218
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
8219
|
-
# [
|
8418
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8419
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8420
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8421
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8220
8422
|
#
|
8221
8423
|
#
|
8222
8424
|
#
|
@@ -8360,11 +8562,11 @@ module Aws::S3
|
|
8360
8562
|
# A metadata key-value pair to store with an object.
|
8361
8563
|
#
|
8362
8564
|
# @!attribute [rw] name
|
8363
|
-
# Name of the
|
8565
|
+
# Name of the object.
|
8364
8566
|
# @return [String]
|
8365
8567
|
#
|
8366
8568
|
# @!attribute [rw] value
|
8367
|
-
# Value of the
|
8569
|
+
# Value of the object.
|
8368
8570
|
# @return [String]
|
8369
8571
|
#
|
8370
8572
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation
|
@@ -8436,7 +8638,9 @@ module Aws::S3
|
|
8436
8638
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html
|
8437
8639
|
#
|
8438
8640
|
# @!attribute [rw] id
|
8439
|
-
# The ID used to identify the metrics configuration.
|
8641
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
8642
|
+
# character limit and can only contain letters, numbers, periods,
|
8643
|
+
# dashes, and underscores.
|
8440
8644
|
# @return [String]
|
8441
8645
|
#
|
8442
8646
|
# @!attribute [rw] filter
|
@@ -8706,12 +8910,12 @@ module Aws::S3
|
|
8706
8910
|
end
|
8707
8911
|
|
8708
8912
|
# Specifies object key name filtering rules. For information about key
|
8709
|
-
# name filtering, see [Configuring
|
8710
|
-
# *Amazon S3 User Guide*.
|
8913
|
+
# name filtering, see [Configuring event notifications using object key
|
8914
|
+
# name filtering][1] in the *Amazon S3 User Guide*.
|
8711
8915
|
#
|
8712
8916
|
#
|
8713
8917
|
#
|
8714
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8918
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
8715
8919
|
#
|
8716
8920
|
# @!attribute [rw] key
|
8717
8921
|
# A container for object key name prefix and suffix filtering rules.
|
@@ -8777,6 +8981,18 @@ module Aws::S3
|
|
8777
8981
|
# The owner of the object
|
8778
8982
|
# @return [Types::Owner]
|
8779
8983
|
#
|
8984
|
+
# @!attribute [rw] restore_status
|
8985
|
+
# Specifies the restoration status of an object. Objects in certain
|
8986
|
+
# storage classes must be restored before they can be retrieved. For
|
8987
|
+
# more information about these storage classes and how to work with
|
8988
|
+
# archived objects, see [ Working with archived objects][1] in the
|
8989
|
+
# *Amazon S3 User Guide*.
|
8990
|
+
#
|
8991
|
+
#
|
8992
|
+
#
|
8993
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
8994
|
+
# @return [Types::RestoreStatus]
|
8995
|
+
#
|
8780
8996
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation
|
8781
8997
|
#
|
8782
8998
|
class Object < Struct.new(
|
@@ -8786,7 +9002,8 @@ module Aws::S3
|
|
8786
9002
|
:checksum_algorithm,
|
8787
9003
|
:size,
|
8788
9004
|
:storage_class,
|
8789
|
-
:owner
|
9005
|
+
:owner,
|
9006
|
+
:restore_status)
|
8790
9007
|
SENSITIVE = []
|
8791
9008
|
include Aws::Structure
|
8792
9009
|
end
|
@@ -9021,6 +9238,18 @@ module Aws::S3
|
|
9021
9238
|
# Specifies the owner of the object.
|
9022
9239
|
# @return [Types::Owner]
|
9023
9240
|
#
|
9241
|
+
# @!attribute [rw] restore_status
|
9242
|
+
# Specifies the restoration status of an object. Objects in certain
|
9243
|
+
# storage classes must be restored before they can be retrieved. For
|
9244
|
+
# more information about these storage classes and how to work with
|
9245
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9246
|
+
# *Amazon S3 User Guide*.
|
9247
|
+
#
|
9248
|
+
#
|
9249
|
+
#
|
9250
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9251
|
+
# @return [Types::RestoreStatus]
|
9252
|
+
#
|
9024
9253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
|
9025
9254
|
#
|
9026
9255
|
class ObjectVersion < Struct.new(
|
@@ -9032,7 +9261,8 @@ module Aws::S3
|
|
9032
9261
|
:version_id,
|
9033
9262
|
:is_latest,
|
9034
9263
|
:last_modified,
|
9035
|
-
:owner
|
9264
|
+
:owner,
|
9265
|
+
:restore_status)
|
9036
9266
|
SENSITIVE = []
|
9037
9267
|
include Aws::Structure
|
9038
9268
|
end
|
@@ -9074,7 +9304,24 @@ module Aws::S3
|
|
9074
9304
|
# Container for the owner's display name and ID.
|
9075
9305
|
#
|
9076
9306
|
# @!attribute [rw] display_name
|
9077
|
-
# Container for the display name of the owner.
|
9307
|
+
# Container for the display name of the owner. This value is only
|
9308
|
+
# supported in the following Amazon Web Services Regions:
|
9309
|
+
#
|
9310
|
+
# * US East (N. Virginia)
|
9311
|
+
#
|
9312
|
+
# * US West (N. California)
|
9313
|
+
#
|
9314
|
+
# * US West (Oregon)
|
9315
|
+
#
|
9316
|
+
# * Asia Pacific (Singapore)
|
9317
|
+
#
|
9318
|
+
# * Asia Pacific (Sydney)
|
9319
|
+
#
|
9320
|
+
# * Asia Pacific (Tokyo)
|
9321
|
+
#
|
9322
|
+
# * Europe (Ireland)
|
9323
|
+
#
|
9324
|
+
# * South America (São Paulo)
|
9078
9325
|
# @return [String]
|
9079
9326
|
#
|
9080
9327
|
# @!attribute [rw] id
|
@@ -9579,10 +9826,14 @@ module Aws::S3
|
|
9579
9826
|
|
9580
9827
|
# @!attribute [rw] bucket
|
9581
9828
|
# Specifies default encryption for a bucket using server-side
|
9582
|
-
# encryption with
|
9583
|
-
#
|
9584
|
-
#
|
9585
|
-
#
|
9829
|
+
# encryption with different key options. By default, all buckets have
|
9830
|
+
# a default encryption configuration that uses server-side encryption
|
9831
|
+
# with Amazon S3 managed keys (SSE-S3). You can optionally configure
|
9832
|
+
# default encryption for a bucket by using server-side encryption with
|
9833
|
+
# an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key
|
9834
|
+
# (SSE-C). For information about the bucket default encryption
|
9835
|
+
# feature, see [Amazon S3 Bucket Default Encryption][1] in the *Amazon
|
9836
|
+
# S3 User Guide*.
|
9586
9837
|
#
|
9587
9838
|
#
|
9588
9839
|
#
|
@@ -9835,7 +10086,9 @@ module Aws::S3
|
|
9835
10086
|
# @return [String]
|
9836
10087
|
#
|
9837
10088
|
# @!attribute [rw] id
|
9838
|
-
# The ID used to identify the metrics configuration.
|
10089
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
10090
|
+
# character limit and can only contain letters, numbers, periods,
|
10091
|
+
# dashes, and underscores.
|
9839
10092
|
# @return [String]
|
9840
10093
|
#
|
9841
10094
|
# @!attribute [rw] metrics_configuration
|
@@ -10458,14 +10711,14 @@ module Aws::S3
|
|
10458
10711
|
# bucket name. For more information about access point ARNs, see
|
10459
10712
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
10460
10713
|
#
|
10461
|
-
# When
|
10714
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
10462
10715
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10463
10716
|
# takes the form `
|
10464
10717
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10465
|
-
# When
|
10466
|
-
# Services SDKs, you provide the Outposts
|
10467
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
10468
|
-
# [
|
10718
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
10719
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
10720
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
10721
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10469
10722
|
#
|
10470
10723
|
#
|
10471
10724
|
#
|
@@ -10771,10 +11024,8 @@ module Aws::S3
|
|
10771
11024
|
# @return [String]
|
10772
11025
|
#
|
10773
11026
|
# @!attribute [rw] server_side_encryption
|
10774
|
-
#
|
10775
|
-
#
|
10776
|
-
# request, the response includes this header. It confirms the
|
10777
|
-
# encryption algorithm that Amazon S3 used to encrypt the object.
|
11027
|
+
# The server-side encryption algorithm used when storing this object
|
11028
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
10778
11029
|
# @return [String]
|
10779
11030
|
#
|
10780
11031
|
# @!attribute [rw] version_id
|
@@ -10795,22 +11046,25 @@ module Aws::S3
|
|
10795
11046
|
# @return [String]
|
10796
11047
|
#
|
10797
11048
|
# @!attribute [rw] ssekms_key_id
|
10798
|
-
# If `x-amz-server-side-encryption`
|
10799
|
-
# `aws:kms`, this header specifies the ID of the
|
10800
|
-
#
|
10801
|
-
#
|
11049
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11050
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11051
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11052
|
+
# used for the object.
|
10802
11053
|
# @return [String]
|
10803
11054
|
#
|
10804
11055
|
# @!attribute [rw] ssekms_encryption_context
|
10805
11056
|
# If present, specifies the Amazon Web Services KMS Encryption Context
|
10806
11057
|
# to use for object encryption. The value of this header is a
|
10807
11058
|
# base64-encoded UTF-8 string holding JSON with the encryption context
|
10808
|
-
# key-value pairs.
|
11059
|
+
# key-value pairs. This value is stored as object metadata and
|
11060
|
+
# automatically gets passed on to Amazon Web Services KMS for future
|
11061
|
+
# `GetObject` or `CopyObject` operations on this object.
|
10809
11062
|
# @return [String]
|
10810
11063
|
#
|
10811
11064
|
# @!attribute [rw] bucket_key_enabled
|
10812
11065
|
# Indicates whether the uploaded object uses an S3 Bucket Key for
|
10813
|
-
# server-side encryption with
|
11066
|
+
# server-side encryption with Key Management Service (KMS) keys
|
11067
|
+
# (SSE-KMS).
|
10814
11068
|
# @return [Boolean]
|
10815
11069
|
#
|
10816
11070
|
# @!attribute [rw] request_charged
|
@@ -10866,14 +11120,14 @@ module Aws::S3
|
|
10866
11120
|
# bucket name. For more information about access point ARNs, see
|
10867
11121
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
10868
11122
|
#
|
10869
|
-
# When
|
11123
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
10870
11124
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10871
11125
|
# takes the form `
|
10872
11126
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10873
|
-
# When
|
10874
|
-
# Services SDKs, you provide the Outposts
|
10875
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
10876
|
-
# [
|
11127
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
11128
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
11129
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11130
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10877
11131
|
#
|
10878
11132
|
#
|
10879
11133
|
#
|
@@ -10894,11 +11148,11 @@ module Aws::S3
|
|
10894
11148
|
# @!attribute [rw] content_disposition
|
10895
11149
|
# Specifies presentational information for the object. For more
|
10896
11150
|
# information, see
|
10897
|
-
# [
|
11151
|
+
# [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
|
10898
11152
|
#
|
10899
11153
|
#
|
10900
11154
|
#
|
10901
|
-
# [1]:
|
11155
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
|
10902
11156
|
# @return [String]
|
10903
11157
|
#
|
10904
11158
|
# @!attribute [rw] content_encoding
|
@@ -10906,11 +11160,11 @@ module Aws::S3
|
|
10906
11160
|
# thus what decoding mechanisms must be applied to obtain the
|
10907
11161
|
# media-type referenced by the Content-Type header field. For more
|
10908
11162
|
# information, see
|
10909
|
-
# [
|
11163
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
|
10910
11164
|
#
|
10911
11165
|
#
|
10912
11166
|
#
|
10913
|
-
# [1]:
|
11167
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
|
10914
11168
|
# @return [String]
|
10915
11169
|
#
|
10916
11170
|
# @!attribute [rw] content_language
|
@@ -10921,11 +11175,11 @@ module Aws::S3
|
|
10921
11175
|
# Size of the body in bytes. This parameter is useful when the size of
|
10922
11176
|
# the body cannot be determined automatically. For more information,
|
10923
11177
|
# see
|
10924
|
-
# [
|
11178
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
|
10925
11179
|
#
|
10926
11180
|
#
|
10927
11181
|
#
|
10928
|
-
# [1]:
|
11182
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
|
10929
11183
|
# @return [Integer]
|
10930
11184
|
#
|
10931
11185
|
# @!attribute [rw] content_md5
|
@@ -10945,11 +11199,11 @@ module Aws::S3
|
|
10945
11199
|
# @!attribute [rw] content_type
|
10946
11200
|
# A standard MIME type describing the format of the contents. For more
|
10947
11201
|
# information, see
|
10948
|
-
# [
|
11202
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
|
10949
11203
|
#
|
10950
11204
|
#
|
10951
11205
|
#
|
10952
|
-
# [1]:
|
11206
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
|
10953
11207
|
# @return [String]
|
10954
11208
|
#
|
10955
11209
|
# @!attribute [rw] checksum_algorithm
|
@@ -11020,11 +11274,11 @@ module Aws::S3
|
|
11020
11274
|
# @!attribute [rw] expires
|
11021
11275
|
# The date and time at which the object is no longer cacheable. For
|
11022
11276
|
# more information, see
|
11023
|
-
# [
|
11277
|
+
# [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
|
11024
11278
|
#
|
11025
11279
|
#
|
11026
11280
|
#
|
11027
|
-
# [1]:
|
11281
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
|
11028
11282
|
# @return [Time]
|
11029
11283
|
#
|
11030
11284
|
# @!attribute [rw] grant_full_control
|
@@ -11062,7 +11316,7 @@ module Aws::S3
|
|
11062
11316
|
#
|
11063
11317
|
# @!attribute [rw] server_side_encryption
|
11064
11318
|
# The server-side encryption algorithm used when storing this object
|
11065
|
-
# in Amazon S3 (for example, AES256
|
11319
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
11066
11320
|
# @return [String]
|
11067
11321
|
#
|
11068
11322
|
# @!attribute [rw] storage_class
|
@@ -11126,29 +11380,32 @@ module Aws::S3
|
|
11126
11380
|
# @return [String]
|
11127
11381
|
#
|
11128
11382
|
# @!attribute [rw] ssekms_key_id
|
11129
|
-
# If `x-amz-server-side-encryption`
|
11130
|
-
# `aws:kms`, this header specifies the ID of the
|
11131
|
-
#
|
11132
|
-
#
|
11133
|
-
# `x-amz-server-side-encryption:aws:kms
|
11383
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11384
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11385
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11386
|
+
# used for the object. If you specify
|
11387
|
+
# `x-amz-server-side-encryption:aws:kms` or
|
11388
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
11134
11389
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
11135
|
-
# Amazon Web Services managed key to protect the data. If
|
11136
|
-
# does not exist in the same account issuing the
|
11137
|
-
# the full ARN and not just the ID.
|
11390
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data. If
|
11391
|
+
# the KMS key does not exist in the same account that's issuing the
|
11392
|
+
# command, you must use the full ARN and not just the ID.
|
11138
11393
|
# @return [String]
|
11139
11394
|
#
|
11140
11395
|
# @!attribute [rw] ssekms_encryption_context
|
11141
11396
|
# Specifies the Amazon Web Services KMS Encryption Context to use for
|
11142
11397
|
# object encryption. The value of this header is a base64-encoded
|
11143
11398
|
# UTF-8 string holding JSON with the encryption context key-value
|
11144
|
-
# pairs.
|
11399
|
+
# pairs. This value is stored as object metadata and automatically
|
11400
|
+
# gets passed on to Amazon Web Services KMS for future `GetObject` or
|
11401
|
+
# `CopyObject` operations on this object.
|
11145
11402
|
# @return [String]
|
11146
11403
|
#
|
11147
11404
|
# @!attribute [rw] bucket_key_enabled
|
11148
11405
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
11149
|
-
# encryption with server-side encryption using
|
11150
|
-
# Setting this header to `true` causes Amazon S3
|
11151
|
-
# Key for object encryption with SSE-KMS.
|
11406
|
+
# encryption with server-side encryption using Key Management Service
|
11407
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
11408
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
11152
11409
|
#
|
11153
11410
|
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11154
11411
|
# settings for S3 Bucket Key.
|
@@ -11372,14 +11629,14 @@ module Aws::S3
|
|
11372
11629
|
# bucket name. For more information about access point ARNs, see
|
11373
11630
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
11374
11631
|
#
|
11375
|
-
# When
|
11632
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
11376
11633
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11377
11634
|
# takes the form `
|
11378
11635
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
11379
|
-
# When
|
11380
|
-
# Services SDKs, you provide the Outposts
|
11381
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
11382
|
-
# [
|
11636
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
11637
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
11638
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11639
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11383
11640
|
#
|
11384
11641
|
#
|
11385
11642
|
#
|
@@ -11539,12 +11796,12 @@ module Aws::S3
|
|
11539
11796
|
#
|
11540
11797
|
# @!attribute [rw] filter
|
11541
11798
|
# Specifies object key name filtering rules. For information about key
|
11542
|
-
# name filtering, see [Configuring
|
11543
|
-
# *Amazon S3 User Guide*.
|
11799
|
+
# name filtering, see [Configuring event notifications using object
|
11800
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
11544
11801
|
#
|
11545
11802
|
#
|
11546
11803
|
#
|
11547
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
11548
11805
|
# @return [Types::NotificationConfigurationFilter]
|
11549
11806
|
#
|
11550
11807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/QueueConfiguration AWS API Documentation
|
@@ -11808,6 +12065,13 @@ module Aws::S3
|
|
11808
12065
|
# @return [Types::SourceSelectionCriteria]
|
11809
12066
|
#
|
11810
12067
|
# @!attribute [rw] existing_object_replication
|
12068
|
+
# Optional configuration to replicate existing source bucket objects.
|
12069
|
+
# For more information, see [Replicating Existing Objects][1] in the
|
12070
|
+
# *Amazon S3 User Guide*.
|
12071
|
+
#
|
12072
|
+
#
|
12073
|
+
#
|
12074
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
|
11811
12075
|
# @return [Types::ExistingObjectReplication]
|
11812
12076
|
#
|
11813
12077
|
# @!attribute [rw] destination
|
@@ -12033,14 +12297,14 @@ module Aws::S3
|
|
12033
12297
|
# bucket name. For more information about access point ARNs, see
|
12034
12298
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
12035
12299
|
#
|
12036
|
-
# When
|
12300
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
12037
12301
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12038
12302
|
# takes the form `
|
12039
12303
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12040
|
-
# When
|
12041
|
-
# Services SDKs, you provide the Outposts
|
12042
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
12043
|
-
# [
|
12304
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
12305
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
12306
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12307
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12044
12308
|
#
|
12045
12309
|
#
|
12046
12310
|
#
|
@@ -12158,6 +12422,49 @@ module Aws::S3
|
|
12158
12422
|
include Aws::Structure
|
12159
12423
|
end
|
12160
12424
|
|
12425
|
+
# Specifies the restoration status of an object. Objects in certain
|
12426
|
+
# storage classes must be restored before they can be retrieved. For
|
12427
|
+
# more information about these storage classes and how to work with
|
12428
|
+
# archived objects, see [ Working with archived objects][1] in the
|
12429
|
+
# *Amazon S3 User Guide*.
|
12430
|
+
#
|
12431
|
+
#
|
12432
|
+
#
|
12433
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
12434
|
+
#
|
12435
|
+
# @!attribute [rw] is_restore_in_progress
|
12436
|
+
# Specifies whether the object is currently being restored. If the
|
12437
|
+
# object restoration is in progress, the header returns the value
|
12438
|
+
# `TRUE`. For example:
|
12439
|
+
#
|
12440
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="true"`
|
12441
|
+
#
|
12442
|
+
# If the object restoration has completed, the header returns the
|
12443
|
+
# value `FALSE`. For example:
|
12444
|
+
#
|
12445
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12446
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12447
|
+
#
|
12448
|
+
# If the object hasn't been restored, there is no header response.
|
12449
|
+
# @return [Boolean]
|
12450
|
+
#
|
12451
|
+
# @!attribute [rw] restore_expiry_date
|
12452
|
+
# Indicates when the restored copy will expire. This value is
|
12453
|
+
# populated only if the object has already been restored. For example:
|
12454
|
+
#
|
12455
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12456
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12457
|
+
# @return [Time]
|
12458
|
+
#
|
12459
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation
|
12460
|
+
#
|
12461
|
+
class RestoreStatus < Struct.new(
|
12462
|
+
:is_restore_in_progress,
|
12463
|
+
:restore_expiry_date)
|
12464
|
+
SENSITIVE = []
|
12465
|
+
include Aws::Structure
|
12466
|
+
end
|
12467
|
+
|
12161
12468
|
# Specifies the redirect behavior and when a redirect is applied. For
|
12162
12469
|
# more information about routing rules, see [Configuring advanced
|
12163
12470
|
# conditional redirects][1] in the *Amazon S3 User Guide*.
|
@@ -12262,8 +12569,8 @@ module Aws::S3
|
|
12262
12569
|
# Specifies the days since the initiation of an incomplete multipart
|
12263
12570
|
# upload that Amazon S3 will wait before permanently removing all
|
12264
12571
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
12265
|
-
# Multipart Uploads Using a Bucket Lifecycle
|
12266
|
-
# S3 User Guide*.
|
12572
|
+
# Multipart Uploads Using a Bucket Lifecycle Configuration][1] in the
|
12573
|
+
# *Amazon S3 User Guide*.
|
12267
12574
|
#
|
12268
12575
|
#
|
12269
12576
|
#
|
@@ -12354,9 +12661,9 @@ module Aws::S3
|
|
12354
12661
|
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
12355
12662
|
#
|
12356
12663
|
# @!attribute [rw] key_id
|
12357
|
-
# Specifies the ID of the
|
12358
|
-
#
|
12359
|
-
#
|
12664
|
+
# Specifies the ID of the Key Management Service (KMS) symmetric
|
12665
|
+
# encryption customer managed key to use for encrypting inventory
|
12666
|
+
# reports.
|
12360
12667
|
# @return [String]
|
12361
12668
|
#
|
12362
12669
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation
|
@@ -12595,22 +12902,22 @@ module Aws::S3
|
|
12595
12902
|
# `aws:kms`.
|
12596
12903
|
#
|
12597
12904
|
# You can specify the key ID or the Amazon Resource Name (ARN) of the
|
12598
|
-
# KMS key.
|
12599
|
-
#
|
12600
|
-
# qualified KMS key ARN. For more information, see [Using encryption
|
12601
|
-
# for cross-account operations][1].
|
12905
|
+
# KMS key. If you use a key ID, you can run into a LogDestination
|
12906
|
+
# undeliverable error when creating a VPC flow log.
|
12602
12907
|
#
|
12603
|
-
#
|
12908
|
+
# If you are using encryption with cross-account or Amazon Web
|
12909
|
+
# Services service operations you must use a fully qualified KMS key
|
12910
|
+
# ARN. For more information, see [Using encryption for cross-account
|
12911
|
+
# operations][1].
|
12604
12912
|
#
|
12605
12913
|
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
12606
12914
|
#
|
12607
12915
|
# * Key ARN:
|
12608
12916
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
12609
12917
|
#
|
12610
|
-
# Amazon S3 only supports symmetric KMS keys
|
12611
|
-
#
|
12612
|
-
#
|
12613
|
-
# Developer Guide*.
|
12918
|
+
# Amazon S3 only supports symmetric encryption KMS keys. For more
|
12919
|
+
# information, see [Asymmetric keys in Amazon Web Services KMS][2] in
|
12920
|
+
# the *Amazon Web Services Key Management Service Developer Guide*.
|
12614
12921
|
#
|
12615
12922
|
#
|
12616
12923
|
#
|
@@ -12926,12 +13233,12 @@ module Aws::S3
|
|
12926
13233
|
#
|
12927
13234
|
# @!attribute [rw] filter
|
12928
13235
|
# Specifies object key name filtering rules. For information about key
|
12929
|
-
# name filtering, see [Configuring
|
12930
|
-
# *Amazon S3 User Guide*.
|
13236
|
+
# name filtering, see [Configuring event notifications using object
|
13237
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
12931
13238
|
#
|
12932
13239
|
#
|
12933
13240
|
#
|
12934
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13241
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
12935
13242
|
# @return [Types::NotificationConfigurationFilter]
|
12936
13243
|
#
|
12937
13244
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TopicConfiguration AWS API Documentation
|
@@ -13030,7 +13337,7 @@ module Aws::S3
|
|
13030
13337
|
#
|
13031
13338
|
# @!attribute [rw] server_side_encryption
|
13032
13339
|
# The server-side encryption algorithm used when storing this object
|
13033
|
-
# in Amazon S3 (for example, AES256
|
13340
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13034
13341
|
# @return [String]
|
13035
13342
|
#
|
13036
13343
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13047,14 +13354,15 @@ module Aws::S3
|
|
13047
13354
|
# @return [String]
|
13048
13355
|
#
|
13049
13356
|
# @!attribute [rw] ssekms_key_id
|
13050
|
-
# If present, specifies the ID of the
|
13051
|
-
#
|
13052
|
-
#
|
13357
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13358
|
+
# symmetric encryption customer managed key that was used for the
|
13359
|
+
# object.
|
13053
13360
|
# @return [String]
|
13054
13361
|
#
|
13055
13362
|
# @!attribute [rw] bucket_key_enabled
|
13056
13363
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13057
|
-
# server-side encryption with
|
13364
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13365
|
+
# (SSE-KMS).
|
13058
13366
|
# @return [Boolean]
|
13059
13367
|
#
|
13060
13368
|
# @!attribute [rw] request_charged
|
@@ -13089,14 +13397,14 @@ module Aws::S3
|
|
13089
13397
|
# bucket name. For more information about access point ARNs, see
|
13090
13398
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
13091
13399
|
#
|
13092
|
-
# When
|
13400
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
13093
13401
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13094
13402
|
# takes the form `
|
13095
13403
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13096
|
-
# When
|
13097
|
-
# Services SDKs, you provide the Outposts
|
13098
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
13099
|
-
# [
|
13404
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
13405
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
13406
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13407
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13100
13408
|
#
|
13101
13409
|
#
|
13102
13410
|
#
|
@@ -13107,7 +13415,7 @@ module Aws::S3
|
|
13107
13415
|
# @!attribute [rw] copy_source
|
13108
13416
|
# Specifies the source object for the copy operation. You specify the
|
13109
13417
|
# value in one of two formats, depending on whether you want to access
|
13110
|
-
# the source object through an [access point][1]
|
13418
|
+
# the source object through an [access point][1]:
|
13111
13419
|
#
|
13112
13420
|
# * For objects not accessed through an access point, specify the name
|
13113
13421
|
# of the source bucket and key of the source object, separated by a
|
@@ -13283,7 +13591,7 @@ module Aws::S3
|
|
13283
13591
|
|
13284
13592
|
# @!attribute [rw] server_side_encryption
|
13285
13593
|
# The server-side encryption algorithm used when storing this object
|
13286
|
-
# in Amazon S3 (for example, AES256
|
13594
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13287
13595
|
# @return [String]
|
13288
13596
|
#
|
13289
13597
|
# @!attribute [rw] etag
|
@@ -13356,14 +13664,14 @@ module Aws::S3
|
|
13356
13664
|
# @return [String]
|
13357
13665
|
#
|
13358
13666
|
# @!attribute [rw] ssekms_key_id
|
13359
|
-
# If present, specifies the ID of the
|
13360
|
-
#
|
13361
|
-
# managed key was used for the object.
|
13667
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13668
|
+
# symmetric encryption customer managed key was used for the object.
|
13362
13669
|
# @return [String]
|
13363
13670
|
#
|
13364
13671
|
# @!attribute [rw] bucket_key_enabled
|
13365
13672
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13366
|
-
# server-side encryption with
|
13673
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13674
|
+
# (SSE-KMS).
|
13367
13675
|
# @return [Boolean]
|
13368
13676
|
#
|
13369
13677
|
# @!attribute [rw] request_charged
|
@@ -13405,14 +13713,14 @@ module Aws::S3
|
|
13405
13713
|
# bucket name. For more information about access point ARNs, see
|
13406
13714
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
13407
13715
|
#
|
13408
|
-
# When
|
13716
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
13409
13717
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13410
13718
|
# takes the form `
|
13411
13719
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13412
|
-
# When
|
13413
|
-
# Services SDKs, you provide the Outposts
|
13414
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
13415
|
-
# [
|
13720
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
13721
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
13722
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13723
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13416
13724
|
#
|
13417
13725
|
#
|
13418
13726
|
#
|
@@ -13652,9 +13960,7 @@ module Aws::S3
|
|
13652
13960
|
#
|
13653
13961
|
# @!attribute [rw] status_code
|
13654
13962
|
# The integer status code for an HTTP response of a corresponding
|
13655
|
-
# `GetObject` request.
|
13656
|
-
#
|
13657
|
-
# **Status Codes**
|
13963
|
+
# `GetObject` request. The following is a list of status codes.
|
13658
13964
|
#
|
13659
13965
|
# * `200 - OK`
|
13660
13966
|
#
|
@@ -13896,7 +14202,7 @@ module Aws::S3
|
|
13896
14202
|
#
|
13897
14203
|
# @!attribute [rw] server_side_encryption
|
13898
14204
|
# The server-side encryption algorithm used when storing requested
|
13899
|
-
# object in Amazon S3 (for example, AES256, aws:kms).
|
14205
|
+
# object in Amazon S3 (for example, AES256, `aws:kms`).
|
13900
14206
|
# @return [String]
|
13901
14207
|
#
|
13902
14208
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13907,8 +14213,8 @@ module Aws::S3
|
|
13907
14213
|
#
|
13908
14214
|
# @!attribute [rw] ssekms_key_id
|
13909
14215
|
# If present, specifies the ID of the Amazon Web Services Key
|
13910
|
-
# Management Service (Amazon Web Services KMS) symmetric
|
13911
|
-
# managed key that was used for stored in Amazon S3 object.
|
14216
|
+
# Management Service (Amazon Web Services KMS) symmetric encryption
|
14217
|
+
# customer managed key that was used for stored in Amazon S3 object.
|
13912
14218
|
# @return [String]
|
13913
14219
|
#
|
13914
14220
|
# @!attribute [rw] sse_customer_key_md5
|