aws-sdk-s3 1.92.0 → 1.95.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +2 -4
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +2 -4
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +1 -3
- data/lib/aws-sdk-s3/bucket.rb +11 -11
- data/lib/aws-sdk-s3/bucket_acl.rb +4 -2
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -2
- data/lib/aws-sdk-s3/client.rb +320 -287
- data/lib/aws-sdk-s3/customizations/object.rb +30 -11
- data/lib/aws-sdk-s3/file_uploader.rb +2 -2
- data/lib/aws-sdk-s3/multipart_upload.rb +3 -3
- data/lib/aws-sdk-s3/multipart_upload_part.rb +2 -2
- data/lib/aws-sdk-s3/object.rb +104 -20
- data/lib/aws-sdk-s3/object_acl.rb +5 -3
- data/lib/aws-sdk-s3/object_summary.rb +17 -19
- data/lib/aws-sdk-s3/object_version.rb +4 -4
- data/lib/aws-sdk-s3/plugins/arn.rb +37 -21
- data/lib/aws-sdk-s3/presigner.rb +12 -3
- data/lib/aws-sdk-s3/resource.rb +4 -2
- data/lib/aws-sdk-s3/types.rb +209 -195
- metadata +5 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d19f73a2ffccaaa9cd15cac607af56e59943f884bb908408e5f56e28fc27bb5c
|
4
|
+
data.tar.gz: 6d78cc39d6200623982c9d96fd7983310da56009f004a4bde7d5a120e1dd67c2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a0c53f6f254417b8d01bd696c6a0ce64c0ba72299186f1bb8ef7b6ce108530cbe815a48d1dbd9be134da0a2bd4858bf966b122fb9c35b01b242a0a989f54ebf3
|
7
|
+
data.tar.gz: ac8e49b6dde30d3e0a5643cd827a63da27501ae2b0f9f85c0250de361b888448ea3421f683d7081cdee16341907cb15b58e782da6fb46c6b67d6934f5e6fbef0
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,33 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.95.0 (2021-05-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for Amazon S3
|
8
|
+
|
9
|
+
1.94.1 (2021-05-05)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Issue - Expose presigned request status to the request handler stack #2513
|
13
|
+
|
14
|
+
1.94.0 (2021-04-27)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Allow S3 Presigner to sign non http verbs like (upload_part, multipart_upload_abort, etc.) #2511
|
18
|
+
|
19
|
+
1.93.1 (2021-04-12)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Issue - Fix FIPS and global endpoint behavior for S3 ARNs.
|
23
|
+
|
24
|
+
* Issue - Increases `multipart_threshold` default from 15 megabytes to 100 megabytes.
|
25
|
+
|
26
|
+
1.93.0 (2021-03-24)
|
27
|
+
------------------
|
28
|
+
|
29
|
+
* Feature - Documentation updates for Amazon S3
|
30
|
+
|
4
31
|
1.92.0 (2021-03-18)
|
5
32
|
------------------
|
6
33
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.95.0
|
data/lib/aws-sdk-s3.rb
CHANGED
@@ -9,8 +9,6 @@ module Aws
|
|
9
9
|
@type, @access_point_name, @extra = @resource.split(/[:,\/]/)
|
10
10
|
end
|
11
11
|
|
12
|
-
attr_reader :access_point_name
|
13
|
-
|
14
12
|
def support_dualstack?
|
15
13
|
true
|
16
14
|
end
|
@@ -52,13 +50,13 @@ module Aws
|
|
52
50
|
end
|
53
51
|
end
|
54
52
|
|
55
|
-
def host_url(region, dualstack = false, custom_endpoint = nil)
|
53
|
+
def host_url(region, fips = false, dualstack = false, custom_endpoint = nil)
|
56
54
|
pfx = "#{@access_point_name}-#{@account_id}"
|
57
55
|
if custom_endpoint
|
58
56
|
"#{pfx}.#{custom_endpoint}"
|
59
57
|
else
|
60
58
|
sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(region)
|
61
|
-
"#{pfx}.s3-accesspoint#{'.dualstack' if dualstack}.#{region}.#{sfx}"
|
59
|
+
"#{pfx}.s3-accesspoint#{'-fips' if fips}#{'.dualstack' if dualstack}.#{region}.#{sfx}"
|
62
60
|
end
|
63
61
|
end
|
64
62
|
end
|
@@ -9,8 +9,6 @@ module Aws
|
|
9
9
|
@type, @access_point_name, @extra = @resource.split(/[:,\/]/)
|
10
10
|
end
|
11
11
|
|
12
|
-
attr_reader :access_point_name
|
13
|
-
|
14
12
|
def support_dualstack?
|
15
13
|
false
|
16
14
|
end
|
@@ -52,13 +50,13 @@ module Aws
|
|
52
50
|
end
|
53
51
|
end
|
54
52
|
|
55
|
-
def host_url(region, _dualstack = false, custom_endpoint = nil)
|
53
|
+
def host_url(region, fips = false, _dualstack = false, custom_endpoint = nil)
|
56
54
|
pfx = "#{@access_point_name}-#{@account_id}"
|
57
55
|
if custom_endpoint
|
58
56
|
"#{pfx}.#{custom_endpoint}"
|
59
57
|
else
|
60
58
|
sfx = Aws::Partitions::EndpointProvider.dns_suffix_for(region)
|
61
|
-
"#{pfx}.s3-object-lambda.#{region}.#{sfx}"
|
59
|
+
"#{pfx}.s3-object-lambda#{'-fips' if fips}.#{region}.#{sfx}"
|
62
60
|
end
|
63
61
|
end
|
64
62
|
end
|
@@ -10,8 +10,6 @@ module Aws
|
|
10
10
|
@resource.split(/[:,\/]/)
|
11
11
|
end
|
12
12
|
|
13
|
-
attr_reader :outpost_id, :access_point_name
|
14
|
-
|
15
13
|
def support_dualstack?
|
16
14
|
false
|
17
15
|
end
|
@@ -62,7 +60,7 @@ module Aws
|
|
62
60
|
end
|
63
61
|
|
64
62
|
# Outpost ARNs currently do not support dualstack
|
65
|
-
def host_url(region, _dualstack = false, custom_endpoint = nil)
|
63
|
+
def host_url(region, _fips = false, _dualstack = false, custom_endpoint = nil)
|
66
64
|
pfx = "#{@access_point_name}-#{@account_id}.#{@outpost_id}"
|
67
65
|
if custom_endpoint
|
68
66
|
"#{pfx}.#{custom_endpoint}"
|
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -245,8 +245,10 @@ module Aws::S3
|
|
245
245
|
# @option options [String] :grant_read_acp
|
246
246
|
# Allows grantee to read the bucket ACL.
|
247
247
|
# @option options [String] :grant_write
|
248
|
-
# Allows grantee to create
|
249
|
-
#
|
248
|
+
# Allows grantee to create new objects in the bucket.
|
249
|
+
#
|
250
|
+
# For the bucket and object owners of existing objects, also allows
|
251
|
+
# deletions and overwrites of those objects.
|
250
252
|
# @option options [String] :grant_write_acp
|
251
253
|
# Allows grantee to write the ACL for the applicable bucket.
|
252
254
|
# @option options [Boolean] :object_lock_enabled_for_bucket
|
@@ -306,7 +308,7 @@ module Aws::S3
|
|
306
308
|
# request. Bucket owners need not specify this parameter in their
|
307
309
|
# requests. For information about downloading objects from requester
|
308
310
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
309
|
-
# in the *Amazon S3
|
311
|
+
# in the *Amazon S3 User Guide*.
|
310
312
|
#
|
311
313
|
#
|
312
314
|
#
|
@@ -468,7 +470,7 @@ module Aws::S3
|
|
468
470
|
# and high availability. Depending on performance needs, you can specify
|
469
471
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
470
472
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
471
|
-
# in the *Amazon S3
|
473
|
+
# in the *Amazon S3 User Guide*.
|
472
474
|
#
|
473
475
|
#
|
474
476
|
#
|
@@ -515,14 +517,12 @@ module Aws::S3
|
|
515
517
|
# If `x-amz-server-side-encryption` is present and has the value of
|
516
518
|
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
517
519
|
# Service (AWS KMS) symmetrical customer managed customer master key
|
518
|
-
# (CMK) that was used for the object.
|
519
|
-
#
|
520
|
-
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
521
|
-
# header specifies the ID of the symmetric customer managed AWS KMS CMK
|
522
|
-
# that will be used for the object. If you specify
|
520
|
+
# (CMK) that was used for the object. If you specify
|
523
521
|
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
524
522
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
|
525
|
-
# managed CMK in AWS to protect the data.
|
523
|
+
# managed CMK in AWS to protect the data. If the KMS key does not exist
|
524
|
+
# in the same account issuing the command, you must use the full ARN and
|
525
|
+
# not just the ID.
|
526
526
|
# @option options [String] :ssekms_encryption_context
|
527
527
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
528
528
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -540,7 +540,7 @@ module Aws::S3
|
|
540
540
|
# request. Bucket owners need not specify this parameter in their
|
541
541
|
# requests. For information about downloading objects from requester
|
542
542
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
543
|
-
# in the *Amazon S3
|
543
|
+
# in the *Amazon S3 User Guide*.
|
544
544
|
#
|
545
545
|
#
|
546
546
|
#
|
@@ -235,8 +235,10 @@ module Aws::S3
|
|
235
235
|
# @option options [String] :grant_read_acp
|
236
236
|
# Allows grantee to read the bucket ACL.
|
237
237
|
# @option options [String] :grant_write
|
238
|
-
# Allows grantee to create
|
239
|
-
#
|
238
|
+
# Allows grantee to create new objects in the bucket.
|
239
|
+
#
|
240
|
+
# For the bucket and object owners of existing objects, also allows
|
241
|
+
# deletions and overwrites of those objects.
|
240
242
|
# @option options [String] :grant_write_acp
|
241
243
|
# Allows grantee to write the ACL for the applicable bucket.
|
242
244
|
# @option options [String] :expected_bucket_owner
|
@@ -36,8 +36,7 @@ module Aws::S3
|
|
36
36
|
|
37
37
|
# Describes where logs are stored and the prefix that Amazon S3 assigns
|
38
38
|
# to all log object keys for a bucket. For more information, see [PUT
|
39
|
-
# Bucket logging][1] in the *Amazon
|
40
|
-
# Reference*.
|
39
|
+
# Bucket logging][1] in the *Amazon S3 API Reference*.
|
41
40
|
#
|
42
41
|
#
|
43
42
|
#
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -454,8 +454,8 @@ module Aws::S3
|
|
454
454
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
455
455
|
# When using this action with an access point through the AWS SDKs, you
|
456
456
|
# provide the access point ARN in place of the bucket name. For more
|
457
|
-
# information about access point ARNs, see [Using
|
458
|
-
# the *Amazon
|
457
|
+
# information about access point ARNs, see [Using access points][1] in
|
458
|
+
# the *Amazon S3 User Guide*.
|
459
459
|
#
|
460
460
|
# When using this action with Amazon S3 on Outposts, you must direct
|
461
461
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -464,7 +464,7 @@ module Aws::S3
|
|
464
464
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
465
465
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
466
466
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
467
|
-
# in the *Amazon
|
467
|
+
# in the *Amazon S3 User Guide*.
|
468
468
|
#
|
469
469
|
#
|
470
470
|
#
|
@@ -482,7 +482,7 @@ module Aws::S3
|
|
482
482
|
# request. Bucket owners need not specify this parameter in their
|
483
483
|
# requests. For information about downloading objects from requester
|
484
484
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
485
|
-
# in the *Amazon S3
|
485
|
+
# in the *Amazon S3 User Guide*.
|
486
486
|
#
|
487
487
|
#
|
488
488
|
#
|
@@ -640,7 +640,7 @@ module Aws::S3
|
|
640
640
|
# request. Bucket owners need not specify this parameter in their
|
641
641
|
# requests. For information about downloading objects from requester
|
642
642
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
643
|
-
# in the *Amazon S3
|
643
|
+
# in the *Amazon S3 User Guide*.
|
644
644
|
#
|
645
645
|
#
|
646
646
|
#
|
@@ -792,9 +792,9 @@ module Aws::S3
|
|
792
792
|
# permissions, you can use the `s3:x-amz-metadata-directive` condition
|
793
793
|
# key to enforce certain metadata behavior when objects are uploaded.
|
794
794
|
# For more information, see [Specifying Conditions in a Policy][6] in
|
795
|
-
# the *Amazon S3
|
796
|
-
#
|
797
|
-
#
|
795
|
+
# the *Amazon S3 User Guide*. For a complete list of Amazon S3-specific
|
796
|
+
# condition keys, see [Actions, Resources, and Condition Keys for Amazon
|
797
|
+
# S3][7].
|
798
798
|
#
|
799
799
|
# <b> <code>x-amz-copy-source-if</code> Headers</b>
|
800
800
|
#
|
@@ -863,7 +863,7 @@ module Aws::S3
|
|
863
863
|
# You can use the `CopyObject` action to change the storage class of an
|
864
864
|
# object that is already stored in Amazon S3 using the `StorageClass`
|
865
865
|
# parameter. For more information, see [Storage Classes][12] in the
|
866
|
-
# *Amazon S3
|
866
|
+
# *Amazon S3 User Guide*.
|
867
867
|
#
|
868
868
|
# **Versioning**
|
869
869
|
#
|
@@ -925,8 +925,8 @@ module Aws::S3
|
|
925
925
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
926
926
|
# When using this action with an access point through the AWS SDKs, you
|
927
927
|
# provide the access point ARN in place of the bucket name. For more
|
928
|
-
# information about access point ARNs, see [Using
|
929
|
-
# the *Amazon
|
928
|
+
# information about access point ARNs, see [Using access points][1] in
|
929
|
+
# the *Amazon S3 User Guide*.
|
930
930
|
#
|
931
931
|
# When using this action with Amazon S3 on Outposts, you must direct
|
932
932
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -935,7 +935,7 @@ module Aws::S3
|
|
935
935
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
936
936
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
937
937
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
938
|
-
# in the *Amazon
|
938
|
+
# in the *Amazon S3 User Guide*.
|
939
939
|
#
|
940
940
|
#
|
941
941
|
#
|
@@ -1067,7 +1067,7 @@ module Aws::S3
|
|
1067
1067
|
# and high availability. Depending on performance needs, you can specify
|
1068
1068
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
1069
1069
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
1070
|
-
# in the *Amazon S3
|
1070
|
+
# in the *Amazon S3 User Guide*.
|
1071
1071
|
#
|
1072
1072
|
#
|
1073
1073
|
#
|
@@ -1099,8 +1099,8 @@ module Aws::S3
|
|
1099
1099
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
1100
1100
|
# via SSL or using SigV4. For information about configuring using any of
|
1101
1101
|
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
1102
|
-
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1103
|
-
#
|
1102
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3 User
|
1103
|
+
# Guide*.
|
1104
1104
|
#
|
1105
1105
|
#
|
1106
1106
|
#
|
@@ -1139,7 +1139,7 @@ module Aws::S3
|
|
1139
1139
|
# request. Bucket owners need not specify this parameter in their
|
1140
1140
|
# requests. For information about downloading objects from requester
|
1141
1141
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1142
|
-
# in the *Amazon S3
|
1142
|
+
# in the *Amazon S3 User Guide*.
|
1143
1143
|
#
|
1144
1144
|
#
|
1145
1145
|
#
|
@@ -1280,7 +1280,7 @@ module Aws::S3
|
|
1280
1280
|
# the bucket, you become the bucket owner.
|
1281
1281
|
#
|
1282
1282
|
# Not every string is an acceptable bucket name. For information about
|
1283
|
-
# bucket naming restrictions, see [
|
1283
|
+
# bucket naming restrictions, see [Bucket naming rules][1].
|
1284
1284
|
#
|
1285
1285
|
# If you want to create an Amazon S3 on Outposts bucket, see [Create
|
1286
1286
|
# Bucket][2].
|
@@ -1374,7 +1374,7 @@ module Aws::S3
|
|
1374
1374
|
#
|
1375
1375
|
#
|
1376
1376
|
#
|
1377
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1377
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
|
1378
1378
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html
|
1379
1379
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro
|
1380
1380
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
@@ -1404,8 +1404,10 @@ module Aws::S3
|
|
1404
1404
|
# Allows grantee to read the bucket ACL.
|
1405
1405
|
#
|
1406
1406
|
# @option params [String] :grant_write
|
1407
|
-
# Allows grantee to create
|
1408
|
-
#
|
1407
|
+
# Allows grantee to create new objects in the bucket.
|
1408
|
+
#
|
1409
|
+
# For the bucket and object owners of existing objects, also allows
|
1410
|
+
# deletions and overwrites of those objects.
|
1409
1411
|
#
|
1410
1412
|
# @option params [String] :grant_write_acp
|
1411
1413
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -1523,11 +1525,12 @@ module Aws::S3
|
|
1523
1525
|
# `CreateMultipartUpload`.
|
1524
1526
|
#
|
1525
1527
|
# To perform a multipart upload with encryption using an AWS KMS CMK,
|
1526
|
-
# the requester must have permission to the `kms:
|
1527
|
-
# `kms:
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1528
|
+
# the requester must have permission to the `kms:Decrypt` and
|
1529
|
+
# `kms:GenerateDataKey*` actions on the key. These permissions are
|
1530
|
+
# required because Amazon S3 must decrypt and read data from the
|
1531
|
+
# encrypted file parts before it completes the multipart upload. For
|
1532
|
+
# more information, see [Multipart upload API and permissions][7] in the
|
1533
|
+
# *Amazon S3 User Guide*.
|
1531
1534
|
#
|
1532
1535
|
# If your AWS Identity and Access Management (IAM) user or role is in
|
1533
1536
|
# the same AWS account as the AWS KMS CMK, then you must have these
|
@@ -1536,7 +1539,7 @@ module Aws::S3
|
|
1536
1539
|
# both the key policy and your IAM user or role.
|
1537
1540
|
#
|
1538
1541
|
# For more information, see [Protecting Data Using Server-Side
|
1539
|
-
# Encryption][
|
1542
|
+
# Encryption][8].
|
1540
1543
|
#
|
1541
1544
|
# Access Permissions
|
1542
1545
|
#
|
@@ -1546,13 +1549,13 @@ module Aws::S3
|
|
1546
1549
|
# request headers:
|
1547
1550
|
#
|
1548
1551
|
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
1549
|
-
# information, see [Canned ACL][
|
1552
|
+
# information, see [Canned ACL][9].
|
1550
1553
|
#
|
1551
1554
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
1552
1555
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
1553
1556
|
# `x-amz-grant-full-control` headers. These parameters map to the
|
1554
1557
|
# set of permissions that Amazon S3 supports in an ACL. For more
|
1555
|
-
# information, see [Access Control List (ACL) Overview][
|
1558
|
+
# information, see [Access Control List (ACL) Overview][10].
|
1556
1559
|
#
|
1557
1560
|
# You can use either a canned ACL or specify access permissions
|
1558
1561
|
# explicitly. You cannot do both.
|
@@ -1588,7 +1591,7 @@ module Aws::S3
|
|
1588
1591
|
#
|
1589
1592
|
# For more information about server-side encryption with CMKs stored
|
1590
1593
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1591
|
-
# Encryption with CMKs stored in AWS KMS][
|
1594
|
+
# Encryption with CMKs stored in AWS KMS][11].
|
1592
1595
|
#
|
1593
1596
|
# * Use customer-provided encryption keys – If you want to manage your
|
1594
1597
|
# own encryption keys, provide all the following headers in the
|
@@ -1602,7 +1605,7 @@ module Aws::S3
|
|
1602
1605
|
#
|
1603
1606
|
# For more information about server-side encryption with CMKs stored
|
1604
1607
|
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1605
|
-
# Encryption with CMKs stored in AWS KMS][
|
1608
|
+
# Encryption with CMKs stored in AWS KMS][11].
|
1606
1609
|
#
|
1607
1610
|
# Access-Control-List (ACL)-Specific Request Headers
|
1608
1611
|
#
|
@@ -1612,19 +1615,19 @@ module Aws::S3
|
|
1612
1615
|
# permissions to individual AWS accounts or to predefined groups
|
1613
1616
|
# defined by Amazon S3. These permissions are then added to the access
|
1614
1617
|
# control list (ACL) on the object. For more information, see [Using
|
1615
|
-
# ACLs][
|
1618
|
+
# ACLs][12]. With this operation, you can grant access permissions
|
1616
1619
|
# using one of the following two methods:
|
1617
1620
|
#
|
1618
1621
|
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
1619
1622
|
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
1620
1623
|
# predefined set of grantees and permissions. For more information,
|
1621
|
-
# see [Canned ACL][
|
1624
|
+
# see [Canned ACL][9].
|
1622
1625
|
#
|
1623
1626
|
# * Specify access permissions explicitly — To explicitly grant access
|
1624
1627
|
# permissions to specific AWS accounts or groups, use the following
|
1625
1628
|
# headers. Each header maps to specific permissions that Amazon S3
|
1626
1629
|
# supports in an ACL. For more information, see [Access Control List
|
1627
|
-
# (ACL) Overview][
|
1630
|
+
# (ACL) Overview][10]. In the header, you specify a list of grantees
|
1628
1631
|
# who get the specific permission. To grant permissions explicitly,
|
1629
1632
|
# use:
|
1630
1633
|
#
|
@@ -1669,7 +1672,7 @@ module Aws::S3
|
|
1669
1672
|
# * South America (São Paulo)
|
1670
1673
|
#
|
1671
1674
|
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1672
|
-
# see [Regions and Endpoints][
|
1675
|
+
# see [Regions and Endpoints][13] in the AWS General Reference.
|
1673
1676
|
#
|
1674
1677
|
# </note>
|
1675
1678
|
#
|
@@ -1683,13 +1686,13 @@ module Aws::S3
|
|
1683
1686
|
#
|
1684
1687
|
# * [UploadPart][1]
|
1685
1688
|
#
|
1686
|
-
# * [CompleteMultipartUpload][
|
1689
|
+
# * [CompleteMultipartUpload][14]
|
1687
1690
|
#
|
1688
|
-
# * [AbortMultipartUpload][
|
1691
|
+
# * [AbortMultipartUpload][15]
|
1689
1692
|
#
|
1690
|
-
# * [ListParts][
|
1693
|
+
# * [ListParts][16]
|
1691
1694
|
#
|
1692
|
-
# * [ListMultipartUploads][
|
1695
|
+
# * [ListMultipartUploads][17]
|
1693
1696
|
#
|
1694
1697
|
#
|
1695
1698
|
#
|
@@ -1699,16 +1702,17 @@ module Aws::S3
|
|
1699
1702
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
1700
1703
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
1701
1704
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html
|
1702
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1703
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1704
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1705
|
-
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1706
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
1707
|
-
# [12]: https://docs.aws.amazon.com/
|
1708
|
-
# [13]: https://docs.aws.amazon.com/
|
1709
|
-
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1710
|
-
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1711
|
-
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
1705
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions
|
1706
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
1707
|
+
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1708
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1709
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1710
|
+
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1711
|
+
# [13]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1712
|
+
# [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
|
1713
|
+
# [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
|
1714
|
+
# [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
|
1715
|
+
# [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
|
1712
1716
|
#
|
1713
1717
|
# @option params [String] :acl
|
1714
1718
|
# The canned ACL to apply to the object.
|
@@ -1723,8 +1727,8 @@ module Aws::S3
|
|
1723
1727
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1724
1728
|
# When using this action with an access point through the AWS SDKs, you
|
1725
1729
|
# provide the access point ARN in place of the bucket name. For more
|
1726
|
-
# information about access point ARNs, see [Using
|
1727
|
-
# the *Amazon
|
1730
|
+
# information about access point ARNs, see [Using access points][1] in
|
1731
|
+
# the *Amazon S3 User Guide*.
|
1728
1732
|
#
|
1729
1733
|
# When using this action with Amazon S3 on Outposts, you must direct
|
1730
1734
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -1733,7 +1737,7 @@ module Aws::S3
|
|
1733
1737
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
1734
1738
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
1735
1739
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
1736
|
-
# in the *Amazon
|
1740
|
+
# in the *Amazon S3 User Guide*.
|
1737
1741
|
#
|
1738
1742
|
#
|
1739
1743
|
#
|
@@ -1797,7 +1801,7 @@ module Aws::S3
|
|
1797
1801
|
# and high availability. Depending on performance needs, you can specify
|
1798
1802
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
1799
1803
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
1800
|
-
# in the *Amazon S3
|
1804
|
+
# in the *Amazon S3 User Guide*.
|
1801
1805
|
#
|
1802
1806
|
#
|
1803
1807
|
#
|
@@ -1830,7 +1834,7 @@ module Aws::S3
|
|
1830
1834
|
# protected by AWS KMS will fail if not made via SSL or using SigV4. For
|
1831
1835
|
# information about configuring using any of the officially supported
|
1832
1836
|
# AWS SDKs and AWS CLI, see [Specifying the Signature Version in Request
|
1833
|
-
# Authentication][1] in the *Amazon S3
|
1837
|
+
# Authentication][1] in the *Amazon S3 User Guide*.
|
1834
1838
|
#
|
1835
1839
|
#
|
1836
1840
|
#
|
@@ -1855,7 +1859,7 @@ module Aws::S3
|
|
1855
1859
|
# request. Bucket owners need not specify this parameter in their
|
1856
1860
|
# requests. For information about downloading objects from requester
|
1857
1861
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1858
|
-
# in the *Amazon S3
|
1862
|
+
# in the *Amazon S3 User Guide*.
|
1859
1863
|
#
|
1860
1864
|
#
|
1861
1865
|
#
|
@@ -2573,7 +2577,7 @@ module Aws::S3
|
|
2573
2577
|
# </note>
|
2574
2578
|
#
|
2575
2579
|
# For information about replication configuration, see [Replication][3]
|
2576
|
-
# in the *Amazon S3
|
2580
|
+
# in the *Amazon S3 User Guide*.
|
2577
2581
|
#
|
2578
2582
|
# The following operations are related to `DeleteBucketReplication`\:
|
2579
2583
|
#
|
@@ -2742,7 +2746,8 @@ module Aws::S3
|
|
2742
2746
|
|
2743
2747
|
# Removes the null version (if there is one) of an object and inserts a
|
2744
2748
|
# delete marker, which becomes the latest version of the object. If
|
2745
|
-
# there isn't a null version, Amazon S3 does not remove any objects
|
2749
|
+
# there isn't a null version, Amazon S3 does not remove any objects but
|
2750
|
+
# will still respond that the command was successful.
|
2746
2751
|
#
|
2747
2752
|
# To remove a specific version, you must be the bucket owner and you
|
2748
2753
|
# must use the version Id subresource. Using this subresource
|
@@ -2786,8 +2791,8 @@ module Aws::S3
|
|
2786
2791
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2787
2792
|
# When using this action with an access point through the AWS SDKs, you
|
2788
2793
|
# provide the access point ARN in place of the bucket name. For more
|
2789
|
-
# information about access point ARNs, see [Using
|
2790
|
-
# the *Amazon
|
2794
|
+
# information about access point ARNs, see [Using access points][1] in
|
2795
|
+
# the *Amazon S3 User Guide*.
|
2791
2796
|
#
|
2792
2797
|
# When using this action with Amazon S3 on Outposts, you must direct
|
2793
2798
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -2796,7 +2801,7 @@ module Aws::S3
|
|
2796
2801
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2797
2802
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2798
2803
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2799
|
-
# in the *Amazon
|
2804
|
+
# in the *Amazon S3 User Guide*.
|
2800
2805
|
#
|
2801
2806
|
#
|
2802
2807
|
#
|
@@ -2820,7 +2825,7 @@ module Aws::S3
|
|
2820
2825
|
# request. Bucket owners need not specify this parameter in their
|
2821
2826
|
# requests. For information about downloading objects from requester
|
2822
2827
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2823
|
-
# in the *Amazon S3
|
2828
|
+
# in the *Amazon S3 User Guide*.
|
2824
2829
|
#
|
2825
2830
|
#
|
2826
2831
|
#
|
@@ -2922,8 +2927,8 @@ module Aws::S3
|
|
2922
2927
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2923
2928
|
# When using this action with an access point through the AWS SDKs, you
|
2924
2929
|
# provide the access point ARN in place of the bucket name. For more
|
2925
|
-
# information about access point ARNs, see [Using
|
2926
|
-
# the *Amazon
|
2930
|
+
# information about access point ARNs, see [Using access points][1] in
|
2931
|
+
# the *Amazon S3 User Guide*.
|
2927
2932
|
#
|
2928
2933
|
# When using this action with Amazon S3 on Outposts, you must direct
|
2929
2934
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -2932,7 +2937,7 @@ module Aws::S3
|
|
2932
2937
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2933
2938
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2934
2939
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2935
|
-
# in the *Amazon
|
2940
|
+
# in the *Amazon S3 User Guide*.
|
2936
2941
|
#
|
2937
2942
|
#
|
2938
2943
|
#
|
@@ -3070,8 +3075,8 @@ module Aws::S3
|
|
3070
3075
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3071
3076
|
# When using this action with an access point through the AWS SDKs, you
|
3072
3077
|
# provide the access point ARN in place of the bucket name. For more
|
3073
|
-
# information about access point ARNs, see [Using
|
3074
|
-
# the *Amazon
|
3078
|
+
# information about access point ARNs, see [Using access points][1] in
|
3079
|
+
# the *Amazon S3 User Guide*.
|
3075
3080
|
#
|
3076
3081
|
# When using this action with Amazon S3 on Outposts, you must direct
|
3077
3082
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -3080,7 +3085,7 @@ module Aws::S3
|
|
3080
3085
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
3081
3086
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
3082
3087
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
3083
|
-
# in the *Amazon
|
3088
|
+
# in the *Amazon S3 User Guide*.
|
3084
3089
|
#
|
3085
3090
|
#
|
3086
3091
|
#
|
@@ -3101,7 +3106,7 @@ module Aws::S3
|
|
3101
3106
|
# request. Bucket owners need not specify this parameter in their
|
3102
3107
|
# requests. For information about downloading objects from requester
|
3103
3108
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
3104
|
-
# in the *Amazon S3
|
3109
|
+
# in the *Amazon S3 User Guide*.
|
3105
3110
|
#
|
3106
3111
|
#
|
3107
3112
|
#
|
@@ -5230,8 +5235,8 @@ module Aws::S3
|
|
5230
5235
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5231
5236
|
# When using this action with an access point through the AWS SDKs, you
|
5232
5237
|
# provide the access point ARN in place of the bucket name. For more
|
5233
|
-
# information about access point ARNs, see [Using
|
5234
|
-
# the *Amazon
|
5238
|
+
# information about access point ARNs, see [Using access points][1] in
|
5239
|
+
# the *Amazon S3 User Guide*.
|
5235
5240
|
#
|
5236
5241
|
# When using this action with Amazon S3 on Outposts, you must direct
|
5237
5242
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -5240,7 +5245,7 @@ module Aws::S3
|
|
5240
5245
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5241
5246
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5242
5247
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5243
|
-
# in the *Amazon
|
5248
|
+
# in the *Amazon S3 User Guide*.
|
5244
5249
|
#
|
5245
5250
|
#
|
5246
5251
|
#
|
@@ -5322,7 +5327,7 @@ module Aws::S3
|
|
5322
5327
|
# request. Bucket owners need not specify this parameter in their
|
5323
5328
|
# requests. For information about downloading objects from requester
|
5324
5329
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5325
|
-
# in the *Amazon S3
|
5330
|
+
# in the *Amazon S3 User Guide*.
|
5326
5331
|
#
|
5327
5332
|
#
|
5328
5333
|
#
|
@@ -5376,49 +5381,49 @@ module Aws::S3
|
|
5376
5381
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5377
5382
|
#
|
5378
5383
|
#
|
5379
|
-
# @example Example: To retrieve an object
|
5384
|
+
# @example Example: To retrieve a byte range of an object
|
5380
5385
|
#
|
5381
|
-
# # The following example retrieves an object for an S3 bucket.
|
5386
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5387
|
+
# # specific byte range.
|
5382
5388
|
#
|
5383
5389
|
# resp = client.get_object({
|
5384
5390
|
# bucket: "examplebucket",
|
5385
|
-
# key: "
|
5391
|
+
# key: "SampleFile.txt",
|
5392
|
+
# range: "bytes=0-9",
|
5386
5393
|
# })
|
5387
5394
|
#
|
5388
5395
|
# resp.to_h outputs the following:
|
5389
5396
|
# {
|
5390
5397
|
# accept_ranges: "bytes",
|
5391
|
-
# content_length:
|
5392
|
-
#
|
5393
|
-
#
|
5394
|
-
#
|
5398
|
+
# content_length: 10,
|
5399
|
+
# content_range: "bytes 0-9/43",
|
5400
|
+
# content_type: "text/plain",
|
5401
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5402
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5395
5403
|
# metadata: {
|
5396
5404
|
# },
|
5397
|
-
# tag_count: 2,
|
5398
5405
|
# version_id: "null",
|
5399
5406
|
# }
|
5400
5407
|
#
|
5401
|
-
# @example Example: To retrieve
|
5408
|
+
# @example Example: To retrieve an object
|
5402
5409
|
#
|
5403
|
-
# # The following example retrieves an object for an S3 bucket.
|
5404
|
-
# # specific byte range.
|
5410
|
+
# # The following example retrieves an object for an S3 bucket.
|
5405
5411
|
#
|
5406
5412
|
# resp = client.get_object({
|
5407
5413
|
# bucket: "examplebucket",
|
5408
|
-
# key: "
|
5409
|
-
# range: "bytes=0-9",
|
5414
|
+
# key: "HappyFace.jpg",
|
5410
5415
|
# })
|
5411
5416
|
#
|
5412
5417
|
# resp.to_h outputs the following:
|
5413
5418
|
# {
|
5414
5419
|
# accept_ranges: "bytes",
|
5415
|
-
# content_length:
|
5416
|
-
#
|
5417
|
-
#
|
5418
|
-
#
|
5419
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5420
|
+
# content_length: 3191,
|
5421
|
+
# content_type: "image/jpeg",
|
5422
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5423
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5420
5424
|
# metadata: {
|
5421
5425
|
# },
|
5426
|
+
# tag_count: 2,
|
5422
5427
|
# version_id: "null",
|
5423
5428
|
# }
|
5424
5429
|
#
|
@@ -5556,8 +5561,8 @@ module Aws::S3
|
|
5556
5561
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5557
5562
|
# When using this action with an access point through the AWS SDKs, you
|
5558
5563
|
# provide the access point ARN in place of the bucket name. For more
|
5559
|
-
# information about access point ARNs, see [Using
|
5560
|
-
# the *Amazon
|
5564
|
+
# information about access point ARNs, see [Using access points][1] in
|
5565
|
+
# the *Amazon S3 User Guide*.
|
5561
5566
|
#
|
5562
5567
|
#
|
5563
5568
|
#
|
@@ -5574,7 +5579,7 @@ module Aws::S3
|
|
5574
5579
|
# request. Bucket owners need not specify this parameter in their
|
5575
5580
|
# requests. For information about downloading objects from requester
|
5576
5581
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5577
|
-
# in the *Amazon S3
|
5582
|
+
# in the *Amazon S3 User Guide*.
|
5578
5583
|
#
|
5579
5584
|
#
|
5580
5585
|
#
|
@@ -5693,8 +5698,8 @@ module Aws::S3
|
|
5693
5698
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5694
5699
|
# When using this action with an access point through the AWS SDKs, you
|
5695
5700
|
# provide the access point ARN in place of the bucket name. For more
|
5696
|
-
# information about access point ARNs, see [Using
|
5697
|
-
# the *Amazon
|
5701
|
+
# information about access point ARNs, see [Using access points][1] in
|
5702
|
+
# the *Amazon S3 User Guide*.
|
5698
5703
|
#
|
5699
5704
|
#
|
5700
5705
|
#
|
@@ -5713,7 +5718,7 @@ module Aws::S3
|
|
5713
5718
|
# request. Bucket owners need not specify this parameter in their
|
5714
5719
|
# requests. For information about downloading objects from requester
|
5715
5720
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5716
|
-
# in the *Amazon S3
|
5721
|
+
# in the *Amazon S3 User Guide*.
|
5717
5722
|
#
|
5718
5723
|
#
|
5719
5724
|
#
|
@@ -5768,8 +5773,8 @@ module Aws::S3
|
|
5768
5773
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5769
5774
|
# When using this action with an access point through the AWS SDKs, you
|
5770
5775
|
# provide the access point ARN in place of the bucket name. For more
|
5771
|
-
# information about access point ARNs, see [Using
|
5772
|
-
# the *Amazon
|
5776
|
+
# information about access point ARNs, see [Using access points][1] in
|
5777
|
+
# the *Amazon S3 User Guide*.
|
5773
5778
|
#
|
5774
5779
|
#
|
5775
5780
|
#
|
@@ -5825,8 +5830,8 @@ module Aws::S3
|
|
5825
5830
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5826
5831
|
# When using this action with an access point through the AWS SDKs, you
|
5827
5832
|
# provide the access point ARN in place of the bucket name. For more
|
5828
|
-
# information about access point ARNs, see [Using
|
5829
|
-
# the *Amazon
|
5833
|
+
# information about access point ARNs, see [Using access points][1] in
|
5834
|
+
# the *Amazon S3 User Guide*.
|
5830
5835
|
#
|
5831
5836
|
#
|
5832
5837
|
#
|
@@ -5845,7 +5850,7 @@ module Aws::S3
|
|
5845
5850
|
# request. Bucket owners need not specify this parameter in their
|
5846
5851
|
# requests. For information about downloading objects from requester
|
5847
5852
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5848
|
-
# in the *Amazon S3
|
5853
|
+
# in the *Amazon S3 User Guide*.
|
5849
5854
|
#
|
5850
5855
|
#
|
5851
5856
|
#
|
@@ -5921,8 +5926,8 @@ module Aws::S3
|
|
5921
5926
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5922
5927
|
# When using this action with an access point through the AWS SDKs, you
|
5923
5928
|
# provide the access point ARN in place of the bucket name. For more
|
5924
|
-
# information about access point ARNs, see [Using
|
5925
|
-
# the *Amazon
|
5929
|
+
# information about access point ARNs, see [Using access points][1] in
|
5930
|
+
# the *Amazon S3 User Guide*.
|
5926
5931
|
#
|
5927
5932
|
# When using this action with Amazon S3 on Outposts, you must direct
|
5928
5933
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -5931,7 +5936,7 @@ module Aws::S3
|
|
5931
5936
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5932
5937
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5933
5938
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5934
|
-
# in the *Amazon
|
5939
|
+
# in the *Amazon S3 User Guide*.
|
5935
5940
|
#
|
5936
5941
|
#
|
5937
5942
|
#
|
@@ -5954,7 +5959,7 @@ module Aws::S3
|
|
5954
5959
|
# request. Bucket owners need not specify this parameter in their
|
5955
5960
|
# requests. For information about downloading objects from requester
|
5956
5961
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5957
|
-
# in the *Amazon S3
|
5962
|
+
# in the *Amazon S3 User Guide*.
|
5958
5963
|
#
|
5959
5964
|
#
|
5960
5965
|
#
|
@@ -6077,7 +6082,7 @@ module Aws::S3
|
|
6077
6082
|
# request. Bucket owners need not specify this parameter in their
|
6078
6083
|
# requests. For information about downloading objects from requester
|
6079
6084
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
6080
|
-
# in the *Amazon S3
|
6085
|
+
# in the *Amazon S3 User Guide*.
|
6081
6086
|
#
|
6082
6087
|
#
|
6083
6088
|
#
|
@@ -6230,8 +6235,8 @@ module Aws::S3
|
|
6230
6235
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6231
6236
|
# When using this action with an access point through the AWS SDKs, you
|
6232
6237
|
# provide the access point ARN in place of the bucket name. For more
|
6233
|
-
# information about access point ARNs, see [Using
|
6234
|
-
# the *Amazon
|
6238
|
+
# information about access point ARNs, see [Using access points][1] in
|
6239
|
+
# the *Amazon S3 User Guide*.
|
6235
6240
|
#
|
6236
6241
|
# When using this action with Amazon S3 on Outposts, you must direct
|
6237
6242
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -6240,7 +6245,7 @@ module Aws::S3
|
|
6240
6245
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6241
6246
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6242
6247
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6243
|
-
# in the *Amazon
|
6248
|
+
# in the *Amazon S3 User Guide*.
|
6244
6249
|
#
|
6245
6250
|
#
|
6246
6251
|
#
|
@@ -6383,8 +6388,8 @@ module Aws::S3
|
|
6383
6388
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6384
6389
|
# When using this action with an access point through the AWS SDKs, you
|
6385
6390
|
# provide the access point ARN in place of the bucket name. For more
|
6386
|
-
# information about access point ARNs, see [Using
|
6387
|
-
# the *Amazon
|
6391
|
+
# information about access point ARNs, see [Using access points][1] in
|
6392
|
+
# the *Amazon S3 User Guide*.
|
6388
6393
|
#
|
6389
6394
|
# When using this action with Amazon S3 on Outposts, you must direct
|
6390
6395
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -6393,7 +6398,7 @@ module Aws::S3
|
|
6393
6398
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6394
6399
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6395
6400
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6396
|
-
# in the *Amazon
|
6401
|
+
# in the *Amazon S3 User Guide*.
|
6397
6402
|
#
|
6398
6403
|
#
|
6399
6404
|
#
|
@@ -6457,7 +6462,7 @@ module Aws::S3
|
|
6457
6462
|
# request. Bucket owners need not specify this parameter in their
|
6458
6463
|
# requests. For information about downloading objects from requester
|
6459
6464
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
6460
|
-
# in the *Amazon S3
|
6465
|
+
# in the *Amazon S3 User Guide*.
|
6461
6466
|
#
|
6462
6467
|
#
|
6463
6468
|
#
|
@@ -7090,8 +7095,8 @@ module Aws::S3
|
|
7090
7095
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7091
7096
|
# When using this action with an access point through the AWS SDKs, you
|
7092
7097
|
# provide the access point ARN in place of the bucket name. For more
|
7093
|
-
# information about access point ARNs, see [Using
|
7094
|
-
# the *Amazon
|
7098
|
+
# information about access point ARNs, see [Using access points][1] in
|
7099
|
+
# the *Amazon S3 User Guide*.
|
7095
7100
|
#
|
7096
7101
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7097
7102
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7100,7 +7105,7 @@ module Aws::S3
|
|
7100
7105
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7101
7106
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7102
7107
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7103
|
-
# in the *Amazon
|
7108
|
+
# in the *Amazon S3 User Guide*.
|
7104
7109
|
#
|
7105
7110
|
#
|
7106
7111
|
#
|
@@ -7325,6 +7330,9 @@ module Aws::S3
|
|
7325
7330
|
# can also use request parameters as selection criteria to return
|
7326
7331
|
# metadata about a subset of all the object versions.
|
7327
7332
|
#
|
7333
|
+
# To use this operation, you must have permissions to perform the
|
7334
|
+
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
7335
|
+
#
|
7328
7336
|
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
7329
7337
|
# design your application to parse the contents of the response and
|
7330
7338
|
# handle it appropriately.
|
@@ -7552,8 +7560,8 @@ module Aws::S3
|
|
7552
7560
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7553
7561
|
# When using this action with an access point through the AWS SDKs, you
|
7554
7562
|
# provide the access point ARN in place of the bucket name. For more
|
7555
|
-
# information about access point ARNs, see [Using
|
7556
|
-
# the *Amazon
|
7563
|
+
# information about access point ARNs, see [Using access points][1] in
|
7564
|
+
# the *Amazon S3 User Guide*.
|
7557
7565
|
#
|
7558
7566
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7559
7567
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7562,7 +7570,7 @@ module Aws::S3
|
|
7562
7570
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7563
7571
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7564
7572
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7565
|
-
# in the *Amazon
|
7573
|
+
# in the *Amazon S3 User Guide*.
|
7566
7574
|
#
|
7567
7575
|
#
|
7568
7576
|
#
|
@@ -7698,13 +7706,14 @@ module Aws::S3
|
|
7698
7706
|
req.send_request(options)
|
7699
7707
|
end
|
7700
7708
|
|
7701
|
-
# Returns some or all (up to 1,000) of the objects in a bucket
|
7702
|
-
# use the request parameters as selection criteria to
|
7703
|
-
# the objects in a bucket. A `200 OK` response can
|
7704
|
-
# invalid XML. Make sure to design your application to
|
7705
|
-
# contents of the response and handle it appropriately.
|
7706
|
-
# returned sorted in an ascending order of the respective
|
7707
|
-
# the list.
|
7709
|
+
# Returns some or all (up to 1,000) of the objects in a bucket with each
|
7710
|
+
# request. You can use the request parameters as selection criteria to
|
7711
|
+
# return a subset of the objects in a bucket. A `200 OK` response can
|
7712
|
+
# contain valid or invalid XML. Make sure to design your application to
|
7713
|
+
# parse the contents of the response and handle it appropriately.
|
7714
|
+
# Objects are returned sorted in an ascending order of the respective
|
7715
|
+
# key names in the list. For more information about listing objects, see
|
7716
|
+
# [Listing object keys programmatically][1]
|
7708
7717
|
#
|
7709
7718
|
# To use this operation, you must have READ access to the bucket.
|
7710
7719
|
#
|
@@ -7712,33 +7721,34 @@ module Aws::S3
|
|
7712
7721
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
7713
7722
|
# action. The bucket owner has this permission by default and can grant
|
7714
7723
|
# this permission to others. For more information about permissions, see
|
7715
|
-
# [Permissions Related to Bucket Subresource Operations][
|
7716
|
-
# [Managing Access Permissions to Your Amazon S3 Resources][
|
7724
|
+
# [Permissions Related to Bucket Subresource Operations][2] and
|
7725
|
+
# [Managing Access Permissions to Your Amazon S3 Resources][3].
|
7717
7726
|
#
|
7718
7727
|
# This section describes the latest revision of this action. We
|
7719
7728
|
# recommend that you use this revised API for application development.
|
7720
7729
|
# For backward compatibility, Amazon S3 continues to support the prior
|
7721
|
-
# version of this API, [ListObjects][
|
7730
|
+
# version of this API, [ListObjects][4].
|
7722
7731
|
#
|
7723
|
-
# To get a list of your buckets, see [ListBuckets][
|
7732
|
+
# To get a list of your buckets, see [ListBuckets][5].
|
7724
7733
|
#
|
7725
7734
|
# The following operations are related to `ListObjectsV2`\:
|
7726
7735
|
#
|
7727
|
-
# * [GetObject][
|
7736
|
+
# * [GetObject][6]
|
7728
7737
|
#
|
7729
|
-
# * [PutObject][
|
7738
|
+
# * [PutObject][7]
|
7730
7739
|
#
|
7731
|
-
# * [CreateBucket][
|
7740
|
+
# * [CreateBucket][8]
|
7732
7741
|
#
|
7733
7742
|
#
|
7734
7743
|
#
|
7735
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
7736
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-
|
7737
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7738
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7739
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7740
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7741
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
7744
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html
|
7745
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7746
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7747
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7748
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7749
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
7750
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
7751
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
7742
7752
|
#
|
7743
7753
|
# @option params [required, String] :bucket
|
7744
7754
|
# Bucket name to list.
|
@@ -7748,8 +7758,8 @@ module Aws::S3
|
|
7748
7758
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7749
7759
|
# When using this action with an access point through the AWS SDKs, you
|
7750
7760
|
# provide the access point ARN in place of the bucket name. For more
|
7751
|
-
# information about access point ARNs, see [Using
|
7752
|
-
# the *Amazon
|
7761
|
+
# information about access point ARNs, see [Using access points][1] in
|
7762
|
+
# the *Amazon S3 User Guide*.
|
7753
7763
|
#
|
7754
7764
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7755
7765
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7758,7 +7768,7 @@ module Aws::S3
|
|
7758
7768
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7759
7769
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7760
7770
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7761
|
-
# in the *Amazon
|
7771
|
+
# in the *Amazon S3 User Guide*.
|
7762
7772
|
#
|
7763
7773
|
#
|
7764
7774
|
#
|
@@ -7954,8 +7964,8 @@ module Aws::S3
|
|
7954
7964
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7955
7965
|
# When using this action with an access point through the AWS SDKs, you
|
7956
7966
|
# provide the access point ARN in place of the bucket name. For more
|
7957
|
-
# information about access point ARNs, see [Using
|
7958
|
-
# the *Amazon
|
7967
|
+
# information about access point ARNs, see [Using access points][1] in
|
7968
|
+
# the *Amazon S3 User Guide*.
|
7959
7969
|
#
|
7960
7970
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7961
7971
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7964,7 +7974,7 @@ module Aws::S3
|
|
7964
7974
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7965
7975
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7966
7976
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7967
|
-
# in the *Amazon
|
7977
|
+
# in the *Amazon S3 User Guide*.
|
7968
7978
|
#
|
7969
7979
|
#
|
7970
7980
|
#
|
@@ -7990,7 +8000,7 @@ module Aws::S3
|
|
7990
8000
|
# request. Bucket owners need not specify this parameter in their
|
7991
8001
|
# requests. For information about downloading objects from requester
|
7992
8002
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
7993
|
-
# in the *Amazon S3
|
8003
|
+
# in the *Amazon S3 User Guide*.
|
7994
8004
|
#
|
7995
8005
|
#
|
7996
8006
|
#
|
@@ -8370,8 +8380,10 @@ module Aws::S3
|
|
8370
8380
|
# Allows grantee to read the bucket ACL.
|
8371
8381
|
#
|
8372
8382
|
# @option params [String] :grant_write
|
8373
|
-
# Allows grantee to create
|
8374
|
-
#
|
8383
|
+
# Allows grantee to create new objects in the bucket.
|
8384
|
+
#
|
8385
|
+
# For the bucket and object owners of existing objects, also allows
|
8386
|
+
# deletions and overwrites of those objects.
|
8375
8387
|
#
|
8376
8388
|
# @option params [String] :grant_write_acp
|
8377
8389
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -8770,7 +8782,7 @@ module Aws::S3
|
|
8770
8782
|
# with Amazon S3-managed keys (SSE-S3) or customer master keys stored in
|
8771
8783
|
# AWS KMS (SSE-KMS). For information about the Amazon S3 default
|
8772
8784
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
8773
|
-
# the *Amazon
|
8785
|
+
# the *Amazon S3 User Guide*.
|
8774
8786
|
#
|
8775
8787
|
#
|
8776
8788
|
#
|
@@ -9203,8 +9215,7 @@ module Aws::S3
|
|
9203
9215
|
|
9204
9216
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9205
9217
|
# existing lifecycle configuration. For information about lifecycle
|
9206
|
-
# configuration, see [Managing
|
9207
|
-
# Resources][1].
|
9218
|
+
# configuration, see [Managing your storage lifecycle][1].
|
9208
9219
|
#
|
9209
9220
|
# <note markdown="1"> Bucket lifecycle configuration now supports specifying a lifecycle
|
9210
9221
|
# rule using an object key name prefix, one or more object tags, or a
|
@@ -9261,25 +9272,26 @@ module Aws::S3
|
|
9261
9272
|
# * s3:PutLifecycleConfiguration
|
9262
9273
|
#
|
9263
9274
|
# For more information about permissions, see [Managing Access
|
9264
|
-
# Permissions to Your Amazon S3 Resources][
|
9275
|
+
# Permissions to Your Amazon S3 Resources][5].
|
9265
9276
|
#
|
9266
9277
|
# The following are related to `PutBucketLifecycleConfiguration`\:
|
9267
9278
|
#
|
9268
|
-
# * [Examples of Lifecycle Configuration][
|
9279
|
+
# * [Examples of Lifecycle Configuration][6]
|
9269
9280
|
#
|
9270
|
-
# * [GetBucketLifecycleConfiguration][
|
9281
|
+
# * [GetBucketLifecycleConfiguration][7]
|
9271
9282
|
#
|
9272
|
-
# * [DeleteBucketLifecycle][
|
9283
|
+
# * [DeleteBucketLifecycle][8]
|
9273
9284
|
#
|
9274
9285
|
#
|
9275
9286
|
#
|
9276
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/
|
9287
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
|
9277
9288
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9278
9289
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9279
9290
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
9280
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9281
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9282
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
9291
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9292
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html
|
9293
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
9294
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
9283
9295
|
#
|
9284
9296
|
# @option params [required, String] :bucket
|
9285
9297
|
# The name of the bucket for which to set the configuration.
|
@@ -10012,8 +10024,7 @@ module Aws::S3
|
|
10012
10024
|
end
|
10013
10025
|
|
10014
10026
|
# Creates a replication configuration or replaces an existing one. For
|
10015
|
-
# more information, see [Replication][1] in the *Amazon S3
|
10016
|
-
# Guide*.
|
10027
|
+
# more information, see [Replication][1] in the *Amazon S3 User Guide*.
|
10017
10028
|
#
|
10018
10029
|
# <note markdown="1"> To perform this operation, the user or role performing the action must
|
10019
10030
|
# have the [iam:PassRole][2] permission.
|
@@ -10729,8 +10740,7 @@ module Aws::S3
|
|
10729
10740
|
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
10730
10741
|
# object with a retention period configured using Amazon S3 Object Lock.
|
10731
10742
|
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
10732
|
-
# Object Lock Overview][1] in the *Amazon
|
10733
|
-
# Developer Guide*.
|
10743
|
+
# Object Lock Overview][1] in the *Amazon S3 User Guide*.
|
10734
10744
|
#
|
10735
10745
|
# </note>
|
10736
10746
|
#
|
@@ -10765,7 +10775,7 @@ module Aws::S3
|
|
10765
10775
|
# and high availability. Depending on performance needs, you can specify
|
10766
10776
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
10767
10777
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][6]
|
10768
|
-
# in the *Amazon S3
|
10778
|
+
# in the *Amazon S3 User Guide*.
|
10769
10779
|
#
|
10770
10780
|
# **Versioning**
|
10771
10781
|
#
|
@@ -10819,8 +10829,8 @@ module Aws::S3
|
|
10819
10829
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10820
10830
|
# When using this action with an access point through the AWS SDKs, you
|
10821
10831
|
# provide the access point ARN in place of the bucket name. For more
|
10822
|
-
# information about access point ARNs, see [Using
|
10823
|
-
# the *Amazon
|
10832
|
+
# information about access point ARNs, see [Using access points][1] in
|
10833
|
+
# the *Amazon S3 User Guide*.
|
10824
10834
|
#
|
10825
10835
|
# When using this action with Amazon S3 on Outposts, you must direct
|
10826
10836
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -10829,7 +10839,7 @@ module Aws::S3
|
|
10829
10839
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
10830
10840
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
10831
10841
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
10832
|
-
# in the *Amazon
|
10842
|
+
# in the *Amazon S3 User Guide*.
|
10833
10843
|
#
|
10834
10844
|
#
|
10835
10845
|
#
|
@@ -10944,7 +10954,7 @@ module Aws::S3
|
|
10944
10954
|
# and high availability. Depending on performance needs, you can specify
|
10945
10955
|
# a different Storage Class. Amazon S3 on Outposts only uses the
|
10946
10956
|
# OUTPOSTS Storage Class. For more information, see [Storage Classes][1]
|
10947
|
-
# in the *Amazon S3
|
10957
|
+
# in the *Amazon S3 User Guide*.
|
10948
10958
|
#
|
10949
10959
|
#
|
10950
10960
|
#
|
@@ -10996,14 +11006,12 @@ module Aws::S3
|
|
10996
11006
|
# If `x-amz-server-side-encryption` is present and has the value of
|
10997
11007
|
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
10998
11008
|
# Service (AWS KMS) symmetrical customer managed customer master key
|
10999
|
-
# (CMK) that was used for the object.
|
11000
|
-
#
|
11001
|
-
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
11002
|
-
# header specifies the ID of the symmetric customer managed AWS KMS CMK
|
11003
|
-
# that will be used for the object. If you specify
|
11009
|
+
# (CMK) that was used for the object. If you specify
|
11004
11010
|
# `x-amz-server-side-encryption:aws:kms`, but do not provide`
|
11005
11011
|
# x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 uses the AWS
|
11006
|
-
# managed CMK in AWS to protect the data.
|
11012
|
+
# managed CMK in AWS to protect the data. If the KMS key does not exist
|
11013
|
+
# in the same account issuing the command, you must use the full ARN and
|
11014
|
+
# not just the ID.
|
11007
11015
|
#
|
11008
11016
|
# @option params [String] :ssekms_encryption_context
|
11009
11017
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -11024,7 +11032,7 @@ module Aws::S3
|
|
11024
11032
|
# request. Bucket owners need not specify this parameter in their
|
11025
11033
|
# requests. For information about downloading objects from requester
|
11026
11034
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11027
|
-
# in the *Amazon S3
|
11035
|
+
# in the *Amazon S3 User Guide*.
|
11028
11036
|
#
|
11029
11037
|
#
|
11030
11038
|
#
|
@@ -11067,37 +11075,25 @@ module Aws::S3
|
|
11067
11075
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11068
11076
|
#
|
11069
11077
|
#
|
11070
|
-
# @example Example: To upload
|
11071
|
-
#
|
11072
|
-
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11073
|
-
# # syntax. S3 returns VersionId of the newly created object.
|
11074
|
-
#
|
11075
|
-
# resp = client.put_object({
|
11076
|
-
# body: "HappyFace.jpg",
|
11077
|
-
# bucket: "examplebucket",
|
11078
|
-
# key: "HappyFace.jpg",
|
11079
|
-
# })
|
11080
|
-
#
|
11081
|
-
# resp.to_h outputs the following:
|
11082
|
-
# {
|
11083
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11084
|
-
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11085
|
-
# }
|
11086
|
-
#
|
11087
|
-
# @example Example: To create an object.
|
11078
|
+
# @example Example: To upload object and specify user-defined metadata
|
11088
11079
|
#
|
11089
|
-
# # The following example creates an object.
|
11080
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
11081
|
+
# # enabled, S3 returns version ID in response.
|
11090
11082
|
#
|
11091
11083
|
# resp = client.put_object({
|
11092
11084
|
# body: "filetoupload",
|
11093
11085
|
# bucket: "examplebucket",
|
11094
|
-
# key: "
|
11086
|
+
# key: "exampleobject",
|
11087
|
+
# metadata: {
|
11088
|
+
# "metadata1" => "value1",
|
11089
|
+
# "metadata2" => "value2",
|
11090
|
+
# },
|
11095
11091
|
# })
|
11096
11092
|
#
|
11097
11093
|
# resp.to_h outputs the following:
|
11098
11094
|
# {
|
11099
11095
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11100
|
-
# version_id: "
|
11096
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11101
11097
|
# }
|
11102
11098
|
#
|
11103
11099
|
# @example Example: To upload an object (specify optional headers)
|
@@ -11120,43 +11116,41 @@ module Aws::S3
|
|
11120
11116
|
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11121
11117
|
# }
|
11122
11118
|
#
|
11123
|
-
# @example Example: To upload object
|
11119
|
+
# @example Example: To upload an object
|
11124
11120
|
#
|
11125
|
-
# # The following example
|
11126
|
-
# #
|
11121
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11122
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11127
11123
|
#
|
11128
11124
|
# resp = client.put_object({
|
11129
|
-
# body: "
|
11125
|
+
# body: "HappyFace.jpg",
|
11130
11126
|
# bucket: "examplebucket",
|
11131
|
-
# key: "
|
11132
|
-
# metadata: {
|
11133
|
-
# "metadata1" => "value1",
|
11134
|
-
# "metadata2" => "value2",
|
11135
|
-
# },
|
11127
|
+
# key: "HappyFace.jpg",
|
11136
11128
|
# })
|
11137
11129
|
#
|
11138
11130
|
# resp.to_h outputs the following:
|
11139
11131
|
# {
|
11140
11132
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11141
|
-
# version_id: "
|
11133
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11142
11134
|
# }
|
11143
11135
|
#
|
11144
|
-
# @example Example: To upload an object and specify
|
11136
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
11145
11137
|
#
|
11146
|
-
# # The following example uploads and object. The request specifies optional
|
11147
|
-
# #
|
11138
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
11139
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
11148
11140
|
#
|
11149
11141
|
# resp = client.put_object({
|
11150
|
-
# acl: "authenticated-read",
|
11151
11142
|
# body: "filetoupload",
|
11152
11143
|
# bucket: "examplebucket",
|
11153
11144
|
# key: "exampleobject",
|
11145
|
+
# server_side_encryption: "AES256",
|
11146
|
+
# tagging: "key1=value1&key2=value2",
|
11154
11147
|
# })
|
11155
11148
|
#
|
11156
11149
|
# resp.to_h outputs the following:
|
11157
11150
|
# {
|
11158
11151
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11159
|
-
#
|
11152
|
+
# server_side_encryption: "AES256",
|
11153
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11160
11154
|
# }
|
11161
11155
|
#
|
11162
11156
|
# @example Example: To upload an object and specify optional tags
|
@@ -11177,24 +11171,38 @@ module Aws::S3
|
|
11177
11171
|
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11178
11172
|
# }
|
11179
11173
|
#
|
11180
|
-
# @example Example: To
|
11174
|
+
# @example Example: To create an object.
|
11181
11175
|
#
|
11182
|
-
# # The following example
|
11183
|
-
#
|
11176
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
11177
|
+
#
|
11178
|
+
# resp = client.put_object({
|
11179
|
+
# body: "filetoupload",
|
11180
|
+
# bucket: "examplebucket",
|
11181
|
+
# key: "objectkey",
|
11182
|
+
# })
|
11183
|
+
#
|
11184
|
+
# resp.to_h outputs the following:
|
11185
|
+
# {
|
11186
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11187
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11188
|
+
# }
|
11189
|
+
#
|
11190
|
+
# @example Example: To upload an object and specify canned ACL.
|
11191
|
+
#
|
11192
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
11193
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11184
11194
|
#
|
11185
11195
|
# resp = client.put_object({
|
11196
|
+
# acl: "authenticated-read",
|
11186
11197
|
# body: "filetoupload",
|
11187
11198
|
# bucket: "examplebucket",
|
11188
11199
|
# key: "exampleobject",
|
11189
|
-
# server_side_encryption: "AES256",
|
11190
|
-
# tagging: "key1=value1&key2=value2",
|
11191
11200
|
# })
|
11192
11201
|
#
|
11193
11202
|
# resp.to_h outputs the following:
|
11194
11203
|
# {
|
11195
11204
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11196
|
-
#
|
11197
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11205
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11198
11206
|
# }
|
11199
11207
|
#
|
11200
11208
|
# @example Streaming a file from disk
|
@@ -11277,7 +11285,7 @@ module Aws::S3
|
|
11277
11285
|
# if you have an existing application that updates a bucket ACL using
|
11278
11286
|
# the request body, you can continue to use that approach. For more
|
11279
11287
|
# information, see [Access Control List (ACL) Overview][2] in the
|
11280
|
-
# *Amazon S3
|
11288
|
+
# *Amazon S3 User Guide*.
|
11281
11289
|
#
|
11282
11290
|
# **Access Permissions**
|
11283
11291
|
#
|
@@ -11437,8 +11445,8 @@ module Aws::S3
|
|
11437
11445
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11438
11446
|
# When using this action with an access point through the AWS SDKs, you
|
11439
11447
|
# provide the access point ARN in place of the bucket name. For more
|
11440
|
-
# information about access point ARNs, see [Using
|
11441
|
-
# the *Amazon
|
11448
|
+
# information about access point ARNs, see [Using access points][1] in
|
11449
|
+
# the *Amazon S3 User Guide*.
|
11442
11450
|
#
|
11443
11451
|
#
|
11444
11452
|
#
|
@@ -11474,8 +11482,10 @@ module Aws::S3
|
|
11474
11482
|
# This action is not supported by Amazon S3 on Outposts.
|
11475
11483
|
#
|
11476
11484
|
# @option params [String] :grant_write
|
11477
|
-
# Allows grantee to create
|
11478
|
-
#
|
11485
|
+
# Allows grantee to create new objects in the bucket.
|
11486
|
+
#
|
11487
|
+
# For the bucket and object owners of existing objects, also allows
|
11488
|
+
# deletions and overwrites of those objects.
|
11479
11489
|
#
|
11480
11490
|
# @option params [String] :grant_write_acp
|
11481
11491
|
# Allows grantee to write the ACL for the applicable bucket.
|
@@ -11490,8 +11500,8 @@ module Aws::S3
|
|
11490
11500
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11491
11501
|
# When using this action with an access point through the AWS SDKs, you
|
11492
11502
|
# provide the access point ARN in place of the bucket name. For more
|
11493
|
-
# information about access point ARNs, see [Using
|
11494
|
-
# the *Amazon
|
11503
|
+
# information about access point ARNs, see [Using access points][1] in
|
11504
|
+
# the *Amazon S3 User Guide*.
|
11495
11505
|
#
|
11496
11506
|
# When using this action with Amazon S3 on Outposts, you must direct
|
11497
11507
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -11500,7 +11510,7 @@ module Aws::S3
|
|
11500
11510
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11501
11511
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11502
11512
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11503
|
-
# in the *Amazon
|
11513
|
+
# in the *Amazon S3 User Guide*.
|
11504
11514
|
#
|
11505
11515
|
#
|
11506
11516
|
#
|
@@ -11512,7 +11522,7 @@ module Aws::S3
|
|
11512
11522
|
# request. Bucket owners need not specify this parameter in their
|
11513
11523
|
# requests. For information about downloading objects from requester
|
11514
11524
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11515
|
-
# in the *Amazon S3
|
11525
|
+
# in the *Amazon S3 User Guide*.
|
11516
11526
|
#
|
11517
11527
|
#
|
11518
11528
|
#
|
@@ -11597,16 +11607,11 @@ module Aws::S3
|
|
11597
11607
|
req.send_request(options)
|
11598
11608
|
end
|
11599
11609
|
|
11600
|
-
# Applies a Legal Hold configuration to the specified object.
|
11610
|
+
# Applies a Legal Hold configuration to the specified object. For more
|
11611
|
+
# information, see [Locking Objects][1].
|
11601
11612
|
#
|
11602
11613
|
# This action is not supported by Amazon S3 on Outposts.
|
11603
11614
|
#
|
11604
|
-
# **Related Resources**
|
11605
|
-
#
|
11606
|
-
# * [Locking Objects][1]
|
11607
|
-
#
|
11608
|
-
# ^
|
11609
|
-
#
|
11610
11615
|
#
|
11611
11616
|
#
|
11612
11617
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11620,8 +11625,8 @@ module Aws::S3
|
|
11620
11625
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11621
11626
|
# When using this action with an access point through the AWS SDKs, you
|
11622
11627
|
# provide the access point ARN in place of the bucket name. For more
|
11623
|
-
# information about access point ARNs, see [Using
|
11624
|
-
# the *Amazon
|
11628
|
+
# information about access point ARNs, see [Using access points][1] in
|
11629
|
+
# the *Amazon S3 User Guide*.
|
11625
11630
|
#
|
11626
11631
|
#
|
11627
11632
|
#
|
@@ -11639,7 +11644,7 @@ module Aws::S3
|
|
11639
11644
|
# request. Bucket owners need not specify this parameter in their
|
11640
11645
|
# requests. For information about downloading objects from requester
|
11641
11646
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11642
|
-
# in the *Amazon S3
|
11647
|
+
# in the *Amazon S3 User Guide*.
|
11643
11648
|
#
|
11644
11649
|
#
|
11645
11650
|
#
|
@@ -11692,18 +11697,19 @@ module Aws::S3
|
|
11692
11697
|
|
11693
11698
|
# Places an Object Lock configuration on the specified bucket. The rule
|
11694
11699
|
# specified in the Object Lock configuration will be applied by default
|
11695
|
-
# to every new object placed in the specified bucket.
|
11700
|
+
# to every new object placed in the specified bucket. For more
|
11701
|
+
# information, see [Locking Objects][1].
|
11696
11702
|
#
|
11697
|
-
# <note markdown="1"> `DefaultRetention`
|
11698
|
-
# both at the same time.
|
11703
|
+
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
11699
11704
|
#
|
11700
|
-
#
|
11701
|
-
#
|
11702
|
-
#
|
11705
|
+
# * The `DefaultRetention` period can be either `Days` or `Years` but
|
11706
|
+
# you must select one. You cannot specify `Days` and `Years` at the
|
11707
|
+
# same time.
|
11703
11708
|
#
|
11704
|
-
# *
|
11709
|
+
# * You can only enable Object Lock for new buckets. If you want to turn
|
11710
|
+
# on Object Lock for an existing bucket, contact AWS Support.
|
11705
11711
|
#
|
11706
|
-
#
|
11712
|
+
# </note>
|
11707
11713
|
#
|
11708
11714
|
#
|
11709
11715
|
#
|
@@ -11722,7 +11728,7 @@ module Aws::S3
|
|
11722
11728
|
# request. Bucket owners need not specify this parameter in their
|
11723
11729
|
# requests. For information about downloading objects from requester
|
11724
11730
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11725
|
-
# in the *Amazon S3
|
11731
|
+
# in the *Amazon S3 User Guide*.
|
11726
11732
|
#
|
11727
11733
|
#
|
11728
11734
|
#
|
@@ -11779,16 +11785,11 @@ module Aws::S3
|
|
11779
11785
|
req.send_request(options)
|
11780
11786
|
end
|
11781
11787
|
|
11782
|
-
# Places an Object Retention configuration on an object.
|
11788
|
+
# Places an Object Retention configuration on an object. For more
|
11789
|
+
# information, see [Locking Objects][1].
|
11783
11790
|
#
|
11784
11791
|
# This action is not supported by Amazon S3 on Outposts.
|
11785
11792
|
#
|
11786
|
-
# **Related Resources**
|
11787
|
-
#
|
11788
|
-
# * [Locking Objects][1]
|
11789
|
-
#
|
11790
|
-
# ^
|
11791
|
-
#
|
11792
11793
|
#
|
11793
11794
|
#
|
11794
11795
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11802,8 +11803,8 @@ module Aws::S3
|
|
11802
11803
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11803
11804
|
# When using this action with an access point through the AWS SDKs, you
|
11804
11805
|
# provide the access point ARN in place of the bucket name. For more
|
11805
|
-
# information about access point ARNs, see [Using
|
11806
|
-
# the *Amazon
|
11806
|
+
# information about access point ARNs, see [Using access points][1] in
|
11807
|
+
# the *Amazon S3 User Guide*.
|
11807
11808
|
#
|
11808
11809
|
#
|
11809
11810
|
#
|
@@ -11821,7 +11822,7 @@ module Aws::S3
|
|
11821
11822
|
# request. Bucket owners need not specify this parameter in their
|
11822
11823
|
# requests. For information about downloading objects from requester
|
11823
11824
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11824
|
-
# in the *Amazon S3
|
11825
|
+
# in the *Amazon S3 User Guide*.
|
11825
11826
|
#
|
11826
11827
|
#
|
11827
11828
|
#
|
@@ -11944,8 +11945,8 @@ module Aws::S3
|
|
11944
11945
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11945
11946
|
# When using this action with an access point through the AWS SDKs, you
|
11946
11947
|
# provide the access point ARN in place of the bucket name. For more
|
11947
|
-
# information about access point ARNs, see [Using
|
11948
|
-
# the *Amazon
|
11948
|
+
# information about access point ARNs, see [Using access points][1] in
|
11949
|
+
# the *Amazon S3 User Guide*.
|
11949
11950
|
#
|
11950
11951
|
# When using this action with Amazon S3 on Outposts, you must direct
|
11951
11952
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -11954,7 +11955,7 @@ module Aws::S3
|
|
11954
11955
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11955
11956
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11956
11957
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11957
|
-
# in the *Amazon
|
11958
|
+
# in the *Amazon S3 User Guide*.
|
11958
11959
|
#
|
11959
11960
|
#
|
11960
11961
|
#
|
@@ -11986,7 +11987,7 @@ module Aws::S3
|
|
11986
11987
|
# request. Bucket owners need not specify this parameter in their
|
11987
11988
|
# requests. For information about downloading objects from requester
|
11988
11989
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11989
|
-
# in the *Amazon S3
|
11990
|
+
# in the *Amazon S3 User Guide*.
|
11990
11991
|
#
|
11991
11992
|
#
|
11992
11993
|
#
|
@@ -12105,7 +12106,7 @@ module Aws::S3
|
|
12105
12106
|
# Amazon S3 bucket. You can enable the configuration options in any
|
12106
12107
|
# combination. For more information about when Amazon S3 considers a
|
12107
12108
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
12108
|
-
# *Amazon
|
12109
|
+
# *Amazon S3 User Guide*.
|
12109
12110
|
#
|
12110
12111
|
#
|
12111
12112
|
#
|
@@ -12388,8 +12389,8 @@ module Aws::S3
|
|
12388
12389
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12389
12390
|
# When using this action with an access point through the AWS SDKs, you
|
12390
12391
|
# provide the access point ARN in place of the bucket name. For more
|
12391
|
-
# information about access point ARNs, see [Using
|
12392
|
-
# the *Amazon
|
12392
|
+
# information about access point ARNs, see [Using access points][1] in
|
12393
|
+
# the *Amazon S3 User Guide*.
|
12393
12394
|
#
|
12394
12395
|
# When using this action with Amazon S3 on Outposts, you must direct
|
12395
12396
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -12398,7 +12399,7 @@ module Aws::S3
|
|
12398
12399
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
12399
12400
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
12400
12401
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
12401
|
-
# in the *Amazon
|
12402
|
+
# in the *Amazon S3 User Guide*.
|
12402
12403
|
#
|
12403
12404
|
#
|
12404
12405
|
#
|
@@ -12419,7 +12420,7 @@ module Aws::S3
|
|
12419
12420
|
# request. Bucket owners need not specify this parameter in their
|
12420
12421
|
# requests. For information about downloading objects from requester
|
12421
12422
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
12422
|
-
# in the *Amazon S3
|
12423
|
+
# in the *Amazon S3 User Guide*.
|
12423
12424
|
#
|
12424
12425
|
#
|
12425
12426
|
#
|
@@ -13092,8 +13093,8 @@ module Aws::S3
|
|
13092
13093
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13093
13094
|
# When using this action with an access point through the AWS SDKs, you
|
13094
13095
|
# provide the access point ARN in place of the bucket name. For more
|
13095
|
-
# information about access point ARNs, see [Using
|
13096
|
-
# the *Amazon
|
13096
|
+
# information about access point ARNs, see [Using access points][1] in
|
13097
|
+
# the *Amazon S3 User Guide*.
|
13097
13098
|
#
|
13098
13099
|
# When using this action with Amazon S3 on Outposts, you must direct
|
13099
13100
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -13102,7 +13103,7 @@ module Aws::S3
|
|
13102
13103
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13103
13104
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13104
13105
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13105
|
-
# in the *Amazon
|
13106
|
+
# in the *Amazon S3 User Guide*.
|
13106
13107
|
#
|
13107
13108
|
#
|
13108
13109
|
#
|
@@ -13152,7 +13153,7 @@ module Aws::S3
|
|
13152
13153
|
# request. Bucket owners need not specify this parameter in their
|
13153
13154
|
# requests. For information about downloading objects from requester
|
13154
13155
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
13155
|
-
# in the *Amazon S3
|
13156
|
+
# in the *Amazon S3 User Guide*.
|
13156
13157
|
#
|
13157
13158
|
#
|
13158
13159
|
#
|
@@ -13366,8 +13367,8 @@ module Aws::S3
|
|
13366
13367
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13367
13368
|
# When using this action with an access point through the AWS SDKs, you
|
13368
13369
|
# provide the access point ARN in place of the bucket name. For more
|
13369
|
-
# information about access point ARNs, see [Using
|
13370
|
-
# the *Amazon
|
13370
|
+
# information about access point ARNs, see [Using access points][1] in
|
13371
|
+
# the *Amazon S3 User Guide*.
|
13371
13372
|
#
|
13372
13373
|
# When using this action with Amazon S3 on Outposts, you must direct
|
13373
13374
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -13376,7 +13377,7 @@ module Aws::S3
|
|
13376
13377
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13377
13378
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13378
13379
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13379
|
-
# in the *Amazon
|
13380
|
+
# in the *Amazon S3 User Guide*.
|
13380
13381
|
#
|
13381
13382
|
#
|
13382
13383
|
#
|
@@ -13497,7 +13498,7 @@ module Aws::S3
|
|
13497
13498
|
# request. Bucket owners need not specify this parameter in their
|
13498
13499
|
# requests. For information about downloading objects from requester
|
13499
13500
|
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
13500
|
-
# in the *Amazon S3
|
13501
|
+
# in the *Amazon S3 User Guide*.
|
13501
13502
|
#
|
13502
13503
|
#
|
13503
13504
|
#
|
@@ -13525,45 +13526,45 @@ module Aws::S3
|
|
13525
13526
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
13526
13527
|
#
|
13527
13528
|
#
|
13528
|
-
# @example Example: To upload a part by copying
|
13529
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
13529
13530
|
#
|
13530
|
-
# # The following example uploads a part of a multipart upload by copying
|
13531
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
13532
|
+
# # data source.
|
13531
13533
|
#
|
13532
13534
|
# resp = client.upload_part_copy({
|
13533
13535
|
# bucket: "examplebucket",
|
13534
13536
|
# copy_source: "/bucketname/sourceobjectkey",
|
13537
|
+
# copy_source_range: "bytes=1-100000",
|
13535
13538
|
# key: "examplelargeobject",
|
13536
|
-
# part_number:
|
13539
|
+
# part_number: 2,
|
13537
13540
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13538
13541
|
# })
|
13539
13542
|
#
|
13540
13543
|
# resp.to_h outputs the following:
|
13541
13544
|
# {
|
13542
13545
|
# copy_part_result: {
|
13543
|
-
# etag: "\"
|
13544
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13546
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
13547
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
13545
13548
|
# },
|
13546
13549
|
# }
|
13547
13550
|
#
|
13548
|
-
# @example Example: To upload a part by copying
|
13551
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
13549
13552
|
#
|
13550
|
-
# # The following example uploads a part of a multipart upload by copying
|
13551
|
-
# # data source.
|
13553
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
13552
13554
|
#
|
13553
13555
|
# resp = client.upload_part_copy({
|
13554
13556
|
# bucket: "examplebucket",
|
13555
13557
|
# copy_source: "/bucketname/sourceobjectkey",
|
13556
|
-
# copy_source_range: "bytes=1-100000",
|
13557
13558
|
# key: "examplelargeobject",
|
13558
|
-
# part_number:
|
13559
|
+
# part_number: 1,
|
13559
13560
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13560
13561
|
# })
|
13561
13562
|
#
|
13562
13563
|
# resp.to_h outputs the following:
|
13563
13564
|
# {
|
13564
13565
|
# copy_part_result: {
|
13565
|
-
# etag: "\"
|
13566
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13566
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
13567
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
13567
13568
|
# },
|
13568
13569
|
# }
|
13569
13570
|
#
|
@@ -13627,10 +13628,40 @@ module Aws::S3
|
|
13627
13628
|
# function, the metadata returned to the end user `GetObject` call might
|
13628
13629
|
# differ from what Amazon S3 would normally return.
|
13629
13630
|
#
|
13631
|
+
# AWS provides some prebuilt Lambda functions that you can use with S3
|
13632
|
+
# Object Lambda to detect and redact personally identifiable information
|
13633
|
+
# (PII) and decompress S3 objects. These Lambda functions are available
|
13634
|
+
# in the AWS Serverless Application Repository, and can be selected
|
13635
|
+
# through the AWS Management Console when you create your Object Lambda
|
13636
|
+
# Access Point.
|
13637
|
+
#
|
13638
|
+
# Example 1: PII Access Control - This Lambda function uses Amazon
|
13639
|
+
# Comprehend, a natural language processing (NLP) service using machine
|
13640
|
+
# learning to find insights and relationships in text. It automatically
|
13641
|
+
# detects personally identifiable information (PII) such as names,
|
13642
|
+
# addresses, dates, credit card numbers, and social security numbers
|
13643
|
+
# from documents in your Amazon S3 bucket.
|
13644
|
+
#
|
13645
|
+
# Example 2: PII Redaction - This Lambda function uses Amazon
|
13646
|
+
# Comprehend, a natural language processing (NLP) service using machine
|
13647
|
+
# learning to find insights and relationships in text. It automatically
|
13648
|
+
# redacts personally identifiable information (PII) such as names,
|
13649
|
+
# addresses, dates, credit card numbers, and social security numbers
|
13650
|
+
# from documents in your Amazon S3 bucket.
|
13651
|
+
#
|
13652
|
+
# Example 3: Decompression - The Lambda function
|
13653
|
+
# S3ObjectLambdaDecompression, is equipped to decompress objects stored
|
13654
|
+
# in S3 in one of six compressed file formats including bzip2, gzip,
|
13655
|
+
# snappy, zlib, zstandard and ZIP.
|
13656
|
+
#
|
13657
|
+
# For information on how to view and use these functions, see [Using AWS
|
13658
|
+
# built Lambda functions][3] in the *Amazon S3 User Guide*.
|
13659
|
+
#
|
13630
13660
|
#
|
13631
13661
|
#
|
13632
13662
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
13633
13663
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13664
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html
|
13634
13665
|
#
|
13635
13666
|
# @option params [required, String] :request_route
|
13636
13667
|
# Route prefix to the HTTP URL generated.
|
@@ -13680,7 +13711,9 @@ module Aws::S3
|
|
13680
13711
|
# A string that uniquely identifies an error condition. Returned in the
|
13681
13712
|
# <Code> tag of the error XML response for a corresponding
|
13682
13713
|
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13683
|
-
# or when the transformed object is provided in the body.
|
13714
|
+
# or when the transformed object is provided in the body. All error
|
13715
|
+
# codes from S3 are sentence-cased. Regex value is
|
13716
|
+
# "^\[A-Z\]\[a-zA-Z\]+$".
|
13684
13717
|
#
|
13685
13718
|
# @option params [String] :error_message
|
13686
13719
|
# Contains a generic description of the error condition. Returned in the
|
@@ -13884,7 +13917,7 @@ module Aws::S3
|
|
13884
13917
|
params: params,
|
13885
13918
|
config: config)
|
13886
13919
|
context[:gem_name] = 'aws-sdk-s3'
|
13887
|
-
context[:gem_version] = '1.
|
13920
|
+
context[:gem_version] = '1.95.0'
|
13888
13921
|
Seahorse::Client::Request.new(handlers, context)
|
13889
13922
|
end
|
13890
13923
|
|