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