aws-sdk-s3 1.173.0 → 1.175.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +22 -2
- data/lib/aws-sdk-s3/client.rb +969 -722
- data/lib/aws-sdk-s3/client_api.rb +2 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +36 -0
- data/lib/aws-sdk-s3/multipart_upload.rb +21 -0
- data/lib/aws-sdk-s3/object.rb +23 -1
- data/lib/aws-sdk-s3/object_summary.rb +20 -0
- data/lib/aws-sdk-s3/resource.rb +9 -8
- data/lib/aws-sdk-s3/types.rb +247 -116
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +3 -2
- data/sig/client.rbs +5 -3
- data/sig/multipart_upload.rbs +1 -0
- data/sig/object.rbs +1 -0
- data/sig/object_summary.rbs +1 -0
- data/sig/resource.rbs +2 -2
- data/sig/types.rbs +5 -3
- metadata +2 -2
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -577,20 +577,24 @@ module Aws::S3
|
|
577
577
|
# * **Directory buckets** - For directory buckets, you must make
|
578
578
|
# requests for this API operation to the Zonal endpoint. These
|
579
579
|
# endpoints support virtual-hosted-style requests in the format
|
580
|
-
# `https://
|
581
|
-
# `. Path-style requests are not supported. For more information
|
582
|
-
# [Regional and Zonal endpoints
|
580
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
581
|
+
# `. Path-style requests are not supported. For more information about
|
582
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
583
|
+
# for directory buckets in Availability Zones][2] in the *Amazon S3
|
584
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
585
|
+
# see [Available Local Zone for directory buckets][3] in the *Amazon
|
586
|
+
# S3 User Guide*.
|
583
587
|
#
|
584
588
|
# </note>
|
585
589
|
#
|
586
590
|
# Permissions
|
587
591
|
# : * **General purpose bucket permissions** - For information about
|
588
592
|
# permissions required to use the multipart upload, see [Multipart
|
589
|
-
# Upload and Permissions][
|
593
|
+
# Upload and Permissions][4] in the *Amazon S3 User Guide*.
|
590
594
|
#
|
591
595
|
# * **Directory bucket permissions** - To grant access to this API
|
592
596
|
# operation on a directory bucket, we recommend that you use the [
|
593
|
-
# `CreateSession` ][
|
597
|
+
# `CreateSession` ][5] API operation for session-based
|
594
598
|
# authorization. Specifically, you grant the
|
595
599
|
# `s3express:CreateSession` permission to the directory bucket in a
|
596
600
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -601,45 +605,46 @@ module Aws::S3
|
|
601
605
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
602
606
|
# refresh the session token automatically to avoid service
|
603
607
|
# interruptions when a session expires. For more information about
|
604
|
-
# authorization, see [ `CreateSession` ][
|
608
|
+
# authorization, see [ `CreateSession` ][5].
|
605
609
|
#
|
606
610
|
# HTTP Host header syntax
|
607
611
|
#
|
608
612
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
609
|
-
#
|
613
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
610
614
|
#
|
611
615
|
# The following operations are related to `AbortMultipartUpload`:
|
612
616
|
#
|
613
|
-
# * [CreateMultipartUpload][
|
617
|
+
# * [CreateMultipartUpload][6]
|
614
618
|
#
|
615
|
-
# * [UploadPart][
|
619
|
+
# * [UploadPart][7]
|
616
620
|
#
|
617
|
-
# * [CompleteMultipartUpload][
|
621
|
+
# * [CompleteMultipartUpload][8]
|
618
622
|
#
|
619
623
|
# * [ListParts][1]
|
620
624
|
#
|
621
|
-
# * [ListMultipartUploads][
|
625
|
+
# * [ListMultipartUploads][9]
|
622
626
|
#
|
623
627
|
#
|
624
628
|
#
|
625
629
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
626
630
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
627
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
628
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
629
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
630
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
631
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
632
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
631
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
632
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
633
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
634
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
635
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
636
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
637
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
633
638
|
#
|
634
639
|
# @option params [required, String] :bucket
|
635
640
|
# The bucket name to which the upload was taking place.
|
636
641
|
#
|
637
642
|
# **Directory buckets** - When you use this operation with a directory
|
638
643
|
# bucket, you must use virtual-hosted-style requests in the format `
|
639
|
-
#
|
640
|
-
# are not supported. Directory bucket names must be unique in
|
641
|
-
# Availability Zone. Bucket names must
|
642
|
-
#
|
644
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
645
|
+
# requests are not supported. Directory bucket names must be unique in
|
646
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
647
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
643
648
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
644
649
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
645
650
|
# *Amazon S3 User Guide*.
|
@@ -805,19 +810,23 @@ module Aws::S3
|
|
805
810
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
806
811
|
# for this API operation to the Zonal endpoint. These endpoints support
|
807
812
|
# virtual-hosted-style requests in the format
|
808
|
-
# `https://
|
809
|
-
# Path-style requests are not supported. For more information
|
810
|
-
# [Regional and Zonal endpoints
|
813
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
814
|
+
# `. Path-style requests are not supported. For more information about
|
815
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
816
|
+
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
817
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
818
|
+
# [Available Local Zone for directory buckets][6] in the *Amazon S3 User
|
819
|
+
# Guide*.
|
811
820
|
#
|
812
821
|
# </note>
|
813
822
|
#
|
814
823
|
# Permissions
|
815
824
|
# : * **General purpose bucket permissions** - For information about
|
816
825
|
# permissions required to use the multipart upload API, see
|
817
|
-
# [Multipart Upload and Permissions][
|
826
|
+
# [Multipart Upload and Permissions][7] in the *Amazon S3 User
|
818
827
|
# Guide*.
|
819
828
|
#
|
820
|
-
# If you provide an [additional checksum value][
|
829
|
+
# If you provide an [additional checksum value][8] in your
|
821
830
|
# `MultipartUpload` requests and the object is encrypted with Key
|
822
831
|
# Management Service, you must have permission to use the
|
823
832
|
# `kms:Decrypt` action for the `CompleteMultipartUpload` request to
|
@@ -825,7 +834,7 @@ module Aws::S3
|
|
825
834
|
#
|
826
835
|
# * **Directory bucket permissions** - To grant access to this API
|
827
836
|
# operation on a directory bucket, we recommend that you use the [
|
828
|
-
# `CreateSession` ][
|
837
|
+
# `CreateSession` ][9] API operation for session-based
|
829
838
|
# authorization. Specifically, you grant the
|
830
839
|
# `s3express:CreateSession` permission to the directory bucket in a
|
831
840
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -836,7 +845,7 @@ module Aws::S3
|
|
836
845
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
837
846
|
# refresh the session token automatically to avoid service
|
838
847
|
# interruptions when a session expires. For more information about
|
839
|
-
# authorization, see [ `CreateSession` ][
|
848
|
+
# authorization, see [ `CreateSession` ][9].
|
840
849
|
#
|
841
850
|
# If the object is encrypted with SSE-KMS, you must also have the
|
842
851
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -874,19 +883,19 @@ module Aws::S3
|
|
874
883
|
# HTTP Host header syntax
|
875
884
|
#
|
876
885
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
877
|
-
#
|
886
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
878
887
|
#
|
879
888
|
# The following operations are related to `CompleteMultipartUpload`:
|
880
889
|
#
|
881
|
-
# * [CreateMultipartUpload][
|
890
|
+
# * [CreateMultipartUpload][10]
|
882
891
|
#
|
883
892
|
# * [UploadPart][1]
|
884
893
|
#
|
885
|
-
# * [AbortMultipartUpload][
|
894
|
+
# * [AbortMultipartUpload][11]
|
886
895
|
#
|
887
|
-
# * [ListParts][
|
896
|
+
# * [ListParts][12]
|
888
897
|
#
|
889
|
-
# * [ListMultipartUploads][
|
898
|
+
# * [ListMultipartUploads][13]
|
890
899
|
#
|
891
900
|
#
|
892
901
|
#
|
@@ -895,23 +904,24 @@ module Aws::S3
|
|
895
904
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html
|
896
905
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
897
906
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
898
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
899
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
900
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
901
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
902
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
903
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
904
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
907
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
908
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
909
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html
|
910
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
911
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
912
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
913
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
914
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
905
915
|
#
|
906
916
|
# @option params [required, String] :bucket
|
907
917
|
# Name of the bucket to which the multipart upload was initiated.
|
908
918
|
#
|
909
919
|
# **Directory buckets** - When you use this operation with a directory
|
910
920
|
# bucket, you must use virtual-hosted-style requests in the format `
|
911
|
-
#
|
912
|
-
# are not supported. Directory bucket names must be unique in
|
913
|
-
# Availability Zone. Bucket names must
|
914
|
-
#
|
921
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
922
|
+
# requests are not supported. Directory bucket names must be unique in
|
923
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
924
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
915
925
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
916
926
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
917
927
|
# *Amazon S3 User Guide*.
|
@@ -1022,6 +1032,27 @@ module Aws::S3
|
|
1022
1032
|
# you provide does not match the actual owner of the bucket, the request
|
1023
1033
|
# fails with the HTTP status code `403 Forbidden` (access denied).
|
1024
1034
|
#
|
1035
|
+
# @option params [String] :if_match
|
1036
|
+
# Uploads the object only if the ETag (entity tag) value provided during
|
1037
|
+
# the WRITE operation matches the ETag of the object in S3. If the ETag
|
1038
|
+
# values do not match, the operation returns a `412 Precondition Failed`
|
1039
|
+
# error.
|
1040
|
+
#
|
1041
|
+
# If a conflicting operation occurs during the upload S3 returns a `409
|
1042
|
+
# ConditionalRequestConflict` response. On a 409 failure you should
|
1043
|
+
# fetch the object's ETag, re-initiate the multipart upload with
|
1044
|
+
# `CreateMultipartUpload`, and re-upload each part.
|
1045
|
+
#
|
1046
|
+
# Expects the ETag value as a string.
|
1047
|
+
#
|
1048
|
+
# For more information about conditional requests, see [RFC 7232][1], or
|
1049
|
+
# [Conditional requests][2] in the *Amazon S3 User Guide*.
|
1050
|
+
#
|
1051
|
+
#
|
1052
|
+
#
|
1053
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
1054
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
1055
|
+
#
|
1025
1056
|
# @option params [String] :if_none_match
|
1026
1057
|
# Uploads the object only if the object key name does not already exist
|
1027
1058
|
# in the bucket specified. Otherwise, Amazon S3 returns a `412
|
@@ -1157,6 +1188,7 @@ module Aws::S3
|
|
1157
1188
|
# checksum_sha256: "ChecksumSHA256",
|
1158
1189
|
# request_payer: "requester", # accepts requester
|
1159
1190
|
# expected_bucket_owner: "AccountId",
|
1191
|
+
# if_match: "IfMatch",
|
1160
1192
|
# if_none_match: "IfNoneMatch",
|
1161
1193
|
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
1162
1194
|
# sse_customer_key: "SSECustomerKey",
|
@@ -1210,9 +1242,13 @@ module Aws::S3
|
|
1210
1242
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
1211
1243
|
# requests for this API operation to the Zonal endpoint. These
|
1212
1244
|
# endpoints support virtual-hosted-style requests in the format
|
1213
|
-
# `https://
|
1214
|
-
# `. Path-style requests are not supported. For more information
|
1215
|
-
# [Regional and Zonal endpoints
|
1245
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
1246
|
+
# `. Path-style requests are not supported. For more information about
|
1247
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
1248
|
+
# for directory buckets in Availability Zones][2] in the *Amazon S3
|
1249
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
1250
|
+
# see [Available Local Zone for directory buckets][3] in the *Amazon
|
1251
|
+
# S3 User Guide*.
|
1216
1252
|
#
|
1217
1253
|
# * VPC endpoints don't support cross-Region requests (including
|
1218
1254
|
# copies). If you're using VPC endpoints, your source and destination
|
@@ -1224,13 +1260,13 @@ module Aws::S3
|
|
1224
1260
|
# Both the Region that you want to copy the object from and the Region
|
1225
1261
|
# that you want to copy the object to must be enabled for your account.
|
1226
1262
|
# For more information about how to enable a Region for your account,
|
1227
|
-
# see [Enable or disable a Region for standalone accounts][
|
1263
|
+
# see [Enable or disable a Region for standalone accounts][4] in the
|
1228
1264
|
# *Amazon Web Services Account Management Guide*.
|
1229
1265
|
#
|
1230
1266
|
# Amazon S3 transfer acceleration does not support cross-Region copies.
|
1231
1267
|
# If you request a cross-Region copy using a transfer acceleration
|
1232
1268
|
# endpoint, you get a `400 Bad Request` error. For more information, see
|
1233
|
-
# [Transfer Acceleration][
|
1269
|
+
# [Transfer Acceleration][5].
|
1234
1270
|
#
|
1235
1271
|
# Authentication and authorization
|
1236
1272
|
#
|
@@ -1238,7 +1274,7 @@ module Aws::S3
|
|
1238
1274
|
# IAM credentials (access key ID and secret access key for the IAM
|
1239
1275
|
# identities). All headers with the `x-amz-` prefix, including
|
1240
1276
|
# `x-amz-copy-source`, must be signed. For more information, see [REST
|
1241
|
-
# Authentication][
|
1277
|
+
# Authentication][6].
|
1242
1278
|
#
|
1243
1279
|
# **Directory buckets** - You must use the IAM credentials to
|
1244
1280
|
# authenticate and authorize your access to the `CopyObject` API
|
@@ -1286,9 +1322,9 @@ module Aws::S3
|
|
1286
1322
|
# identity-based policies and KMS key policies for the KMS key.
|
1287
1323
|
#
|
1288
1324
|
# For example policies, see [Example bucket policies for S3 Express
|
1289
|
-
# One Zone][
|
1325
|
+
# One Zone][7] and [Amazon Web Services Identity and Access
|
1290
1326
|
# Management (IAM) identity-based policies for S3 Express One
|
1291
|
-
# Zone][
|
1327
|
+
# Zone][8] in the *Amazon S3 User Guide*.
|
1292
1328
|
#
|
1293
1329
|
# Response and special errors
|
1294
1330
|
#
|
@@ -1311,7 +1347,7 @@ module Aws::S3
|
|
1311
1347
|
# response is embedded in the `200 OK` response. For example, in a
|
1312
1348
|
# cross-region copy, you may encounter throttling and receive a
|
1313
1349
|
# `200 OK` response. For more information, see [Resolve the Error
|
1314
|
-
# 200 response when copying objects to Amazon S3][
|
1350
|
+
# 200 response when copying objects to Amazon S3][9]. The `200 OK`
|
1315
1351
|
# status code means the copy was accepted, but it doesn't mean
|
1316
1352
|
# the copy is complete. Another example is when you disconnect
|
1317
1353
|
# from Amazon S3 before the copy is complete, Amazon S3 might
|
@@ -1335,32 +1371,33 @@ module Aws::S3
|
|
1335
1371
|
# result in a data retrieval charge for the source if the source
|
1336
1372
|
# storage class bills for data retrieval. If the copy source is in a
|
1337
1373
|
# different region, the data transfer is billed to the copy source
|
1338
|
-
# account. For pricing information, see [Amazon S3 pricing][
|
1374
|
+
# account. For pricing information, see [Amazon S3 pricing][10].
|
1339
1375
|
#
|
1340
1376
|
# HTTP Host header syntax
|
1341
1377
|
#
|
1342
1378
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
1343
|
-
#
|
1379
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
1344
1380
|
#
|
1345
1381
|
# The following operations are related to `CopyObject`:
|
1346
1382
|
#
|
1347
|
-
# * [PutObject][
|
1383
|
+
# * [PutObject][11]
|
1348
1384
|
#
|
1349
|
-
# * [GetObject][
|
1385
|
+
# * [GetObject][12]
|
1350
1386
|
#
|
1351
1387
|
#
|
1352
1388
|
#
|
1353
1389
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
|
1354
1390
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
1355
|
-
# [3]: https://docs.aws.amazon.com/
|
1356
|
-
# [4]: https://docs.aws.amazon.com/
|
1357
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1358
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1359
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-
|
1360
|
-
# [8]: https://
|
1361
|
-
# [9]:
|
1362
|
-
# [10]:
|
1363
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1391
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
1392
|
+
# [4]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone
|
1393
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
1394
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
1395
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
1396
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html
|
1397
|
+
# [9]: https://repost.aws/knowledge-center/s3-resolve-200-internalerror
|
1398
|
+
# [10]: http://aws.amazon.com/s3/pricing/
|
1399
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
1400
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
1364
1401
|
#
|
1365
1402
|
# @option params [String] :acl
|
1366
1403
|
# The canned access control list (ACL) to apply to the object.
|
@@ -1400,14 +1437,22 @@ module Aws::S3
|
|
1400
1437
|
#
|
1401
1438
|
# **Directory buckets** - When you use this operation with a directory
|
1402
1439
|
# bucket, you must use virtual-hosted-style requests in the format `
|
1403
|
-
#
|
1404
|
-
# are not supported. Directory bucket names must be unique in
|
1405
|
-
# Availability Zone. Bucket names must
|
1406
|
-
#
|
1440
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
1441
|
+
# requests are not supported. Directory bucket names must be unique in
|
1442
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
1443
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
1407
1444
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
1408
1445
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
1409
1446
|
# *Amazon S3 User Guide*.
|
1410
1447
|
#
|
1448
|
+
# <note markdown="1"> Copying objects across different Amazon Web Services Regions isn't
|
1449
|
+
# supported when the source or destination bucket is in Amazon Web
|
1450
|
+
# Services Local Zones. The source and destination buckets must have the
|
1451
|
+
# same parent Amazon Web Services Region. Otherwise, you get an HTTP
|
1452
|
+
# `400 Bad Request` error with the error code `InvalidRequest`.
|
1453
|
+
#
|
1454
|
+
# </note>
|
1455
|
+
#
|
1411
1456
|
# **Access points** - When you use this action with an access point, you
|
1412
1457
|
# must provide the alias of the access point in place of the bucket name
|
1413
1458
|
# or specify the access point ARN. When using the access point ARN, you
|
@@ -2260,10 +2305,13 @@ module Aws::S3
|
|
2260
2305
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
2261
2306
|
# requests for this API operation to the Regional endpoint. These
|
2262
2307
|
# endpoints support path-style requests in the format
|
2263
|
-
# `https://s3express-control.
|
2308
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
2264
2309
|
# Virtual-hosted-style requests aren't supported. For more
|
2265
|
-
# information, see [Regional and
|
2266
|
-
#
|
2310
|
+
# information about endpoints in Availability Zones, see [Regional and
|
2311
|
+
# Zonal endpoints for directory buckets in Availability Zones][4] in
|
2312
|
+
# the *Amazon S3 User Guide*. For more information about endpoints in
|
2313
|
+
# Local Zones, see [Available Local Zone for directory buckets][5] in
|
2314
|
+
# the *Amazon S3 User Guide*.
|
2267
2315
|
#
|
2268
2316
|
# </note>
|
2269
2317
|
#
|
@@ -2305,17 +2353,17 @@ module Aws::S3
|
|
2305
2353
|
# disabled. If you would like to share data with users outside of
|
2306
2354
|
# your account, you can use bucket policies as needed. For more
|
2307
2355
|
# information, see [Controlling ownership of objects and disabling
|
2308
|
-
# ACLs for your bucket ][
|
2309
|
-
# Amazon S3 storage ][
|
2356
|
+
# ACLs for your bucket ][6] and [Blocking public access to your
|
2357
|
+
# Amazon S3 storage ][7] in the *Amazon S3 User Guide*.
|
2310
2358
|
#
|
2311
2359
|
# * **S3 Block Public Access** - If your specific use case requires
|
2312
2360
|
# granting public access to your S3 resources, you can disable
|
2313
2361
|
# Block Public Access. Specifically, you can create a new bucket
|
2314
2362
|
# with Block Public Access enabled, then separately call the [
|
2315
|
-
# `DeletePublicAccessBlock` ][
|
2363
|
+
# `DeletePublicAccessBlock` ][8] API. To use this operation, you
|
2316
2364
|
# must have the `s3:PutBucketPublicAccessBlock` permission. For
|
2317
2365
|
# more information about S3 Block Public Access, see [Blocking
|
2318
|
-
# public access to your Amazon S3 storage ][
|
2366
|
+
# public access to your Amazon S3 storage ][7] in the *Amazon S3
|
2319
2367
|
# User Guide*.
|
2320
2368
|
# * **Directory bucket permissions** - You must have the
|
2321
2369
|
# `s3express:CreateBucket` permission in an IAM identity-based
|
@@ -2324,7 +2372,7 @@ module Aws::S3
|
|
2324
2372
|
# performed by the Amazon Web Services account that owns the
|
2325
2373
|
# resource. For more information about directory bucket policies and
|
2326
2374
|
# permissions, see [Amazon Web Services Identity and Access
|
2327
|
-
# Management (IAM) for S3 Express One Zone][
|
2375
|
+
# Management (IAM) for S3 Express One Zone][9] in the *Amazon S3
|
2328
2376
|
# User Guide*.
|
2329
2377
|
#
|
2330
2378
|
# The permissions for ACLs, Object Lock, S3 Object Ownership, and S3
|
@@ -2334,21 +2382,21 @@ module Aws::S3
|
|
2334
2382
|
# enforced (ACLs disabled). These settings can't be modified.
|
2335
2383
|
#
|
2336
2384
|
# For more information about permissions for creating and working
|
2337
|
-
# with directory buckets, see [Directory buckets][
|
2385
|
+
# with directory buckets, see [Directory buckets][10] in the *Amazon
|
2338
2386
|
# S3 User Guide*. For more information about supported S3 features
|
2339
|
-
# for directory buckets, see [Features of S3 Express One Zone][
|
2387
|
+
# for directory buckets, see [Features of S3 Express One Zone][11]
|
2340
2388
|
# in the *Amazon S3 User Guide*.
|
2341
2389
|
#
|
2342
2390
|
# HTTP Host header syntax
|
2343
2391
|
#
|
2344
2392
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
2345
|
-
# `s3express-control.region.amazonaws.com`.
|
2393
|
+
# `s3express-control.region-code.amazonaws.com`.
|
2346
2394
|
#
|
2347
2395
|
# The following operations are related to `CreateBucket`:
|
2348
2396
|
#
|
2349
|
-
# * [PutObject][
|
2397
|
+
# * [PutObject][12]
|
2350
2398
|
#
|
2351
|
-
# * [DeleteBucket][
|
2399
|
+
# * [DeleteBucket][13]
|
2352
2400
|
#
|
2353
2401
|
#
|
2354
2402
|
#
|
@@ -2356,14 +2404,15 @@ module Aws::S3
|
|
2356
2404
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html
|
2357
2405
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
2358
2406
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
2359
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2360
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2361
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2362
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2363
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2364
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2365
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2366
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2407
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
2408
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
2409
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html
|
2410
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html
|
2411
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
2412
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html
|
2413
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features
|
2414
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
2415
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
2367
2416
|
#
|
2368
2417
|
# @option params [String] :acl
|
2369
2418
|
# The canned ACL to apply to the bucket.
|
@@ -2381,13 +2430,14 @@ module Aws::S3
|
|
2381
2430
|
#
|
2382
2431
|
# <b>Directory buckets </b> - When you use this operation with a
|
2383
2432
|
# directory bucket, you must use path-style requests in the format
|
2384
|
-
# `https://s3express-control.
|
2433
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
2385
2434
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
2386
|
-
# names must be unique in the chosen Availability Zone
|
2387
|
-
# must also follow the format `
|
2388
|
-
#
|
2389
|
-
#
|
2390
|
-
#
|
2435
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
2436
|
+
# Zone). Bucket names must also follow the format `
|
2437
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
2438
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
2439
|
+
# naming restrictions, see [Directory bucket naming rules][2] in the
|
2440
|
+
# *Amazon S3 User Guide*
|
2391
2441
|
#
|
2392
2442
|
#
|
2393
2443
|
#
|
@@ -2484,33 +2534,33 @@ module Aws::S3
|
|
2484
2534
|
# * {Types::CreateBucketOutput#location #location} => String
|
2485
2535
|
#
|
2486
2536
|
#
|
2487
|
-
# @example Example: To create a bucket
|
2537
|
+
# @example Example: To create a bucket in a specific region
|
2488
2538
|
#
|
2489
|
-
# # The following example creates a bucket.
|
2539
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
2490
2540
|
#
|
2491
2541
|
# resp = client.create_bucket({
|
2492
2542
|
# bucket: "examplebucket",
|
2543
|
+
# create_bucket_configuration: {
|
2544
|
+
# location_constraint: "eu-west-1",
|
2545
|
+
# },
|
2493
2546
|
# })
|
2494
2547
|
#
|
2495
2548
|
# resp.to_h outputs the following:
|
2496
2549
|
# {
|
2497
|
-
# location: "/
|
2550
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
2498
2551
|
# }
|
2499
2552
|
#
|
2500
|
-
# @example Example: To create a bucket
|
2553
|
+
# @example Example: To create a bucket
|
2501
2554
|
#
|
2502
|
-
# # The following example creates a bucket.
|
2555
|
+
# # The following example creates a bucket.
|
2503
2556
|
#
|
2504
2557
|
# resp = client.create_bucket({
|
2505
2558
|
# bucket: "examplebucket",
|
2506
|
-
# create_bucket_configuration: {
|
2507
|
-
# location_constraint: "eu-west-1",
|
2508
|
-
# },
|
2509
2559
|
# })
|
2510
2560
|
#
|
2511
2561
|
# resp.to_h outputs the following:
|
2512
2562
|
# {
|
2513
|
-
# location: "
|
2563
|
+
# location: "/examplebucket",
|
2514
2564
|
# }
|
2515
2565
|
#
|
2516
2566
|
# @example Request syntax with placeholder values
|
@@ -2521,11 +2571,11 @@ module Aws::S3
|
|
2521
2571
|
# create_bucket_configuration: {
|
2522
2572
|
# location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
|
2523
2573
|
# location: {
|
2524
|
-
# type: "AvailabilityZone", # accepts AvailabilityZone
|
2574
|
+
# type: "AvailabilityZone", # accepts AvailabilityZone, LocalZone
|
2525
2575
|
# name: "LocationNameAsString",
|
2526
2576
|
# },
|
2527
2577
|
# bucket: {
|
2528
|
-
# data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone
|
2578
|
+
# data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone, SingleLocalZone
|
2529
2579
|
# type: "Directory", # accepts Directory
|
2530
2580
|
# },
|
2531
2581
|
# },
|
@@ -2582,9 +2632,13 @@ module Aws::S3
|
|
2582
2632
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
2583
2633
|
# requests for this API operation to the Zonal endpoint. These
|
2584
2634
|
# endpoints support virtual-hosted-style requests in the format
|
2585
|
-
# `https://
|
2586
|
-
# `. Path-style requests are not supported. For more information
|
2587
|
-
# [Regional and Zonal endpoints
|
2635
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
2636
|
+
# `. Path-style requests are not supported. For more information about
|
2637
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
2638
|
+
# for directory buckets in Availability Zones][4] in the *Amazon S3
|
2639
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
2640
|
+
# see [Available Local Zone for directory buckets][5] in the *Amazon
|
2641
|
+
# S3 User Guide*.
|
2588
2642
|
#
|
2589
2643
|
# </note>
|
2590
2644
|
#
|
@@ -2596,7 +2650,7 @@ module Aws::S3
|
|
2596
2650
|
# sign each request individually. There is nothing special about
|
2597
2651
|
# signing multipart upload requests. For more information about
|
2598
2652
|
# signing, see [Authenticating Requests (Amazon Web Services Signature
|
2599
|
-
# Version 4)][
|
2653
|
+
# Version 4)][6] in the *Amazon S3 User Guide*.
|
2600
2654
|
#
|
2601
2655
|
# Permissions
|
2602
2656
|
# : * **General purpose bucket permissions** - To perform a multipart
|
@@ -2609,13 +2663,13 @@ module Aws::S3
|
|
2609
2663
|
# `UploadPartCopy` APIs. These permissions are required because
|
2610
2664
|
# Amazon S3 must decrypt and read data from the encrypted file parts
|
2611
2665
|
# before it completes the multipart upload. For more information,
|
2612
|
-
# see [Multipart upload API and permissions][
|
2613
|
-
# using server-side encryption with Amazon Web Services KMS][
|
2666
|
+
# see [Multipart upload API and permissions][7] and [Protecting data
|
2667
|
+
# using server-side encryption with Amazon Web Services KMS][8] in
|
2614
2668
|
# the *Amazon S3 User Guide*.
|
2615
2669
|
#
|
2616
2670
|
# * **Directory bucket permissions** - To grant access to this API
|
2617
2671
|
# operation on a directory bucket, we recommend that you use the [
|
2618
|
-
# `CreateSession` ][
|
2672
|
+
# `CreateSession` ][9] API operation for session-based
|
2619
2673
|
# authorization. Specifically, you grant the
|
2620
2674
|
# `s3express:CreateSession` permission to the directory bucket in a
|
2621
2675
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -2626,7 +2680,7 @@ module Aws::S3
|
|
2626
2680
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
2627
2681
|
# refresh the session token automatically to avoid service
|
2628
2682
|
# interruptions when a session expires. For more information about
|
2629
|
-
# authorization, see [ `CreateSession` ][
|
2683
|
+
# authorization, see [ `CreateSession` ][9].
|
2630
2684
|
#
|
2631
2685
|
# Encryption
|
2632
2686
|
# : * **General purpose buckets** - Server-side encryption is for data
|
@@ -2653,7 +2707,7 @@ module Aws::S3
|
|
2653
2707
|
# the destination bucket, the encryption setting in your request
|
2654
2708
|
# takes precedence. If you choose to provide your own encryption
|
2655
2709
|
# key, the request headers you provide in [UploadPart][1] and
|
2656
|
-
# [UploadPartCopy][
|
2710
|
+
# [UploadPartCopy][10] requests must match the headers you used in
|
2657
2711
|
# the `CreateMultipartUpload` request.
|
2658
2712
|
#
|
2659
2713
|
# * Use KMS keys (SSE-KMS) that include the Amazon Web Services
|
@@ -2678,9 +2732,9 @@ module Aws::S3
|
|
2678
2732
|
# actions on the key. These permissions are required because
|
2679
2733
|
# Amazon S3 must decrypt and read data from the encrypted file
|
2680
2734
|
# parts before it completes the multipart upload. For more
|
2681
|
-
# information, see [Multipart upload API and permissions][
|
2735
|
+
# information, see [Multipart upload API and permissions][7] and
|
2682
2736
|
# [Protecting data using server-side encryption with Amazon Web
|
2683
|
-
# Services KMS][
|
2737
|
+
# Services KMS][8] in the *Amazon S3 User Guide*.
|
2684
2738
|
#
|
2685
2739
|
# * If your Identity and Access Management (IAM) user or role is
|
2686
2740
|
# in the same Amazon Web Services account as the KMS key, then
|
@@ -2695,13 +2749,13 @@ module Aws::S3
|
|
2695
2749
|
# For information about configuring any of the officially
|
2696
2750
|
# supported Amazon Web Services SDKs and Amazon Web Services
|
2697
2751
|
# CLI, see [Specifying the Signature Version in Request
|
2698
|
-
# Authentication][
|
2752
|
+
# Authentication][11] in the *Amazon S3 User Guide*.
|
2699
2753
|
#
|
2700
2754
|
# </note>
|
2701
2755
|
#
|
2702
2756
|
# For more information about server-side encryption with KMS keys
|
2703
2757
|
# (SSE-KMS), see [Protecting Data Using Server-Side Encryption
|
2704
|
-
# with KMS keys][
|
2758
|
+
# with KMS keys][8] in the *Amazon S3 User Guide*.
|
2705
2759
|
#
|
2706
2760
|
# * Use customer-provided encryption keys (SSE-C) – If you want to
|
2707
2761
|
# manage your own encryption keys, provide all the following
|
@@ -2715,7 +2769,7 @@ module Aws::S3
|
|
2715
2769
|
# For more information about server-side encryption with
|
2716
2770
|
# customer-provided encryption keys (SSE-C), see [ Protecting data
|
2717
2771
|
# using server-side encryption with customer-provided encryption
|
2718
|
-
# keys (SSE-C)][
|
2772
|
+
# keys (SSE-C)][12] in the *Amazon S3 User Guide*.
|
2719
2773
|
# * **Directory buckets** - For directory buckets, there are only two
|
2720
2774
|
# supported options for server-side encryption: server-side
|
2721
2775
|
# encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and
|
@@ -2725,13 +2779,13 @@ module Aws::S3
|
|
2725
2779
|
# default encryption in your `CreateSession` requests or `PUT`
|
2726
2780
|
# object requests. Then, new objects are automatically encrypted
|
2727
2781
|
# with the desired encryption settings. For more information, see
|
2728
|
-
# [Protecting data with server-side encryption][
|
2782
|
+
# [Protecting data with server-side encryption][13] in the *Amazon
|
2729
2783
|
# S3 User Guide*. For more information about the encryption
|
2730
2784
|
# overriding behaviors in directory buckets, see [Specifying
|
2731
|
-
# server-side encryption with KMS for new object uploads][
|
2785
|
+
# server-side encryption with KMS for new object uploads][14].
|
2732
2786
|
#
|
2733
|
-
# In the Zonal endpoint API calls (except [CopyObject][
|
2734
|
-
# [UploadPartCopy][
|
2787
|
+
# In the Zonal endpoint API calls (except [CopyObject][15] and
|
2788
|
+
# [UploadPartCopy][10]) using the REST API, the encryption request
|
2735
2789
|
# headers must match the encryption settings that are specified in
|
2736
2790
|
# the `CreateSession` request. You can't override the values of the
|
2737
2791
|
# encryption settings (`x-amz-server-side-encryption`,
|
@@ -2751,7 +2805,7 @@ module Aws::S3
|
|
2751
2805
|
# configuration for the `CreateSession` request. It's not supported
|
2752
2806
|
# to override the encryption settings values in the `CreateSession`
|
2753
2807
|
# request. So in the Zonal endpoint API calls (except
|
2754
|
-
# [CopyObject][
|
2808
|
+
# [CopyObject][15] and [UploadPartCopy][10]), the encryption request
|
2755
2809
|
# headers must match the default encryption configuration of the
|
2756
2810
|
# directory bucket.
|
2757
2811
|
#
|
@@ -2767,19 +2821,19 @@ module Aws::S3
|
|
2767
2821
|
# HTTP Host header syntax
|
2768
2822
|
#
|
2769
2823
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
2770
|
-
#
|
2824
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
2771
2825
|
#
|
2772
2826
|
# The following operations are related to `CreateMultipartUpload`:
|
2773
2827
|
#
|
2774
2828
|
# * [UploadPart][1]
|
2775
2829
|
#
|
2776
|
-
# * [CompleteMultipartUpload][
|
2830
|
+
# * [CompleteMultipartUpload][16]
|
2777
2831
|
#
|
2778
|
-
# * [AbortMultipartUpload][
|
2832
|
+
# * [AbortMultipartUpload][17]
|
2779
2833
|
#
|
2780
|
-
# * [ListParts][
|
2834
|
+
# * [ListParts][18]
|
2781
2835
|
#
|
2782
|
-
# * [ListMultipartUploads][
|
2836
|
+
# * [ListMultipartUploads][19]
|
2783
2837
|
#
|
2784
2838
|
#
|
2785
2839
|
#
|
@@ -2787,20 +2841,21 @@ module Aws::S3
|
|
2787
2841
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
2788
2842
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config
|
2789
2843
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
2790
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2791
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2792
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2793
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2794
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2795
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2796
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2797
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2798
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-
|
2799
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2800
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2801
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2802
|
-
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2803
|
-
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2844
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
2845
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
2846
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
2847
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
|
2848
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
2849
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
2850
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
2851
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
2852
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
2853
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html
|
2854
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
2855
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
2856
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
2857
|
+
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
2858
|
+
# [19]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
2804
2859
|
#
|
2805
2860
|
# @option params [String] :acl
|
2806
2861
|
# The canned ACL to apply to the object. Amazon S3 supports a set of
|
@@ -2833,10 +2888,10 @@ module Aws::S3
|
|
2833
2888
|
#
|
2834
2889
|
# **Directory buckets** - When you use this operation with a directory
|
2835
2890
|
# bucket, you must use virtual-hosted-style requests in the format `
|
2836
|
-
#
|
2837
|
-
# are not supported. Directory bucket names must be unique in
|
2838
|
-
# Availability Zone. Bucket names must
|
2839
|
-
#
|
2891
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
2892
|
+
# requests are not supported. Directory bucket names must be unique in
|
2893
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
2894
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
2840
2895
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
2841
2896
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
2842
2897
|
# *Amazon S3 User Guide*.
|
@@ -3533,23 +3588,27 @@ module Aws::S3
|
|
3533
3588
|
#
|
3534
3589
|
# <note markdown="1"> * You must make requests for this API operation to the Zonal endpoint.
|
3535
3590
|
# These endpoints support virtual-hosted-style requests in the format
|
3536
|
-
# `https://
|
3537
|
-
# Path-style requests are not supported. For more information
|
3538
|
-
# [Regional and Zonal endpoints
|
3591
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
3592
|
+
# Path-style requests are not supported. For more information about
|
3593
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
3594
|
+
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
3595
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
3596
|
+
# see [Available Local Zone for directory buckets][4] in the *Amazon
|
3597
|
+
# S3 User Guide*.
|
3539
3598
|
#
|
3540
3599
|
# * <b> <code>CopyObject</code> API operation</b> - Unlike other Zonal
|
3541
3600
|
# endpoint API operations, the `CopyObject` API operation doesn't use
|
3542
3601
|
# the temporary security credentials returned from the `CreateSession`
|
3543
3602
|
# API operation for authentication and authorization. For information
|
3544
3603
|
# about authentication and authorization of the `CopyObject` API
|
3545
|
-
# operation on directory buckets, see [CopyObject][
|
3604
|
+
# operation on directory buckets, see [CopyObject][5].
|
3546
3605
|
#
|
3547
3606
|
# * <b> <code>HeadBucket</code> API operation</b> - Unlike other Zonal
|
3548
3607
|
# endpoint API operations, the `HeadBucket` API operation doesn't use
|
3549
3608
|
# the temporary security credentials returned from the `CreateSession`
|
3550
3609
|
# API operation for authentication and authorization. For information
|
3551
3610
|
# about authentication and authorization of the `HeadBucket` API
|
3552
|
-
# operation on directory buckets, see [HeadBucket][
|
3611
|
+
# operation on directory buckets, see [HeadBucket][6].
|
3553
3612
|
#
|
3554
3613
|
# </note>
|
3555
3614
|
#
|
@@ -3561,10 +3620,10 @@ module Aws::S3
|
|
3561
3620
|
# can have the `s3express:SessionMode` condition key to control who
|
3562
3621
|
# can create a `ReadWrite` or `ReadOnly` session. For more information
|
3563
3622
|
# about `ReadWrite` or `ReadOnly` sessions, see [
|
3564
|
-
# `x-amz-create-session-mode` ][
|
3565
|
-
# bucket policies for S3 Express One Zone][
|
3623
|
+
# `x-amz-create-session-mode` ][7]. For example policies, see [Example
|
3624
|
+
# bucket policies for S3 Express One Zone][8] and [Amazon Web Services
|
3566
3625
|
# Identity and Access Management (IAM) identity-based policies for S3
|
3567
|
-
# Express One Zone][
|
3626
|
+
# Express One Zone][9] in the *Amazon S3 User Guide*.
|
3568
3627
|
#
|
3569
3628
|
# To grant cross-account access to Zonal endpoint API operations, the
|
3570
3629
|
# bucket policy should also grant both accounts the
|
@@ -3585,32 +3644,32 @@ module Aws::S3
|
|
3585
3644
|
# requests or `PUT` object requests. Then, new objects are
|
3586
3645
|
# automatically encrypted with the desired encryption settings. For
|
3587
3646
|
# more information, see [Protecting data with server-side
|
3588
|
-
# encryption][
|
3647
|
+
# encryption][10] in the *Amazon S3 User Guide*. For more information
|
3589
3648
|
# about the encryption overriding behaviors in directory buckets, see
|
3590
3649
|
# [Specifying server-side encryption with KMS for new object
|
3591
|
-
# uploads][
|
3650
|
+
# uploads][11].
|
3592
3651
|
#
|
3593
|
-
# For [Zonal endpoint (object-level) API operations][
|
3594
|
-
# [CopyObject][
|
3595
|
-
# authorize requests through [CreateSession][
|
3652
|
+
# For [Zonal endpoint (object-level) API operations][12] except
|
3653
|
+
# [CopyObject][5] and [UploadPartCopy][13], you authenticate and
|
3654
|
+
# authorize requests through [CreateSession][14] for low latency. To
|
3596
3655
|
# encrypt new objects in a directory bucket with SSE-KMS, you must
|
3597
3656
|
# specify SSE-KMS as the directory bucket's default encryption
|
3598
3657
|
# configuration with a KMS key (specifically, a [customer managed
|
3599
|
-
# key][
|
3658
|
+
# key][15]). Then, when a session is created for Zonal endpoint API
|
3600
3659
|
# operations, new objects are automatically encrypted and decrypted
|
3601
3660
|
# with SSE-KMS and S3 Bucket Keys during the session.
|
3602
3661
|
#
|
3603
|
-
# <note markdown="1"> Only 1 [customer managed key][
|
3662
|
+
# <note markdown="1"> Only 1 [customer managed key][15] is supported per directory bucket
|
3604
3663
|
# for the lifetime of the bucket. The [Amazon Web Services managed
|
3605
|
-
# key][
|
3664
|
+
# key][16] (`aws/s3`) isn't supported. After you specify SSE-KMS as
|
3606
3665
|
# your bucket's default encryption configuration with a customer
|
3607
3666
|
# managed key, you can't change the customer managed key for the
|
3608
3667
|
# bucket's SSE-KMS configuration.
|
3609
3668
|
#
|
3610
3669
|
# </note>
|
3611
3670
|
#
|
3612
|
-
# In the Zonal endpoint API calls (except [CopyObject][
|
3613
|
-
# [UploadPartCopy][
|
3671
|
+
# In the Zonal endpoint API calls (except [CopyObject][5] and
|
3672
|
+
# [UploadPartCopy][13]) using the REST API, you can't override the
|
3614
3673
|
# values of the encryption settings (`x-amz-server-side-encryption`,
|
3615
3674
|
# `x-amz-server-side-encryption-aws-kms-key-id`,
|
3616
3675
|
# `x-amz-server-side-encryption-context`, and
|
@@ -3626,8 +3685,8 @@ module Aws::S3
|
|
3626
3685
|
# Web Services SDKs use the bucket's default encryption configuration
|
3627
3686
|
# for the `CreateSession` request. It's not supported to override the
|
3628
3687
|
# encryption settings values in the `CreateSession` request. Also, in
|
3629
|
-
# the Zonal endpoint API calls (except [CopyObject][
|
3630
|
-
# [UploadPartCopy][
|
3688
|
+
# the Zonal endpoint API calls (except [CopyObject][5] and
|
3689
|
+
# [UploadPartCopy][13]), it's not supported to override the values of
|
3631
3690
|
# the encryption settings from the `CreateSession` request.
|
3632
3691
|
#
|
3633
3692
|
# </note>
|
@@ -3635,25 +3694,26 @@ module Aws::S3
|
|
3635
3694
|
# HTTP Host header syntax
|
3636
3695
|
#
|
3637
3696
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
3638
|
-
#
|
3697
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
3639
3698
|
#
|
3640
3699
|
#
|
3641
3700
|
#
|
3642
3701
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html
|
3643
3702
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication
|
3644
3703
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
3645
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3646
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
3647
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
3648
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3649
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-
|
3650
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-
|
3651
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-
|
3652
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-
|
3653
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3654
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
3655
|
-
# [14]: https://docs.aws.amazon.com/
|
3656
|
-
# [15]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#
|
3704
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
3705
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
3706
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html
|
3707
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters
|
3708
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
3709
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html
|
3710
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
3711
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html
|
3712
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-differences.html#s3-express-differences-api-operations
|
3713
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
3714
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
3715
|
+
# [15]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
3716
|
+
# [16]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
3657
3717
|
#
|
3658
3718
|
# @option params [String] :session_mode
|
3659
3719
|
# Specifies the mode of the session that will be created, either
|
@@ -3795,10 +3855,13 @@ module Aws::S3
|
|
3795
3855
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
3796
3856
|
# requests for this API operation to the Regional endpoint. These
|
3797
3857
|
# endpoints support path-style requests in the format
|
3798
|
-
# `https://s3express-control.
|
3858
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
3799
3859
|
# Virtual-hosted-style requests aren't supported. For more
|
3800
|
-
# information, see [Regional and
|
3801
|
-
#
|
3860
|
+
# information about endpoints in Availability Zones, see [Regional and
|
3861
|
+
# Zonal endpoints for directory buckets in Availability Zones][1] in
|
3862
|
+
# the *Amazon S3 User Guide*. For more information about endpoints in
|
3863
|
+
# Local Zones, see [Available Local Zone for directory buckets][2] in
|
3864
|
+
# the *Amazon S3 User Guide*.
|
3802
3865
|
#
|
3803
3866
|
# </note>
|
3804
3867
|
#
|
@@ -3813,39 +3876,41 @@ module Aws::S3
|
|
3813
3876
|
# performed by the Amazon Web Services account that owns the
|
3814
3877
|
# resource. For more information about directory bucket policies and
|
3815
3878
|
# permissions, see [Amazon Web Services Identity and Access
|
3816
|
-
# Management (IAM) for S3 Express One Zone][
|
3879
|
+
# Management (IAM) for S3 Express One Zone][3] in the *Amazon S3
|
3817
3880
|
# User Guide*.
|
3818
3881
|
#
|
3819
3882
|
# HTTP Host header syntax
|
3820
3883
|
#
|
3821
3884
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
3822
|
-
# `s3express-control.region.amazonaws.com`.
|
3885
|
+
# `s3express-control.region-code.amazonaws.com`.
|
3823
3886
|
#
|
3824
3887
|
# The following operations are related to `DeleteBucket`:
|
3825
3888
|
#
|
3826
|
-
# * [CreateBucket][
|
3889
|
+
# * [CreateBucket][4]
|
3827
3890
|
#
|
3828
|
-
# * [DeleteObject][
|
3891
|
+
# * [DeleteObject][5]
|
3829
3892
|
#
|
3830
3893
|
#
|
3831
3894
|
#
|
3832
3895
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
3833
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
3834
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3835
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
3896
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
3897
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
3898
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
3899
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
3836
3900
|
#
|
3837
3901
|
# @option params [required, String] :bucket
|
3838
3902
|
# Specifies the bucket being deleted.
|
3839
3903
|
#
|
3840
3904
|
# <b>Directory buckets </b> - When you use this operation with a
|
3841
3905
|
# directory bucket, you must use path-style requests in the format
|
3842
|
-
# `https://s3express-control.
|
3906
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
3843
3907
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
3844
|
-
# names must be unique in the chosen Availability Zone
|
3845
|
-
# must also follow the format `
|
3846
|
-
#
|
3847
|
-
#
|
3848
|
-
#
|
3908
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
3909
|
+
# Zone). Bucket names must also follow the format `
|
3910
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
3911
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
3912
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
3913
|
+
# *Amazon S3 User Guide*
|
3849
3914
|
#
|
3850
3915
|
#
|
3851
3916
|
#
|
@@ -4054,7 +4119,7 @@ module Aws::S3
|
|
4054
4119
|
# HTTP Host header syntax
|
4055
4120
|
#
|
4056
4121
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
4057
|
-
# `s3express-control.region.amazonaws.com`.
|
4122
|
+
# `s3express-control.region-code.amazonaws.com`.
|
4058
4123
|
#
|
4059
4124
|
# The following operations are related to `DeleteBucketEncryption`:
|
4060
4125
|
#
|
@@ -4078,13 +4143,14 @@ module Aws::S3
|
|
4078
4143
|
#
|
4079
4144
|
# <b>Directory buckets </b> - When you use this operation with a
|
4080
4145
|
# directory bucket, you must use path-style requests in the format
|
4081
|
-
# `https://s3express-control.
|
4146
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
4082
4147
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
4083
|
-
# names must be unique in the chosen Availability Zone
|
4084
|
-
# must also follow the format `
|
4085
|
-
#
|
4086
|
-
#
|
4087
|
-
#
|
4148
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
4149
|
+
# Zone). Bucket names must also follow the format `
|
4150
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
4151
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
4152
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
4153
|
+
# *Amazon S3 User Guide*
|
4088
4154
|
#
|
4089
4155
|
#
|
4090
4156
|
#
|
@@ -4286,10 +4352,13 @@ module Aws::S3
|
|
4286
4352
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
4287
4353
|
# requests for this API operation to the Regional endpoint. These
|
4288
4354
|
# endpoints support path-style requests in the format
|
4289
|
-
# `https://s3express-control.
|
4355
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name
|
4290
4356
|
# `. Virtual-hosted-style requests aren't supported. For more
|
4291
|
-
# information
|
4292
|
-
#
|
4357
|
+
# information about endpoints in Availability Zones, see [Regional
|
4358
|
+
# and Zonal endpoints for directory buckets in Availability
|
4359
|
+
# Zones][3] in the *Amazon S3 User Guide*. For more information
|
4360
|
+
# about endpoints in Local Zones, see [Available Local Zone for
|
4361
|
+
# directory buckets][4] in the *Amazon S3 User Guide*.
|
4293
4362
|
#
|
4294
4363
|
# </note>
|
4295
4364
|
# ^
|
@@ -4300,22 +4369,23 @@ module Aws::S3
|
|
4300
4369
|
# `s3express-control.region.amazonaws.com`.
|
4301
4370
|
#
|
4302
4371
|
# For more information about the object expiration, see [Elements to
|
4303
|
-
# Describe Lifecycle Actions][
|
4372
|
+
# Describe Lifecycle Actions][5].
|
4304
4373
|
#
|
4305
4374
|
# Related actions include:
|
4306
4375
|
#
|
4307
|
-
# * [PutBucketLifecycleConfiguration][
|
4376
|
+
# * [PutBucketLifecycleConfiguration][6]
|
4308
4377
|
#
|
4309
|
-
# * [GetBucketLifecycleConfiguration][
|
4378
|
+
# * [GetBucketLifecycleConfiguration][7]
|
4310
4379
|
#
|
4311
4380
|
#
|
4312
4381
|
#
|
4313
4382
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4314
4383
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
4315
4384
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
4316
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4317
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4318
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
4385
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4386
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions
|
4387
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
4388
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
4319
4389
|
#
|
4320
4390
|
# @option params [required, String] :bucket
|
4321
4391
|
# The bucket name of the lifecycle to delete.
|
@@ -4482,9 +4552,13 @@ module Aws::S3
|
|
4482
4552
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
4483
4553
|
# requests for this API operation to the Regional endpoint. These
|
4484
4554
|
# endpoints support path-style requests in the format
|
4485
|
-
# `https://s3express-control.
|
4486
|
-
# Virtual-hosted-style requests aren't supported. For more information
|
4487
|
-
#
|
4555
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
4556
|
+
# Virtual-hosted-style requests aren't supported. For more information
|
4557
|
+
# about endpoints in Availability Zones, see [Regional and Zonal
|
4558
|
+
# endpoints for directory buckets in Availability Zones][1] in the
|
4559
|
+
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
4560
|
+
# Zones, see [Available Local Zone for directory buckets][2] in the
|
4561
|
+
# *Amazon S3 User Guide*.
|
4488
4562
|
#
|
4489
4563
|
# </note>
|
4490
4564
|
#
|
@@ -4514,7 +4588,7 @@ module Aws::S3
|
|
4514
4588
|
# * **General purpose bucket permissions** - The
|
4515
4589
|
# `s3:DeleteBucketPolicy` permission is required in a policy. For
|
4516
4590
|
# more information about general purpose buckets bucket policies,
|
4517
|
-
# see [Using Bucket Policies and User Policies][
|
4591
|
+
# see [Using Bucket Policies and User Policies][3] in the *Amazon S3
|
4518
4592
|
# User Guide*.
|
4519
4593
|
#
|
4520
4594
|
# * **Directory bucket permissions** - To grant access to this API
|
@@ -4525,39 +4599,41 @@ module Aws::S3
|
|
4525
4599
|
# Services account that owns the resource. For more information
|
4526
4600
|
# about directory bucket policies and permissions, see [Amazon Web
|
4527
4601
|
# Services Identity and Access Management (IAM) for S3 Express One
|
4528
|
-
# Zone][
|
4602
|
+
# Zone][4] in the *Amazon S3 User Guide*.
|
4529
4603
|
#
|
4530
4604
|
# HTTP Host header syntax
|
4531
4605
|
#
|
4532
4606
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
4533
|
-
# `s3express-control.region.amazonaws.com`.
|
4607
|
+
# `s3express-control.region-code.amazonaws.com`.
|
4534
4608
|
#
|
4535
4609
|
# The following operations are related to `DeleteBucketPolicy`
|
4536
4610
|
#
|
4537
|
-
# * [CreateBucket][
|
4611
|
+
# * [CreateBucket][5]
|
4538
4612
|
#
|
4539
|
-
# * [DeleteObject][
|
4613
|
+
# * [DeleteObject][6]
|
4540
4614
|
#
|
4541
4615
|
#
|
4542
4616
|
#
|
4543
4617
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
4544
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4545
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4546
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4547
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
4618
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4619
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
4620
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
4621
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
4622
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
4548
4623
|
#
|
4549
4624
|
# @option params [required, String] :bucket
|
4550
4625
|
# The bucket name.
|
4551
4626
|
#
|
4552
4627
|
# <b>Directory buckets </b> - When you use this operation with a
|
4553
4628
|
# directory bucket, you must use path-style requests in the format
|
4554
|
-
# `https://s3express-control.
|
4629
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
4555
4630
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
4556
|
-
# names must be unique in the chosen Availability Zone
|
4557
|
-
# must also follow the format `
|
4558
|
-
#
|
4559
|
-
#
|
4560
|
-
#
|
4631
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
4632
|
+
# Zone). Bucket names must also follow the format `
|
4633
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
4634
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
4635
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
4636
|
+
# *Amazon S3 User Guide*
|
4561
4637
|
#
|
4562
4638
|
#
|
4563
4639
|
#
|
@@ -4796,33 +4872,71 @@ module Aws::S3
|
|
4796
4872
|
end
|
4797
4873
|
|
4798
4874
|
# Removes an object from a bucket. The behavior depends on the bucket's
|
4799
|
-
# versioning state
|
4800
|
-
#
|
4875
|
+
# versioning state:
|
4876
|
+
#
|
4877
|
+
# * If bucket versioning is not enabled, the operation permanently
|
4878
|
+
# deletes the object.
|
4879
|
+
#
|
4880
|
+
# * If bucket versioning is enabled, the operation inserts a delete
|
4881
|
+
# marker, which becomes the current version of the object. To
|
4882
|
+
# permanently delete an object in a versioned bucket, you must include
|
4883
|
+
# the object’s `versionId` in the request. For more information about
|
4884
|
+
# versioning-enabled buckets, see [Deleting object versions from a
|
4885
|
+
# versioning-enabled bucket][1].
|
4886
|
+
#
|
4887
|
+
# * If bucket versioning is suspended, the operation removes the object
|
4888
|
+
# that has a null `versionId`, if there is one, and inserts a delete
|
4889
|
+
# marker that becomes the current version of the object. If there
|
4890
|
+
# isn't an object with a null `versionId`, and all versions of the
|
4891
|
+
# object have a `versionId`, Amazon S3 does not remove the object and
|
4892
|
+
# only inserts a delete marker. To permanently delete an object that
|
4893
|
+
# has a `versionId`, you must include the object’s `versionId` in the
|
4894
|
+
# request. For more information about versioning-suspended buckets,
|
4895
|
+
# see [Deleting objects from versioning-suspended buckets][2].
|
4896
|
+
#
|
4897
|
+
# <note markdown="1"> * **Directory buckets** - S3 Versioning isn't enabled and supported
|
4898
|
+
# for directory buckets. For this API operation, only the `null` value
|
4899
|
+
# of the version ID is supported by directory buckets. You can only
|
4900
|
+
# specify `null` to the `versionId` query parameter in the request.
|
4901
|
+
#
|
4902
|
+
# * **Directory buckets** - For directory buckets, you must make
|
4903
|
+
# requests for this API operation to the Zonal endpoint. These
|
4904
|
+
# endpoints support virtual-hosted-style requests in the format
|
4905
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
4906
|
+
# `. Path-style requests are not supported. For more information about
|
4907
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
4908
|
+
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
4909
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
4910
|
+
# see [Available Local Zone for directory buckets][4] in the *Amazon
|
4911
|
+
# S3 User Guide*.
|
4912
|
+
#
|
4913
|
+
# </note>
|
4801
4914
|
#
|
4802
4915
|
# To remove a specific version, you must use the `versionId` query
|
4803
4916
|
# parameter. Using this query parameter permanently deletes the version.
|
4804
4917
|
# If the object deleted is a delete marker, Amazon S3 sets the response
|
4805
|
-
# header `x-amz-delete-marker` to true.
|
4806
|
-
# is in a bucket where the bucket versioning configuration is MFA delete
|
4807
|
-
# enabled, you must include the `x-amz-mfa` request header in the DELETE
|
4808
|
-
# `versionId` request. Requests that include `x-amz-mfa` must use HTTPS.
|
4809
|
-
# For more information about MFA delete and to see example requests, see
|
4810
|
-
# [Using MFA delete][2] and [Sample request][3] in the *Amazon S3 User
|
4811
|
-
# Guide*.
|
4918
|
+
# header `x-amz-delete-marker` to true.
|
4812
4919
|
#
|
4813
|
-
#
|
4814
|
-
#
|
4815
|
-
#
|
4816
|
-
#
|
4920
|
+
# If the object you want to delete is in a bucket where the bucket
|
4921
|
+
# versioning configuration is MFA Delete enabled, you must include the
|
4922
|
+
# `x-amz-mfa` request header in the DELETE `versionId` request. Requests
|
4923
|
+
# that include `x-amz-mfa` must use HTTPS. For more information about
|
4924
|
+
# MFA Delete, see [Using MFA Delete][5] in the *Amazon S3 User Guide*.
|
4925
|
+
# To see sample requests that use versioning, see [Sample Request][6].
|
4817
4926
|
#
|
4818
|
-
#
|
4819
|
-
#
|
4820
|
-
#
|
4821
|
-
#
|
4822
|
-
# `. Path-style requests are not supported. For more information, see
|
4823
|
-
# [Regional and Zonal endpoints][4] in the *Amazon S3 User Guide*.
|
4927
|
+
# <note markdown="1"> **Directory buckets** - MFA delete is not supported by directory
|
4928
|
+
# buckets.
|
4929
|
+
#
|
4930
|
+
# </note>
|
4824
4931
|
#
|
4825
|
-
#
|
4932
|
+
# You can delete objects by explicitly calling DELETE Object or calling
|
4933
|
+
# ([PutBucketLifecycle][7]) to enable Amazon S3 to remove them for you.
|
4934
|
+
# If you want to block users or accounts from removing or deleting
|
4935
|
+
# objects from your bucket, you must deny them the `s3:DeleteObject`,
|
4936
|
+
# `s3:DeleteObjectVersion`, and `s3:PutLifeCycleConfiguration` actions.
|
4937
|
+
#
|
4938
|
+
# <note markdown="1"> **Directory buckets** - S3 Lifecycle is not supported by directory
|
4939
|
+
# buckets.
|
4826
4940
|
#
|
4827
4941
|
# </note>
|
4828
4942
|
#
|
@@ -4834,51 +4948,56 @@ module Aws::S3
|
|
4834
4948
|
# * <b> <code>s3:DeleteObject</code> </b> - To delete an object from
|
4835
4949
|
# a bucket, you must always have the `s3:DeleteObject` permission.
|
4836
4950
|
#
|
4837
|
-
# <note markdown="1"> You can also use PutBucketLifecycle to delete objects in Amazon
|
4838
|
-
# S3.
|
4839
|
-
#
|
4840
|
-
# </note>
|
4841
|
-
#
|
4842
4951
|
# * <b> <code>s3:DeleteObjectVersion</code> </b> - To delete a
|
4843
4952
|
# specific version of an object from a versioning-enabled bucket,
|
4844
4953
|
# you must have the `s3:DeleteObjectVersion` permission.
|
4845
|
-
#
|
4846
|
-
#
|
4847
|
-
#
|
4848
|
-
#
|
4849
|
-
#
|
4850
|
-
#
|
4851
|
-
#
|
4852
|
-
#
|
4954
|
+
# * **Directory bucket permissions** - To grant access to this API
|
4955
|
+
# operation on a directory bucket, we recommend that you use the [
|
4956
|
+
# `CreateSession` ][8] API operation for session-based
|
4957
|
+
# authorization. Specifically, you grant the
|
4958
|
+
# `s3express:CreateSession` permission to the directory bucket in a
|
4959
|
+
# bucket policy or an IAM identity-based policy. Then, you make the
|
4960
|
+
# `CreateSession` API call on the bucket to obtain a session token.
|
4961
|
+
# With the session token in your request header, you can make API
|
4962
|
+
# requests to this operation. After the session token expires, you
|
4963
|
+
# make another `CreateSession` API call to generate a new session
|
4964
|
+
# token for use. Amazon Web Services CLI or SDKs create session and
|
4965
|
+
# refresh the session token automatically to avoid service
|
4966
|
+
# interruptions when a session expires. For more information about
|
4967
|
+
# authorization, see [ `CreateSession` ][8].
|
4853
4968
|
#
|
4854
4969
|
# HTTP Host header syntax
|
4855
4970
|
#
|
4856
4971
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
4857
|
-
#
|
4972
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
4858
4973
|
#
|
4859
4974
|
# The following action is related to `DeleteObject`:
|
4860
4975
|
#
|
4861
|
-
# * [PutObject][
|
4976
|
+
# * [PutObject][9]
|
4862
4977
|
#
|
4863
4978
|
# ^
|
4864
4979
|
#
|
4865
4980
|
#
|
4866
4981
|
#
|
4867
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
4868
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4869
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4870
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
4871
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4982
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html
|
4983
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html
|
4984
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
4985
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4986
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html
|
4987
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete
|
4988
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
4989
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
4990
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
4872
4991
|
#
|
4873
4992
|
# @option params [required, String] :bucket
|
4874
4993
|
# The bucket name of the bucket containing the object.
|
4875
4994
|
#
|
4876
4995
|
# **Directory buckets** - When you use this operation with a directory
|
4877
4996
|
# bucket, you must use virtual-hosted-style requests in the format `
|
4878
|
-
#
|
4879
|
-
# are not supported. Directory bucket names must be unique in
|
4880
|
-
# Availability Zone. Bucket names must
|
4881
|
-
#
|
4997
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
4998
|
+
# requests are not supported. Directory bucket names must be unique in
|
4999
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
5000
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
4882
5001
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
4883
5002
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
4884
5003
|
# *Amazon S3 User Guide*.
|
@@ -5211,9 +5330,13 @@ module Aws::S3
|
|
5211
5330
|
# * **Directory buckets** - For directory buckets, you must make
|
5212
5331
|
# requests for this API operation to the Zonal endpoint. These
|
5213
5332
|
# endpoints support virtual-hosted-style requests in the format
|
5214
|
-
# `https://
|
5215
|
-
# `. Path-style requests are not supported. For more information
|
5216
|
-
# [Regional and Zonal endpoints
|
5333
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
5334
|
+
# `. Path-style requests are not supported. For more information about
|
5335
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
5336
|
+
# for directory buckets in Availability Zones][1] in the *Amazon S3
|
5337
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
5338
|
+
# see [Available Local Zone for directory buckets][2] in the *Amazon
|
5339
|
+
# S3 User Guide*.
|
5217
5340
|
#
|
5218
5341
|
# </note>
|
5219
5342
|
#
|
@@ -5231,7 +5354,7 @@ module Aws::S3
|
|
5231
5354
|
# if there are non-versioned objects you are trying to delete. If you
|
5232
5355
|
# provide an invalid token, whether there are versioned keys in the
|
5233
5356
|
# request or not, the entire Multi-Object Delete request will fail. For
|
5234
|
-
# information about MFA Delete, see [MFA Delete][
|
5357
|
+
# information about MFA Delete, see [MFA Delete][3] in the *Amazon S3
|
5235
5358
|
# User Guide*.
|
5236
5359
|
#
|
5237
5360
|
# <note markdown="1"> **Directory buckets** - MFA delete is not supported by directory
|
@@ -5253,7 +5376,7 @@ module Aws::S3
|
|
5253
5376
|
# you must specify the `s3:DeleteObjectVersion` permission.
|
5254
5377
|
# * **Directory bucket permissions** - To grant access to this API
|
5255
5378
|
# operation on a directory bucket, we recommend that you use the [
|
5256
|
-
# `CreateSession` ][
|
5379
|
+
# `CreateSession` ][4] API operation for session-based
|
5257
5380
|
# authorization. Specifically, you grant the
|
5258
5381
|
# `s3express:CreateSession` permission to the directory bucket in a
|
5259
5382
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -5264,7 +5387,7 @@ module Aws::S3
|
|
5264
5387
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
5265
5388
|
# refresh the session token automatically to avoid service
|
5266
5389
|
# interruptions when a session expires. For more information about
|
5267
|
-
# authorization, see [ `CreateSession` ][
|
5390
|
+
# authorization, see [ `CreateSession` ][4].
|
5268
5391
|
#
|
5269
5392
|
# Content-MD5 request header
|
5270
5393
|
# : * **General purpose bucket** - The Content-MD5 request header is
|
@@ -5281,40 +5404,41 @@ module Aws::S3
|
|
5281
5404
|
# HTTP Host header syntax
|
5282
5405
|
#
|
5283
5406
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
5284
|
-
#
|
5407
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
5285
5408
|
#
|
5286
5409
|
# The following operations are related to `DeleteObjects`:
|
5287
5410
|
#
|
5288
|
-
# * [CreateMultipartUpload][
|
5411
|
+
# * [CreateMultipartUpload][5]
|
5289
5412
|
#
|
5290
|
-
# * [UploadPart][
|
5413
|
+
# * [UploadPart][6]
|
5291
5414
|
#
|
5292
|
-
# * [CompleteMultipartUpload][
|
5415
|
+
# * [CompleteMultipartUpload][7]
|
5293
5416
|
#
|
5294
|
-
# * [ListParts][
|
5417
|
+
# * [ListParts][8]
|
5295
5418
|
#
|
5296
|
-
# * [AbortMultipartUpload][
|
5419
|
+
# * [AbortMultipartUpload][9]
|
5297
5420
|
#
|
5298
5421
|
#
|
5299
5422
|
#
|
5300
5423
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
5301
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5302
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5303
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
5304
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
5305
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
5306
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
5307
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
5424
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
5425
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
|
5426
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
5427
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
5428
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
5429
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
5430
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
5431
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
5308
5432
|
#
|
5309
5433
|
# @option params [required, String] :bucket
|
5310
5434
|
# The bucket name containing the objects to delete.
|
5311
5435
|
#
|
5312
5436
|
# **Directory buckets** - When you use this operation with a directory
|
5313
5437
|
# bucket, you must use virtual-hosted-style requests in the format `
|
5314
|
-
#
|
5315
|
-
# are not supported. Directory bucket names must be unique in
|
5316
|
-
# Availability Zone. Bucket names must
|
5317
|
-
#
|
5438
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
5439
|
+
# requests are not supported. Directory bucket names must be unique in
|
5440
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
5441
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
5318
5442
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
5319
5443
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
5320
5444
|
# *Amazon S3 User Guide*.
|
@@ -5449,22 +5573,20 @@ module Aws::S3
|
|
5449
5573
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
5450
5574
|
#
|
5451
5575
|
#
|
5452
|
-
# @example Example: To delete multiple
|
5576
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
5453
5577
|
#
|
5454
|
-
# # The following example deletes objects from a bucket. The
|
5455
|
-
# #
|
5578
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
5579
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
5456
5580
|
#
|
5457
5581
|
# resp = client.delete_objects({
|
5458
5582
|
# bucket: "examplebucket",
|
5459
5583
|
# delete: {
|
5460
5584
|
# objects: [
|
5461
5585
|
# {
|
5462
|
-
# key: "
|
5463
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
5586
|
+
# key: "objectkey1",
|
5464
5587
|
# },
|
5465
5588
|
# {
|
5466
|
-
# key: "
|
5467
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
5589
|
+
# key: "objectkey2",
|
5468
5590
|
# },
|
5469
5591
|
# ],
|
5470
5592
|
# quiet: false,
|
@@ -5475,30 +5597,34 @@ module Aws::S3
|
|
5475
5597
|
# {
|
5476
5598
|
# deleted: [
|
5477
5599
|
# {
|
5478
|
-
#
|
5479
|
-
#
|
5600
|
+
# delete_marker: true,
|
5601
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
5602
|
+
# key: "objectkey1",
|
5480
5603
|
# },
|
5481
5604
|
# {
|
5482
|
-
#
|
5483
|
-
#
|
5605
|
+
# delete_marker: true,
|
5606
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
5607
|
+
# key: "objectkey2",
|
5484
5608
|
# },
|
5485
5609
|
# ],
|
5486
5610
|
# }
|
5487
5611
|
#
|
5488
|
-
# @example Example: To delete multiple
|
5612
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
5489
5613
|
#
|
5490
|
-
# # The following example deletes objects from a bucket. The
|
5491
|
-
# #
|
5614
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
5615
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
5492
5616
|
#
|
5493
5617
|
# resp = client.delete_objects({
|
5494
5618
|
# bucket: "examplebucket",
|
5495
5619
|
# delete: {
|
5496
5620
|
# objects: [
|
5497
5621
|
# {
|
5498
|
-
# key: "
|
5622
|
+
# key: "HappyFace.jpg",
|
5623
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
5499
5624
|
# },
|
5500
5625
|
# {
|
5501
|
-
# key: "
|
5626
|
+
# key: "HappyFace.jpg",
|
5627
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
5502
5628
|
# },
|
5503
5629
|
# ],
|
5504
5630
|
# quiet: false,
|
@@ -5509,14 +5635,12 @@ module Aws::S3
|
|
5509
5635
|
# {
|
5510
5636
|
# deleted: [
|
5511
5637
|
# {
|
5512
|
-
#
|
5513
|
-
#
|
5514
|
-
# key: "objectkey1",
|
5638
|
+
# key: "HappyFace.jpg",
|
5639
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
5515
5640
|
# },
|
5516
5641
|
# {
|
5517
|
-
#
|
5518
|
-
#
|
5519
|
-
# key: "objectkey2",
|
5642
|
+
# key: "HappyFace.jpg",
|
5643
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
5520
5644
|
# },
|
5521
5645
|
# ],
|
5522
5646
|
# }
|
@@ -6061,7 +6185,7 @@ module Aws::S3
|
|
6061
6185
|
# HTTP Host header syntax
|
6062
6186
|
#
|
6063
6187
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
6064
|
-
# `s3express-control.region.amazonaws.com`.
|
6188
|
+
# `s3express-control.region-code.amazonaws.com`.
|
6065
6189
|
#
|
6066
6190
|
# The following operations are related to `GetBucketEncryption`:
|
6067
6191
|
#
|
@@ -6085,13 +6209,14 @@ module Aws::S3
|
|
6085
6209
|
#
|
6086
6210
|
# <b>Directory buckets </b> - When you use this operation with a
|
6087
6211
|
# directory bucket, you must use path-style requests in the format
|
6088
|
-
# `https://s3express-control.
|
6212
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
6089
6213
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
6090
|
-
# names must be unique in the chosen Availability Zone
|
6091
|
-
# must also follow the format `
|
6092
|
-
#
|
6093
|
-
#
|
6094
|
-
#
|
6214
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
6215
|
+
# Zone). Bucket names must also follow the format `
|
6216
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
6217
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
6218
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
6219
|
+
# *Amazon S3 User Guide*
|
6095
6220
|
#
|
6096
6221
|
#
|
6097
6222
|
#
|
@@ -6468,10 +6593,13 @@ module Aws::S3
|
|
6468
6593
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
6469
6594
|
# requests for this API operation to the Regional endpoint. These
|
6470
6595
|
# endpoints support path-style requests in the format
|
6471
|
-
# `https://s3express-control.
|
6596
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name
|
6472
6597
|
# `. Virtual-hosted-style requests aren't supported. For more
|
6473
|
-
# information
|
6474
|
-
#
|
6598
|
+
# information about endpoints in Availability Zones, see [Regional
|
6599
|
+
# and Zonal endpoints for directory buckets in Availability
|
6600
|
+
# Zones][5] in the *Amazon S3 User Guide*. For more information
|
6601
|
+
# about endpoints in Local Zones, see [Available Local Zone for
|
6602
|
+
# directory buckets][6] in the *Amazon S3 User Guide*.
|
6475
6603
|
#
|
6476
6604
|
# </note>
|
6477
6605
|
#
|
@@ -6495,9 +6623,9 @@ module Aws::S3
|
|
6495
6623
|
#
|
6496
6624
|
# * [GetBucketLifecycle][2]
|
6497
6625
|
#
|
6498
|
-
# * [PutBucketLifecycle][
|
6626
|
+
# * [PutBucketLifecycle][7]
|
6499
6627
|
#
|
6500
|
-
# * [DeleteBucketLifecycle][
|
6628
|
+
# * [DeleteBucketLifecycle][8]
|
6501
6629
|
#
|
6502
6630
|
#
|
6503
6631
|
#
|
@@ -6506,8 +6634,9 @@ module Aws::S3
|
|
6506
6634
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6507
6635
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
6508
6636
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
6509
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6510
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
6637
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
6638
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
6639
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
6511
6640
|
#
|
6512
6641
|
# @option params [required, String] :bucket
|
6513
6642
|
# The name of the bucket for which to get the lifecycle information.
|
@@ -7152,9 +7281,13 @@ module Aws::S3
|
|
7152
7281
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
7153
7282
|
# requests for this API operation to the Regional endpoint. These
|
7154
7283
|
# endpoints support path-style requests in the format
|
7155
|
-
# `https://s3express-control.
|
7156
|
-
# Virtual-hosted-style requests aren't supported. For more information
|
7157
|
-
#
|
7284
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
7285
|
+
# Virtual-hosted-style requests aren't supported. For more information
|
7286
|
+
# about endpoints in Availability Zones, see [Regional and Zonal
|
7287
|
+
# endpoints for directory buckets in Availability Zones][1] in the
|
7288
|
+
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
7289
|
+
# Zones, see [Available Local Zone for directory buckets][2] in the
|
7290
|
+
# *Amazon S3 User Guide*.
|
7158
7291
|
#
|
7159
7292
|
# </note>
|
7160
7293
|
#
|
@@ -7184,7 +7317,7 @@ module Aws::S3
|
|
7184
7317
|
# * **General purpose bucket permissions** - The `s3:GetBucketPolicy`
|
7185
7318
|
# permission is required in a policy. For more information about
|
7186
7319
|
# general purpose buckets bucket policies, see [Using Bucket
|
7187
|
-
# Policies and User Policies][
|
7320
|
+
# Policies and User Policies][3] in the *Amazon S3 User Guide*.
|
7188
7321
|
#
|
7189
7322
|
# * **Directory bucket permissions** - To grant access to this API
|
7190
7323
|
# operation, you must have the `s3express:GetBucketPolicy`
|
@@ -7194,48 +7327,50 @@ module Aws::S3
|
|
7194
7327
|
# Services account that owns the resource. For more information
|
7195
7328
|
# about directory bucket policies and permissions, see [Amazon Web
|
7196
7329
|
# Services Identity and Access Management (IAM) for S3 Express One
|
7197
|
-
# Zone][
|
7330
|
+
# Zone][4] in the *Amazon S3 User Guide*.
|
7198
7331
|
#
|
7199
7332
|
# Example bucket policies
|
7200
7333
|
#
|
7201
7334
|
# : **General purpose buckets example bucket policies** - See [Bucket
|
7202
|
-
# policy examples][
|
7335
|
+
# policy examples][5] in the *Amazon S3 User Guide*.
|
7203
7336
|
#
|
7204
7337
|
# **Directory bucket example bucket policies** - See [Example bucket
|
7205
|
-
# policies for S3 Express One Zone][
|
7338
|
+
# policies for S3 Express One Zone][6] in the *Amazon S3 User Guide*.
|
7206
7339
|
#
|
7207
7340
|
# HTTP Host header syntax
|
7208
7341
|
#
|
7209
7342
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
7210
|
-
# `s3express-control.region.amazonaws.com`.
|
7343
|
+
# `s3express-control.region-code.amazonaws.com`.
|
7211
7344
|
#
|
7212
7345
|
# The following action is related to `GetBucketPolicy`:
|
7213
7346
|
#
|
7214
|
-
# * [GetObject][
|
7347
|
+
# * [GetObject][7]
|
7215
7348
|
#
|
7216
7349
|
# ^
|
7217
7350
|
#
|
7218
7351
|
#
|
7219
7352
|
#
|
7220
7353
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
7221
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7222
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7223
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
7224
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
7225
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7354
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
7355
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
7356
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
7357
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html
|
7358
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
7359
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
7226
7360
|
#
|
7227
7361
|
# @option params [required, String] :bucket
|
7228
7362
|
# The bucket name to get the bucket policy for.
|
7229
7363
|
#
|
7230
7364
|
# <b>Directory buckets </b> - When you use this operation with a
|
7231
7365
|
# directory bucket, you must use path-style requests in the format
|
7232
|
-
# `https://s3express-control.
|
7366
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
7233
7367
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
7234
|
-
# names must be unique in the chosen Availability Zone
|
7235
|
-
# must also follow the format `
|
7236
|
-
#
|
7237
|
-
#
|
7238
|
-
#
|
7368
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
7369
|
+
# Zone). Bucket names must also follow the format `
|
7370
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
7371
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
7372
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
7373
|
+
# *Amazon S3 User Guide*
|
7239
7374
|
#
|
7240
7375
|
# **Access points** - When you use this API operation with an access
|
7241
7376
|
# point, provide the alias of the access point in place of the bucket
|
@@ -7838,9 +7973,13 @@ module Aws::S3
|
|
7838
7973
|
# `/photos/2006/February/sample.jpg`. Also, when you make requests to
|
7839
7974
|
# this API operation, your requests are sent to the Zonal endpoint.
|
7840
7975
|
# These endpoints support virtual-hosted-style requests in the format
|
7841
|
-
# `https://
|
7842
|
-
# Path-style requests are not supported. For more information
|
7843
|
-
# [Regional and Zonal endpoints
|
7976
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
7977
|
+
# `. Path-style requests are not supported. For more information about
|
7978
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
7979
|
+
# directory buckets in Availability Zones][2] in the *Amazon S3 User
|
7980
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
7981
|
+
# [Available Local Zone for directory buckets][3] in the *Amazon S3 User
|
7982
|
+
# Guide*.
|
7844
7983
|
#
|
7845
7984
|
# Permissions
|
7846
7985
|
# : * **General purpose bucket permissions** - You must have the
|
@@ -7848,7 +7987,7 @@ module Aws::S3
|
|
7848
7987
|
# have the `READ` access to the object (or version). If you grant
|
7849
7988
|
# `READ` access to the anonymous user, the `GetObject` operation
|
7850
7989
|
# returns the object without using an authorization header. For more
|
7851
|
-
# information, see [Specifying permissions in a policy][
|
7990
|
+
# information, see [Specifying permissions in a policy][4] in the
|
7852
7991
|
# *Amazon S3 User Guide*.
|
7853
7992
|
#
|
7854
7993
|
# If you include a `versionId` in your request header, you must have
|
@@ -7872,7 +8011,7 @@ module Aws::S3
|
|
7872
8011
|
# returns an HTTP status code `403 Access Denied` error.
|
7873
8012
|
# * **Directory bucket permissions** - To grant access to this API
|
7874
8013
|
# operation on a directory bucket, we recommend that you use the [
|
7875
|
-
# `CreateSession` ][
|
8014
|
+
# `CreateSession` ][5] API operation for session-based
|
7876
8015
|
# authorization. Specifically, you grant the
|
7877
8016
|
# `s3express:CreateSession` permission to the directory bucket in a
|
7878
8017
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -7883,7 +8022,7 @@ module Aws::S3
|
|
7883
8022
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
7884
8023
|
# refresh the session token automatically to avoid service
|
7885
8024
|
# interruptions when a session expires. For more information about
|
7886
|
-
# authorization, see [ `CreateSession` ][
|
8025
|
+
# authorization, see [ `CreateSession` ][5].
|
7887
8026
|
#
|
7888
8027
|
# If the object is encrypted using SSE-KMS, you must also have the
|
7889
8028
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -7896,9 +8035,9 @@ module Aws::S3
|
|
7896
8035
|
# storage class, the S3 Intelligent-Tiering Archive Access tier, or
|
7897
8036
|
# the S3 Intelligent-Tiering Deep Archive Access tier, before you can
|
7898
8037
|
# retrieve the object you must first restore a copy using
|
7899
|
-
# [RestoreObject][
|
8038
|
+
# [RestoreObject][6]. Otherwise, this operation returns an
|
7900
8039
|
# `InvalidObjectState` error. For information about restoring archived
|
7901
|
-
# objects, see [Restoring Archived Objects][
|
8040
|
+
# objects, see [Restoring Archived Objects][7] in the *Amazon S3 User
|
7902
8041
|
# Guide*.
|
7903
8042
|
#
|
7904
8043
|
# <b>Directory buckets </b> - For directory buckets, only the S3
|
@@ -7920,7 +8059,7 @@ module Aws::S3
|
|
7920
8059
|
# **Directory buckets** - For directory buckets, there are only two
|
7921
8060
|
# supported options for server-side encryption: SSE-S3 and SSE-KMS.
|
7922
8061
|
# SSE-C isn't supported. For more information, see [Protecting data
|
7923
|
-
# with server-side encryption][
|
8062
|
+
# with server-side encryption][8] in the *Amazon S3 User Guide*.
|
7924
8063
|
#
|
7925
8064
|
# Overriding response header values through the request
|
7926
8065
|
#
|
@@ -7965,25 +8104,26 @@ module Aws::S3
|
|
7965
8104
|
# HTTP Host header syntax
|
7966
8105
|
#
|
7967
8106
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
7968
|
-
#
|
8107
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
7969
8108
|
#
|
7970
8109
|
# The following operations are related to `GetObject`:
|
7971
8110
|
#
|
7972
|
-
# * [ListBuckets][
|
8111
|
+
# * [ListBuckets][9]
|
7973
8112
|
#
|
7974
|
-
# * [GetObjectAcl][
|
8113
|
+
# * [GetObjectAcl][10]
|
7975
8114
|
#
|
7976
8115
|
#
|
7977
8116
|
#
|
7978
8117
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket
|
7979
8118
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
7980
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7981
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7982
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7983
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7984
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7985
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7986
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8119
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
8120
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
8121
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
8122
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
|
8123
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html
|
8124
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
8125
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
8126
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html
|
7987
8127
|
#
|
7988
8128
|
# @option params [String, IO] :response_target
|
7989
8129
|
# Where to write response data, file path, or IO object.
|
@@ -7993,10 +8133,10 @@ module Aws::S3
|
|
7993
8133
|
#
|
7994
8134
|
# **Directory buckets** - When you use this operation with a directory
|
7995
8135
|
# bucket, you must use virtual-hosted-style requests in the format `
|
7996
|
-
#
|
7997
|
-
# are not supported. Directory bucket names must be unique in
|
7998
|
-
# Availability Zone. Bucket names must
|
7999
|
-
#
|
8136
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
8137
|
+
# requests are not supported. Directory bucket names must be unique in
|
8138
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
8139
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
8000
8140
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
8001
8141
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
8002
8142
|
# *Amazon S3 User Guide*.
|
@@ -8676,9 +8816,13 @@ module Aws::S3
|
|
8676
8816
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
8677
8817
|
# for this API operation to the Zonal endpoint. These endpoints support
|
8678
8818
|
# virtual-hosted-style requests in the format
|
8679
|
-
# `https://
|
8680
|
-
# Path-style requests are not supported. For more information
|
8681
|
-
# [Regional and Zonal endpoints
|
8819
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
8820
|
+
# `. Path-style requests are not supported. For more information about
|
8821
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
8822
|
+
# directory buckets in Availability Zones][1] in the *Amazon S3 User
|
8823
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
8824
|
+
# [Available Local Zone for directory buckets][2] in the *Amazon S3 User
|
8825
|
+
# Guide*.
|
8682
8826
|
#
|
8683
8827
|
# </note>
|
8684
8828
|
#
|
@@ -8691,7 +8835,7 @@ module Aws::S3
|
|
8691
8835
|
# `s3:GetObjectVersionAttributes` permissions for this operation. If
|
8692
8836
|
# the bucket is not versioned, you need the `s3:GetObject` and
|
8693
8837
|
# `s3:GetObjectAttributes` permissions. For more information, see
|
8694
|
-
# [Specifying Permissions in a Policy][
|
8838
|
+
# [Specifying Permissions in a Policy][3] in the *Amazon S3 User
|
8695
8839
|
# Guide*. If the object that you request does not exist, the error
|
8696
8840
|
# Amazon S3 returns depends on whether you also have the
|
8697
8841
|
# `s3:ListBucket` permission.
|
@@ -8705,7 +8849,7 @@ module Aws::S3
|
|
8705
8849
|
# error.
|
8706
8850
|
# * **Directory bucket permissions** - To grant access to this API
|
8707
8851
|
# operation on a directory bucket, we recommend that you use the [
|
8708
|
-
# `CreateSession` ][
|
8852
|
+
# `CreateSession` ][4] API operation for session-based
|
8709
8853
|
# authorization. Specifically, you grant the
|
8710
8854
|
# `s3express:CreateSession` permission to the directory bucket in a
|
8711
8855
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -8716,7 +8860,7 @@ module Aws::S3
|
|
8716
8860
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
8717
8861
|
# refresh the session token automatically to avoid service
|
8718
8862
|
# interruptions when a session expires. For more information about
|
8719
|
-
# authorization, see [ `CreateSession` ][
|
8863
|
+
# authorization, see [ `CreateSession` ][4].
|
8720
8864
|
#
|
8721
8865
|
# If the object is encrypted with SSE-KMS, you must also have the
|
8722
8866
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -8752,7 +8896,7 @@ module Aws::S3
|
|
8752
8896
|
# * `x-amz-server-side-encryption-customer-key-MD5`
|
8753
8897
|
#
|
8754
8898
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
8755
|
-
# Customer-Provided Encryption Keys)][
|
8899
|
+
# Customer-Provided Encryption Keys)][5] in the *Amazon S3 User
|
8756
8900
|
# Guide*.
|
8757
8901
|
#
|
8758
8902
|
# <note markdown="1"> **Directory bucket permissions** - For directory buckets, there are
|
@@ -8764,10 +8908,10 @@ module Aws::S3
|
|
8764
8908
|
# encryption in your `CreateSession` requests or `PUT` object
|
8765
8909
|
# requests. Then, new objects are automatically encrypted with the
|
8766
8910
|
# desired encryption settings. For more information, see [Protecting
|
8767
|
-
# data with server-side encryption][
|
8911
|
+
# data with server-side encryption][6] in the *Amazon S3 User Guide*.
|
8768
8912
|
# For more information about the encryption overriding behaviors in
|
8769
8913
|
# directory buckets, see [Specifying server-side encryption with KMS
|
8770
|
-
# for new object uploads][
|
8914
|
+
# for new object uploads][7].
|
8771
8915
|
#
|
8772
8916
|
# </note>
|
8773
8917
|
#
|
@@ -8790,7 +8934,7 @@ module Aws::S3
|
|
8790
8934
|
#
|
8791
8935
|
# * `If-Unmodified-Since` condition evaluates to `false`.
|
8792
8936
|
# For more information about conditional requests, see [RFC
|
8793
|
-
# 7232][
|
8937
|
+
# 7232][8].
|
8794
8938
|
#
|
8795
8939
|
# * If both of the `If-None-Match` and `If-Modified-Since` headers are
|
8796
8940
|
# present in the request as follows, then Amazon S3 returns the HTTP
|
@@ -8800,58 +8944,59 @@ module Aws::S3
|
|
8800
8944
|
#
|
8801
8945
|
# * `If-Modified-Since` condition evaluates to `true`.
|
8802
8946
|
# For more information about conditional requests, see [RFC
|
8803
|
-
# 7232][
|
8947
|
+
# 7232][8].
|
8804
8948
|
#
|
8805
8949
|
# HTTP Host header syntax
|
8806
8950
|
#
|
8807
8951
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
8808
|
-
#
|
8952
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
8809
8953
|
#
|
8810
8954
|
# The following actions are related to `GetObjectAttributes`:
|
8811
8955
|
#
|
8812
|
-
# * [GetObject][
|
8956
|
+
# * [GetObject][9]
|
8813
8957
|
#
|
8814
|
-
# * [GetObjectAcl][
|
8958
|
+
# * [GetObjectAcl][10]
|
8815
8959
|
#
|
8816
|
-
# * [GetObjectLegalHold][
|
8960
|
+
# * [GetObjectLegalHold][11]
|
8817
8961
|
#
|
8818
|
-
# * [GetObjectLockConfiguration][
|
8962
|
+
# * [GetObjectLockConfiguration][12]
|
8819
8963
|
#
|
8820
|
-
# * [GetObjectRetention][
|
8964
|
+
# * [GetObjectRetention][13]
|
8821
8965
|
#
|
8822
|
-
# * [GetObjectTagging][
|
8966
|
+
# * [GetObjectTagging][14]
|
8823
8967
|
#
|
8824
|
-
# * [HeadObject][
|
8968
|
+
# * [HeadObject][15]
|
8825
8969
|
#
|
8826
|
-
# * [ListParts][
|
8970
|
+
# * [ListParts][16]
|
8827
8971
|
#
|
8828
8972
|
#
|
8829
8973
|
#
|
8830
8974
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
8831
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8832
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8833
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8834
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8835
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-
|
8836
|
-
# [7]: https://
|
8837
|
-
# [8]: https://
|
8838
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8839
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8840
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8841
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8842
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8843
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8844
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8975
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
8976
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
8977
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
8978
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
8979
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
8980
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html
|
8981
|
+
# [8]: https://tools.ietf.org/html/rfc7232
|
8982
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
8983
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html
|
8984
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html
|
8985
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html
|
8986
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html
|
8987
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
8988
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html
|
8989
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
8845
8990
|
#
|
8846
8991
|
# @option params [required, String] :bucket
|
8847
8992
|
# The name of the bucket that contains the object.
|
8848
8993
|
#
|
8849
8994
|
# **Directory buckets** - When you use this operation with a directory
|
8850
8995
|
# bucket, you must use virtual-hosted-style requests in the format `
|
8851
|
-
#
|
8852
|
-
# are not supported. Directory bucket names must be unique in
|
8853
|
-
# Availability Zone. Bucket names must
|
8854
|
-
#
|
8996
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
8997
|
+
# requests are not supported. Directory bucket names must be unique in
|
8998
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
8999
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
8855
9000
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
8856
9001
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
8857
9002
|
# *Amazon S3 User Guide*.
|
@@ -9688,13 +9833,17 @@ module Aws::S3
|
|
9688
9833
|
# HTTP Host header syntax
|
9689
9834
|
#
|
9690
9835
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
9691
|
-
#
|
9836
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
9692
9837
|
#
|
9693
9838
|
# <note markdown="1"> You must make requests for this API operation to the Zonal endpoint.
|
9694
9839
|
# These endpoints support virtual-hosted-style requests in the format
|
9695
|
-
# `https://
|
9696
|
-
# Path-style requests are not supported. For more information
|
9697
|
-
# [Regional and Zonal endpoints
|
9840
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
9841
|
+
# Path-style requests are not supported. For more information about
|
9842
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
9843
|
+
# for directory buckets in Availability Zones][5] in the *Amazon S3
|
9844
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
9845
|
+
# see [Available Local Zone for directory buckets][6] in the *Amazon
|
9846
|
+
# S3 User Guide*.
|
9698
9847
|
#
|
9699
9848
|
# </note>
|
9700
9849
|
#
|
@@ -9705,16 +9854,17 @@ module Aws::S3
|
|
9705
9854
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
9706
9855
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html
|
9707
9856
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
9857
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
9708
9858
|
#
|
9709
9859
|
# @option params [required, String] :bucket
|
9710
9860
|
# The bucket name.
|
9711
9861
|
#
|
9712
9862
|
# **Directory buckets** - When you use this operation with a directory
|
9713
9863
|
# bucket, you must use virtual-hosted-style requests in the format `
|
9714
|
-
#
|
9715
|
-
# are not supported. Directory bucket names must be unique in
|
9716
|
-
# Availability Zone. Bucket names must
|
9717
|
-
#
|
9864
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
9865
|
+
# requests are not supported. Directory bucket names must be unique in
|
9866
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
9867
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
9718
9868
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
9719
9869
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
9720
9870
|
# *Amazon S3 User Guide*.
|
@@ -9788,7 +9938,7 @@ module Aws::S3
|
|
9788
9938
|
#
|
9789
9939
|
# @example Response structure
|
9790
9940
|
#
|
9791
|
-
# resp.bucket_location_type #=> String, one of "AvailabilityZone"
|
9941
|
+
# resp.bucket_location_type #=> String, one of "AvailabilityZone", "LocalZone"
|
9792
9942
|
# resp.bucket_location_name #=> String
|
9793
9943
|
# resp.bucket_region #=> String
|
9794
9944
|
# resp.access_point_alias #=> Boolean
|
@@ -9933,22 +10083,26 @@ module Aws::S3
|
|
9933
10083
|
# HTTP Host header syntax
|
9934
10084
|
#
|
9935
10085
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
9936
|
-
#
|
10086
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
9937
10087
|
#
|
9938
10088
|
# <note markdown="1"> For directory buckets, you must make requests for this API operation
|
9939
10089
|
# to the Zonal endpoint. These endpoints support virtual-hosted-style
|
9940
10090
|
# requests in the format
|
9941
|
-
# `https://
|
9942
|
-
# `. Path-style requests are not supported. For more information
|
9943
|
-
# [Regional and Zonal endpoints
|
10091
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
10092
|
+
# `. Path-style requests are not supported. For more information about
|
10093
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
10094
|
+
# for directory buckets in Availability Zones][6] in the *Amazon S3
|
10095
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
10096
|
+
# see [Available Local Zone for directory buckets][7] in the *Amazon
|
10097
|
+
# S3 User Guide*.
|
9944
10098
|
#
|
9945
10099
|
# </note>
|
9946
10100
|
#
|
9947
10101
|
# The following actions are related to `HeadObject`:
|
9948
10102
|
#
|
9949
|
-
# * [GetObject][
|
10103
|
+
# * [GetObject][8]
|
9950
10104
|
#
|
9951
|
-
# * [GetObjectAttributes][
|
10105
|
+
# * [GetObjectAttributes][9]
|
9952
10106
|
#
|
9953
10107
|
#
|
9954
10108
|
#
|
@@ -9958,18 +10112,19 @@ module Aws::S3
|
|
9958
10112
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
9959
10113
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
9960
10114
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
9961
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9962
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
10115
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
10116
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
10117
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
|
9963
10118
|
#
|
9964
10119
|
# @option params [required, String] :bucket
|
9965
10120
|
# The name of the bucket that contains the object.
|
9966
10121
|
#
|
9967
10122
|
# **Directory buckets** - When you use this operation with a directory
|
9968
10123
|
# bucket, you must use virtual-hosted-style requests in the format `
|
9969
|
-
#
|
9970
|
-
# are not supported. Directory bucket names must be unique in
|
9971
|
-
# Availability Zone. Bucket names must
|
9972
|
-
#
|
10124
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
10125
|
+
# requests are not supported. Directory bucket names must be unique in
|
10126
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
10127
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
9973
10128
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
9974
10129
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
9975
10130
|
# *Amazon S3 User Guide*.
|
@@ -10873,9 +11028,13 @@ module Aws::S3
|
|
10873
11028
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
10874
11029
|
# requests for this API operation to the Regional endpoint. These
|
10875
11030
|
# endpoints support path-style requests in the format
|
10876
|
-
# `https://s3express-control.
|
10877
|
-
# Virtual-hosted-style requests aren't supported. For more information
|
10878
|
-
#
|
11031
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
11032
|
+
# Virtual-hosted-style requests aren't supported. For more information
|
11033
|
+
# about endpoints in Availability Zones, see [Regional and Zonal
|
11034
|
+
# endpoints for directory buckets in Availability Zones][2] in the
|
11035
|
+
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
11036
|
+
# Zones, see [Available Local Zone for directory buckets][3] in the
|
11037
|
+
# *Amazon S3 User Guide*.
|
10879
11038
|
#
|
10880
11039
|
# </note>
|
10881
11040
|
#
|
@@ -10887,7 +11046,7 @@ module Aws::S3
|
|
10887
11046
|
# operation can only be performed by the Amazon Web Services account
|
10888
11047
|
# that owns the resource. For more information about directory bucket
|
10889
11048
|
# policies and permissions, see [Amazon Web Services Identity and
|
10890
|
-
# Access Management (IAM) for S3 Express One Zone][
|
11049
|
+
# Access Management (IAM) for S3 Express One Zone][4] in the *Amazon
|
10891
11050
|
# S3 User Guide*.
|
10892
11051
|
#
|
10893
11052
|
# HTTP Host header syntax
|
@@ -10904,7 +11063,8 @@ module Aws::S3
|
|
10904
11063
|
#
|
10905
11064
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html
|
10906
11065
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
10907
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
11066
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
11067
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
10908
11068
|
#
|
10909
11069
|
# @option params [String] :continuation_token
|
10910
11070
|
# `ContinuationToken` indicates to Amazon S3 that the list is being
|
@@ -10992,21 +11152,25 @@ module Aws::S3
|
|
10992
11152
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
10993
11153
|
# for this API operation to the Zonal endpoint. These endpoints support
|
10994
11154
|
# virtual-hosted-style requests in the format
|
10995
|
-
# `https://
|
10996
|
-
# Path-style requests are not supported. For more information
|
10997
|
-
# [Regional and Zonal endpoints
|
11155
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
11156
|
+
# `. Path-style requests are not supported. For more information about
|
11157
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
11158
|
+
# directory buckets in Availability Zones][2] in the *Amazon S3 User
|
11159
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
11160
|
+
# [Available Local Zone for directory buckets][3] in the *Amazon S3 User
|
11161
|
+
# Guide*.
|
10998
11162
|
#
|
10999
11163
|
# </note>
|
11000
11164
|
#
|
11001
11165
|
# Permissions
|
11002
11166
|
# : * **General purpose bucket permissions** - For information about
|
11003
11167
|
# permissions required to use the multipart upload API, see
|
11004
|
-
# [Multipart Upload and Permissions][
|
11168
|
+
# [Multipart Upload and Permissions][4] in the *Amazon S3 User
|
11005
11169
|
# Guide*.
|
11006
11170
|
#
|
11007
11171
|
# * **Directory bucket permissions** - To grant access to this API
|
11008
11172
|
# operation on a directory bucket, we recommend that you use the [
|
11009
|
-
# `CreateSession` ][
|
11173
|
+
# `CreateSession` ][5] API operation for session-based
|
11010
11174
|
# authorization. Specifically, you grant the
|
11011
11175
|
# `s3express:CreateSession` permission to the directory bucket in a
|
11012
11176
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -11017,7 +11181,7 @@ module Aws::S3
|
|
11017
11181
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
11018
11182
|
# refresh the session token automatically to avoid service
|
11019
11183
|
# interruptions when a session expires. For more information about
|
11020
|
-
# authorization, see [ `CreateSession` ][
|
11184
|
+
# authorization, see [ `CreateSession` ][5].
|
11021
11185
|
#
|
11022
11186
|
# Sorting of multipart uploads in response
|
11023
11187
|
# : * **General purpose bucket** - In the `ListMultipartUploads`
|
@@ -11038,41 +11202,42 @@ module Aws::S3
|
|
11038
11202
|
# HTTP Host header syntax
|
11039
11203
|
#
|
11040
11204
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
11041
|
-
#
|
11205
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
11042
11206
|
#
|
11043
11207
|
# The following operations are related to `ListMultipartUploads`:
|
11044
11208
|
#
|
11045
|
-
# * [CreateMultipartUpload][
|
11209
|
+
# * [CreateMultipartUpload][6]
|
11046
11210
|
#
|
11047
|
-
# * [UploadPart][
|
11211
|
+
# * [UploadPart][7]
|
11048
11212
|
#
|
11049
|
-
# * [CompleteMultipartUpload][
|
11213
|
+
# * [CompleteMultipartUpload][8]
|
11050
11214
|
#
|
11051
|
-
# * [ListParts][
|
11215
|
+
# * [ListParts][9]
|
11052
11216
|
#
|
11053
|
-
# * [AbortMultipartUpload][
|
11217
|
+
# * [AbortMultipartUpload][10]
|
11054
11218
|
#
|
11055
11219
|
#
|
11056
11220
|
#
|
11057
11221
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
11058
11222
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
11059
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11060
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11061
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11062
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11063
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11064
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11065
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11223
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
11224
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
11225
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
11226
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
11227
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
11228
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
11229
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
11230
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
11066
11231
|
#
|
11067
11232
|
# @option params [required, String] :bucket
|
11068
11233
|
# The name of the bucket to which the multipart upload was initiated.
|
11069
11234
|
#
|
11070
11235
|
# **Directory buckets** - When you use this operation with a directory
|
11071
11236
|
# bucket, you must use virtual-hosted-style requests in the format `
|
11072
|
-
#
|
11073
|
-
# are not supported. Directory bucket names must be unique in
|
11074
|
-
# Availability Zone. Bucket names must
|
11075
|
-
#
|
11237
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
11238
|
+
# requests are not supported. Directory bucket names must be unique in
|
11239
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
11240
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
11076
11241
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
11077
11242
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
11078
11243
|
# *Amazon S3 User Guide*.
|
@@ -11665,10 +11830,10 @@ module Aws::S3
|
|
11665
11830
|
#
|
11666
11831
|
# **Directory buckets** - When you use this operation with a directory
|
11667
11832
|
# bucket, you must use virtual-hosted-style requests in the format `
|
11668
|
-
#
|
11669
|
-
# are not supported. Directory bucket names must be unique in
|
11670
|
-
# Availability Zone. Bucket names must
|
11671
|
-
#
|
11833
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
11834
|
+
# requests are not supported. Directory bucket names must be unique in
|
11835
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
11836
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
11672
11837
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
11673
11838
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
11674
11839
|
# *Amazon S3 User Guide*.
|
@@ -11880,9 +12045,13 @@ module Aws::S3
|
|
11880
12045
|
# * **Directory buckets** - For directory buckets, you must make
|
11881
12046
|
# requests for this API operation to the Zonal endpoint. These
|
11882
12047
|
# endpoints support virtual-hosted-style requests in the format
|
11883
|
-
# `https://
|
11884
|
-
# `. Path-style requests are not supported. For more information
|
11885
|
-
# [Regional and Zonal endpoints
|
12048
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
12049
|
+
# `. Path-style requests are not supported. For more information about
|
12050
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
12051
|
+
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
12052
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
12053
|
+
# see [Available Local Zone for directory buckets][4] in the *Amazon
|
12054
|
+
# S3 User Guide*.
|
11886
12055
|
#
|
11887
12056
|
# </note>
|
11888
12057
|
#
|
@@ -11892,12 +12061,12 @@ module Aws::S3
|
|
11892
12061
|
# to perform the `s3:ListBucket` action. The bucket owner has this
|
11893
12062
|
# permission by default and can grant this permission to others. For
|
11894
12063
|
# more information about permissions, see [Permissions Related to
|
11895
|
-
# Bucket Subresource Operations][
|
11896
|
-
# to Your Amazon S3 Resources][
|
12064
|
+
# Bucket Subresource Operations][5] and [Managing Access Permissions
|
12065
|
+
# to Your Amazon S3 Resources][6] in the *Amazon S3 User Guide*.
|
11897
12066
|
#
|
11898
12067
|
# * **Directory bucket permissions** - To grant access to this API
|
11899
12068
|
# operation on a directory bucket, we recommend that you use the [
|
11900
|
-
# `CreateSession` ][
|
12069
|
+
# `CreateSession` ][7] API operation for session-based
|
11901
12070
|
# authorization. Specifically, you grant the
|
11902
12071
|
# `s3express:CreateSession` permission to the directory bucket in a
|
11903
12072
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -11908,7 +12077,7 @@ module Aws::S3
|
|
11908
12077
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
11909
12078
|
# refresh the session token automatically to avoid service
|
11910
12079
|
# interruptions when a session expires. For more information about
|
11911
|
-
# authorization, see [ `CreateSession` ][
|
12080
|
+
# authorization, see [ `CreateSession` ][7].
|
11912
12081
|
#
|
11913
12082
|
# Sorting order of returned objects
|
11914
12083
|
# : * **General purpose bucket** - For general purpose buckets,
|
@@ -11921,41 +12090,42 @@ module Aws::S3
|
|
11921
12090
|
# HTTP Host header syntax
|
11922
12091
|
#
|
11923
12092
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
11924
|
-
#
|
12093
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
11925
12094
|
#
|
11926
12095
|
# This section describes the latest revision of this action. We
|
11927
12096
|
# recommend that you use this revised API operation for application
|
11928
12097
|
# development. For backward compatibility, Amazon S3 continues to
|
11929
|
-
# support the prior version of this API operation, [ListObjects][
|
12098
|
+
# support the prior version of this API operation, [ListObjects][8].
|
11930
12099
|
#
|
11931
12100
|
# The following operations are related to `ListObjectsV2`:
|
11932
12101
|
#
|
11933
|
-
# * [GetObject][
|
12102
|
+
# * [GetObject][9]
|
11934
12103
|
#
|
11935
|
-
# * [PutObject][
|
12104
|
+
# * [PutObject][10]
|
11936
12105
|
#
|
11937
|
-
# * [CreateBucket][
|
12106
|
+
# * [CreateBucket][11]
|
11938
12107
|
#
|
11939
12108
|
#
|
11940
12109
|
#
|
11941
12110
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html
|
11942
12111
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
11943
12112
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
11944
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
11945
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
11946
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11947
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11948
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11949
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
11950
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12113
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
12114
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12115
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
12116
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
12117
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
12118
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
12119
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
12120
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
11951
12121
|
#
|
11952
12122
|
# @option params [required, String] :bucket
|
11953
12123
|
# **Directory buckets** - When you use this operation with a directory
|
11954
12124
|
# bucket, you must use virtual-hosted-style requests in the format `
|
11955
|
-
#
|
11956
|
-
# are not supported. Directory bucket names must be unique in
|
11957
|
-
# Availability Zone. Bucket names must
|
11958
|
-
#
|
12125
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
12126
|
+
# requests are not supported. Directory bucket names must be unique in
|
12127
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
12128
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
11959
12129
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
11960
12130
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
11961
12131
|
# *Amazon S3 User Guide*.
|
@@ -12223,16 +12393,20 @@ module Aws::S3
|
|
12223
12393
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
12224
12394
|
# for this API operation to the Zonal endpoint. These endpoints support
|
12225
12395
|
# virtual-hosted-style requests in the format
|
12226
|
-
# `https://
|
12227
|
-
# Path-style requests are not supported. For more information
|
12228
|
-
# [Regional and Zonal endpoints
|
12396
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
12397
|
+
# `. Path-style requests are not supported. For more information about
|
12398
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
12399
|
+
# directory buckets in Availability Zones][3] in the *Amazon S3 User
|
12400
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
12401
|
+
# [Available Local Zone for directory buckets][4] in the *Amazon S3 User
|
12402
|
+
# Guide*.
|
12229
12403
|
#
|
12230
12404
|
# </note>
|
12231
12405
|
#
|
12232
12406
|
# Permissions
|
12233
12407
|
# : * **General purpose bucket permissions** - For information about
|
12234
12408
|
# permissions required to use the multipart upload API, see
|
12235
|
-
# [Multipart Upload and Permissions][
|
12409
|
+
# [Multipart Upload and Permissions][5] in the *Amazon S3 User
|
12236
12410
|
# Guide*.
|
12237
12411
|
#
|
12238
12412
|
# If the upload was created using server-side encryption with Key
|
@@ -12243,7 +12417,7 @@ module Aws::S3
|
|
12243
12417
|
#
|
12244
12418
|
# * **Directory bucket permissions** - To grant access to this API
|
12245
12419
|
# operation on a directory bucket, we recommend that you use the [
|
12246
|
-
# `CreateSession` ][
|
12420
|
+
# `CreateSession` ][6] API operation for session-based
|
12247
12421
|
# authorization. Specifically, you grant the
|
12248
12422
|
# `s3express:CreateSession` permission to the directory bucket in a
|
12249
12423
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -12254,49 +12428,50 @@ module Aws::S3
|
|
12254
12428
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
12255
12429
|
# refresh the session token automatically to avoid service
|
12256
12430
|
# interruptions when a session expires. For more information about
|
12257
|
-
# authorization, see [ `CreateSession` ][
|
12431
|
+
# authorization, see [ `CreateSession` ][6].
|
12258
12432
|
#
|
12259
12433
|
# HTTP Host header syntax
|
12260
12434
|
#
|
12261
12435
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
12262
|
-
#
|
12436
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
12263
12437
|
#
|
12264
12438
|
# The following operations are related to `ListParts`:
|
12265
12439
|
#
|
12266
12440
|
# * [CreateMultipartUpload][1]
|
12267
12441
|
#
|
12268
|
-
# * [UploadPart][
|
12442
|
+
# * [UploadPart][7]
|
12269
12443
|
#
|
12270
|
-
# * [CompleteMultipartUpload][
|
12444
|
+
# * [CompleteMultipartUpload][8]
|
12271
12445
|
#
|
12272
|
-
# * [AbortMultipartUpload][
|
12446
|
+
# * [AbortMultipartUpload][9]
|
12273
12447
|
#
|
12274
|
-
# * [GetObjectAttributes][
|
12448
|
+
# * [GetObjectAttributes][10]
|
12275
12449
|
#
|
12276
|
-
# * [ListMultipartUploads][
|
12450
|
+
# * [ListMultipartUploads][11]
|
12277
12451
|
#
|
12278
12452
|
#
|
12279
12453
|
#
|
12280
12454
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
12281
12455
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
12282
12456
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
12283
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12284
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12285
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12286
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12287
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12288
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12289
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
12457
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
12458
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
12459
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
12460
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
12461
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
12462
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
12463
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
|
12464
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
12290
12465
|
#
|
12291
12466
|
# @option params [required, String] :bucket
|
12292
12467
|
# The name of the bucket to which the parts are being uploaded.
|
12293
12468
|
#
|
12294
12469
|
# **Directory buckets** - When you use this operation with a directory
|
12295
12470
|
# bucket, you must use virtual-hosted-style requests in the format `
|
12296
|
-
#
|
12297
|
-
# are not supported. Directory bucket names must be unique in
|
12298
|
-
# Availability Zone. Bucket names must
|
12299
|
-
#
|
12471
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
12472
|
+
# requests are not supported. Directory bucket names must be unique in
|
12473
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
12474
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
12300
12475
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
12301
12476
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
12302
12477
|
# *Amazon S3 User Guide*.
|
@@ -13233,9 +13408,13 @@ module Aws::S3
|
|
13233
13408
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
13234
13409
|
# requests for this API operation to the Regional endpoint. These
|
13235
13410
|
# endpoints support path-style requests in the format
|
13236
|
-
# `https://s3express-control.
|
13237
|
-
# Virtual-hosted-style requests aren't supported. For more information
|
13238
|
-
#
|
13411
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
13412
|
+
# Virtual-hosted-style requests aren't supported. For more information
|
13413
|
+
# about endpoints in Availability Zones, see [Regional and Zonal
|
13414
|
+
# endpoints for directory buckets in Availability Zones][1] in the
|
13415
|
+
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
13416
|
+
# Zones, see [Available Local Zone for directory buckets][2] in the
|
13417
|
+
# *Amazon S3 User Guide*.
|
13239
13418
|
#
|
13240
13419
|
# </note>
|
13241
13420
|
#
|
@@ -13249,12 +13428,12 @@ module Aws::S3
|
|
13249
13428
|
# keys (SSE-KMS) or dual-layer server-side encryption with Amazon
|
13250
13429
|
# Web Services KMS keys (DSSE-KMS). If you specify default
|
13251
13430
|
# encryption by using SSE-KMS, you can also configure [Amazon S3
|
13252
|
-
# Bucket Keys][
|
13253
|
-
# encryption feature, see [Amazon S3 Bucket Default Encryption][
|
13431
|
+
# Bucket Keys][3]. For information about the bucket default
|
13432
|
+
# encryption feature, see [Amazon S3 Bucket Default Encryption][4]
|
13254
13433
|
# in the *Amazon S3 User Guide*.
|
13255
13434
|
#
|
13256
13435
|
# * If you use PutBucketEncryption to set your [default bucket
|
13257
|
-
# encryption][
|
13436
|
+
# encryption][4] to SSE-KMS, you should verify that your KMS key ID
|
13258
13437
|
# is correct. Amazon S3 doesn't validate the KMS key ID provided in
|
13259
13438
|
# PutBucketEncryption requests.
|
13260
13439
|
# * <b>Directory buckets </b> - You can optionally configure default
|
@@ -13268,28 +13447,28 @@ module Aws::S3
|
|
13268
13447
|
# encrypted with the desired encryption settings. For more
|
13269
13448
|
# information about the encryption overriding behaviors in directory
|
13270
13449
|
# buckets, see [Specifying server-side encryption with KMS for new
|
13271
|
-
# object uploads][
|
13450
|
+
# object uploads][5].
|
13272
13451
|
#
|
13273
13452
|
# * Your SSE-KMS configuration can only support 1 [customer managed
|
13274
|
-
# key][
|
13275
|
-
# [Amazon Web Services managed key][
|
13453
|
+
# key][6] per directory bucket for the lifetime of the bucket. The
|
13454
|
+
# [Amazon Web Services managed key][7] (`aws/s3`) isn't supported.
|
13276
13455
|
#
|
13277
13456
|
# * S3 Bucket Keys are always enabled for `GET` and `PUT` operations
|
13278
13457
|
# in a directory bucket and can’t be disabled. S3 Bucket Keys
|
13279
13458
|
# aren't supported, when you copy SSE-KMS encrypted objects from
|
13280
13459
|
# general purpose buckets to directory buckets, from directory
|
13281
13460
|
# buckets to general purpose buckets, or between directory buckets,
|
13282
|
-
# through [CopyObject][
|
13283
|
-
# in Batch Operations][
|
13461
|
+
# through [CopyObject][8], [UploadPartCopy][9], [the Copy operation
|
13462
|
+
# in Batch Operations][10], or [the import jobs][11]. In this case,
|
13284
13463
|
# Amazon S3 makes a call to KMS every time a copy request is made
|
13285
13464
|
# for a KMS-encrypted object.
|
13286
13465
|
#
|
13287
|
-
# * When you specify an [KMS customer managed key][
|
13466
|
+
# * When you specify an [KMS customer managed key][6] for encryption
|
13288
13467
|
# in your directory bucket, only use the key ID or key ARN. The key
|
13289
13468
|
# alias format of the KMS key isn't supported.
|
13290
13469
|
#
|
13291
13470
|
# * For directory buckets, if you use PutBucketEncryption to set your
|
13292
|
-
# [default bucket encryption][
|
13471
|
+
# [default bucket encryption][4] to SSE-KMS, Amazon S3 validates the
|
13293
13472
|
# KMS key ID provided in PutBucketEncryption requests.
|
13294
13473
|
#
|
13295
13474
|
# </note>
|
@@ -13302,7 +13481,7 @@ module Aws::S3
|
|
13302
13481
|
#
|
13303
13482
|
# Also, this action requires Amazon Web Services Signature Version 4.
|
13304
13483
|
# For more information, see [ Authenticating Requests (Amazon Web
|
13305
|
-
# Services Signature Version 4)][
|
13484
|
+
# Services Signature Version 4)][12].
|
13306
13485
|
#
|
13307
13486
|
# Permissions
|
13308
13487
|
# : * **General purpose bucket permissions** - The
|
@@ -13310,8 +13489,8 @@ module Aws::S3
|
|
13310
13489
|
# policy. The bucket owner has this permission by default. The
|
13311
13490
|
# bucket owner can grant this permission to others. For more
|
13312
13491
|
# information about permissions, see [Permissions Related to Bucket
|
13313
|
-
# Operations][
|
13314
|
-
# Resources][
|
13492
|
+
# Operations][13] and [Managing Access Permissions to Your Amazon S3
|
13493
|
+
# Resources][14] in the *Amazon S3 User Guide*.
|
13315
13494
|
#
|
13316
13495
|
# * **Directory bucket permissions** - To grant access to this API
|
13317
13496
|
# operation, you must have the
|
@@ -13321,7 +13500,7 @@ module Aws::S3
|
|
13321
13500
|
# only be performed by the Amazon Web Services account that owns the
|
13322
13501
|
# resource. For more information about directory bucket policies and
|
13323
13502
|
# permissions, see [Amazon Web Services Identity and Access
|
13324
|
-
# Management (IAM) for S3 Express One Zone][
|
13503
|
+
# Management (IAM) for S3 Express One Zone][15] in the *Amazon S3
|
13325
13504
|
# User Guide*.
|
13326
13505
|
#
|
13327
13506
|
# To set a directory bucket default encryption with SSE-KMS, you
|
@@ -13332,32 +13511,33 @@ module Aws::S3
|
|
13332
13511
|
# HTTP Host header syntax
|
13333
13512
|
#
|
13334
13513
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
13335
|
-
# `s3express-control.region.amazonaws.com`.
|
13514
|
+
# `s3express-control.region-code.amazonaws.com`.
|
13336
13515
|
#
|
13337
13516
|
# The following operations are related to `PutBucketEncryption`:
|
13338
13517
|
#
|
13339
|
-
# * [GetBucketEncryption][
|
13518
|
+
# * [GetBucketEncryption][16]
|
13340
13519
|
#
|
13341
|
-
# * [DeleteBucketEncryption][
|
13520
|
+
# * [DeleteBucketEncryption][17]
|
13342
13521
|
#
|
13343
13522
|
#
|
13344
13523
|
#
|
13345
13524
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
13346
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13347
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-
|
13348
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13349
|
-
# [5]: https://docs.aws.amazon.com/
|
13350
|
-
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#
|
13351
|
-
# [7]: https://docs.aws.amazon.com/
|
13352
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
13353
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13354
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
13355
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13356
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13357
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
13358
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
13359
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13360
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
13525
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
13526
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
13527
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
13528
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-specifying-kms-encryption.html
|
13529
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk
|
13530
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk
|
13531
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
13532
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
13533
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-objects-Batch-Ops
|
13534
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-import-job
|
13535
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
13536
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
13537
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
13538
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
13539
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
13540
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
13361
13541
|
#
|
13362
13542
|
# @option params [required, String] :bucket
|
13363
13543
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -13365,13 +13545,14 @@ module Aws::S3
|
|
13365
13545
|
#
|
13366
13546
|
# <b>Directory buckets </b> - When you use this operation with a
|
13367
13547
|
# directory bucket, you must use path-style requests in the format
|
13368
|
-
# `https://s3express-control.
|
13548
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
13369
13549
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
13370
|
-
# names must be unique in the chosen Availability Zone
|
13371
|
-
# must also follow the format `
|
13372
|
-
#
|
13373
|
-
#
|
13374
|
-
#
|
13550
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
13551
|
+
# Zone). Bucket names must also follow the format `
|
13552
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
13553
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
13554
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
13555
|
+
# *Amazon S3 User Guide*
|
13375
13556
|
#
|
13376
13557
|
#
|
13377
13558
|
#
|
@@ -13890,6 +14071,16 @@ module Aws::S3
|
|
13890
14071
|
# lifecycle configuration. For information about lifecycle
|
13891
14072
|
# configuration, see [Managing your storage lifecycle][1].
|
13892
14073
|
#
|
14074
|
+
# <note markdown="1"> Bucket lifecycle configuration now supports specifying a lifecycle
|
14075
|
+
# rule using an object key name prefix, one or more object tags, object
|
14076
|
+
# size, or any combination of these. Accordingly, this section describes
|
14077
|
+
# the latest API. The previous version of the API supported filtering
|
14078
|
+
# based only on an object key name prefix, which is supported for
|
14079
|
+
# backward compatibility. For the related API description, see
|
14080
|
+
# [PutBucketLifecycle][2].
|
14081
|
+
#
|
14082
|
+
# </note>
|
14083
|
+
#
|
13893
14084
|
# Rules
|
13894
14085
|
# Permissions
|
13895
14086
|
# HTTP Host header syntax
|
@@ -13970,10 +14161,13 @@ module Aws::S3
|
|
13970
14161
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
13971
14162
|
# requests for this API operation to the Regional endpoint. These
|
13972
14163
|
# endpoints support path-style requests in the format
|
13973
|
-
# `https://s3express-control.
|
14164
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name
|
13974
14165
|
# `. Virtual-hosted-style requests aren't supported. For more
|
13975
|
-
# information
|
13976
|
-
#
|
14166
|
+
# information about endpoints in Availability Zones, see [Regional
|
14167
|
+
# and Zonal endpoints for directory buckets in Availability
|
14168
|
+
# Zones][7] in the *Amazon S3 User Guide*. For more information
|
14169
|
+
# about endpoints in Local Zones, see [Available Local Zone for
|
14170
|
+
# directory buckets][8] in the *Amazon S3 User Guide*.
|
13977
14171
|
#
|
13978
14172
|
# </note>
|
13979
14173
|
#
|
@@ -13983,9 +14177,9 @@ module Aws::S3
|
|
13983
14177
|
# The following operations are related to
|
13984
14178
|
# `PutBucketLifecycleConfiguration`:
|
13985
14179
|
#
|
13986
|
-
# * [GetBucketLifecycleConfiguration][
|
14180
|
+
# * [GetBucketLifecycleConfiguration][9]
|
13987
14181
|
#
|
13988
|
-
# * [DeleteBucketLifecycle][
|
14182
|
+
# * [DeleteBucketLifecycle][10]
|
13989
14183
|
#
|
13990
14184
|
#
|
13991
14185
|
#
|
@@ -13996,8 +14190,9 @@ module Aws::S3
|
|
13996
14190
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
13997
14191
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
13998
14192
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
13999
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14000
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
14193
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
14194
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
14195
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
14001
14196
|
#
|
14002
14197
|
# @option params [required, String] :bucket
|
14003
14198
|
# The name of the bucket for which to set the configuration.
|
@@ -14794,9 +14989,13 @@ module Aws::S3
|
|
14794
14989
|
# <note markdown="1"> <b>Directory buckets </b> - For directory buckets, you must make
|
14795
14990
|
# requests for this API operation to the Regional endpoint. These
|
14796
14991
|
# endpoints support path-style requests in the format
|
14797
|
-
# `https://s3express-control.
|
14798
|
-
# Virtual-hosted-style requests aren't supported. For more information
|
14799
|
-
#
|
14992
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
14993
|
+
# Virtual-hosted-style requests aren't supported. For more information
|
14994
|
+
# about endpoints in Availability Zones, see [Regional and Zonal
|
14995
|
+
# endpoints for directory buckets in Availability Zones][1] in the
|
14996
|
+
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
14997
|
+
# Zones, see [Available Local Zone for directory buckets][2] in the
|
14998
|
+
# *Amazon S3 User Guide*.
|
14800
14999
|
#
|
14801
15000
|
# </note>
|
14802
15001
|
#
|
@@ -14826,7 +15025,7 @@ module Aws::S3
|
|
14826
15025
|
# * **General purpose bucket permissions** - The `s3:PutBucketPolicy`
|
14827
15026
|
# permission is required in a policy. For more information about
|
14828
15027
|
# general purpose buckets bucket policies, see [Using Bucket
|
14829
|
-
# Policies and User Policies][
|
15028
|
+
# Policies and User Policies][3] in the *Amazon S3 User Guide*.
|
14830
15029
|
#
|
14831
15030
|
# * **Directory bucket permissions** - To grant access to this API
|
14832
15031
|
# operation, you must have the `s3express:PutBucketPolicy`
|
@@ -14836,49 +15035,51 @@ module Aws::S3
|
|
14836
15035
|
# Services account that owns the resource. For more information
|
14837
15036
|
# about directory bucket policies and permissions, see [Amazon Web
|
14838
15037
|
# Services Identity and Access Management (IAM) for S3 Express One
|
14839
|
-
# Zone][
|
15038
|
+
# Zone][4] in the *Amazon S3 User Guide*.
|
14840
15039
|
#
|
14841
15040
|
# Example bucket policies
|
14842
15041
|
#
|
14843
15042
|
# : **General purpose buckets example bucket policies** - See [Bucket
|
14844
|
-
# policy examples][
|
15043
|
+
# policy examples][5] in the *Amazon S3 User Guide*.
|
14845
15044
|
#
|
14846
15045
|
# **Directory bucket example bucket policies** - See [Example bucket
|
14847
|
-
# policies for S3 Express One Zone][
|
15046
|
+
# policies for S3 Express One Zone][6] in the *Amazon S3 User Guide*.
|
14848
15047
|
#
|
14849
15048
|
# HTTP Host header syntax
|
14850
15049
|
#
|
14851
15050
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is
|
14852
|
-
# `s3express-control.region.amazonaws.com`.
|
15051
|
+
# `s3express-control.region-code.amazonaws.com`.
|
14853
15052
|
#
|
14854
15053
|
# The following operations are related to `PutBucketPolicy`:
|
14855
15054
|
#
|
14856
|
-
# * [CreateBucket][
|
15055
|
+
# * [CreateBucket][7]
|
14857
15056
|
#
|
14858
|
-
# * [DeleteBucket][
|
15057
|
+
# * [DeleteBucket][8]
|
14859
15058
|
#
|
14860
15059
|
#
|
14861
15060
|
#
|
14862
15061
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
14863
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14864
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14865
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
14866
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
14867
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
14868
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
15062
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
15063
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
15064
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
15065
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html
|
15066
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
15067
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
15068
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
|
14869
15069
|
#
|
14870
15070
|
# @option params [required, String] :bucket
|
14871
15071
|
# The name of the bucket.
|
14872
15072
|
#
|
14873
15073
|
# <b>Directory buckets </b> - When you use this operation with a
|
14874
15074
|
# directory bucket, you must use path-style requests in the format
|
14875
|
-
# `https://s3express-control.
|
15075
|
+
# `https://s3express-control.region-code.amazonaws.com/bucket-name `.
|
14876
15076
|
# Virtual-hosted-style requests aren't supported. Directory bucket
|
14877
|
-
# names must be unique in the chosen Availability Zone
|
14878
|
-
# must also follow the format `
|
14879
|
-
#
|
14880
|
-
#
|
14881
|
-
#
|
15077
|
+
# names must be unique in the chosen Zone (Availability Zone or Local
|
15078
|
+
# Zone). Bucket names must also follow the format `
|
15079
|
+
# bucket-base-name--zone-id--x-s3` (for example, `
|
15080
|
+
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
15081
|
+
# naming restrictions, see [Directory bucket naming rules][1] in the
|
15082
|
+
# *Amazon S3 User Guide*
|
14882
15083
|
#
|
14883
15084
|
#
|
14884
15085
|
#
|
@@ -15480,10 +15681,12 @@ module Aws::S3
|
|
15480
15681
|
# </note>
|
15481
15682
|
#
|
15482
15683
|
# <note markdown="1"> When you enable versioning on a bucket for the first time, it might
|
15483
|
-
# take a short amount of time for the change to be fully propagated.
|
15484
|
-
#
|
15485
|
-
#
|
15486
|
-
#
|
15684
|
+
# take a short amount of time for the change to be fully propagated.
|
15685
|
+
# While this change is propagating, you may encounter intermittent `HTTP
|
15686
|
+
# 404 NoSuchKey` errors for requests to objects created or updated after
|
15687
|
+
# enabling versioning. We recommend that you wait for 15 minutes after
|
15688
|
+
# enabling versioning before issuing write operations (`PUT` or
|
15689
|
+
# `DELETE`) on objects in the bucket.
|
15487
15690
|
#
|
15488
15691
|
# </note>
|
15489
15692
|
#
|
@@ -15814,9 +16017,13 @@ module Aws::S3
|
|
15814
16017
|
# * **Directory buckets** - For directory buckets, you must make
|
15815
16018
|
# requests for this API operation to the Zonal endpoint. These
|
15816
16019
|
# endpoints support virtual-hosted-style requests in the format
|
15817
|
-
# `https://
|
15818
|
-
# `. Path-style requests are not supported. For more information
|
15819
|
-
# [Regional and Zonal endpoints
|
16020
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
16021
|
+
# `. Path-style requests are not supported. For more information about
|
16022
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
16023
|
+
# for directory buckets in Availability Zones][1] in the *Amazon S3
|
16024
|
+
# User Guide*. For more information about endpoints in Local Zones,
|
16025
|
+
# see [Available Local Zone for directory buckets][2] in the *Amazon
|
16026
|
+
# S3 User Guide*.
|
15820
16027
|
#
|
15821
16028
|
# </note>
|
15822
16029
|
#
|
@@ -15826,7 +16033,7 @@ module Aws::S3
|
|
15826
16033
|
# modify this behavior:
|
15827
16034
|
#
|
15828
16035
|
# * **S3 Object Lock** - To prevent objects from being deleted or
|
15829
|
-
# overwritten, you can use [Amazon S3 Object Lock][
|
16036
|
+
# overwritten, you can use [Amazon S3 Object Lock][3] in the *Amazon
|
15830
16037
|
# S3 User Guide*.
|
15831
16038
|
#
|
15832
16039
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
@@ -15840,9 +16047,9 @@ module Aws::S3
|
|
15840
16047
|
# automatically generates a unique version ID of that object being
|
15841
16048
|
# stored in Amazon S3. You can retrieve, replace, or delete any
|
15842
16049
|
# version of the object. For more information about versioning, see
|
15843
|
-
# [Adding Objects to Versioning-Enabled Buckets][
|
16050
|
+
# [Adding Objects to Versioning-Enabled Buckets][4] in the *Amazon S3
|
15844
16051
|
# User Guide*. For information about returning the versioning state of
|
15845
|
-
# a bucket, see [GetBucketVersioning][
|
16052
|
+
# a bucket, see [GetBucketVersioning][5].
|
15846
16053
|
#
|
15847
16054
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
15848
16055
|
#
|
@@ -15866,7 +16073,7 @@ module Aws::S3
|
|
15866
16073
|
# `s3:PutObjectTagging`.
|
15867
16074
|
# * **Directory bucket permissions** - To grant access to this API
|
15868
16075
|
# operation on a directory bucket, we recommend that you use the [
|
15869
|
-
# `CreateSession` ][
|
16076
|
+
# `CreateSession` ][6] API operation for session-based
|
15870
16077
|
# authorization. Specifically, you grant the
|
15871
16078
|
# `s3express:CreateSession` permission to the directory bucket in a
|
15872
16079
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -15877,7 +16084,7 @@ module Aws::S3
|
|
15877
16084
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
15878
16085
|
# refresh the session token automatically to avoid service
|
15879
16086
|
# interruptions when a session expires. For more information about
|
15880
|
-
# authorization, see [ `CreateSession` ][
|
16087
|
+
# authorization, see [ `CreateSession` ][6].
|
15881
16088
|
#
|
15882
16089
|
# If the object is encrypted with SSE-KMS, you must also have the
|
15883
16090
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -15898,23 +16105,24 @@ module Aws::S3
|
|
15898
16105
|
# HTTP Host header syntax
|
15899
16106
|
#
|
15900
16107
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
15901
|
-
#
|
16108
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
15902
16109
|
#
|
15903
16110
|
# For more information about related Amazon S3 APIs, see the following:
|
15904
16111
|
#
|
15905
|
-
# * [CopyObject][
|
16112
|
+
# * [CopyObject][7]
|
15906
16113
|
#
|
15907
|
-
# * [DeleteObject][
|
16114
|
+
# * [DeleteObject][8]
|
15908
16115
|
#
|
15909
16116
|
#
|
15910
16117
|
#
|
15911
16118
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
15912
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
15913
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
15914
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
15915
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
15916
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
15917
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
16119
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
16120
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
16121
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
|
16122
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html
|
16123
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
16124
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
16125
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
15918
16126
|
#
|
15919
16127
|
# @option params [String] :acl
|
15920
16128
|
# The canned ACL to apply to the object. For more information, see
|
@@ -15962,10 +16170,10 @@ module Aws::S3
|
|
15962
16170
|
#
|
15963
16171
|
# **Directory buckets** - When you use this operation with a directory
|
15964
16172
|
# bucket, you must use virtual-hosted-style requests in the format `
|
15965
|
-
#
|
15966
|
-
# are not supported. Directory bucket names must be unique in
|
15967
|
-
# Availability Zone. Bucket names must
|
15968
|
-
#
|
16173
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
16174
|
+
# requests are not supported. Directory bucket names must be unique in
|
16175
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
16176
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
15969
16177
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
15970
16178
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
15971
16179
|
# *Amazon S3 User Guide*.
|
@@ -16173,6 +16381,26 @@ module Aws::S3
|
|
16173
16381
|
#
|
16174
16382
|
# [1]: https://www.rfc-editor.org/rfc/rfc7234#section-5.3
|
16175
16383
|
#
|
16384
|
+
# @option params [String] :if_match
|
16385
|
+
# Uploads the object only if the ETag (entity tag) value provided during
|
16386
|
+
# the WRITE operation matches the ETag of the object in S3. If the ETag
|
16387
|
+
# values do not match, the operation returns a `412 Precondition Failed`
|
16388
|
+
# error.
|
16389
|
+
#
|
16390
|
+
# If a conflicting operation occurs during the upload S3 returns a `409
|
16391
|
+
# ConditionalRequestConflict` response. On a 409 failure you should
|
16392
|
+
# fetch the object's ETag and retry the upload.
|
16393
|
+
#
|
16394
|
+
# Expects the ETag value as a string.
|
16395
|
+
#
|
16396
|
+
# For more information about conditional requests, see [RFC 7232][1], or
|
16397
|
+
# [Conditional requests][2] in the *Amazon S3 User Guide*.
|
16398
|
+
#
|
16399
|
+
#
|
16400
|
+
#
|
16401
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
16402
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
16403
|
+
#
|
16176
16404
|
# @option params [String] :if_none_match
|
16177
16405
|
# Uploads the object only if the object key name does not already exist
|
16178
16406
|
# in the bucket specified. Otherwise, Amazon S3 returns a `412
|
@@ -16549,134 +16777,134 @@ module Aws::S3
|
|
16549
16777
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
16550
16778
|
#
|
16551
16779
|
#
|
16552
|
-
# @example Example: To upload
|
16780
|
+
# @example Example: To upload object and specify user-defined metadata
|
16553
16781
|
#
|
16554
|
-
# # The following example
|
16555
|
-
# # S3 returns version ID
|
16782
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
16783
|
+
# # enabled, S3 returns version ID in response.
|
16556
16784
|
#
|
16557
16785
|
# resp = client.put_object({
|
16558
|
-
# body: "
|
16786
|
+
# body: "filetoupload",
|
16559
16787
|
# bucket: "examplebucket",
|
16560
|
-
# key: "
|
16561
|
-
#
|
16788
|
+
# key: "exampleobject",
|
16789
|
+
# metadata: {
|
16790
|
+
# "metadata1" => "value1",
|
16791
|
+
# "metadata2" => "value2",
|
16792
|
+
# },
|
16562
16793
|
# })
|
16563
16794
|
#
|
16564
16795
|
# resp.to_h outputs the following:
|
16565
16796
|
# {
|
16566
16797
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16567
|
-
# version_id: "
|
16798
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
16568
16799
|
# }
|
16569
16800
|
#
|
16570
|
-
# @example Example: To upload an object and specify
|
16801
|
+
# @example Example: To upload an object and specify optional tags
|
16571
16802
|
#
|
16572
|
-
# # The following example uploads
|
16573
|
-
# #
|
16803
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
16804
|
+
# # S3 returns version ID of the newly created object.
|
16574
16805
|
#
|
16575
16806
|
# resp = client.put_object({
|
16576
|
-
#
|
16577
|
-
# body: "filetoupload",
|
16807
|
+
# body: "c:\\HappyFace.jpg",
|
16578
16808
|
# bucket: "examplebucket",
|
16579
|
-
# key: "
|
16809
|
+
# key: "HappyFace.jpg",
|
16810
|
+
# tagging: "key1=value1&key2=value2",
|
16580
16811
|
# })
|
16581
16812
|
#
|
16582
16813
|
# resp.to_h outputs the following:
|
16583
16814
|
# {
|
16584
16815
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16585
|
-
# version_id: "
|
16816
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
16586
16817
|
# }
|
16587
16818
|
#
|
16588
|
-
# @example Example: To upload an object
|
16819
|
+
# @example Example: To upload an object (specify optional headers)
|
16589
16820
|
#
|
16590
|
-
# # The following example uploads an object
|
16591
|
-
# #
|
16821
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
16822
|
+
# # storage class and use server-side encryption.
|
16592
16823
|
#
|
16593
16824
|
# resp = client.put_object({
|
16594
16825
|
# body: "HappyFace.jpg",
|
16595
16826
|
# bucket: "examplebucket",
|
16596
16827
|
# key: "HappyFace.jpg",
|
16828
|
+
# server_side_encryption: "AES256",
|
16829
|
+
# storage_class: "STANDARD_IA",
|
16597
16830
|
# })
|
16598
16831
|
#
|
16599
16832
|
# resp.to_h outputs the following:
|
16600
16833
|
# {
|
16601
16834
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16602
|
-
#
|
16835
|
+
# server_side_encryption: "AES256",
|
16836
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
16603
16837
|
# }
|
16604
16838
|
#
|
16605
|
-
# @example Example: To upload object and specify
|
16839
|
+
# @example Example: To upload an object and specify canned ACL.
|
16606
16840
|
#
|
16607
|
-
# # The following example
|
16608
|
-
# # enabled, S3 returns version ID in response.
|
16841
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
16842
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
16609
16843
|
#
|
16610
16844
|
# resp = client.put_object({
|
16845
|
+
# acl: "authenticated-read",
|
16611
16846
|
# body: "filetoupload",
|
16612
16847
|
# bucket: "examplebucket",
|
16613
16848
|
# key: "exampleobject",
|
16614
|
-
# metadata: {
|
16615
|
-
# "metadata1" => "value1",
|
16616
|
-
# "metadata2" => "value2",
|
16617
|
-
# },
|
16618
16849
|
# })
|
16619
16850
|
#
|
16620
16851
|
# resp.to_h outputs the following:
|
16621
16852
|
# {
|
16622
16853
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16623
|
-
# version_id: "
|
16854
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
16624
16855
|
# }
|
16625
16856
|
#
|
16626
|
-
# @example Example: To
|
16857
|
+
# @example Example: To upload an object
|
16627
16858
|
#
|
16628
|
-
# # The following example
|
16859
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
16860
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
16629
16861
|
#
|
16630
16862
|
# resp = client.put_object({
|
16631
|
-
# body: "
|
16863
|
+
# body: "HappyFace.jpg",
|
16632
16864
|
# bucket: "examplebucket",
|
16633
|
-
# key: "
|
16865
|
+
# key: "HappyFace.jpg",
|
16634
16866
|
# })
|
16635
16867
|
#
|
16636
16868
|
# resp.to_h outputs the following:
|
16637
16869
|
# {
|
16638
16870
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16639
|
-
# version_id: "
|
16871
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
16640
16872
|
# }
|
16641
16873
|
#
|
16642
|
-
# @example Example: To upload an object
|
16874
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
16643
16875
|
#
|
16644
|
-
# # The following example uploads an object. The request specifies optional
|
16645
|
-
# #
|
16876
|
+
# # The following example uploads an object. The request specifies the optional server-side encryption option. The request
|
16877
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
16646
16878
|
#
|
16647
16879
|
# resp = client.put_object({
|
16648
|
-
# body: "
|
16880
|
+
# body: "filetoupload",
|
16649
16881
|
# bucket: "examplebucket",
|
16650
|
-
# key: "
|
16882
|
+
# key: "exampleobject",
|
16651
16883
|
# server_side_encryption: "AES256",
|
16652
|
-
#
|
16884
|
+
# tagging: "key1=value1&key2=value2",
|
16653
16885
|
# })
|
16654
16886
|
#
|
16655
16887
|
# resp.to_h outputs the following:
|
16656
16888
|
# {
|
16657
16889
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16658
16890
|
# server_side_encryption: "AES256",
|
16659
|
-
# version_id: "
|
16891
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
16660
16892
|
# }
|
16661
16893
|
#
|
16662
|
-
# @example Example: To
|
16894
|
+
# @example Example: To create an object.
|
16663
16895
|
#
|
16664
|
-
# # The following example
|
16665
|
-
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
16896
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
16666
16897
|
#
|
16667
16898
|
# resp = client.put_object({
|
16668
16899
|
# body: "filetoupload",
|
16669
16900
|
# bucket: "examplebucket",
|
16670
|
-
# key: "
|
16671
|
-
# server_side_encryption: "AES256",
|
16672
|
-
# tagging: "key1=value1&key2=value2",
|
16901
|
+
# key: "objectkey",
|
16673
16902
|
# })
|
16674
16903
|
#
|
16675
16904
|
# resp.to_h outputs the following:
|
16676
16905
|
# {
|
16677
16906
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
16678
|
-
#
|
16679
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
16907
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
16680
16908
|
# }
|
16681
16909
|
#
|
16682
16910
|
# @example Streaming a file from disk
|
@@ -16704,6 +16932,7 @@ module Aws::S3
|
|
16704
16932
|
# checksum_sha1: "ChecksumSHA1",
|
16705
16933
|
# checksum_sha256: "ChecksumSHA256",
|
16706
16934
|
# expires: Time.now,
|
16935
|
+
# if_match: "IfMatch",
|
16707
16936
|
# if_none_match: "IfNoneMatch",
|
16708
16937
|
# grant_full_control: "GrantFullControl",
|
16709
16938
|
# grant_read: "GrantRead",
|
@@ -18639,9 +18868,13 @@ module Aws::S3
|
|
18639
18868
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
18640
18869
|
# for this API operation to the Zonal endpoint. These endpoints support
|
18641
18870
|
# virtual-hosted-style requests in the format
|
18642
|
-
# `https://
|
18643
|
-
# Path-style requests are not supported. For more information
|
18644
|
-
# [Regional and Zonal endpoints
|
18871
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
18872
|
+
# `. Path-style requests are not supported. For more information about
|
18873
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
18874
|
+
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
18875
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
18876
|
+
# [Available Local Zone for directory buckets][6] in the *Amazon S3 User
|
18877
|
+
# Guide*.
|
18645
18878
|
#
|
18646
18879
|
# </note>
|
18647
18880
|
#
|
@@ -18658,15 +18891,15 @@ module Aws::S3
|
|
18658
18891
|
# These permissions are required because Amazon S3 must decrypt and
|
18659
18892
|
# read data from the encrypted file parts before it completes the
|
18660
18893
|
# multipart upload. For more information about KMS permissions, see
|
18661
|
-
# [Protecting data using server-side encryption with KMS][
|
18894
|
+
# [Protecting data using server-side encryption with KMS][7] in the
|
18662
18895
|
# *Amazon S3 User Guide*. For information about the permissions
|
18663
18896
|
# required to use the multipart upload API, see [Multipart upload
|
18664
|
-
# and permissions][
|
18897
|
+
# and permissions][8] and [Multipart upload API and permissions][9]
|
18665
18898
|
# in the *Amazon S3 User Guide*.
|
18666
18899
|
#
|
18667
18900
|
# * **Directory bucket permissions** - To grant access to this API
|
18668
18901
|
# operation on a directory bucket, we recommend that you use the [
|
18669
|
-
# `CreateSession` ][
|
18902
|
+
# `CreateSession` ][10] API operation for session-based
|
18670
18903
|
# authorization. Specifically, you grant the
|
18671
18904
|
# `s3express:CreateSession` permission to the directory bucket in a
|
18672
18905
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -18677,7 +18910,7 @@ module Aws::S3
|
|
18677
18910
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
18678
18911
|
# refresh the session token automatically to avoid service
|
18679
18912
|
# interruptions when a session expires. For more information about
|
18680
|
-
# authorization, see [ `CreateSession` ][
|
18913
|
+
# authorization, see [ `CreateSession` ][10].
|
18681
18914
|
#
|
18682
18915
|
# If the object is encrypted with SSE-KMS, you must also have the
|
18683
18916
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -18693,7 +18926,7 @@ module Aws::S3
|
|
18693
18926
|
# then Amazon Web Services S3 uses the `x-amz-content-sha256` header
|
18694
18927
|
# as a checksum instead of `Content-MD5`. For more information see
|
18695
18928
|
# [Authenticating Requests: Using the Authorization Header (Amazon Web
|
18696
|
-
# Services Signature Version 4)][
|
18929
|
+
# Services Signature Version 4)][11].
|
18697
18930
|
#
|
18698
18931
|
# <note markdown="1"> **Directory buckets** - MD5 is not supported by directory buckets.
|
18699
18932
|
# You can use checksum algorithms to check object integrity.
|
@@ -18733,7 +18966,7 @@ module Aws::S3
|
|
18733
18966
|
# * x-amz-server-side-encryption-customer-key
|
18734
18967
|
#
|
18735
18968
|
# * x-amz-server-side-encryption-customer-key-MD5
|
18736
|
-
# For more information, see [Using Server-Side Encryption][
|
18969
|
+
# For more information, see [Using Server-Side Encryption][12] in
|
18737
18970
|
# the *Amazon S3 User Guide*.
|
18738
18971
|
#
|
18739
18972
|
# * <b>Directory buckets </b> - For directory buckets, there are only
|
@@ -18755,19 +18988,19 @@ module Aws::S3
|
|
18755
18988
|
# HTTP Host header syntax
|
18756
18989
|
#
|
18757
18990
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
18758
|
-
#
|
18991
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
18759
18992
|
#
|
18760
18993
|
# The following operations are related to `UploadPart`:
|
18761
18994
|
#
|
18762
18995
|
# * [CreateMultipartUpload][2]
|
18763
18996
|
#
|
18764
|
-
# * [CompleteMultipartUpload][
|
18997
|
+
# * [CompleteMultipartUpload][13]
|
18765
18998
|
#
|
18766
|
-
# * [AbortMultipartUpload][
|
18999
|
+
# * [AbortMultipartUpload][14]
|
18767
19000
|
#
|
18768
|
-
# * [ListParts][
|
19001
|
+
# * [ListParts][15]
|
18769
19002
|
#
|
18770
|
-
# * [ListMultipartUploads][
|
19003
|
+
# * [ListMultipartUploads][16]
|
18771
19004
|
#
|
18772
19005
|
#
|
18773
19006
|
#
|
@@ -18776,16 +19009,17 @@ module Aws::S3
|
|
18776
19009
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
|
18777
19010
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
18778
19011
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
18779
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
18780
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
18781
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
18782
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
18783
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
18784
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/
|
18785
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
18786
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
18787
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
18788
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19012
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
19013
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
|
19014
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
19015
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
19016
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
19017
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html
|
19018
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
19019
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
19020
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
19021
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
19022
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
18789
19023
|
#
|
18790
19024
|
# @option params [String, StringIO, File] :body
|
18791
19025
|
# Object data.
|
@@ -18795,10 +19029,10 @@ module Aws::S3
|
|
18795
19029
|
#
|
18796
19030
|
# **Directory buckets** - When you use this operation with a directory
|
18797
19031
|
# bucket, you must use virtual-hosted-style requests in the format `
|
18798
|
-
#
|
18799
|
-
# are not supported. Directory bucket names must be unique in
|
18800
|
-
# Availability Zone. Bucket names must
|
18801
|
-
#
|
19032
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
19033
|
+
# requests are not supported. Directory bucket names must be unique in
|
19034
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
19035
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
18802
19036
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
18803
19037
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
18804
19038
|
# *Amazon S3 User Guide*.
|
@@ -19079,9 +19313,13 @@ module Aws::S3
|
|
19079
19313
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
19080
19314
|
# for this API operation to the Zonal endpoint. These endpoints support
|
19081
19315
|
# virtual-hosted-style requests in the format
|
19082
|
-
# `https://
|
19083
|
-
# Path-style requests are not supported. For more information
|
19084
|
-
# [Regional and Zonal endpoints
|
19316
|
+
# `https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name
|
19317
|
+
# `. Path-style requests are not supported. For more information about
|
19318
|
+
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
19319
|
+
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
19320
|
+
# Guide*. For more information about endpoints in Local Zones, see
|
19321
|
+
# [Available Local Zone for directory buckets][6] in the *Amazon S3 User
|
19322
|
+
# Guide*.
|
19085
19323
|
#
|
19086
19324
|
# </note>
|
19087
19325
|
#
|
@@ -19091,7 +19329,7 @@ module Aws::S3
|
|
19091
19329
|
# using IAM credentials (access key ID and secret access key for the
|
19092
19330
|
# IAM identities). All headers with the `x-amz-` prefix, including
|
19093
19331
|
# `x-amz-copy-source`, must be signed. For more information, see [REST
|
19094
|
-
# Authentication][
|
19332
|
+
# Authentication][7].
|
19095
19333
|
#
|
19096
19334
|
# **Directory buckets** - You must use IAM credentials to authenticate
|
19097
19335
|
# and authorize your access to the `UploadPartCopy` API operation,
|
@@ -19128,11 +19366,11 @@ module Aws::S3
|
|
19128
19366
|
# permissions are required because Amazon S3 must decrypt and read
|
19129
19367
|
# data from the encrypted file parts before it completes the
|
19130
19368
|
# multipart upload. For more information about KMS permissions,
|
19131
|
-
# see [Protecting data using server-side encryption with KMS][
|
19369
|
+
# see [Protecting data using server-side encryption with KMS][8]
|
19132
19370
|
# in the *Amazon S3 User Guide*. For information about the
|
19133
19371
|
# permissions required to use the multipart upload API, see
|
19134
|
-
# [Multipart upload and permissions][
|
19135
|
-
# and permissions][
|
19372
|
+
# [Multipart upload and permissions][9] and [Multipart upload API
|
19373
|
+
# and permissions][10] in the *Amazon S3 User Guide*.
|
19136
19374
|
# * **Directory bucket permissions** - You must have permissions in a
|
19137
19375
|
# bucket policy or an IAM identity-based policy based on the source
|
19138
19376
|
# and destination bucket types in an `UploadPartCopy` operation.
|
@@ -19155,14 +19393,14 @@ module Aws::S3
|
|
19155
19393
|
# identity-based policies and KMS key policies for the KMS key.
|
19156
19394
|
#
|
19157
19395
|
# For example policies, see [Example bucket policies for S3 Express
|
19158
|
-
# One Zone][
|
19396
|
+
# One Zone][11] and [Amazon Web Services Identity and Access
|
19159
19397
|
# Management (IAM) identity-based policies for S3 Express One
|
19160
|
-
# Zone][
|
19398
|
+
# Zone][12] in the *Amazon S3 User Guide*.
|
19161
19399
|
#
|
19162
19400
|
# Encryption
|
19163
19401
|
# : * <b>General purpose buckets </b> - For information about using
|
19164
19402
|
# server-side encryption with customer-provided encryption keys with
|
19165
|
-
# the `UploadPartCopy` operation, see [CopyObject][
|
19403
|
+
# the `UploadPartCopy` operation, see [CopyObject][13] and
|
19166
19404
|
# [UploadPart][2].
|
19167
19405
|
#
|
19168
19406
|
# * <b>Directory buckets </b> - For directory buckets, there are only
|
@@ -19170,7 +19408,7 @@ module Aws::S3
|
|
19170
19408
|
# encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) and
|
19171
19409
|
# server-side encryption with KMS keys (SSE-KMS) (`aws:kms`). For
|
19172
19410
|
# more information, see [Protecting data with server-side
|
19173
|
-
# encryption][
|
19411
|
+
# encryption][14] in the *Amazon S3 User Guide*.
|
19174
19412
|
#
|
19175
19413
|
# <note markdown="1"> For directory buckets, when you perform a `CreateMultipartUpload`
|
19176
19414
|
# operation and an `UploadPartCopy` operation, the request headers
|
@@ -19182,7 +19420,7 @@ module Aws::S3
|
|
19182
19420
|
# S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted
|
19183
19421
|
# objects from general purpose buckets to directory buckets, from
|
19184
19422
|
# directory buckets to general purpose buckets, or between directory
|
19185
|
-
# buckets, through [UploadPartCopy][
|
19423
|
+
# buckets, through [UploadPartCopy][15]. In this case, Amazon S3
|
19186
19424
|
# makes a call to KMS every time a copy request is made for a
|
19187
19425
|
# KMS-encrypted object.
|
19188
19426
|
#
|
@@ -19204,21 +19442,21 @@ module Aws::S3
|
|
19204
19442
|
# HTTP Host header syntax
|
19205
19443
|
#
|
19206
19444
|
# : <b>Directory buckets </b> - The HTTP Host header syntax is `
|
19207
|
-
#
|
19445
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
19208
19446
|
#
|
19209
19447
|
# The following operations are related to `UploadPartCopy`:
|
19210
19448
|
#
|
19211
|
-
# * [CreateMultipartUpload][
|
19449
|
+
# * [CreateMultipartUpload][16]
|
19212
19450
|
#
|
19213
19451
|
# * [UploadPart][2]
|
19214
19452
|
#
|
19215
|
-
# * [CompleteMultipartUpload][
|
19453
|
+
# * [CompleteMultipartUpload][17]
|
19216
19454
|
#
|
19217
|
-
# * [AbortMultipartUpload][
|
19455
|
+
# * [AbortMultipartUpload][18]
|
19218
19456
|
#
|
19219
|
-
# * [ListParts][
|
19457
|
+
# * [ListParts][19]
|
19220
19458
|
#
|
19221
|
-
# * [ListMultipartUploads][
|
19459
|
+
# * [ListMultipartUploads][20]
|
19222
19460
|
#
|
19223
19461
|
#
|
19224
19462
|
#
|
@@ -19227,34 +19465,43 @@ module Aws::S3
|
|
19227
19465
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
19228
19466
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html
|
19229
19467
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html
|
19230
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19231
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19232
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19233
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19234
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
19235
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-
|
19236
|
-
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19237
|
-
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19238
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/
|
19239
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19240
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19241
|
-
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19242
|
-
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19243
|
-
# [19]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
19468
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
19469
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
19470
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
|
19471
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
19472
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
19473
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
19474
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html
|
19475
|
+
# [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
19476
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
19477
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
19478
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
19479
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
19480
|
+
# [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
19481
|
+
# [19]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
19482
|
+
# [20]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
19244
19483
|
#
|
19245
19484
|
# @option params [required, String] :bucket
|
19246
19485
|
# The bucket name.
|
19247
19486
|
#
|
19248
19487
|
# **Directory buckets** - When you use this operation with a directory
|
19249
19488
|
# bucket, you must use virtual-hosted-style requests in the format `
|
19250
|
-
#
|
19251
|
-
# are not supported. Directory bucket names must be unique in
|
19252
|
-
# Availability Zone. Bucket names must
|
19253
|
-
#
|
19489
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
|
19490
|
+
# requests are not supported. Directory bucket names must be unique in
|
19491
|
+
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
19492
|
+
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
19254
19493
|
# DOC-EXAMPLE-BUCKET--usw2-az1--x-s3`). For information about bucket
|
19255
19494
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
19256
19495
|
# *Amazon S3 User Guide*.
|
19257
19496
|
#
|
19497
|
+
# <note markdown="1"> Copying objects across different Amazon Web Services Regions isn't
|
19498
|
+
# supported when the source or destination bucket is in Amazon Web
|
19499
|
+
# Services Local Zones. The source and destination buckets must have the
|
19500
|
+
# same parent Amazon Web Services Region. Otherwise, you get an HTTP
|
19501
|
+
# `400 Bad Request` error with the error code `InvalidRequest`.
|
19502
|
+
#
|
19503
|
+
# </note>
|
19504
|
+
#
|
19258
19505
|
# **Access points** - When you use this action with an access point, you
|
19259
19506
|
# must provide the alias of the access point in place of the bucket name
|
19260
19507
|
# or specify the access point ARN. When using the access point ARN, you
|
@@ -20026,7 +20273,7 @@ module Aws::S3
|
|
20026
20273
|
tracer: tracer
|
20027
20274
|
)
|
20028
20275
|
context[:gem_name] = 'aws-sdk-s3'
|
20029
|
-
context[:gem_version] = '1.
|
20276
|
+
context[:gem_version] = '1.175.0'
|
20030
20277
|
Seahorse::Client::Request.new(handlers, context)
|
20031
20278
|
end
|
20032
20279
|
|