aws-sdk-s3 1.91.0 → 1.94.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 +29 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +4 -6
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +64 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +4 -6
- data/lib/aws-sdk-s3/bucket.rb +6 -6
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -1
- data/lib/aws-sdk-s3/bucket_cors.rb +3 -4
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +2 -2
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +2 -2
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -1
- data/lib/aws-sdk-s3/bucket_notification.rb +1 -1
- data/lib/aws-sdk-s3/bucket_policy.rb +2 -2
- data/lib/aws-sdk-s3/bucket_request_payment.rb +1 -1
- data/lib/aws-sdk-s3/bucket_tagging.rb +2 -2
- data/lib/aws-sdk-s3/bucket_versioning.rb +3 -3
- data/lib/aws-sdk-s3/bucket_website.rb +2 -2
- data/lib/aws-sdk-s3/client.rb +758 -482
- data/lib/aws-sdk-s3/client_api.rb +58 -0
- 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 +4 -4
- data/lib/aws-sdk-s3/object.rb +96 -10
- data/lib/aws-sdk-s3/object_acl.rb +1 -1
- data/lib/aws-sdk-s3/object_summary.rb +9 -9
- data/lib/aws-sdk-s3/object_version.rb +4 -4
- data/lib/aws-sdk-s3/plugins/arn.rb +57 -34
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +9 -9
- data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +6 -0
- data/lib/aws-sdk-s3/presigner.rb +12 -3
- data/lib/aws-sdk-s3/types.rb +567 -243
- metadata +7 -6
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -39,6 +39,7 @@ require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
|
39
39
|
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
40
40
|
require 'aws-sdk-s3/plugins/location_constraint.rb'
|
41
41
|
require 'aws-sdk-s3/plugins/md5s.rb'
|
42
|
+
require 'aws-sdk-s3/plugins/object_lambda_endpoint.rb'
|
42
43
|
require 'aws-sdk-s3/plugins/redirects.rb'
|
43
44
|
require 'aws-sdk-s3/plugins/s3_host_id.rb'
|
44
45
|
require 'aws-sdk-s3/plugins/s3_signer.rb'
|
@@ -102,6 +103,7 @@ module Aws::S3
|
|
102
103
|
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
103
104
|
add_plugin(Aws::S3::Plugins::LocationConstraint)
|
104
105
|
add_plugin(Aws::S3::Plugins::Md5s)
|
106
|
+
add_plugin(Aws::S3::Plugins::ObjectLambdaEndpoint)
|
105
107
|
add_plugin(Aws::S3::Plugins::Redirects)
|
106
108
|
add_plugin(Aws::S3::Plugins::S3HostId)
|
107
109
|
add_plugin(Aws::S3::Plugins::S3Signer)
|
@@ -326,8 +328,8 @@ module Aws::S3
|
|
326
328
|
#
|
327
329
|
#
|
328
330
|
# @option options [String] :s3_us_east_1_regional_endpoint ("legacy")
|
329
|
-
#
|
330
|
-
#
|
331
|
+
# Pass in `regional` to enable the `us-east-1` regional endpoint.
|
332
|
+
# Defaults to `legacy` mode which uses the global endpoint.
|
331
333
|
#
|
332
334
|
# @option options [Boolean] :s3_use_arn_region (true)
|
333
335
|
# For S3 ARNs passed into the `:bucket` parameter, this option will
|
@@ -453,7 +455,7 @@ module Aws::S3
|
|
453
455
|
# When using this action with an access point through the AWS SDKs, you
|
454
456
|
# provide the access point ARN in place of the bucket name. For more
|
455
457
|
# information about access point ARNs, see [Using Access Points][1] in
|
456
|
-
# the *Amazon
|
458
|
+
# the *Amazon S3 User Guide*.
|
457
459
|
#
|
458
460
|
# When using this action with Amazon S3 on Outposts, you must direct
|
459
461
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -462,12 +464,12 @@ module Aws::S3
|
|
462
464
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
463
465
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
464
466
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
465
|
-
# in the *Amazon
|
467
|
+
# in the *Amazon S3 User Guide*.
|
466
468
|
#
|
467
469
|
#
|
468
470
|
#
|
469
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
470
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
471
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
472
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
471
473
|
#
|
472
474
|
# @option params [required, String] :key
|
473
475
|
# Key of the object for which the multipart upload was initiated.
|
@@ -487,7 +489,7 @@ module Aws::S3
|
|
487
489
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
488
490
|
#
|
489
491
|
# @option params [String] :expected_bucket_owner
|
490
|
-
# The account
|
492
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
491
493
|
# a different account, the request will fail with an HTTP `403 (Access
|
492
494
|
# Denied)` error.
|
493
495
|
#
|
@@ -645,7 +647,7 @@ module Aws::S3
|
|
645
647
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
646
648
|
#
|
647
649
|
# @option params [String] :expected_bucket_owner
|
648
|
-
# The account
|
650
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
649
651
|
# a different account, the request will fail with an HTTP `403 (Access
|
650
652
|
# Denied)` error.
|
651
653
|
#
|
@@ -844,7 +846,7 @@ module Aws::S3
|
|
844
846
|
#
|
845
847
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
846
848
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
847
|
-
# the *Amazon
|
849
|
+
# the *Amazon S3 User Guide*.
|
848
850
|
#
|
849
851
|
# **Access Control List (ACL)-Specific Request Headers**
|
850
852
|
#
|
@@ -924,7 +926,7 @@ module Aws::S3
|
|
924
926
|
# When using this action with an access point through the AWS SDKs, you
|
925
927
|
# provide the access point ARN in place of the bucket name. For more
|
926
928
|
# information about access point ARNs, see [Using Access Points][1] in
|
927
|
-
# the *Amazon
|
929
|
+
# the *Amazon S3 User Guide*.
|
928
930
|
#
|
929
931
|
# When using this action with Amazon S3 on Outposts, you must direct
|
930
932
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -933,12 +935,12 @@ module Aws::S3
|
|
933
935
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
934
936
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
935
937
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
936
|
-
# in the *Amazon
|
938
|
+
# in the *Amazon S3 User Guide*.
|
937
939
|
#
|
938
940
|
#
|
939
941
|
#
|
940
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
941
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
942
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
943
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
942
944
|
#
|
943
945
|
# @option params [String] :cache_control
|
944
946
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1001,7 +1003,7 @@ module Aws::S3
|
|
1001
1003
|
#
|
1002
1004
|
#
|
1003
1005
|
#
|
1004
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1006
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
1005
1007
|
#
|
1006
1008
|
# @option params [String] :copy_source_if_match
|
1007
1009
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -1159,12 +1161,12 @@ module Aws::S3
|
|
1159
1161
|
# Specifies whether you want to apply a Legal Hold to the copied object.
|
1160
1162
|
#
|
1161
1163
|
# @option params [String] :expected_bucket_owner
|
1162
|
-
# The account
|
1164
|
+
# The account ID of the expected destination bucket owner. If the
|
1163
1165
|
# destination bucket is owned by a different account, the request will
|
1164
1166
|
# fail with an HTTP `403 (Access Denied)` error.
|
1165
1167
|
#
|
1166
1168
|
# @option params [String] :expected_source_bucket_owner
|
1167
|
-
# The account
|
1169
|
+
# The account ID of the expected source bucket owner. If the source
|
1168
1170
|
# bucket is owned by a different account, the request will fail with an
|
1169
1171
|
# HTTP `403 (Access Denied)` error.
|
1170
1172
|
#
|
@@ -1417,33 +1419,33 @@ module Aws::S3
|
|
1417
1419
|
# * {Types::CreateBucketOutput#location #location} => String
|
1418
1420
|
#
|
1419
1421
|
#
|
1420
|
-
# @example Example: To create a bucket
|
1422
|
+
# @example Example: To create a bucket in a specific region
|
1421
1423
|
#
|
1422
|
-
# # The following example creates a bucket.
|
1424
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
1423
1425
|
#
|
1424
1426
|
# resp = client.create_bucket({
|
1425
1427
|
# bucket: "examplebucket",
|
1428
|
+
# create_bucket_configuration: {
|
1429
|
+
# location_constraint: "eu-west-1",
|
1430
|
+
# },
|
1426
1431
|
# })
|
1427
1432
|
#
|
1428
1433
|
# resp.to_h outputs the following:
|
1429
1434
|
# {
|
1430
|
-
# location: "/
|
1435
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1431
1436
|
# }
|
1432
1437
|
#
|
1433
|
-
# @example Example: To create a bucket
|
1438
|
+
# @example Example: To create a bucket
|
1434
1439
|
#
|
1435
|
-
# # The following example creates a bucket.
|
1440
|
+
# # The following example creates a bucket.
|
1436
1441
|
#
|
1437
1442
|
# resp = client.create_bucket({
|
1438
1443
|
# bucket: "examplebucket",
|
1439
|
-
# create_bucket_configuration: {
|
1440
|
-
# location_constraint: "eu-west-1",
|
1441
|
-
# },
|
1442
1444
|
# })
|
1443
1445
|
#
|
1444
1446
|
# resp.to_h outputs the following:
|
1445
1447
|
# {
|
1446
|
-
# location: "
|
1448
|
+
# location: "/examplebucket",
|
1447
1449
|
# }
|
1448
1450
|
#
|
1449
1451
|
# @example Request syntax with placeholder values
|
@@ -1722,7 +1724,7 @@ module Aws::S3
|
|
1722
1724
|
# When using this action with an access point through the AWS SDKs, you
|
1723
1725
|
# provide the access point ARN in place of the bucket name. For more
|
1724
1726
|
# information about access point ARNs, see [Using Access Points][1] in
|
1725
|
-
# the *Amazon
|
1727
|
+
# the *Amazon S3 User Guide*.
|
1726
1728
|
#
|
1727
1729
|
# When using this action with Amazon S3 on Outposts, you must direct
|
1728
1730
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -1731,12 +1733,12 @@ module Aws::S3
|
|
1731
1733
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
1732
1734
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
1733
1735
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
1734
|
-
# in the *Amazon
|
1736
|
+
# in the *Amazon S3 User Guide*.
|
1735
1737
|
#
|
1736
1738
|
#
|
1737
1739
|
#
|
1738
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1739
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1740
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
1741
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
1740
1742
|
#
|
1741
1743
|
# @option params [String] :cache_control
|
1742
1744
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1875,7 +1877,7 @@ module Aws::S3
|
|
1875
1877
|
# object.
|
1876
1878
|
#
|
1877
1879
|
# @option params [String] :expected_bucket_owner
|
1878
|
-
# The account
|
1880
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1879
1881
|
# a different account, the request will fail with an HTTP `403 (Access
|
1880
1882
|
# Denied)` error.
|
1881
1883
|
#
|
@@ -1990,7 +1992,7 @@ module Aws::S3
|
|
1990
1992
|
# Specifies the bucket being deleted.
|
1991
1993
|
#
|
1992
1994
|
# @option params [String] :expected_bucket_owner
|
1993
|
-
# The account
|
1995
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1994
1996
|
# a different account, the request will fail with an HTTP `403 (Access
|
1995
1997
|
# Denied)` error.
|
1996
1998
|
#
|
@@ -2045,8 +2047,8 @@ module Aws::S3
|
|
2045
2047
|
#
|
2046
2048
|
#
|
2047
2049
|
#
|
2048
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2049
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2050
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2051
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2050
2052
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
2051
2053
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
2052
2054
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -2060,7 +2062,7 @@ module Aws::S3
|
|
2060
2062
|
# The ID that identifies the analytics configuration.
|
2061
2063
|
#
|
2062
2064
|
# @option params [String] :expected_bucket_owner
|
2063
|
-
# The account
|
2065
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2064
2066
|
# a different account, the request will fail with an HTTP `403 (Access
|
2065
2067
|
# Denied)` error.
|
2066
2068
|
#
|
@@ -2090,7 +2092,7 @@ module Aws::S3
|
|
2090
2092
|
# default and can grant this permission to others.
|
2091
2093
|
#
|
2092
2094
|
# For information about `cors`, see [Enabling Cross-Origin Resource
|
2093
|
-
# Sharing][1] in the *Amazon
|
2095
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
2094
2096
|
#
|
2095
2097
|
# **Related Resources:**
|
2096
2098
|
#
|
@@ -2108,7 +2110,7 @@ module Aws::S3
|
|
2108
2110
|
# Specifies the bucket whose `cors` configuration is being deleted.
|
2109
2111
|
#
|
2110
2112
|
# @option params [String] :expected_bucket_owner
|
2111
|
-
# The account
|
2113
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2112
2114
|
# a different account, the request will fail with an HTTP `403 (Access
|
2113
2115
|
# Denied)` error.
|
2114
2116
|
#
|
@@ -2142,15 +2144,15 @@ module Aws::S3
|
|
2142
2144
|
# This implementation of the DELETE action removes default encryption
|
2143
2145
|
# from the bucket. For information about the Amazon S3 default
|
2144
2146
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
2145
|
-
# the *Amazon
|
2147
|
+
# the *Amazon S3 User Guide*.
|
2146
2148
|
#
|
2147
2149
|
# To use this operation, you must have permissions to perform the
|
2148
2150
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
2149
2151
|
# permission by default. The bucket owner can grant this permission to
|
2150
2152
|
# others. For more information about permissions, see [Permissions
|
2151
2153
|
# Related to Bucket Subresource Operations][2] and [Managing Access
|
2152
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
2153
|
-
#
|
2154
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
2155
|
+
# Guide*.
|
2154
2156
|
#
|
2155
2157
|
# **Related Resources**
|
2156
2158
|
#
|
@@ -2161,8 +2163,8 @@ module Aws::S3
|
|
2161
2163
|
#
|
2162
2164
|
#
|
2163
2165
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
2164
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2165
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2166
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2167
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2166
2168
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
2167
2169
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
2168
2170
|
#
|
@@ -2171,7 +2173,7 @@ module Aws::S3
|
|
2171
2173
|
# configuration to delete.
|
2172
2174
|
#
|
2173
2175
|
# @option params [String] :expected_bucket_owner
|
2174
|
-
# The account
|
2176
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2175
2177
|
# a different account, the request will fail with an HTTP `403 (Access
|
2176
2178
|
# Denied)` error.
|
2177
2179
|
#
|
@@ -2278,8 +2280,8 @@ module Aws::S3
|
|
2278
2280
|
#
|
2279
2281
|
#
|
2280
2282
|
#
|
2281
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2282
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2283
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2284
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2283
2285
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
2284
2286
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
2285
2287
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
@@ -2293,7 +2295,7 @@ module Aws::S3
|
|
2293
2295
|
# The ID used to identify the inventory configuration.
|
2294
2296
|
#
|
2295
2297
|
# @option params [String] :expected_bucket_owner
|
2296
|
-
# The account
|
2298
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2297
2299
|
# a different account, the request will fail with an HTTP `403 (Access
|
2298
2300
|
# Denied)` error.
|
2299
2301
|
#
|
@@ -2349,7 +2351,7 @@ module Aws::S3
|
|
2349
2351
|
# The bucket name of the lifecycle to delete.
|
2350
2352
|
#
|
2351
2353
|
# @option params [String] :expected_bucket_owner
|
2352
|
-
# The account
|
2354
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2353
2355
|
# a different account, the request will fail with an HTTP `403 (Access
|
2354
2356
|
# Denied)` error.
|
2355
2357
|
#
|
@@ -2407,8 +2409,8 @@ module Aws::S3
|
|
2407
2409
|
#
|
2408
2410
|
#
|
2409
2411
|
#
|
2410
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2411
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2412
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2413
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2412
2414
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
2413
2415
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
2414
2416
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -2421,7 +2423,7 @@ module Aws::S3
|
|
2421
2423
|
# The ID used to identify the metrics configuration.
|
2422
2424
|
#
|
2423
2425
|
# @option params [String] :expected_bucket_owner
|
2424
|
-
# The account
|
2426
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2425
2427
|
# a different account, the request will fail with an HTTP `403 (Access
|
2426
2428
|
# Denied)` error.
|
2427
2429
|
#
|
@@ -2468,7 +2470,7 @@ module Aws::S3
|
|
2468
2470
|
# The Amazon S3 bucket whose `OwnershipControls` you want to delete.
|
2469
2471
|
#
|
2470
2472
|
# @option params [String] :expected_bucket_owner
|
2471
|
-
# The account
|
2473
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2472
2474
|
# a different account, the request will fail with an HTTP `403 (Access
|
2473
2475
|
# Denied)` error.
|
2474
2476
|
#
|
@@ -2525,7 +2527,7 @@ module Aws::S3
|
|
2525
2527
|
# The bucket name.
|
2526
2528
|
#
|
2527
2529
|
# @option params [String] :expected_bucket_owner
|
2528
|
-
# The account
|
2530
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2529
2531
|
# a different account, the request will fail with an HTTP `403 (Access
|
2530
2532
|
# Denied)` error.
|
2531
2533
|
#
|
@@ -2581,8 +2583,8 @@ module Aws::S3
|
|
2581
2583
|
#
|
2582
2584
|
#
|
2583
2585
|
#
|
2584
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2585
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2586
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2587
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
2586
2588
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
2587
2589
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
2588
2590
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -2591,7 +2593,7 @@ module Aws::S3
|
|
2591
2593
|
# The bucket name.
|
2592
2594
|
#
|
2593
2595
|
# @option params [String] :expected_bucket_owner
|
2594
|
-
# The account
|
2596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2595
2597
|
# a different account, the request will fail with an HTTP `403 (Access
|
2596
2598
|
# Denied)` error.
|
2597
2599
|
#
|
@@ -2643,7 +2645,7 @@ module Aws::S3
|
|
2643
2645
|
# The bucket that has the tag set to be removed.
|
2644
2646
|
#
|
2645
2647
|
# @option params [String] :expected_bucket_owner
|
2646
|
-
# The account
|
2648
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2647
2649
|
# a different account, the request will fail with an HTTP `403 (Access
|
2648
2650
|
# Denied)` error.
|
2649
2651
|
#
|
@@ -2707,7 +2709,7 @@ module Aws::S3
|
|
2707
2709
|
# configuration.
|
2708
2710
|
#
|
2709
2711
|
# @option params [String] :expected_bucket_owner
|
2710
|
-
# The account
|
2712
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2711
2713
|
# a different account, the request will fail with an HTTP `403 (Access
|
2712
2714
|
# Denied)` error.
|
2713
2715
|
#
|
@@ -2740,7 +2742,8 @@ module Aws::S3
|
|
2740
2742
|
|
2741
2743
|
# Removes the null version (if there is one) of an object and inserts a
|
2742
2744
|
# delete marker, which becomes the latest version of the object. If
|
2743
|
-
# there isn't a null version, Amazon S3 does not remove any objects
|
2745
|
+
# there isn't a null version, Amazon S3 does not remove any objects but
|
2746
|
+
# will still respond that the command was successful.
|
2744
2747
|
#
|
2745
2748
|
# To remove a specific version, you must be the bucket owner and you
|
2746
2749
|
# must use the version Id subresource. Using this subresource
|
@@ -2785,7 +2788,7 @@ module Aws::S3
|
|
2785
2788
|
# When using this action with an access point through the AWS SDKs, you
|
2786
2789
|
# provide the access point ARN in place of the bucket name. For more
|
2787
2790
|
# information about access point ARNs, see [Using Access Points][1] in
|
2788
|
-
# the *Amazon
|
2791
|
+
# the *Amazon S3 User Guide*.
|
2789
2792
|
#
|
2790
2793
|
# When using this action with Amazon S3 on Outposts, you must direct
|
2791
2794
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -2794,12 +2797,12 @@ module Aws::S3
|
|
2794
2797
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2795
2798
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2796
2799
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2797
|
-
# in the *Amazon
|
2800
|
+
# in the *Amazon S3 User Guide*.
|
2798
2801
|
#
|
2799
2802
|
#
|
2800
2803
|
#
|
2801
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2802
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2805
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2803
2806
|
#
|
2804
2807
|
# @option params [required, String] :key
|
2805
2808
|
# Key name of the object to delete.
|
@@ -2829,7 +2832,7 @@ module Aws::S3
|
|
2829
2832
|
# restrictions to process this operation.
|
2830
2833
|
#
|
2831
2834
|
# @option params [String] :expected_bucket_owner
|
2832
|
-
# The account
|
2835
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2833
2836
|
# a different account, the request will fail with an HTTP `403 (Access
|
2834
2837
|
# Denied)` error.
|
2835
2838
|
#
|
@@ -2840,6 +2843,15 @@ module Aws::S3
|
|
2840
2843
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2841
2844
|
#
|
2842
2845
|
#
|
2846
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2847
|
+
#
|
2848
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2849
|
+
#
|
2850
|
+
# resp = client.delete_object({
|
2851
|
+
# bucket: "ExampleBucket",
|
2852
|
+
# key: "HappyFace.jpg",
|
2853
|
+
# })
|
2854
|
+
#
|
2843
2855
|
# @example Example: To delete an object
|
2844
2856
|
#
|
2845
2857
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2853,15 +2865,6 @@ module Aws::S3
|
|
2853
2865
|
# {
|
2854
2866
|
# }
|
2855
2867
|
#
|
2856
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
2857
|
-
#
|
2858
|
-
# # The following example deletes an object from a non-versioned bucket.
|
2859
|
-
#
|
2860
|
-
# resp = client.delete_object({
|
2861
|
-
# bucket: "ExampleBucket",
|
2862
|
-
# key: "HappyFace.jpg",
|
2863
|
-
# })
|
2864
|
-
#
|
2865
2868
|
# @example Request syntax with placeholder values
|
2866
2869
|
#
|
2867
2870
|
# resp = client.delete_object({
|
@@ -2921,7 +2924,7 @@ module Aws::S3
|
|
2921
2924
|
# When using this action with an access point through the AWS SDKs, you
|
2922
2925
|
# provide the access point ARN in place of the bucket name. For more
|
2923
2926
|
# information about access point ARNs, see [Using Access Points][1] in
|
2924
|
-
# the *Amazon
|
2927
|
+
# the *Amazon S3 User Guide*.
|
2925
2928
|
#
|
2926
2929
|
# When using this action with Amazon S3 on Outposts, you must direct
|
2927
2930
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -2930,12 +2933,12 @@ module Aws::S3
|
|
2930
2933
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2931
2934
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2932
2935
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2933
|
-
# in the *Amazon
|
2936
|
+
# in the *Amazon S3 User Guide*.
|
2934
2937
|
#
|
2935
2938
|
#
|
2936
2939
|
#
|
2937
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2938
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2940
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2941
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2939
2942
|
#
|
2940
2943
|
# @option params [required, String] :key
|
2941
2944
|
# The key that identifies the object in the bucket from which to remove
|
@@ -2945,7 +2948,7 @@ module Aws::S3
|
|
2945
2948
|
# The versionId of the object that the tag-set will be removed from.
|
2946
2949
|
#
|
2947
2950
|
# @option params [String] :expected_bucket_owner
|
2948
|
-
# The account
|
2951
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2949
2952
|
# a different account, the request will fail with an HTTP `403 (Access
|
2950
2953
|
# Denied)` error.
|
2951
2954
|
#
|
@@ -2954,35 +2957,35 @@ module Aws::S3
|
|
2954
2957
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2955
2958
|
#
|
2956
2959
|
#
|
2957
|
-
# @example Example: To remove tag set from an object
|
2960
|
+
# @example Example: To remove tag set from an object
|
2958
2961
|
#
|
2959
|
-
# # The following example removes tag set associated with the specified object
|
2960
|
-
# #
|
2962
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2963
|
+
# # operation removes tag set from the latest object version.
|
2961
2964
|
#
|
2962
2965
|
# resp = client.delete_object_tagging({
|
2963
2966
|
# bucket: "examplebucket",
|
2964
2967
|
# key: "HappyFace.jpg",
|
2965
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2966
2968
|
# })
|
2967
2969
|
#
|
2968
2970
|
# resp.to_h outputs the following:
|
2969
2971
|
# {
|
2970
|
-
# version_id: "
|
2972
|
+
# version_id: "null",
|
2971
2973
|
# }
|
2972
2974
|
#
|
2973
|
-
# @example Example: To remove tag set from an object
|
2975
|
+
# @example Example: To remove tag set from an object version
|
2974
2976
|
#
|
2975
|
-
# # The following example removes tag set associated with the specified object.
|
2976
|
-
# #
|
2977
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2978
|
+
# # object key and object version.
|
2977
2979
|
#
|
2978
2980
|
# resp = client.delete_object_tagging({
|
2979
2981
|
# bucket: "examplebucket",
|
2980
2982
|
# key: "HappyFace.jpg",
|
2983
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2981
2984
|
# })
|
2982
2985
|
#
|
2983
2986
|
# resp.to_h outputs the following:
|
2984
2987
|
# {
|
2985
|
-
# version_id: "
|
2988
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2986
2989
|
# }
|
2987
2990
|
#
|
2988
2991
|
# @example Request syntax with placeholder values
|
@@ -3069,7 +3072,7 @@ module Aws::S3
|
|
3069
3072
|
# When using this action with an access point through the AWS SDKs, you
|
3070
3073
|
# provide the access point ARN in place of the bucket name. For more
|
3071
3074
|
# information about access point ARNs, see [Using Access Points][1] in
|
3072
|
-
# the *Amazon
|
3075
|
+
# the *Amazon S3 User Guide*.
|
3073
3076
|
#
|
3074
3077
|
# When using this action with Amazon S3 on Outposts, you must direct
|
3075
3078
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -3078,12 +3081,12 @@ module Aws::S3
|
|
3078
3081
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
3079
3082
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
3080
3083
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
3081
|
-
# in the *Amazon
|
3084
|
+
# in the *Amazon S3 User Guide*.
|
3082
3085
|
#
|
3083
3086
|
#
|
3084
3087
|
#
|
3085
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3086
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3088
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
3089
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
3087
3090
|
#
|
3088
3091
|
# @option params [required, Types::Delete] :delete
|
3089
3092
|
# Container for the request.
|
@@ -3111,7 +3114,7 @@ module Aws::S3
|
|
3111
3114
|
# permissions to perform this operation.
|
3112
3115
|
#
|
3113
3116
|
# @option params [String] :expected_bucket_owner
|
3114
|
-
# The account
|
3117
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3115
3118
|
# a different account, the request will fail with an HTTP `403 (Access
|
3116
3119
|
# Denied)` error.
|
3117
3120
|
#
|
@@ -3122,20 +3125,22 @@ module Aws::S3
|
|
3122
3125
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3123
3126
|
#
|
3124
3127
|
#
|
3125
|
-
# @example Example: To delete multiple
|
3128
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3126
3129
|
#
|
3127
|
-
# # The following example deletes objects from a bucket. The
|
3128
|
-
# #
|
3130
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3131
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3129
3132
|
#
|
3130
3133
|
# resp = client.delete_objects({
|
3131
3134
|
# bucket: "examplebucket",
|
3132
3135
|
# delete: {
|
3133
3136
|
# objects: [
|
3134
3137
|
# {
|
3135
|
-
# key: "
|
3138
|
+
# key: "HappyFace.jpg",
|
3139
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3136
3140
|
# },
|
3137
3141
|
# {
|
3138
|
-
# key: "
|
3142
|
+
# key: "HappyFace.jpg",
|
3143
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3139
3144
|
# },
|
3140
3145
|
# ],
|
3141
3146
|
# quiet: false,
|
@@ -3146,34 +3151,30 @@ module Aws::S3
|
|
3146
3151
|
# {
|
3147
3152
|
# deleted: [
|
3148
3153
|
# {
|
3149
|
-
#
|
3150
|
-
#
|
3151
|
-
# key: "objectkey1",
|
3154
|
+
# key: "HappyFace.jpg",
|
3155
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3152
3156
|
# },
|
3153
3157
|
# {
|
3154
|
-
#
|
3155
|
-
#
|
3156
|
-
# key: "objectkey2",
|
3158
|
+
# key: "HappyFace.jpg",
|
3159
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3157
3160
|
# },
|
3158
3161
|
# ],
|
3159
3162
|
# }
|
3160
3163
|
#
|
3161
|
-
# @example Example: To delete multiple
|
3164
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3162
3165
|
#
|
3163
|
-
# # The following example deletes objects from a bucket. The
|
3164
|
-
# #
|
3166
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3167
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3165
3168
|
#
|
3166
3169
|
# resp = client.delete_objects({
|
3167
3170
|
# bucket: "examplebucket",
|
3168
3171
|
# delete: {
|
3169
3172
|
# objects: [
|
3170
3173
|
# {
|
3171
|
-
# key: "
|
3172
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3174
|
+
# key: "objectkey1",
|
3173
3175
|
# },
|
3174
3176
|
# {
|
3175
|
-
# key: "
|
3176
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3177
|
+
# key: "objectkey2",
|
3177
3178
|
# },
|
3178
3179
|
# ],
|
3179
3180
|
# quiet: false,
|
@@ -3184,12 +3185,14 @@ module Aws::S3
|
|
3184
3185
|
# {
|
3185
3186
|
# deleted: [
|
3186
3187
|
# {
|
3187
|
-
#
|
3188
|
-
#
|
3188
|
+
# delete_marker: true,
|
3189
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3190
|
+
# key: "objectkey1",
|
3189
3191
|
# },
|
3190
3192
|
# {
|
3191
|
-
#
|
3192
|
-
#
|
3193
|
+
# delete_marker: true,
|
3194
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3195
|
+
# key: "objectkey2",
|
3193
3196
|
# },
|
3194
3197
|
# ],
|
3195
3198
|
# }
|
@@ -3255,8 +3258,8 @@ module Aws::S3
|
|
3255
3258
|
#
|
3256
3259
|
#
|
3257
3260
|
#
|
3258
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3259
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3261
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3262
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3260
3263
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
3261
3264
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
3262
3265
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
@@ -3267,7 +3270,7 @@ module Aws::S3
|
|
3267
3270
|
# to delete.
|
3268
3271
|
#
|
3269
3272
|
# @option params [String] :expected_bucket_owner
|
3270
|
-
# The account
|
3273
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3271
3274
|
# a different account, the request will fail with an HTTP `403 (Access
|
3272
3275
|
# Denied)` error.
|
3273
3276
|
#
|
@@ -3300,8 +3303,8 @@ module Aws::S3
|
|
3300
3303
|
# permission by default. The bucket owner can grant this permission to
|
3301
3304
|
# others. For more information about permissions, see [Permissions
|
3302
3305
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3303
|
-
# Permissions to your Amazon S3 Resources][2] in the *Amazon
|
3304
|
-
#
|
3306
|
+
# Permissions to your Amazon S3 Resources][2] in the *Amazon S3 User
|
3307
|
+
# Guide*.
|
3305
3308
|
#
|
3306
3309
|
# You set the Transfer Acceleration state of an existing bucket to
|
3307
3310
|
# `Enabled` or `Suspended` by using the
|
@@ -3312,7 +3315,7 @@ module Aws::S3
|
|
3312
3315
|
# Acceleration state if a state has never been set on the bucket.
|
3313
3316
|
#
|
3314
3317
|
# For more information about transfer acceleration, see [Transfer
|
3315
|
-
# Acceleration][4] in the Amazon
|
3318
|
+
# Acceleration][4] in the Amazon S3 User Guide.
|
3316
3319
|
#
|
3317
3320
|
# **Related Resources**
|
3318
3321
|
#
|
@@ -3322,8 +3325,8 @@ module Aws::S3
|
|
3322
3325
|
#
|
3323
3326
|
#
|
3324
3327
|
#
|
3325
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3326
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3328
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3329
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3327
3330
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html
|
3328
3331
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
3329
3332
|
#
|
@@ -3332,7 +3335,7 @@ module Aws::S3
|
|
3332
3335
|
# retrieved.
|
3333
3336
|
#
|
3334
3337
|
# @option params [String] :expected_bucket_owner
|
3335
|
-
# The account
|
3338
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3336
3339
|
# a different account, the request will fail with an HTTP `403 (Access
|
3337
3340
|
# Denied)` error.
|
3338
3341
|
#
|
@@ -3381,7 +3384,7 @@ module Aws::S3
|
|
3381
3384
|
# Specifies the S3 bucket whose ACL is being requested.
|
3382
3385
|
#
|
3383
3386
|
# @option params [String] :expected_bucket_owner
|
3384
|
-
# The account
|
3387
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3385
3388
|
# a different account, the request will fail with an HTTP `403 (Access
|
3386
3389
|
# Denied)` error.
|
3387
3390
|
#
|
@@ -3427,12 +3430,11 @@ module Aws::S3
|
|
3427
3430
|
# permission by default. The bucket owner can grant this permission to
|
3428
3431
|
# others. For more information about permissions, see [ Permissions
|
3429
3432
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3430
|
-
# Permissions to Your Amazon S3 Resources][2] in the *Amazon
|
3431
|
-
#
|
3433
|
+
# Permissions to Your Amazon S3 Resources][2] in the *Amazon S3 User
|
3434
|
+
# Guide*.
|
3432
3435
|
#
|
3433
3436
|
# For information about Amazon S3 analytics feature, see [Amazon S3
|
3434
|
-
# Analytics – Storage Class Analysis][3] in the *Amazon
|
3435
|
-
# Service User Guide*.
|
3437
|
+
# Analytics – Storage Class Analysis][3] in the *Amazon S3 User Guide*.
|
3436
3438
|
#
|
3437
3439
|
# **Related Resources**
|
3438
3440
|
#
|
@@ -3444,8 +3446,8 @@ module Aws::S3
|
|
3444
3446
|
#
|
3445
3447
|
#
|
3446
3448
|
#
|
3447
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3448
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3449
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3450
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3449
3451
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
3450
3452
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
3451
3453
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -3459,7 +3461,7 @@ module Aws::S3
|
|
3459
3461
|
# The ID that identifies the analytics configuration.
|
3460
3462
|
#
|
3461
3463
|
# @option params [String] :expected_bucket_owner
|
3462
|
-
# The account
|
3464
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3463
3465
|
# a different account, the request will fail with an HTTP `403 (Access
|
3464
3466
|
# Denied)` error.
|
3465
3467
|
#
|
@@ -3525,7 +3527,7 @@ module Aws::S3
|
|
3525
3527
|
# The bucket name for which to get the cors configuration.
|
3526
3528
|
#
|
3527
3529
|
# @option params [String] :expected_bucket_owner
|
3528
|
-
# The account
|
3530
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3529
3531
|
# a different account, the request will fail with an HTTP `403 (Access
|
3530
3532
|
# Denied)` error.
|
3531
3533
|
#
|
@@ -3614,8 +3616,8 @@ module Aws::S3
|
|
3614
3616
|
#
|
3615
3617
|
#
|
3616
3618
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
3617
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3618
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3619
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3620
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3619
3621
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
3620
3622
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
3621
3623
|
#
|
@@ -3624,7 +3626,7 @@ module Aws::S3
|
|
3624
3626
|
# configuration is retrieved.
|
3625
3627
|
#
|
3626
3628
|
# @option params [String] :expected_bucket_owner
|
3627
|
-
# The account
|
3629
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3628
3630
|
# a different account, the request will fail with an HTTP `403 (Access
|
3629
3631
|
# Denied)` error.
|
3630
3632
|
#
|
@@ -3758,8 +3760,8 @@ module Aws::S3
|
|
3758
3760
|
#
|
3759
3761
|
#
|
3760
3762
|
#
|
3761
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3762
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3763
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3764
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3763
3765
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
3764
3766
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
3765
3767
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -3773,7 +3775,7 @@ module Aws::S3
|
|
3773
3775
|
# The ID used to identify the inventory configuration.
|
3774
3776
|
#
|
3775
3777
|
# @option params [String] :expected_bucket_owner
|
3776
|
-
# The account
|
3778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3777
3779
|
# a different account, the request will fail with an HTTP `403 (Access
|
3778
3780
|
# Denied)` error.
|
3779
3781
|
#
|
@@ -3852,8 +3854,8 @@ module Aws::S3
|
|
3852
3854
|
#
|
3853
3855
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
3854
3856
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3855
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3856
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3857
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3858
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3857
3859
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3858
3860
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3859
3861
|
#
|
@@ -3861,7 +3863,7 @@ module Aws::S3
|
|
3861
3863
|
# The name of the bucket for which to get the lifecycle information.
|
3862
3864
|
#
|
3863
3865
|
# @option params [String] :expected_bucket_owner
|
3864
|
-
# The account
|
3866
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3865
3867
|
# a different account, the request will fail with an HTTP `403 (Access
|
3866
3868
|
# Denied)` error.
|
3867
3869
|
#
|
@@ -3970,8 +3972,8 @@ module Aws::S3
|
|
3970
3972
|
#
|
3971
3973
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
3972
3974
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3973
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3974
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3975
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3976
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3975
3977
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3976
3978
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3977
3979
|
#
|
@@ -3979,7 +3981,7 @@ module Aws::S3
|
|
3979
3981
|
# The name of the bucket for which to get the lifecycle information.
|
3980
3982
|
#
|
3981
3983
|
# @option params [String] :expected_bucket_owner
|
3982
|
-
# The account
|
3984
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3983
3985
|
# a different account, the request will fail with an HTTP `403 (Access
|
3984
3986
|
# Denied)` error.
|
3985
3987
|
#
|
@@ -4077,7 +4079,7 @@ module Aws::S3
|
|
4077
4079
|
# The name of the bucket for which to get the location.
|
4078
4080
|
#
|
4079
4081
|
# @option params [String] :expected_bucket_owner
|
4080
|
-
# The account
|
4082
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4081
4083
|
# a different account, the request will fail with an HTTP `403 (Access
|
4082
4084
|
# Denied)` error.
|
4083
4085
|
#
|
@@ -4138,7 +4140,7 @@ module Aws::S3
|
|
4138
4140
|
# The bucket name for which to get the logging information.
|
4139
4141
|
#
|
4140
4142
|
# @option params [String] :expected_bucket_owner
|
4141
|
-
# The account
|
4143
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4142
4144
|
# a different account, the request will fail with an HTTP `403 (Access
|
4143
4145
|
# Denied)` error.
|
4144
4146
|
#
|
@@ -4201,8 +4203,8 @@ module Aws::S3
|
|
4201
4203
|
#
|
4202
4204
|
#
|
4203
4205
|
#
|
4204
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4205
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4206
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
4207
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4206
4208
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
4207
4209
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
4208
4210
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
@@ -4216,7 +4218,7 @@ module Aws::S3
|
|
4216
4218
|
# The ID used to identify the metrics configuration.
|
4217
4219
|
#
|
4218
4220
|
# @option params [String] :expected_bucket_owner
|
4219
|
-
# The account
|
4221
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4220
4222
|
# a different account, the request will fail with an HTTP `403 (Access
|
4221
4223
|
# Denied)` error.
|
4222
4224
|
#
|
@@ -4263,7 +4265,7 @@ module Aws::S3
|
|
4263
4265
|
# configuration.
|
4264
4266
|
#
|
4265
4267
|
# @option params [String] :expected_bucket_owner
|
4266
|
-
# The account
|
4268
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4267
4269
|
# a different account, the request will fail with an HTTP `403 (Access
|
4268
4270
|
# Denied)` error.
|
4269
4271
|
#
|
@@ -4397,7 +4399,7 @@ module Aws::S3
|
|
4397
4399
|
# configuration.
|
4398
4400
|
#
|
4399
4401
|
# @option params [String] :expected_bucket_owner
|
4400
|
-
# The account
|
4402
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4401
4403
|
# a different account, the request will fail with an HTTP `403 (Access
|
4402
4404
|
# Denied)` error.
|
4403
4405
|
#
|
@@ -4474,7 +4476,7 @@ module Aws::S3
|
|
4474
4476
|
# retrieve.
|
4475
4477
|
#
|
4476
4478
|
# @option params [String] :expected_bucket_owner
|
4477
|
-
# The account
|
4479
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4478
4480
|
# a different account, the request will fail with an HTTP `403 (Access
|
4479
4481
|
# Denied)` error.
|
4480
4482
|
#
|
@@ -4536,7 +4538,7 @@ module Aws::S3
|
|
4536
4538
|
# The bucket name for which to get the bucket policy.
|
4537
4539
|
#
|
4538
4540
|
# @option params [String] :expected_bucket_owner
|
4539
|
-
# The account
|
4541
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4540
4542
|
# a different account, the request will fail with an HTTP `403 (Access
|
4541
4543
|
# Denied)` error.
|
4542
4544
|
#
|
@@ -4611,7 +4613,7 @@ module Aws::S3
|
|
4611
4613
|
# retrieve.
|
4612
4614
|
#
|
4613
4615
|
# @option params [String] :expected_bucket_owner
|
4614
|
-
# The account
|
4616
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4615
4617
|
# a different account, the request will fail with an HTTP `403 (Access
|
4616
4618
|
# Denied)` error.
|
4617
4619
|
#
|
@@ -4648,7 +4650,7 @@ module Aws::S3
|
|
4648
4650
|
# </note>
|
4649
4651
|
#
|
4650
4652
|
# For information about replication configuration, see [Replication][1]
|
4651
|
-
# in the *Amazon
|
4653
|
+
# in the *Amazon S3 User Guide*.
|
4652
4654
|
#
|
4653
4655
|
# This action requires permissions for the
|
4654
4656
|
# `s3:GetReplicationConfiguration` action. For more information about
|
@@ -4679,7 +4681,7 @@ module Aws::S3
|
|
4679
4681
|
# The bucket name for which to get the replication information.
|
4680
4682
|
#
|
4681
4683
|
# @option params [String] :expected_bucket_owner
|
4682
|
-
# The account
|
4684
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4683
4685
|
# a different account, the request will fail with an HTTP `403 (Access
|
4684
4686
|
# Denied)` error.
|
4685
4687
|
#
|
@@ -4778,7 +4780,7 @@ module Aws::S3
|
|
4778
4780
|
# configuration
|
4779
4781
|
#
|
4780
4782
|
# @option params [String] :expected_bucket_owner
|
4781
|
-
# The account
|
4783
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4782
4784
|
# a different account, the request will fail with an HTTP `403 (Access
|
4783
4785
|
# Denied)` error.
|
4784
4786
|
#
|
@@ -4849,7 +4851,7 @@ module Aws::S3
|
|
4849
4851
|
# The name of the bucket for which to get the tagging information.
|
4850
4852
|
#
|
4851
4853
|
# @option params [String] :expected_bucket_owner
|
4852
|
-
# The account
|
4854
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4853
4855
|
# a different account, the request will fail with an HTTP `403 (Access
|
4854
4856
|
# Denied)` error.
|
4855
4857
|
#
|
@@ -4930,7 +4932,7 @@ module Aws::S3
|
|
4930
4932
|
# The name of the bucket for which to get the versioning information.
|
4931
4933
|
#
|
4932
4934
|
# @option params [String] :expected_bucket_owner
|
4933
|
-
# The account
|
4935
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4934
4936
|
# a different account, the request will fail with an HTTP `403 (Access
|
4935
4937
|
# Denied)` error.
|
4936
4938
|
#
|
@@ -5002,7 +5004,7 @@ module Aws::S3
|
|
5002
5004
|
# The bucket name for which to get the website configuration.
|
5003
5005
|
#
|
5004
5006
|
# @option params [String] :expected_bucket_owner
|
5005
|
-
# The account
|
5007
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5006
5008
|
# a different account, the request will fail with an HTTP `403 (Access
|
5007
5009
|
# Denied)` error.
|
5008
5010
|
#
|
@@ -5230,7 +5232,7 @@ module Aws::S3
|
|
5230
5232
|
# When using this action with an access point through the AWS SDKs, you
|
5231
5233
|
# provide the access point ARN in place of the bucket name. For more
|
5232
5234
|
# information about access point ARNs, see [Using Access Points][1] in
|
5233
|
-
# the *Amazon
|
5235
|
+
# the *Amazon S3 User Guide*.
|
5234
5236
|
#
|
5235
5237
|
# When using this action with Amazon S3 on Outposts, you must direct
|
5236
5238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -5239,12 +5241,12 @@ module Aws::S3
|
|
5239
5241
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5240
5242
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5241
5243
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5242
|
-
# in the *Amazon
|
5244
|
+
# in the *Amazon S3 User Guide*.
|
5243
5245
|
#
|
5244
5246
|
#
|
5245
5247
|
#
|
5246
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5247
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5248
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5249
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5248
5250
|
#
|
5249
5251
|
# @option params [String] :if_match
|
5250
5252
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -5334,7 +5336,7 @@ module Aws::S3
|
|
5334
5336
|
# object.
|
5335
5337
|
#
|
5336
5338
|
# @option params [String] :expected_bucket_owner
|
5337
|
-
# The account
|
5339
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5338
5340
|
# a different account, the request will fail with an HTTP `403 (Access
|
5339
5341
|
# Denied)` error.
|
5340
5342
|
#
|
@@ -5375,49 +5377,49 @@ module Aws::S3
|
|
5375
5377
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5376
5378
|
#
|
5377
5379
|
#
|
5378
|
-
# @example Example: To retrieve
|
5380
|
+
# @example Example: To retrieve an object
|
5379
5381
|
#
|
5380
|
-
# # The following example retrieves an object for an S3 bucket.
|
5381
|
-
# # specific byte range.
|
5382
|
+
# # The following example retrieves an object for an S3 bucket.
|
5382
5383
|
#
|
5383
5384
|
# resp = client.get_object({
|
5384
5385
|
# bucket: "examplebucket",
|
5385
|
-
# key: "
|
5386
|
-
# range: "bytes=0-9",
|
5386
|
+
# key: "HappyFace.jpg",
|
5387
5387
|
# })
|
5388
5388
|
#
|
5389
5389
|
# resp.to_h outputs the following:
|
5390
5390
|
# {
|
5391
5391
|
# accept_ranges: "bytes",
|
5392
|
-
# content_length:
|
5393
|
-
#
|
5394
|
-
#
|
5395
|
-
#
|
5396
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5392
|
+
# content_length: 3191,
|
5393
|
+
# content_type: "image/jpeg",
|
5394
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5395
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5397
5396
|
# metadata: {
|
5398
5397
|
# },
|
5398
|
+
# tag_count: 2,
|
5399
5399
|
# version_id: "null",
|
5400
5400
|
# }
|
5401
5401
|
#
|
5402
|
-
# @example Example: To retrieve an object
|
5402
|
+
# @example Example: To retrieve a byte range of an object
|
5403
5403
|
#
|
5404
|
-
# # The following example retrieves an object for an S3 bucket.
|
5404
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5405
|
+
# # specific byte range.
|
5405
5406
|
#
|
5406
5407
|
# resp = client.get_object({
|
5407
5408
|
# bucket: "examplebucket",
|
5408
|
-
# key: "
|
5409
|
+
# key: "SampleFile.txt",
|
5410
|
+
# range: "bytes=0-9",
|
5409
5411
|
# })
|
5410
5412
|
#
|
5411
5413
|
# resp.to_h outputs the following:
|
5412
5414
|
# {
|
5413
5415
|
# accept_ranges: "bytes",
|
5414
|
-
# content_length:
|
5415
|
-
#
|
5416
|
-
#
|
5417
|
-
#
|
5416
|
+
# content_length: 10,
|
5417
|
+
# content_range: "bytes 0-9/43",
|
5418
|
+
# content_type: "text/plain",
|
5419
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5420
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5418
5421
|
# metadata: {
|
5419
5422
|
# },
|
5420
|
-
# tag_count: 2,
|
5421
5423
|
# version_id: "null",
|
5422
5424
|
# }
|
5423
5425
|
#
|
@@ -5556,11 +5558,11 @@ module Aws::S3
|
|
5556
5558
|
# When using this action with an access point through the AWS SDKs, you
|
5557
5559
|
# provide the access point ARN in place of the bucket name. For more
|
5558
5560
|
# information about access point ARNs, see [Using Access Points][1] in
|
5559
|
-
# the *Amazon
|
5561
|
+
# the *Amazon S3 User Guide*.
|
5560
5562
|
#
|
5561
5563
|
#
|
5562
5564
|
#
|
5563
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5565
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5564
5566
|
#
|
5565
5567
|
# @option params [required, String] :key
|
5566
5568
|
# The key of the object for which to get the ACL information.
|
@@ -5580,7 +5582,7 @@ module Aws::S3
|
|
5580
5582
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5581
5583
|
#
|
5582
5584
|
# @option params [String] :expected_bucket_owner
|
5583
|
-
# The account
|
5585
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5584
5586
|
# a different account, the request will fail with an HTTP `403 (Access
|
5585
5587
|
# Denied)` error.
|
5586
5588
|
#
|
@@ -5693,11 +5695,11 @@ module Aws::S3
|
|
5693
5695
|
# When using this action with an access point through the AWS SDKs, you
|
5694
5696
|
# provide the access point ARN in place of the bucket name. For more
|
5695
5697
|
# information about access point ARNs, see [Using Access Points][1] in
|
5696
|
-
# the *Amazon
|
5698
|
+
# the *Amazon S3 User Guide*.
|
5697
5699
|
#
|
5698
5700
|
#
|
5699
5701
|
#
|
5700
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5702
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5701
5703
|
#
|
5702
5704
|
# @option params [required, String] :key
|
5703
5705
|
# The key name for the object whose Legal Hold status you want to
|
@@ -5719,7 +5721,7 @@ module Aws::S3
|
|
5719
5721
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5720
5722
|
#
|
5721
5723
|
# @option params [String] :expected_bucket_owner
|
5722
|
-
# The account
|
5724
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5723
5725
|
# a different account, the request will fail with an HTTP `403 (Access
|
5724
5726
|
# Denied)` error.
|
5725
5727
|
#
|
@@ -5768,14 +5770,14 @@ module Aws::S3
|
|
5768
5770
|
# When using this action with an access point through the AWS SDKs, you
|
5769
5771
|
# provide the access point ARN in place of the bucket name. For more
|
5770
5772
|
# information about access point ARNs, see [Using Access Points][1] in
|
5771
|
-
# the *Amazon
|
5773
|
+
# the *Amazon S3 User Guide*.
|
5772
5774
|
#
|
5773
5775
|
#
|
5774
5776
|
#
|
5775
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5777
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5776
5778
|
#
|
5777
5779
|
# @option params [String] :expected_bucket_owner
|
5778
|
-
# The account
|
5780
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5779
5781
|
# a different account, the request will fail with an HTTP `403 (Access
|
5780
5782
|
# Denied)` error.
|
5781
5783
|
#
|
@@ -5825,11 +5827,11 @@ module Aws::S3
|
|
5825
5827
|
# When using this action with an access point through the AWS SDKs, you
|
5826
5828
|
# provide the access point ARN in place of the bucket name. For more
|
5827
5829
|
# information about access point ARNs, see [Using Access Points][1] in
|
5828
|
-
# the *Amazon
|
5830
|
+
# the *Amazon S3 User Guide*.
|
5829
5831
|
#
|
5830
5832
|
#
|
5831
5833
|
#
|
5832
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5834
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5833
5835
|
#
|
5834
5836
|
# @option params [required, String] :key
|
5835
5837
|
# The key name for the object whose retention settings you want to
|
@@ -5851,7 +5853,7 @@ module Aws::S3
|
|
5851
5853
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5852
5854
|
#
|
5853
5855
|
# @option params [String] :expected_bucket_owner
|
5854
|
-
# The account
|
5856
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5855
5857
|
# a different account, the request will fail with an HTTP `403 (Access
|
5856
5858
|
# Denied)` error.
|
5857
5859
|
#
|
@@ -5921,7 +5923,7 @@ module Aws::S3
|
|
5921
5923
|
# When using this action with an access point through the AWS SDKs, you
|
5922
5924
|
# provide the access point ARN in place of the bucket name. For more
|
5923
5925
|
# information about access point ARNs, see [Using Access Points][1] in
|
5924
|
-
# the *Amazon
|
5926
|
+
# the *Amazon S3 User Guide*.
|
5925
5927
|
#
|
5926
5928
|
# When using this action with Amazon S3 on Outposts, you must direct
|
5927
5929
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -5930,12 +5932,12 @@ module Aws::S3
|
|
5930
5932
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5931
5933
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5932
5934
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5933
|
-
# in the *Amazon
|
5935
|
+
# in the *Amazon S3 User Guide*.
|
5934
5936
|
#
|
5935
5937
|
#
|
5936
5938
|
#
|
5937
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5938
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5939
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5940
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5939
5941
|
#
|
5940
5942
|
# @option params [required, String] :key
|
5941
5943
|
# Object key for which to get the tagging information.
|
@@ -5944,7 +5946,7 @@ module Aws::S3
|
|
5944
5946
|
# The versionId of the object for which to get the tagging information.
|
5945
5947
|
#
|
5946
5948
|
# @option params [String] :expected_bucket_owner
|
5947
|
-
# The account
|
5949
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5948
5950
|
# a different account, the request will fail with an HTTP `403 (Access
|
5949
5951
|
# Denied)` error.
|
5950
5952
|
#
|
@@ -5965,49 +5967,49 @@ module Aws::S3
|
|
5965
5967
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
5966
5968
|
#
|
5967
5969
|
#
|
5968
|
-
# @example Example: To retrieve tag set of
|
5970
|
+
# @example Example: To retrieve tag set of a specific object version
|
5969
5971
|
#
|
5970
|
-
# # The following example retrieves tag set of an object.
|
5972
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
5971
5973
|
#
|
5972
5974
|
# resp = client.get_object_tagging({
|
5973
5975
|
# bucket: "examplebucket",
|
5974
|
-
# key: "
|
5976
|
+
# key: "exampleobject",
|
5977
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5975
5978
|
# })
|
5976
5979
|
#
|
5977
5980
|
# resp.to_h outputs the following:
|
5978
5981
|
# {
|
5979
5982
|
# tag_set: [
|
5980
5983
|
# {
|
5981
|
-
# key: "
|
5982
|
-
# value: "
|
5983
|
-
# },
|
5984
|
-
# {
|
5985
|
-
# key: "Key3",
|
5986
|
-
# value: "Value3",
|
5984
|
+
# key: "Key1",
|
5985
|
+
# value: "Value1",
|
5987
5986
|
# },
|
5988
5987
|
# ],
|
5989
|
-
# version_id: "
|
5988
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5990
5989
|
# }
|
5991
5990
|
#
|
5992
|
-
# @example Example: To retrieve tag set of
|
5991
|
+
# @example Example: To retrieve tag set of an object
|
5993
5992
|
#
|
5994
|
-
# # The following example retrieves tag set of an object.
|
5993
|
+
# # The following example retrieves tag set of an object.
|
5995
5994
|
#
|
5996
5995
|
# resp = client.get_object_tagging({
|
5997
5996
|
# bucket: "examplebucket",
|
5998
|
-
# key: "
|
5999
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5997
|
+
# key: "HappyFace.jpg",
|
6000
5998
|
# })
|
6001
5999
|
#
|
6002
6000
|
# resp.to_h outputs the following:
|
6003
6001
|
# {
|
6004
6002
|
# tag_set: [
|
6005
6003
|
# {
|
6006
|
-
# key: "
|
6007
|
-
# value: "
|
6004
|
+
# key: "Key4",
|
6005
|
+
# value: "Value4",
|
6006
|
+
# },
|
6007
|
+
# {
|
6008
|
+
# key: "Key3",
|
6009
|
+
# value: "Value3",
|
6008
6010
|
# },
|
6009
6011
|
# ],
|
6010
|
-
# version_id: "
|
6012
|
+
# version_id: "null",
|
6011
6013
|
# }
|
6012
6014
|
#
|
6013
6015
|
# @example Request syntax with placeholder values
|
@@ -6083,7 +6085,7 @@ module Aws::S3
|
|
6083
6085
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
6084
6086
|
#
|
6085
6087
|
# @option params [String] :expected_bucket_owner
|
6086
|
-
# The account
|
6088
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6087
6089
|
# a different account, the request will fail with an HTTP `403 (Access
|
6088
6090
|
# Denied)` error.
|
6089
6091
|
#
|
@@ -6169,7 +6171,7 @@ module Aws::S3
|
|
6169
6171
|
# configuration you want to retrieve.
|
6170
6172
|
#
|
6171
6173
|
# @option params [String] :expected_bucket_owner
|
6172
|
-
# The account
|
6174
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6173
6175
|
# a different account, the request will fail with an HTTP `403 (Access
|
6174
6176
|
# Denied)` error.
|
6175
6177
|
#
|
@@ -6218,8 +6220,8 @@ module Aws::S3
|
|
6218
6220
|
#
|
6219
6221
|
#
|
6220
6222
|
#
|
6221
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6222
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6223
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6224
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6223
6225
|
#
|
6224
6226
|
# @option params [required, String] :bucket
|
6225
6227
|
# The bucket name.
|
@@ -6230,7 +6232,7 @@ module Aws::S3
|
|
6230
6232
|
# When using this action with an access point through the AWS SDKs, you
|
6231
6233
|
# provide the access point ARN in place of the bucket name. For more
|
6232
6234
|
# information about access point ARNs, see [Using Access Points][1] in
|
6233
|
-
# the *Amazon
|
6235
|
+
# the *Amazon S3 User Guide*.
|
6234
6236
|
#
|
6235
6237
|
# When using this action with Amazon S3 on Outposts, you must direct
|
6236
6238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -6239,15 +6241,15 @@ module Aws::S3
|
|
6239
6241
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6240
6242
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6241
6243
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6242
|
-
# in the *Amazon
|
6244
|
+
# in the *Amazon S3 User Guide*.
|
6243
6245
|
#
|
6244
6246
|
#
|
6245
6247
|
#
|
6246
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6247
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6248
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6249
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6248
6250
|
#
|
6249
6251
|
# @option params [String] :expected_bucket_owner
|
6250
|
-
# The account
|
6252
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6251
6253
|
# a different account, the request will fail with an HTTP `403 (Access
|
6252
6254
|
# Denied)` error.
|
6253
6255
|
#
|
@@ -6383,7 +6385,7 @@ module Aws::S3
|
|
6383
6385
|
# When using this action with an access point through the AWS SDKs, you
|
6384
6386
|
# provide the access point ARN in place of the bucket name. For more
|
6385
6387
|
# information about access point ARNs, see [Using Access Points][1] in
|
6386
|
-
# the *Amazon
|
6388
|
+
# the *Amazon S3 User Guide*.
|
6387
6389
|
#
|
6388
6390
|
# When using this action with Amazon S3 on Outposts, you must direct
|
6389
6391
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -6392,12 +6394,12 @@ module Aws::S3
|
|
6392
6394
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6393
6395
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6394
6396
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6395
|
-
# in the *Amazon
|
6397
|
+
# in the *Amazon S3 User Guide*.
|
6396
6398
|
#
|
6397
6399
|
#
|
6398
6400
|
#
|
6399
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6400
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6401
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6402
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6401
6403
|
#
|
6402
6404
|
# @option params [String] :if_match
|
6403
6405
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -6469,7 +6471,7 @@ module Aws::S3
|
|
6469
6471
|
# the number of parts in this object.
|
6470
6472
|
#
|
6471
6473
|
# @option params [String] :expected_bucket_owner
|
6472
|
-
# The account
|
6474
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6473
6475
|
# a different account, the request will fail with an HTTP `403 (Access
|
6474
6476
|
# Denied)` error.
|
6475
6477
|
#
|
@@ -6631,8 +6633,8 @@ module Aws::S3
|
|
6631
6633
|
#
|
6632
6634
|
#
|
6633
6635
|
#
|
6634
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6635
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6636
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6637
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6636
6638
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
6637
6639
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
6638
6640
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
@@ -6647,7 +6649,7 @@ module Aws::S3
|
|
6647
6649
|
# request should begin.
|
6648
6650
|
#
|
6649
6651
|
# @option params [String] :expected_bucket_owner
|
6650
|
-
# The account
|
6652
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6651
6653
|
# a different account, the request will fail with an HTTP `403 (Access
|
6652
6654
|
# Denied)` error.
|
6653
6655
|
#
|
@@ -6815,8 +6817,8 @@ module Aws::S3
|
|
6815
6817
|
#
|
6816
6818
|
#
|
6817
6819
|
#
|
6818
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6819
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6820
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6821
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6820
6822
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
6821
6823
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
6822
6824
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
@@ -6833,7 +6835,7 @@ module Aws::S3
|
|
6833
6835
|
# token is an opaque value that Amazon S3 understands.
|
6834
6836
|
#
|
6835
6837
|
# @option params [String] :expected_bucket_owner
|
6836
|
-
# The account
|
6838
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6837
6839
|
# a different account, the request will fail with an HTTP `403 (Access
|
6838
6840
|
# Denied)` error.
|
6839
6841
|
#
|
@@ -6915,8 +6917,8 @@ module Aws::S3
|
|
6915
6917
|
#
|
6916
6918
|
#
|
6917
6919
|
#
|
6918
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6919
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6920
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6921
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6920
6922
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
6921
6923
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
6922
6924
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
@@ -6933,7 +6935,7 @@ module Aws::S3
|
|
6933
6935
|
# continuation token is an opaque value that Amazon S3 understands.
|
6934
6936
|
#
|
6935
6937
|
# @option params [String] :expected_bucket_owner
|
6936
|
-
# The account
|
6938
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6937
6939
|
# a different account, the request will fail with an HTTP `403 (Access
|
6938
6940
|
# Denied)` error.
|
6939
6941
|
#
|
@@ -7090,7 +7092,7 @@ module Aws::S3
|
|
7090
7092
|
# When using this action with an access point through the AWS SDKs, you
|
7091
7093
|
# provide the access point ARN in place of the bucket name. For more
|
7092
7094
|
# information about access point ARNs, see [Using Access Points][1] in
|
7093
|
-
# the *Amazon
|
7095
|
+
# the *Amazon S3 User Guide*.
|
7094
7096
|
#
|
7095
7097
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7096
7098
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7099,12 +7101,12 @@ module Aws::S3
|
|
7099
7101
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7100
7102
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7101
7103
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7102
|
-
# in the *Amazon
|
7104
|
+
# in the *Amazon S3 User Guide*.
|
7103
7105
|
#
|
7104
7106
|
#
|
7105
7107
|
#
|
7106
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7107
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7108
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7109
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7108
7110
|
#
|
7109
7111
|
# @option params [String] :delimiter
|
7110
7112
|
# Character you use to group keys.
|
@@ -7157,7 +7159,7 @@ module Aws::S3
|
|
7157
7159
|
# specified `upload-id-marker`.
|
7158
7160
|
#
|
7159
7161
|
# @option params [String] :expected_bucket_owner
|
7160
|
-
# The account
|
7162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7161
7163
|
# a different account, the request will fail with an HTTP `403 (Access
|
7162
7164
|
# Denied)` error.
|
7163
7165
|
#
|
@@ -7179,97 +7181,97 @@ module Aws::S3
|
|
7179
7181
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7180
7182
|
#
|
7181
7183
|
#
|
7182
|
-
# @example Example:
|
7184
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
7183
7185
|
#
|
7184
|
-
# # The following example
|
7185
|
-
# # setup of multipart uploads.
|
7186
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
7186
7187
|
#
|
7187
7188
|
# resp = client.list_multipart_uploads({
|
7188
7189
|
# bucket: "examplebucket",
|
7189
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
7190
|
-
# max_uploads: 2,
|
7191
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
7192
7190
|
# })
|
7193
7191
|
#
|
7194
7192
|
# resp.to_h outputs the following:
|
7195
7193
|
# {
|
7196
|
-
# bucket: "acl1",
|
7197
|
-
# is_truncated: true,
|
7198
|
-
# key_marker: "",
|
7199
|
-
# max_uploads: 2,
|
7200
|
-
# next_key_marker: "someobjectkey",
|
7201
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7202
|
-
# upload_id_marker: "",
|
7203
7194
|
# uploads: [
|
7204
7195
|
# {
|
7205
7196
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7206
7197
|
# initiator: {
|
7207
|
-
# display_name: "
|
7198
|
+
# display_name: "display-name",
|
7208
7199
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7209
7200
|
# },
|
7210
7201
|
# key: "JavaFile",
|
7211
7202
|
# owner: {
|
7212
|
-
# display_name: "
|
7213
|
-
# id: "
|
7203
|
+
# display_name: "display-name",
|
7204
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7214
7205
|
# },
|
7215
7206
|
# storage_class: "STANDARD",
|
7216
|
-
# upload_id: "
|
7207
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7217
7208
|
# },
|
7218
7209
|
# {
|
7219
7210
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7220
7211
|
# initiator: {
|
7221
|
-
# display_name: "
|
7212
|
+
# display_name: "display-name",
|
7222
7213
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7223
7214
|
# },
|
7224
7215
|
# key: "JavaFile",
|
7225
7216
|
# owner: {
|
7226
|
-
# display_name: "
|
7217
|
+
# display_name: "display-name",
|
7227
7218
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7228
7219
|
# },
|
7229
7220
|
# storage_class: "STANDARD",
|
7230
|
-
# upload_id: "
|
7221
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7231
7222
|
# },
|
7232
7223
|
# ],
|
7233
7224
|
# }
|
7234
7225
|
#
|
7235
|
-
# @example Example:
|
7226
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
7236
7227
|
#
|
7237
|
-
# # The following example
|
7228
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
7229
|
+
# # setup of multipart uploads.
|
7238
7230
|
#
|
7239
7231
|
# resp = client.list_multipart_uploads({
|
7240
7232
|
# bucket: "examplebucket",
|
7233
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
7234
|
+
# max_uploads: 2,
|
7235
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
7241
7236
|
# })
|
7242
7237
|
#
|
7243
7238
|
# resp.to_h outputs the following:
|
7244
7239
|
# {
|
7240
|
+
# bucket: "acl1",
|
7241
|
+
# is_truncated: true,
|
7242
|
+
# key_marker: "",
|
7243
|
+
# max_uploads: 2,
|
7244
|
+
# next_key_marker: "someobjectkey",
|
7245
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7246
|
+
# upload_id_marker: "",
|
7245
7247
|
# uploads: [
|
7246
7248
|
# {
|
7247
7249
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7248
7250
|
# initiator: {
|
7249
|
-
# display_name: "display-name",
|
7251
|
+
# display_name: "ownder-display-name",
|
7250
7252
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7251
7253
|
# },
|
7252
7254
|
# key: "JavaFile",
|
7253
7255
|
# owner: {
|
7254
|
-
# display_name: "
|
7255
|
-
# id: "
|
7256
|
+
# display_name: "mohanataws",
|
7257
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7256
7258
|
# },
|
7257
7259
|
# storage_class: "STANDARD",
|
7258
|
-
# upload_id: "
|
7260
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7259
7261
|
# },
|
7260
7262
|
# {
|
7261
7263
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7262
7264
|
# initiator: {
|
7263
|
-
# display_name: "display-name",
|
7265
|
+
# display_name: "ownder-display-name",
|
7264
7266
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7265
7267
|
# },
|
7266
7268
|
# key: "JavaFile",
|
7267
7269
|
# owner: {
|
7268
|
-
# display_name: "display-name",
|
7270
|
+
# display_name: "ownder-display-name",
|
7269
7271
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7270
7272
|
# },
|
7271
7273
|
# storage_class: "STANDARD",
|
7272
|
-
# upload_id: "
|
7274
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7273
7275
|
# },
|
7274
7276
|
# ],
|
7275
7277
|
# }
|
@@ -7324,6 +7326,9 @@ module Aws::S3
|
|
7324
7326
|
# can also use request parameters as selection criteria to return
|
7325
7327
|
# metadata about a subset of all the object versions.
|
7326
7328
|
#
|
7329
|
+
# To use this operation, you must have permissions to perform the
|
7330
|
+
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
7331
|
+
#
|
7327
7332
|
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
7328
7333
|
# design your application to parse the contents of the response and
|
7329
7334
|
# handle it appropriately.
|
@@ -7393,7 +7398,7 @@ module Aws::S3
|
|
7393
7398
|
# Specifies the object version you want to start listing from.
|
7394
7399
|
#
|
7395
7400
|
# @option params [String] :expected_bucket_owner
|
7396
|
-
# The account
|
7401
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7397
7402
|
# a different account, the request will fail with an HTTP `403 (Access
|
7398
7403
|
# Denied)` error.
|
7399
7404
|
#
|
@@ -7552,7 +7557,7 @@ module Aws::S3
|
|
7552
7557
|
# When using this action with an access point through the AWS SDKs, you
|
7553
7558
|
# provide the access point ARN in place of the bucket name. For more
|
7554
7559
|
# information about access point ARNs, see [Using Access Points][1] in
|
7555
|
-
# the *Amazon
|
7560
|
+
# the *Amazon S3 User Guide*.
|
7556
7561
|
#
|
7557
7562
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7558
7563
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7561,12 +7566,12 @@ module Aws::S3
|
|
7561
7566
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7562
7567
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7563
7568
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7564
|
-
# in the *Amazon
|
7569
|
+
# in the *Amazon S3 User Guide*.
|
7565
7570
|
#
|
7566
7571
|
#
|
7567
7572
|
#
|
7568
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7569
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7573
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7574
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7570
7575
|
#
|
7571
7576
|
# @option params [String] :delimiter
|
7572
7577
|
# A delimiter is a character you use to group keys.
|
@@ -7596,7 +7601,7 @@ module Aws::S3
|
|
7596
7601
|
# parameter in their requests.
|
7597
7602
|
#
|
7598
7603
|
# @option params [String] :expected_bucket_owner
|
7599
|
-
# The account
|
7604
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7600
7605
|
# a different account, the request will fail with an HTTP `403 (Access
|
7601
7606
|
# Denied)` error.
|
7602
7607
|
#
|
@@ -7731,8 +7736,8 @@ module Aws::S3
|
|
7731
7736
|
#
|
7732
7737
|
#
|
7733
7738
|
#
|
7734
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7735
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7739
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7740
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7736
7741
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7737
7742
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7738
7743
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
@@ -7748,7 +7753,7 @@ module Aws::S3
|
|
7748
7753
|
# When using this action with an access point through the AWS SDKs, you
|
7749
7754
|
# provide the access point ARN in place of the bucket name. For more
|
7750
7755
|
# information about access point ARNs, see [Using Access Points][1] in
|
7751
|
-
# the *Amazon
|
7756
|
+
# the *Amazon S3 User Guide*.
|
7752
7757
|
#
|
7753
7758
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7754
7759
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7757,12 +7762,12 @@ module Aws::S3
|
|
7757
7762
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7758
7763
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7759
7764
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7760
|
-
# in the *Amazon
|
7765
|
+
# in the *Amazon S3 User Guide*.
|
7761
7766
|
#
|
7762
7767
|
#
|
7763
7768
|
#
|
7764
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7765
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7769
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7770
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7766
7771
|
#
|
7767
7772
|
# @option params [String] :delimiter
|
7768
7773
|
# A delimiter is a character you use to group keys.
|
@@ -7799,7 +7804,7 @@ module Aws::S3
|
|
7799
7804
|
# this parameter in their requests.
|
7800
7805
|
#
|
7801
7806
|
# @option params [String] :expected_bucket_owner
|
7802
|
-
# The account
|
7807
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7803
7808
|
# a different account, the request will fail with an HTTP `403 (Access
|
7804
7809
|
# Denied)` error.
|
7805
7810
|
#
|
@@ -7954,7 +7959,7 @@ module Aws::S3
|
|
7954
7959
|
# When using this action with an access point through the AWS SDKs, you
|
7955
7960
|
# provide the access point ARN in place of the bucket name. For more
|
7956
7961
|
# information about access point ARNs, see [Using Access Points][1] in
|
7957
|
-
# the *Amazon
|
7962
|
+
# the *Amazon S3 User Guide*.
|
7958
7963
|
#
|
7959
7964
|
# When using this action with Amazon S3 on Outposts, you must direct
|
7960
7965
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -7963,12 +7968,12 @@ module Aws::S3
|
|
7963
7968
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7964
7969
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7965
7970
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7966
|
-
# in the *Amazon
|
7971
|
+
# in the *Amazon S3 User Guide*.
|
7967
7972
|
#
|
7968
7973
|
#
|
7969
7974
|
#
|
7970
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7971
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7975
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7976
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7972
7977
|
#
|
7973
7978
|
# @option params [required, String] :key
|
7974
7979
|
# Object key for which the multipart upload was initiated.
|
@@ -7996,7 +8001,7 @@ module Aws::S3
|
|
7996
8001
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7997
8002
|
#
|
7998
8003
|
# @option params [String] :expected_bucket_owner
|
7999
|
-
# The account
|
8004
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8000
8005
|
# a different account, the request will fail with an HTTP `403 (Access
|
8001
8006
|
# Denied)` error.
|
8002
8007
|
#
|
@@ -8141,8 +8146,8 @@ module Aws::S3
|
|
8141
8146
|
#
|
8142
8147
|
#
|
8143
8148
|
#
|
8144
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8145
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8149
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8150
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8146
8151
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
8147
8152
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
8148
8153
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
@@ -8154,7 +8159,7 @@ module Aws::S3
|
|
8154
8159
|
# Container for setting the transfer acceleration state.
|
8155
8160
|
#
|
8156
8161
|
# @option params [String] :expected_bucket_owner
|
8157
|
-
# The account
|
8162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8158
8163
|
# a different account, the request will fail with an HTTP `403 (Access
|
8159
8164
|
# Denied)` error.
|
8160
8165
|
#
|
@@ -8376,7 +8381,7 @@ module Aws::S3
|
|
8376
8381
|
# Allows grantee to write the ACL for the applicable bucket.
|
8377
8382
|
#
|
8378
8383
|
# @option params [String] :expected_bucket_owner
|
8379
|
-
# The account
|
8384
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8380
8385
|
# a different account, the request will fail with an HTTP `403 (Access
|
8381
8386
|
# Denied)` error.
|
8382
8387
|
#
|
@@ -8498,8 +8503,8 @@ module Aws::S3
|
|
8498
8503
|
#
|
8499
8504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
8500
8505
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
8501
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8502
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8506
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8507
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8503
8508
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
8504
8509
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
8505
8510
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -8514,7 +8519,7 @@ module Aws::S3
|
|
8514
8519
|
# The configuration and any analyses for the analytics filter.
|
8515
8520
|
#
|
8516
8521
|
# @option params [String] :expected_bucket_owner
|
8517
|
-
# The account
|
8522
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8518
8523
|
# a different account, the request will fail with an HTTP `403 (Access
|
8519
8524
|
# Denied)` error.
|
8520
8525
|
#
|
@@ -8605,7 +8610,7 @@ module Aws::S3
|
|
8605
8610
|
# element.
|
8606
8611
|
#
|
8607
8612
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
8608
|
-
# Sharing][1] in the *Amazon
|
8613
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
8609
8614
|
#
|
8610
8615
|
# **Related Resources**
|
8611
8616
|
#
|
@@ -8628,8 +8633,7 @@ module Aws::S3
|
|
8628
8633
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
8629
8634
|
# Describes the cross-origin access configuration for objects in an
|
8630
8635
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8631
|
-
# Resource Sharing][1] in the *Amazon
|
8632
|
-
# Guide*.
|
8636
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
8633
8637
|
#
|
8634
8638
|
#
|
8635
8639
|
#
|
@@ -8648,7 +8652,7 @@ module Aws::S3
|
|
8648
8652
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
8649
8653
|
#
|
8650
8654
|
# @option params [String] :expected_bucket_owner
|
8651
|
-
# The account
|
8655
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8652
8656
|
# a different account, the request will fail with an HTTP `403 (Access
|
8653
8657
|
# Denied)` error.
|
8654
8658
|
#
|
@@ -8735,9 +8739,8 @@ module Aws::S3
|
|
8735
8739
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
8736
8740
|
# also configure Amazon S3 Bucket Key. For information about default
|
8737
8741
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
8738
|
-
# *Amazon
|
8739
|
-
#
|
8740
|
-
# Storage Service User Guide*.
|
8742
|
+
# *Amazon S3 User Guide*. For more information about S3 Bucket Keys, see
|
8743
|
+
# [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*.
|
8741
8744
|
#
|
8742
8745
|
# This action requires AWS Signature Version 4. For more information,
|
8743
8746
|
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
@@ -8747,8 +8750,8 @@ module Aws::S3
|
|
8747
8750
|
# permission by default. The bucket owner can grant this permission to
|
8748
8751
|
# others. For more information about permissions, see [Permissions
|
8749
8752
|
# Related to Bucket Subresource Operations][4] and [Managing Access
|
8750
|
-
# Permissions to Your Amazon S3 Resources][5] in the Amazon
|
8751
|
-
#
|
8753
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
8754
|
+
# Guide.
|
8752
8755
|
#
|
8753
8756
|
# **Related Resources**
|
8754
8757
|
#
|
@@ -8761,8 +8764,8 @@ module Aws::S3
|
|
8761
8764
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
8762
8765
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
8763
8766
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
8764
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8765
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8767
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8768
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8766
8769
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
8767
8770
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
8768
8771
|
#
|
@@ -8771,7 +8774,7 @@ module Aws::S3
|
|
8771
8774
|
# with Amazon S3-managed keys (SSE-S3) or customer master keys stored in
|
8772
8775
|
# AWS KMS (SSE-KMS). For information about the Amazon S3 default
|
8773
8776
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
8774
|
-
# the *Amazon
|
8777
|
+
# the *Amazon S3 User Guide*.
|
8775
8778
|
#
|
8776
8779
|
#
|
8777
8780
|
#
|
@@ -8788,7 +8791,7 @@ module Aws::S3
|
|
8788
8791
|
# Specifies the default server-side-encryption configuration.
|
8789
8792
|
#
|
8790
8793
|
# @option params [String] :expected_bucket_owner
|
8791
|
-
# The account
|
8794
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8792
8795
|
# a different account, the request will fail with an HTTP `403 (Access
|
8793
8796
|
# Denied)` error.
|
8794
8797
|
#
|
@@ -8959,8 +8962,7 @@ module Aws::S3
|
|
8959
8962
|
# whether to generate the inventory daily or weekly. You can also
|
8960
8963
|
# configure what object metadata to include and whether to inventory all
|
8961
8964
|
# object versions or only current versions. For more information, see
|
8962
|
-
# [Amazon S3 Inventory][1] in the Amazon
|
8963
|
-
# Guide.
|
8965
|
+
# [Amazon S3 Inventory][1] in the Amazon S3 User Guide.
|
8964
8966
|
#
|
8965
8967
|
# You must create a bucket policy on the *destination* bucket to grant
|
8966
8968
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
@@ -8972,8 +8974,7 @@ module Aws::S3
|
|
8972
8974
|
# permission by default and can grant this permission to others. For
|
8973
8975
|
# more information about permissions, see [Permissions Related to Bucket
|
8974
8976
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
8975
|
-
# Amazon S3 Resources][4] in the Amazon
|
8976
|
-
# Guide.
|
8977
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
8977
8978
|
#
|
8978
8979
|
# **Special Errors**
|
8979
8980
|
#
|
@@ -9010,8 +9011,8 @@ module Aws::S3
|
|
9010
9011
|
#
|
9011
9012
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
9012
9013
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
9013
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9014
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9014
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9015
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9015
9016
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
9016
9017
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
9017
9018
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -9027,7 +9028,7 @@ module Aws::S3
|
|
9027
9028
|
# Specifies the inventory configuration.
|
9028
9029
|
#
|
9029
9030
|
# @option params [String] :expected_bucket_owner
|
9030
|
-
# The account
|
9031
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9031
9032
|
# a different account, the request will fail with an HTTP `403 (Access
|
9032
9033
|
# Denied)` error.
|
9033
9034
|
#
|
@@ -9084,8 +9085,8 @@ module Aws::S3
|
|
9084
9085
|
#
|
9085
9086
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9086
9087
|
# existing lifecycle configuration. For information about lifecycle
|
9087
|
-
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
9088
|
-
#
|
9088
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon S3
|
9089
|
+
# User Guide*.
|
9089
9090
|
#
|
9090
9091
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
9091
9092
|
# related subresources (for example, lifecycle configuration and website
|
@@ -9107,8 +9108,8 @@ module Aws::S3
|
|
9107
9108
|
# * `s3:PutLifecycleConfiguration`
|
9108
9109
|
#
|
9109
9110
|
# For more information about permissions, see [Managing Access
|
9110
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
9111
|
-
#
|
9111
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
9112
|
+
# Guide*.
|
9112
9113
|
#
|
9113
9114
|
# For more examples of transitioning objects to storage classes such as
|
9114
9115
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
@@ -9126,7 +9127,7 @@ module Aws::S3
|
|
9126
9127
|
# the AWS account that created the bucket—can perform any of the
|
9127
9128
|
# operations. A resource owner can also grant others permission to
|
9128
9129
|
# perform the operation. For more information, see the following
|
9129
|
-
# topics in the Amazon
|
9130
|
+
# topics in the Amazon S3 User Guide:
|
9130
9131
|
#
|
9131
9132
|
# * [Specifying Permissions in a Policy][8]
|
9132
9133
|
#
|
@@ -9136,7 +9137,7 @@ module Aws::S3
|
|
9136
9137
|
#
|
9137
9138
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
9138
9139
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9139
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9140
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9140
9141
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
9141
9142
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
9142
9143
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
@@ -9152,7 +9153,7 @@ module Aws::S3
|
|
9152
9153
|
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
|
9153
9154
|
#
|
9154
9155
|
# @option params [String] :expected_bucket_owner
|
9155
|
-
# The account
|
9156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9156
9157
|
# a different account, the request will fail with an HTTP `403 (Access
|
9157
9158
|
# Denied)` error.
|
9158
9159
|
#
|
@@ -9276,7 +9277,7 @@ module Aws::S3
|
|
9276
9277
|
#
|
9277
9278
|
#
|
9278
9279
|
#
|
9279
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9280
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9280
9281
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9281
9282
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9282
9283
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
@@ -9291,7 +9292,7 @@ module Aws::S3
|
|
9291
9292
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
9292
9293
|
#
|
9293
9294
|
# @option params [String] :expected_bucket_owner
|
9294
|
-
# The account
|
9295
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9295
9296
|
# a different account, the request will fail with an HTTP `403 (Access
|
9296
9297
|
# Denied)` error.
|
9297
9298
|
#
|
@@ -9472,7 +9473,7 @@ module Aws::S3
|
|
9472
9473
|
# SDKs, this field is calculated automatically.
|
9473
9474
|
#
|
9474
9475
|
# @option params [String] :expected_bucket_owner
|
9475
|
-
# The account
|
9476
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9476
9477
|
# a different account, the request will fail with an HTTP `403 (Access
|
9477
9478
|
# Denied)` error.
|
9478
9479
|
#
|
@@ -9575,8 +9576,8 @@ module Aws::S3
|
|
9575
9576
|
#
|
9576
9577
|
#
|
9577
9578
|
#
|
9578
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9579
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9579
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9580
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9580
9581
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
9581
9582
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
9582
9583
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -9592,7 +9593,7 @@ module Aws::S3
|
|
9592
9593
|
# Specifies the metrics configuration.
|
9593
9594
|
#
|
9594
9595
|
# @option params [String] :expected_bucket_owner
|
9595
|
-
# The account
|
9596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9596
9597
|
# a different account, the request will fail with an HTTP `403 (Access
|
9597
9598
|
# Denied)` error.
|
9598
9599
|
#
|
@@ -9654,7 +9655,7 @@ module Aws::S3
|
|
9654
9655
|
# The container for the configuration.
|
9655
9656
|
#
|
9656
9657
|
# @option params [String] :expected_bucket_owner
|
9657
|
-
# The account
|
9658
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9658
9659
|
# a different account, the request will fail with an HTTP `403 (Access
|
9659
9660
|
# Denied)` error.
|
9660
9661
|
#
|
@@ -9774,7 +9775,7 @@ module Aws::S3
|
|
9774
9775
|
# bucket.
|
9775
9776
|
#
|
9776
9777
|
# @option params [String] :expected_bucket_owner
|
9777
|
-
# The account
|
9778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9778
9779
|
# a different account, the request will fail with an HTTP `403 (Access
|
9779
9780
|
# Denied)` error.
|
9780
9781
|
#
|
@@ -9898,7 +9899,7 @@ module Aws::S3
|
|
9898
9899
|
# SDKs, this field is calculated automatically.
|
9899
9900
|
#
|
9900
9901
|
# @option params [String] :expected_bucket_owner
|
9901
|
-
# The account
|
9902
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9902
9903
|
# a different account, the request will fail with an HTTP `403 (Access
|
9903
9904
|
# Denied)` error.
|
9904
9905
|
#
|
@@ -9979,7 +9980,7 @@ module Aws::S3
|
|
9979
9980
|
# The bucket policy as a JSON document.
|
9980
9981
|
#
|
9981
9982
|
# @option params [String] :expected_bucket_owner
|
9982
|
-
# The account
|
9983
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9983
9984
|
# a different account, the request will fail with an HTTP `403 (Access
|
9984
9985
|
# Denied)` error.
|
9985
9986
|
#
|
@@ -10084,7 +10085,7 @@ module Aws::S3
|
|
10084
10085
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
10085
10086
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
10086
10087
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10087
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10088
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10088
10089
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
10089
10090
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
10090
10091
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -10113,7 +10114,7 @@ module Aws::S3
|
|
10113
10114
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
10114
10115
|
#
|
10115
10116
|
# @option params [String] :expected_bucket_owner
|
10116
|
-
# The account
|
10117
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10117
10118
|
# a different account, the request will fail with an HTTP `403 (Access
|
10118
10119
|
# Denied)` error.
|
10119
10120
|
#
|
@@ -10260,7 +10261,7 @@ module Aws::S3
|
|
10260
10261
|
# Container for Payer.
|
10261
10262
|
#
|
10262
10263
|
# @option params [String] :expected_bucket_owner
|
10263
|
-
# The account
|
10264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10264
10265
|
# a different account, the request will fail with an HTTP `403 (Access
|
10265
10266
|
# Denied)` error.
|
10266
10267
|
#
|
@@ -10363,8 +10364,8 @@ module Aws::S3
|
|
10363
10364
|
#
|
10364
10365
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
10365
10366
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
10366
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10367
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10367
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
10368
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10368
10369
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
10369
10370
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
10370
10371
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
@@ -10389,7 +10390,7 @@ module Aws::S3
|
|
10389
10390
|
# Container for the `TagSet` and `Tag` elements.
|
10390
10391
|
#
|
10391
10392
|
# @option params [String] :expected_bucket_owner
|
10392
|
-
# The account
|
10393
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10393
10394
|
# a different account, the request will fail with an HTTP `403 (Access
|
10394
10395
|
# Denied)` error.
|
10395
10396
|
#
|
@@ -10509,7 +10510,7 @@ module Aws::S3
|
|
10509
10510
|
# Container for setting the versioning state.
|
10510
10511
|
#
|
10511
10512
|
# @option params [String] :expected_bucket_owner
|
10512
|
-
# The account
|
10513
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10513
10514
|
# a different account, the request will fail with an HTTP `403 (Access
|
10514
10515
|
# Denied)` error.
|
10515
10516
|
#
|
@@ -10616,7 +10617,7 @@ module Aws::S3
|
|
10616
10617
|
# Amazon S3 has a limitation of 50 routing rules per website
|
10617
10618
|
# configuration. If you require more than 50 routing rules, you can use
|
10618
10619
|
# object redirect. For more information, see [Configuring an Object
|
10619
|
-
# Redirect][2] in the *Amazon
|
10620
|
+
# Redirect][2] in the *Amazon S3 User Guide*.
|
10620
10621
|
#
|
10621
10622
|
#
|
10622
10623
|
#
|
@@ -10642,7 +10643,7 @@ module Aws::S3
|
|
10642
10643
|
# Container for the request.
|
10643
10644
|
#
|
10644
10645
|
# @option params [String] :expected_bucket_owner
|
10645
|
-
# The account
|
10646
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10646
10647
|
# a different account, the request will fail with an HTTP `403 (Access
|
10647
10648
|
# Denied)` error.
|
10648
10649
|
#
|
@@ -10732,8 +10733,7 @@ module Aws::S3
|
|
10732
10733
|
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
10733
10734
|
# object with a retention period configured using Amazon S3 Object Lock.
|
10734
10735
|
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
10735
|
-
# Object Lock Overview][1] in the *Amazon
|
10736
|
-
# Developer Guide*.
|
10736
|
+
# Object Lock Overview][1] in the *Amazon S3 User Guide*.
|
10737
10737
|
#
|
10738
10738
|
# </note>
|
10739
10739
|
#
|
@@ -10748,8 +10748,8 @@ module Aws::S3
|
|
10748
10748
|
#
|
10749
10749
|
# If you request server-side encryption using AWS Key Management Service
|
10750
10750
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
10751
|
-
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon
|
10752
|
-
#
|
10751
|
+
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon S3
|
10752
|
+
# User Guide*.
|
10753
10753
|
#
|
10754
10754
|
# **Access Control List (ACL)-Specific Request Headers**
|
10755
10755
|
#
|
@@ -10823,7 +10823,7 @@ module Aws::S3
|
|
10823
10823
|
# When using this action with an access point through the AWS SDKs, you
|
10824
10824
|
# provide the access point ARN in place of the bucket name. For more
|
10825
10825
|
# information about access point ARNs, see [Using Access Points][1] in
|
10826
|
-
# the *Amazon
|
10826
|
+
# the *Amazon S3 User Guide*.
|
10827
10827
|
#
|
10828
10828
|
# When using this action with Amazon S3 on Outposts, you must direct
|
10829
10829
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -10832,12 +10832,12 @@ module Aws::S3
|
|
10832
10832
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
10833
10833
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
10834
10834
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
10835
|
-
# in the *Amazon
|
10835
|
+
# in the *Amazon S3 User Guide*.
|
10836
10836
|
#
|
10837
10837
|
#
|
10838
10838
|
#
|
10839
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10840
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10839
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
10840
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
10841
10841
|
#
|
10842
10842
|
# @option params [String] :cache_control
|
10843
10843
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -11052,7 +11052,7 @@ module Aws::S3
|
|
11052
11052
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
11053
11053
|
#
|
11054
11054
|
# @option params [String] :expected_bucket_owner
|
11055
|
-
# The account
|
11055
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11056
11056
|
# a different account, the request will fail with an HTTP `403 (Access
|
11057
11057
|
# Denied)` error.
|
11058
11058
|
#
|
@@ -11088,96 +11088,96 @@ module Aws::S3
|
|
11088
11088
|
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11089
11089
|
# }
|
11090
11090
|
#
|
11091
|
-
# @example Example: To
|
11091
|
+
# @example Example: To create an object.
|
11092
11092
|
#
|
11093
|
-
# # The following example
|
11094
|
-
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11093
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
11095
11094
|
#
|
11096
11095
|
# resp = client.put_object({
|
11097
|
-
# acl: "authenticated-read",
|
11098
11096
|
# body: "filetoupload",
|
11099
11097
|
# bucket: "examplebucket",
|
11100
|
-
# key: "
|
11098
|
+
# key: "objectkey",
|
11101
11099
|
# })
|
11102
11100
|
#
|
11103
11101
|
# resp.to_h outputs the following:
|
11104
11102
|
# {
|
11105
11103
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11106
|
-
# version_id: "
|
11104
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11107
11105
|
# }
|
11108
11106
|
#
|
11109
|
-
# @example Example: To
|
11107
|
+
# @example Example: To upload object and specify user-defined metadata
|
11110
11108
|
#
|
11111
|
-
# # The following example creates an object.
|
11109
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
11110
|
+
# # enabled, S3 returns version ID in response.
|
11112
11111
|
#
|
11113
11112
|
# resp = client.put_object({
|
11114
11113
|
# body: "filetoupload",
|
11115
11114
|
# bucket: "examplebucket",
|
11116
|
-
# key: "
|
11115
|
+
# key: "exampleobject",
|
11116
|
+
# metadata: {
|
11117
|
+
# "metadata1" => "value1",
|
11118
|
+
# "metadata2" => "value2",
|
11119
|
+
# },
|
11117
11120
|
# })
|
11118
11121
|
#
|
11119
11122
|
# resp.to_h outputs the following:
|
11120
11123
|
# {
|
11121
11124
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11122
|
-
# version_id: "
|
11125
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11123
11126
|
# }
|
11124
11127
|
#
|
11125
|
-
# @example Example: To upload an object
|
11128
|
+
# @example Example: To upload an object
|
11126
11129
|
#
|
11127
|
-
# # The following example uploads
|
11128
|
-
# #
|
11130
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11131
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11129
11132
|
#
|
11130
11133
|
# resp = client.put_object({
|
11131
|
-
# body: "
|
11134
|
+
# body: "HappyFace.jpg",
|
11132
11135
|
# bucket: "examplebucket",
|
11133
|
-
# key: "
|
11134
|
-
# server_side_encryption: "AES256",
|
11135
|
-
# tagging: "key1=value1&key2=value2",
|
11136
|
+
# key: "HappyFace.jpg",
|
11136
11137
|
# })
|
11137
11138
|
#
|
11138
11139
|
# resp.to_h outputs the following:
|
11139
11140
|
# {
|
11140
11141
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11141
|
-
#
|
11142
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11142
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11143
11143
|
# }
|
11144
11144
|
#
|
11145
|
-
# @example Example: To upload object and specify
|
11145
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
11146
11146
|
#
|
11147
|
-
# # The following example
|
11148
|
-
# # enabled, S3 returns version ID in response.
|
11147
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
11148
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
11149
11149
|
#
|
11150
11150
|
# resp = client.put_object({
|
11151
11151
|
# body: "filetoupload",
|
11152
11152
|
# bucket: "examplebucket",
|
11153
11153
|
# key: "exampleobject",
|
11154
|
-
#
|
11155
|
-
#
|
11156
|
-
# "metadata2" => "value2",
|
11157
|
-
# },
|
11154
|
+
# server_side_encryption: "AES256",
|
11155
|
+
# tagging: "key1=value1&key2=value2",
|
11158
11156
|
# })
|
11159
11157
|
#
|
11160
11158
|
# resp.to_h outputs the following:
|
11161
11159
|
# {
|
11162
11160
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11163
|
-
#
|
11161
|
+
# server_side_encryption: "AES256",
|
11162
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11164
11163
|
# }
|
11165
11164
|
#
|
11166
|
-
# @example Example: To upload an object
|
11165
|
+
# @example Example: To upload an object and specify canned ACL.
|
11167
11166
|
#
|
11168
|
-
# # The following example uploads
|
11169
|
-
# #
|
11167
|
+
# # The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ
|
11168
|
+
# # access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
|
11170
11169
|
#
|
11171
11170
|
# resp = client.put_object({
|
11172
|
-
#
|
11171
|
+
# acl: "authenticated-read",
|
11172
|
+
# body: "filetoupload",
|
11173
11173
|
# bucket: "examplebucket",
|
11174
|
-
# key: "
|
11174
|
+
# key: "exampleobject",
|
11175
11175
|
# })
|
11176
11176
|
#
|
11177
11177
|
# resp.to_h outputs the following:
|
11178
11178
|
# {
|
11179
11179
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11180
|
-
# version_id: "
|
11180
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11181
11181
|
# }
|
11182
11182
|
#
|
11183
11183
|
# @example Example: To upload an object (specify optional headers)
|
@@ -11270,8 +11270,8 @@ module Aws::S3
|
|
11270
11270
|
# Uses the `acl` subresource to set the access control list (ACL)
|
11271
11271
|
# permissions for a new or existing object in an S3 bucket. You must
|
11272
11272
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
11273
|
-
# information, see [What permissions can I grant?][1] in the *Amazon
|
11274
|
-
#
|
11273
|
+
# information, see [What permissions can I grant?][1] in the *Amazon S3
|
11274
|
+
# User Guide*.
|
11275
11275
|
#
|
11276
11276
|
# This action is not supported by Amazon S3 on Outposts.
|
11277
11277
|
#
|
@@ -11441,11 +11441,11 @@ module Aws::S3
|
|
11441
11441
|
# When using this action with an access point through the AWS SDKs, you
|
11442
11442
|
# provide the access point ARN in place of the bucket name. For more
|
11443
11443
|
# information about access point ARNs, see [Using Access Points][1] in
|
11444
|
-
# the *Amazon
|
11444
|
+
# the *Amazon S3 User Guide*.
|
11445
11445
|
#
|
11446
11446
|
#
|
11447
11447
|
#
|
11448
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11448
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11449
11449
|
#
|
11450
11450
|
# @option params [String] :content_md5
|
11451
11451
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -11494,7 +11494,7 @@ module Aws::S3
|
|
11494
11494
|
# When using this action with an access point through the AWS SDKs, you
|
11495
11495
|
# provide the access point ARN in place of the bucket name. For more
|
11496
11496
|
# information about access point ARNs, see [Using Access Points][1] in
|
11497
|
-
# the *Amazon
|
11497
|
+
# the *Amazon S3 User Guide*.
|
11498
11498
|
#
|
11499
11499
|
# When using this action with Amazon S3 on Outposts, you must direct
|
11500
11500
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -11503,12 +11503,12 @@ module Aws::S3
|
|
11503
11503
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11504
11504
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11505
11505
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11506
|
-
# in the *Amazon
|
11506
|
+
# in the *Amazon S3 User Guide*.
|
11507
11507
|
#
|
11508
11508
|
#
|
11509
11509
|
#
|
11510
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11511
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11510
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11511
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11512
11512
|
#
|
11513
11513
|
# @option params [String] :request_payer
|
11514
11514
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11525,7 +11525,7 @@ module Aws::S3
|
|
11525
11525
|
# VersionId used to reference a specific version of the object.
|
11526
11526
|
#
|
11527
11527
|
# @option params [String] :expected_bucket_owner
|
11528
|
-
# The account
|
11528
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11529
11529
|
# a different account, the request will fail with an HTTP `403 (Access
|
11530
11530
|
# Denied)` error.
|
11531
11531
|
#
|
@@ -11600,16 +11600,11 @@ module Aws::S3
|
|
11600
11600
|
req.send_request(options)
|
11601
11601
|
end
|
11602
11602
|
|
11603
|
-
# Applies a Legal Hold configuration to the specified object.
|
11603
|
+
# Applies a Legal Hold configuration to the specified object. For more
|
11604
|
+
# information, see [Locking Objects][1].
|
11604
11605
|
#
|
11605
11606
|
# This action is not supported by Amazon S3 on Outposts.
|
11606
11607
|
#
|
11607
|
-
# **Related Resources**
|
11608
|
-
#
|
11609
|
-
# * [Locking Objects][1]
|
11610
|
-
#
|
11611
|
-
# ^
|
11612
|
-
#
|
11613
11608
|
#
|
11614
11609
|
#
|
11615
11610
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11624,11 +11619,11 @@ module Aws::S3
|
|
11624
11619
|
# When using this action with an access point through the AWS SDKs, you
|
11625
11620
|
# provide the access point ARN in place of the bucket name. For more
|
11626
11621
|
# information about access point ARNs, see [Using Access Points][1] in
|
11627
|
-
# the *Amazon
|
11622
|
+
# the *Amazon S3 User Guide*.
|
11628
11623
|
#
|
11629
11624
|
#
|
11630
11625
|
#
|
11631
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11626
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11632
11627
|
#
|
11633
11628
|
# @option params [required, String] :key
|
11634
11629
|
# The key name for the object that you want to place a Legal Hold on.
|
@@ -11658,7 +11653,7 @@ module Aws::S3
|
|
11658
11653
|
# SDKs, this field is calculated automatically.
|
11659
11654
|
#
|
11660
11655
|
# @option params [String] :expected_bucket_owner
|
11661
|
-
# The account
|
11656
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11662
11657
|
# a different account, the request will fail with an HTTP `403 (Access
|
11663
11658
|
# Denied)` error.
|
11664
11659
|
#
|
@@ -11695,18 +11690,19 @@ module Aws::S3
|
|
11695
11690
|
|
11696
11691
|
# Places an Object Lock configuration on the specified bucket. The rule
|
11697
11692
|
# specified in the Object Lock configuration will be applied by default
|
11698
|
-
# to every new object placed in the specified bucket.
|
11699
|
-
#
|
11700
|
-
# <note markdown="1"> `DefaultRetention` requires either Days or Years. You can't specify
|
11701
|
-
# both at the same time.
|
11693
|
+
# to every new object placed in the specified bucket. For more
|
11694
|
+
# information, see [Locking Objects][1].
|
11702
11695
|
#
|
11703
|
-
#
|
11696
|
+
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
11704
11697
|
#
|
11705
|
-
#
|
11698
|
+
# * The `DefaultRetention` period can be either `Days` or `Years` but
|
11699
|
+
# you must select one. You cannot specify `Days` and `Years` at the
|
11700
|
+
# same time.
|
11706
11701
|
#
|
11707
|
-
# *
|
11702
|
+
# * You can only enable Object Lock for new buckets. If you want to turn
|
11703
|
+
# on Object Lock for an existing bucket, contact AWS Support.
|
11708
11704
|
#
|
11709
|
-
#
|
11705
|
+
# </note>
|
11710
11706
|
#
|
11711
11707
|
#
|
11712
11708
|
#
|
@@ -11741,7 +11737,7 @@ module Aws::S3
|
|
11741
11737
|
# SDKs, this field is calculated automatically.
|
11742
11738
|
#
|
11743
11739
|
# @option params [String] :expected_bucket_owner
|
11744
|
-
# The account
|
11740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11745
11741
|
# a different account, the request will fail with an HTTP `403 (Access
|
11746
11742
|
# Denied)` error.
|
11747
11743
|
#
|
@@ -11782,16 +11778,11 @@ module Aws::S3
|
|
11782
11778
|
req.send_request(options)
|
11783
11779
|
end
|
11784
11780
|
|
11785
|
-
# Places an Object Retention configuration on an object.
|
11781
|
+
# Places an Object Retention configuration on an object. For more
|
11782
|
+
# information, see [Locking Objects][1].
|
11786
11783
|
#
|
11787
11784
|
# This action is not supported by Amazon S3 on Outposts.
|
11788
11785
|
#
|
11789
|
-
# **Related Resources**
|
11790
|
-
#
|
11791
|
-
# * [Locking Objects][1]
|
11792
|
-
#
|
11793
|
-
# ^
|
11794
|
-
#
|
11795
11786
|
#
|
11796
11787
|
#
|
11797
11788
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11806,11 +11797,11 @@ module Aws::S3
|
|
11806
11797
|
# When using this action with an access point through the AWS SDKs, you
|
11807
11798
|
# provide the access point ARN in place of the bucket name. For more
|
11808
11799
|
# information about access point ARNs, see [Using Access Points][1] in
|
11809
|
-
# the *Amazon
|
11800
|
+
# the *Amazon S3 User Guide*.
|
11810
11801
|
#
|
11811
11802
|
#
|
11812
11803
|
#
|
11813
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11814
11805
|
#
|
11815
11806
|
# @option params [required, String] :key
|
11816
11807
|
# The key name for the object that you want to apply this Object
|
@@ -11845,7 +11836,7 @@ module Aws::S3
|
|
11845
11836
|
# SDKs, this field is calculated automatically.
|
11846
11837
|
#
|
11847
11838
|
# @option params [String] :expected_bucket_owner
|
11848
|
-
# The account
|
11839
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11849
11840
|
# a different account, the request will fail with an HTTP `403 (Access
|
11850
11841
|
# Denied)` error.
|
11851
11842
|
#
|
@@ -11948,7 +11939,7 @@ module Aws::S3
|
|
11948
11939
|
# When using this action with an access point through the AWS SDKs, you
|
11949
11940
|
# provide the access point ARN in place of the bucket name. For more
|
11950
11941
|
# information about access point ARNs, see [Using Access Points][1] in
|
11951
|
-
# the *Amazon
|
11942
|
+
# the *Amazon S3 User Guide*.
|
11952
11943
|
#
|
11953
11944
|
# When using this action with Amazon S3 on Outposts, you must direct
|
11954
11945
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -11957,12 +11948,12 @@ module Aws::S3
|
|
11957
11948
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11958
11949
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11959
11950
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11960
|
-
# in the *Amazon
|
11951
|
+
# in the *Amazon S3 User Guide*.
|
11961
11952
|
#
|
11962
11953
|
#
|
11963
11954
|
#
|
11964
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11965
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11955
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11956
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11966
11957
|
#
|
11967
11958
|
# @option params [required, String] :key
|
11968
11959
|
# Name of the object key.
|
@@ -11980,7 +11971,7 @@ module Aws::S3
|
|
11980
11971
|
# Container for the `TagSet` and `Tag` elements
|
11981
11972
|
#
|
11982
11973
|
# @option params [String] :expected_bucket_owner
|
11983
|
-
# The account
|
11974
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11984
11975
|
# a different account, the request will fail with an HTTP `403 (Access
|
11985
11976
|
# Denied)` error.
|
11986
11977
|
#
|
@@ -12108,14 +12099,14 @@ module Aws::S3
|
|
12108
12099
|
# Amazon S3 bucket. You can enable the configuration options in any
|
12109
12100
|
# combination. For more information about when Amazon S3 considers a
|
12110
12101
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
12111
|
-
# *Amazon
|
12102
|
+
# *Amazon S3 User Guide*.
|
12112
12103
|
#
|
12113
12104
|
#
|
12114
12105
|
#
|
12115
12106
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
12116
12107
|
#
|
12117
12108
|
# @option params [String] :expected_bucket_owner
|
12118
|
-
# The account
|
12109
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12119
12110
|
# a different account, the request will fail with an HTTP `403 (Access
|
12120
12111
|
# Denied)` error.
|
12121
12112
|
#
|
@@ -12159,7 +12150,7 @@ module Aws::S3
|
|
12159
12150
|
# default and can grant this permission to others. For more information
|
12160
12151
|
# about permissions, see [Permissions Related to Bucket Subresource
|
12161
12152
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
12162
|
-
# Resources][2] in the *Amazon
|
12153
|
+
# Resources][2] in the *Amazon S3 User Guide*.
|
12163
12154
|
#
|
12164
12155
|
# **Querying Archives with Select Requests**
|
12165
12156
|
#
|
@@ -12169,7 +12160,7 @@ module Aws::S3
|
|
12169
12160
|
# files. You can run queries and custom analytics on your archived data
|
12170
12161
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
12171
12162
|
# overview about select requests, see [Querying Archived Objects][3] in
|
12172
|
-
# the *Amazon
|
12163
|
+
# the *Amazon S3 User Guide*.
|
12173
12164
|
#
|
12174
12165
|
# When making a select request, do the following:
|
12175
12166
|
#
|
@@ -12179,19 +12170,18 @@ module Aws::S3
|
|
12179
12170
|
# that initiates the job must have permissions to write to the S3
|
12180
12171
|
# bucket. You can specify the storage class and encryption for the
|
12181
12172
|
# output objects stored in the bucket. For more information about
|
12182
|
-
# output, see [Querying Archived Objects][3] in the *Amazon
|
12183
|
-
#
|
12173
|
+
# output, see [Querying Archived Objects][3] in the *Amazon S3 User
|
12174
|
+
# Guide*.
|
12184
12175
|
#
|
12185
12176
|
# For more information about the `S3` structure in the request body,
|
12186
12177
|
# see the following:
|
12187
12178
|
#
|
12188
12179
|
# * [PutObject][4]
|
12189
12180
|
#
|
12190
|
-
# * [Managing Access with ACLs][5] in the *Amazon
|
12191
|
-
# Service User Guide*
|
12181
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
12192
12182
|
#
|
12193
12183
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
12194
|
-
#
|
12184
|
+
# S3 User Guide*
|
12195
12185
|
#
|
12196
12186
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
12197
12187
|
# your query in the request body's `SelectParameters` structure. You
|
@@ -12217,7 +12207,7 @@ module Aws::S3
|
|
12217
12207
|
#
|
12218
12208
|
# For more information about using SQL with S3 Glacier Select restore,
|
12219
12209
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
12220
|
-
# the *Amazon
|
12210
|
+
# the *Amazon S3 User Guide*.
|
12221
12211
|
#
|
12222
12212
|
# When making a select request, you can also do the following:
|
12223
12213
|
#
|
@@ -12296,20 +12286,19 @@ module Aws::S3
|
|
12296
12286
|
#
|
12297
12287
|
# For more information about archive retrieval options and provisioned
|
12298
12288
|
# capacity for `Expedited` data access, see [Restoring Archived
|
12299
|
-
# Objects][8] in the *Amazon
|
12289
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
12300
12290
|
#
|
12301
12291
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
12302
12292
|
# speed to a faster speed while it is in progress. For more information,
|
12303
12293
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
12304
|
-
#
|
12294
|
+
# S3 User Guide*.
|
12305
12295
|
#
|
12306
12296
|
# To get the status of object restoration, you can send a `HEAD`
|
12307
12297
|
# request. Operations return the `x-amz-restore` header, which provides
|
12308
12298
|
# information about the restoration status, in the response. You can use
|
12309
12299
|
# Amazon S3 event notifications to notify you when a restore is
|
12310
12300
|
# initiated or completed. For more information, see [Configuring Amazon
|
12311
|
-
# S3 Event Notifications][10] in the *Amazon
|
12312
|
-
# Guide*.
|
12301
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
12313
12302
|
#
|
12314
12303
|
# After restoring an archived object, you can update the restoration
|
12315
12304
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -12325,7 +12314,7 @@ module Aws::S3
|
|
12325
12314
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
12326
12315
|
# about lifecycle configuration, see
|
12327
12316
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
12328
|
-
# Management][12] in *Amazon
|
12317
|
+
# Management][12] in *Amazon S3 User Guide*.
|
12329
12318
|
#
|
12330
12319
|
# **Responses**
|
12331
12320
|
#
|
@@ -12367,12 +12356,12 @@ module Aws::S3
|
|
12367
12356
|
# * [GetBucketNotificationConfiguration][13]
|
12368
12357
|
#
|
12369
12358
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
12370
|
-
# the *Amazon
|
12359
|
+
# the *Amazon S3 User Guide*
|
12371
12360
|
#
|
12372
12361
|
#
|
12373
12362
|
#
|
12374
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12375
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12363
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12364
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
12376
12365
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
12377
12366
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
12378
12367
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
@@ -12394,7 +12383,7 @@ module Aws::S3
|
|
12394
12383
|
# When using this action with an access point through the AWS SDKs, you
|
12395
12384
|
# provide the access point ARN in place of the bucket name. For more
|
12396
12385
|
# information about access point ARNs, see [Using Access Points][1] in
|
12397
|
-
# the *Amazon
|
12386
|
+
# the *Amazon S3 User Guide*.
|
12398
12387
|
#
|
12399
12388
|
# When using this action with Amazon S3 on Outposts, you must direct
|
12400
12389
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -12403,12 +12392,12 @@ module Aws::S3
|
|
12403
12392
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
12404
12393
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
12405
12394
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
12406
|
-
# in the *Amazon
|
12395
|
+
# in the *Amazon S3 User Guide*.
|
12407
12396
|
#
|
12408
12397
|
#
|
12409
12398
|
#
|
12410
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12411
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12399
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12400
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
12412
12401
|
#
|
12413
12402
|
# @option params [required, String] :key
|
12414
12403
|
# Object key for which the action was initiated.
|
@@ -12431,7 +12420,7 @@ module Aws::S3
|
|
12431
12420
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12432
12421
|
#
|
12433
12422
|
# @option params [String] :expected_bucket_owner
|
12434
|
-
# The account
|
12423
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12435
12424
|
# a different account, the request will fail with an HTTP `403 (Access
|
12436
12425
|
# Denied)` error.
|
12437
12426
|
#
|
@@ -12576,11 +12565,11 @@ module Aws::S3
|
|
12576
12565
|
# This action is not supported by Amazon S3 on Outposts.
|
12577
12566
|
#
|
12578
12567
|
# For more information about Amazon S3 Select, see [Selecting Content
|
12579
|
-
# from Objects][1] in the *Amazon
|
12568
|
+
# from Objects][1] in the *Amazon S3 User Guide*.
|
12580
12569
|
#
|
12581
12570
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
12582
12571
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
12583
|
-
# *Amazon
|
12572
|
+
# *Amazon S3 User Guide*.
|
12584
12573
|
#
|
12585
12574
|
#
|
12586
12575
|
#
|
@@ -12589,7 +12578,7 @@ module Aws::S3
|
|
12589
12578
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
12590
12579
|
# Select does not support anonymous access. For more information about
|
12591
12580
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
12592
|
-
# *Amazon
|
12581
|
+
# *Amazon S3 User Guide*.
|
12593
12582
|
#
|
12594
12583
|
#
|
12595
12584
|
#
|
@@ -12617,8 +12606,7 @@ module Aws::S3
|
|
12617
12606
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
12618
12607
|
# are documented in the [GetObject][4]. For more information about
|
12619
12608
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
12620
|
-
# Encryption Keys)][5] in the *Amazon
|
12621
|
-
# Guide*.
|
12609
|
+
# Encryption Keys)][5] in the *Amazon S3 User Guide*.
|
12622
12610
|
#
|
12623
12611
|
# For objects that are encrypted with Amazon S3 managed encryption
|
12624
12612
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
@@ -12626,7 +12614,7 @@ module Aws::S3
|
|
12626
12614
|
# transparently, so you don't need to specify anything. For more
|
12627
12615
|
# information about server-side encryption, including SSE-S3 and
|
12628
12616
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
12629
|
-
# the *Amazon
|
12617
|
+
# the *Amazon S3 User Guide*.
|
12630
12618
|
#
|
12631
12619
|
# **Working with the Response Body**
|
12632
12620
|
#
|
@@ -12650,8 +12638,7 @@ module Aws::S3
|
|
12650
12638
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
12651
12639
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
12652
12640
|
# storage classes. For more information, about storage classes see
|
12653
|
-
# [Storage Classes][9] in the *Amazon
|
12654
|
-
# Guide*.
|
12641
|
+
# [Storage Classes][9] in the *Amazon S3 User Guide*.
|
12655
12642
|
#
|
12656
12643
|
#
|
12657
12644
|
#
|
@@ -12750,7 +12737,7 @@ module Aws::S3
|
|
12750
12737
|
# within the last 50 bytes of the file.
|
12751
12738
|
#
|
12752
12739
|
# @option params [String] :expected_bucket_owner
|
12753
|
-
# The account
|
12740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12754
12741
|
# a different account, the request will fail with an HTTP `403 (Access
|
12755
12742
|
# Denied)` error.
|
12756
12743
|
#
|
@@ -13017,11 +13004,11 @@ module Aws::S3
|
|
13017
13004
|
# parts storage and stops charging you for the parts storage.
|
13018
13005
|
#
|
13019
13006
|
# For more information on multipart uploads, go to [Multipart Upload
|
13020
|
-
# Overview][4] in the <i>Amazon
|
13007
|
+
# Overview][4] in the <i>Amazon S3 User Guide </i>.
|
13021
13008
|
#
|
13022
13009
|
# For information on the permissions required to use the multipart
|
13023
13010
|
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
13024
|
-
#
|
13011
|
+
# S3 User Guide*.
|
13025
13012
|
#
|
13026
13013
|
# You can optionally request server-side encryption where Amazon S3
|
13027
13014
|
# encrypts your data as it writes it to disks in its data centers and
|
@@ -13031,8 +13018,7 @@ module Aws::S3
|
|
13031
13018
|
# request headers you provide in the request must match the headers you
|
13032
13019
|
# used in the request to initiate the upload by using
|
13033
13020
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
13034
|
-
# Server-Side Encryption][6] in the *Amazon
|
13035
|
-
# Guide*.
|
13021
|
+
# Server-Side Encryption][6] in the *Amazon S3 User Guide*.
|
13036
13022
|
#
|
13037
13023
|
# Server-side encryption is supported by the S3 Multipart Upload
|
13038
13024
|
# actions. Unless you are using a customer-provided encryption key, you
|
@@ -13101,7 +13087,7 @@ module Aws::S3
|
|
13101
13087
|
# When using this action with an access point through the AWS SDKs, you
|
13102
13088
|
# provide the access point ARN in place of the bucket name. For more
|
13103
13089
|
# information about access point ARNs, see [Using Access Points][1] in
|
13104
|
-
# the *Amazon
|
13090
|
+
# the *Amazon S3 User Guide*.
|
13105
13091
|
#
|
13106
13092
|
# When using this action with Amazon S3 on Outposts, you must direct
|
13107
13093
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -13110,12 +13096,12 @@ module Aws::S3
|
|
13110
13096
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13111
13097
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13112
13098
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13113
|
-
# in the *Amazon
|
13099
|
+
# in the *Amazon S3 User Guide*.
|
13114
13100
|
#
|
13115
13101
|
#
|
13116
13102
|
#
|
13117
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13118
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13103
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13104
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13119
13105
|
#
|
13120
13106
|
# @option params [Integer] :content_length
|
13121
13107
|
# Size of the body in bytes. This parameter is useful when the size of
|
@@ -13167,7 +13153,7 @@ module Aws::S3
|
|
13167
13153
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13168
13154
|
#
|
13169
13155
|
# @option params [String] :expected_bucket_owner
|
13170
|
-
# The account
|
13156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
13171
13157
|
# a different account, the request will fail with an HTTP `403 (Access
|
13172
13158
|
# Denied)` error.
|
13173
13159
|
#
|
@@ -13243,7 +13229,7 @@ module Aws::S3
|
|
13243
13229
|
#
|
13244
13230
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
13245
13231
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
13246
|
-
# in the *Amazon
|
13232
|
+
# in the *Amazon S3 User Guide*.
|
13247
13233
|
#
|
13248
13234
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
13249
13235
|
# [UploadPart][2] action and provide data in your request.
|
@@ -13259,16 +13245,15 @@ module Aws::S3
|
|
13259
13245
|
# the following:
|
13260
13246
|
#
|
13261
13247
|
# * For conceptual information about multipart uploads, see [Uploading
|
13262
|
-
# Objects Using Multipart Upload][3] in the *Amazon
|
13263
|
-
# Service User Guide*.
|
13248
|
+
# Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*.
|
13264
13249
|
#
|
13265
13250
|
# * For information about permissions required to use the multipart
|
13266
13251
|
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
13267
|
-
#
|
13252
|
+
# S3 User Guide*.
|
13268
13253
|
#
|
13269
13254
|
# * For information about copying objects using a single atomic action
|
13270
13255
|
# vs. the multipart upload, see [Operations on Objects][5] in the
|
13271
|
-
# *Amazon
|
13256
|
+
# *Amazon S3 User Guide*.
|
13272
13257
|
#
|
13273
13258
|
# * For information about using server-side encryption with
|
13274
13259
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
@@ -13376,7 +13361,7 @@ module Aws::S3
|
|
13376
13361
|
# When using this action with an access point through the AWS SDKs, you
|
13377
13362
|
# provide the access point ARN in place of the bucket name. For more
|
13378
13363
|
# information about access point ARNs, see [Using Access Points][1] in
|
13379
|
-
# the *Amazon
|
13364
|
+
# the *Amazon S3 User Guide*.
|
13380
13365
|
#
|
13381
13366
|
# When using this action with Amazon S3 on Outposts, you must direct
|
13382
13367
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
@@ -13385,12 +13370,12 @@ module Aws::S3
|
|
13385
13370
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13386
13371
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13387
13372
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13388
|
-
# in the *Amazon
|
13373
|
+
# in the *Amazon S3 User Guide*.
|
13389
13374
|
#
|
13390
13375
|
#
|
13391
13376
|
#
|
13392
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13393
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13377
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13378
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13394
13379
|
#
|
13395
13380
|
# @option params [required, String] :copy_source
|
13396
13381
|
# Specifies the source object for the copy operation. You specify the
|
@@ -13436,7 +13421,7 @@ module Aws::S3
|
|
13436
13421
|
#
|
13437
13422
|
#
|
13438
13423
|
#
|
13439
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13424
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
13440
13425
|
#
|
13441
13426
|
# @option params [String] :copy_source_if_match
|
13442
13427
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -13513,12 +13498,12 @@ module Aws::S3
|
|
13513
13498
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13514
13499
|
#
|
13515
13500
|
# @option params [String] :expected_bucket_owner
|
13516
|
-
# The account
|
13501
|
+
# The account ID of the expected destination bucket owner. If the
|
13517
13502
|
# destination bucket is owned by a different account, the request will
|
13518
13503
|
# fail with an HTTP `403 (Access Denied)` error.
|
13519
13504
|
#
|
13520
13505
|
# @option params [String] :expected_source_bucket_owner
|
13521
|
-
# The account
|
13506
|
+
# The account ID of the expected source bucket owner. If the source
|
13522
13507
|
# bucket is owned by a different account, the request will fail with an
|
13523
13508
|
# HTTP `403 (Access Denied)` error.
|
13524
13509
|
#
|
@@ -13621,6 +13606,297 @@ module Aws::S3
|
|
13621
13606
|
req.send_request(options)
|
13622
13607
|
end
|
13623
13608
|
|
13609
|
+
# Passes transformed objects to a `GetObject` operation when using
|
13610
|
+
# Object Lambda Access Points. For information about Object Lambda
|
13611
|
+
# Access Points, see [Transforming objects with Object Lambda Access
|
13612
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
13613
|
+
#
|
13614
|
+
# This operation supports metadata that can be returned by
|
13615
|
+
# [GetObject][2], in addition to `RequestRoute`, `RequestToken`,
|
13616
|
+
# `StatusCode`, `ErrorCode`, and `ErrorMessage`. The `GetObject`
|
13617
|
+
# response metadata is supported so that the `WriteGetObjectResponse`
|
13618
|
+
# caller, typically an AWS Lambda function, can provide the same
|
13619
|
+
# metadata when it internally invokes `GetObject`. When
|
13620
|
+
# `WriteGetObjectResponse` is called by a customer-owned Lambda
|
13621
|
+
# function, the metadata returned to the end user `GetObject` call might
|
13622
|
+
# differ from what Amazon S3 would normally return.
|
13623
|
+
#
|
13624
|
+
# AWS provides some prebuilt Lambda functions that you can use with S3
|
13625
|
+
# Object Lambda to detect and redact personally identifiable information
|
13626
|
+
# (PII) and decompress S3 objects. These Lambda functions are available
|
13627
|
+
# in the AWS Serverless Application Repository, and can be selected
|
13628
|
+
# through the AWS Management Console when you create your Object Lambda
|
13629
|
+
# Access Point.
|
13630
|
+
#
|
13631
|
+
# Example 1: PII Access Control - This Lambda function uses Amazon
|
13632
|
+
# Comprehend, a natural language processing (NLP) service using machine
|
13633
|
+
# learning to find insights and relationships in text. It automatically
|
13634
|
+
# detects personally identifiable information (PII) such as names,
|
13635
|
+
# addresses, dates, credit card numbers, and social security numbers
|
13636
|
+
# from documents in your Amazon S3 bucket.
|
13637
|
+
#
|
13638
|
+
# Example 2: PII Redaction - 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
|
+
# redacts 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 3: Decompression - The Lambda function
|
13646
|
+
# S3ObjectLambdaDecompression, is equipped to decompress objects stored
|
13647
|
+
# in S3 in one of six compressed file formats including bzip2, gzip,
|
13648
|
+
# snappy, zlib, zstandard and ZIP.
|
13649
|
+
#
|
13650
|
+
# For information on how to view and use these functions, see [Using AWS
|
13651
|
+
# built Lambda functions][3] in the *Amazon S3 User Guide*.
|
13652
|
+
#
|
13653
|
+
#
|
13654
|
+
#
|
13655
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
13656
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13657
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html
|
13658
|
+
#
|
13659
|
+
# @option params [required, String] :request_route
|
13660
|
+
# Route prefix to the HTTP URL generated.
|
13661
|
+
#
|
13662
|
+
# @option params [required, String] :request_token
|
13663
|
+
# A single use encrypted token that maps `WriteGetObjectResponse` to the
|
13664
|
+
# end user `GetObject` request.
|
13665
|
+
#
|
13666
|
+
# @option params [String, IO] :body
|
13667
|
+
# The object data.
|
13668
|
+
#
|
13669
|
+
# @option params [Integer] :status_code
|
13670
|
+
# The integer status code for an HTTP response of a corresponding
|
13671
|
+
# `GetObject` request.
|
13672
|
+
#
|
13673
|
+
# **Status Codes**
|
13674
|
+
#
|
13675
|
+
# * *200 - OK*
|
13676
|
+
#
|
13677
|
+
# * *206 - Partial Content*
|
13678
|
+
#
|
13679
|
+
# * *304 - Not Modified*
|
13680
|
+
#
|
13681
|
+
# * *400 - Bad Request*
|
13682
|
+
#
|
13683
|
+
# * *401 - Unauthorized*
|
13684
|
+
#
|
13685
|
+
# * *403 - Forbidden*
|
13686
|
+
#
|
13687
|
+
# * *404 - Not Found*
|
13688
|
+
#
|
13689
|
+
# * *405 - Method Not Allowed*
|
13690
|
+
#
|
13691
|
+
# * *409 - Conflict*
|
13692
|
+
#
|
13693
|
+
# * *411 - Length Required*
|
13694
|
+
#
|
13695
|
+
# * *412 - Precondition Failed*
|
13696
|
+
#
|
13697
|
+
# * *416 - Range Not Satisfiable*
|
13698
|
+
#
|
13699
|
+
# * *500 - Internal Server Error*
|
13700
|
+
#
|
13701
|
+
# * *503 - Service Unavailable*
|
13702
|
+
#
|
13703
|
+
# @option params [String] :error_code
|
13704
|
+
# A string that uniquely identifies an error condition. Returned in the
|
13705
|
+
# <Code> tag of the error XML response for a corresponding
|
13706
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13707
|
+
# or when the transformed object is provided in the body. All error
|
13708
|
+
# codes from S3 are sentence-cased. Regex value is
|
13709
|
+
# "^\[A-Z\]\[a-zA-Z\]+$".
|
13710
|
+
#
|
13711
|
+
# @option params [String] :error_message
|
13712
|
+
# Contains a generic description of the error condition. Returned in the
|
13713
|
+
# <Message> tag of the error XML response for a corresponding
|
13714
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13715
|
+
# or when the transformed object is provided in body.
|
13716
|
+
#
|
13717
|
+
# @option params [String] :accept_ranges
|
13718
|
+
# Indicates that a range of bytes was specified.
|
13719
|
+
#
|
13720
|
+
# @option params [String] :cache_control
|
13721
|
+
# Specifies caching behavior along the request/reply chain.
|
13722
|
+
#
|
13723
|
+
# @option params [String] :content_disposition
|
13724
|
+
# Specifies presentational information for the object.
|
13725
|
+
#
|
13726
|
+
# @option params [String] :content_encoding
|
13727
|
+
# Specifies what content encodings have been applied to the object and
|
13728
|
+
# thus what decoding mechanisms must be applied to obtain the media-type
|
13729
|
+
# referenced by the Content-Type header field.
|
13730
|
+
#
|
13731
|
+
# @option params [String] :content_language
|
13732
|
+
# The language the content is in.
|
13733
|
+
#
|
13734
|
+
# @option params [Integer] :content_length
|
13735
|
+
# The size of the content body in bytes.
|
13736
|
+
#
|
13737
|
+
# @option params [String] :content_range
|
13738
|
+
# The portion of the object returned in the response.
|
13739
|
+
#
|
13740
|
+
# @option params [String] :content_type
|
13741
|
+
# A standard MIME type describing the format of the object data.
|
13742
|
+
#
|
13743
|
+
# @option params [Boolean] :delete_marker
|
13744
|
+
# Specifies whether an object stored in Amazon S3 is (`true`) or is not
|
13745
|
+
# (`false`) a delete marker.
|
13746
|
+
#
|
13747
|
+
# @option params [String] :etag
|
13748
|
+
# An opaque identifier assigned by a web server to a specific version of
|
13749
|
+
# a resource found at a URL.
|
13750
|
+
#
|
13751
|
+
# @option params [Time,DateTime,Date,Integer,String] :expires
|
13752
|
+
# The date and time at which the object is no longer cacheable.
|
13753
|
+
#
|
13754
|
+
# @option params [String] :expiration
|
13755
|
+
# If object stored in Amazon S3 expiration is configured (see PUT Bucket
|
13756
|
+
# lifecycle) it includes expiry-date and rule-id key-value pairs
|
13757
|
+
# providing object expiration information. The value of the rule-id is
|
13758
|
+
# URL encoded.
|
13759
|
+
#
|
13760
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified
|
13761
|
+
# The date and time that the object was last modified.
|
13762
|
+
#
|
13763
|
+
# @option params [Integer] :missing_meta
|
13764
|
+
# Set to the number of metadata entries not returned in `x-amz-meta`
|
13765
|
+
# headers. This can happen if you create metadata using an API like SOAP
|
13766
|
+
# that supports more flexible metadata than the REST API. For example,
|
13767
|
+
# using SOAP, you can create metadata whose values are not legal HTTP
|
13768
|
+
# headers.
|
13769
|
+
#
|
13770
|
+
# @option params [Hash<String,String>] :metadata
|
13771
|
+
# A map of metadata to store with the object in S3.
|
13772
|
+
#
|
13773
|
+
# @option params [String] :object_lock_mode
|
13774
|
+
# Indicates whether an object stored in Amazon S3 has Object Lock
|
13775
|
+
# enabled. For more information about S3 Object Lock, see [Object
|
13776
|
+
# Lock][1].
|
13777
|
+
#
|
13778
|
+
#
|
13779
|
+
#
|
13780
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
13781
|
+
#
|
13782
|
+
# @option params [String] :object_lock_legal_hold_status
|
13783
|
+
# Indicates whether an object stored in Amazon S3 has an active legal
|
13784
|
+
# hold.
|
13785
|
+
#
|
13786
|
+
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
13787
|
+
# The date and time when Object Lock is configured to expire.
|
13788
|
+
#
|
13789
|
+
# @option params [Integer] :parts_count
|
13790
|
+
# The count of parts this object has.
|
13791
|
+
#
|
13792
|
+
# @option params [String] :replication_status
|
13793
|
+
# Indicates if request involves bucket that is either a source or
|
13794
|
+
# destination in a Replication rule. For more information about S3
|
13795
|
+
# Replication, see [Replication][1].
|
13796
|
+
#
|
13797
|
+
#
|
13798
|
+
#
|
13799
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
|
13800
|
+
#
|
13801
|
+
# @option params [String] :request_charged
|
13802
|
+
# If present, indicates that the requester was successfully charged for
|
13803
|
+
# the request.
|
13804
|
+
#
|
13805
|
+
# @option params [String] :restore
|
13806
|
+
# Provides information about object restoration operation and expiration
|
13807
|
+
# time of the restored object copy.
|
13808
|
+
#
|
13809
|
+
# @option params [String] :server_side_encryption
|
13810
|
+
# The server-side encryption algorithm used when storing requested
|
13811
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
13812
|
+
#
|
13813
|
+
# @option params [String] :sse_customer_algorithm
|
13814
|
+
# Encryption algorithm used if server-side encryption with a
|
13815
|
+
# customer-provided encryption key was specified for object stored in
|
13816
|
+
# Amazon S3.
|
13817
|
+
#
|
13818
|
+
# @option params [String] :ssekms_key_id
|
13819
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
13820
|
+
# KMS) symmetric customer managed customer master key (CMK) that was
|
13821
|
+
# used for stored in Amazon S3 object.
|
13822
|
+
#
|
13823
|
+
# @option params [String] :sse_customer_key_md5
|
13824
|
+
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
13825
|
+
# S3 to encrypt data stored in S3. For more information, see [Protecting
|
13826
|
+
# data using server-side encryption with customer-provided encryption
|
13827
|
+
# keys (SSE-C)][1].
|
13828
|
+
#
|
13829
|
+
#
|
13830
|
+
#
|
13831
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
13832
|
+
#
|
13833
|
+
# @option params [String] :storage_class
|
13834
|
+
# The class of storage used to store object in Amazon S3.
|
13835
|
+
#
|
13836
|
+
# @option params [Integer] :tag_count
|
13837
|
+
# The number of tags, if any, on the object.
|
13838
|
+
#
|
13839
|
+
# @option params [String] :version_id
|
13840
|
+
# An ID used to reference a specific version of the object.
|
13841
|
+
#
|
13842
|
+
# @option params [Boolean] :bucket_key_enabled
|
13843
|
+
# Indicates whether the object stored in Amazon S3 uses an S3 bucket key
|
13844
|
+
# for server-side encryption with AWS KMS (SSE-KMS).
|
13845
|
+
#
|
13846
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13847
|
+
#
|
13848
|
+
# @example Request syntax with placeholder values
|
13849
|
+
#
|
13850
|
+
# resp = client.write_get_object_response({
|
13851
|
+
# request_route: "RequestRoute", # required
|
13852
|
+
# request_token: "RequestToken", # required
|
13853
|
+
# body: source_file,
|
13854
|
+
# status_code: 1,
|
13855
|
+
# error_code: "ErrorCode",
|
13856
|
+
# error_message: "ErrorMessage",
|
13857
|
+
# accept_ranges: "AcceptRanges",
|
13858
|
+
# cache_control: "CacheControl",
|
13859
|
+
# content_disposition: "ContentDisposition",
|
13860
|
+
# content_encoding: "ContentEncoding",
|
13861
|
+
# content_language: "ContentLanguage",
|
13862
|
+
# content_length: 1,
|
13863
|
+
# content_range: "ContentRange",
|
13864
|
+
# content_type: "ContentType",
|
13865
|
+
# delete_marker: false,
|
13866
|
+
# etag: "ETag",
|
13867
|
+
# expires: Time.now,
|
13868
|
+
# expiration: "Expiration",
|
13869
|
+
# last_modified: Time.now,
|
13870
|
+
# missing_meta: 1,
|
13871
|
+
# metadata: {
|
13872
|
+
# "MetadataKey" => "MetadataValue",
|
13873
|
+
# },
|
13874
|
+
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
13875
|
+
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
13876
|
+
# object_lock_retain_until_date: Time.now,
|
13877
|
+
# parts_count: 1,
|
13878
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
13879
|
+
# request_charged: "requester", # accepts requester
|
13880
|
+
# restore: "Restore",
|
13881
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
13882
|
+
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
13883
|
+
# ssekms_key_id: "SSEKMSKeyId",
|
13884
|
+
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
13885
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
13886
|
+
# tag_count: 1,
|
13887
|
+
# version_id: "ObjectVersionId",
|
13888
|
+
# bucket_key_enabled: false,
|
13889
|
+
# })
|
13890
|
+
#
|
13891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse AWS API Documentation
|
13892
|
+
#
|
13893
|
+
# @overload write_get_object_response(params = {})
|
13894
|
+
# @param [Hash] params ({})
|
13895
|
+
def write_get_object_response(params = {}, options = {})
|
13896
|
+
req = build_request(:write_get_object_response, params)
|
13897
|
+
req.send_request(options)
|
13898
|
+
end
|
13899
|
+
|
13624
13900
|
# @!endgroup
|
13625
13901
|
|
13626
13902
|
# @param params ({})
|
@@ -13634,7 +13910,7 @@ module Aws::S3
|
|
13634
13910
|
params: params,
|
13635
13911
|
config: config)
|
13636
13912
|
context[:gem_name] = 'aws-sdk-s3'
|
13637
|
-
context[:gem_version] = '1.
|
13913
|
+
context[:gem_version] = '1.94.1'
|
13638
13914
|
Seahorse::Client::Request.new(handlers, context)
|
13639
13915
|
end
|
13640
13916
|
|