aws-sdk-s3 1.121.0 → 1.136.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +99 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +122 -60
- 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 +2017 -1674
- data/lib/aws-sdk-s3/client_api.rb +24 -0
- data/lib/aws-sdk-s3/customizations/bucket.rb +3 -1
- data/lib/aws-sdk-s3/customizations/errors.rb +1 -1
- data/lib/aws-sdk-s3/customizations/object.rb +91 -18
- data/lib/aws-sdk-s3/encryption/client.rb +6 -2
- data/lib/aws-sdk-s3/encryption/kms_cipher_provider.rb +13 -9
- data/lib/aws-sdk-s3/encryptionV2/client.rb +6 -2
- data/lib/aws-sdk-s3/encryptionV2/decrypt_handler.rb +1 -0
- data/lib/aws-sdk-s3/encryptionV2/kms_cipher_provider.rb +10 -6
- data/lib/aws-sdk-s3/endpoint_parameters.rb +4 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +22 -246
- data/lib/aws-sdk-s3/endpoints.rb +1 -0
- data/lib/aws-sdk-s3/file_downloader.rb +170 -44
- data/lib/aws-sdk-s3/file_uploader.rb +8 -6
- data/lib/aws-sdk-s3/multipart_stream_uploader.rb +5 -3
- data/lib/aws-sdk-s3/multipart_upload.rb +27 -13
- data/lib/aws-sdk-s3/multipart_upload_part.rb +19 -9
- data/lib/aws-sdk-s3/object.rb +151 -105
- data/lib/aws-sdk-s3/object_acl.rb +14 -6
- data/lib/aws-sdk-s3/object_copier.rb +7 -5
- data/lib/aws-sdk-s3/object_multipart_copier.rb +33 -17
- data/lib/aws-sdk-s3/object_summary.rb +144 -89
- data/lib/aws-sdk-s3/object_version.rb +55 -21
- 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 +854 -484
- data/lib/aws-sdk-s3.rb +1 -1
- metadata +6 -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
|
#
|
@@ -84,9 +84,11 @@ module Aws::S3
|
|
84
84
|
# @!attribute [rw] request_payer
|
85
85
|
# Confirms that the requester knows that they will be charged for the
|
86
86
|
# request. Bucket owners need not specify this parameter in their
|
87
|
-
# requests.
|
88
|
-
# Pays
|
89
|
-
#
|
87
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
88
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
89
|
+
# charges to copy the object. For information about downloading
|
90
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
91
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
90
92
|
#
|
91
93
|
#
|
92
94
|
#
|
@@ -474,7 +476,10 @@ module Aws::S3
|
|
474
476
|
# @!attribute [rw] comments
|
475
477
|
# A single character used to indicate that a row should be ignored
|
476
478
|
# when the character is present at the start of that row. You can
|
477
|
-
# specify any character to indicate a comment line.
|
479
|
+
# specify any character to indicate a comment line. The default
|
480
|
+
# character is `#`.
|
481
|
+
#
|
482
|
+
# Default: `#`
|
478
483
|
# @return [String]
|
479
484
|
#
|
480
485
|
# @!attribute [rw] quote_escape_character
|
@@ -708,14 +713,14 @@ module Aws::S3
|
|
708
713
|
# bucket name. For more information about access point ARNs, see
|
709
714
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
710
715
|
#
|
711
|
-
# When
|
716
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
712
717
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
713
718
|
# takes the form `
|
714
719
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
715
|
-
# When
|
716
|
-
# Services SDKs, you provide the Outposts
|
717
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
718
|
-
# [
|
720
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
721
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
722
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
723
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
719
724
|
#
|
720
725
|
#
|
721
726
|
#
|
@@ -802,11 +807,8 @@ module Aws::S3
|
|
802
807
|
# @return [String]
|
803
808
|
#
|
804
809
|
# @!attribute [rw] server_side_encryption
|
805
|
-
#
|
806
|
-
#
|
807
|
-
# initiate multipart upload request, the response includes this
|
808
|
-
# header. It confirms the encryption algorithm that Amazon S3 used to
|
809
|
-
# encrypt the object.
|
810
|
+
# The server-side encryption algorithm used when storing this object
|
811
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
810
812
|
# @return [String]
|
811
813
|
#
|
812
814
|
# @!attribute [rw] version_id
|
@@ -815,14 +817,15 @@ module Aws::S3
|
|
815
817
|
# @return [String]
|
816
818
|
#
|
817
819
|
# @!attribute [rw] ssekms_key_id
|
818
|
-
# If present, specifies the ID of the
|
819
|
-
#
|
820
|
-
#
|
820
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
821
|
+
# symmetric encryption customer managed key that was used for the
|
822
|
+
# object.
|
821
823
|
# @return [String]
|
822
824
|
#
|
823
825
|
# @!attribute [rw] bucket_key_enabled
|
824
826
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
825
|
-
# server-side encryption with
|
827
|
+
# server-side encryption with Key Management Service (KMS) keys
|
828
|
+
# (SSE-KMS).
|
826
829
|
# @return [Boolean]
|
827
830
|
#
|
828
831
|
# @!attribute [rw] request_charged
|
@@ -863,14 +866,14 @@ module Aws::S3
|
|
863
866
|
# bucket name. For more information about access point ARNs, see
|
864
867
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
865
868
|
#
|
866
|
-
# When
|
869
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
867
870
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
868
871
|
# takes the form `
|
869
872
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
870
|
-
# When
|
871
|
-
# Services SDKs, you provide the Outposts
|
872
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
873
|
-
# [
|
873
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
874
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
875
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
876
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
874
877
|
#
|
875
878
|
#
|
876
879
|
#
|
@@ -941,9 +944,11 @@ module Aws::S3
|
|
941
944
|
# @!attribute [rw] request_payer
|
942
945
|
# Confirms that the requester knows that they will be charged for the
|
943
946
|
# request. Bucket owners need not specify this parameter in their
|
944
|
-
# requests.
|
945
|
-
# Pays
|
946
|
-
#
|
947
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
948
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
949
|
+
# charges to copy the object. For information about downloading
|
950
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
951
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
947
952
|
#
|
948
953
|
#
|
949
954
|
#
|
@@ -1172,7 +1177,7 @@ module Aws::S3
|
|
1172
1177
|
#
|
1173
1178
|
# @!attribute [rw] server_side_encryption
|
1174
1179
|
# The server-side encryption algorithm used when storing this object
|
1175
|
-
# in Amazon S3 (for example, AES256
|
1180
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1176
1181
|
# @return [String]
|
1177
1182
|
#
|
1178
1183
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1189,9 +1194,9 @@ module Aws::S3
|
|
1189
1194
|
# @return [String]
|
1190
1195
|
#
|
1191
1196
|
# @!attribute [rw] ssekms_key_id
|
1192
|
-
# If present, specifies the ID of the
|
1193
|
-
#
|
1194
|
-
#
|
1197
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1198
|
+
# symmetric encryption customer managed key that was used for the
|
1199
|
+
# object.
|
1195
1200
|
# @return [String]
|
1196
1201
|
#
|
1197
1202
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1203,7 +1208,8 @@ module Aws::S3
|
|
1203
1208
|
#
|
1204
1209
|
# @!attribute [rw] bucket_key_enabled
|
1205
1210
|
# Indicates whether the copied object uses an S3 Bucket Key for
|
1206
|
-
# server-side encryption with
|
1211
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1212
|
+
# (SSE-KMS).
|
1207
1213
|
# @return [Boolean]
|
1208
1214
|
#
|
1209
1215
|
# @!attribute [rw] request_charged
|
@@ -1247,14 +1253,14 @@ module Aws::S3
|
|
1247
1253
|
# bucket name. For more information about access point ARNs, see
|
1248
1254
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1249
1255
|
#
|
1250
|
-
# When
|
1256
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1251
1257
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1252
1258
|
# takes the form `
|
1253
1259
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1254
|
-
# When
|
1255
|
-
# Services SDKs, you provide the Outposts
|
1256
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
1257
|
-
# [
|
1260
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
1261
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
1262
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1263
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1258
1264
|
#
|
1259
1265
|
#
|
1260
1266
|
#
|
@@ -1410,15 +1416,16 @@ module Aws::S3
|
|
1410
1416
|
#
|
1411
1417
|
# @!attribute [rw] server_side_encryption
|
1412
1418
|
# The server-side encryption algorithm used when storing this object
|
1413
|
-
# in Amazon S3 (for example, AES256
|
1419
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
1414
1420
|
# @return [String]
|
1415
1421
|
#
|
1416
1422
|
# @!attribute [rw] storage_class
|
1417
|
-
#
|
1418
|
-
#
|
1419
|
-
#
|
1420
|
-
#
|
1421
|
-
#
|
1423
|
+
# If the `x-amz-storage-class` header is not used, the copied object
|
1424
|
+
# will be stored in the STANDARD Storage Class by default. The
|
1425
|
+
# STANDARD storage class provides high durability and high
|
1426
|
+
# availability. Depending on performance needs, you can specify a
|
1427
|
+
# different Storage Class. Amazon S3 on Outposts only uses the
|
1428
|
+
# OUTPOSTS Storage Class. For more information, see [Storage
|
1422
1429
|
# Classes][1] in the *Amazon S3 User Guide*.
|
1423
1430
|
#
|
1424
1431
|
#
|
@@ -1430,7 +1437,9 @@ module Aws::S3
|
|
1430
1437
|
# If the bucket is configured as a website, redirects requests for
|
1431
1438
|
# this object to another object in the same bucket or to an external
|
1432
1439
|
# URL. Amazon S3 stores the value of this header in the object
|
1433
|
-
# metadata.
|
1440
|
+
# metadata. This value is unique to each object and is not copied when
|
1441
|
+
# using the `x-amz-metadata-directive` header. Instead, you may opt to
|
1442
|
+
# provide this header in combination with the directive.
|
1434
1443
|
# @return [String]
|
1435
1444
|
#
|
1436
1445
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1453,13 +1462,13 @@ module Aws::S3
|
|
1453
1462
|
# @return [String]
|
1454
1463
|
#
|
1455
1464
|
# @!attribute [rw] ssekms_key_id
|
1456
|
-
# Specifies the
|
1457
|
-
# encryption. All GET and PUT requests for an object protected
|
1458
|
-
#
|
1459
|
-
#
|
1460
|
-
#
|
1461
|
-
#
|
1462
|
-
#
|
1465
|
+
# Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for
|
1466
|
+
# object encryption. All GET and PUT requests for an object protected
|
1467
|
+
# by KMS will fail if they're not made via SSL or using SigV4. For
|
1468
|
+
# information about configuring any of the officially supported Amazon
|
1469
|
+
# Web Services SDKs and Amazon Web Services CLI, see [Specifying the
|
1470
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1471
|
+
# User Guide*.
|
1463
1472
|
#
|
1464
1473
|
#
|
1465
1474
|
#
|
@@ -1475,9 +1484,9 @@ module Aws::S3
|
|
1475
1484
|
#
|
1476
1485
|
# @!attribute [rw] bucket_key_enabled
|
1477
1486
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
1478
|
-
# encryption with server-side encryption using
|
1479
|
-
# Setting this header to `true` causes Amazon S3
|
1480
|
-
# Key for object encryption with SSE-KMS.
|
1487
|
+
# encryption with server-side encryption using Key Management Service
|
1488
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
1489
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
1481
1490
|
#
|
1482
1491
|
# Specifying this header with a COPY action doesn’t affect
|
1483
1492
|
# bucket-level settings for S3 Bucket Key.
|
@@ -1503,9 +1512,11 @@ module Aws::S3
|
|
1503
1512
|
# @!attribute [rw] request_payer
|
1504
1513
|
# Confirms that the requester knows that they will be charged for the
|
1505
1514
|
# request. Bucket owners need not specify this parameter in their
|
1506
|
-
# requests.
|
1507
|
-
# Pays
|
1508
|
-
#
|
1515
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
1516
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
1517
|
+
# charges to copy the object. For information about downloading
|
1518
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
1519
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
1509
1520
|
#
|
1510
1521
|
#
|
1511
1522
|
#
|
@@ -1855,7 +1866,7 @@ module Aws::S3
|
|
1855
1866
|
# this header. The header indicates when the initiated multipart
|
1856
1867
|
# upload becomes eligible for an abort operation. For more
|
1857
1868
|
# information, see [ Aborting Incomplete Multipart Uploads Using a
|
1858
|
-
# Bucket Lifecycle
|
1869
|
+
# Bucket Lifecycle Configuration][1].
|
1859
1870
|
#
|
1860
1871
|
# The response also includes the `x-amz-abort-rule-id` header that
|
1861
1872
|
# provides the ID of the lifecycle configuration rule that defines
|
@@ -1885,14 +1896,14 @@ module Aws::S3
|
|
1885
1896
|
# bucket name. For more information about access point ARNs, see
|
1886
1897
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1887
1898
|
#
|
1888
|
-
# When
|
1899
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1889
1900
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1890
1901
|
# takes the form `
|
1891
1902
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1892
|
-
# When
|
1893
|
-
# Services SDKs, you provide the Outposts
|
1894
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
1895
|
-
# [
|
1903
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
1904
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
1905
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1906
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
1896
1907
|
#
|
1897
1908
|
#
|
1898
1909
|
#
|
@@ -1910,7 +1921,7 @@ module Aws::S3
|
|
1910
1921
|
#
|
1911
1922
|
# @!attribute [rw] server_side_encryption
|
1912
1923
|
# The server-side encryption algorithm used when storing this object
|
1913
|
-
# in Amazon S3 (for example, AES256
|
1924
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
1914
1925
|
# @return [String]
|
1915
1926
|
#
|
1916
1927
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -1927,9 +1938,9 @@ module Aws::S3
|
|
1927
1938
|
# @return [String]
|
1928
1939
|
#
|
1929
1940
|
# @!attribute [rw] ssekms_key_id
|
1930
|
-
# If present, specifies the ID of the
|
1931
|
-
#
|
1932
|
-
#
|
1941
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
1942
|
+
# symmetric encryption customer managed key that was used for the
|
1943
|
+
# object.
|
1933
1944
|
# @return [String]
|
1934
1945
|
#
|
1935
1946
|
# @!attribute [rw] ssekms_encryption_context
|
@@ -1941,7 +1952,8 @@ module Aws::S3
|
|
1941
1952
|
#
|
1942
1953
|
# @!attribute [rw] bucket_key_enabled
|
1943
1954
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
1944
|
-
# server-side encryption with
|
1955
|
+
# server-side encryption with Key Management Service (KMS) keys
|
1956
|
+
# (SSE-KMS).
|
1945
1957
|
# @return [Boolean]
|
1946
1958
|
#
|
1947
1959
|
# @!attribute [rw] request_charged
|
@@ -1991,14 +2003,14 @@ module Aws::S3
|
|
1991
2003
|
# bucket name. For more information about access point ARNs, see
|
1992
2004
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
1993
2005
|
#
|
1994
|
-
# When
|
2006
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
1995
2007
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1996
2008
|
# takes the form `
|
1997
2009
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1998
|
-
# When
|
1999
|
-
# Services SDKs, you provide the Outposts
|
2000
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2001
|
-
# [
|
2010
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2011
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2012
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2013
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2002
2014
|
#
|
2003
2015
|
#
|
2004
2016
|
#
|
@@ -2067,7 +2079,7 @@ module Aws::S3
|
|
2067
2079
|
#
|
2068
2080
|
# @!attribute [rw] server_side_encryption
|
2069
2081
|
# The server-side encryption algorithm used when storing this object
|
2070
|
-
# in Amazon S3 (for example, AES256
|
2082
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
2071
2083
|
# @return [String]
|
2072
2084
|
#
|
2073
2085
|
# @!attribute [rw] storage_class
|
@@ -2110,13 +2122,13 @@ module Aws::S3
|
|
2110
2122
|
# @return [String]
|
2111
2123
|
#
|
2112
2124
|
# @!attribute [rw] ssekms_key_id
|
2113
|
-
# Specifies the ID
|
2114
|
-
#
|
2115
|
-
#
|
2116
|
-
#
|
2117
|
-
#
|
2118
|
-
# [Specifying the Signature Version
|
2119
|
-
# the *Amazon S3 User Guide*.
|
2125
|
+
# Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric
|
2126
|
+
# encryption customer managed key to use for object encryption. All
|
2127
|
+
# GET and PUT requests for an object protected by KMS will fail if
|
2128
|
+
# they're not made via SSL or using SigV4. For information about
|
2129
|
+
# configuring any of the officially supported Amazon Web Services SDKs
|
2130
|
+
# and Amazon Web Services CLI, see [Specifying the Signature Version
|
2131
|
+
# in Request Authentication][1] in the *Amazon S3 User Guide*.
|
2120
2132
|
#
|
2121
2133
|
#
|
2122
2134
|
#
|
@@ -2132,9 +2144,9 @@ module Aws::S3
|
|
2132
2144
|
#
|
2133
2145
|
# @!attribute [rw] bucket_key_enabled
|
2134
2146
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
2135
|
-
# encryption with server-side encryption using
|
2136
|
-
# Setting this header to `true` causes Amazon S3
|
2137
|
-
# Key for object encryption with SSE-KMS.
|
2147
|
+
# encryption with server-side encryption using Key Management Service
|
2148
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
2149
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
2138
2150
|
#
|
2139
2151
|
# Specifying this header with an object action doesn’t affect
|
2140
2152
|
# bucket-level settings for S3 Bucket Key.
|
@@ -2143,9 +2155,11 @@ module Aws::S3
|
|
2143
2155
|
# @!attribute [rw] request_payer
|
2144
2156
|
# Confirms that the requester knows that they will be charged for the
|
2145
2157
|
# request. Bucket owners need not specify this parameter in their
|
2146
|
-
# requests.
|
2147
|
-
# Pays
|
2148
|
-
#
|
2158
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2159
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2160
|
+
# charges to copy the object. For information about downloading
|
2161
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2162
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2149
2163
|
#
|
2150
2164
|
#
|
2151
2165
|
#
|
@@ -2264,7 +2278,7 @@ module Aws::S3
|
|
2264
2278
|
# Container for the objects to delete.
|
2265
2279
|
#
|
2266
2280
|
# @!attribute [rw] objects
|
2267
|
-
# The
|
2281
|
+
# The object to delete.
|
2268
2282
|
# @return [Array<Types::ObjectIdentifier>]
|
2269
2283
|
#
|
2270
2284
|
# @!attribute [rw] quiet
|
@@ -2413,7 +2427,9 @@ module Aws::S3
|
|
2413
2427
|
# @return [String]
|
2414
2428
|
#
|
2415
2429
|
# @!attribute [rw] id
|
2416
|
-
# The ID used to identify the metrics configuration.
|
2430
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
2431
|
+
# character limit and can only contain letters, numbers, periods,
|
2432
|
+
# dashes, and underscores.
|
2417
2433
|
# @return [String]
|
2418
2434
|
#
|
2419
2435
|
# @!attribute [rw] expected_bucket_owner
|
@@ -2622,8 +2638,10 @@ module Aws::S3
|
|
2622
2638
|
end
|
2623
2639
|
|
2624
2640
|
# @!attribute [rw] delete_marker
|
2625
|
-
#
|
2626
|
-
# was (true) or was not (false) a delete marker
|
2641
|
+
# Indicates whether the specified object version that was permanently
|
2642
|
+
# deleted was (true) or was not (false) a delete marker before
|
2643
|
+
# deletion. In a simple DELETE, this header indicates whether (true)
|
2644
|
+
# or not (false) the current version of the object is a delete marker.
|
2627
2645
|
# @return [Boolean]
|
2628
2646
|
#
|
2629
2647
|
# @!attribute [rw] version_id
|
@@ -2658,14 +2676,14 @@ module Aws::S3
|
|
2658
2676
|
# bucket name. For more information about access point ARNs, see
|
2659
2677
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2660
2678
|
#
|
2661
|
-
# When
|
2679
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2662
2680
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2663
2681
|
# takes the form `
|
2664
2682
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2665
|
-
# When
|
2666
|
-
# Services SDKs, you provide the Outposts
|
2667
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2668
|
-
# [
|
2683
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2684
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2685
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2686
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2669
2687
|
#
|
2670
2688
|
#
|
2671
2689
|
#
|
@@ -2691,9 +2709,11 @@ module Aws::S3
|
|
2691
2709
|
# @!attribute [rw] request_payer
|
2692
2710
|
# Confirms that the requester knows that they will be charged for the
|
2693
2711
|
# request. Bucket owners need not specify this parameter in their
|
2694
|
-
# requests.
|
2695
|
-
# Pays
|
2696
|
-
#
|
2712
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2713
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2714
|
+
# charges to copy the object. For information about downloading
|
2715
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2716
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2697
2717
|
#
|
2698
2718
|
#
|
2699
2719
|
#
|
@@ -2751,14 +2771,14 @@ module Aws::S3
|
|
2751
2771
|
# bucket name. For more information about access point ARNs, see
|
2752
2772
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2753
2773
|
#
|
2754
|
-
# When
|
2774
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2755
2775
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2756
2776
|
# takes the form `
|
2757
2777
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2758
|
-
# When
|
2759
|
-
# Services SDKs, you provide the Outposts
|
2760
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2761
|
-
# [
|
2778
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2779
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2780
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2781
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2762
2782
|
#
|
2763
2783
|
#
|
2764
2784
|
#
|
@@ -2829,14 +2849,14 @@ module Aws::S3
|
|
2829
2849
|
# bucket name. For more information about access point ARNs, see
|
2830
2850
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
2831
2851
|
#
|
2832
|
-
# When
|
2852
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
2833
2853
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2834
2854
|
# takes the form `
|
2835
2855
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
2836
|
-
# When
|
2837
|
-
# Services SDKs, you provide the Outposts
|
2838
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
2839
|
-
# [
|
2856
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
2857
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
2858
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
2859
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
2840
2860
|
#
|
2841
2861
|
#
|
2842
2862
|
#
|
@@ -2858,9 +2878,11 @@ module Aws::S3
|
|
2858
2878
|
# @!attribute [rw] request_payer
|
2859
2879
|
# Confirms that the requester knows that they will be charged for the
|
2860
2880
|
# request. Bucket owners need not specify this parameter in their
|
2861
|
-
# requests.
|
2862
|
-
# Pays
|
2863
|
-
#
|
2881
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
2882
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
2883
|
+
# charges to copy the object. For information about downloading
|
2884
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
2885
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
2864
2886
|
#
|
2865
2887
|
#
|
2866
2888
|
#
|
@@ -2944,10 +2966,10 @@ module Aws::S3
|
|
2944
2966
|
# @return [String]
|
2945
2967
|
#
|
2946
2968
|
# @!attribute [rw] delete_marker
|
2947
|
-
#
|
2948
|
-
# was (true) or was not (false) a delete marker
|
2949
|
-
# this header indicates whether (true)
|
2950
|
-
#
|
2969
|
+
# Indicates whether the specified object version that was permanently
|
2970
|
+
# deleted was (true) or was not (false) a delete marker before
|
2971
|
+
# deletion. In a simple DELETE, this header indicates whether (true)
|
2972
|
+
# or not (false) the current version of the object is a delete marker.
|
2951
2973
|
# @return [Boolean]
|
2952
2974
|
#
|
2953
2975
|
# @!attribute [rw] delete_marker_version_id
|
@@ -3049,15 +3071,16 @@ module Aws::S3
|
|
3049
3071
|
#
|
3050
3072
|
# @!attribute [rw] encryption_type
|
3051
3073
|
# The server-side encryption algorithm used when storing job results
|
3052
|
-
# in Amazon S3 (for example, AES256, aws:kms).
|
3074
|
+
# in Amazon S3 (for example, AES256, `aws:kms`).
|
3053
3075
|
# @return [String]
|
3054
3076
|
#
|
3055
3077
|
# @!attribute [rw] kms_key_id
|
3056
3078
|
# If the encryption type is `aws:kms`, this optional value specifies
|
3057
|
-
# the ID of the symmetric customer managed key to use for
|
3058
|
-
# of job results. Amazon S3 only supports symmetric
|
3059
|
-
# information, see [
|
3060
|
-
# *Amazon Web Services Key Management Service Developer
|
3079
|
+
# the ID of the symmetric encryption customer managed key to use for
|
3080
|
+
# encryption of job results. Amazon S3 only supports symmetric
|
3081
|
+
# encryption KMS keys. For more information, see [Asymmetric keys in
|
3082
|
+
# KMS][1] in the *Amazon Web Services Key Management Service Developer
|
3083
|
+
# Guide*.
|
3061
3084
|
#
|
3062
3085
|
#
|
3063
3086
|
#
|
@@ -3087,9 +3110,9 @@ module Aws::S3
|
|
3087
3110
|
# Amazon Web Services KMS key stored in Amazon Web Services Key
|
3088
3111
|
# Management Service (KMS) for the destination bucket. Amazon S3 uses
|
3089
3112
|
# this key to encrypt replica objects. Amazon S3 only supports
|
3090
|
-
# symmetric
|
3091
|
-
#
|
3092
|
-
#
|
3113
|
+
# symmetric encryption KMS keys. For more information, see [Asymmetric
|
3114
|
+
# keys in Amazon Web Services KMS][1] in the *Amazon Web Services Key
|
3115
|
+
# Management Service Developer Guide*.
|
3093
3116
|
#
|
3094
3117
|
#
|
3095
3118
|
#
|
@@ -3129,9 +3152,8 @@ module Aws::S3
|
|
3129
3152
|
# @!attribute [rw] code
|
3130
3153
|
# The error code is a string that uniquely identifies an error
|
3131
3154
|
# condition. It is meant to be read and understood by programs that
|
3132
|
-
# detect and handle errors by type.
|
3133
|
-
#
|
3134
|
-
# **Amazon S3 error codes**
|
3155
|
+
# detect and handle errors by type. The following is a list of Amazon
|
3156
|
+
# S3 error codes. For more information, see [Error responses][1].
|
3135
3157
|
#
|
3136
3158
|
# * * *Code:* AccessDenied
|
3137
3159
|
#
|
@@ -3370,7 +3392,7 @@ module Aws::S3
|
|
3370
3392
|
#
|
3371
3393
|
# * *Description:* The specified location constraint is not valid.
|
3372
3394
|
# For more information about Regions, see [How to Select a Region
|
3373
|
-
# for Your Buckets][
|
3395
|
+
# for Your Buckets][2].
|
3374
3396
|
#
|
3375
3397
|
# * *HTTP Status Code:* 400 Bad Request
|
3376
3398
|
#
|
@@ -3755,7 +3777,7 @@ module Aws::S3
|
|
3755
3777
|
#
|
3756
3778
|
# * *Description:* Your account is not signed up for the Amazon S3
|
3757
3779
|
# service. You must sign up before you can use Amazon S3. You can
|
3758
|
-
# sign up at the following URL: [Amazon S3][
|
3780
|
+
# sign up at the following URL: [Amazon S3][3]
|
3759
3781
|
#
|
3760
3782
|
# * *HTTP Status Code:* 403 Forbidden
|
3761
3783
|
#
|
@@ -3846,7 +3868,7 @@ module Aws::S3
|
|
3846
3868
|
# * *Description:* The request signature we calculated does not
|
3847
3869
|
# match the signature you provided. Check your Amazon Web Services
|
3848
3870
|
# secret access key and signing method. For more information, see
|
3849
|
-
# [REST Authentication][
|
3871
|
+
# [REST Authentication][4] and [SOAP Authentication][5] for
|
3850
3872
|
# details.
|
3851
3873
|
#
|
3852
3874
|
# * *HTTP Status Code:* 403 Forbidden
|
@@ -3855,7 +3877,7 @@ module Aws::S3
|
|
3855
3877
|
#
|
3856
3878
|
# * * *Code:* ServiceUnavailable
|
3857
3879
|
#
|
3858
|
-
# * *Description:*
|
3880
|
+
# * *Description:* Service is unable to handle request.
|
3859
3881
|
#
|
3860
3882
|
# * *HTTP Status Code:* 503 Service Unavailable
|
3861
3883
|
#
|
@@ -3925,10 +3947,11 @@ module Aws::S3
|
|
3925
3947
|
#
|
3926
3948
|
#
|
3927
3949
|
#
|
3928
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3929
|
-
# [2]:
|
3930
|
-
# [3]:
|
3931
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
3950
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
|
3951
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
3952
|
+
# [3]: http://aws.amazon.com/s3
|
3953
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
3954
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/SOAPAuthentication.html
|
3932
3955
|
# @return [String]
|
3933
3956
|
#
|
3934
3957
|
# @!attribute [rw] message
|
@@ -3991,6 +4014,8 @@ module Aws::S3
|
|
3991
4014
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
|
3992
4015
|
#
|
3993
4016
|
# @!attribute [rw] status
|
4017
|
+
# Specifies whether Amazon S3 replicates existing source bucket
|
4018
|
+
# objects.
|
3994
4019
|
# @return [String]
|
3995
4020
|
#
|
3996
4021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ExistingObjectReplication AWS API Documentation
|
@@ -4033,10 +4058,16 @@ module Aws::S3
|
|
4033
4058
|
# The accelerate configuration of the bucket.
|
4034
4059
|
# @return [String]
|
4035
4060
|
#
|
4061
|
+
# @!attribute [rw] request_charged
|
4062
|
+
# If present, indicates that the requester was successfully charged
|
4063
|
+
# for the request.
|
4064
|
+
# @return [String]
|
4065
|
+
#
|
4036
4066
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationOutput AWS API Documentation
|
4037
4067
|
#
|
4038
4068
|
class GetBucketAccelerateConfigurationOutput < Struct.new(
|
4039
|
-
:status
|
4069
|
+
:status,
|
4070
|
+
:request_charged)
|
4040
4071
|
SENSITIVE = []
|
4041
4072
|
include Aws::Structure
|
4042
4073
|
end
|
@@ -4052,11 +4083,26 @@ module Aws::S3
|
|
4052
4083
|
# `403 Forbidden` (access denied).
|
4053
4084
|
# @return [String]
|
4054
4085
|
#
|
4086
|
+
# @!attribute [rw] request_payer
|
4087
|
+
# Confirms that the requester knows that they will be charged for the
|
4088
|
+
# request. Bucket owners need not specify this parameter in their
|
4089
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
4090
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
4091
|
+
# charges to copy the object. For information about downloading
|
4092
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
4093
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
4094
|
+
#
|
4095
|
+
#
|
4096
|
+
#
|
4097
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4098
|
+
# @return [String]
|
4099
|
+
#
|
4055
4100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationRequest AWS API Documentation
|
4056
4101
|
#
|
4057
4102
|
class GetBucketAccelerateConfigurationRequest < Struct.new(
|
4058
4103
|
:bucket,
|
4059
|
-
:expected_bucket_owner
|
4104
|
+
:expected_bucket_owner,
|
4105
|
+
:request_payer)
|
4060
4106
|
SENSITIVE = []
|
4061
4107
|
include Aws::Structure
|
4062
4108
|
end
|
@@ -4080,6 +4126,20 @@ module Aws::S3
|
|
4080
4126
|
|
4081
4127
|
# @!attribute [rw] bucket
|
4082
4128
|
# Specifies the S3 bucket whose ACL is being requested.
|
4129
|
+
#
|
4130
|
+
# To use this API operation against an access point, provide the alias
|
4131
|
+
# of the access point in place of the bucket name.
|
4132
|
+
#
|
4133
|
+
# To use this API operation against an Object Lambda access point,
|
4134
|
+
# provide the alias of the Object Lambda access point in place of the
|
4135
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4136
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4137
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4138
|
+
# see [List of Error Codes][1].
|
4139
|
+
#
|
4140
|
+
#
|
4141
|
+
#
|
4142
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4083
4143
|
# @return [String]
|
4084
4144
|
#
|
4085
4145
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4149,6 +4209,20 @@ module Aws::S3
|
|
4149
4209
|
|
4150
4210
|
# @!attribute [rw] bucket
|
4151
4211
|
# The bucket name for which to get the cors configuration.
|
4212
|
+
#
|
4213
|
+
# To use this API operation against an access point, provide the alias
|
4214
|
+
# of the access point in place of the bucket name.
|
4215
|
+
#
|
4216
|
+
# To use this API operation against an Object Lambda access point,
|
4217
|
+
# provide the alias of the Object Lambda access point in place of the
|
4218
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4219
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4220
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4221
|
+
# see [List of Error Codes][1].
|
4222
|
+
#
|
4223
|
+
#
|
4224
|
+
#
|
4225
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4152
4226
|
# @return [String]
|
4153
4227
|
#
|
4154
4228
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4348,6 +4422,20 @@ module Aws::S3
|
|
4348
4422
|
|
4349
4423
|
# @!attribute [rw] bucket
|
4350
4424
|
# The name of the bucket for which to get the location.
|
4425
|
+
#
|
4426
|
+
# To use this API operation against an access point, provide the alias
|
4427
|
+
# of the access point in place of the bucket name.
|
4428
|
+
#
|
4429
|
+
# To use this API operation against an Object Lambda access point,
|
4430
|
+
# provide the alias of the Object Lambda access point in place of the
|
4431
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4432
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4433
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4434
|
+
# see [List of Error Codes][1].
|
4435
|
+
#
|
4436
|
+
#
|
4437
|
+
#
|
4438
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4351
4439
|
# @return [String]
|
4352
4440
|
#
|
4353
4441
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4420,7 +4508,9 @@ module Aws::S3
|
|
4420
4508
|
# @return [String]
|
4421
4509
|
#
|
4422
4510
|
# @!attribute [rw] id
|
4423
|
-
# The ID used to identify the metrics configuration.
|
4511
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
4512
|
+
# character limit and can only contain letters, numbers, periods,
|
4513
|
+
# dashes, and underscores.
|
4424
4514
|
# @return [String]
|
4425
4515
|
#
|
4426
4516
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4442,6 +4532,20 @@ module Aws::S3
|
|
4442
4532
|
# @!attribute [rw] bucket
|
4443
4533
|
# The name of the bucket for which to get the notification
|
4444
4534
|
# configuration.
|
4535
|
+
#
|
4536
|
+
# To use this API operation against an access point, provide the alias
|
4537
|
+
# of the access point in place of the bucket name.
|
4538
|
+
#
|
4539
|
+
# To use this API operation against an Object Lambda access point,
|
4540
|
+
# provide the alias of the Object Lambda access point in place of the
|
4541
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4542
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4543
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4544
|
+
# see [List of Error Codes][1].
|
4545
|
+
#
|
4546
|
+
#
|
4547
|
+
#
|
4548
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4445
4549
|
# @return [String]
|
4446
4550
|
#
|
4447
4551
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4506,6 +4610,20 @@ module Aws::S3
|
|
4506
4610
|
|
4507
4611
|
# @!attribute [rw] bucket
|
4508
4612
|
# The bucket name for which to get the bucket policy.
|
4613
|
+
#
|
4614
|
+
# To use this API operation against an access point, provide the alias
|
4615
|
+
# of the access point in place of the bucket name.
|
4616
|
+
#
|
4617
|
+
# To use this API operation against an Object Lambda access point,
|
4618
|
+
# provide the alias of the Object Lambda access point in place of the
|
4619
|
+
# bucket name. If the Object Lambda access point alias in a request is
|
4620
|
+
# not valid, the error code `InvalidAccessPointAliasError` is
|
4621
|
+
# returned. For more information about `InvalidAccessPointAliasError`,
|
4622
|
+
# see [List of Error Codes][1].
|
4623
|
+
#
|
4624
|
+
#
|
4625
|
+
#
|
4626
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
4509
4627
|
# @return [String]
|
4510
4628
|
#
|
4511
4629
|
# @!attribute [rw] expected_bucket_owner
|
@@ -4791,9 +4909,11 @@ module Aws::S3
|
|
4791
4909
|
# @!attribute [rw] request_payer
|
4792
4910
|
# Confirms that the requester knows that they will be charged for the
|
4793
4911
|
# request. Bucket owners need not specify this parameter in their
|
4794
|
-
# requests.
|
4795
|
-
# Pays
|
4796
|
-
#
|
4912
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
4913
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
4914
|
+
# charges to copy the object. For information about downloading
|
4915
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
4916
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
4797
4917
|
#
|
4798
4918
|
#
|
4799
4919
|
#
|
@@ -4939,14 +5059,14 @@ module Aws::S3
|
|
4939
5059
|
# bucket name. For more information about access point ARNs, see
|
4940
5060
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
4941
5061
|
#
|
4942
|
-
# When
|
5062
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
4943
5063
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
4944
5064
|
# takes the form `
|
4945
5065
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
4946
|
-
# When
|
4947
|
-
# Services SDKs, you provide the Outposts
|
4948
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
4949
|
-
# [
|
5066
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5067
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5068
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5069
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
4950
5070
|
#
|
4951
5071
|
#
|
4952
5072
|
#
|
@@ -4993,9 +5113,11 @@ module Aws::S3
|
|
4993
5113
|
# @!attribute [rw] request_payer
|
4994
5114
|
# Confirms that the requester knows that they will be charged for the
|
4995
5115
|
# request. Bucket owners need not specify this parameter in their
|
4996
|
-
# requests.
|
4997
|
-
# Pays
|
4998
|
-
#
|
5116
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5117
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5118
|
+
# charges to copy the object. For information about downloading
|
5119
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5120
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
4999
5121
|
#
|
5000
5122
|
#
|
5001
5123
|
#
|
@@ -5009,9 +5131,8 @@ module Aws::S3
|
|
5009
5131
|
# @return [String]
|
5010
5132
|
#
|
5011
5133
|
# @!attribute [rw] object_attributes
|
5012
|
-
#
|
5013
|
-
#
|
5014
|
-
# not returned.
|
5134
|
+
# Specifies the fields at the root level that you want returned in the
|
5135
|
+
# response. Fields that you do not specify are not returned.
|
5015
5136
|
# @return [Array<String>]
|
5016
5137
|
#
|
5017
5138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation
|
@@ -5075,9 +5196,11 @@ module Aws::S3
|
|
5075
5196
|
# @!attribute [rw] request_payer
|
5076
5197
|
# Confirms that the requester knows that they will be charged for the
|
5077
5198
|
# request. Bucket owners need not specify this parameter in their
|
5078
|
-
# requests.
|
5079
|
-
# Pays
|
5080
|
-
#
|
5199
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5200
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5201
|
+
# charges to copy the object. For information about downloading
|
5202
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5203
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5081
5204
|
#
|
5082
5205
|
#
|
5083
5206
|
#
|
@@ -5291,7 +5414,7 @@ module Aws::S3
|
|
5291
5414
|
#
|
5292
5415
|
# @!attribute [rw] server_side_encryption
|
5293
5416
|
# The server-side encryption algorithm used when storing this object
|
5294
|
-
# in Amazon S3 (for example, AES256
|
5417
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
5295
5418
|
# @return [String]
|
5296
5419
|
#
|
5297
5420
|
# @!attribute [rw] metadata
|
@@ -5312,14 +5435,14 @@ module Aws::S3
|
|
5312
5435
|
# @return [String]
|
5313
5436
|
#
|
5314
5437
|
# @!attribute [rw] ssekms_key_id
|
5315
|
-
# If present, specifies the ID of the
|
5316
|
-
#
|
5317
|
-
#
|
5438
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
5439
|
+
# symmetric encryption customer managed key that was used for the
|
5440
|
+
# object.
|
5318
5441
|
# @return [String]
|
5319
5442
|
#
|
5320
5443
|
# @!attribute [rw] bucket_key_enabled
|
5321
5444
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
5322
|
-
# encryption with
|
5445
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
5323
5446
|
# @return [Boolean]
|
5324
5447
|
#
|
5325
5448
|
# @!attribute [rw] storage_class
|
@@ -5421,14 +5544,14 @@ module Aws::S3
|
|
5421
5544
|
# When using an Object Lambda access point the hostname takes the form
|
5422
5545
|
# *AccessPointName*-*AccountId*.s3-object-lambda.*Region*.amazonaws.com.
|
5423
5546
|
#
|
5424
|
-
# When
|
5547
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5425
5548
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5426
5549
|
# takes the form `
|
5427
5550
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5428
|
-
# When
|
5429
|
-
# Services SDKs, you provide the Outposts
|
5430
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5431
|
-
# [
|
5551
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5552
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5553
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5554
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5432
5555
|
#
|
5433
5556
|
#
|
5434
5557
|
#
|
@@ -5463,7 +5586,7 @@ module Aws::S3
|
|
5463
5586
|
# @!attribute [rw] range
|
5464
5587
|
# Downloads the specified range bytes of an object. For more
|
5465
5588
|
# information about the HTTP Range header, see
|
5466
|
-
# [https://www.
|
5589
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-range][1].
|
5467
5590
|
#
|
5468
5591
|
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
5469
5592
|
# `GET` request.
|
@@ -5472,7 +5595,7 @@ module Aws::S3
|
|
5472
5595
|
#
|
5473
5596
|
#
|
5474
5597
|
#
|
5475
|
-
# [1]: https://www.
|
5598
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-range
|
5476
5599
|
# @return [String]
|
5477
5600
|
#
|
5478
5601
|
# @!attribute [rw] response_cache_control
|
@@ -5525,9 +5648,11 @@ module Aws::S3
|
|
5525
5648
|
# @!attribute [rw] request_payer
|
5526
5649
|
# Confirms that the requester knows that they will be charged for the
|
5527
5650
|
# request. Bucket owners need not specify this parameter in their
|
5528
|
-
# requests.
|
5529
|
-
# Pays
|
5530
|
-
#
|
5651
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5652
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5653
|
+
# charges to copy the object. For information about downloading
|
5654
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5655
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5531
5656
|
#
|
5532
5657
|
#
|
5533
5658
|
#
|
@@ -5622,9 +5747,11 @@ module Aws::S3
|
|
5622
5747
|
# @!attribute [rw] request_payer
|
5623
5748
|
# Confirms that the requester knows that they will be charged for the
|
5624
5749
|
# request. Bucket owners need not specify this parameter in their
|
5625
|
-
# requests.
|
5626
|
-
# Pays
|
5627
|
-
#
|
5750
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5751
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5752
|
+
# charges to copy the object. For information about downloading
|
5753
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5754
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5628
5755
|
#
|
5629
5756
|
#
|
5630
5757
|
#
|
@@ -5680,14 +5807,14 @@ module Aws::S3
|
|
5680
5807
|
# bucket name. For more information about access point ARNs, see
|
5681
5808
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
5682
5809
|
#
|
5683
|
-
# When
|
5810
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5684
5811
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5685
5812
|
# takes the form `
|
5686
5813
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5687
|
-
# When
|
5688
|
-
# Services SDKs, you provide the Outposts
|
5689
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5690
|
-
# [
|
5814
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
5815
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
5816
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
5817
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
5691
5818
|
#
|
5692
5819
|
#
|
5693
5820
|
#
|
@@ -5713,9 +5840,11 @@ module Aws::S3
|
|
5713
5840
|
# @!attribute [rw] request_payer
|
5714
5841
|
# Confirms that the requester knows that they will be charged for the
|
5715
5842
|
# request. Bucket owners need not specify this parameter in their
|
5716
|
-
# requests.
|
5717
|
-
# Pays
|
5718
|
-
#
|
5843
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5844
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5845
|
+
# charges to copy the object. For information about downloading
|
5846
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5847
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5719
5848
|
#
|
5720
5849
|
#
|
5721
5850
|
#
|
@@ -5764,9 +5893,11 @@ module Aws::S3
|
|
5764
5893
|
# @!attribute [rw] request_payer
|
5765
5894
|
# Confirms that the requester knows that they will be charged for the
|
5766
5895
|
# request. Bucket owners need not specify this parameter in their
|
5767
|
-
# requests.
|
5768
|
-
# Pays
|
5769
|
-
#
|
5896
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
5897
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
5898
|
+
# charges to copy the object. For information about downloading
|
5899
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
5900
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
5770
5901
|
#
|
5771
5902
|
#
|
5772
5903
|
#
|
@@ -5931,19 +6062,27 @@ module Aws::S3
|
|
5931
6062
|
# bucket name. For more information about access point ARNs, see
|
5932
6063
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
5933
6064
|
#
|
5934
|
-
# When
|
6065
|
+
# When you use this action with an Object Lambda access point, provide
|
6066
|
+
# the alias of the Object Lambda access point in place of the bucket
|
6067
|
+
# name. If the Object Lambda access point alias in a request is not
|
6068
|
+
# valid, the error code `InvalidAccessPointAliasError` is returned.
|
6069
|
+
# For more information about `InvalidAccessPointAliasError`, see [List
|
6070
|
+
# of Error Codes][2].
|
6071
|
+
#
|
6072
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
5935
6073
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5936
6074
|
# takes the form `
|
5937
6075
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5938
|
-
# When
|
5939
|
-
# Services SDKs, you provide the Outposts
|
5940
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
5941
|
-
# [
|
6076
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
6077
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
6078
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6079
|
+
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
5942
6080
|
#
|
5943
6081
|
#
|
5944
6082
|
#
|
5945
6083
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5946
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6084
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList
|
6085
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5947
6086
|
# @return [String]
|
5948
6087
|
#
|
5949
6088
|
# @!attribute [rw] expected_bucket_owner
|
@@ -6120,11 +6259,8 @@ module Aws::S3
|
|
6120
6259
|
# @return [String]
|
6121
6260
|
#
|
6122
6261
|
# @!attribute [rw] server_side_encryption
|
6123
|
-
#
|
6124
|
-
# Amazon
|
6125
|
-
# the response includes this header with the value of the server-side
|
6126
|
-
# encryption algorithm used when storing this object in Amazon S3 (for
|
6127
|
-
# example, AES256, aws:kms).
|
6262
|
+
# The server-side encryption algorithm used when storing this object
|
6263
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
6128
6264
|
# @return [String]
|
6129
6265
|
#
|
6130
6266
|
# @!attribute [rw] metadata
|
@@ -6145,14 +6281,14 @@ module Aws::S3
|
|
6145
6281
|
# @return [String]
|
6146
6282
|
#
|
6147
6283
|
# @!attribute [rw] ssekms_key_id
|
6148
|
-
# If present, specifies the ID of the
|
6149
|
-
#
|
6150
|
-
#
|
6284
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
6285
|
+
# symmetric encryption customer managed key that was used for the
|
6286
|
+
# object.
|
6151
6287
|
# @return [String]
|
6152
6288
|
#
|
6153
6289
|
# @!attribute [rw] bucket_key_enabled
|
6154
6290
|
# Indicates whether the object uses an S3 Bucket Key for server-side
|
6155
|
-
# encryption with
|
6291
|
+
# encryption with Key Management Service (KMS) keys (SSE-KMS).
|
6156
6292
|
# @return [Boolean]
|
6157
6293
|
#
|
6158
6294
|
# @!attribute [rw] storage_class
|
@@ -6306,14 +6442,14 @@ module Aws::S3
|
|
6306
6442
|
# bucket name. For more information about access point ARNs, see
|
6307
6443
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
6308
6444
|
#
|
6309
|
-
# When
|
6445
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
6310
6446
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6311
6447
|
# takes the form `
|
6312
6448
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
6313
|
-
# When
|
6314
|
-
# Services SDKs, you provide the Outposts
|
6315
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
6316
|
-
# [
|
6449
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
6450
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
6451
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
6452
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
6317
6453
|
#
|
6318
6454
|
#
|
6319
6455
|
#
|
@@ -6346,8 +6482,10 @@ module Aws::S3
|
|
6346
6482
|
# @return [String]
|
6347
6483
|
#
|
6348
6484
|
# @!attribute [rw] range
|
6349
|
-
#
|
6350
|
-
#
|
6485
|
+
# HeadObject returns only the metadata for an object. If the Range is
|
6486
|
+
# satisfiable, only the `ContentLength` is affected in the response.
|
6487
|
+
# If the Range is not satisfiable, S3 returns a `416 - Requested Range
|
6488
|
+
# Not Satisfiable` error.
|
6351
6489
|
# @return [String]
|
6352
6490
|
#
|
6353
6491
|
# @!attribute [rw] version_id
|
@@ -6376,9 +6514,11 @@ module Aws::S3
|
|
6376
6514
|
# @!attribute [rw] request_payer
|
6377
6515
|
# Confirms that the requester knows that they will be charged for the
|
6378
6516
|
# request. Bucket owners need not specify this parameter in their
|
6379
|
-
# requests.
|
6380
|
-
# Pays
|
6381
|
-
#
|
6517
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
6518
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
6519
|
+
# charges to copy the object. For information about downloading
|
6520
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
6521
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
6382
6522
|
#
|
6383
6523
|
#
|
6384
6524
|
#
|
@@ -6843,12 +6983,12 @@ module Aws::S3
|
|
6843
6983
|
#
|
6844
6984
|
# @!attribute [rw] filter
|
6845
6985
|
# Specifies object key name filtering rules. For information about key
|
6846
|
-
# name filtering, see [Configuring
|
6847
|
-
# *Amazon S3 User Guide*.
|
6986
|
+
# name filtering, see [Configuring event notifications using object
|
6987
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
6848
6988
|
#
|
6849
6989
|
#
|
6850
6990
|
#
|
6851
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6991
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
6852
6992
|
# @return [Types::NotificationConfigurationFilter]
|
6853
6993
|
#
|
6854
6994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LambdaFunctionConfiguration AWS API Documentation
|
@@ -6864,6 +7004,13 @@ module Aws::S3
|
|
6864
7004
|
|
6865
7005
|
# Container for lifecycle rules. You can add as many as 1000 rules.
|
6866
7006
|
#
|
7007
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
7008
|
+
# *Amazon S3 User Guide*.
|
7009
|
+
#
|
7010
|
+
#
|
7011
|
+
#
|
7012
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
7013
|
+
#
|
6867
7014
|
# @!attribute [rw] rules
|
6868
7015
|
# Specifies lifecycle configuration rules for an Amazon S3 bucket.
|
6869
7016
|
# @return [Array<Types::Rule>]
|
@@ -6878,9 +7025,17 @@ module Aws::S3
|
|
6878
7025
|
|
6879
7026
|
# Container for the expiration for the lifecycle of the object.
|
6880
7027
|
#
|
7028
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
7029
|
+
# *Amazon S3 User Guide*.
|
7030
|
+
#
|
7031
|
+
#
|
7032
|
+
#
|
7033
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
7034
|
+
#
|
6881
7035
|
# @!attribute [rw] date
|
6882
|
-
# Indicates at what date the object is to be moved or deleted.
|
6883
|
-
#
|
7036
|
+
# Indicates at what date the object is to be moved or deleted. The
|
7037
|
+
# date value must conform to the ISO 8601 format. The time is always
|
7038
|
+
# midnight UTC.
|
6884
7039
|
# @return [Time]
|
6885
7040
|
#
|
6886
7041
|
# @!attribute [rw] days
|
@@ -6907,6 +7062,13 @@ module Aws::S3
|
|
6907
7062
|
|
6908
7063
|
# A lifecycle rule for individual objects in an Amazon S3 bucket.
|
6909
7064
|
#
|
7065
|
+
# For more information see, [Managing your storage lifecycle][1] in the
|
7066
|
+
# *Amazon S3 User Guide*.
|
7067
|
+
#
|
7068
|
+
#
|
7069
|
+
#
|
7070
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
7071
|
+
#
|
6910
7072
|
# @!attribute [rw] expiration
|
6911
7073
|
# Specifies the expiration for the lifecycle of the object in the form
|
6912
7074
|
# of date, days and, whether the object has a delete marker.
|
@@ -6969,8 +7131,8 @@ module Aws::S3
|
|
6969
7131
|
# Specifies the days since the initiation of an incomplete multipart
|
6970
7132
|
# upload that Amazon S3 will wait before permanently removing all
|
6971
7133
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
6972
|
-
# Multipart Uploads Using a Bucket Lifecycle
|
6973
|
-
# S3 User Guide*.
|
7134
|
+
# Multipart Uploads Using a Bucket Lifecycle Configuration][1] in the
|
7135
|
+
# *Amazon S3 User Guide*.
|
6974
7136
|
#
|
6975
7137
|
#
|
6976
7138
|
#
|
@@ -7113,8 +7275,8 @@ module Aws::S3
|
|
7113
7275
|
# @return [String]
|
7114
7276
|
#
|
7115
7277
|
# @!attribute [rw] continuation_token
|
7116
|
-
# The ContinuationToken that represents a placeholder from where
|
7117
|
-
# request should begin.
|
7278
|
+
# The `ContinuationToken` that represents a placeholder from where
|
7279
|
+
# this request should begin.
|
7118
7280
|
# @return [String]
|
7119
7281
|
#
|
7120
7282
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7226,9 +7388,9 @@ module Aws::S3
|
|
7226
7388
|
#
|
7227
7389
|
# @!attribute [rw] continuation_token
|
7228
7390
|
# The marker used to continue an inventory configuration listing that
|
7229
|
-
# has been truncated. Use the NextContinuationToken from a
|
7230
|
-
# truncated list response to continue the listing. The
|
7231
|
-
# token is an opaque value that Amazon S3 understands.
|
7391
|
+
# has been truncated. Use the `NextContinuationToken` from a
|
7392
|
+
# previously truncated list response to continue the listing. The
|
7393
|
+
# continuation token is an opaque value that Amazon S3 understands.
|
7232
7394
|
# @return [String]
|
7233
7395
|
#
|
7234
7396
|
# @!attribute [rw] expected_bucket_owner
|
@@ -7289,7 +7451,7 @@ module Aws::S3
|
|
7289
7451
|
#
|
7290
7452
|
# @!attribute [rw] continuation_token
|
7291
7453
|
# The marker that is used to continue a metrics configuration listing
|
7292
|
-
# that has been truncated. Use the NextContinuationToken from a
|
7454
|
+
# that has been truncated. Use the `NextContinuationToken` from a
|
7293
7455
|
# previously truncated list response to continue the listing. The
|
7294
7456
|
# continuation token is an opaque value that Amazon S3 understands.
|
7295
7457
|
# @return [String]
|
@@ -7392,13 +7554,18 @@ module Aws::S3
|
|
7392
7554
|
# Encoding type used by Amazon S3 to encode object keys in the
|
7393
7555
|
# response.
|
7394
7556
|
#
|
7395
|
-
# If you specify `encoding-type` request parameter, Amazon S3
|
7396
|
-
# this element in the response, and returns encoded key name
|
7397
|
-
# the following response elements:
|
7557
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7558
|
+
# includes this element in the response, and returns encoded key name
|
7559
|
+
# values in the following response elements:
|
7398
7560
|
#
|
7399
7561
|
# `Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.
|
7400
7562
|
# @return [String]
|
7401
7563
|
#
|
7564
|
+
# @!attribute [rw] request_charged
|
7565
|
+
# If present, indicates that the requester was successfully charged
|
7566
|
+
# for the request.
|
7567
|
+
# @return [String]
|
7568
|
+
#
|
7402
7569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsOutput AWS API Documentation
|
7403
7570
|
#
|
7404
7571
|
class ListMultipartUploadsOutput < Struct.new(
|
@@ -7413,7 +7580,8 @@ module Aws::S3
|
|
7413
7580
|
:is_truncated,
|
7414
7581
|
:uploads,
|
7415
7582
|
:common_prefixes,
|
7416
|
-
:encoding_type
|
7583
|
+
:encoding_type,
|
7584
|
+
:request_charged)
|
7417
7585
|
SENSITIVE = []
|
7418
7586
|
include Aws::Structure
|
7419
7587
|
end
|
@@ -7430,14 +7598,14 @@ module Aws::S3
|
|
7430
7598
|
# bucket name. For more information about access point ARNs, see
|
7431
7599
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7432
7600
|
#
|
7433
|
-
# When
|
7601
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7434
7602
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7435
7603
|
# takes the form `
|
7436
7604
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7437
|
-
# When
|
7438
|
-
# Services SDKs, you provide the Outposts
|
7439
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7440
|
-
# [
|
7605
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
7606
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
7607
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
7608
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7441
7609
|
#
|
7442
7610
|
#
|
7443
7611
|
#
|
@@ -7459,15 +7627,15 @@ module Aws::S3
|
|
7459
7627
|
#
|
7460
7628
|
# @!attribute [rw] encoding_type
|
7461
7629
|
# Requests Amazon S3 to encode the object keys in the response and
|
7462
|
-
# specifies the encoding method to use. An object key
|
7463
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7630
|
+
# specifies the encoding method to use. An object key can contain any
|
7631
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7464
7632
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7465
7633
|
# characters that are not supported in XML 1.0, you can add this
|
7466
7634
|
# parameter to request that Amazon S3 encode the keys in the response.
|
7467
7635
|
# @return [String]
|
7468
7636
|
#
|
7469
7637
|
# @!attribute [rw] key_marker
|
7470
|
-
# Together with upload-id-marker
|
7638
|
+
# Together with `upload-id-marker`, this parameter specifies the
|
7471
7639
|
# multipart upload after which listing should begin.
|
7472
7640
|
#
|
7473
7641
|
# If `upload-id-marker` is not specified, only the keys
|
@@ -7489,8 +7657,8 @@ module Aws::S3
|
|
7489
7657
|
# @!attribute [rw] prefix
|
7490
7658
|
# Lists in-progress uploads only for those keys that begin with the
|
7491
7659
|
# specified prefix. You can use prefixes to separate a bucket into
|
7492
|
-
# different grouping of keys. (You can think of using prefix to make
|
7493
|
-
# groups in the same way you'd use a folder in a file system.)
|
7660
|
+
# different grouping of keys. (You can think of using `prefix` to make
|
7661
|
+
# groups in the same way that you'd use a folder in a file system.)
|
7494
7662
|
# @return [String]
|
7495
7663
|
#
|
7496
7664
|
# @!attribute [rw] upload_id_marker
|
@@ -7508,6 +7676,20 @@ module Aws::S3
|
|
7508
7676
|
# `403 Forbidden` (access denied).
|
7509
7677
|
# @return [String]
|
7510
7678
|
#
|
7679
|
+
# @!attribute [rw] request_payer
|
7680
|
+
# Confirms that the requester knows that they will be charged for the
|
7681
|
+
# request. Bucket owners need not specify this parameter in their
|
7682
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
7683
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
7684
|
+
# charges to copy the object. For information about downloading
|
7685
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
7686
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
7687
|
+
#
|
7688
|
+
#
|
7689
|
+
#
|
7690
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7691
|
+
# @return [String]
|
7692
|
+
#
|
7511
7693
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation
|
7512
7694
|
#
|
7513
7695
|
class ListMultipartUploadsRequest < Struct.new(
|
@@ -7518,7 +7700,8 @@ module Aws::S3
|
|
7518
7700
|
:max_uploads,
|
7519
7701
|
:prefix,
|
7520
7702
|
:upload_id_marker,
|
7521
|
-
:expected_bucket_owner
|
7703
|
+
:expected_bucket_owner,
|
7704
|
+
:request_payer)
|
7522
7705
|
SENSITIVE = []
|
7523
7706
|
include Aws::Structure
|
7524
7707
|
end
|
@@ -7526,9 +7709,9 @@ module Aws::S3
|
|
7526
7709
|
# @!attribute [rw] is_truncated
|
7527
7710
|
# A flag that indicates whether Amazon S3 returned all of the results
|
7528
7711
|
# that satisfied the search criteria. If your results were truncated,
|
7529
|
-
# you can make a follow-up paginated request using the
|
7530
|
-
# and NextVersionIdMarker response parameters as a
|
7531
|
-
# another request to return the rest of the results.
|
7712
|
+
# you can make a follow-up paginated request by using the
|
7713
|
+
# `NextKeyMarker` and `NextVersionIdMarker` response parameters as a
|
7714
|
+
# starting place in another request to return the rest of the results.
|
7532
7715
|
# @return [Boolean]
|
7533
7716
|
#
|
7534
7717
|
# @!attribute [rw] key_marker
|
@@ -7550,7 +7733,7 @@ module Aws::S3
|
|
7550
7733
|
# When the number of responses exceeds the value of `MaxKeys`,
|
7551
7734
|
# `NextVersionIdMarker` specifies the first object version not
|
7552
7735
|
# returned that satisfies the search criteria. Use this value for the
|
7553
|
-
# version-id-marker request parameter in a subsequent request.
|
7736
|
+
# `version-id-marker` request parameter in a subsequent request.
|
7554
7737
|
# @return [String]
|
7555
7738
|
#
|
7556
7739
|
# @!attribute [rw] versions
|
@@ -7575,7 +7758,7 @@ module Aws::S3
|
|
7575
7758
|
# that you specify to group keys. All keys that contain the same
|
7576
7759
|
# string between the prefix and the first occurrence of the delimiter
|
7577
7760
|
# are grouped under a single result element in `CommonPrefixes`. These
|
7578
|
-
# groups are counted as one result against the max-keys limitation.
|
7761
|
+
# groups are counted as one result against the `max-keys` limitation.
|
7579
7762
|
# These keys are not returned elsewhere in the response.
|
7580
7763
|
# @return [String]
|
7581
7764
|
#
|
@@ -7592,13 +7775,18 @@ module Aws::S3
|
|
7592
7775
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7593
7776
|
# XML response.
|
7594
7777
|
#
|
7595
|
-
# If you specify encoding-type request parameter, Amazon S3
|
7596
|
-
# this element in the response, and returns encoded key name
|
7597
|
-
# the following response elements:
|
7778
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7779
|
+
# includes this element in the response, and returns encoded key name
|
7780
|
+
# values in the following response elements:
|
7598
7781
|
#
|
7599
7782
|
# `KeyMarker, NextKeyMarker, Prefix, Key`, and `Delimiter`.
|
7600
7783
|
# @return [String]
|
7601
7784
|
#
|
7785
|
+
# @!attribute [rw] request_charged
|
7786
|
+
# If present, indicates that the requester was successfully charged
|
7787
|
+
# for the request.
|
7788
|
+
# @return [String]
|
7789
|
+
#
|
7602
7790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsOutput AWS API Documentation
|
7603
7791
|
#
|
7604
7792
|
class ListObjectVersionsOutput < Struct.new(
|
@@ -7614,7 +7802,8 @@ module Aws::S3
|
|
7614
7802
|
:delimiter,
|
7615
7803
|
:max_keys,
|
7616
7804
|
:common_prefixes,
|
7617
|
-
:encoding_type
|
7805
|
+
:encoding_type,
|
7806
|
+
:request_charged)
|
7618
7807
|
SENSITIVE = []
|
7619
7808
|
include Aws::Structure
|
7620
7809
|
end
|
@@ -7627,15 +7816,15 @@ module Aws::S3
|
|
7627
7816
|
# A delimiter is a character that you specify to group keys. All keys
|
7628
7817
|
# that contain the same string between the `prefix` and the first
|
7629
7818
|
# occurrence of the delimiter are grouped under a single result
|
7630
|
-
# element in CommonPrefixes
|
7631
|
-
# against the max-keys limitation. These keys are not returned
|
7819
|
+
# element in `CommonPrefixes`. These groups are counted as one result
|
7820
|
+
# against the `max-keys` limitation. These keys are not returned
|
7632
7821
|
# elsewhere in the response.
|
7633
7822
|
# @return [String]
|
7634
7823
|
#
|
7635
7824
|
# @!attribute [rw] encoding_type
|
7636
7825
|
# Requests Amazon S3 to encode the object keys in the response and
|
7637
|
-
# specifies the encoding method to use. An object key
|
7638
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
7826
|
+
# specifies the encoding method to use. An object key can contain any
|
7827
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7639
7828
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7640
7829
|
# characters that are not supported in XML 1.0, you can add this
|
7641
7830
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7646,22 +7835,22 @@ module Aws::S3
|
|
7646
7835
|
# @return [String]
|
7647
7836
|
#
|
7648
7837
|
# @!attribute [rw] max_keys
|
7649
|
-
# Sets the maximum number of keys returned in the response. By
|
7650
|
-
# the action returns up to 1,000 key names. The response
|
7651
|
-
# fewer keys but will never contain more. If additional
|
7652
|
-
# the search criteria, but were not returned because
|
7653
|
-
# exceeded, the response contains
|
7654
|
-
#
|
7655
|
-
#
|
7838
|
+
# Sets the maximum number of keys returned in the response. By
|
7839
|
+
# default, the action returns up to 1,000 key names. The response
|
7840
|
+
# might contain fewer keys but will never contain more. If additional
|
7841
|
+
# keys satisfy the search criteria, but were not returned because
|
7842
|
+
# `max-keys` was exceeded, the response contains
|
7843
|
+
# `<isTruncated>true</isTruncated>`. To return the additional keys,
|
7844
|
+
# see `key-marker` and `version-id-marker`.
|
7656
7845
|
# @return [Integer]
|
7657
7846
|
#
|
7658
7847
|
# @!attribute [rw] prefix
|
7659
7848
|
# Use this parameter to select only those keys that begin with the
|
7660
7849
|
# specified prefix. You can use prefixes to separate a bucket into
|
7661
|
-
# different groupings of keys. (You can think of using prefix to
|
7662
|
-
# groups in the same way you'd use a folder in a file
|
7663
|
-
# can use prefix with delimiter to roll up numerous
|
7664
|
-
# single result under CommonPrefixes
|
7850
|
+
# different groupings of keys. (You can think of using `prefix` to
|
7851
|
+
# make groups in the same way that you'd use a folder in a file
|
7852
|
+
# system.) You can use `prefix` with `delimiter` to roll up numerous
|
7853
|
+
# objects into a single result under `CommonPrefixes`.
|
7665
7854
|
# @return [String]
|
7666
7855
|
#
|
7667
7856
|
# @!attribute [rw] version_id_marker
|
@@ -7674,6 +7863,25 @@ module Aws::S3
|
|
7674
7863
|
# `403 Forbidden` (access denied).
|
7675
7864
|
# @return [String]
|
7676
7865
|
#
|
7866
|
+
# @!attribute [rw] request_payer
|
7867
|
+
# Confirms that the requester knows that they will be charged for the
|
7868
|
+
# request. Bucket owners need not specify this parameter in their
|
7869
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
7870
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
7871
|
+
# charges to copy the object. For information about downloading
|
7872
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
7873
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
7874
|
+
#
|
7875
|
+
#
|
7876
|
+
#
|
7877
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7878
|
+
# @return [String]
|
7879
|
+
#
|
7880
|
+
# @!attribute [rw] optional_object_attributes
|
7881
|
+
# Specifies the optional fields that you want returned in the
|
7882
|
+
# response. Fields that you do not specify are not returned.
|
7883
|
+
# @return [Array<String>]
|
7884
|
+
#
|
7677
7885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation
|
7678
7886
|
#
|
7679
7887
|
class ListObjectVersionsRequest < Struct.new(
|
@@ -7684,7 +7892,9 @@ module Aws::S3
|
|
7684
7892
|
:max_keys,
|
7685
7893
|
:prefix,
|
7686
7894
|
:version_id_marker,
|
7687
|
-
:expected_bucket_owner
|
7895
|
+
:expected_bucket_owner,
|
7896
|
+
:request_payer,
|
7897
|
+
:optional_object_attributes)
|
7688
7898
|
SENSITIVE = []
|
7689
7899
|
include Aws::Structure
|
7690
7900
|
end
|
@@ -7700,14 +7910,18 @@ module Aws::S3
|
|
7700
7910
|
# @return [String]
|
7701
7911
|
#
|
7702
7912
|
# @!attribute [rw] next_marker
|
7703
|
-
# When response is truncated (the IsTruncated element value in
|
7704
|
-
# response is true), you can use the key name in this field as
|
7705
|
-
# in the subsequent request to get next set
|
7706
|
-
# lists objects in alphabetical order
|
7707
|
-
#
|
7708
|
-
#
|
7709
|
-
#
|
7710
|
-
#
|
7913
|
+
# When the response is truncated (the `IsTruncated` element value in
|
7914
|
+
# the response is `true`), you can use the key name in this field as
|
7915
|
+
# the `marker` parameter in the subsequent request to get the next set
|
7916
|
+
# of objects. Amazon S3 lists objects in alphabetical order.
|
7917
|
+
#
|
7918
|
+
# <note markdown="1"> This element is returned only if you have the `delimiter` request
|
7919
|
+
# parameter specified. If the response does not include the
|
7920
|
+
# `NextMarker` element and it is truncated, you can use the value of
|
7921
|
+
# the last `Key` element in the response as the `marker` parameter in
|
7922
|
+
# the subsequent request to get the next set of object keys.
|
7923
|
+
#
|
7924
|
+
# </note>
|
7711
7925
|
# @return [String]
|
7712
7926
|
#
|
7713
7927
|
# @!attribute [rw] contents
|
@@ -7738,19 +7952,20 @@ module Aws::S3
|
|
7738
7952
|
# All of the keys (up to 1,000) rolled up in a common prefix count as
|
7739
7953
|
# a single return when calculating the number of returns.
|
7740
7954
|
#
|
7741
|
-
# A response can contain CommonPrefixes only if you specify a
|
7955
|
+
# A response can contain `CommonPrefixes` only if you specify a
|
7742
7956
|
# delimiter.
|
7743
7957
|
#
|
7744
|
-
# CommonPrefixes contains all (if there are any) keys between
|
7745
|
-
# and the next occurrence of the string specified by the
|
7958
|
+
# `CommonPrefixes` contains all (if there are any) keys between
|
7959
|
+
# `Prefix` and the next occurrence of the string specified by the
|
7960
|
+
# delimiter.
|
7746
7961
|
#
|
7747
|
-
# CommonPrefixes lists keys that act like subdirectories in the
|
7748
|
-
# directory specified by Prefix
|
7962
|
+
# `CommonPrefixes` lists keys that act like subdirectories in the
|
7963
|
+
# directory specified by `Prefix`.
|
7749
7964
|
#
|
7750
|
-
# For example, if the prefix is notes
|
7751
|
-
# (
|
7752
|
-
# of the keys that roll up into a common prefix
|
7753
|
-
# return when calculating the number of returns.
|
7965
|
+
# For example, if the prefix is `notes/` and the delimiter is a slash
|
7966
|
+
# (`/`), as in `notes/summer/july`, the common prefix is
|
7967
|
+
# `notes/summer/`. All of the keys that roll up into a common prefix
|
7968
|
+
# count as a single return when calculating the number of returns.
|
7754
7969
|
# @return [Array<Types::CommonPrefix>]
|
7755
7970
|
#
|
7756
7971
|
# @!attribute [rw] encoding_type
|
@@ -7758,6 +7973,11 @@ module Aws::S3
|
|
7758
7973
|
# response.
|
7759
7974
|
# @return [String]
|
7760
7975
|
#
|
7976
|
+
# @!attribute [rw] request_charged
|
7977
|
+
# If present, indicates that the requester was successfully charged
|
7978
|
+
# for the request.
|
7979
|
+
# @return [String]
|
7980
|
+
#
|
7761
7981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation
|
7762
7982
|
#
|
7763
7983
|
class ListObjectsOutput < Struct.new(
|
@@ -7770,7 +7990,8 @@ module Aws::S3
|
|
7770
7990
|
:delimiter,
|
7771
7991
|
:max_keys,
|
7772
7992
|
:common_prefixes,
|
7773
|
-
:encoding_type
|
7993
|
+
:encoding_type,
|
7994
|
+
:request_charged)
|
7774
7995
|
SENSITIVE = []
|
7775
7996
|
include Aws::Structure
|
7776
7997
|
end
|
@@ -7787,14 +8008,14 @@ module Aws::S3
|
|
7787
8008
|
# bucket name. For more information about access point ARNs, see
|
7788
8009
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7789
8010
|
#
|
7790
|
-
# When
|
8011
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7791
8012
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7792
8013
|
# takes the form `
|
7793
8014
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7794
|
-
# When
|
7795
|
-
# Services SDKs, you provide the Outposts
|
7796
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7797
|
-
# [
|
8015
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8016
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8017
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8018
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7798
8019
|
#
|
7799
8020
|
#
|
7800
8021
|
#
|
@@ -7803,13 +8024,13 @@ module Aws::S3
|
|
7803
8024
|
# @return [String]
|
7804
8025
|
#
|
7805
8026
|
# @!attribute [rw] delimiter
|
7806
|
-
# A delimiter is a character you use to group keys.
|
8027
|
+
# A delimiter is a character that you use to group keys.
|
7807
8028
|
# @return [String]
|
7808
8029
|
#
|
7809
8030
|
# @!attribute [rw] encoding_type
|
7810
8031
|
# Requests Amazon S3 to encode the object keys in the response and
|
7811
|
-
# specifies the encoding method to use. An object key
|
7812
|
-
# Unicode character; however, XML 1.0 parser cannot parse some
|
8032
|
+
# specifies the encoding method to use. An object key can contain any
|
8033
|
+
# Unicode character; however, the XML 1.0 parser cannot parse some
|
7813
8034
|
# characters, such as characters with an ASCII value from 0 to 10. For
|
7814
8035
|
# characters that are not supported in XML 1.0, you can add this
|
7815
8036
|
# parameter to request that Amazon S3 encode the keys in the response.
|
@@ -7822,9 +8043,9 @@ module Aws::S3
|
|
7822
8043
|
# @return [String]
|
7823
8044
|
#
|
7824
8045
|
# @!attribute [rw] max_keys
|
7825
|
-
# Sets the maximum number of keys returned in the response. By
|
7826
|
-
# the action returns up to 1,000 key names. The response
|
7827
|
-
# fewer keys but will never contain more.
|
8046
|
+
# Sets the maximum number of keys returned in the response. By
|
8047
|
+
# default, the action returns up to 1,000 key names. The response
|
8048
|
+
# might contain fewer keys but will never contain more.
|
7828
8049
|
# @return [Integer]
|
7829
8050
|
#
|
7830
8051
|
# @!attribute [rw] prefix
|
@@ -7843,6 +8064,11 @@ module Aws::S3
|
|
7843
8064
|
# `403 Forbidden` (access denied).
|
7844
8065
|
# @return [String]
|
7845
8066
|
#
|
8067
|
+
# @!attribute [rw] optional_object_attributes
|
8068
|
+
# Specifies the optional fields that you want returned in the
|
8069
|
+
# response. Fields that you do not specify are not returned.
|
8070
|
+
# @return [Array<String>]
|
8071
|
+
#
|
7846
8072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
|
7847
8073
|
#
|
7848
8074
|
class ListObjectsRequest < Struct.new(
|
@@ -7853,15 +8079,17 @@ module Aws::S3
|
|
7853
8079
|
:max_keys,
|
7854
8080
|
:prefix,
|
7855
8081
|
:request_payer,
|
7856
|
-
:expected_bucket_owner
|
8082
|
+
:expected_bucket_owner,
|
8083
|
+
:optional_object_attributes)
|
7857
8084
|
SENSITIVE = []
|
7858
8085
|
include Aws::Structure
|
7859
8086
|
end
|
7860
8087
|
|
7861
8088
|
# @!attribute [rw] is_truncated
|
7862
|
-
# Set to false if all of the results were returned. Set to true if
|
8089
|
+
# Set to `false` if all of the results were returned. Set to `true` if
|
7863
8090
|
# more keys are available to return. If the number of results exceeds
|
7864
|
-
# that specified by MaxKeys
|
8091
|
+
# that specified by `MaxKeys`, all of the results might not be
|
8092
|
+
# returned.
|
7865
8093
|
# @return [Boolean]
|
7866
8094
|
#
|
7867
8095
|
# @!attribute [rw] contents
|
@@ -7880,14 +8108,14 @@ module Aws::S3
|
|
7880
8108
|
# bucket name. For more information about access point ARNs, see
|
7881
8109
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
7882
8110
|
#
|
7883
|
-
# When
|
8111
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
7884
8112
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7885
8113
|
# takes the form `
|
7886
8114
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
7887
|
-
# When
|
7888
|
-
# Services SDKs, you provide the Outposts
|
7889
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
7890
|
-
# [
|
8115
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8116
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8117
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8118
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
7891
8119
|
#
|
7892
8120
|
#
|
7893
8121
|
#
|
@@ -7900,17 +8128,17 @@ module Aws::S3
|
|
7900
8128
|
# @return [String]
|
7901
8129
|
#
|
7902
8130
|
# @!attribute [rw] delimiter
|
7903
|
-
# Causes keys that contain the same string between the prefix and
|
7904
|
-
# first occurrence of the delimiter to be rolled up into a single
|
7905
|
-
# result element in the CommonPrefixes collection. These rolled-up
|
8131
|
+
# Causes keys that contain the same string between the `prefix` and
|
8132
|
+
# the first occurrence of the delimiter to be rolled up into a single
|
8133
|
+
# result element in the `CommonPrefixes` collection. These rolled-up
|
7906
8134
|
# keys are not returned elsewhere in the response. Each rolled-up
|
7907
8135
|
# result counts as only one return against the `MaxKeys` value.
|
7908
8136
|
# @return [String]
|
7909
8137
|
#
|
7910
8138
|
# @!attribute [rw] max_keys
|
7911
|
-
# Sets the maximum number of keys returned in the response. By
|
7912
|
-
# the action returns up to 1,000 key names. The response
|
7913
|
-
# fewer keys but will never contain more.
|
8139
|
+
# Sets the maximum number of keys returned in the response. By
|
8140
|
+
# default, the action returns up to 1,000 key names. The response
|
8141
|
+
# might contain fewer keys but will never contain more.
|
7914
8142
|
# @return [Integer]
|
7915
8143
|
#
|
7916
8144
|
# @!attribute [rw] common_prefixes
|
@@ -7937,7 +8165,7 @@ module Aws::S3
|
|
7937
8165
|
# Encoding type used by Amazon S3 to encode object key names in the
|
7938
8166
|
# XML response.
|
7939
8167
|
#
|
7940
|
-
# If you specify the encoding-type request parameter, Amazon S3
|
8168
|
+
# If you specify the `encoding-type` request parameter, Amazon S3
|
7941
8169
|
# includes this element in the response, and returns encoded key name
|
7942
8170
|
# values in the following response elements:
|
7943
8171
|
#
|
@@ -7945,13 +8173,14 @@ module Aws::S3
|
|
7945
8173
|
# @return [String]
|
7946
8174
|
#
|
7947
8175
|
# @!attribute [rw] key_count
|
7948
|
-
# KeyCount is the number of keys returned with this request.
|
7949
|
-
# will always be less than or
|
7950
|
-
# 50 keys, your result will include
|
8176
|
+
# `KeyCount` is the number of keys returned with this request.
|
8177
|
+
# `KeyCount` will always be less than or equal to the `MaxKeys` field.
|
8178
|
+
# For example, if you ask for 50 keys, your result will include 50
|
8179
|
+
# keys or fewer.
|
7951
8180
|
# @return [Integer]
|
7952
8181
|
#
|
7953
8182
|
# @!attribute [rw] continuation_token
|
7954
|
-
# If ContinuationToken was sent with the request, it is included in
|
8183
|
+
# If `ContinuationToken` was sent with the request, it is included in
|
7955
8184
|
# the response.
|
7956
8185
|
# @return [String]
|
7957
8186
|
#
|
@@ -7968,6 +8197,11 @@ module Aws::S3
|
|
7968
8197
|
# response.
|
7969
8198
|
# @return [String]
|
7970
8199
|
#
|
8200
|
+
# @!attribute [rw] request_charged
|
8201
|
+
# If present, indicates that the requester was successfully charged
|
8202
|
+
# for the request.
|
8203
|
+
# @return [String]
|
8204
|
+
#
|
7971
8205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Output AWS API Documentation
|
7972
8206
|
#
|
7973
8207
|
class ListObjectsV2Output < Struct.new(
|
@@ -7982,7 +8216,8 @@ module Aws::S3
|
|
7982
8216
|
:key_count,
|
7983
8217
|
:continuation_token,
|
7984
8218
|
:next_continuation_token,
|
7985
|
-
:start_after
|
8219
|
+
:start_after,
|
8220
|
+
:request_charged)
|
7986
8221
|
SENSITIVE = []
|
7987
8222
|
include Aws::Structure
|
7988
8223
|
end
|
@@ -7999,14 +8234,14 @@ module Aws::S3
|
|
7999
8234
|
# bucket name. For more information about access point ARNs, see
|
8000
8235
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
8001
8236
|
#
|
8002
|
-
# When
|
8237
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
8003
8238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8004
8239
|
# takes the form `
|
8005
8240
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8006
|
-
# When
|
8007
|
-
# Services SDKs, you provide the Outposts
|
8008
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
8009
|
-
# [
|
8241
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8242
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8243
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8244
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8010
8245
|
#
|
8011
8246
|
#
|
8012
8247
|
#
|
@@ -8015,7 +8250,7 @@ module Aws::S3
|
|
8015
8250
|
# @return [String]
|
8016
8251
|
#
|
8017
8252
|
# @!attribute [rw] delimiter
|
8018
|
-
# A delimiter is a character you use to group keys.
|
8253
|
+
# A delimiter is a character that you use to group keys.
|
8019
8254
|
# @return [String]
|
8020
8255
|
#
|
8021
8256
|
# @!attribute [rw] encoding_type
|
@@ -8024,9 +8259,9 @@ module Aws::S3
|
|
8024
8259
|
# @return [String]
|
8025
8260
|
#
|
8026
8261
|
# @!attribute [rw] max_keys
|
8027
|
-
# Sets the maximum number of keys returned in the response. By
|
8028
|
-
# the action returns up to 1,000 key names. The response
|
8029
|
-
# fewer keys but will never contain more.
|
8262
|
+
# Sets the maximum number of keys returned in the response. By
|
8263
|
+
# default, the action returns up to 1,000 key names. The response
|
8264
|
+
# might contain fewer keys but will never contain more.
|
8030
8265
|
# @return [Integer]
|
8031
8266
|
#
|
8032
8267
|
# @!attribute [rw] prefix
|
@@ -8034,15 +8269,15 @@ module Aws::S3
|
|
8034
8269
|
# @return [String]
|
8035
8270
|
#
|
8036
8271
|
# @!attribute [rw] continuation_token
|
8037
|
-
# ContinuationToken indicates Amazon S3 that the list is being
|
8038
|
-
# continued on this bucket with a token. ContinuationToken is
|
8272
|
+
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
8273
|
+
# continued on this bucket with a token. `ContinuationToken` is
|
8039
8274
|
# obfuscated and is not a real key.
|
8040
8275
|
# @return [String]
|
8041
8276
|
#
|
8042
8277
|
# @!attribute [rw] fetch_owner
|
8043
|
-
# The owner field is not present in
|
8044
|
-
# return owner field with each key in the result then set
|
8045
|
-
#
|
8278
|
+
# The owner field is not present in `ListObjectsV2` by default. If you
|
8279
|
+
# want to return the owner field with each key in the result, then set
|
8280
|
+
# the `FetchOwner` field to `true`.
|
8046
8281
|
# @return [Boolean]
|
8047
8282
|
#
|
8048
8283
|
# @!attribute [rw] start_after
|
@@ -8063,6 +8298,11 @@ module Aws::S3
|
|
8063
8298
|
# `403 Forbidden` (access denied).
|
8064
8299
|
# @return [String]
|
8065
8300
|
#
|
8301
|
+
# @!attribute [rw] optional_object_attributes
|
8302
|
+
# Specifies the optional fields that you want returned in the
|
8303
|
+
# response. Fields that you do not specify are not returned.
|
8304
|
+
# @return [Array<String>]
|
8305
|
+
#
|
8066
8306
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation
|
8067
8307
|
#
|
8068
8308
|
class ListObjectsV2Request < Struct.new(
|
@@ -8075,7 +8315,8 @@ module Aws::S3
|
|
8075
8315
|
:fetch_owner,
|
8076
8316
|
:start_after,
|
8077
8317
|
:request_payer,
|
8078
|
-
:expected_bucket_owner
|
8318
|
+
:expected_bucket_owner,
|
8319
|
+
:optional_object_attributes)
|
8079
8320
|
SENSITIVE = []
|
8080
8321
|
include Aws::Structure
|
8081
8322
|
end
|
@@ -8087,7 +8328,7 @@ module Aws::S3
|
|
8087
8328
|
# includes this header indicating when the initiated multipart upload
|
8088
8329
|
# will become eligible for abort operation. For more information, see
|
8089
8330
|
# [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
8090
|
-
#
|
8331
|
+
# Configuration][1].
|
8091
8332
|
#
|
8092
8333
|
# The response will also include the `x-amz-abort-rule-id` header that
|
8093
8334
|
# will provide the ID of the lifecycle configuration rule that defines
|
@@ -8126,7 +8367,7 @@ module Aws::S3
|
|
8126
8367
|
#
|
8127
8368
|
# @!attribute [rw] next_part_number_marker
|
8128
8369
|
# When a list is truncated, this element specifies the last part in
|
8129
|
-
# the list, as well as the value to use for the part-number-marker
|
8370
|
+
# the list, as well as the value to use for the `part-number-marker`
|
8130
8371
|
# request parameter in a subsequent request.
|
8131
8372
|
# @return [Integer]
|
8132
8373
|
#
|
@@ -8208,14 +8449,14 @@ module Aws::S3
|
|
8208
8449
|
# bucket name. For more information about access point ARNs, see
|
8209
8450
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
8210
8451
|
#
|
8211
|
-
# When
|
8452
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
8212
8453
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
8213
8454
|
# takes the form `
|
8214
8455
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8215
|
-
# When
|
8216
|
-
# Services SDKs, you provide the Outposts
|
8217
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
8218
|
-
# [
|
8456
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
8457
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
8458
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
8459
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
8219
8460
|
#
|
8220
8461
|
#
|
8221
8462
|
#
|
@@ -8244,9 +8485,11 @@ module Aws::S3
|
|
8244
8485
|
# @!attribute [rw] request_payer
|
8245
8486
|
# Confirms that the requester knows that they will be charged for the
|
8246
8487
|
# request. Bucket owners need not specify this parameter in their
|
8247
|
-
# requests.
|
8248
|
-
# Pays
|
8249
|
-
#
|
8488
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
8489
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
8490
|
+
# charges to copy the object. For information about downloading
|
8491
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
8492
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
8250
8493
|
#
|
8251
8494
|
#
|
8252
8495
|
#
|
@@ -8359,11 +8602,11 @@ module Aws::S3
|
|
8359
8602
|
# A metadata key-value pair to store with an object.
|
8360
8603
|
#
|
8361
8604
|
# @!attribute [rw] name
|
8362
|
-
# Name of the
|
8605
|
+
# Name of the object.
|
8363
8606
|
# @return [String]
|
8364
8607
|
#
|
8365
8608
|
# @!attribute [rw] value
|
8366
|
-
# Value of the
|
8609
|
+
# Value of the object.
|
8367
8610
|
# @return [String]
|
8368
8611
|
#
|
8369
8612
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation
|
@@ -8435,7 +8678,9 @@ module Aws::S3
|
|
8435
8678
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html
|
8436
8679
|
#
|
8437
8680
|
# @!attribute [rw] id
|
8438
|
-
# The ID used to identify the metrics configuration.
|
8681
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
8682
|
+
# character limit and can only contain letters, numbers, periods,
|
8683
|
+
# dashes, and underscores.
|
8439
8684
|
# @return [String]
|
8440
8685
|
#
|
8441
8686
|
# @!attribute [rw] filter
|
@@ -8705,12 +8950,12 @@ module Aws::S3
|
|
8705
8950
|
end
|
8706
8951
|
|
8707
8952
|
# Specifies object key name filtering rules. For information about key
|
8708
|
-
# name filtering, see [Configuring
|
8709
|
-
# *Amazon S3 User Guide*.
|
8953
|
+
# name filtering, see [Configuring event notifications using object key
|
8954
|
+
# name filtering][1] in the *Amazon S3 User Guide*.
|
8710
8955
|
#
|
8711
8956
|
#
|
8712
8957
|
#
|
8713
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8958
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
8714
8959
|
#
|
8715
8960
|
# @!attribute [rw] key
|
8716
8961
|
# A container for object key name prefix and suffix filtering rules.
|
@@ -8776,6 +9021,18 @@ module Aws::S3
|
|
8776
9021
|
# The owner of the object
|
8777
9022
|
# @return [Types::Owner]
|
8778
9023
|
#
|
9024
|
+
# @!attribute [rw] restore_status
|
9025
|
+
# Specifies the restoration status of an object. Objects in certain
|
9026
|
+
# storage classes must be restored before they can be retrieved. For
|
9027
|
+
# more information about these storage classes and how to work with
|
9028
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9029
|
+
# *Amazon S3 User Guide*.
|
9030
|
+
#
|
9031
|
+
#
|
9032
|
+
#
|
9033
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9034
|
+
# @return [Types::RestoreStatus]
|
9035
|
+
#
|
8779
9036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation
|
8780
9037
|
#
|
8781
9038
|
class Object < Struct.new(
|
@@ -8785,7 +9042,8 @@ module Aws::S3
|
|
8785
9042
|
:checksum_algorithm,
|
8786
9043
|
:size,
|
8787
9044
|
:storage_class,
|
8788
|
-
:owner
|
9045
|
+
:owner,
|
9046
|
+
:restore_status)
|
8789
9047
|
SENSITIVE = []
|
8790
9048
|
include Aws::Structure
|
8791
9049
|
end
|
@@ -9020,6 +9278,18 @@ module Aws::S3
|
|
9020
9278
|
# Specifies the owner of the object.
|
9021
9279
|
# @return [Types::Owner]
|
9022
9280
|
#
|
9281
|
+
# @!attribute [rw] restore_status
|
9282
|
+
# Specifies the restoration status of an object. Objects in certain
|
9283
|
+
# storage classes must be restored before they can be retrieved. For
|
9284
|
+
# more information about these storage classes and how to work with
|
9285
|
+
# archived objects, see [ Working with archived objects][1] in the
|
9286
|
+
# *Amazon S3 User Guide*.
|
9287
|
+
#
|
9288
|
+
#
|
9289
|
+
#
|
9290
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
9291
|
+
# @return [Types::RestoreStatus]
|
9292
|
+
#
|
9023
9293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation
|
9024
9294
|
#
|
9025
9295
|
class ObjectVersion < Struct.new(
|
@@ -9031,7 +9301,8 @@ module Aws::S3
|
|
9031
9301
|
:version_id,
|
9032
9302
|
:is_latest,
|
9033
9303
|
:last_modified,
|
9034
|
-
:owner
|
9304
|
+
:owner,
|
9305
|
+
:restore_status)
|
9035
9306
|
SENSITIVE = []
|
9036
9307
|
include Aws::Structure
|
9037
9308
|
end
|
@@ -9073,7 +9344,24 @@ module Aws::S3
|
|
9073
9344
|
# Container for the owner's display name and ID.
|
9074
9345
|
#
|
9075
9346
|
# @!attribute [rw] display_name
|
9076
|
-
# Container for the display name of the owner.
|
9347
|
+
# Container for the display name of the owner. This value is only
|
9348
|
+
# supported in the following Amazon Web Services Regions:
|
9349
|
+
#
|
9350
|
+
# * US East (N. Virginia)
|
9351
|
+
#
|
9352
|
+
# * US West (N. California)
|
9353
|
+
#
|
9354
|
+
# * US West (Oregon)
|
9355
|
+
#
|
9356
|
+
# * Asia Pacific (Singapore)
|
9357
|
+
#
|
9358
|
+
# * Asia Pacific (Sydney)
|
9359
|
+
#
|
9360
|
+
# * Asia Pacific (Tokyo)
|
9361
|
+
#
|
9362
|
+
# * Europe (Ireland)
|
9363
|
+
#
|
9364
|
+
# * South America (São Paulo)
|
9077
9365
|
# @return [String]
|
9078
9366
|
#
|
9079
9367
|
# @!attribute [rw] id
|
@@ -9578,10 +9866,14 @@ module Aws::S3
|
|
9578
9866
|
|
9579
9867
|
# @!attribute [rw] bucket
|
9580
9868
|
# Specifies default encryption for a bucket using server-side
|
9581
|
-
# encryption with
|
9582
|
-
#
|
9583
|
-
#
|
9584
|
-
#
|
9869
|
+
# encryption with different key options. By default, all buckets have
|
9870
|
+
# a default encryption configuration that uses server-side encryption
|
9871
|
+
# with Amazon S3 managed keys (SSE-S3). You can optionally configure
|
9872
|
+
# default encryption for a bucket by using server-side encryption with
|
9873
|
+
# an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key
|
9874
|
+
# (SSE-C). For information about the bucket default encryption
|
9875
|
+
# feature, see [Amazon S3 Bucket Default Encryption][1] in the *Amazon
|
9876
|
+
# S3 User Guide*.
|
9585
9877
|
#
|
9586
9878
|
#
|
9587
9879
|
#
|
@@ -9834,7 +10126,9 @@ module Aws::S3
|
|
9834
10126
|
# @return [String]
|
9835
10127
|
#
|
9836
10128
|
# @!attribute [rw] id
|
9837
|
-
# The ID used to identify the metrics configuration.
|
10129
|
+
# The ID used to identify the metrics configuration. The ID has a 64
|
10130
|
+
# character limit and can only contain letters, numbers, periods,
|
10131
|
+
# dashes, and underscores.
|
9838
10132
|
# @return [String]
|
9839
10133
|
#
|
9840
10134
|
# @!attribute [rw] metrics_configuration
|
@@ -10457,14 +10751,14 @@ module Aws::S3
|
|
10457
10751
|
# bucket name. For more information about access point ARNs, see
|
10458
10752
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
10459
10753
|
#
|
10460
|
-
# When
|
10754
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
10461
10755
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10462
10756
|
# takes the form `
|
10463
10757
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10464
|
-
# When
|
10465
|
-
# Services SDKs, you provide the Outposts
|
10466
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
10467
|
-
# [
|
10758
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
10759
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
10760
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
10761
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10468
10762
|
#
|
10469
10763
|
#
|
10470
10764
|
#
|
@@ -10475,9 +10769,11 @@ module Aws::S3
|
|
10475
10769
|
# @!attribute [rw] request_payer
|
10476
10770
|
# Confirms that the requester knows that they will be charged for the
|
10477
10771
|
# request. Bucket owners need not specify this parameter in their
|
10478
|
-
# requests.
|
10479
|
-
# Pays
|
10480
|
-
#
|
10772
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10773
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10774
|
+
# charges to copy the object. For information about downloading
|
10775
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10776
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10481
10777
|
#
|
10482
10778
|
#
|
10483
10779
|
#
|
@@ -10558,9 +10854,11 @@ module Aws::S3
|
|
10558
10854
|
# @!attribute [rw] request_payer
|
10559
10855
|
# Confirms that the requester knows that they will be charged for the
|
10560
10856
|
# request. Bucket owners need not specify this parameter in their
|
10561
|
-
# requests.
|
10562
|
-
# Pays
|
10563
|
-
#
|
10857
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10858
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10859
|
+
# charges to copy the object. For information about downloading
|
10860
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10861
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10564
10862
|
#
|
10565
10863
|
#
|
10566
10864
|
#
|
@@ -10643,9 +10941,11 @@ module Aws::S3
|
|
10643
10941
|
# @!attribute [rw] request_payer
|
10644
10942
|
# Confirms that the requester knows that they will be charged for the
|
10645
10943
|
# request. Bucket owners need not specify this parameter in their
|
10646
|
-
# requests.
|
10647
|
-
# Pays
|
10648
|
-
#
|
10944
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
10945
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
10946
|
+
# charges to copy the object. For information about downloading
|
10947
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
10948
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
10649
10949
|
#
|
10650
10950
|
#
|
10651
10951
|
#
|
@@ -10770,10 +11070,8 @@ module Aws::S3
|
|
10770
11070
|
# @return [String]
|
10771
11071
|
#
|
10772
11072
|
# @!attribute [rw] server_side_encryption
|
10773
|
-
#
|
10774
|
-
#
|
10775
|
-
# request, the response includes this header. It confirms the
|
10776
|
-
# encryption algorithm that Amazon S3 used to encrypt the object.
|
11073
|
+
# The server-side encryption algorithm used when storing this object
|
11074
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
10777
11075
|
# @return [String]
|
10778
11076
|
#
|
10779
11077
|
# @!attribute [rw] version_id
|
@@ -10794,22 +11092,25 @@ module Aws::S3
|
|
10794
11092
|
# @return [String]
|
10795
11093
|
#
|
10796
11094
|
# @!attribute [rw] ssekms_key_id
|
10797
|
-
# If `x-amz-server-side-encryption`
|
10798
|
-
# `aws:kms`, this header specifies the ID of the
|
10799
|
-
#
|
10800
|
-
#
|
11095
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11096
|
+
# `aws:kms:dsse`, this header specifies the ID of the Key Management
|
11097
|
+
# Service (KMS) symmetric encryption customer managed key that was
|
11098
|
+
# used for the object.
|
10801
11099
|
# @return [String]
|
10802
11100
|
#
|
10803
11101
|
# @!attribute [rw] ssekms_encryption_context
|
10804
11102
|
# If present, specifies the Amazon Web Services KMS Encryption Context
|
10805
11103
|
# to use for object encryption. The value of this header is a
|
10806
11104
|
# base64-encoded UTF-8 string holding JSON with the encryption context
|
10807
|
-
# key-value pairs.
|
11105
|
+
# key-value pairs. This value is stored as object metadata and
|
11106
|
+
# automatically gets passed on to Amazon Web Services KMS for future
|
11107
|
+
# `GetObject` or `CopyObject` operations on this object.
|
10808
11108
|
# @return [String]
|
10809
11109
|
#
|
10810
11110
|
# @!attribute [rw] bucket_key_enabled
|
10811
11111
|
# Indicates whether the uploaded object uses an S3 Bucket Key for
|
10812
|
-
# server-side encryption with
|
11112
|
+
# server-side encryption with Key Management Service (KMS) keys
|
11113
|
+
# (SSE-KMS).
|
10813
11114
|
# @return [Boolean]
|
10814
11115
|
#
|
10815
11116
|
# @!attribute [rw] request_charged
|
@@ -10865,14 +11166,14 @@ module Aws::S3
|
|
10865
11166
|
# bucket name. For more information about access point ARNs, see
|
10866
11167
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
10867
11168
|
#
|
10868
|
-
# When
|
11169
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
10869
11170
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10870
11171
|
# takes the form `
|
10871
11172
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10872
|
-
# When
|
10873
|
-
# Services SDKs, you provide the Outposts
|
10874
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
10875
|
-
# [
|
11173
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
11174
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
11175
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11176
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
10876
11177
|
#
|
10877
11178
|
#
|
10878
11179
|
#
|
@@ -10893,11 +11194,11 @@ module Aws::S3
|
|
10893
11194
|
# @!attribute [rw] content_disposition
|
10894
11195
|
# Specifies presentational information for the object. For more
|
10895
11196
|
# information, see
|
10896
|
-
# [
|
11197
|
+
# [https://www.rfc-editor.org/rfc/rfc6266#section-4][1].
|
10897
11198
|
#
|
10898
11199
|
#
|
10899
11200
|
#
|
10900
|
-
# [1]:
|
11201
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc6266#section-4
|
10901
11202
|
# @return [String]
|
10902
11203
|
#
|
10903
11204
|
# @!attribute [rw] content_encoding
|
@@ -10905,11 +11206,11 @@ module Aws::S3
|
|
10905
11206
|
# thus what decoding mechanisms must be applied to obtain the
|
10906
11207
|
# media-type referenced by the Content-Type header field. For more
|
10907
11208
|
# information, see
|
10908
|
-
# [
|
11209
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding][1].
|
10909
11210
|
#
|
10910
11211
|
#
|
10911
11212
|
#
|
10912
|
-
# [1]:
|
11213
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
|
10913
11214
|
# @return [String]
|
10914
11215
|
#
|
10915
11216
|
# @!attribute [rw] content_language
|
@@ -10920,11 +11221,11 @@ module Aws::S3
|
|
10920
11221
|
# Size of the body in bytes. This parameter is useful when the size of
|
10921
11222
|
# the body cannot be determined automatically. For more information,
|
10922
11223
|
# see
|
10923
|
-
# [
|
11224
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length][1].
|
10924
11225
|
#
|
10925
11226
|
#
|
10926
11227
|
#
|
10927
|
-
# [1]:
|
11228
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
|
10928
11229
|
# @return [Integer]
|
10929
11230
|
#
|
10930
11231
|
# @!attribute [rw] content_md5
|
@@ -10944,11 +11245,11 @@ module Aws::S3
|
|
10944
11245
|
# @!attribute [rw] content_type
|
10945
11246
|
# A standard MIME type describing the format of the contents. For more
|
10946
11247
|
# information, see
|
10947
|
-
# [
|
11248
|
+
# [https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type][1].
|
10948
11249
|
#
|
10949
11250
|
#
|
10950
11251
|
#
|
10951
|
-
# [1]:
|
11252
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
|
10952
11253
|
# @return [String]
|
10953
11254
|
#
|
10954
11255
|
# @!attribute [rw] checksum_algorithm
|
@@ -11019,11 +11320,11 @@ module Aws::S3
|
|
11019
11320
|
# @!attribute [rw] expires
|
11020
11321
|
# The date and time at which the object is no longer cacheable. For
|
11021
11322
|
# more information, see
|
11022
|
-
# [
|
11323
|
+
# [https://www.rfc-editor.org/rfc/rfc7234#section-5.3][1].
|
11023
11324
|
#
|
11024
11325
|
#
|
11025
11326
|
#
|
11026
|
-
# [1]:
|
11327
|
+
# [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
|
11027
11328
|
# @return [Time]
|
11028
11329
|
#
|
11029
11330
|
# @!attribute [rw] grant_full_control
|
@@ -11061,7 +11362,7 @@ module Aws::S3
|
|
11061
11362
|
#
|
11062
11363
|
# @!attribute [rw] server_side_encryption
|
11063
11364
|
# The server-side encryption algorithm used when storing this object
|
11064
|
-
# in Amazon S3 (for example, AES256
|
11365
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
|
11065
11366
|
# @return [String]
|
11066
11367
|
#
|
11067
11368
|
# @!attribute [rw] storage_class
|
@@ -11125,29 +11426,32 @@ module Aws::S3
|
|
11125
11426
|
# @return [String]
|
11126
11427
|
#
|
11127
11428
|
# @!attribute [rw] ssekms_key_id
|
11128
|
-
# If `x-amz-server-side-encryption`
|
11129
|
-
# `aws:kms`, this header specifies the ID
|
11130
|
-
# Key Management Service (
|
11429
|
+
# If `x-amz-server-side-encryption` has a valid value of `aws:kms` or
|
11430
|
+
# `aws:kms:dsse`, this header specifies the ID (Key ID, Key ARN, or
|
11431
|
+
# Key Alias) of the Key Management Service (KMS) symmetric encryption
|
11131
11432
|
# customer managed key that was used for the object. If you specify
|
11132
|
-
# `x-amz-server-side-encryption:aws:kms
|
11433
|
+
# `x-amz-server-side-encryption:aws:kms` or
|
11434
|
+
# `x-amz-server-side-encryption:aws:kms:dsse`, but do not provide`
|
11133
11435
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
11134
|
-
# Amazon Web Services managed key to protect the data. If
|
11135
|
-
# does not exist in the same account issuing the
|
11136
|
-
# the full ARN and not just the ID.
|
11436
|
+
# Amazon Web Services managed key (`aws/s3`) to protect the data. If
|
11437
|
+
# the KMS key does not exist in the same account that's issuing the
|
11438
|
+
# command, you must use the full ARN and not just the ID.
|
11137
11439
|
# @return [String]
|
11138
11440
|
#
|
11139
11441
|
# @!attribute [rw] ssekms_encryption_context
|
11140
11442
|
# Specifies the Amazon Web Services KMS Encryption Context to use for
|
11141
11443
|
# object encryption. The value of this header is a base64-encoded
|
11142
11444
|
# UTF-8 string holding JSON with the encryption context key-value
|
11143
|
-
# pairs.
|
11445
|
+
# pairs. This value is stored as object metadata and automatically
|
11446
|
+
# gets passed on to Amazon Web Services KMS for future `GetObject` or
|
11447
|
+
# `CopyObject` operations on this object.
|
11144
11448
|
# @return [String]
|
11145
11449
|
#
|
11146
11450
|
# @!attribute [rw] bucket_key_enabled
|
11147
11451
|
# Specifies whether Amazon S3 should use an S3 Bucket Key for object
|
11148
|
-
# encryption with server-side encryption using
|
11149
|
-
# Setting this header to `true` causes Amazon S3
|
11150
|
-
# Key for object encryption with SSE-KMS.
|
11452
|
+
# encryption with server-side encryption using Key Management Service
|
11453
|
+
# (KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
|
11454
|
+
# to use an S3 Bucket Key for object encryption with SSE-KMS.
|
11151
11455
|
#
|
11152
11456
|
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11153
11457
|
# settings for S3 Bucket Key.
|
@@ -11156,9 +11460,11 @@ module Aws::S3
|
|
11156
11460
|
# @!attribute [rw] request_payer
|
11157
11461
|
# Confirms that the requester knows that they will be charged for the
|
11158
11462
|
# request. Bucket owners need not specify this parameter in their
|
11159
|
-
# requests.
|
11160
|
-
# Pays
|
11161
|
-
#
|
11463
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11464
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11465
|
+
# charges to copy the object. For information about downloading
|
11466
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11467
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11162
11468
|
#
|
11163
11469
|
#
|
11164
11470
|
#
|
@@ -11281,9 +11587,11 @@ module Aws::S3
|
|
11281
11587
|
# @!attribute [rw] request_payer
|
11282
11588
|
# Confirms that the requester knows that they will be charged for the
|
11283
11589
|
# request. Bucket owners need not specify this parameter in their
|
11284
|
-
# requests.
|
11285
|
-
# Pays
|
11286
|
-
#
|
11590
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11591
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11592
|
+
# charges to copy the object. For information about downloading
|
11593
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11594
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11287
11595
|
#
|
11288
11596
|
#
|
11289
11597
|
#
|
@@ -11371,14 +11679,14 @@ module Aws::S3
|
|
11371
11679
|
# bucket name. For more information about access point ARNs, see
|
11372
11680
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
11373
11681
|
#
|
11374
|
-
# When
|
11682
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
11375
11683
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11376
11684
|
# takes the form `
|
11377
11685
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
11378
|
-
# When
|
11379
|
-
# Services SDKs, you provide the Outposts
|
11380
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
11381
|
-
# [
|
11686
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
11687
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
11688
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
11689
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
11382
11690
|
#
|
11383
11691
|
#
|
11384
11692
|
#
|
@@ -11432,9 +11740,11 @@ module Aws::S3
|
|
11432
11740
|
# @!attribute [rw] request_payer
|
11433
11741
|
# Confirms that the requester knows that they will be charged for the
|
11434
11742
|
# request. Bucket owners need not specify this parameter in their
|
11435
|
-
# requests.
|
11436
|
-
# Pays
|
11437
|
-
#
|
11743
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
11744
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
11745
|
+
# charges to copy the object. For information about downloading
|
11746
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
11747
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
11438
11748
|
#
|
11439
11749
|
#
|
11440
11750
|
#
|
@@ -11538,12 +11848,12 @@ module Aws::S3
|
|
11538
11848
|
#
|
11539
11849
|
# @!attribute [rw] filter
|
11540
11850
|
# Specifies object key name filtering rules. For information about key
|
11541
|
-
# name filtering, see [Configuring
|
11542
|
-
# *Amazon S3 User Guide*.
|
11851
|
+
# name filtering, see [Configuring event notifications using object
|
11852
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
11543
11853
|
#
|
11544
11854
|
#
|
11545
11855
|
#
|
11546
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11856
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
11547
11857
|
# @return [Types::NotificationConfigurationFilter]
|
11548
11858
|
#
|
11549
11859
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/QueueConfiguration AWS API Documentation
|
@@ -11807,6 +12117,13 @@ module Aws::S3
|
|
11807
12117
|
# @return [Types::SourceSelectionCriteria]
|
11808
12118
|
#
|
11809
12119
|
# @!attribute [rw] existing_object_replication
|
12120
|
+
# Optional configuration to replicate existing source bucket objects.
|
12121
|
+
# For more information, see [Replicating Existing Objects][1] in the
|
12122
|
+
# *Amazon S3 User Guide*.
|
12123
|
+
#
|
12124
|
+
#
|
12125
|
+
#
|
12126
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication
|
11810
12127
|
# @return [Types::ExistingObjectReplication]
|
11811
12128
|
#
|
11812
12129
|
# @!attribute [rw] destination
|
@@ -12032,14 +12349,14 @@ module Aws::S3
|
|
12032
12349
|
# bucket name. For more information about access point ARNs, see
|
12033
12350
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
12034
12351
|
#
|
12035
|
-
# When
|
12352
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
12036
12353
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12037
12354
|
# takes the form `
|
12038
12355
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12039
|
-
# When
|
12040
|
-
# Services SDKs, you provide the Outposts
|
12041
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
12042
|
-
# [
|
12356
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
12357
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
12358
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
12359
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
12043
12360
|
#
|
12044
12361
|
#
|
12045
12362
|
#
|
@@ -12062,9 +12379,11 @@ module Aws::S3
|
|
12062
12379
|
# @!attribute [rw] request_payer
|
12063
12380
|
# Confirms that the requester knows that they will be charged for the
|
12064
12381
|
# request. Bucket owners need not specify this parameter in their
|
12065
|
-
# requests.
|
12066
|
-
# Pays
|
12067
|
-
#
|
12382
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
12383
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
12384
|
+
# charges to copy the object. For information about downloading
|
12385
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
12386
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
12068
12387
|
#
|
12069
12388
|
#
|
12070
12389
|
#
|
@@ -12157,6 +12476,49 @@ module Aws::S3
|
|
12157
12476
|
include Aws::Structure
|
12158
12477
|
end
|
12159
12478
|
|
12479
|
+
# Specifies the restoration status of an object. Objects in certain
|
12480
|
+
# storage classes must be restored before they can be retrieved. For
|
12481
|
+
# more information about these storage classes and how to work with
|
12482
|
+
# archived objects, see [ Working with archived objects][1] in the
|
12483
|
+
# *Amazon S3 User Guide*.
|
12484
|
+
#
|
12485
|
+
#
|
12486
|
+
#
|
12487
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html
|
12488
|
+
#
|
12489
|
+
# @!attribute [rw] is_restore_in_progress
|
12490
|
+
# Specifies whether the object is currently being restored. If the
|
12491
|
+
# object restoration is in progress, the header returns the value
|
12492
|
+
# `TRUE`. For example:
|
12493
|
+
#
|
12494
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="true"`
|
12495
|
+
#
|
12496
|
+
# If the object restoration has completed, the header returns the
|
12497
|
+
# value `FALSE`. For example:
|
12498
|
+
#
|
12499
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12500
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12501
|
+
#
|
12502
|
+
# If the object hasn't been restored, there is no header response.
|
12503
|
+
# @return [Boolean]
|
12504
|
+
#
|
12505
|
+
# @!attribute [rw] restore_expiry_date
|
12506
|
+
# Indicates when the restored copy will expire. This value is
|
12507
|
+
# populated only if the object has already been restored. For example:
|
12508
|
+
#
|
12509
|
+
# `x-amz-optional-object-attributes: IsRestoreInProgress="false",
|
12510
|
+
# RestoreExpiryDate="2012-12-21T00:00:00.000Z"`
|
12511
|
+
# @return [Time]
|
12512
|
+
#
|
12513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation
|
12514
|
+
#
|
12515
|
+
class RestoreStatus < Struct.new(
|
12516
|
+
:is_restore_in_progress,
|
12517
|
+
:restore_expiry_date)
|
12518
|
+
SENSITIVE = []
|
12519
|
+
include Aws::Structure
|
12520
|
+
end
|
12521
|
+
|
12160
12522
|
# Specifies the redirect behavior and when a redirect is applied. For
|
12161
12523
|
# more information about routing rules, see [Configuring advanced
|
12162
12524
|
# conditional redirects][1] in the *Amazon S3 User Guide*.
|
@@ -12261,8 +12623,8 @@ module Aws::S3
|
|
12261
12623
|
# Specifies the days since the initiation of an incomplete multipart
|
12262
12624
|
# upload that Amazon S3 will wait before permanently removing all
|
12263
12625
|
# parts of the upload. For more information, see [ Aborting Incomplete
|
12264
|
-
# Multipart Uploads Using a Bucket Lifecycle
|
12265
|
-
# S3 User Guide*.
|
12626
|
+
# Multipart Uploads Using a Bucket Lifecycle Configuration][1] in the
|
12627
|
+
# *Amazon S3 User Guide*.
|
12266
12628
|
#
|
12267
12629
|
#
|
12268
12630
|
#
|
@@ -12353,9 +12715,9 @@ module Aws::S3
|
|
12353
12715
|
# Specifies the use of SSE-KMS to encrypt delivered inventory reports.
|
12354
12716
|
#
|
12355
12717
|
# @!attribute [rw] key_id
|
12356
|
-
# Specifies the ID of the
|
12357
|
-
#
|
12358
|
-
#
|
12718
|
+
# Specifies the ID of the Key Management Service (KMS) symmetric
|
12719
|
+
# encryption customer managed key to use for encrypting inventory
|
12720
|
+
# reports.
|
12359
12721
|
# @return [String]
|
12360
12722
|
#
|
12361
12723
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation
|
@@ -12593,23 +12955,27 @@ module Aws::S3
|
|
12593
12955
|
# parameter is allowed if and only if `SSEAlgorithm` is set to
|
12594
12956
|
# `aws:kms`.
|
12595
12957
|
#
|
12596
|
-
# You can specify the key ID or the Amazon Resource Name
|
12597
|
-
# KMS key.
|
12598
|
-
# Amazon Web Services service operations you must use a fully
|
12599
|
-
# qualified KMS key ARN. For more information, see [Using encryption
|
12600
|
-
# for cross-account operations][1].
|
12601
|
-
#
|
12602
|
-
# **For example:**
|
12958
|
+
# You can specify the key ID, key alias, or the Amazon Resource Name
|
12959
|
+
# (ARN) of the KMS key.
|
12603
12960
|
#
|
12604
12961
|
# * Key ID: `1234abcd-12ab-34cd-56ef-1234567890ab`
|
12605
12962
|
#
|
12606
12963
|
# * Key ARN:
|
12607
12964
|
# `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`
|
12608
12965
|
#
|
12609
|
-
#
|
12610
|
-
#
|
12611
|
-
#
|
12612
|
-
#
|
12966
|
+
# * Key Alias: `alias/alias-name`
|
12967
|
+
#
|
12968
|
+
# If you use a key ID, you can run into a LogDestination undeliverable
|
12969
|
+
# error when creating a VPC flow log.
|
12970
|
+
#
|
12971
|
+
# If you are using encryption with cross-account or Amazon Web
|
12972
|
+
# Services service operations you must use a fully qualified KMS key
|
12973
|
+
# ARN. For more information, see [Using encryption for cross-account
|
12974
|
+
# operations][1].
|
12975
|
+
#
|
12976
|
+
# Amazon S3 only supports symmetric encryption KMS keys. For more
|
12977
|
+
# information, see [Asymmetric keys in Amazon Web Services KMS][2] in
|
12978
|
+
# the *Amazon Web Services Key Management Service Developer Guide*.
|
12613
12979
|
#
|
12614
12980
|
#
|
12615
12981
|
#
|
@@ -12925,12 +13291,12 @@ module Aws::S3
|
|
12925
13291
|
#
|
12926
13292
|
# @!attribute [rw] filter
|
12927
13293
|
# Specifies object key name filtering rules. For information about key
|
12928
|
-
# name filtering, see [Configuring
|
12929
|
-
# *Amazon S3 User Guide*.
|
13294
|
+
# name filtering, see [Configuring event notifications using object
|
13295
|
+
# key name filtering][1] in the *Amazon S3 User Guide*.
|
12930
13296
|
#
|
12931
13297
|
#
|
12932
13298
|
#
|
12933
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13299
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html
|
12934
13300
|
# @return [Types::NotificationConfigurationFilter]
|
12935
13301
|
#
|
12936
13302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TopicConfiguration AWS API Documentation
|
@@ -13029,7 +13395,7 @@ module Aws::S3
|
|
13029
13395
|
#
|
13030
13396
|
# @!attribute [rw] server_side_encryption
|
13031
13397
|
# The server-side encryption algorithm used when storing this object
|
13032
|
-
# in Amazon S3 (for example, AES256
|
13398
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13033
13399
|
# @return [String]
|
13034
13400
|
#
|
13035
13401
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13046,14 +13412,15 @@ module Aws::S3
|
|
13046
13412
|
# @return [String]
|
13047
13413
|
#
|
13048
13414
|
# @!attribute [rw] ssekms_key_id
|
13049
|
-
# If present, specifies the ID of the
|
13050
|
-
#
|
13051
|
-
#
|
13415
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13416
|
+
# symmetric encryption customer managed key that was used for the
|
13417
|
+
# object.
|
13052
13418
|
# @return [String]
|
13053
13419
|
#
|
13054
13420
|
# @!attribute [rw] bucket_key_enabled
|
13055
13421
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13056
|
-
# server-side encryption with
|
13422
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13423
|
+
# (SSE-KMS).
|
13057
13424
|
# @return [Boolean]
|
13058
13425
|
#
|
13059
13426
|
# @!attribute [rw] request_charged
|
@@ -13088,14 +13455,14 @@ module Aws::S3
|
|
13088
13455
|
# bucket name. For more information about access point ARNs, see
|
13089
13456
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
13090
13457
|
#
|
13091
|
-
# When
|
13458
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
13092
13459
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13093
13460
|
# takes the form `
|
13094
13461
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13095
|
-
# When
|
13096
|
-
# Services SDKs, you provide the Outposts
|
13097
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
13098
|
-
# [
|
13462
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
13463
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
13464
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13465
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13099
13466
|
#
|
13100
13467
|
#
|
13101
13468
|
#
|
@@ -13233,9 +13600,11 @@ module Aws::S3
|
|
13233
13600
|
# @!attribute [rw] request_payer
|
13234
13601
|
# Confirms that the requester knows that they will be charged for the
|
13235
13602
|
# request. Bucket owners need not specify this parameter in their
|
13236
|
-
# requests.
|
13237
|
-
# Pays
|
13238
|
-
#
|
13603
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13604
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13605
|
+
# charges to copy the object. For information about downloading
|
13606
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
13607
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13239
13608
|
#
|
13240
13609
|
#
|
13241
13610
|
#
|
@@ -13282,7 +13651,7 @@ module Aws::S3
|
|
13282
13651
|
|
13283
13652
|
# @!attribute [rw] server_side_encryption
|
13284
13653
|
# The server-side encryption algorithm used when storing this object
|
13285
|
-
# in Amazon S3 (for example, AES256
|
13654
|
+
# in Amazon S3 (for example, `AES256`, `aws:kms`).
|
13286
13655
|
# @return [String]
|
13287
13656
|
#
|
13288
13657
|
# @!attribute [rw] etag
|
@@ -13355,14 +13724,14 @@ module Aws::S3
|
|
13355
13724
|
# @return [String]
|
13356
13725
|
#
|
13357
13726
|
# @!attribute [rw] ssekms_key_id
|
13358
|
-
# If present, specifies the ID of the
|
13359
|
-
#
|
13360
|
-
# managed key was used for the object.
|
13727
|
+
# If present, specifies the ID of the Key Management Service (KMS)
|
13728
|
+
# symmetric encryption customer managed key was used for the object.
|
13361
13729
|
# @return [String]
|
13362
13730
|
#
|
13363
13731
|
# @!attribute [rw] bucket_key_enabled
|
13364
13732
|
# Indicates whether the multipart upload uses an S3 Bucket Key for
|
13365
|
-
# server-side encryption with
|
13733
|
+
# server-side encryption with Key Management Service (KMS) keys
|
13734
|
+
# (SSE-KMS).
|
13366
13735
|
# @return [Boolean]
|
13367
13736
|
#
|
13368
13737
|
# @!attribute [rw] request_charged
|
@@ -13404,14 +13773,14 @@ module Aws::S3
|
|
13404
13773
|
# bucket name. For more information about access point ARNs, see
|
13405
13774
|
# [Using access points][1] in the *Amazon S3 User Guide*.
|
13406
13775
|
#
|
13407
|
-
# When
|
13776
|
+
# When you use this action with Amazon S3 on Outposts, you must direct
|
13408
13777
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13409
13778
|
# takes the form `
|
13410
13779
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
13411
|
-
# When
|
13412
|
-
# Services SDKs, you provide the Outposts
|
13413
|
-
# bucket name. For more information about S3 on Outposts ARNs, see
|
13414
|
-
# [
|
13780
|
+
# When you use this action with S3 on Outposts through the Amazon Web
|
13781
|
+
# Services SDKs, you provide the Outposts access point ARN in place of
|
13782
|
+
# the bucket name. For more information about S3 on Outposts ARNs, see
|
13783
|
+
# [What is S3 on Outposts?][2] in the *Amazon S3 User Guide*.
|
13415
13784
|
#
|
13416
13785
|
#
|
13417
13786
|
#
|
@@ -13536,9 +13905,11 @@ module Aws::S3
|
|
13536
13905
|
# @!attribute [rw] request_payer
|
13537
13906
|
# Confirms that the requester knows that they will be charged for the
|
13538
13907
|
# request. Bucket owners need not specify this parameter in their
|
13539
|
-
# requests.
|
13540
|
-
# Pays
|
13541
|
-
#
|
13908
|
+
# requests. If either the source or destination Amazon S3 bucket has
|
13909
|
+
# Requester Pays enabled, the requester will pay for corresponding
|
13910
|
+
# charges to copy the object. For information about downloading
|
13911
|
+
# objects from Requester Pays buckets, see [Downloading Objects in
|
13912
|
+
# Requester Pays Buckets][1] in the *Amazon S3 User Guide*.
|
13542
13913
|
#
|
13543
13914
|
#
|
13544
13915
|
#
|
@@ -13651,9 +14022,7 @@ module Aws::S3
|
|
13651
14022
|
#
|
13652
14023
|
# @!attribute [rw] status_code
|
13653
14024
|
# The integer status code for an HTTP response of a corresponding
|
13654
|
-
# `GetObject` request.
|
13655
|
-
#
|
13656
|
-
# **Status Codes**
|
14025
|
+
# `GetObject` request. The following is a list of status codes.
|
13657
14026
|
#
|
13658
14027
|
# * `200 - OK`
|
13659
14028
|
#
|
@@ -13895,7 +14264,7 @@ module Aws::S3
|
|
13895
14264
|
#
|
13896
14265
|
# @!attribute [rw] server_side_encryption
|
13897
14266
|
# The server-side encryption algorithm used when storing requested
|
13898
|
-
# object in Amazon S3 (for example, AES256, aws:kms).
|
14267
|
+
# object in Amazon S3 (for example, AES256, `aws:kms`).
|
13899
14268
|
# @return [String]
|
13900
14269
|
#
|
13901
14270
|
# @!attribute [rw] sse_customer_algorithm
|
@@ -13905,9 +14274,10 @@ module Aws::S3
|
|
13905
14274
|
# @return [String]
|
13906
14275
|
#
|
13907
14276
|
# @!attribute [rw] ssekms_key_id
|
13908
|
-
# If present, specifies the ID
|
13909
|
-
# Management Service (Amazon Web Services KMS)
|
13910
|
-
# managed key that was used for stored
|
14277
|
+
# If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the
|
14278
|
+
# Amazon Web Services Key Management Service (Amazon Web Services KMS)
|
14279
|
+
# symmetric encryption customer managed key that was used for stored
|
14280
|
+
# in Amazon S3 object.
|
13911
14281
|
# @return [String]
|
13912
14282
|
#
|
13913
14283
|
# @!attribute [rw] sse_customer_key_md5
|