aws-sdk-s3 1.178.0 → 1.183.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 +25 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3/bucket.rb +35 -37
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -1
- data/lib/aws-sdk-s3/bucket_cors.rb +1 -1
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +1 -1
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +1 -1
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -1
- data/lib/aws-sdk-s3/bucket_policy.rb +6 -6
- data/lib/aws-sdk-s3/bucket_request_payment.rb +1 -1
- data/lib/aws-sdk-s3/bucket_tagging.rb +1 -1
- data/lib/aws-sdk-s3/bucket_versioning.rb +3 -3
- data/lib/aws-sdk-s3/bucket_website.rb +1 -1
- data/lib/aws-sdk-s3/client.rb +844 -782
- data/lib/aws-sdk-s3/client_api.rb +1 -0
- data/lib/aws-sdk-s3/endpoint_provider.rb +369 -281
- data/lib/aws-sdk-s3/multipart_upload.rb +14 -12
- data/lib/aws-sdk-s3/multipart_upload_part.rb +23 -23
- data/lib/aws-sdk-s3/object.rb +86 -90
- data/lib/aws-sdk-s3/object_summary.rb +74 -85
- data/lib/aws-sdk-s3/object_version.rb +6 -15
- data/lib/aws-sdk-s3/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +779 -660
- data/lib/aws-sdk-s3.rb +1 -1
- data/sig/bucket.rbs +1 -1
- data/sig/client.rbs +3 -2
- data/sig/object.rbs +3 -0
- data/sig/resource.rbs +1 -1
- data/sig/types.rbs +3 -2
- metadata +2 -2
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -7,55 +7,55 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
19
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
20
|
-
require 'aws-sdk-core/plugins/endpoint_discovery
|
21
|
-
require 'aws-sdk-core/plugins/endpoint_pattern
|
22
|
-
require 'aws-sdk-core/plugins/response_paging
|
23
|
-
require 'aws-sdk-core/plugins/stub_responses
|
24
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
25
|
-
require 'aws-sdk-core/plugins/invocation_id
|
26
|
-
require 'aws-sdk-core/plugins/jsonvalue_converter
|
27
|
-
require 'aws-sdk-core/plugins/client_metrics_plugin
|
28
|
-
require 'aws-sdk-core/plugins/client_metrics_send_plugin
|
29
|
-
require 'aws-sdk-core/plugins/transfer_encoding
|
30
|
-
require 'aws-sdk-core/plugins/http_checksum
|
31
|
-
require 'aws-sdk-core/plugins/checksum_algorithm
|
32
|
-
require 'aws-sdk-core/plugins/request_compression
|
33
|
-
require 'aws-sdk-core/plugins/defaults_mode
|
34
|
-
require 'aws-sdk-core/plugins/recursion_detection
|
35
|
-
require 'aws-sdk-core/plugins/telemetry
|
36
|
-
require 'aws-sdk-core/plugins/sign
|
37
|
-
require 'aws-sdk-core/plugins/protocols/rest_xml
|
38
|
-
require 'aws-sdk-s3/plugins/accelerate
|
39
|
-
require 'aws-sdk-s3/plugins/access_grants
|
40
|
-
require 'aws-sdk-s3/plugins/arn
|
41
|
-
require 'aws-sdk-s3/plugins/bucket_dns
|
42
|
-
require 'aws-sdk-s3/plugins/bucket_name_restrictions
|
43
|
-
require 'aws-sdk-s3/plugins/checksum_algorithm
|
44
|
-
require 'aws-sdk-s3/plugins/dualstack
|
45
|
-
require 'aws-sdk-s3/plugins/expect_100_continue
|
46
|
-
require 'aws-sdk-s3/plugins/express_session_auth
|
47
|
-
require 'aws-sdk-s3/plugins/get_bucket_location_fix
|
48
|
-
require 'aws-sdk-s3/plugins/http_200_errors
|
49
|
-
require 'aws-sdk-s3/plugins/iad_regional_endpoint
|
50
|
-
require 'aws-sdk-s3/plugins/location_constraint
|
51
|
-
require 'aws-sdk-s3/plugins/md5s
|
52
|
-
require 'aws-sdk-s3/plugins/redirects
|
53
|
-
require 'aws-sdk-s3/plugins/s3_host_id
|
54
|
-
require 'aws-sdk-s3/plugins/s3_signer
|
55
|
-
require 'aws-sdk-s3/plugins/sse_cpk
|
56
|
-
require 'aws-sdk-s3/plugins/streaming_retry
|
57
|
-
require 'aws-sdk-s3/plugins/url_encoded_keys
|
58
|
-
require 'aws-sdk-core/plugins/event_stream_configuration
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rest_xml'
|
38
|
+
require 'aws-sdk-s3/plugins/accelerate'
|
39
|
+
require 'aws-sdk-s3/plugins/access_grants'
|
40
|
+
require 'aws-sdk-s3/plugins/arn'
|
41
|
+
require 'aws-sdk-s3/plugins/bucket_dns'
|
42
|
+
require 'aws-sdk-s3/plugins/bucket_name_restrictions'
|
43
|
+
require 'aws-sdk-s3/plugins/checksum_algorithm'
|
44
|
+
require 'aws-sdk-s3/plugins/dualstack'
|
45
|
+
require 'aws-sdk-s3/plugins/expect_100_continue'
|
46
|
+
require 'aws-sdk-s3/plugins/express_session_auth'
|
47
|
+
require 'aws-sdk-s3/plugins/get_bucket_location_fix'
|
48
|
+
require 'aws-sdk-s3/plugins/http_200_errors'
|
49
|
+
require 'aws-sdk-s3/plugins/iad_regional_endpoint'
|
50
|
+
require 'aws-sdk-s3/plugins/location_constraint'
|
51
|
+
require 'aws-sdk-s3/plugins/md5s'
|
52
|
+
require 'aws-sdk-s3/plugins/redirects'
|
53
|
+
require 'aws-sdk-s3/plugins/s3_host_id'
|
54
|
+
require 'aws-sdk-s3/plugins/s3_signer'
|
55
|
+
require 'aws-sdk-s3/plugins/sse_cpk'
|
56
|
+
require 'aws-sdk-s3/plugins/streaming_retry'
|
57
|
+
require 'aws-sdk-s3/plugins/url_encoded_keys'
|
58
|
+
require 'aws-sdk-core/plugins/event_stream_configuration'
|
59
59
|
|
60
60
|
module Aws::S3
|
61
61
|
# An API client for S3. To construct a client, you need to configure a `:region` and `:credentials`.
|
@@ -597,13 +597,13 @@ module Aws::S3
|
|
597
597
|
# * **Directory buckets** - For directory buckets, you must make
|
598
598
|
# requests for this API operation to the Zonal endpoint. These
|
599
599
|
# endpoints support virtual-hosted-style requests in the format
|
600
|
-
# `https://bucket
|
600
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
601
601
|
# `. Path-style requests are not supported. For more information about
|
602
602
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
603
603
|
# for directory buckets in Availability Zones][2] in the *Amazon S3
|
604
604
|
# User Guide*. For more information about endpoints in Local Zones,
|
605
|
-
# see [
|
606
|
-
# S3 User Guide*.
|
605
|
+
# see [Concepts for directory buckets in Local Zones][3] in the
|
606
|
+
# *Amazon S3 User Guide*.
|
607
607
|
#
|
608
608
|
# </note>
|
609
609
|
#
|
@@ -647,7 +647,7 @@ module Aws::S3
|
|
647
647
|
#
|
648
648
|
#
|
649
649
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
650
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
650
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
651
651
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
652
652
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
653
653
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -665,34 +665,35 @@ module Aws::S3
|
|
665
665
|
# requests are not supported. Directory bucket names must be unique in
|
666
666
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
667
667
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
668
|
-
#
|
668
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
669
669
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
670
670
|
# *Amazon S3 User Guide*.
|
671
671
|
#
|
672
|
-
# **Access points** - When you use this action with an access point
|
673
|
-
# must provide the alias of the access
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
672
|
+
# **Access points** - When you use this action with an access point for
|
673
|
+
# general purpose buckets, you must provide the alias of the access
|
674
|
+
# point in place of the bucket name or specify the access point ARN.
|
675
|
+
# When you use this action with an access point for directory buckets,
|
676
|
+
# you must provide the access point name in place of the bucket name.
|
677
|
+
# When using the access point ARN, you must direct requests to the
|
678
|
+
# access point hostname. The access point hostname takes the form
|
677
679
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
678
680
|
# When using this action with an access point through the Amazon Web
|
679
681
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
680
682
|
# name. For more information about access point ARNs, see [Using access
|
681
683
|
# points][2] in the *Amazon S3 User Guide*.
|
682
684
|
#
|
683
|
-
# <note markdown="1">
|
684
|
-
# directory buckets.
|
685
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
685
686
|
#
|
686
687
|
# </note>
|
687
688
|
#
|
688
|
-
# **S3 on Outposts** - When you use this action with
|
689
|
-
#
|
690
|
-
#
|
689
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
690
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
691
|
+
# Outposts hostname takes the form `
|
691
692
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
692
|
-
# When you use this action with S3 on Outposts
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
693
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
694
|
+
# must be the Outposts access point ARN or the access point alias. For
|
695
|
+
# more information about S3 on Outposts, see [What is S3 on
|
696
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
696
697
|
#
|
697
698
|
#
|
698
699
|
#
|
@@ -830,13 +831,13 @@ module Aws::S3
|
|
830
831
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
831
832
|
# for this API operation to the Zonal endpoint. These endpoints support
|
832
833
|
# virtual-hosted-style requests in the format
|
833
|
-
# `https://bucket
|
834
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
834
835
|
# `. Path-style requests are not supported. For more information about
|
835
836
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
836
837
|
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
837
838
|
# Guide*. For more information about endpoints in Local Zones, see
|
838
|
-
# [
|
839
|
-
# Guide*.
|
839
|
+
# [Concepts for directory buckets in Local Zones][6] in the *Amazon S3
|
840
|
+
# User Guide*.
|
840
841
|
#
|
841
842
|
# </note>
|
842
843
|
#
|
@@ -923,7 +924,7 @@ module Aws::S3
|
|
923
924
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
924
925
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html
|
925
926
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
926
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
927
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
927
928
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
928
929
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
929
930
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html
|
@@ -942,34 +943,35 @@ module Aws::S3
|
|
942
943
|
# requests are not supported. Directory bucket names must be unique in
|
943
944
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
944
945
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
945
|
-
#
|
946
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
946
947
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
947
948
|
# *Amazon S3 User Guide*.
|
948
949
|
#
|
949
|
-
# **Access points** - When you use this action with an access point
|
950
|
-
# must provide the alias of the access
|
951
|
-
#
|
952
|
-
#
|
953
|
-
#
|
950
|
+
# **Access points** - When you use this action with an access point for
|
951
|
+
# general purpose buckets, you must provide the alias of the access
|
952
|
+
# point in place of the bucket name or specify the access point ARN.
|
953
|
+
# When you use this action with an access point for directory buckets,
|
954
|
+
# you must provide the access point name in place of the bucket name.
|
955
|
+
# When using the access point ARN, you must direct requests to the
|
956
|
+
# access point hostname. The access point hostname takes the form
|
954
957
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
955
958
|
# When using this action with an access point through the Amazon Web
|
956
959
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
957
960
|
# name. For more information about access point ARNs, see [Using access
|
958
961
|
# points][2] in the *Amazon S3 User Guide*.
|
959
962
|
#
|
960
|
-
# <note markdown="1">
|
961
|
-
# directory buckets.
|
963
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
962
964
|
#
|
963
965
|
# </note>
|
964
966
|
#
|
965
|
-
# **S3 on Outposts** - When you use this action with
|
966
|
-
#
|
967
|
-
#
|
967
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
968
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
969
|
+
# Outposts hostname takes the form `
|
968
970
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
969
|
-
# When you use this action with S3 on Outposts
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
971
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
972
|
+
# must be the Outposts access point ARN or the access point alias. For
|
973
|
+
# more information about S3 on Outposts, see [What is S3 on
|
974
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
973
975
|
#
|
974
976
|
#
|
975
977
|
#
|
@@ -989,7 +991,7 @@ module Aws::S3
|
|
989
991
|
# @option params [String] :checksum_crc32
|
990
992
|
# This header can be used as a data integrity check to verify that the
|
991
993
|
# data received is the same data that was originally sent. This header
|
992
|
-
# specifies the Base64 encoded, 32-bit `
|
994
|
+
# specifies the Base64 encoded, 32-bit `CRC32` checksum of the object.
|
993
995
|
# For more information, see [Checking object integrity][1] in the
|
994
996
|
# *Amazon S3 User Guide*.
|
995
997
|
#
|
@@ -1000,7 +1002,7 @@ module Aws::S3
|
|
1000
1002
|
# @option params [String] :checksum_crc32c
|
1001
1003
|
# This header can be used as a data integrity check to verify that the
|
1002
1004
|
# data received is the same data that was originally sent. This header
|
1003
|
-
# specifies the Base64 encoded, 32-bit `
|
1005
|
+
# specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object.
|
1004
1006
|
# For more information, see [Checking object integrity][1] in the
|
1005
1007
|
# *Amazon S3 User Guide*.
|
1006
1008
|
#
|
@@ -1011,10 +1013,10 @@ module Aws::S3
|
|
1011
1013
|
# @option params [String] :checksum_crc64nvme
|
1012
1014
|
# This header can be used as a data integrity check to verify that the
|
1013
1015
|
# data received is the same data that was originally sent. This header
|
1014
|
-
# specifies the Base64 encoded, 64-bit `
|
1015
|
-
# object. The `
|
1016
|
-
#
|
1017
|
-
#
|
1016
|
+
# specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the
|
1017
|
+
# object. The `CRC64NVME` checksum is always a full object checksum. For
|
1018
|
+
# more information, see [Checking object integrity in the Amazon S3 User
|
1019
|
+
# Guide][1].
|
1018
1020
|
#
|
1019
1021
|
#
|
1020
1022
|
#
|
@@ -1023,9 +1025,9 @@ module Aws::S3
|
|
1023
1025
|
# @option params [String] :checksum_sha1
|
1024
1026
|
# This header can be used as a data integrity check to verify that the
|
1025
1027
|
# data received is the same data that was originally sent. This header
|
1026
|
-
# specifies the Base64 encoded, 160-bit `
|
1027
|
-
#
|
1028
|
-
#
|
1028
|
+
# specifies the Base64 encoded, 160-bit `SHA1` digest of the object. For
|
1029
|
+
# more information, see [Checking object integrity][1] in the *Amazon S3
|
1030
|
+
# User Guide*.
|
1029
1031
|
#
|
1030
1032
|
#
|
1031
1033
|
#
|
@@ -1034,7 +1036,7 @@ module Aws::S3
|
|
1034
1036
|
# @option params [String] :checksum_sha256
|
1035
1037
|
# This header can be used as a data integrity check to verify that the
|
1036
1038
|
# data received is the same data that was originally sent. This header
|
1037
|
-
# specifies the Base64 encoded, 256-bit `
|
1039
|
+
# specifies the Base64 encoded, 256-bit `SHA256` digest of the object.
|
1038
1040
|
# For more information, see [Checking object integrity][1] in the
|
1039
1041
|
# *Amazon S3 User Guide*.
|
1040
1042
|
#
|
@@ -1299,13 +1301,13 @@ module Aws::S3
|
|
1299
1301
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
1300
1302
|
# requests for this API operation to the Zonal endpoint. These
|
1301
1303
|
# endpoints support virtual-hosted-style requests in the format
|
1302
|
-
# `https://bucket
|
1304
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
1303
1305
|
# `. Path-style requests are not supported. For more information about
|
1304
1306
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
1305
1307
|
# for directory buckets in Availability Zones][2] in the *Amazon S3
|
1306
1308
|
# User Guide*. For more information about endpoints in Local Zones,
|
1307
|
-
# see [
|
1308
|
-
# S3 User Guide*.
|
1309
|
+
# see [Concepts for directory buckets in Local Zones][3] in the
|
1310
|
+
# *Amazon S3 User Guide*.
|
1309
1311
|
#
|
1310
1312
|
# * VPC endpoints don't support cross-Region requests (including
|
1311
1313
|
# copies). If you're using VPC endpoints, your source and destination
|
@@ -1431,9 +1433,15 @@ module Aws::S3
|
|
1431
1433
|
# account. For pricing information, see [Amazon S3 pricing][10].
|
1432
1434
|
#
|
1433
1435
|
# HTTP Host header syntax
|
1436
|
+
# : * <b>Directory buckets </b> - The HTTP Host header syntax is `
|
1437
|
+
# Bucket-name.s3express-zone-id.region-code.amazonaws.com`.
|
1434
1438
|
#
|
1435
|
-
#
|
1436
|
-
#
|
1439
|
+
# * **Amazon S3 on Outposts** - When you use this action with S3 on
|
1440
|
+
# Outposts through the REST API, you must direct requests to the S3
|
1441
|
+
# on Outposts hostname. The S3 on Outposts hostname takes the form `
|
1442
|
+
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1443
|
+
# The hostname isn't required when you use the Amazon Web Services
|
1444
|
+
# CLI or SDKs.
|
1437
1445
|
#
|
1438
1446
|
# The following operations are related to `CopyObject`:
|
1439
1447
|
#
|
@@ -1444,7 +1452,7 @@ module Aws::S3
|
|
1444
1452
|
#
|
1445
1453
|
#
|
1446
1454
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
|
1447
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
1455
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
1448
1456
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
1449
1457
|
# [4]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone
|
1450
1458
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
@@ -1498,7 +1506,7 @@ module Aws::S3
|
|
1498
1506
|
# requests are not supported. Directory bucket names must be unique in
|
1499
1507
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
1500
1508
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
1501
|
-
#
|
1509
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
1502
1510
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
1503
1511
|
# *Amazon S3 User Guide*.
|
1504
1512
|
#
|
@@ -1510,30 +1518,36 @@ module Aws::S3
|
|
1510
1518
|
#
|
1511
1519
|
# </note>
|
1512
1520
|
#
|
1513
|
-
# **Access points** - When you use this action with an access point
|
1514
|
-
# must provide the alias of the access
|
1515
|
-
#
|
1516
|
-
#
|
1517
|
-
#
|
1521
|
+
# **Access points** - When you use this action with an access point for
|
1522
|
+
# general purpose buckets, you must provide the alias of the access
|
1523
|
+
# point in place of the bucket name or specify the access point ARN.
|
1524
|
+
# When you use this action with an access point for directory buckets,
|
1525
|
+
# you must provide the access point name in place of the bucket name.
|
1526
|
+
# When using the access point ARN, you must direct requests to the
|
1527
|
+
# access point hostname. The access point hostname takes the form
|
1518
1528
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1519
1529
|
# When using this action with an access point through the Amazon Web
|
1520
1530
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
1521
1531
|
# name. For more information about access point ARNs, see [Using access
|
1522
1532
|
# points][2] in the *Amazon S3 User Guide*.
|
1523
1533
|
#
|
1524
|
-
# <note markdown="1">
|
1525
|
-
# directory buckets.
|
1534
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
1526
1535
|
#
|
1527
1536
|
# </note>
|
1528
1537
|
#
|
1529
|
-
# **S3 on Outposts** - When you use this action with
|
1530
|
-
#
|
1531
|
-
#
|
1538
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
1539
|
+
# must use the Outpost bucket access point ARN or the access point alias
|
1540
|
+
# for the destination bucket. You can only copy objects within the same
|
1541
|
+
# Outpost bucket. It's not supported to copy objects across different
|
1542
|
+
# Amazon Web Services Outposts, between buckets on the same Outposts, or
|
1543
|
+
# between Outposts buckets and any other bucket types. For more
|
1544
|
+
# information about S3 on Outposts, see [What is S3 on Outposts?][3] in
|
1545
|
+
# the *S3 on Outposts guide*. When you use this action with S3 on
|
1546
|
+
# Outposts through the REST API, you must direct requests to the S3 on
|
1547
|
+
# Outposts hostname, in the format `
|
1532
1548
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
1533
|
-
#
|
1534
|
-
#
|
1535
|
-
# the bucket name. For more information about S3 on Outposts ARNs, see
|
1536
|
-
# [What is S3 on Outposts?][3] in the *Amazon S3 User Guide*.
|
1549
|
+
# The hostname isn't required when you use the Amazon Web Services CLI
|
1550
|
+
# or SDKs.
|
1537
1551
|
#
|
1538
1552
|
#
|
1539
1553
|
#
|
@@ -1916,10 +1930,12 @@ module Aws::S3
|
|
1916
1930
|
# availability. Depending on performance needs, you can specify a
|
1917
1931
|
# different Storage Class.
|
1918
1932
|
#
|
1919
|
-
# <note markdown="1"> * <b>Directory buckets </b> -
|
1920
|
-
# Express One Zone storage class
|
1921
|
-
#
|
1922
|
-
#
|
1933
|
+
# <note markdown="1"> * <b>Directory buckets </b> - Directory buckets only support
|
1934
|
+
# `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in
|
1935
|
+
# Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent
|
1936
|
+
# Access storage class) in Dedicated Local Zones. Unsupported storage
|
1937
|
+
# class values won't write a destination object and will respond with
|
1938
|
+
# the HTTP status code `400 Bad Request`.
|
1923
1939
|
#
|
1924
1940
|
# * <b>Amazon S3 on Outposts </b> - S3 on Outposts only uses the
|
1925
1941
|
# `OUTPOSTS` Storage Class.
|
@@ -2012,20 +2028,17 @@ module Aws::S3
|
|
2012
2028
|
# Signature Version in Request Authentication][1] in the *Amazon S3 User
|
2013
2029
|
# Guide*.
|
2014
2030
|
#
|
2015
|
-
# **Directory buckets** -
|
2016
|
-
#
|
2017
|
-
#
|
2018
|
-
#
|
2019
|
-
#
|
2020
|
-
# x-amz-server-side-encryption-aws-kms-key-id` header
|
2021
|
-
#
|
2022
|
-
#
|
2023
|
-
#
|
2024
|
-
#
|
2025
|
-
#
|
2026
|
-
# support 1 [customer managed key][2] per directory bucket for the
|
2027
|
-
# lifetime of the bucket. The [Amazon Web Services managed key][3]
|
2028
|
-
# (`aws/s3`) isn't supported.
|
2031
|
+
# **Directory buckets** - To encrypt data using SSE-KMS, it's
|
2032
|
+
# recommended to specify the `x-amz-server-side-encryption` header to
|
2033
|
+
# `aws:kms`. Then, the `x-amz-server-side-encryption-aws-kms-key-id`
|
2034
|
+
# header implicitly uses the bucket's default KMS customer managed key
|
2035
|
+
# ID. If you want to explicitly set the `
|
2036
|
+
# x-amz-server-side-encryption-aws-kms-key-id` header, it must match the
|
2037
|
+
# bucket's default customer managed key (using key ID or ARN, not
|
2038
|
+
# alias). Your SSE-KMS configuration can only support 1 [customer
|
2039
|
+
# managed key][2] per directory bucket's lifetime. The [Amazon Web
|
2040
|
+
# Services managed key][3] (`aws/s3`) isn't supported. Incorrect key
|
2041
|
+
# specification results in an HTTP `400 Bad Request` error.
|
2029
2042
|
#
|
2030
2043
|
#
|
2031
2044
|
#
|
@@ -2369,8 +2382,8 @@ module Aws::S3
|
|
2369
2382
|
# information about endpoints in Availability Zones, see [Regional and
|
2370
2383
|
# Zonal endpoints for directory buckets in Availability Zones][4] in
|
2371
2384
|
# the *Amazon S3 User Guide*. For more information about endpoints in
|
2372
|
-
# Local Zones, see [
|
2373
|
-
# the *Amazon S3 User Guide*.
|
2385
|
+
# Local Zones, see [Concepts for directory buckets in Local Zones][5]
|
2386
|
+
# in the *Amazon S3 User Guide*.
|
2374
2387
|
#
|
2375
2388
|
# </note>
|
2376
2389
|
#
|
@@ -2462,7 +2475,7 @@ module Aws::S3
|
|
2462
2475
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
2463
2476
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html
|
2464
2477
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
2465
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2478
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
2466
2479
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
2467
2480
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html
|
2468
2481
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html
|
@@ -2593,33 +2606,33 @@ module Aws::S3
|
|
2593
2606
|
# * {Types::CreateBucketOutput#location #location} => String
|
2594
2607
|
#
|
2595
2608
|
#
|
2596
|
-
# @example Example: To create a bucket
|
2609
|
+
# @example Example: To create a bucket
|
2597
2610
|
#
|
2598
|
-
# # The following example creates a bucket.
|
2611
|
+
# # The following example creates a bucket.
|
2599
2612
|
#
|
2600
2613
|
# resp = client.create_bucket({
|
2601
2614
|
# bucket: "examplebucket",
|
2602
|
-
# create_bucket_configuration: {
|
2603
|
-
# location_constraint: "eu-west-1",
|
2604
|
-
# },
|
2605
2615
|
# })
|
2606
2616
|
#
|
2607
2617
|
# resp.to_h outputs the following:
|
2608
2618
|
# {
|
2609
|
-
# location: "
|
2619
|
+
# location: "/examplebucket",
|
2610
2620
|
# }
|
2611
2621
|
#
|
2612
|
-
# @example Example: To create a bucket
|
2622
|
+
# @example Example: To create a bucket in a specific region
|
2613
2623
|
#
|
2614
|
-
# # The following example creates a bucket.
|
2624
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
2615
2625
|
#
|
2616
2626
|
# resp = client.create_bucket({
|
2617
2627
|
# bucket: "examplebucket",
|
2628
|
+
# create_bucket_configuration: {
|
2629
|
+
# location_constraint: "eu-west-1",
|
2630
|
+
# },
|
2618
2631
|
# })
|
2619
2632
|
#
|
2620
2633
|
# resp.to_h outputs the following:
|
2621
2634
|
# {
|
2622
|
-
# location: "/
|
2635
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
2623
2636
|
# }
|
2624
2637
|
#
|
2625
2638
|
# @example Request syntax with placeholder values
|
@@ -2628,7 +2641,7 @@ module Aws::S3
|
|
2628
2641
|
# acl: "private", # accepts private, public-read, public-read-write, authenticated-read
|
2629
2642
|
# bucket: "BucketName", # required
|
2630
2643
|
# create_bucket_configuration: {
|
2631
|
-
# 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
|
2644
|
+
# 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, ap-southeast-4, ap-southeast-5, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-central-2, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, il-central-1, me-central-1, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2
|
2632
2645
|
# location: {
|
2633
2646
|
# type: "AvailabilityZone", # accepts AvailabilityZone, LocalZone
|
2634
2647
|
# name: "LocationNameAsString",
|
@@ -2775,13 +2788,13 @@ module Aws::S3
|
|
2775
2788
|
# * <b>Directory buckets </b> - For directory buckets, you must make
|
2776
2789
|
# requests for this API operation to the Zonal endpoint. These
|
2777
2790
|
# endpoints support virtual-hosted-style requests in the format
|
2778
|
-
# `https://bucket
|
2791
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
2779
2792
|
# `. Path-style requests are not supported. For more information about
|
2780
2793
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
2781
2794
|
# for directory buckets in Availability Zones][4] in the *Amazon S3
|
2782
2795
|
# User Guide*. For more information about endpoints in Local Zones,
|
2783
|
-
# see [
|
2784
|
-
# S3 User Guide*.
|
2796
|
+
# see [Concepts for directory buckets in Local Zones][5] in the
|
2797
|
+
# *Amazon S3 User Guide*.
|
2785
2798
|
#
|
2786
2799
|
# </note>
|
2787
2800
|
#
|
@@ -2983,7 +2996,7 @@ module Aws::S3
|
|
2983
2996
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
2984
2997
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
2985
2998
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config
|
2986
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
2999
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
2987
3000
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
2988
3001
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
2989
3002
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
@@ -3035,34 +3048,35 @@ module Aws::S3
|
|
3035
3048
|
# requests are not supported. Directory bucket names must be unique in
|
3036
3049
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
3037
3050
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
3038
|
-
#
|
3051
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
3039
3052
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
3040
3053
|
# *Amazon S3 User Guide*.
|
3041
3054
|
#
|
3042
|
-
# **Access points** - When you use this action with an access point
|
3043
|
-
# must provide the alias of the access
|
3044
|
-
#
|
3045
|
-
#
|
3046
|
-
#
|
3055
|
+
# **Access points** - When you use this action with an access point for
|
3056
|
+
# general purpose buckets, you must provide the alias of the access
|
3057
|
+
# point in place of the bucket name or specify the access point ARN.
|
3058
|
+
# When you use this action with an access point for directory buckets,
|
3059
|
+
# you must provide the access point name in place of the bucket name.
|
3060
|
+
# When using the access point ARN, you must direct requests to the
|
3061
|
+
# access point hostname. The access point hostname takes the form
|
3047
3062
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3048
3063
|
# When using this action with an access point through the Amazon Web
|
3049
3064
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
3050
3065
|
# name. For more information about access point ARNs, see [Using access
|
3051
3066
|
# points][2] in the *Amazon S3 User Guide*.
|
3052
3067
|
#
|
3053
|
-
# <note markdown="1">
|
3054
|
-
# directory buckets.
|
3068
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
3055
3069
|
#
|
3056
3070
|
# </note>
|
3057
3071
|
#
|
3058
|
-
# **S3 on Outposts** - When you use this action with
|
3059
|
-
#
|
3060
|
-
#
|
3072
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
3073
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
3074
|
+
# Outposts hostname takes the form `
|
3061
3075
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
3062
|
-
# When you use this action with S3 on Outposts
|
3063
|
-
#
|
3064
|
-
#
|
3065
|
-
#
|
3076
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
3077
|
+
# must be the Outposts access point ARN or the access point alias. For
|
3078
|
+
# more information about S3 on Outposts, see [What is S3 on
|
3079
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
3066
3080
|
#
|
3067
3081
|
#
|
3068
3082
|
#
|
@@ -3415,8 +3429,9 @@ module Aws::S3
|
|
3415
3429
|
# a different Storage Class. For more information, see [Storage
|
3416
3430
|
# Classes][1] in the *Amazon S3 User Guide*.
|
3417
3431
|
#
|
3418
|
-
# <note markdown="1"> *
|
3419
|
-
#
|
3432
|
+
# <note markdown="1"> * Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One
|
3433
|
+
# Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3
|
3434
|
+
# One Zone-Infrequent Access storage class) in Dedicated Local Zones.
|
3420
3435
|
#
|
3421
3436
|
# * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
|
3422
3437
|
#
|
@@ -3478,20 +3493,17 @@ module Aws::S3
|
|
3478
3493
|
# `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
3479
3494
|
# Amazon Web Services managed key (`aws/s3`) to protect the data.
|
3480
3495
|
#
|
3481
|
-
# **Directory buckets** -
|
3482
|
-
#
|
3483
|
-
#
|
3484
|
-
#
|
3485
|
-
#
|
3486
|
-
# x-amz-server-side-encryption-aws-kms-key-id` header
|
3487
|
-
#
|
3488
|
-
#
|
3489
|
-
#
|
3490
|
-
#
|
3491
|
-
#
|
3492
|
-
# support 1 [customer managed key][1] per directory bucket for the
|
3493
|
-
# lifetime of the bucket. The [Amazon Web Services managed key][2]
|
3494
|
-
# (`aws/s3`) isn't supported.
|
3496
|
+
# **Directory buckets** - To encrypt data using SSE-KMS, it's
|
3497
|
+
# recommended to specify the `x-amz-server-side-encryption` header to
|
3498
|
+
# `aws:kms`. Then, the `x-amz-server-side-encryption-aws-kms-key-id`
|
3499
|
+
# header implicitly uses the bucket's default KMS customer managed key
|
3500
|
+
# ID. If you want to explicitly set the `
|
3501
|
+
# x-amz-server-side-encryption-aws-kms-key-id` header, it must match the
|
3502
|
+
# bucket's default customer managed key (using key ID or ARN, not
|
3503
|
+
# alias). Your SSE-KMS configuration can only support 1 [customer
|
3504
|
+
# managed key][1] per directory bucket's lifetime. The [Amazon Web
|
3505
|
+
# Services managed key][2] (`aws/s3`) isn't supported. Incorrect key
|
3506
|
+
# specification results in an HTTP `400 Bad Request` error.
|
3495
3507
|
#
|
3496
3508
|
#
|
3497
3509
|
#
|
@@ -3748,8 +3760,8 @@ module Aws::S3
|
|
3748
3760
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
3749
3761
|
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
3750
3762
|
# User Guide*. For more information about endpoints in Local Zones,
|
3751
|
-
# see [
|
3752
|
-
# S3 User Guide*.
|
3763
|
+
# see [Concepts for directory buckets in Local Zones][4] in the
|
3764
|
+
# *Amazon S3 User Guide*.
|
3753
3765
|
#
|
3754
3766
|
# * <b> <code>CopyObject</code> API operation</b> - Unlike other Zonal
|
3755
3767
|
# endpoint API operations, the `CopyObject` API operation doesn't use
|
@@ -3855,7 +3867,7 @@ module Aws::S3
|
|
3855
3867
|
#
|
3856
3868
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html
|
3857
3869
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication
|
3858
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
3870
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
3859
3871
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
3860
3872
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
3861
3873
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html
|
@@ -3895,7 +3907,7 @@ module Aws::S3
|
|
3895
3907
|
#
|
3896
3908
|
#
|
3897
3909
|
#
|
3898
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
3910
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/serv-side-encryption.html
|
3899
3911
|
#
|
3900
3912
|
# @option params [String] :ssekms_key_id
|
3901
3913
|
# If you specify `x-amz-server-side-encryption` with `aws:kms`, you must
|
@@ -3908,8 +3920,8 @@ module Aws::S3
|
|
3908
3920
|
# the Key ID.
|
3909
3921
|
#
|
3910
3922
|
# Your SSE-KMS configuration can only support 1 [customer managed
|
3911
|
-
# key][1] per directory bucket
|
3912
|
-
#
|
3923
|
+
# key][1] per directory bucket's lifetime. The [Amazon Web Services
|
3924
|
+
# managed key][2] (`aws/s3`) isn't supported.
|
3913
3925
|
#
|
3914
3926
|
#
|
3915
3927
|
#
|
@@ -4015,8 +4027,8 @@ module Aws::S3
|
|
4015
4027
|
# information about endpoints in Availability Zones, see [Regional and
|
4016
4028
|
# Zonal endpoints for directory buckets in Availability Zones][1] in
|
4017
4029
|
# the *Amazon S3 User Guide*. For more information about endpoints in
|
4018
|
-
# Local Zones, see [
|
4019
|
-
# the *Amazon S3 User Guide*.
|
4030
|
+
# Local Zones, see [Concepts for directory buckets in Local Zones][2]
|
4031
|
+
# in the *Amazon S3 User Guide*.
|
4020
4032
|
#
|
4021
4033
|
# </note>
|
4022
4034
|
#
|
@@ -4047,7 +4059,7 @@ module Aws::S3
|
|
4047
4059
|
#
|
4048
4060
|
#
|
4049
4061
|
#
|
4050
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
4062
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
4051
4063
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4052
4064
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
4053
4065
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
@@ -4512,8 +4524,8 @@ module Aws::S3
|
|
4512
4524
|
# information about endpoints in Availability Zones, see [Regional
|
4513
4525
|
# and Zonal endpoints for directory buckets in Availability
|
4514
4526
|
# Zones][3] in the *Amazon S3 User Guide*. For more information
|
4515
|
-
# about endpoints in Local Zones, see [
|
4516
|
-
#
|
4527
|
+
# about endpoints in Local Zones, see [Concepts for directory
|
4528
|
+
# buckets in Local Zones][4] in the *Amazon S3 User Guide*.
|
4517
4529
|
#
|
4518
4530
|
# </note>
|
4519
4531
|
# ^
|
@@ -4536,7 +4548,7 @@ module Aws::S3
|
|
4536
4548
|
#
|
4537
4549
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4538
4550
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
4539
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
4551
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
4540
4552
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4541
4553
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions
|
4542
4554
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
@@ -4763,7 +4775,7 @@ module Aws::S3
|
|
4763
4775
|
# about endpoints in Availability Zones, see [Regional and Zonal
|
4764
4776
|
# endpoints for directory buckets in Availability Zones][1] in the
|
4765
4777
|
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
4766
|
-
# Zones, see [
|
4778
|
+
# Zones, see [Concepts for directory buckets in Local Zones][2] in the
|
4767
4779
|
# *Amazon S3 User Guide*.
|
4768
4780
|
#
|
4769
4781
|
# </note>
|
@@ -4820,7 +4832,7 @@ module Aws::S3
|
|
4820
4832
|
#
|
4821
4833
|
#
|
4822
4834
|
#
|
4823
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
4835
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
4824
4836
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
4825
4837
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
4826
4838
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
@@ -5108,13 +5120,13 @@ module Aws::S3
|
|
5108
5120
|
# * **Directory buckets** - For directory buckets, you must make
|
5109
5121
|
# requests for this API operation to the Zonal endpoint. These
|
5110
5122
|
# endpoints support virtual-hosted-style requests in the format
|
5111
|
-
# `https://bucket
|
5123
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
5112
5124
|
# `. Path-style requests are not supported. For more information about
|
5113
5125
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
5114
5126
|
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
5115
5127
|
# User Guide*. For more information about endpoints in Local Zones,
|
5116
|
-
# see [
|
5117
|
-
# S3 User Guide*.
|
5128
|
+
# see [Concepts for directory buckets in Local Zones][4] in the
|
5129
|
+
# *Amazon S3 User Guide*.
|
5118
5130
|
#
|
5119
5131
|
# </note>
|
5120
5132
|
#
|
@@ -5187,7 +5199,7 @@ module Aws::S3
|
|
5187
5199
|
#
|
5188
5200
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html
|
5189
5201
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html
|
5190
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
5202
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
5191
5203
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
5192
5204
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html
|
5193
5205
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete
|
@@ -5204,34 +5216,35 @@ module Aws::S3
|
|
5204
5216
|
# requests are not supported. Directory bucket names must be unique in
|
5205
5217
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
5206
5218
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
5207
|
-
#
|
5219
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
5208
5220
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
5209
5221
|
# *Amazon S3 User Guide*.
|
5210
5222
|
#
|
5211
|
-
# **Access points** - When you use this action with an access point
|
5212
|
-
# must provide the alias of the access
|
5213
|
-
#
|
5214
|
-
#
|
5215
|
-
#
|
5223
|
+
# **Access points** - When you use this action with an access point for
|
5224
|
+
# general purpose buckets, you must provide the alias of the access
|
5225
|
+
# point in place of the bucket name or specify the access point ARN.
|
5226
|
+
# When you use this action with an access point for directory buckets,
|
5227
|
+
# you must provide the access point name in place of the bucket name.
|
5228
|
+
# When using the access point ARN, you must direct requests to the
|
5229
|
+
# access point hostname. The access point hostname takes the form
|
5216
5230
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5217
5231
|
# When using this action with an access point through the Amazon Web
|
5218
5232
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
5219
5233
|
# name. For more information about access point ARNs, see [Using access
|
5220
5234
|
# points][2] in the *Amazon S3 User Guide*.
|
5221
5235
|
#
|
5222
|
-
# <note markdown="1">
|
5223
|
-
# directory buckets.
|
5236
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
5224
5237
|
#
|
5225
5238
|
# </note>
|
5226
5239
|
#
|
5227
|
-
# **S3 on Outposts** - When you use this action with
|
5228
|
-
#
|
5229
|
-
#
|
5240
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
5241
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
5242
|
+
# Outposts hostname takes the form `
|
5230
5243
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5231
|
-
# When you use this action with S3 on Outposts
|
5232
|
-
#
|
5233
|
-
#
|
5234
|
-
#
|
5244
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
5245
|
+
# must be the Outposts access point ARN or the access point alias. For
|
5246
|
+
# more information about S3 on Outposts, see [What is S3 on
|
5247
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
5235
5248
|
#
|
5236
5249
|
#
|
5237
5250
|
#
|
@@ -5306,7 +5319,7 @@ module Aws::S3
|
|
5306
5319
|
#
|
5307
5320
|
#
|
5308
5321
|
#
|
5309
|
-
# [1]: https://
|
5322
|
+
# [1]: https://tools.ietf.org/html/rfc7232
|
5310
5323
|
#
|
5311
5324
|
# @option params [Time,DateTime,Date,Integer,String] :if_match_last_modified_time
|
5312
5325
|
# If present, the object is deleted only if its modification times
|
@@ -5341,6 +5354,15 @@ module Aws::S3
|
|
5341
5354
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
5342
5355
|
#
|
5343
5356
|
#
|
5357
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
5358
|
+
#
|
5359
|
+
# # The following example deletes an object from a non-versioned bucket.
|
5360
|
+
#
|
5361
|
+
# resp = client.delete_object({
|
5362
|
+
# bucket: "ExampleBucket",
|
5363
|
+
# key: "HappyFace.jpg",
|
5364
|
+
# })
|
5365
|
+
#
|
5344
5366
|
# @example Example: To delete an object
|
5345
5367
|
#
|
5346
5368
|
# # The following example deletes an object from an S3 bucket.
|
@@ -5354,15 +5376,6 @@ module Aws::S3
|
|
5354
5376
|
# {
|
5355
5377
|
# }
|
5356
5378
|
#
|
5357
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
5358
|
-
#
|
5359
|
-
# # The following example deletes an object from a non-versioned bucket.
|
5360
|
-
#
|
5361
|
-
# resp = client.delete_object({
|
5362
|
-
# bucket: "ExampleBucket",
|
5363
|
-
# key: "HappyFace.jpg",
|
5364
|
-
# })
|
5365
|
-
#
|
5366
5379
|
# @example Request syntax with placeholder values
|
5367
5380
|
#
|
5368
5381
|
# resp = client.delete_object({
|
@@ -5422,25 +5435,27 @@ module Aws::S3
|
|
5422
5435
|
# @option params [required, String] :bucket
|
5423
5436
|
# The bucket name containing the objects from which to remove the tags.
|
5424
5437
|
#
|
5425
|
-
# **Access points** - When you use this action with an access point
|
5426
|
-
# must provide the alias of the access
|
5427
|
-
#
|
5428
|
-
#
|
5429
|
-
#
|
5438
|
+
# **Access points** - When you use this action with an access point for
|
5439
|
+
# general purpose buckets, you must provide the alias of the access
|
5440
|
+
# point in place of the bucket name or specify the access point ARN.
|
5441
|
+
# When you use this action with an access point for directory buckets,
|
5442
|
+
# you must provide the access point name in place of the bucket name.
|
5443
|
+
# When using the access point ARN, you must direct requests to the
|
5444
|
+
# access point hostname. The access point hostname takes the form
|
5430
5445
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5431
5446
|
# When using this action with an access point through the Amazon Web
|
5432
5447
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
5433
5448
|
# name. For more information about access point ARNs, see [Using access
|
5434
5449
|
# points][1] in the *Amazon S3 User Guide*.
|
5435
5450
|
#
|
5436
|
-
# **S3 on Outposts** - When you use this action with
|
5437
|
-
#
|
5438
|
-
#
|
5451
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
5452
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
5453
|
+
# Outposts hostname takes the form `
|
5439
5454
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5440
|
-
# When you use this action with S3 on Outposts
|
5441
|
-
#
|
5442
|
-
#
|
5443
|
-
#
|
5455
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
5456
|
+
# must be the Outposts access point ARN or the access point alias. For
|
5457
|
+
# more information about S3 on Outposts, see [What is S3 on
|
5458
|
+
# Outposts?][2] in the *Amazon S3 User Guide*.
|
5444
5459
|
#
|
5445
5460
|
#
|
5446
5461
|
#
|
@@ -5522,13 +5537,14 @@ module Aws::S3
|
|
5522
5537
|
# to delete, then this operation provides a suitable alternative to
|
5523
5538
|
# sending individual delete requests, reducing per-request overhead.
|
5524
5539
|
#
|
5525
|
-
# The request can contain a list of up to
|
5540
|
+
# The request can contain a list of up to 1,000 keys that you want to
|
5526
5541
|
# delete. In the XML, you provide the object key names, and optionally,
|
5527
5542
|
# version IDs if you want to delete a specific version of the object
|
5528
5543
|
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
5529
5544
|
# delete operation and returns the result of that delete, success or
|
5530
|
-
# failure, in the response.
|
5531
|
-
#
|
5545
|
+
# failure, in the response. If the object specified in the request
|
5546
|
+
# isn't found, Amazon S3 confirms the deletion by returning the result
|
5547
|
+
# as deleted.
|
5532
5548
|
#
|
5533
5549
|
# <note markdown="1"> * **Directory buckets** - S3 Versioning isn't enabled and supported
|
5534
5550
|
# for directory buckets.
|
@@ -5536,13 +5552,13 @@ module Aws::S3
|
|
5536
5552
|
# * **Directory buckets** - For directory buckets, you must make
|
5537
5553
|
# requests for this API operation to the Zonal endpoint. These
|
5538
5554
|
# endpoints support virtual-hosted-style requests in the format
|
5539
|
-
# `https://bucket
|
5555
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
5540
5556
|
# `. Path-style requests are not supported. For more information about
|
5541
5557
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
5542
5558
|
# for directory buckets in Availability Zones][1] in the *Amazon S3
|
5543
5559
|
# User Guide*. For more information about endpoints in Local Zones,
|
5544
|
-
# see [
|
5545
|
-
# S3 User Guide*.
|
5560
|
+
# see [Concepts for directory buckets in Local Zones][2] in the
|
5561
|
+
# *Amazon S3 User Guide*.
|
5546
5562
|
#
|
5547
5563
|
# </note>
|
5548
5564
|
#
|
@@ -5626,7 +5642,7 @@ module Aws::S3
|
|
5626
5642
|
#
|
5627
5643
|
#
|
5628
5644
|
#
|
5629
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
5645
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
5630
5646
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
5631
5647
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
|
5632
5648
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -5645,34 +5661,35 @@ module Aws::S3
|
|
5645
5661
|
# requests are not supported. Directory bucket names must be unique in
|
5646
5662
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
5647
5663
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
5648
|
-
#
|
5664
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
5649
5665
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
5650
5666
|
# *Amazon S3 User Guide*.
|
5651
5667
|
#
|
5652
|
-
# **Access points** - When you use this action with an access point
|
5653
|
-
# must provide the alias of the access
|
5654
|
-
#
|
5655
|
-
#
|
5656
|
-
#
|
5668
|
+
# **Access points** - When you use this action with an access point for
|
5669
|
+
# general purpose buckets, you must provide the alias of the access
|
5670
|
+
# point in place of the bucket name or specify the access point ARN.
|
5671
|
+
# When you use this action with an access point for directory buckets,
|
5672
|
+
# you must provide the access point name in place of the bucket name.
|
5673
|
+
# When using the access point ARN, you must direct requests to the
|
5674
|
+
# access point hostname. The access point hostname takes the form
|
5657
5675
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5658
5676
|
# When using this action with an access point through the Amazon Web
|
5659
5677
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
5660
5678
|
# name. For more information about access point ARNs, see [Using access
|
5661
5679
|
# points][2] in the *Amazon S3 User Guide*.
|
5662
5680
|
#
|
5663
|
-
# <note markdown="1">
|
5664
|
-
# directory buckets.
|
5681
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
5665
5682
|
#
|
5666
5683
|
# </note>
|
5667
5684
|
#
|
5668
|
-
# **S3 on Outposts** - When you use this action with
|
5669
|
-
#
|
5670
|
-
#
|
5685
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
5686
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
5687
|
+
# Outposts hostname takes the form `
|
5671
5688
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
5672
|
-
# When you use this action with S3 on Outposts
|
5673
|
-
#
|
5674
|
-
#
|
5675
|
-
#
|
5689
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
5690
|
+
# must be the Outposts access point ARN or the access point alias. For
|
5691
|
+
# more information about S3 on Outposts, see [What is S3 on
|
5692
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
5676
5693
|
#
|
5677
5694
|
#
|
5678
5695
|
#
|
@@ -5748,15 +5765,15 @@ module Aws::S3
|
|
5748
5765
|
# For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
|
5749
5766
|
# the supported algorithm from the following list:
|
5750
5767
|
#
|
5751
|
-
# * `
|
5768
|
+
# * `CRC32`
|
5752
5769
|
#
|
5753
|
-
# * `
|
5770
|
+
# * `CRC32C`
|
5754
5771
|
#
|
5755
|
-
# * `
|
5772
|
+
# * `CRC64NVME`
|
5756
5773
|
#
|
5757
|
-
# * `
|
5774
|
+
# * `SHA1`
|
5758
5775
|
#
|
5759
|
-
# * `
|
5776
|
+
# * `SHA256`
|
5760
5777
|
#
|
5761
5778
|
# For more information, see [Checking object integrity][1] in the
|
5762
5779
|
# *Amazon S3 User Guide*.
|
@@ -6805,8 +6822,8 @@ module Aws::S3
|
|
6805
6822
|
# information about endpoints in Availability Zones, see [Regional
|
6806
6823
|
# and Zonal endpoints for directory buckets in Availability
|
6807
6824
|
# Zones][5] in the *Amazon S3 User Guide*. For more information
|
6808
|
-
# about endpoints in Local Zones, see [
|
6809
|
-
#
|
6825
|
+
# about endpoints in Local Zones, see [Concepts for directory
|
6826
|
+
# buckets in Local Zones][6] in the *Amazon S3 User Guide*.
|
6810
6827
|
#
|
6811
6828
|
# </note>
|
6812
6829
|
#
|
@@ -6840,7 +6857,7 @@ module Aws::S3
|
|
6840
6857
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
6841
6858
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6842
6859
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
6843
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
6860
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
6844
6861
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
6845
6862
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
6846
6863
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
@@ -7024,7 +7041,7 @@ module Aws::S3
|
|
7024
7041
|
#
|
7025
7042
|
# @example Response structure
|
7026
7043
|
#
|
7027
|
-
# resp.location_constraint #=> String, one of "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"
|
7044
|
+
# resp.location_constraint #=> String, one of "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", "ap-southeast-4", "ap-southeast-5", "ca-central-1", "cn-north-1", "cn-northwest-1", "EU", "eu-central-1", "eu-central-2", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "il-central-1", "me-central-1", "me-south-1", "sa-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2"
|
7028
7045
|
#
|
7029
7046
|
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation AWS API Documentation
|
7030
7047
|
#
|
@@ -7556,7 +7573,7 @@ module Aws::S3
|
|
7556
7573
|
# about endpoints in Availability Zones, see [Regional and Zonal
|
7557
7574
|
# endpoints for directory buckets in Availability Zones][1] in the
|
7558
7575
|
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
7559
|
-
# Zones, see [
|
7576
|
+
# Zones, see [Concepts for directory buckets in Local Zones][2] in the
|
7560
7577
|
# *Amazon S3 User Guide*.
|
7561
7578
|
#
|
7562
7579
|
# </note>
|
@@ -7620,7 +7637,7 @@ module Aws::S3
|
|
7620
7637
|
#
|
7621
7638
|
#
|
7622
7639
|
#
|
7623
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
7640
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
7624
7641
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
7625
7642
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
7626
7643
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
@@ -7653,8 +7670,7 @@ module Aws::S3
|
|
7653
7670
|
# `InvalidAccessPointAliasError` is returned. For more information about
|
7654
7671
|
# `InvalidAccessPointAliasError`, see [List of Error Codes][2].
|
7655
7672
|
#
|
7656
|
-
# <note markdown="1">
|
7657
|
-
# directory buckets.
|
7673
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
7658
7674
|
#
|
7659
7675
|
# </note>
|
7660
7676
|
#
|
@@ -8239,7 +8255,7 @@ module Aws::S3
|
|
8239
8255
|
# **Directory buckets** - Only virtual-hosted-style requests are
|
8240
8256
|
# supported. For a virtual hosted-style request example, if you have the
|
8241
8257
|
# object `photos/2006/February/sample.jpg` in the bucket named
|
8242
|
-
# `
|
8258
|
+
# `amzn-s3-demo-bucket--usw2-az1--x-s3`, specify the object key name as
|
8243
8259
|
# `/photos/2006/February/sample.jpg`. Also, when you make requests to
|
8244
8260
|
# this API operation, your requests are sent to the Zonal endpoint.
|
8245
8261
|
# These endpoints support virtual-hosted-style requests in the format
|
@@ -8248,8 +8264,8 @@ module Aws::S3
|
|
8248
8264
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
8249
8265
|
# directory buckets in Availability Zones][2] in the *Amazon S3 User
|
8250
8266
|
# Guide*. For more information about endpoints in Local Zones, see
|
8251
|
-
# [
|
8252
|
-
# Guide*.
|
8267
|
+
# [Concepts for directory buckets in Local Zones][3] in the *Amazon S3
|
8268
|
+
# User Guide*.
|
8253
8269
|
#
|
8254
8270
|
# Permissions
|
8255
8271
|
# : * **General purpose bucket permissions** - You must have the
|
@@ -8310,10 +8326,12 @@ module Aws::S3
|
|
8310
8326
|
# objects, see [Restoring Archived Objects][7] in the *Amazon S3 User
|
8311
8327
|
# Guide*.
|
8312
8328
|
#
|
8313
|
-
# <b>Directory buckets </b> -
|
8314
|
-
# Express One Zone storage class
|
8315
|
-
#
|
8316
|
-
#
|
8329
|
+
# <b>Directory buckets </b> - Directory buckets only support
|
8330
|
+
# `EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in
|
8331
|
+
# Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent
|
8332
|
+
# Access storage class) in Dedicated Local Zones. Unsupported storage
|
8333
|
+
# class values won't write a destination object and will respond with
|
8334
|
+
# the HTTP status code `400 Bad Request`.
|
8317
8335
|
#
|
8318
8336
|
# Encryption
|
8319
8337
|
#
|
@@ -8385,7 +8403,7 @@ module Aws::S3
|
|
8385
8403
|
#
|
8386
8404
|
#
|
8387
8405
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket
|
8388
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
8406
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
8389
8407
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
8390
8408
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
8391
8409
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -8407,15 +8425,17 @@ module Aws::S3
|
|
8407
8425
|
# requests are not supported. Directory bucket names must be unique in
|
8408
8426
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
8409
8427
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
8410
|
-
#
|
8428
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
8411
8429
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
8412
8430
|
# *Amazon S3 User Guide*.
|
8413
8431
|
#
|
8414
|
-
# **Access points** - When you use this action with an access point
|
8415
|
-
# must provide the alias of the access
|
8416
|
-
#
|
8417
|
-
#
|
8418
|
-
#
|
8432
|
+
# **Access points** - When you use this action with an access point for
|
8433
|
+
# general purpose buckets, you must provide the alias of the access
|
8434
|
+
# point in place of the bucket name or specify the access point ARN.
|
8435
|
+
# When you use this action with an access point for directory buckets,
|
8436
|
+
# you must provide the access point name in place of the bucket name.
|
8437
|
+
# When using the access point ARN, you must direct requests to the
|
8438
|
+
# access point hostname. The access point hostname takes the form
|
8419
8439
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8420
8440
|
# When using this action with an access point through the Amazon Web
|
8421
8441
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -8428,19 +8448,18 @@ module Aws::S3
|
|
8428
8448
|
# takes the form
|
8429
8449
|
# *AccessPointName*-*AccountId*.s3-object-lambda.*Region*.amazonaws.com.
|
8430
8450
|
#
|
8431
|
-
# <note markdown="1">
|
8432
|
-
# directory buckets.
|
8451
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
8433
8452
|
#
|
8434
8453
|
# </note>
|
8435
8454
|
#
|
8436
|
-
# **S3 on Outposts** - When you use this action with
|
8437
|
-
#
|
8438
|
-
#
|
8455
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
8456
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
8457
|
+
# Outposts hostname takes the form `
|
8439
8458
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
8440
|
-
# When you use this action with S3 on Outposts
|
8441
|
-
#
|
8442
|
-
#
|
8443
|
-
#
|
8459
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
8460
|
+
# must be the Outposts access point ARN or the access point alias. For
|
8461
|
+
# more information about S3 on Outposts, see [What is S3 on
|
8462
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
8444
8463
|
#
|
8445
8464
|
#
|
8446
8465
|
#
|
@@ -8690,15 +8709,6 @@ module Aws::S3
|
|
8690
8709
|
# @option params [String] :checksum_mode
|
8691
8710
|
# To retrieve the checksum, this mode must be enabled.
|
8692
8711
|
#
|
8693
|
-
# **General purpose buckets** - In addition, if you enable checksum mode
|
8694
|
-
# and the object is uploaded with a [checksum][1] and encrypted with an
|
8695
|
-
# Key Management Service (KMS) key, you must have permission to use the
|
8696
|
-
# `kms:Decrypt` action to retrieve the checksum.
|
8697
|
-
#
|
8698
|
-
#
|
8699
|
-
#
|
8700
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html
|
8701
|
-
#
|
8702
8712
|
# @return [Types::GetObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8703
8713
|
#
|
8704
8714
|
# * {Types::GetObjectOutput#body #body} => IO
|
@@ -8742,49 +8752,49 @@ module Aws::S3
|
|
8742
8752
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
8743
8753
|
#
|
8744
8754
|
#
|
8745
|
-
# @example Example: To retrieve
|
8755
|
+
# @example Example: To retrieve an object
|
8746
8756
|
#
|
8747
|
-
# # The following example retrieves an object for an S3 bucket.
|
8748
|
-
# # specific byte range.
|
8757
|
+
# # The following example retrieves an object for an S3 bucket.
|
8749
8758
|
#
|
8750
8759
|
# resp = client.get_object({
|
8751
8760
|
# bucket: "examplebucket",
|
8752
|
-
# key: "
|
8753
|
-
# range: "bytes=0-9",
|
8761
|
+
# key: "HappyFace.jpg",
|
8754
8762
|
# })
|
8755
8763
|
#
|
8756
8764
|
# resp.to_h outputs the following:
|
8757
8765
|
# {
|
8758
8766
|
# accept_ranges: "bytes",
|
8759
|
-
# content_length:
|
8760
|
-
#
|
8761
|
-
#
|
8762
|
-
#
|
8763
|
-
# last_modified: Time.parse("2014-10-09T22:57:28.000Z"),
|
8767
|
+
# content_length: 3191,
|
8768
|
+
# content_type: "image/jpeg",
|
8769
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
8770
|
+
# last_modified: Time.parse("2016-12-15T01:19:41.000Z"),
|
8764
8771
|
# metadata: {
|
8765
8772
|
# },
|
8773
|
+
# tag_count: 2,
|
8766
8774
|
# version_id: "null",
|
8767
8775
|
# }
|
8768
8776
|
#
|
8769
|
-
# @example Example: To retrieve an object
|
8777
|
+
# @example Example: To retrieve a byte range of an object
|
8770
8778
|
#
|
8771
|
-
# # The following example retrieves an object for an S3 bucket.
|
8779
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
8780
|
+
# # specific byte range.
|
8772
8781
|
#
|
8773
8782
|
# resp = client.get_object({
|
8774
8783
|
# bucket: "examplebucket",
|
8775
|
-
# key: "
|
8784
|
+
# key: "SampleFile.txt",
|
8785
|
+
# range: "bytes=0-9",
|
8776
8786
|
# })
|
8777
8787
|
#
|
8778
8788
|
# resp.to_h outputs the following:
|
8779
8789
|
# {
|
8780
8790
|
# accept_ranges: "bytes",
|
8781
|
-
# content_length:
|
8782
|
-
#
|
8783
|
-
#
|
8784
|
-
#
|
8791
|
+
# content_length: 10,
|
8792
|
+
# content_range: "bytes 0-9/43",
|
8793
|
+
# content_type: "text/plain",
|
8794
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
8795
|
+
# last_modified: Time.parse("2014-10-09T22:57:28.000Z"),
|
8785
8796
|
# metadata: {
|
8786
8797
|
# },
|
8787
|
-
# tag_count: 2,
|
8788
8798
|
# version_id: "null",
|
8789
8799
|
# }
|
8790
8800
|
#
|
@@ -8942,11 +8952,13 @@ module Aws::S3
|
|
8942
8952
|
# The bucket name that contains the object for which to get the ACL
|
8943
8953
|
# information.
|
8944
8954
|
#
|
8945
|
-
# **Access points** - When you use this action with an access point
|
8946
|
-
# must provide the alias of the access
|
8947
|
-
#
|
8948
|
-
#
|
8949
|
-
#
|
8955
|
+
# **Access points** - When you use this action with an access point for
|
8956
|
+
# general purpose buckets, you must provide the alias of the access
|
8957
|
+
# point in place of the bucket name or specify the access point ARN.
|
8958
|
+
# When you use this action with an access point for directory buckets,
|
8959
|
+
# you must provide the access point name in place of the bucket name.
|
8960
|
+
# When using the access point ARN, you must direct requests to the
|
8961
|
+
# access point hostname. The access point hostname takes the form
|
8950
8962
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
8951
8963
|
# When using this action with an access point through the Amazon Web
|
8952
8964
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -9090,13 +9102,13 @@ module Aws::S3
|
|
9090
9102
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
9091
9103
|
# for this API operation to the Zonal endpoint. These endpoints support
|
9092
9104
|
# virtual-hosted-style requests in the format
|
9093
|
-
# `https://bucket
|
9105
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
9094
9106
|
# `. Path-style requests are not supported. For more information about
|
9095
9107
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
9096
9108
|
# directory buckets in Availability Zones][1] in the *Amazon S3 User
|
9097
9109
|
# Guide*. For more information about endpoints in Local Zones, see
|
9098
|
-
# [
|
9099
|
-
# Guide*.
|
9110
|
+
# [Concepts for directory buckets in Local Zones][2] in the *Amazon S3
|
9111
|
+
# User Guide*.
|
9100
9112
|
#
|
9101
9113
|
# </note>
|
9102
9114
|
#
|
@@ -9245,7 +9257,7 @@ module Aws::S3
|
|
9245
9257
|
#
|
9246
9258
|
#
|
9247
9259
|
#
|
9248
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
9260
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
9249
9261
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
9250
9262
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
9251
9263
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -9271,34 +9283,35 @@ module Aws::S3
|
|
9271
9283
|
# requests are not supported. Directory bucket names must be unique in
|
9272
9284
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
9273
9285
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
9274
|
-
#
|
9286
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
9275
9287
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
9276
9288
|
# *Amazon S3 User Guide*.
|
9277
9289
|
#
|
9278
|
-
# **Access points** - When you use this action with an access point
|
9279
|
-
# must provide the alias of the access
|
9280
|
-
#
|
9281
|
-
#
|
9282
|
-
#
|
9290
|
+
# **Access points** - When you use this action with an access point for
|
9291
|
+
# general purpose buckets, you must provide the alias of the access
|
9292
|
+
# point in place of the bucket name or specify the access point ARN.
|
9293
|
+
# When you use this action with an access point for directory buckets,
|
9294
|
+
# you must provide the access point name in place of the bucket name.
|
9295
|
+
# When using the access point ARN, you must direct requests to the
|
9296
|
+
# access point hostname. The access point hostname takes the form
|
9283
9297
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9284
9298
|
# When using this action with an access point through the Amazon Web
|
9285
9299
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
9286
9300
|
# name. For more information about access point ARNs, see [Using access
|
9287
9301
|
# points][2] in the *Amazon S3 User Guide*.
|
9288
9302
|
#
|
9289
|
-
# <note markdown="1">
|
9290
|
-
# directory buckets.
|
9303
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
9291
9304
|
#
|
9292
9305
|
# </note>
|
9293
9306
|
#
|
9294
|
-
# **S3 on Outposts** - When you use this action with
|
9295
|
-
#
|
9296
|
-
#
|
9307
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
9308
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
9309
|
+
# Outposts hostname takes the form `
|
9297
9310
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
9298
|
-
# When you use this action with S3 on Outposts
|
9299
|
-
#
|
9300
|
-
#
|
9301
|
-
#
|
9311
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
9312
|
+
# must be the Outposts access point ARN or the access point alias. For
|
9313
|
+
# more information about S3 on Outposts, see [What is S3 on
|
9314
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
9302
9315
|
#
|
9303
9316
|
#
|
9304
9317
|
#
|
@@ -9470,11 +9483,13 @@ module Aws::S3
|
|
9470
9483
|
# The bucket name containing the object whose legal hold status you want
|
9471
9484
|
# to retrieve.
|
9472
9485
|
#
|
9473
|
-
# **Access points** - When you use this action with an access point
|
9474
|
-
# must provide the alias of the access
|
9475
|
-
#
|
9476
|
-
#
|
9477
|
-
#
|
9486
|
+
# **Access points** - When you use this action with an access point for
|
9487
|
+
# general purpose buckets, you must provide the alias of the access
|
9488
|
+
# point in place of the bucket name or specify the access point ARN.
|
9489
|
+
# When you use this action with an access point for directory buckets,
|
9490
|
+
# you must provide the access point name in place of the bucket name.
|
9491
|
+
# When using the access point ARN, you must direct requests to the
|
9492
|
+
# access point hostname. The access point hostname takes the form
|
9478
9493
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9479
9494
|
# When using this action with an access point through the Amazon Web
|
9480
9495
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -9565,11 +9580,13 @@ module Aws::S3
|
|
9565
9580
|
# @option params [required, String] :bucket
|
9566
9581
|
# The bucket whose Object Lock configuration you want to retrieve.
|
9567
9582
|
#
|
9568
|
-
# **Access points** - When you use this action with an access point
|
9569
|
-
# must provide the alias of the access
|
9570
|
-
#
|
9571
|
-
#
|
9572
|
-
#
|
9583
|
+
# **Access points** - When you use this action with an access point for
|
9584
|
+
# general purpose buckets, you must provide the alias of the access
|
9585
|
+
# point in place of the bucket name or specify the access point ARN.
|
9586
|
+
# When you use this action with an access point for directory buckets,
|
9587
|
+
# you must provide the access point name in place of the bucket name.
|
9588
|
+
# When using the access point ARN, you must direct requests to the
|
9589
|
+
# access point hostname. The access point hostname takes the form
|
9573
9590
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9574
9591
|
# When using this action with an access point through the Amazon Web
|
9575
9592
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -9636,11 +9653,13 @@ module Aws::S3
|
|
9636
9653
|
# The bucket name containing the object whose retention settings you
|
9637
9654
|
# want to retrieve.
|
9638
9655
|
#
|
9639
|
-
# **Access points** - When you use this action with an access point
|
9640
|
-
# must provide the alias of the access
|
9641
|
-
#
|
9642
|
-
#
|
9643
|
-
#
|
9656
|
+
# **Access points** - When you use this action with an access point for
|
9657
|
+
# general purpose buckets, you must provide the alias of the access
|
9658
|
+
# point in place of the bucket name or specify the access point ARN.
|
9659
|
+
# When you use this action with an access point for directory buckets,
|
9660
|
+
# you must provide the access point name in place of the bucket name.
|
9661
|
+
# When using the access point ARN, you must direct requests to the
|
9662
|
+
# access point hostname. The access point hostname takes the form
|
9644
9663
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9645
9664
|
# When using this action with an access point through the Amazon Web
|
9646
9665
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -9748,25 +9767,27 @@ module Aws::S3
|
|
9748
9767
|
# The bucket name containing the object for which to get the tagging
|
9749
9768
|
# information.
|
9750
9769
|
#
|
9751
|
-
# **Access points** - When you use this action with an access point
|
9752
|
-
# must provide the alias of the access
|
9753
|
-
#
|
9754
|
-
#
|
9755
|
-
#
|
9770
|
+
# **Access points** - When you use this action with an access point for
|
9771
|
+
# general purpose buckets, you must provide the alias of the access
|
9772
|
+
# point in place of the bucket name or specify the access point ARN.
|
9773
|
+
# When you use this action with an access point for directory buckets,
|
9774
|
+
# you must provide the access point name in place of the bucket name.
|
9775
|
+
# When using the access point ARN, you must direct requests to the
|
9776
|
+
# access point hostname. The access point hostname takes the form
|
9756
9777
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9757
9778
|
# When using this action with an access point through the Amazon Web
|
9758
9779
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
9759
9780
|
# name. For more information about access point ARNs, see [Using access
|
9760
9781
|
# points][1] in the *Amazon S3 User Guide*.
|
9761
9782
|
#
|
9762
|
-
# **S3 on Outposts** - When you use this action with
|
9763
|
-
#
|
9764
|
-
#
|
9783
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
9784
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
9785
|
+
# Outposts hostname takes the form `
|
9765
9786
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
9766
|
-
# When you use this action with S3 on Outposts
|
9767
|
-
#
|
9768
|
-
#
|
9769
|
-
#
|
9787
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
9788
|
+
# must be the Outposts access point ARN or the access point alias. For
|
9789
|
+
# more information about S3 on Outposts, see [What is S3 on
|
9790
|
+
# Outposts?][2] in the *Amazon S3 User Guide*.
|
9770
9791
|
#
|
9771
9792
|
#
|
9772
9793
|
#
|
@@ -9807,49 +9828,49 @@ module Aws::S3
|
|
9807
9828
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
9808
9829
|
#
|
9809
9830
|
#
|
9810
|
-
# @example Example: To retrieve tag set of
|
9831
|
+
# @example Example: To retrieve tag set of a specific object version
|
9811
9832
|
#
|
9812
|
-
# # The following example retrieves tag set of an object.
|
9833
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
9813
9834
|
#
|
9814
9835
|
# resp = client.get_object_tagging({
|
9815
9836
|
# bucket: "examplebucket",
|
9816
|
-
# key: "
|
9837
|
+
# key: "exampleobject",
|
9838
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
9817
9839
|
# })
|
9818
9840
|
#
|
9819
9841
|
# resp.to_h outputs the following:
|
9820
9842
|
# {
|
9821
9843
|
# tag_set: [
|
9822
9844
|
# {
|
9823
|
-
# key: "
|
9824
|
-
# value: "
|
9825
|
-
# },
|
9826
|
-
# {
|
9827
|
-
# key: "Key3",
|
9828
|
-
# value: "Value3",
|
9845
|
+
# key: "Key1",
|
9846
|
+
# value: "Value1",
|
9829
9847
|
# },
|
9830
9848
|
# ],
|
9831
|
-
# version_id: "
|
9849
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
9832
9850
|
# }
|
9833
9851
|
#
|
9834
|
-
# @example Example: To retrieve tag set of
|
9852
|
+
# @example Example: To retrieve tag set of an object
|
9835
9853
|
#
|
9836
|
-
# # The following example retrieves tag set of an object.
|
9854
|
+
# # The following example retrieves tag set of an object.
|
9837
9855
|
#
|
9838
9856
|
# resp = client.get_object_tagging({
|
9839
9857
|
# bucket: "examplebucket",
|
9840
|
-
# key: "
|
9841
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
9858
|
+
# key: "HappyFace.jpg",
|
9842
9859
|
# })
|
9843
9860
|
#
|
9844
9861
|
# resp.to_h outputs the following:
|
9845
9862
|
# {
|
9846
9863
|
# tag_set: [
|
9847
9864
|
# {
|
9848
|
-
# key: "
|
9849
|
-
# value: "
|
9865
|
+
# key: "Key4",
|
9866
|
+
# value: "Value4",
|
9867
|
+
# },
|
9868
|
+
# {
|
9869
|
+
# key: "Key3",
|
9870
|
+
# value: "Value3",
|
9850
9871
|
# },
|
9851
9872
|
# ],
|
9852
|
-
# version_id: "
|
9873
|
+
# version_id: "null",
|
9853
9874
|
# }
|
9854
9875
|
#
|
9855
9876
|
# @example Request syntax with placeholder values
|
@@ -10119,8 +10140,8 @@ module Aws::S3
|
|
10119
10140
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
10120
10141
|
# for directory buckets in Availability Zones][5] in the *Amazon S3
|
10121
10142
|
# User Guide*. For more information about endpoints in Local Zones,
|
10122
|
-
# see [
|
10123
|
-
# S3 User Guide*.
|
10143
|
+
# see [Concepts for directory buckets in Local Zones][6] in the
|
10144
|
+
# *Amazon S3 User Guide*.
|
10124
10145
|
#
|
10125
10146
|
# </note>
|
10126
10147
|
#
|
@@ -10130,7 +10151,7 @@ module Aws::S3
|
|
10130
10151
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10131
10152
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html
|
10132
10153
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html
|
10133
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
10154
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
10134
10155
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
10135
10156
|
#
|
10136
10157
|
# @option params [required, String] :bucket
|
@@ -10142,15 +10163,17 @@ module Aws::S3
|
|
10142
10163
|
# requests are not supported. Directory bucket names must be unique in
|
10143
10164
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
10144
10165
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
10145
|
-
#
|
10166
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
10146
10167
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
10147
10168
|
# *Amazon S3 User Guide*.
|
10148
10169
|
#
|
10149
|
-
# **Access points** - When you use this action with an access point
|
10150
|
-
# must provide the alias of the access
|
10151
|
-
#
|
10152
|
-
#
|
10153
|
-
#
|
10170
|
+
# **Access points** - When you use this action with an access point for
|
10171
|
+
# general purpose buckets, you must provide the alias of the access
|
10172
|
+
# point in place of the bucket name or specify the access point ARN.
|
10173
|
+
# When you use this action with an access point for directory buckets,
|
10174
|
+
# you must provide the access point name in place of the bucket name.
|
10175
|
+
# When using the access point ARN, you must direct requests to the
|
10176
|
+
# access point hostname. The access point hostname takes the form
|
10154
10177
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10155
10178
|
# When using this action with an access point through the Amazon Web
|
10156
10179
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -10164,19 +10187,18 @@ module Aws::S3
|
|
10164
10187
|
# `InvalidAccessPointAliasError` is returned. For more information about
|
10165
10188
|
# `InvalidAccessPointAliasError`, see [List of Error Codes][3].
|
10166
10189
|
#
|
10167
|
-
# <note markdown="1">
|
10168
|
-
# directory buckets.
|
10190
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
10169
10191
|
#
|
10170
10192
|
# </note>
|
10171
10193
|
#
|
10172
|
-
# **S3 on Outposts** - When you use this action with
|
10173
|
-
#
|
10174
|
-
#
|
10194
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
10195
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
10196
|
+
# Outposts hostname takes the form `
|
10175
10197
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10176
|
-
# When you use this action with S3 on Outposts
|
10177
|
-
#
|
10178
|
-
#
|
10179
|
-
#
|
10198
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
10199
|
+
# must be the Outposts access point ARN or the access point alias. For
|
10200
|
+
# more information about S3 on Outposts, see [What is S3 on
|
10201
|
+
# Outposts?][4] in the *Amazon S3 User Guide*.
|
10180
10202
|
#
|
10181
10203
|
#
|
10182
10204
|
#
|
@@ -10365,13 +10387,13 @@ module Aws::S3
|
|
10365
10387
|
# <note markdown="1"> For directory buckets, you must make requests for this API operation
|
10366
10388
|
# to the Zonal endpoint. These endpoints support virtual-hosted-style
|
10367
10389
|
# requests in the format
|
10368
|
-
# `https://bucket
|
10390
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
10369
10391
|
# `. Path-style requests are not supported. For more information about
|
10370
10392
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
10371
10393
|
# for directory buckets in Availability Zones][6] in the *Amazon S3
|
10372
10394
|
# User Guide*. For more information about endpoints in Local Zones,
|
10373
|
-
# see [
|
10374
|
-
# S3 User Guide*.
|
10395
|
+
# see [Concepts for directory buckets in Local Zones][7] in the
|
10396
|
+
# *Amazon S3 User Guide*.
|
10375
10397
|
#
|
10376
10398
|
# </note>
|
10377
10399
|
#
|
@@ -10388,7 +10410,7 @@ module Aws::S3
|
|
10388
10410
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
10389
10411
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
10390
10412
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-serv-side-encryption.html
|
10391
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
10413
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
10392
10414
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
10393
10415
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
10394
10416
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html
|
@@ -10402,34 +10424,35 @@ module Aws::S3
|
|
10402
10424
|
# requests are not supported. Directory bucket names must be unique in
|
10403
10425
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
10404
10426
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
10405
|
-
#
|
10427
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
10406
10428
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
10407
10429
|
# *Amazon S3 User Guide*.
|
10408
10430
|
#
|
10409
|
-
# **Access points** - When you use this action with an access point
|
10410
|
-
# must provide the alias of the access
|
10411
|
-
#
|
10412
|
-
#
|
10413
|
-
#
|
10431
|
+
# **Access points** - When you use this action with an access point for
|
10432
|
+
# general purpose buckets, you must provide the alias of the access
|
10433
|
+
# point in place of the bucket name or specify the access point ARN.
|
10434
|
+
# When you use this action with an access point for directory buckets,
|
10435
|
+
# you must provide the access point name in place of the bucket name.
|
10436
|
+
# When using the access point ARN, you must direct requests to the
|
10437
|
+
# access point hostname. The access point hostname takes the form
|
10414
10438
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10415
10439
|
# When using this action with an access point through the Amazon Web
|
10416
10440
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
10417
10441
|
# name. For more information about access point ARNs, see [Using access
|
10418
10442
|
# points][2] in the *Amazon S3 User Guide*.
|
10419
10443
|
#
|
10420
|
-
# <note markdown="1">
|
10421
|
-
# directory buckets.
|
10444
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
10422
10445
|
#
|
10423
10446
|
# </note>
|
10424
10447
|
#
|
10425
|
-
# **S3 on Outposts** - When you use this action with
|
10426
|
-
#
|
10427
|
-
#
|
10448
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
10449
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
10450
|
+
# Outposts hostname takes the form `
|
10428
10451
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
10429
|
-
# When you use this action with S3 on Outposts
|
10430
|
-
#
|
10431
|
-
#
|
10432
|
-
#
|
10452
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
10453
|
+
# must be the Outposts access point ARN or the access point alias. For
|
10454
|
+
# more information about S3 on Outposts, see [What is S3 on
|
10455
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
10433
10456
|
#
|
10434
10457
|
#
|
10435
10458
|
#
|
@@ -10645,6 +10668,7 @@ module Aws::S3
|
|
10645
10668
|
# * {Types::HeadObjectOutput#content_encoding #content_encoding} => String
|
10646
10669
|
# * {Types::HeadObjectOutput#content_language #content_language} => String
|
10647
10670
|
# * {Types::HeadObjectOutput#content_type #content_type} => String
|
10671
|
+
# * {Types::HeadObjectOutput#content_range #content_range} => String
|
10648
10672
|
# * {Types::HeadObjectOutput#expires #expires} => Time
|
10649
10673
|
# * {Types::HeadObjectOutput#expires_string #expires_string} => String
|
10650
10674
|
# * {Types::HeadObjectOutput#website_redirect_location #website_redirect_location} => String
|
@@ -10733,6 +10757,7 @@ module Aws::S3
|
|
10733
10757
|
# resp.content_encoding #=> String
|
10734
10758
|
# resp.content_language #=> String
|
10735
10759
|
# resp.content_type #=> String
|
10760
|
+
# resp.content_range #=> String
|
10736
10761
|
# resp.expires #=> Time
|
10737
10762
|
# resp.expires_string #=> String
|
10738
10763
|
# resp.website_redirect_location #=> String
|
@@ -11314,7 +11339,7 @@ module Aws::S3
|
|
11314
11339
|
# about endpoints in Availability Zones, see [Regional and Zonal
|
11315
11340
|
# endpoints for directory buckets in Availability Zones][2] in the
|
11316
11341
|
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
11317
|
-
# Zones, see [
|
11342
|
+
# Zones, see [Concepts for directory buckets in Local Zones][3] in the
|
11318
11343
|
# *Amazon S3 User Guide*.
|
11319
11344
|
#
|
11320
11345
|
# </note>
|
@@ -11343,7 +11368,7 @@ module Aws::S3
|
|
11343
11368
|
#
|
11344
11369
|
#
|
11345
11370
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html
|
11346
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
11371
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
11347
11372
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
11348
11373
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
11349
11374
|
#
|
@@ -11433,13 +11458,13 @@ module Aws::S3
|
|
11433
11458
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
11434
11459
|
# for this API operation to the Zonal endpoint. These endpoints support
|
11435
11460
|
# virtual-hosted-style requests in the format
|
11436
|
-
# `https://bucket
|
11461
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
11437
11462
|
# `. Path-style requests are not supported. For more information about
|
11438
11463
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
11439
11464
|
# directory buckets in Availability Zones][2] in the *Amazon S3 User
|
11440
11465
|
# Guide*. For more information about endpoints in Local Zones, see
|
11441
|
-
# [
|
11442
|
-
# Guide*.
|
11466
|
+
# [Concepts for directory buckets in Local Zones][3] in the *Amazon S3
|
11467
|
+
# User Guide*.
|
11443
11468
|
#
|
11444
11469
|
# </note>
|
11445
11470
|
#
|
@@ -11500,7 +11525,7 @@ module Aws::S3
|
|
11500
11525
|
#
|
11501
11526
|
#
|
11502
11527
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
11503
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
11528
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
11504
11529
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
11505
11530
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
11506
11531
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -11519,34 +11544,35 @@ module Aws::S3
|
|
11519
11544
|
# requests are not supported. Directory bucket names must be unique in
|
11520
11545
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
11521
11546
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
11522
|
-
#
|
11547
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
11523
11548
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
11524
11549
|
# *Amazon S3 User Guide*.
|
11525
11550
|
#
|
11526
|
-
# **Access points** - When you use this action with an access point
|
11527
|
-
# must provide the alias of the access
|
11528
|
-
#
|
11529
|
-
#
|
11530
|
-
#
|
11551
|
+
# **Access points** - When you use this action with an access point for
|
11552
|
+
# general purpose buckets, you must provide the alias of the access
|
11553
|
+
# point in place of the bucket name or specify the access point ARN.
|
11554
|
+
# When you use this action with an access point for directory buckets,
|
11555
|
+
# you must provide the access point name in place of the bucket name.
|
11556
|
+
# When using the access point ARN, you must direct requests to the
|
11557
|
+
# access point hostname. The access point hostname takes the form
|
11531
11558
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11532
11559
|
# When using this action with an access point through the Amazon Web
|
11533
11560
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
11534
11561
|
# name. For more information about access point ARNs, see [Using access
|
11535
11562
|
# points][2] in the *Amazon S3 User Guide*.
|
11536
11563
|
#
|
11537
|
-
# <note markdown="1">
|
11538
|
-
# directory buckets.
|
11564
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
11539
11565
|
#
|
11540
11566
|
# </note>
|
11541
11567
|
#
|
11542
|
-
# **S3 on Outposts** - When you use this action with
|
11543
|
-
#
|
11544
|
-
#
|
11568
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
11569
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
11570
|
+
# Outposts hostname takes the form `
|
11545
11571
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
11546
|
-
# When you use this action with S3 on Outposts
|
11547
|
-
#
|
11548
|
-
#
|
11549
|
-
#
|
11572
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
11573
|
+
# must be the Outposts access point ARN or the access point alias. For
|
11574
|
+
# more information about S3 on Outposts, see [What is S3 on
|
11575
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
11550
11576
|
#
|
11551
11577
|
#
|
11552
11578
|
#
|
@@ -12117,34 +12143,35 @@ module Aws::S3
|
|
12117
12143
|
# requests are not supported. Directory bucket names must be unique in
|
12118
12144
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
12119
12145
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
12120
|
-
#
|
12146
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
12121
12147
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
12122
12148
|
# *Amazon S3 User Guide*.
|
12123
12149
|
#
|
12124
|
-
# **Access points** - When you use this action with an access point
|
12125
|
-
# must provide the alias of the access
|
12126
|
-
#
|
12127
|
-
#
|
12128
|
-
#
|
12150
|
+
# **Access points** - When you use this action with an access point for
|
12151
|
+
# general purpose buckets, you must provide the alias of the access
|
12152
|
+
# point in place of the bucket name or specify the access point ARN.
|
12153
|
+
# When you use this action with an access point for directory buckets,
|
12154
|
+
# you must provide the access point name in place of the bucket name.
|
12155
|
+
# When using the access point ARN, you must direct requests to the
|
12156
|
+
# access point hostname. The access point hostname takes the form
|
12129
12157
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12130
12158
|
# When using this action with an access point through the Amazon Web
|
12131
12159
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
12132
12160
|
# name. For more information about access point ARNs, see [Using access
|
12133
12161
|
# points][2] in the *Amazon S3 User Guide*.
|
12134
12162
|
#
|
12135
|
-
# <note markdown="1">
|
12136
|
-
# directory buckets.
|
12163
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
12137
12164
|
#
|
12138
12165
|
# </note>
|
12139
12166
|
#
|
12140
|
-
# **S3 on Outposts** - When you use this action with
|
12141
|
-
#
|
12142
|
-
#
|
12167
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
12168
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
12169
|
+
# Outposts hostname takes the form `
|
12143
12170
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12144
|
-
# When you use this action with S3 on Outposts
|
12145
|
-
#
|
12146
|
-
#
|
12147
|
-
#
|
12171
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
12172
|
+
# must be the Outposts access point ARN or the access point alias. For
|
12173
|
+
# more information about S3 on Outposts, see [What is S3 on
|
12174
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
12148
12175
|
#
|
12149
12176
|
#
|
12150
12177
|
#
|
@@ -12329,13 +12356,13 @@ module Aws::S3
|
|
12329
12356
|
# * **Directory buckets** - For directory buckets, you must make
|
12330
12357
|
# requests for this API operation to the Zonal endpoint. These
|
12331
12358
|
# endpoints support virtual-hosted-style requests in the format
|
12332
|
-
# `https://bucket
|
12359
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
12333
12360
|
# `. Path-style requests are not supported. For more information about
|
12334
12361
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
12335
12362
|
# for directory buckets in Availability Zones][3] in the *Amazon S3
|
12336
12363
|
# User Guide*. For more information about endpoints in Local Zones,
|
12337
|
-
# see [
|
12338
|
-
# S3 User Guide*.
|
12364
|
+
# see [Concepts for directory buckets in Local Zones][4] in the
|
12365
|
+
# *Amazon S3 User Guide*.
|
12339
12366
|
#
|
12340
12367
|
# </note>
|
12341
12368
|
#
|
@@ -12393,7 +12420,7 @@ module Aws::S3
|
|
12393
12420
|
#
|
12394
12421
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html
|
12395
12422
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
12396
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
12423
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
12397
12424
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
12398
12425
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12399
12426
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
@@ -12410,34 +12437,35 @@ module Aws::S3
|
|
12410
12437
|
# requests are not supported. Directory bucket names must be unique in
|
12411
12438
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
12412
12439
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
12413
|
-
#
|
12440
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
12414
12441
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
12415
12442
|
# *Amazon S3 User Guide*.
|
12416
12443
|
#
|
12417
|
-
# **Access points** - When you use this action with an access point
|
12418
|
-
# must provide the alias of the access
|
12419
|
-
#
|
12420
|
-
#
|
12421
|
-
#
|
12444
|
+
# **Access points** - When you use this action with an access point for
|
12445
|
+
# general purpose buckets, you must provide the alias of the access
|
12446
|
+
# point in place of the bucket name or specify the access point ARN.
|
12447
|
+
# When you use this action with an access point for directory buckets,
|
12448
|
+
# you must provide the access point name in place of the bucket name.
|
12449
|
+
# When using the access point ARN, you must direct requests to the
|
12450
|
+
# access point hostname. The access point hostname takes the form
|
12422
12451
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12423
12452
|
# When using this action with an access point through the Amazon Web
|
12424
12453
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
12425
12454
|
# name. For more information about access point ARNs, see [Using access
|
12426
12455
|
# points][2] in the *Amazon S3 User Guide*.
|
12427
12456
|
#
|
12428
|
-
# <note markdown="1">
|
12429
|
-
# directory buckets.
|
12457
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
12430
12458
|
#
|
12431
12459
|
# </note>
|
12432
12460
|
#
|
12433
|
-
# **S3 on Outposts** - When you use this action with
|
12434
|
-
#
|
12435
|
-
#
|
12461
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
12462
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
12463
|
+
# Outposts hostname takes the form `
|
12436
12464
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12437
|
-
# When you use this action with S3 on Outposts
|
12438
|
-
#
|
12439
|
-
#
|
12440
|
-
#
|
12465
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
12466
|
+
# must be the Outposts access point ARN or the access point alias. For
|
12467
|
+
# more information about S3 on Outposts, see [What is S3 on
|
12468
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
12441
12469
|
#
|
12442
12470
|
#
|
12443
12471
|
#
|
@@ -12678,13 +12706,13 @@ module Aws::S3
|
|
12678
12706
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
12679
12707
|
# for this API operation to the Zonal endpoint. These endpoints support
|
12680
12708
|
# virtual-hosted-style requests in the format
|
12681
|
-
# `https://bucket
|
12709
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
12682
12710
|
# `. Path-style requests are not supported. For more information about
|
12683
12711
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
12684
12712
|
# directory buckets in Availability Zones][3] in the *Amazon S3 User
|
12685
12713
|
# Guide*. For more information about endpoints in Local Zones, see
|
12686
|
-
# [
|
12687
|
-
# Guide*.
|
12714
|
+
# [Concepts for directory buckets in Local Zones][4] in the *Amazon S3
|
12715
|
+
# User Guide*.
|
12688
12716
|
#
|
12689
12717
|
# </note>
|
12690
12718
|
#
|
@@ -12738,7 +12766,7 @@ module Aws::S3
|
|
12738
12766
|
#
|
12739
12767
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
12740
12768
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
12741
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
12769
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
12742
12770
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
12743
12771
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
12744
12772
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
@@ -12757,34 +12785,35 @@ module Aws::S3
|
|
12757
12785
|
# requests are not supported. Directory bucket names must be unique in
|
12758
12786
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
12759
12787
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
12760
|
-
#
|
12788
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
12761
12789
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
12762
12790
|
# *Amazon S3 User Guide*.
|
12763
12791
|
#
|
12764
|
-
# **Access points** - When you use this action with an access point
|
12765
|
-
# must provide the alias of the access
|
12766
|
-
#
|
12767
|
-
#
|
12768
|
-
#
|
12792
|
+
# **Access points** - When you use this action with an access point for
|
12793
|
+
# general purpose buckets, you must provide the alias of the access
|
12794
|
+
# point in place of the bucket name or specify the access point ARN.
|
12795
|
+
# When you use this action with an access point for directory buckets,
|
12796
|
+
# you must provide the access point name in place of the bucket name.
|
12797
|
+
# When using the access point ARN, you must direct requests to the
|
12798
|
+
# access point hostname. The access point hostname takes the form
|
12769
12799
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12770
12800
|
# When using this action with an access point through the Amazon Web
|
12771
12801
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
12772
12802
|
# name. For more information about access point ARNs, see [Using access
|
12773
12803
|
# points][2] in the *Amazon S3 User Guide*.
|
12774
12804
|
#
|
12775
|
-
# <note markdown="1">
|
12776
|
-
# directory buckets.
|
12805
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
12777
12806
|
#
|
12778
12807
|
# </note>
|
12779
12808
|
#
|
12780
|
-
# **S3 on Outposts** - When you use this action with
|
12781
|
-
#
|
12782
|
-
#
|
12809
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
12810
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
12811
|
+
# Outposts hostname takes the form `
|
12783
12812
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
12784
|
-
# When you use this action with S3 on Outposts
|
12785
|
-
#
|
12786
|
-
#
|
12787
|
-
#
|
12813
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
12814
|
+
# must be the Outposts access point ARN or the access point alias. For
|
12815
|
+
# more information about S3 on Outposts, see [What is S3 on
|
12816
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
12788
12817
|
#
|
12789
12818
|
#
|
12790
12819
|
#
|
@@ -13045,7 +13074,7 @@ module Aws::S3
|
|
13045
13074
|
# fails with the HTTP status code `403 Forbidden` (access denied).
|
13046
13075
|
#
|
13047
13076
|
# @option params [String] :checksum_algorithm
|
13048
|
-
# Indicates the algorithm used to create the checksum for the
|
13077
|
+
# Indicates the algorithm used to create the checksum for the request
|
13049
13078
|
# when you use the SDK. This header will not provide any additional
|
13050
13079
|
# functionality if you don't use the SDK. When you send this header,
|
13051
13080
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -13280,7 +13309,7 @@ module Aws::S3
|
|
13280
13309
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
13281
13310
|
#
|
13282
13311
|
# @option params [String] :checksum_algorithm
|
13283
|
-
# Indicates the algorithm used to create the checksum for the
|
13312
|
+
# Indicates the algorithm used to create the checksum for the request
|
13284
13313
|
# when you use the SDK. This header will not provide any additional
|
13285
13314
|
# functionality if you don't use the SDK. When you send this header,
|
13286
13315
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -13596,7 +13625,7 @@ module Aws::S3
|
|
13596
13625
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
13597
13626
|
#
|
13598
13627
|
# @option params [String] :checksum_algorithm
|
13599
|
-
# Indicates the algorithm used to create the checksum for the
|
13628
|
+
# Indicates the algorithm used to create the checksum for the request
|
13600
13629
|
# when you use the SDK. This header will not provide any additional
|
13601
13630
|
# functionality if you don't use the SDK. When you send this header,
|
13602
13631
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -13703,7 +13732,7 @@ module Aws::S3
|
|
13703
13732
|
# about endpoints in Availability Zones, see [Regional and Zonal
|
13704
13733
|
# endpoints for directory buckets in Availability Zones][1] in the
|
13705
13734
|
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
13706
|
-
# Zones, see [
|
13735
|
+
# Zones, see [Concepts for directory buckets in Local Zones][2] in the
|
13707
13736
|
# *Amazon S3 User Guide*.
|
13708
13737
|
#
|
13709
13738
|
# </note>
|
@@ -13740,8 +13769,8 @@ module Aws::S3
|
|
13740
13769
|
# object uploads][5].
|
13741
13770
|
#
|
13742
13771
|
# * Your SSE-KMS configuration can only support 1 [customer managed
|
13743
|
-
# key][6] per directory bucket
|
13744
|
-
#
|
13772
|
+
# key][6] per directory bucket's lifetime. The [Amazon Web Services
|
13773
|
+
# managed key][7] (`aws/s3`) isn't supported.
|
13745
13774
|
#
|
13746
13775
|
# * S3 Bucket Keys are always enabled for `GET` and `PUT` operations
|
13747
13776
|
# in a directory bucket and can’t be disabled. S3 Bucket Keys
|
@@ -13811,7 +13840,7 @@ module Aws::S3
|
|
13811
13840
|
#
|
13812
13841
|
#
|
13813
13842
|
#
|
13814
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
13843
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
13815
13844
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
13816
13845
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
13817
13846
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
@@ -13861,7 +13890,7 @@ module Aws::S3
|
|
13861
13890
|
# </note>
|
13862
13891
|
#
|
13863
13892
|
# @option params [String] :checksum_algorithm
|
13864
|
-
# Indicates the algorithm used to create the checksum for the
|
13893
|
+
# Indicates the algorithm used to create the checksum for the request
|
13865
13894
|
# when you use the SDK. This header will not provide any additional
|
13866
13895
|
# functionality if you don't use the SDK. When you send this header,
|
13867
13896
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -14285,7 +14314,7 @@ module Aws::S3
|
|
14285
14314
|
# automatically.
|
14286
14315
|
#
|
14287
14316
|
# @option params [String] :checksum_algorithm
|
14288
|
-
# Indicates the algorithm used to create the checksum for the
|
14317
|
+
# Indicates the algorithm used to create the checksum for the request
|
14289
14318
|
# when you use the SDK. This header will not provide any additional
|
14290
14319
|
# functionality if you don't use the SDK. When you send this header,
|
14291
14320
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -14460,8 +14489,8 @@ module Aws::S3
|
|
14460
14489
|
# information about endpoints in Availability Zones, see [Regional
|
14461
14490
|
# and Zonal endpoints for directory buckets in Availability
|
14462
14491
|
# Zones][7] in the *Amazon S3 User Guide*. For more information
|
14463
|
-
# about endpoints in Local Zones, see [
|
14464
|
-
#
|
14492
|
+
# about endpoints in Local Zones, see [Concepts for directory
|
14493
|
+
# buckets in Local Zones][8] in the *Amazon S3 User Guide*.
|
14465
14494
|
#
|
14466
14495
|
# </note>
|
14467
14496
|
#
|
@@ -14483,7 +14512,7 @@ module Aws::S3
|
|
14483
14512
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
14484
14513
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
14485
14514
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
14486
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
14515
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
14487
14516
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
14488
14517
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
14489
14518
|
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
@@ -14492,7 +14521,7 @@ module Aws::S3
|
|
14492
14521
|
# The name of the bucket for which to set the configuration.
|
14493
14522
|
#
|
14494
14523
|
# @option params [String] :checksum_algorithm
|
14495
|
-
# Indicates the algorithm used to create the checksum for the
|
14524
|
+
# Indicates the algorithm used to create the checksum for the request
|
14496
14525
|
# when you use the SDK. This header will not provide any additional
|
14497
14526
|
# functionality if you don't use the SDK. When you send this header,
|
14498
14527
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -14745,7 +14774,7 @@ module Aws::S3
|
|
14745
14774
|
# automatically.
|
14746
14775
|
#
|
14747
14776
|
# @option params [String] :checksum_algorithm
|
14748
|
-
# Indicates the algorithm used to create the checksum for the
|
14777
|
+
# Indicates the algorithm used to create the checksum for the request
|
14749
14778
|
# when you use the SDK. This header will not provide any additional
|
14750
14779
|
# functionality if you don't use the SDK. When you send this header,
|
14751
14780
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -14961,7 +14990,7 @@ module Aws::S3
|
|
14961
14990
|
# automatically.
|
14962
14991
|
#
|
14963
14992
|
# @option params [String] :checksum_algorithm
|
14964
|
-
# Indicates the algorithm used to create the checksum for the
|
14993
|
+
# Indicates the algorithm used to create the checksum for the request
|
14965
14994
|
# when you use the SDK. This header will not provide any additional
|
14966
14995
|
# functionality if you don't use the SDK. When you send this header,
|
14967
14996
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -15288,7 +15317,7 @@ module Aws::S3
|
|
15288
15317
|
# about endpoints in Availability Zones, see [Regional and Zonal
|
15289
15318
|
# endpoints for directory buckets in Availability Zones][1] in the
|
15290
15319
|
# *Amazon S3 User Guide*. For more information about endpoints in Local
|
15291
|
-
# Zones, see [
|
15320
|
+
# Zones, see [Concepts for directory buckets in Local Zones][2] in the
|
15292
15321
|
# *Amazon S3 User Guide*.
|
15293
15322
|
#
|
15294
15323
|
# </note>
|
@@ -15352,7 +15381,7 @@ module Aws::S3
|
|
15352
15381
|
#
|
15353
15382
|
#
|
15354
15383
|
#
|
15355
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
15384
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
15356
15385
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
15357
15386
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
15358
15387
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html
|
@@ -15391,7 +15420,7 @@ module Aws::S3
|
|
15391
15420
|
# </note>
|
15392
15421
|
#
|
15393
15422
|
# @option params [String] :checksum_algorithm
|
15394
|
-
# Indicates the algorithm used to create the checksum for the
|
15423
|
+
# Indicates the algorithm used to create the checksum for the request
|
15395
15424
|
# when you use the SDK. This header will not provide any additional
|
15396
15425
|
# functionality if you don't use the SDK. When you send this header,
|
15397
15426
|
# there must be a corresponding `x-amz-checksum-algorithm ` or
|
@@ -15401,15 +15430,15 @@ module Aws::S3
|
|
15401
15430
|
# For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
|
15402
15431
|
# the supported algorithm from the following list:
|
15403
15432
|
#
|
15404
|
-
# * `
|
15433
|
+
# * `CRC32`
|
15405
15434
|
#
|
15406
|
-
# * `
|
15435
|
+
# * `CRC32C`
|
15407
15436
|
#
|
15408
|
-
# * `
|
15437
|
+
# * `CRC64NVME`
|
15409
15438
|
#
|
15410
|
-
# * `
|
15439
|
+
# * `SHA1`
|
15411
15440
|
#
|
15412
|
-
# * `
|
15441
|
+
# * `SHA256`
|
15413
15442
|
#
|
15414
15443
|
# For more information, see [Checking object integrity][1] in the
|
15415
15444
|
# *Amazon S3 User Guide*.
|
@@ -15589,7 +15618,7 @@ module Aws::S3
|
|
15589
15618
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
15590
15619
|
#
|
15591
15620
|
# @option params [String] :checksum_algorithm
|
15592
|
-
# Indicates the algorithm used to create the checksum for the
|
15621
|
+
# Indicates the algorithm used to create the checksum for the request
|
15593
15622
|
# when you use the SDK. This header will not provide any additional
|
15594
15623
|
# functionality if you don't use the SDK. When you send this header,
|
15595
15624
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -15762,7 +15791,7 @@ module Aws::S3
|
|
15762
15791
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
15763
15792
|
#
|
15764
15793
|
# @option params [String] :checksum_algorithm
|
15765
|
-
# Indicates the algorithm used to create the checksum for the
|
15794
|
+
# Indicates the algorithm used to create the checksum for the request
|
15766
15795
|
# when you use the SDK. This header will not provide any additional
|
15767
15796
|
# functionality if you don't use the SDK. When you send this header,
|
15768
15797
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -15899,7 +15928,7 @@ module Aws::S3
|
|
15899
15928
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
15900
15929
|
#
|
15901
15930
|
# @option params [String] :checksum_algorithm
|
15902
|
-
# Indicates the algorithm used to create the checksum for the
|
15931
|
+
# Indicates the algorithm used to create the checksum for the request
|
15903
15932
|
# when you use the SDK. This header will not provide any additional
|
15904
15933
|
# functionality if you don't use the SDK. When you send this header,
|
15905
15934
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -16047,7 +16076,7 @@ module Aws::S3
|
|
16047
16076
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
16048
16077
|
#
|
16049
16078
|
# @option params [String] :checksum_algorithm
|
16050
|
-
# Indicates the algorithm used to create the checksum for the
|
16079
|
+
# Indicates the algorithm used to create the checksum for the request
|
16051
16080
|
# when you use the SDK. This header will not provide any additional
|
16052
16081
|
# functionality if you don't use the SDK. When you send this header,
|
16053
16082
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -16208,7 +16237,7 @@ module Aws::S3
|
|
16208
16237
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
16209
16238
|
#
|
16210
16239
|
# @option params [String] :checksum_algorithm
|
16211
|
-
# Indicates the algorithm used to create the checksum for the
|
16240
|
+
# Indicates the algorithm used to create the checksum for the request
|
16212
16241
|
# when you use the SDK. This header will not provide any additional
|
16213
16242
|
# functionality if you don't use the SDK. When you send this header,
|
16214
16243
|
# there must be a corresponding `x-amz-checksum` or `x-amz-trailer`
|
@@ -16312,13 +16341,13 @@ module Aws::S3
|
|
16312
16341
|
# * **Directory buckets** - For directory buckets, you must make
|
16313
16342
|
# requests for this API operation to the Zonal endpoint. These
|
16314
16343
|
# endpoints support virtual-hosted-style requests in the format
|
16315
|
-
# `https://bucket
|
16344
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
16316
16345
|
# `. Path-style requests are not supported. For more information about
|
16317
16346
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints
|
16318
16347
|
# for directory buckets in Availability Zones][1] in the *Amazon S3
|
16319
16348
|
# User Guide*. For more information about endpoints in Local Zones,
|
16320
|
-
# see [
|
16321
|
-
# S3 User Guide*.
|
16349
|
+
# see [Concepts for directory buckets in Local Zones][2] in the
|
16350
|
+
# *Amazon S3 User Guide*.
|
16322
16351
|
#
|
16323
16352
|
# </note>
|
16324
16353
|
#
|
@@ -16335,6 +16364,23 @@ module Aws::S3
|
|
16335
16364
|
#
|
16336
16365
|
# </note>
|
16337
16366
|
#
|
16367
|
+
# * **If-None-Match** - Uploads the object only if the object key name
|
16368
|
+
# does not already exist in the specified bucket. Otherwise, Amazon S3
|
16369
|
+
# returns a `412 Precondition Failed` error. If a conflicting
|
16370
|
+
# operation occurs during the upload, S3 returns a `409
|
16371
|
+
# ConditionalRequestConflict` response. On a 409 failure, retry the
|
16372
|
+
# upload.
|
16373
|
+
#
|
16374
|
+
# Expects the * character (asterisk).
|
16375
|
+
#
|
16376
|
+
# For more information, see [Add preconditions to S3 operations with
|
16377
|
+
# conditional requests][4] in the *Amazon S3 User Guide* or [RFC
|
16378
|
+
# 7232][5].
|
16379
|
+
#
|
16380
|
+
# <note markdown="1"> This functionality is not supported for S3 on Outposts.
|
16381
|
+
#
|
16382
|
+
# </note>
|
16383
|
+
#
|
16338
16384
|
# * **S3 Versioning** - When you enable versioning for a bucket, if
|
16339
16385
|
# Amazon S3 receives multiple write requests for the same object
|
16340
16386
|
# simultaneously, it stores all versions of the objects. For each
|
@@ -16342,9 +16388,9 @@ module Aws::S3
|
|
16342
16388
|
# automatically generates a unique version ID of that object being
|
16343
16389
|
# stored in Amazon S3. You can retrieve, replace, or delete any
|
16344
16390
|
# version of the object. For more information about versioning, see
|
16345
|
-
# [Adding Objects to Versioning-Enabled Buckets][
|
16391
|
+
# [Adding Objects to Versioning-Enabled Buckets][6] in the *Amazon S3
|
16346
16392
|
# User Guide*. For information about returning the versioning state of
|
16347
|
-
# a bucket, see [GetBucketVersioning][
|
16393
|
+
# a bucket, see [GetBucketVersioning][7].
|
16348
16394
|
#
|
16349
16395
|
# <note markdown="1"> This functionality is not supported for directory buckets.
|
16350
16396
|
#
|
@@ -16368,7 +16414,7 @@ module Aws::S3
|
|
16368
16414
|
# `s3:PutObjectTagging`.
|
16369
16415
|
# * **Directory bucket permissions** - To grant access to this API
|
16370
16416
|
# operation on a directory bucket, we recommend that you use the [
|
16371
|
-
# `CreateSession` ][
|
16417
|
+
# `CreateSession` ][8] API operation for session-based
|
16372
16418
|
# authorization. Specifically, you grant the
|
16373
16419
|
# `s3express:CreateSession` permission to the directory bucket in a
|
16374
16420
|
# bucket policy or an IAM identity-based policy. Then, you make the
|
@@ -16379,7 +16425,7 @@ module Aws::S3
|
|
16379
16425
|
# token for use. Amazon Web Services CLI or SDKs create session and
|
16380
16426
|
# refresh the session token automatically to avoid service
|
16381
16427
|
# interruptions when a session expires. For more information about
|
16382
|
-
# authorization, see [ `CreateSession` ][
|
16428
|
+
# authorization, see [ `CreateSession` ][8].
|
16383
16429
|
#
|
16384
16430
|
# If the object is encrypted with SSE-KMS, you must also have the
|
16385
16431
|
# `kms:GenerateDataKey` and `kms:Decrypt` permissions in IAM
|
@@ -16404,20 +16450,22 @@ module Aws::S3
|
|
16404
16450
|
#
|
16405
16451
|
# For more information about related Amazon S3 APIs, see the following:
|
16406
16452
|
#
|
16407
|
-
# * [CopyObject][
|
16453
|
+
# * [CopyObject][9]
|
16408
16454
|
#
|
16409
|
-
# * [DeleteObject][
|
16455
|
+
# * [DeleteObject][10]
|
16410
16456
|
#
|
16411
16457
|
#
|
16412
16458
|
#
|
16413
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
16459
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
16414
16460
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
16415
16461
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
16416
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
16417
|
-
# [5]: https://
|
16418
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
16419
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
16420
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
16462
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
|
16463
|
+
# [5]: https://datatracker.ietf.org/doc/rfc7232/
|
16464
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
|
16465
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html
|
16466
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html
|
16467
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
|
16468
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
16421
16469
|
#
|
16422
16470
|
# @option params [String] :acl
|
16423
16471
|
# The canned ACL to apply to the object. For more information, see
|
@@ -16469,34 +16517,35 @@ module Aws::S3
|
|
16469
16517
|
# requests are not supported. Directory bucket names must be unique in
|
16470
16518
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
16471
16519
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
16472
|
-
#
|
16520
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
16473
16521
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
16474
16522
|
# *Amazon S3 User Guide*.
|
16475
16523
|
#
|
16476
|
-
# **Access points** - When you use this action with an access point
|
16477
|
-
# must provide the alias of the access
|
16478
|
-
#
|
16479
|
-
#
|
16480
|
-
#
|
16524
|
+
# **Access points** - When you use this action with an access point for
|
16525
|
+
# general purpose buckets, you must provide the alias of the access
|
16526
|
+
# point in place of the bucket name or specify the access point ARN.
|
16527
|
+
# When you use this action with an access point for directory buckets,
|
16528
|
+
# you must provide the access point name in place of the bucket name.
|
16529
|
+
# When using the access point ARN, you must direct requests to the
|
16530
|
+
# access point hostname. The access point hostname takes the form
|
16481
16531
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
16482
16532
|
# When using this action with an access point through the Amazon Web
|
16483
16533
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
16484
16534
|
# name. For more information about access point ARNs, see [Using access
|
16485
16535
|
# points][2] in the *Amazon S3 User Guide*.
|
16486
16536
|
#
|
16487
|
-
# <note markdown="1">
|
16488
|
-
# directory buckets.
|
16537
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
16489
16538
|
#
|
16490
16539
|
# </note>
|
16491
16540
|
#
|
16492
|
-
# **S3 on Outposts** - When you use this action with
|
16493
|
-
#
|
16494
|
-
#
|
16541
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
16542
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
16543
|
+
# Outposts hostname takes the form `
|
16495
16544
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
16496
|
-
# When you use this action with S3 on Outposts
|
16497
|
-
#
|
16498
|
-
#
|
16499
|
-
#
|
16545
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
16546
|
+
# must be the Outposts access point ARN or the access point alias. For
|
16547
|
+
# more information about S3 on Outposts, see [What is S3 on
|
16548
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
16500
16549
|
#
|
16501
16550
|
#
|
16502
16551
|
#
|
@@ -16590,15 +16639,15 @@ module Aws::S3
|
|
16590
16639
|
# For the `x-amz-checksum-algorithm ` header, replace ` algorithm ` with
|
16591
16640
|
# the supported algorithm from the following list:
|
16592
16641
|
#
|
16593
|
-
# * `
|
16642
|
+
# * `CRC32`
|
16594
16643
|
#
|
16595
|
-
# * `
|
16644
|
+
# * `CRC32C`
|
16596
16645
|
#
|
16597
|
-
# * `
|
16646
|
+
# * `CRC64NVME`
|
16598
16647
|
#
|
16599
|
-
# * `
|
16648
|
+
# * `SHA1`
|
16600
16649
|
#
|
16601
|
-
# * `
|
16650
|
+
# * `SHA256`
|
16602
16651
|
#
|
16603
16652
|
# For more information, see [Checking object integrity][1] in the
|
16604
16653
|
# *Amazon S3 User Guide*.
|
@@ -16627,7 +16676,7 @@ module Aws::S3
|
|
16627
16676
|
# @option params [String] :checksum_crc32
|
16628
16677
|
# This header can be used as a data integrity check to verify that the
|
16629
16678
|
# data received is the same data that was originally sent. This header
|
16630
|
-
# specifies the Base64 encoded, 32-bit `
|
16679
|
+
# specifies the Base64 encoded, 32-bit `CRC32` checksum of the object.
|
16631
16680
|
# For more information, see [Checking object integrity][1] in the
|
16632
16681
|
# *Amazon S3 User Guide*.
|
16633
16682
|
#
|
@@ -16638,7 +16687,7 @@ module Aws::S3
|
|
16638
16687
|
# @option params [String] :checksum_crc32c
|
16639
16688
|
# This header can be used as a data integrity check to verify that the
|
16640
16689
|
# data received is the same data that was originally sent. This header
|
16641
|
-
# specifies the Base64 encoded, 32-bit `
|
16690
|
+
# specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object.
|
16642
16691
|
# For more information, see [Checking object integrity][1] in the
|
16643
16692
|
# *Amazon S3 User Guide*.
|
16644
16693
|
#
|
@@ -16649,10 +16698,10 @@ module Aws::S3
|
|
16649
16698
|
# @option params [String] :checksum_crc64nvme
|
16650
16699
|
# This header can be used as a data integrity check to verify that the
|
16651
16700
|
# data received is the same data that was originally sent. This header
|
16652
|
-
# specifies the Base64 encoded, 64-bit `
|
16653
|
-
# object. The `
|
16654
|
-
#
|
16655
|
-
#
|
16701
|
+
# specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the
|
16702
|
+
# object. The `CRC64NVME` checksum is always a full object checksum. For
|
16703
|
+
# more information, see [Checking object integrity in the Amazon S3 User
|
16704
|
+
# Guide][1].
|
16656
16705
|
#
|
16657
16706
|
#
|
16658
16707
|
#
|
@@ -16661,9 +16710,9 @@ module Aws::S3
|
|
16661
16710
|
# @option params [String] :checksum_sha1
|
16662
16711
|
# This header can be used as a data integrity check to verify that the
|
16663
16712
|
# data received is the same data that was originally sent. This header
|
16664
|
-
# specifies the Base64 encoded, 160-bit `
|
16665
|
-
#
|
16666
|
-
#
|
16713
|
+
# specifies the Base64 encoded, 160-bit `SHA1` digest of the object. For
|
16714
|
+
# more information, see [Checking object integrity][1] in the *Amazon S3
|
16715
|
+
# User Guide*.
|
16667
16716
|
#
|
16668
16717
|
#
|
16669
16718
|
#
|
@@ -16672,7 +16721,7 @@ module Aws::S3
|
|
16672
16721
|
# @option params [String] :checksum_sha256
|
16673
16722
|
# This header can be used as a data integrity check to verify that the
|
16674
16723
|
# data received is the same data that was originally sent. This header
|
16675
|
-
# specifies the Base64 encoded, 256-bit `
|
16724
|
+
# specifies the Base64 encoded, 256-bit `SHA256` digest of the object.
|
16676
16725
|
# For more information, see [Checking object integrity][1] in the
|
16677
16726
|
# *Amazon S3 User Guide*.
|
16678
16727
|
#
|
@@ -16854,8 +16903,9 @@ module Aws::S3
|
|
16854
16903
|
# a different Storage Class. For more information, see [Storage
|
16855
16904
|
# Classes][1] in the *Amazon S3 User Guide*.
|
16856
16905
|
#
|
16857
|
-
# <note markdown="1"> *
|
16858
|
-
#
|
16906
|
+
# <note markdown="1"> * Directory buckets only support `EXPRESS_ONEZONE` (the S3 Express One
|
16907
|
+
# Zone storage class) in Availability Zones and `ONEZONE_IA` (the S3
|
16908
|
+
# One Zone-Infrequent Access storage class) in Dedicated Local Zones.
|
16859
16909
|
#
|
16860
16910
|
# * Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
|
16861
16911
|
#
|
@@ -16938,20 +16988,17 @@ module Aws::S3
|
|
16938
16988
|
# `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the
|
16939
16989
|
# Amazon Web Services managed key (`aws/s3`) to protect the data.
|
16940
16990
|
#
|
16941
|
-
# **Directory buckets** -
|
16942
|
-
#
|
16943
|
-
#
|
16944
|
-
#
|
16945
|
-
#
|
16946
|
-
# x-amz-server-side-encryption-aws-kms-key-id` header
|
16947
|
-
#
|
16948
|
-
#
|
16949
|
-
#
|
16950
|
-
#
|
16951
|
-
#
|
16952
|
-
# support 1 [customer managed key][1] per directory bucket for the
|
16953
|
-
# lifetime of the bucket. The [Amazon Web Services managed key][2]
|
16954
|
-
# (`aws/s3`) isn't supported.
|
16991
|
+
# **Directory buckets** - To encrypt data using SSE-KMS, it's
|
16992
|
+
# recommended to specify the `x-amz-server-side-encryption` header to
|
16993
|
+
# `aws:kms`. Then, the `x-amz-server-side-encryption-aws-kms-key-id`
|
16994
|
+
# header implicitly uses the bucket's default KMS customer managed key
|
16995
|
+
# ID. If you want to explicitly set the `
|
16996
|
+
# x-amz-server-side-encryption-aws-kms-key-id` header, it must match the
|
16997
|
+
# bucket's default customer managed key (using key ID or ARN, not
|
16998
|
+
# alias). Your SSE-KMS configuration can only support 1 [customer
|
16999
|
+
# managed key][1] per directory bucket's lifetime. The [Amazon Web
|
17000
|
+
# Services managed key][2] (`aws/s3`) isn't supported. Incorrect key
|
17001
|
+
# specification results in an HTTP `400 Bad Request` error.
|
16955
17002
|
#
|
16956
17003
|
#
|
16957
17004
|
#
|
@@ -17103,118 +17150,118 @@ module Aws::S3
|
|
17103
17150
|
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
17104
17151
|
# }
|
17105
17152
|
#
|
17106
|
-
# @example Example: To upload an object
|
17153
|
+
# @example Example: To upload an object and specify optional tags
|
17107
17154
|
#
|
17108
|
-
# # The following example uploads an object
|
17109
|
-
# #
|
17155
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
17156
|
+
# # S3 returns version ID of the newly created object.
|
17110
17157
|
#
|
17111
17158
|
# resp = client.put_object({
|
17112
|
-
# body: "HappyFace.jpg",
|
17159
|
+
# body: "c:\\HappyFace.jpg",
|
17113
17160
|
# bucket: "examplebucket",
|
17114
17161
|
# key: "HappyFace.jpg",
|
17162
|
+
# tagging: "key1=value1&key2=value2",
|
17115
17163
|
# })
|
17116
17164
|
#
|
17117
17165
|
# resp.to_h outputs the following:
|
17118
17166
|
# {
|
17119
17167
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17120
|
-
# version_id: "
|
17168
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
17121
17169
|
# }
|
17122
17170
|
#
|
17123
|
-
# @example Example: To upload an object
|
17171
|
+
# @example Example: To upload an object (specify optional headers)
|
17124
17172
|
#
|
17125
|
-
# # The following example uploads an object. The request specifies
|
17126
|
-
# #
|
17173
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
17174
|
+
# # storage class and use server-side encryption.
|
17127
17175
|
#
|
17128
17176
|
# resp = client.put_object({
|
17129
|
-
# body: "
|
17177
|
+
# body: "HappyFace.jpg",
|
17130
17178
|
# bucket: "examplebucket",
|
17131
|
-
# key: "
|
17179
|
+
# key: "HappyFace.jpg",
|
17132
17180
|
# server_side_encryption: "AES256",
|
17133
|
-
#
|
17181
|
+
# storage_class: "STANDARD_IA",
|
17134
17182
|
# })
|
17135
17183
|
#
|
17136
17184
|
# resp.to_h outputs the following:
|
17137
17185
|
# {
|
17138
17186
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17139
17187
|
# server_side_encryption: "AES256",
|
17140
|
-
# version_id: "
|
17188
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
17141
17189
|
# }
|
17142
17190
|
#
|
17143
|
-
# @example Example: To upload object and specify
|
17191
|
+
# @example Example: To upload an object and specify canned ACL.
|
17144
17192
|
#
|
17145
|
-
# # The following example
|
17146
|
-
# # enabled, S3 returns version ID in response.
|
17193
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
17194
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
17147
17195
|
#
|
17148
17196
|
# resp = client.put_object({
|
17197
|
+
# acl: "authenticated-read",
|
17149
17198
|
# body: "filetoupload",
|
17150
17199
|
# bucket: "examplebucket",
|
17151
17200
|
# key: "exampleobject",
|
17152
|
-
# metadata: {
|
17153
|
-
# "metadata1" => "value1",
|
17154
|
-
# "metadata2" => "value2",
|
17155
|
-
# },
|
17156
17201
|
# })
|
17157
17202
|
#
|
17158
17203
|
# resp.to_h outputs the following:
|
17159
17204
|
# {
|
17160
17205
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17161
|
-
# version_id: "
|
17206
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
17162
17207
|
# }
|
17163
17208
|
#
|
17164
|
-
# @example Example: To upload an object and specify
|
17209
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
17165
17210
|
#
|
17166
|
-
# # The following example uploads an object. The request specifies optional
|
17167
|
-
# # S3 returns version ID
|
17211
|
+
# # The following example uploads an object. The request specifies the optional server-side encryption option. The request
|
17212
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
17168
17213
|
#
|
17169
17214
|
# resp = client.put_object({
|
17170
|
-
# body: "
|
17215
|
+
# body: "filetoupload",
|
17171
17216
|
# bucket: "examplebucket",
|
17172
|
-
# key: "
|
17217
|
+
# key: "exampleobject",
|
17218
|
+
# server_side_encryption: "AES256",
|
17173
17219
|
# tagging: "key1=value1&key2=value2",
|
17174
17220
|
# })
|
17175
17221
|
#
|
17176
17222
|
# resp.to_h outputs the following:
|
17177
17223
|
# {
|
17178
17224
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17179
|
-
#
|
17225
|
+
# server_side_encryption: "AES256",
|
17226
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
17180
17227
|
# }
|
17181
17228
|
#
|
17182
|
-
# @example Example: To upload
|
17229
|
+
# @example Example: To upload object and specify user-defined metadata
|
17183
17230
|
#
|
17184
|
-
# # The following example
|
17185
|
-
# #
|
17231
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
17232
|
+
# # enabled, S3 returns version ID in response.
|
17186
17233
|
#
|
17187
17234
|
# resp = client.put_object({
|
17188
|
-
# body: "
|
17235
|
+
# body: "filetoupload",
|
17189
17236
|
# bucket: "examplebucket",
|
17190
|
-
# key: "
|
17191
|
-
#
|
17192
|
-
#
|
17237
|
+
# key: "exampleobject",
|
17238
|
+
# metadata: {
|
17239
|
+
# "metadata1" => "value1",
|
17240
|
+
# "metadata2" => "value2",
|
17241
|
+
# },
|
17193
17242
|
# })
|
17194
17243
|
#
|
17195
17244
|
# resp.to_h outputs the following:
|
17196
17245
|
# {
|
17197
17246
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17198
|
-
#
|
17199
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
17247
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
17200
17248
|
# }
|
17201
17249
|
#
|
17202
|
-
# @example Example: To upload an object
|
17250
|
+
# @example Example: To upload an object
|
17203
17251
|
#
|
17204
|
-
# # The following example uploads
|
17205
|
-
# #
|
17252
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
17253
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
17206
17254
|
#
|
17207
17255
|
# resp = client.put_object({
|
17208
|
-
#
|
17209
|
-
# body: "filetoupload",
|
17256
|
+
# body: "HappyFace.jpg",
|
17210
17257
|
# bucket: "examplebucket",
|
17211
|
-
# key: "
|
17258
|
+
# key: "HappyFace.jpg",
|
17212
17259
|
# })
|
17213
17260
|
#
|
17214
17261
|
# resp.to_h outputs the following:
|
17215
17262
|
# {
|
17216
17263
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
17217
|
-
# version_id: "
|
17264
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
17218
17265
|
# }
|
17219
17266
|
#
|
17220
17267
|
# @example Streaming a file from disk
|
@@ -17483,25 +17530,27 @@ module Aws::S3
|
|
17483
17530
|
# The bucket name that contains the object to which you want to attach
|
17484
17531
|
# the ACL.
|
17485
17532
|
#
|
17486
|
-
# **Access points** - When you use this action with an access point
|
17487
|
-
# must provide the alias of the access
|
17488
|
-
#
|
17489
|
-
#
|
17490
|
-
#
|
17533
|
+
# **Access points** - When you use this action with an access point for
|
17534
|
+
# general purpose buckets, you must provide the alias of the access
|
17535
|
+
# point in place of the bucket name or specify the access point ARN.
|
17536
|
+
# When you use this action with an access point for directory buckets,
|
17537
|
+
# you must provide the access point name in place of the bucket name.
|
17538
|
+
# When using the access point ARN, you must direct requests to the
|
17539
|
+
# access point hostname. The access point hostname takes the form
|
17491
17540
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
17492
17541
|
# When using this action with an access point through the Amazon Web
|
17493
17542
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
17494
17543
|
# name. For more information about access point ARNs, see [Using access
|
17495
17544
|
# points][1] in the *Amazon S3 User Guide*.
|
17496
17545
|
#
|
17497
|
-
# **S3 on Outposts** - When you use this action with
|
17498
|
-
#
|
17499
|
-
#
|
17546
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
17547
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
17548
|
+
# Outposts hostname takes the form `
|
17500
17549
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
17501
|
-
# When you use this action with S3 on Outposts
|
17502
|
-
#
|
17503
|
-
#
|
17504
|
-
#
|
17550
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
17551
|
+
# must be the Outposts access point ARN or the access point alias. For
|
17552
|
+
# more information about S3 on Outposts, see [What is S3 on
|
17553
|
+
# Outposts?][2] in the *Amazon S3 User Guide*.
|
17505
17554
|
#
|
17506
17555
|
#
|
17507
17556
|
#
|
@@ -17686,11 +17735,13 @@ module Aws::S3
|
|
17686
17735
|
# The bucket name containing the object that you want to place a legal
|
17687
17736
|
# hold on.
|
17688
17737
|
#
|
17689
|
-
# **Access points** - When you use this action with an access point
|
17690
|
-
# must provide the alias of the access
|
17691
|
-
#
|
17692
|
-
#
|
17693
|
-
#
|
17738
|
+
# **Access points** - When you use this action with an access point for
|
17739
|
+
# general purpose buckets, you must provide the alias of the access
|
17740
|
+
# point in place of the bucket name or specify the access point ARN.
|
17741
|
+
# When you use this action with an access point for directory buckets,
|
17742
|
+
# you must provide the access point name in place of the bucket name.
|
17743
|
+
# When using the access point ARN, you must direct requests to the
|
17744
|
+
# access point hostname. The access point hostname takes the form
|
17694
17745
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
17695
17746
|
# When using this action with an access point through the Amazon Web
|
17696
17747
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -17927,11 +17978,13 @@ module Aws::S3
|
|
17927
17978
|
# The bucket name that contains the object you want to apply this Object
|
17928
17979
|
# Retention configuration to.
|
17929
17980
|
#
|
17930
|
-
# **Access points** - When you use this action with an access point
|
17931
|
-
# must provide the alias of the access
|
17932
|
-
#
|
17933
|
-
#
|
17934
|
-
#
|
17981
|
+
# **Access points** - When you use this action with an access point for
|
17982
|
+
# general purpose buckets, you must provide the alias of the access
|
17983
|
+
# point in place of the bucket name or specify the access point ARN.
|
17984
|
+
# When you use this action with an access point for directory buckets,
|
17985
|
+
# you must provide the access point name in place of the bucket name.
|
17986
|
+
# When using the access point ARN, you must direct requests to the
|
17987
|
+
# access point hostname. The access point hostname takes the form
|
17935
17988
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
17936
17989
|
# When using this action with an access point through the Amazon Web
|
17937
17990
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
@@ -18092,25 +18145,27 @@ module Aws::S3
|
|
18092
18145
|
# @option params [required, String] :bucket
|
18093
18146
|
# The bucket name containing the object.
|
18094
18147
|
#
|
18095
|
-
# **Access points** - When you use this action with an access point
|
18096
|
-
# must provide the alias of the access
|
18097
|
-
#
|
18098
|
-
#
|
18099
|
-
#
|
18148
|
+
# **Access points** - When you use this action with an access point for
|
18149
|
+
# general purpose buckets, you must provide the alias of the access
|
18150
|
+
# point in place of the bucket name or specify the access point ARN.
|
18151
|
+
# When you use this action with an access point for directory buckets,
|
18152
|
+
# you must provide the access point name in place of the bucket name.
|
18153
|
+
# When using the access point ARN, you must direct requests to the
|
18154
|
+
# access point hostname. The access point hostname takes the form
|
18100
18155
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
18101
18156
|
# When using this action with an access point through the Amazon Web
|
18102
18157
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
18103
18158
|
# name. For more information about access point ARNs, see [Using access
|
18104
18159
|
# points][1] in the *Amazon S3 User Guide*.
|
18105
18160
|
#
|
18106
|
-
# **S3 on Outposts** - When you use this action with
|
18107
|
-
#
|
18108
|
-
#
|
18161
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
18162
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
18163
|
+
# Outposts hostname takes the form `
|
18109
18164
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
18110
|
-
# When you use this action with S3 on Outposts
|
18111
|
-
#
|
18112
|
-
#
|
18113
|
-
#
|
18165
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
18166
|
+
# must be the Outposts access point ARN or the access point alias. For
|
18167
|
+
# more information about S3 on Outposts, see [What is S3 on
|
18168
|
+
# Outposts?][2] in the *Amazon S3 User Guide*.
|
18114
18169
|
#
|
18115
18170
|
#
|
18116
18171
|
#
|
@@ -18378,20 +18433,19 @@ module Aws::S3
|
|
18378
18433
|
#
|
18379
18434
|
# Restoring objects
|
18380
18435
|
#
|
18381
|
-
# : Objects that you archive to the S3 Glacier Flexible Retrieval
|
18382
|
-
#
|
18383
|
-
#
|
18384
|
-
#
|
18385
|
-
#
|
18386
|
-
#
|
18387
|
-
#
|
18388
|
-
#
|
18389
|
-
#
|
18390
|
-
#
|
18391
|
-
#
|
18392
|
-
#
|
18393
|
-
#
|
18394
|
-
# moved into the Frequent Access tier.
|
18436
|
+
# : Objects that you archive to the S3 Glacier Flexible Retrieval or S3
|
18437
|
+
# Glacier Deep Archive storage class, and S3 Intelligent-Tiering
|
18438
|
+
# Archive or S3 Intelligent-Tiering Deep Archive tiers, are not
|
18439
|
+
# accessible in real time. For objects in the S3 Glacier Flexible
|
18440
|
+
# Retrieval or S3 Glacier Deep Archive storage classes, you must first
|
18441
|
+
# initiate a restore request, and then wait until a temporary copy of
|
18442
|
+
# the object is available. If you want a permanent copy of the object,
|
18443
|
+
# create a copy of it in the Amazon S3 Standard storage class in your
|
18444
|
+
# S3 bucket. To access an archived object, you must restore the object
|
18445
|
+
# for the duration (number of days) that you specify. For objects in
|
18446
|
+
# the Archive Access or Deep Archive Access tiers of S3
|
18447
|
+
# Intelligent-Tiering, you must first initiate a restore request, and
|
18448
|
+
# then wait until the object is moved into the Frequent Access tier.
|
18395
18449
|
#
|
18396
18450
|
# To restore a specific object version, you can provide a version ID.
|
18397
18451
|
# If you don't provide a version ID, Amazon S3 restores the current
|
@@ -18402,38 +18456,37 @@ module Aws::S3
|
|
18402
18456
|
# request body:
|
18403
18457
|
#
|
18404
18458
|
# * `Expedited` - Expedited retrievals allow you to quickly access
|
18405
|
-
# your data stored in the S3 Glacier Flexible Retrieval
|
18406
|
-
#
|
18407
|
-
#
|
18408
|
-
#
|
18409
|
-
#
|
18410
|
-
#
|
18411
|
-
#
|
18412
|
-
#
|
18413
|
-
#
|
18414
|
-
#
|
18459
|
+
# your data stored in the S3 Glacier Flexible Retrieval storage
|
18460
|
+
# class or S3 Intelligent-Tiering Archive tier when occasional
|
18461
|
+
# urgent requests for restoring archives are required. For all but
|
18462
|
+
# the largest archived objects (250 MB+), data accessed using
|
18463
|
+
# Expedited retrievals is typically made available within 1–5
|
18464
|
+
# minutes. Provisioned capacity ensures that retrieval capacity for
|
18465
|
+
# Expedited retrievals is available when you need it. Expedited
|
18466
|
+
# retrievals and provisioned capacity are not available for objects
|
18467
|
+
# stored in the S3 Glacier Deep Archive storage class or S3
|
18468
|
+
# Intelligent-Tiering Deep Archive tier.
|
18415
18469
|
#
|
18416
18470
|
# * `Standard` - Standard retrievals allow you to access any of your
|
18417
18471
|
# archived objects within several hours. This is the default option
|
18418
18472
|
# for retrieval requests that do not specify the retrieval option.
|
18419
18473
|
# Standard retrievals typically finish within 3–5 hours for objects
|
18420
|
-
# stored in the S3 Glacier Flexible Retrieval
|
18421
|
-
#
|
18422
|
-
#
|
18423
|
-
#
|
18424
|
-
#
|
18425
|
-
# S3 Intelligent-Tiering.
|
18474
|
+
# stored in the S3 Glacier Flexible Retrieval storage class or S3
|
18475
|
+
# Intelligent-Tiering Archive tier. They typically finish within 12
|
18476
|
+
# hours for objects stored in the S3 Glacier Deep Archive storage
|
18477
|
+
# class or S3 Intelligent-Tiering Deep Archive tier. Standard
|
18478
|
+
# retrievals are free for objects stored in S3 Intelligent-Tiering.
|
18426
18479
|
#
|
18427
18480
|
# * `Bulk` - Bulk retrievals free for objects stored in the S3 Glacier
|
18428
18481
|
# Flexible Retrieval and S3 Intelligent-Tiering storage classes,
|
18429
18482
|
# enabling you to retrieve large amounts, even petabytes, of data at
|
18430
18483
|
# no cost. Bulk retrievals typically finish within 5–12 hours for
|
18431
|
-
# objects stored in the S3 Glacier Flexible Retrieval
|
18432
|
-
#
|
18433
|
-
#
|
18434
|
-
#
|
18435
|
-
#
|
18436
|
-
#
|
18484
|
+
# objects stored in the S3 Glacier Flexible Retrieval storage class
|
18485
|
+
# or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also
|
18486
|
+
# the lowest-cost retrieval option when restoring objects from S3
|
18487
|
+
# Glacier Deep Archive. They typically finish within 48 hours for
|
18488
|
+
# objects stored in the S3 Glacier Deep Archive storage class or S3
|
18489
|
+
# Intelligent-Tiering Deep Archive tier.
|
18437
18490
|
#
|
18438
18491
|
# For more information about archive retrieval options and provisioned
|
18439
18492
|
# capacity for `Expedited` data access, see [Restoring Archived
|
@@ -18524,25 +18577,27 @@ module Aws::S3
|
|
18524
18577
|
# @option params [required, String] :bucket
|
18525
18578
|
# The bucket name containing the object to restore.
|
18526
18579
|
#
|
18527
|
-
# **Access points** - When you use this action with an access point
|
18528
|
-
# must provide the alias of the access
|
18529
|
-
#
|
18530
|
-
#
|
18531
|
-
#
|
18580
|
+
# **Access points** - When you use this action with an access point for
|
18581
|
+
# general purpose buckets, you must provide the alias of the access
|
18582
|
+
# point in place of the bucket name or specify the access point ARN.
|
18583
|
+
# When you use this action with an access point for directory buckets,
|
18584
|
+
# you must provide the access point name in place of the bucket name.
|
18585
|
+
# When using the access point ARN, you must direct requests to the
|
18586
|
+
# access point hostname. The access point hostname takes the form
|
18532
18587
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
18533
18588
|
# When using this action with an access point through the Amazon Web
|
18534
18589
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
18535
18590
|
# name. For more information about access point ARNs, see [Using access
|
18536
18591
|
# points][1] in the *Amazon S3 User Guide*.
|
18537
18592
|
#
|
18538
|
-
# **S3 on Outposts** - When you use this action with
|
18539
|
-
#
|
18540
|
-
#
|
18593
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
18594
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
18595
|
+
# Outposts hostname takes the form `
|
18541
18596
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
18542
|
-
# When you use this action with S3 on Outposts
|
18543
|
-
#
|
18544
|
-
#
|
18545
|
-
#
|
18597
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
18598
|
+
# must be the Outposts access point ARN or the access point alias. For
|
18599
|
+
# more information about S3 on Outposts, see [What is S3 on
|
18600
|
+
# Outposts?][2] in the *Amazon S3 User Guide*.
|
18546
18601
|
#
|
18547
18602
|
#
|
18548
18603
|
#
|
@@ -19181,13 +19236,13 @@ module Aws::S3
|
|
19181
19236
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
19182
19237
|
# for this API operation to the Zonal endpoint. These endpoints support
|
19183
19238
|
# virtual-hosted-style requests in the format
|
19184
|
-
# `https://bucket
|
19239
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
19185
19240
|
# `. Path-style requests are not supported. For more information about
|
19186
19241
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
19187
19242
|
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
19188
19243
|
# Guide*. For more information about endpoints in Local Zones, see
|
19189
|
-
# [
|
19190
|
-
# Guide*.
|
19244
|
+
# [Concepts for directory buckets in Local Zones][6] in the *Amazon S3
|
19245
|
+
# User Guide*.
|
19191
19246
|
#
|
19192
19247
|
# </note>
|
19193
19248
|
#
|
@@ -19321,7 +19376,7 @@ module Aws::S3
|
|
19321
19376
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
|
19322
19377
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html
|
19323
19378
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html
|
19324
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
19379
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
19325
19380
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
19326
19381
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
|
19327
19382
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
@@ -19346,34 +19401,35 @@ module Aws::S3
|
|
19346
19401
|
# requests are not supported. Directory bucket names must be unique in
|
19347
19402
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
19348
19403
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
19349
|
-
#
|
19404
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
19350
19405
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
19351
19406
|
# *Amazon S3 User Guide*.
|
19352
19407
|
#
|
19353
|
-
# **Access points** - When you use this action with an access point
|
19354
|
-
# must provide the alias of the access
|
19355
|
-
#
|
19356
|
-
#
|
19357
|
-
#
|
19408
|
+
# **Access points** - When you use this action with an access point for
|
19409
|
+
# general purpose buckets, you must provide the alias of the access
|
19410
|
+
# point in place of the bucket name or specify the access point ARN.
|
19411
|
+
# When you use this action with an access point for directory buckets,
|
19412
|
+
# you must provide the access point name in place of the bucket name.
|
19413
|
+
# When using the access point ARN, you must direct requests to the
|
19414
|
+
# access point hostname. The access point hostname takes the form
|
19358
19415
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
19359
19416
|
# When using this action with an access point through the Amazon Web
|
19360
19417
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
19361
19418
|
# name. For more information about access point ARNs, see [Using access
|
19362
19419
|
# points][2] in the *Amazon S3 User Guide*.
|
19363
19420
|
#
|
19364
|
-
# <note markdown="1">
|
19365
|
-
# directory buckets.
|
19421
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
19366
19422
|
#
|
19367
19423
|
# </note>
|
19368
19424
|
#
|
19369
|
-
# **S3 on Outposts** - When you use this action with
|
19370
|
-
#
|
19371
|
-
#
|
19425
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
19426
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
19427
|
+
# Outposts hostname takes the form `
|
19372
19428
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
19373
|
-
# When you use this action with S3 on Outposts
|
19374
|
-
#
|
19375
|
-
#
|
19376
|
-
#
|
19429
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
19430
|
+
# must be the Outposts access point ARN or the access point alias. For
|
19431
|
+
# more information about S3 on Outposts, see [What is S3 on
|
19432
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
19377
19433
|
#
|
19378
19434
|
#
|
19379
19435
|
#
|
@@ -19416,7 +19472,7 @@ module Aws::S3
|
|
19416
19472
|
# @option params [String] :checksum_crc32
|
19417
19473
|
# This header can be used as a data integrity check to verify that the
|
19418
19474
|
# data received is the same data that was originally sent. This header
|
19419
|
-
# specifies the Base64 encoded, 32-bit `
|
19475
|
+
# specifies the Base64 encoded, 32-bit `CRC32` checksum of the object.
|
19420
19476
|
# For more information, see [Checking object integrity][1] in the
|
19421
19477
|
# *Amazon S3 User Guide*.
|
19422
19478
|
#
|
@@ -19427,7 +19483,7 @@ module Aws::S3
|
|
19427
19483
|
# @option params [String] :checksum_crc32c
|
19428
19484
|
# This header can be used as a data integrity check to verify that the
|
19429
19485
|
# data received is the same data that was originally sent. This header
|
19430
|
-
# specifies the Base64 encoded, 32-bit `
|
19486
|
+
# specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object.
|
19431
19487
|
# For more information, see [Checking object integrity][1] in the
|
19432
19488
|
# *Amazon S3 User Guide*.
|
19433
19489
|
#
|
@@ -19438,8 +19494,8 @@ module Aws::S3
|
|
19438
19494
|
# @option params [String] :checksum_crc64nvme
|
19439
19495
|
# This header can be used as a data integrity check to verify that the
|
19440
19496
|
# data received is the same data that was originally sent. This header
|
19441
|
-
# specifies the Base64 encoded, 64-bit `
|
19442
|
-
#
|
19497
|
+
# specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the part.
|
19498
|
+
# For more information, see [Checking object integrity][1] in the
|
19443
19499
|
# *Amazon S3 User Guide*.
|
19444
19500
|
#
|
19445
19501
|
#
|
@@ -19449,9 +19505,9 @@ module Aws::S3
|
|
19449
19505
|
# @option params [String] :checksum_sha1
|
19450
19506
|
# This header can be used as a data integrity check to verify that the
|
19451
19507
|
# data received is the same data that was originally sent. This header
|
19452
|
-
# specifies the Base64 encoded, 160-bit `
|
19453
|
-
#
|
19454
|
-
#
|
19508
|
+
# specifies the Base64 encoded, 160-bit `SHA1` digest of the object. For
|
19509
|
+
# more information, see [Checking object integrity][1] in the *Amazon S3
|
19510
|
+
# User Guide*.
|
19455
19511
|
#
|
19456
19512
|
#
|
19457
19513
|
#
|
@@ -19460,7 +19516,7 @@ module Aws::S3
|
|
19460
19516
|
# @option params [String] :checksum_sha256
|
19461
19517
|
# This header can be used as a data integrity check to verify that the
|
19462
19518
|
# data received is the same data that was originally sent. This header
|
19463
|
-
# specifies the Base64 encoded, 256-bit `
|
19519
|
+
# specifies the Base64 encoded, 256-bit `SHA256` digest of the object.
|
19464
19520
|
# For more information, see [Checking object integrity][1] in the
|
19465
19521
|
# *Amazon S3 User Guide*.
|
19466
19522
|
#
|
@@ -19640,13 +19696,13 @@ module Aws::S3
|
|
19640
19696
|
# <note markdown="1"> **Directory buckets** - For directory buckets, you must make requests
|
19641
19697
|
# for this API operation to the Zonal endpoint. These endpoints support
|
19642
19698
|
# virtual-hosted-style requests in the format
|
19643
|
-
# `https://bucket
|
19699
|
+
# `https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
|
19644
19700
|
# `. Path-style requests are not supported. For more information about
|
19645
19701
|
# endpoints in Availability Zones, see [Regional and Zonal endpoints for
|
19646
19702
|
# directory buckets in Availability Zones][5] in the *Amazon S3 User
|
19647
19703
|
# Guide*. For more information about endpoints in Local Zones, see
|
19648
|
-
# [
|
19649
|
-
# Guide*.
|
19704
|
+
# [Concepts for directory buckets in Local Zones][6] in the *Amazon S3
|
19705
|
+
# User Guide*.
|
19650
19706
|
#
|
19651
19707
|
# </note>
|
19652
19708
|
#
|
@@ -19791,7 +19847,7 @@ module Aws::S3
|
|
19791
19847
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
|
19792
19848
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html
|
19793
19849
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html
|
19794
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
19850
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html
|
19795
19851
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html
|
19796
19852
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
19797
19853
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html
|
@@ -19817,7 +19873,7 @@ module Aws::S3
|
|
19817
19873
|
# requests are not supported. Directory bucket names must be unique in
|
19818
19874
|
# the chosen Zone (Availability Zone or Local Zone). Bucket names must
|
19819
19875
|
# follow the format ` bucket-base-name--zone-id--x-s3` (for example, `
|
19820
|
-
#
|
19876
|
+
# amzn-s3-demo-bucket--usw2-az1--x-s3`). For information about bucket
|
19821
19877
|
# naming restrictions, see [Directory bucket naming rules][1] in the
|
19822
19878
|
# *Amazon S3 User Guide*.
|
19823
19879
|
#
|
@@ -19829,30 +19885,31 @@ module Aws::S3
|
|
19829
19885
|
#
|
19830
19886
|
# </note>
|
19831
19887
|
#
|
19832
|
-
# **Access points** - When you use this action with an access point
|
19833
|
-
# must provide the alias of the access
|
19834
|
-
#
|
19835
|
-
#
|
19836
|
-
#
|
19888
|
+
# **Access points** - When you use this action with an access point for
|
19889
|
+
# general purpose buckets, you must provide the alias of the access
|
19890
|
+
# point in place of the bucket name or specify the access point ARN.
|
19891
|
+
# When you use this action with an access point for directory buckets,
|
19892
|
+
# you must provide the access point name in place of the bucket name.
|
19893
|
+
# When using the access point ARN, you must direct requests to the
|
19894
|
+
# access point hostname. The access point hostname takes the form
|
19837
19895
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
19838
19896
|
# When using this action with an access point through the Amazon Web
|
19839
19897
|
# Services SDKs, you provide the access point ARN in place of the bucket
|
19840
19898
|
# name. For more information about access point ARNs, see [Using access
|
19841
19899
|
# points][2] in the *Amazon S3 User Guide*.
|
19842
19900
|
#
|
19843
|
-
# <note markdown="1">
|
19844
|
-
# directory buckets.
|
19901
|
+
# <note markdown="1"> Object Lambda access points are not supported by directory buckets.
|
19845
19902
|
#
|
19846
19903
|
# </note>
|
19847
19904
|
#
|
19848
|
-
# **S3 on Outposts** - When you use this action with
|
19849
|
-
#
|
19850
|
-
#
|
19905
|
+
# **S3 on Outposts** - When you use this action with S3 on Outposts, you
|
19906
|
+
# must direct requests to the S3 on Outposts hostname. The S3 on
|
19907
|
+
# Outposts hostname takes the form `
|
19851
19908
|
# AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
|
19852
|
-
# When you use this action with S3 on Outposts
|
19853
|
-
#
|
19854
|
-
#
|
19855
|
-
#
|
19909
|
+
# When you use this action with S3 on Outposts, the destination bucket
|
19910
|
+
# must be the Outposts access point ARN or the access point alias. For
|
19911
|
+
# more information about S3 on Outposts, see [What is S3 on
|
19912
|
+
# Outposts?][3] in the *Amazon S3 User Guide*.
|
19856
19913
|
#
|
19857
19914
|
#
|
19858
19915
|
#
|
@@ -20100,45 +20157,45 @@ module Aws::S3
|
|
20100
20157
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
20101
20158
|
#
|
20102
20159
|
#
|
20103
|
-
# @example Example: To upload a part by copying
|
20160
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
20104
20161
|
#
|
20105
|
-
# # The following example uploads a part of a multipart upload by copying
|
20162
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
20163
|
+
# # data source.
|
20106
20164
|
#
|
20107
20165
|
# resp = client.upload_part_copy({
|
20108
20166
|
# bucket: "examplebucket",
|
20109
20167
|
# copy_source: "/bucketname/sourceobjectkey",
|
20168
|
+
# copy_source_range: "bytes=1-100000",
|
20110
20169
|
# key: "examplelargeobject",
|
20111
|
-
# part_number:
|
20170
|
+
# part_number: 2,
|
20112
20171
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
20113
20172
|
# })
|
20114
20173
|
#
|
20115
20174
|
# resp.to_h outputs the following:
|
20116
20175
|
# {
|
20117
20176
|
# copy_part_result: {
|
20118
|
-
# etag: "\"
|
20119
|
-
# last_modified: Time.parse("2016-12-29T21:
|
20177
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
20178
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
20120
20179
|
# },
|
20121
20180
|
# }
|
20122
20181
|
#
|
20123
|
-
# @example Example: To upload a part by copying
|
20182
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
20124
20183
|
#
|
20125
|
-
# # The following example uploads a part of a multipart upload by copying
|
20126
|
-
# # data source.
|
20184
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
20127
20185
|
#
|
20128
20186
|
# resp = client.upload_part_copy({
|
20129
20187
|
# bucket: "examplebucket",
|
20130
20188
|
# copy_source: "/bucketname/sourceobjectkey",
|
20131
|
-
# copy_source_range: "bytes=1-100000",
|
20132
20189
|
# key: "examplelargeobject",
|
20133
|
-
# part_number:
|
20190
|
+
# part_number: 1,
|
20134
20191
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
20135
20192
|
# })
|
20136
20193
|
#
|
20137
20194
|
# resp.to_h outputs the following:
|
20138
20195
|
# {
|
20139
20196
|
# copy_part_result: {
|
20140
|
-
# etag: "\"
|
20141
|
-
# last_modified: Time.parse("2016-12-29T21:
|
20197
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
20198
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
20142
20199
|
# },
|
20143
20200
|
# }
|
20144
20201
|
#
|
@@ -20338,7 +20395,7 @@ module Aws::S3
|
|
20338
20395
|
# @option params [String] :checksum_crc32
|
20339
20396
|
# This header can be used as a data integrity check to verify that the
|
20340
20397
|
# data received is the same data that was originally sent. This
|
20341
|
-
# specifies the Base64 encoded, 32-bit `
|
20398
|
+
# specifies the Base64 encoded, 32-bit `CRC32` checksum of the object
|
20342
20399
|
# returned by the Object Lambda function. This may not match the
|
20343
20400
|
# checksum for the object stored in Amazon S3. Amazon S3 will perform
|
20344
20401
|
# validation of the checksum values only when the original `GetObject`
|
@@ -20358,7 +20415,7 @@ module Aws::S3
|
|
20358
20415
|
# @option params [String] :checksum_crc32c
|
20359
20416
|
# This header can be used as a data integrity check to verify that the
|
20360
20417
|
# data received is the same data that was originally sent. This
|
20361
|
-
# specifies the Base64 encoded, 32-bit `
|
20418
|
+
# specifies the Base64 encoded, 32-bit `CRC32C` checksum of the object
|
20362
20419
|
# returned by the Object Lambda function. This may not match the
|
20363
20420
|
# checksum for the object stored in Amazon S3. Amazon S3 will perform
|
20364
20421
|
# validation of the checksum values only when the original `GetObject`
|
@@ -20376,8 +20433,8 @@ module Aws::S3
|
|
20376
20433
|
# @option params [String] :checksum_crc64nvme
|
20377
20434
|
# This header can be used as a data integrity check to verify that the
|
20378
20435
|
# data received is the same data that was originally sent. This header
|
20379
|
-
# specifies the Base64 encoded, 64-bit `
|
20380
|
-
#
|
20436
|
+
# specifies the Base64 encoded, 64-bit `CRC64NVME` checksum of the part.
|
20437
|
+
# For more information, see [Checking object integrity][1] in the
|
20381
20438
|
# *Amazon S3 User Guide*.
|
20382
20439
|
#
|
20383
20440
|
#
|
@@ -20387,7 +20444,7 @@ module Aws::S3
|
|
20387
20444
|
# @option params [String] :checksum_sha1
|
20388
20445
|
# This header can be used as a data integrity check to verify that the
|
20389
20446
|
# data received is the same data that was originally sent. This
|
20390
|
-
# specifies the Base64 encoded, 160-bit `
|
20447
|
+
# specifies the Base64 encoded, 160-bit `SHA1` digest of the object
|
20391
20448
|
# returned by the Object Lambda function. This may not match the
|
20392
20449
|
# checksum for the object stored in Amazon S3. Amazon S3 will perform
|
20393
20450
|
# validation of the checksum values only when the original `GetObject`
|
@@ -20405,7 +20462,7 @@ module Aws::S3
|
|
20405
20462
|
# @option params [String] :checksum_sha256
|
20406
20463
|
# This header can be used as a data integrity check to verify that the
|
20407
20464
|
# data received is the same data that was originally sent. This
|
20408
|
-
# specifies the Base64 encoded, 256-bit `
|
20465
|
+
# specifies the Base64 encoded, 256-bit `SHA256` digest of the object
|
20409
20466
|
# returned by the Object Lambda function. This may not match the
|
20410
20467
|
# checksum for the object stored in Amazon S3. Amazon S3 will perform
|
20411
20468
|
# validation of the checksum values only when the original `GetObject`
|
@@ -20422,7 +20479,12 @@ module Aws::S3
|
|
20422
20479
|
#
|
20423
20480
|
# @option params [Boolean] :delete_marker
|
20424
20481
|
# Specifies whether an object stored in Amazon S3 is (`true`) or is not
|
20425
|
-
# (`false`) a delete marker.
|
20482
|
+
# (`false`) a delete marker. To learn more about delete markers, see
|
20483
|
+
# [Working with delete markers][1].
|
20484
|
+
#
|
20485
|
+
#
|
20486
|
+
#
|
20487
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeleteMarker.html
|
20426
20488
|
#
|
20427
20489
|
# @option params [String] :etag
|
20428
20490
|
# An opaque identifier assigned by a web server to a specific version of
|
@@ -20613,7 +20675,7 @@ module Aws::S3
|
|
20613
20675
|
tracer: tracer
|
20614
20676
|
)
|
20615
20677
|
context[:gem_name] = 'aws-sdk-s3'
|
20616
|
-
context[:gem_version] = '1.
|
20678
|
+
context[:gem_version] = '1.183.0'
|
20617
20679
|
Seahorse::Client::Request.new(handlers, context)
|
20618
20680
|
end
|
20619
20681
|
|