aws-sdk-s3 1.90.0 → 1.94.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +29 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-s3.rb +2 -2
- 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 +7 -7
- data/lib/aws-sdk-s3/bucket_acl.rb +2 -2
- data/lib/aws-sdk-s3/bucket_cors.rb +5 -5
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +3 -3
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +3 -3
- data/lib/aws-sdk-s3/bucket_logging.rb +2 -2
- data/lib/aws-sdk-s3/bucket_notification.rb +2 -2
- data/lib/aws-sdk-s3/bucket_policy.rb +3 -3
- data/lib/aws-sdk-s3/bucket_request_payment.rb +2 -2
- data/lib/aws-sdk-s3/bucket_tagging.rb +3 -3
- data/lib/aws-sdk-s3/bucket_versioning.rb +4 -4
- data/lib/aws-sdk-s3/bucket_website.rb +3 -3
- data/lib/aws-sdk-s3/client.rb +699 -421
- data/lib/aws-sdk-s3/client_api.rb +60 -1
- data/lib/aws-sdk-s3/customizations/object.rb +30 -11
- data/lib/aws-sdk-s3/errors.rb +1 -1
- data/lib/aws-sdk-s3/event_streams.rb +1 -1
- data/lib/aws-sdk-s3/file_uploader.rb +2 -2
- data/lib/aws-sdk-s3/multipart_upload.rb +4 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +5 -5
- data/lib/aws-sdk-s3/object.rb +97 -11
- data/lib/aws-sdk-s3/object_acl.rb +2 -2
- data/lib/aws-sdk-s3/object_summary.rb +10 -10
- data/lib/aws-sdk-s3/object_version.rb +5 -5
- 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/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +577 -244
- data/lib/aws-sdk-s3/waiters.rb +1 -1
- metadata +7 -6
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -198,7 +198,7 @@ module Aws::S3
|
|
|
198
198
|
# @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
|
|
199
199
|
# Container for Payer.
|
|
200
200
|
# @option options [String] :expected_bucket_owner
|
|
201
|
-
# The account
|
|
201
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
202
202
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
203
203
|
# Denied)` error.
|
|
204
204
|
# @return [EmptyStructure]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
|
181
181
|
# })
|
|
182
182
|
# @param [Hash] options ({})
|
|
183
183
|
# @option options [String] :expected_bucket_owner
|
|
184
|
-
# The account
|
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
186
186
|
# Denied)` error.
|
|
187
187
|
# @return [EmptyStructure]
|
|
@@ -220,7 +220,7 @@ module Aws::S3
|
|
|
220
220
|
# @option options [required, Types::Tagging] :tagging
|
|
221
221
|
# Container for the `TagSet` and `Tag` elements.
|
|
222
222
|
# @option options [String] :expected_bucket_owner
|
|
223
|
-
# The account
|
|
223
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
224
224
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
225
225
|
# Denied)` error.
|
|
226
226
|
# @return [EmptyStructure]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -207,7 +207,7 @@ module Aws::S3
|
|
|
207
207
|
# The concatenation of the authentication device's serial number, a
|
|
208
208
|
# space, and the value that is displayed on your authentication device.
|
|
209
209
|
# @option options [String] :expected_bucket_owner
|
|
210
|
-
# The account
|
|
210
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
211
211
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
212
212
|
# Denied)` error.
|
|
213
213
|
# @return [EmptyStructure]
|
|
@@ -252,7 +252,7 @@ module Aws::S3
|
|
|
252
252
|
# @option options [required, Types::VersioningConfiguration] :versioning_configuration
|
|
253
253
|
# Container for setting the versioning state.
|
|
254
254
|
# @option options [String] :expected_bucket_owner
|
|
255
|
-
# The account
|
|
255
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
256
256
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
257
257
|
# Denied)` error.
|
|
258
258
|
# @return [EmptyStructure]
|
|
@@ -286,7 +286,7 @@ module Aws::S3
|
|
|
286
286
|
# The concatenation of the authentication device's serial number, a
|
|
287
287
|
# space, and the value that is displayed on your authentication device.
|
|
288
288
|
# @option options [String] :expected_bucket_owner
|
|
289
|
-
# The account
|
|
289
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
290
290
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
291
291
|
# Denied)` error.
|
|
292
292
|
# @return [EmptyStructure]
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -203,7 +203,7 @@ module Aws::S3
|
|
|
203
203
|
# })
|
|
204
204
|
# @param [Hash] options ({})
|
|
205
205
|
# @option options [String] :expected_bucket_owner
|
|
206
|
-
# The account
|
|
206
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
207
207
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
208
208
|
# Denied)` error.
|
|
209
209
|
# @return [EmptyStructure]
|
|
@@ -261,7 +261,7 @@ module Aws::S3
|
|
|
261
261
|
# @option options [required, Types::WebsiteConfiguration] :website_configuration
|
|
262
262
|
# Container for the request.
|
|
263
263
|
# @option options [String] :expected_bucket_owner
|
|
264
|
-
# The account
|
|
264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
265
265
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
266
266
|
# Denied)` error.
|
|
267
267
|
# @return [EmptyStructure]
|
data/lib/aws-sdk-s3/client.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -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
|
#
|
|
@@ -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
|
#
|
|
@@ -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
|
#
|
|
@@ -3570,6 +3572,7 @@ module Aws::S3
|
|
|
3570
3572
|
# @example Response structure
|
|
3571
3573
|
#
|
|
3572
3574
|
# resp.cors_rules #=> Array
|
|
3575
|
+
# resp.cors_rules[0].id #=> String
|
|
3573
3576
|
# resp.cors_rules[0].allowed_headers #=> Array
|
|
3574
3577
|
# resp.cors_rules[0].allowed_headers[0] #=> String
|
|
3575
3578
|
# resp.cors_rules[0].allowed_methods #=> Array
|
|
@@ -3613,8 +3616,8 @@ module Aws::S3
|
|
|
3613
3616
|
#
|
|
3614
3617
|
#
|
|
3615
3618
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
|
3616
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
3617
|
-
# [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
|
|
3618
3621
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
|
3619
3622
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
|
3620
3623
|
#
|
|
@@ -3623,7 +3626,7 @@ module Aws::S3
|
|
|
3623
3626
|
# configuration is retrieved.
|
|
3624
3627
|
#
|
|
3625
3628
|
# @option params [String] :expected_bucket_owner
|
|
3626
|
-
# The account
|
|
3629
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
3627
3630
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
3628
3631
|
# Denied)` error.
|
|
3629
3632
|
#
|
|
@@ -3757,8 +3760,8 @@ module Aws::S3
|
|
|
3757
3760
|
#
|
|
3758
3761
|
#
|
|
3759
3762
|
#
|
|
3760
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
3761
|
-
# [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
|
|
3762
3765
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
|
3763
3766
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
|
3764
3767
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
|
@@ -3772,7 +3775,7 @@ module Aws::S3
|
|
|
3772
3775
|
# The ID used to identify the inventory configuration.
|
|
3773
3776
|
#
|
|
3774
3777
|
# @option params [String] :expected_bucket_owner
|
|
3775
|
-
# The account
|
|
3778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
3776
3779
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
3777
3780
|
# Denied)` error.
|
|
3778
3781
|
#
|
|
@@ -3851,8 +3854,8 @@ module Aws::S3
|
|
|
3851
3854
|
#
|
|
3852
3855
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
|
3853
3856
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
|
3854
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
3855
|
-
# [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
|
|
3856
3859
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
|
3857
3860
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
|
3858
3861
|
#
|
|
@@ -3860,7 +3863,7 @@ module Aws::S3
|
|
|
3860
3863
|
# The name of the bucket for which to get the lifecycle information.
|
|
3861
3864
|
#
|
|
3862
3865
|
# @option params [String] :expected_bucket_owner
|
|
3863
|
-
# The account
|
|
3866
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
3864
3867
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
3865
3868
|
# Denied)` error.
|
|
3866
3869
|
#
|
|
@@ -3969,8 +3972,8 @@ module Aws::S3
|
|
|
3969
3972
|
#
|
|
3970
3973
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
|
3971
3974
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
|
3972
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
3973
|
-
# [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
|
|
3974
3977
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
|
3975
3978
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
|
3976
3979
|
#
|
|
@@ -3978,7 +3981,7 @@ module Aws::S3
|
|
|
3978
3981
|
# The name of the bucket for which to get the lifecycle information.
|
|
3979
3982
|
#
|
|
3980
3983
|
# @option params [String] :expected_bucket_owner
|
|
3981
|
-
# The account
|
|
3984
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
3982
3985
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
3983
3986
|
# Denied)` error.
|
|
3984
3987
|
#
|
|
@@ -4076,7 +4079,7 @@ module Aws::S3
|
|
|
4076
4079
|
# The name of the bucket for which to get the location.
|
|
4077
4080
|
#
|
|
4078
4081
|
# @option params [String] :expected_bucket_owner
|
|
4079
|
-
# The account
|
|
4082
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4080
4083
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4081
4084
|
# Denied)` error.
|
|
4082
4085
|
#
|
|
@@ -4137,7 +4140,7 @@ module Aws::S3
|
|
|
4137
4140
|
# The bucket name for which to get the logging information.
|
|
4138
4141
|
#
|
|
4139
4142
|
# @option params [String] :expected_bucket_owner
|
|
4140
|
-
# The account
|
|
4143
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4141
4144
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4142
4145
|
# Denied)` error.
|
|
4143
4146
|
#
|
|
@@ -4200,8 +4203,8 @@ module Aws::S3
|
|
|
4200
4203
|
#
|
|
4201
4204
|
#
|
|
4202
4205
|
#
|
|
4203
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
4204
|
-
# [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
|
|
4205
4208
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
|
4206
4209
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
|
4207
4210
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
|
@@ -4215,7 +4218,7 @@ module Aws::S3
|
|
|
4215
4218
|
# The ID used to identify the metrics configuration.
|
|
4216
4219
|
#
|
|
4217
4220
|
# @option params [String] :expected_bucket_owner
|
|
4218
|
-
# The account
|
|
4221
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4219
4222
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4220
4223
|
# Denied)` error.
|
|
4221
4224
|
#
|
|
@@ -4262,7 +4265,7 @@ module Aws::S3
|
|
|
4262
4265
|
# configuration.
|
|
4263
4266
|
#
|
|
4264
4267
|
# @option params [String] :expected_bucket_owner
|
|
4265
|
-
# The account
|
|
4268
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4266
4269
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4267
4270
|
# Denied)` error.
|
|
4268
4271
|
#
|
|
@@ -4396,7 +4399,7 @@ module Aws::S3
|
|
|
4396
4399
|
# configuration.
|
|
4397
4400
|
#
|
|
4398
4401
|
# @option params [String] :expected_bucket_owner
|
|
4399
|
-
# The account
|
|
4402
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4400
4403
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4401
4404
|
# Denied)` error.
|
|
4402
4405
|
#
|
|
@@ -4473,7 +4476,7 @@ module Aws::S3
|
|
|
4473
4476
|
# retrieve.
|
|
4474
4477
|
#
|
|
4475
4478
|
# @option params [String] :expected_bucket_owner
|
|
4476
|
-
# The account
|
|
4479
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4477
4480
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4478
4481
|
# Denied)` error.
|
|
4479
4482
|
#
|
|
@@ -4535,7 +4538,7 @@ module Aws::S3
|
|
|
4535
4538
|
# The bucket name for which to get the bucket policy.
|
|
4536
4539
|
#
|
|
4537
4540
|
# @option params [String] :expected_bucket_owner
|
|
4538
|
-
# The account
|
|
4541
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4539
4542
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4540
4543
|
# Denied)` error.
|
|
4541
4544
|
#
|
|
@@ -4610,7 +4613,7 @@ module Aws::S3
|
|
|
4610
4613
|
# retrieve.
|
|
4611
4614
|
#
|
|
4612
4615
|
# @option params [String] :expected_bucket_owner
|
|
4613
|
-
# The account
|
|
4616
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4614
4617
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4615
4618
|
# Denied)` error.
|
|
4616
4619
|
#
|
|
@@ -4647,7 +4650,7 @@ module Aws::S3
|
|
|
4647
4650
|
# </note>
|
|
4648
4651
|
#
|
|
4649
4652
|
# For information about replication configuration, see [Replication][1]
|
|
4650
|
-
# in the *Amazon
|
|
4653
|
+
# in the *Amazon S3 User Guide*.
|
|
4651
4654
|
#
|
|
4652
4655
|
# This action requires permissions for the
|
|
4653
4656
|
# `s3:GetReplicationConfiguration` action. For more information about
|
|
@@ -4678,7 +4681,7 @@ module Aws::S3
|
|
|
4678
4681
|
# The bucket name for which to get the replication information.
|
|
4679
4682
|
#
|
|
4680
4683
|
# @option params [String] :expected_bucket_owner
|
|
4681
|
-
# The account
|
|
4684
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4682
4685
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4683
4686
|
# Denied)` error.
|
|
4684
4687
|
#
|
|
@@ -4777,7 +4780,7 @@ module Aws::S3
|
|
|
4777
4780
|
# configuration
|
|
4778
4781
|
#
|
|
4779
4782
|
# @option params [String] :expected_bucket_owner
|
|
4780
|
-
# The account
|
|
4783
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4781
4784
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4782
4785
|
# Denied)` error.
|
|
4783
4786
|
#
|
|
@@ -4848,7 +4851,7 @@ module Aws::S3
|
|
|
4848
4851
|
# The name of the bucket for which to get the tagging information.
|
|
4849
4852
|
#
|
|
4850
4853
|
# @option params [String] :expected_bucket_owner
|
|
4851
|
-
# The account
|
|
4854
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4852
4855
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4853
4856
|
# Denied)` error.
|
|
4854
4857
|
#
|
|
@@ -4929,7 +4932,7 @@ module Aws::S3
|
|
|
4929
4932
|
# The name of the bucket for which to get the versioning information.
|
|
4930
4933
|
#
|
|
4931
4934
|
# @option params [String] :expected_bucket_owner
|
|
4932
|
-
# The account
|
|
4935
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
4933
4936
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
4934
4937
|
# Denied)` error.
|
|
4935
4938
|
#
|
|
@@ -5001,7 +5004,7 @@ module Aws::S3
|
|
|
5001
5004
|
# The bucket name for which to get the website configuration.
|
|
5002
5005
|
#
|
|
5003
5006
|
# @option params [String] :expected_bucket_owner
|
|
5004
|
-
# The account
|
|
5007
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5005
5008
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5006
5009
|
# Denied)` error.
|
|
5007
5010
|
#
|
|
@@ -5229,7 +5232,7 @@ module Aws::S3
|
|
|
5229
5232
|
# When using this action with an access point through the AWS SDKs, you
|
|
5230
5233
|
# provide the access point ARN in place of the bucket name. For more
|
|
5231
5234
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5232
|
-
# the *Amazon
|
|
5235
|
+
# the *Amazon S3 User Guide*.
|
|
5233
5236
|
#
|
|
5234
5237
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
5235
5238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -5238,12 +5241,12 @@ module Aws::S3
|
|
|
5238
5241
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
5239
5242
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
5240
5243
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
5241
|
-
# in the *Amazon
|
|
5244
|
+
# in the *Amazon S3 User Guide*.
|
|
5242
5245
|
#
|
|
5243
5246
|
#
|
|
5244
5247
|
#
|
|
5245
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5246
|
-
# [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
|
|
5247
5250
|
#
|
|
5248
5251
|
# @option params [String] :if_match
|
|
5249
5252
|
# Return the object only if its entity tag (ETag) is the same as the one
|
|
@@ -5333,7 +5336,7 @@ module Aws::S3
|
|
|
5333
5336
|
# object.
|
|
5334
5337
|
#
|
|
5335
5338
|
# @option params [String] :expected_bucket_owner
|
|
5336
|
-
# The account
|
|
5339
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5337
5340
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5338
5341
|
# Denied)` error.
|
|
5339
5342
|
#
|
|
@@ -5555,11 +5558,11 @@ module Aws::S3
|
|
|
5555
5558
|
# When using this action with an access point through the AWS SDKs, you
|
|
5556
5559
|
# provide the access point ARN in place of the bucket name. For more
|
|
5557
5560
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5558
|
-
# the *Amazon
|
|
5561
|
+
# the *Amazon S3 User Guide*.
|
|
5559
5562
|
#
|
|
5560
5563
|
#
|
|
5561
5564
|
#
|
|
5562
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5565
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
5563
5566
|
#
|
|
5564
5567
|
# @option params [required, String] :key
|
|
5565
5568
|
# The key of the object for which to get the ACL information.
|
|
@@ -5579,7 +5582,7 @@ module Aws::S3
|
|
|
5579
5582
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
5580
5583
|
#
|
|
5581
5584
|
# @option params [String] :expected_bucket_owner
|
|
5582
|
-
# The account
|
|
5585
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5583
5586
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5584
5587
|
# Denied)` error.
|
|
5585
5588
|
#
|
|
@@ -5692,11 +5695,11 @@ module Aws::S3
|
|
|
5692
5695
|
# When using this action with an access point through the AWS SDKs, you
|
|
5693
5696
|
# provide the access point ARN in place of the bucket name. For more
|
|
5694
5697
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5695
|
-
# the *Amazon
|
|
5698
|
+
# the *Amazon S3 User Guide*.
|
|
5696
5699
|
#
|
|
5697
5700
|
#
|
|
5698
5701
|
#
|
|
5699
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5702
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
5700
5703
|
#
|
|
5701
5704
|
# @option params [required, String] :key
|
|
5702
5705
|
# The key name for the object whose Legal Hold status you want to
|
|
@@ -5718,7 +5721,7 @@ module Aws::S3
|
|
|
5718
5721
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
5719
5722
|
#
|
|
5720
5723
|
# @option params [String] :expected_bucket_owner
|
|
5721
|
-
# The account
|
|
5724
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5722
5725
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5723
5726
|
# Denied)` error.
|
|
5724
5727
|
#
|
|
@@ -5767,14 +5770,14 @@ module Aws::S3
|
|
|
5767
5770
|
# When using this action with an access point through the AWS SDKs, you
|
|
5768
5771
|
# provide the access point ARN in place of the bucket name. For more
|
|
5769
5772
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5770
|
-
# the *Amazon
|
|
5773
|
+
# the *Amazon S3 User Guide*.
|
|
5771
5774
|
#
|
|
5772
5775
|
#
|
|
5773
5776
|
#
|
|
5774
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5777
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
5775
5778
|
#
|
|
5776
5779
|
# @option params [String] :expected_bucket_owner
|
|
5777
|
-
# The account
|
|
5780
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5778
5781
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5779
5782
|
# Denied)` error.
|
|
5780
5783
|
#
|
|
@@ -5824,11 +5827,11 @@ module Aws::S3
|
|
|
5824
5827
|
# When using this action with an access point through the AWS SDKs, you
|
|
5825
5828
|
# provide the access point ARN in place of the bucket name. For more
|
|
5826
5829
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5827
|
-
# the *Amazon
|
|
5830
|
+
# the *Amazon S3 User Guide*.
|
|
5828
5831
|
#
|
|
5829
5832
|
#
|
|
5830
5833
|
#
|
|
5831
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5834
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
5832
5835
|
#
|
|
5833
5836
|
# @option params [required, String] :key
|
|
5834
5837
|
# The key name for the object whose retention settings you want to
|
|
@@ -5850,7 +5853,7 @@ module Aws::S3
|
|
|
5850
5853
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
5851
5854
|
#
|
|
5852
5855
|
# @option params [String] :expected_bucket_owner
|
|
5853
|
-
# The account
|
|
5856
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5854
5857
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5855
5858
|
# Denied)` error.
|
|
5856
5859
|
#
|
|
@@ -5920,7 +5923,7 @@ module Aws::S3
|
|
|
5920
5923
|
# When using this action with an access point through the AWS SDKs, you
|
|
5921
5924
|
# provide the access point ARN in place of the bucket name. For more
|
|
5922
5925
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
5923
|
-
# the *Amazon
|
|
5926
|
+
# the *Amazon S3 User Guide*.
|
|
5924
5927
|
#
|
|
5925
5928
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
5926
5929
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -5929,12 +5932,12 @@ module Aws::S3
|
|
|
5929
5932
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
5930
5933
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
5931
5934
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
5932
|
-
# in the *Amazon
|
|
5935
|
+
# in the *Amazon S3 User Guide*.
|
|
5933
5936
|
#
|
|
5934
5937
|
#
|
|
5935
5938
|
#
|
|
5936
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
5937
|
-
# [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
|
|
5938
5941
|
#
|
|
5939
5942
|
# @option params [required, String] :key
|
|
5940
5943
|
# Object key for which to get the tagging information.
|
|
@@ -5943,7 +5946,7 @@ module Aws::S3
|
|
|
5943
5946
|
# The versionId of the object for which to get the tagging information.
|
|
5944
5947
|
#
|
|
5945
5948
|
# @option params [String] :expected_bucket_owner
|
|
5946
|
-
# The account
|
|
5949
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
5947
5950
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
5948
5951
|
# Denied)` error.
|
|
5949
5952
|
#
|
|
@@ -5964,49 +5967,49 @@ module Aws::S3
|
|
|
5964
5967
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
|
5965
5968
|
#
|
|
5966
5969
|
#
|
|
5967
|
-
# @example Example: To retrieve tag set of
|
|
5970
|
+
# @example Example: To retrieve tag set of a specific object version
|
|
5968
5971
|
#
|
|
5969
|
-
# # The following example retrieves tag set of an object.
|
|
5972
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
|
5970
5973
|
#
|
|
5971
5974
|
# resp = client.get_object_tagging({
|
|
5972
5975
|
# bucket: "examplebucket",
|
|
5973
|
-
# key: "
|
|
5976
|
+
# key: "exampleobject",
|
|
5977
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
|
5974
5978
|
# })
|
|
5975
5979
|
#
|
|
5976
5980
|
# resp.to_h outputs the following:
|
|
5977
5981
|
# {
|
|
5978
5982
|
# tag_set: [
|
|
5979
5983
|
# {
|
|
5980
|
-
# key: "
|
|
5981
|
-
# value: "
|
|
5982
|
-
# },
|
|
5983
|
-
# {
|
|
5984
|
-
# key: "Key3",
|
|
5985
|
-
# value: "Value3",
|
|
5984
|
+
# key: "Key1",
|
|
5985
|
+
# value: "Value1",
|
|
5986
5986
|
# },
|
|
5987
5987
|
# ],
|
|
5988
|
-
# version_id: "
|
|
5988
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
|
5989
5989
|
# }
|
|
5990
5990
|
#
|
|
5991
|
-
# @example Example: To retrieve tag set of
|
|
5991
|
+
# @example Example: To retrieve tag set of an object
|
|
5992
5992
|
#
|
|
5993
|
-
# # The following example retrieves tag set of an object.
|
|
5993
|
+
# # The following example retrieves tag set of an object.
|
|
5994
5994
|
#
|
|
5995
5995
|
# resp = client.get_object_tagging({
|
|
5996
5996
|
# bucket: "examplebucket",
|
|
5997
|
-
# key: "
|
|
5998
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
|
5997
|
+
# key: "HappyFace.jpg",
|
|
5999
5998
|
# })
|
|
6000
5999
|
#
|
|
6001
6000
|
# resp.to_h outputs the following:
|
|
6002
6001
|
# {
|
|
6003
6002
|
# tag_set: [
|
|
6004
6003
|
# {
|
|
6005
|
-
# key: "
|
|
6006
|
-
# value: "
|
|
6004
|
+
# key: "Key4",
|
|
6005
|
+
# value: "Value4",
|
|
6006
|
+
# },
|
|
6007
|
+
# {
|
|
6008
|
+
# key: "Key3",
|
|
6009
|
+
# value: "Value3",
|
|
6007
6010
|
# },
|
|
6008
6011
|
# ],
|
|
6009
|
-
# version_id: "
|
|
6012
|
+
# version_id: "null",
|
|
6010
6013
|
# }
|
|
6011
6014
|
#
|
|
6012
6015
|
# @example Request syntax with placeholder values
|
|
@@ -6082,7 +6085,7 @@ module Aws::S3
|
|
|
6082
6085
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
6083
6086
|
#
|
|
6084
6087
|
# @option params [String] :expected_bucket_owner
|
|
6085
|
-
# The account
|
|
6088
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6086
6089
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6087
6090
|
# Denied)` error.
|
|
6088
6091
|
#
|
|
@@ -6168,7 +6171,7 @@ module Aws::S3
|
|
|
6168
6171
|
# configuration you want to retrieve.
|
|
6169
6172
|
#
|
|
6170
6173
|
# @option params [String] :expected_bucket_owner
|
|
6171
|
-
# The account
|
|
6174
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6172
6175
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6173
6176
|
# Denied)` error.
|
|
6174
6177
|
#
|
|
@@ -6217,8 +6220,8 @@ module Aws::S3
|
|
|
6217
6220
|
#
|
|
6218
6221
|
#
|
|
6219
6222
|
#
|
|
6220
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6221
|
-
# [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
|
|
6222
6225
|
#
|
|
6223
6226
|
# @option params [required, String] :bucket
|
|
6224
6227
|
# The bucket name.
|
|
@@ -6229,7 +6232,7 @@ module Aws::S3
|
|
|
6229
6232
|
# When using this action with an access point through the AWS SDKs, you
|
|
6230
6233
|
# provide the access point ARN in place of the bucket name. For more
|
|
6231
6234
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
6232
|
-
# the *Amazon
|
|
6235
|
+
# the *Amazon S3 User Guide*.
|
|
6233
6236
|
#
|
|
6234
6237
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
6235
6238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -6238,15 +6241,15 @@ module Aws::S3
|
|
|
6238
6241
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
6239
6242
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
6240
6243
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
6241
|
-
# in the *Amazon
|
|
6244
|
+
# in the *Amazon S3 User Guide*.
|
|
6242
6245
|
#
|
|
6243
6246
|
#
|
|
6244
6247
|
#
|
|
6245
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6246
|
-
# [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
|
|
6247
6250
|
#
|
|
6248
6251
|
# @option params [String] :expected_bucket_owner
|
|
6249
|
-
# The account
|
|
6252
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6250
6253
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6251
6254
|
# Denied)` error.
|
|
6252
6255
|
#
|
|
@@ -6382,7 +6385,7 @@ module Aws::S3
|
|
|
6382
6385
|
# When using this action with an access point through the AWS SDKs, you
|
|
6383
6386
|
# provide the access point ARN in place of the bucket name. For more
|
|
6384
6387
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
6385
|
-
# the *Amazon
|
|
6388
|
+
# the *Amazon S3 User Guide*.
|
|
6386
6389
|
#
|
|
6387
6390
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
6388
6391
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -6391,12 +6394,12 @@ module Aws::S3
|
|
|
6391
6394
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
6392
6395
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
6393
6396
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
6394
|
-
# in the *Amazon
|
|
6397
|
+
# in the *Amazon S3 User Guide*.
|
|
6395
6398
|
#
|
|
6396
6399
|
#
|
|
6397
6400
|
#
|
|
6398
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6399
|
-
# [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
|
|
6400
6403
|
#
|
|
6401
6404
|
# @option params [String] :if_match
|
|
6402
6405
|
# Return the object only if its entity tag (ETag) is the same as the one
|
|
@@ -6468,7 +6471,7 @@ module Aws::S3
|
|
|
6468
6471
|
# the number of parts in this object.
|
|
6469
6472
|
#
|
|
6470
6473
|
# @option params [String] :expected_bucket_owner
|
|
6471
|
-
# The account
|
|
6474
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6472
6475
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6473
6476
|
# Denied)` error.
|
|
6474
6477
|
#
|
|
@@ -6630,8 +6633,8 @@ module Aws::S3
|
|
|
6630
6633
|
#
|
|
6631
6634
|
#
|
|
6632
6635
|
#
|
|
6633
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6634
|
-
# [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
|
|
6635
6638
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
|
6636
6639
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
|
6637
6640
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
|
@@ -6646,7 +6649,7 @@ module Aws::S3
|
|
|
6646
6649
|
# request should begin.
|
|
6647
6650
|
#
|
|
6648
6651
|
# @option params [String] :expected_bucket_owner
|
|
6649
|
-
# The account
|
|
6652
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6650
6653
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6651
6654
|
# Denied)` error.
|
|
6652
6655
|
#
|
|
@@ -6814,8 +6817,8 @@ module Aws::S3
|
|
|
6814
6817
|
#
|
|
6815
6818
|
#
|
|
6816
6819
|
#
|
|
6817
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6818
|
-
# [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
|
|
6819
6822
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
|
6820
6823
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
|
6821
6824
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
|
@@ -6832,7 +6835,7 @@ module Aws::S3
|
|
|
6832
6835
|
# token is an opaque value that Amazon S3 understands.
|
|
6833
6836
|
#
|
|
6834
6837
|
# @option params [String] :expected_bucket_owner
|
|
6835
|
-
# The account
|
|
6838
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6836
6839
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6837
6840
|
# Denied)` error.
|
|
6838
6841
|
#
|
|
@@ -6914,8 +6917,8 @@ module Aws::S3
|
|
|
6914
6917
|
#
|
|
6915
6918
|
#
|
|
6916
6919
|
#
|
|
6917
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
6918
|
-
# [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
|
|
6919
6922
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
|
6920
6923
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
|
6921
6924
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
|
@@ -6932,7 +6935,7 @@ module Aws::S3
|
|
|
6932
6935
|
# continuation token is an opaque value that Amazon S3 understands.
|
|
6933
6936
|
#
|
|
6934
6937
|
# @option params [String] :expected_bucket_owner
|
|
6935
|
-
# The account
|
|
6938
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
6936
6939
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
6937
6940
|
# Denied)` error.
|
|
6938
6941
|
#
|
|
@@ -7089,7 +7092,7 @@ module Aws::S3
|
|
|
7089
7092
|
# When using this action with an access point through the AWS SDKs, you
|
|
7090
7093
|
# provide the access point ARN in place of the bucket name. For more
|
|
7091
7094
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
7092
|
-
# the *Amazon
|
|
7095
|
+
# the *Amazon S3 User Guide*.
|
|
7093
7096
|
#
|
|
7094
7097
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
7095
7098
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -7098,12 +7101,12 @@ module Aws::S3
|
|
|
7098
7101
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
7099
7102
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
7100
7103
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
7101
|
-
# in the *Amazon
|
|
7104
|
+
# in the *Amazon S3 User Guide*.
|
|
7102
7105
|
#
|
|
7103
7106
|
#
|
|
7104
7107
|
#
|
|
7105
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
7106
|
-
# [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
|
|
7107
7110
|
#
|
|
7108
7111
|
# @option params [String] :delimiter
|
|
7109
7112
|
# Character you use to group keys.
|
|
@@ -7156,7 +7159,7 @@ module Aws::S3
|
|
|
7156
7159
|
# specified `upload-id-marker`.
|
|
7157
7160
|
#
|
|
7158
7161
|
# @option params [String] :expected_bucket_owner
|
|
7159
|
-
# The account
|
|
7162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
7160
7163
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
7161
7164
|
# Denied)` error.
|
|
7162
7165
|
#
|
|
@@ -7323,6 +7326,9 @@ module Aws::S3
|
|
|
7323
7326
|
# can also use request parameters as selection criteria to return
|
|
7324
7327
|
# metadata about a subset of all the object versions.
|
|
7325
7328
|
#
|
|
7329
|
+
# To use this operation, you must have permissions to perform the
|
|
7330
|
+
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
|
7331
|
+
#
|
|
7326
7332
|
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
|
7327
7333
|
# design your application to parse the contents of the response and
|
|
7328
7334
|
# handle it appropriately.
|
|
@@ -7392,7 +7398,7 @@ module Aws::S3
|
|
|
7392
7398
|
# Specifies the object version you want to start listing from.
|
|
7393
7399
|
#
|
|
7394
7400
|
# @option params [String] :expected_bucket_owner
|
|
7395
|
-
# The account
|
|
7401
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
7396
7402
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
7397
7403
|
# Denied)` error.
|
|
7398
7404
|
#
|
|
@@ -7551,7 +7557,7 @@ module Aws::S3
|
|
|
7551
7557
|
# When using this action with an access point through the AWS SDKs, you
|
|
7552
7558
|
# provide the access point ARN in place of the bucket name. For more
|
|
7553
7559
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
7554
|
-
# the *Amazon
|
|
7560
|
+
# the *Amazon S3 User Guide*.
|
|
7555
7561
|
#
|
|
7556
7562
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
7557
7563
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -7560,12 +7566,12 @@ module Aws::S3
|
|
|
7560
7566
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
7561
7567
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
7562
7568
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
7563
|
-
# in the *Amazon
|
|
7569
|
+
# in the *Amazon S3 User Guide*.
|
|
7564
7570
|
#
|
|
7565
7571
|
#
|
|
7566
7572
|
#
|
|
7567
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
7568
|
-
# [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
|
|
7569
7575
|
#
|
|
7570
7576
|
# @option params [String] :delimiter
|
|
7571
7577
|
# A delimiter is a character you use to group keys.
|
|
@@ -7595,7 +7601,7 @@ module Aws::S3
|
|
|
7595
7601
|
# parameter in their requests.
|
|
7596
7602
|
#
|
|
7597
7603
|
# @option params [String] :expected_bucket_owner
|
|
7598
|
-
# The account
|
|
7604
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
7599
7605
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
7600
7606
|
# Denied)` error.
|
|
7601
7607
|
#
|
|
@@ -7730,8 +7736,8 @@ module Aws::S3
|
|
|
7730
7736
|
#
|
|
7731
7737
|
#
|
|
7732
7738
|
#
|
|
7733
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
7734
|
-
# [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
|
|
7735
7741
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
|
7736
7742
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
|
7737
7743
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
|
@@ -7747,7 +7753,7 @@ module Aws::S3
|
|
|
7747
7753
|
# When using this action with an access point through the AWS SDKs, you
|
|
7748
7754
|
# provide the access point ARN in place of the bucket name. For more
|
|
7749
7755
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
7750
|
-
# the *Amazon
|
|
7756
|
+
# the *Amazon S3 User Guide*.
|
|
7751
7757
|
#
|
|
7752
7758
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
7753
7759
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -7756,12 +7762,12 @@ module Aws::S3
|
|
|
7756
7762
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
7757
7763
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
7758
7764
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
7759
|
-
# in the *Amazon
|
|
7765
|
+
# in the *Amazon S3 User Guide*.
|
|
7760
7766
|
#
|
|
7761
7767
|
#
|
|
7762
7768
|
#
|
|
7763
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
7764
|
-
# [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
|
|
7765
7771
|
#
|
|
7766
7772
|
# @option params [String] :delimiter
|
|
7767
7773
|
# A delimiter is a character you use to group keys.
|
|
@@ -7798,7 +7804,7 @@ module Aws::S3
|
|
|
7798
7804
|
# this parameter in their requests.
|
|
7799
7805
|
#
|
|
7800
7806
|
# @option params [String] :expected_bucket_owner
|
|
7801
|
-
# The account
|
|
7807
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
7802
7808
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
7803
7809
|
# Denied)` error.
|
|
7804
7810
|
#
|
|
@@ -7953,7 +7959,7 @@ module Aws::S3
|
|
|
7953
7959
|
# When using this action with an access point through the AWS SDKs, you
|
|
7954
7960
|
# provide the access point ARN in place of the bucket name. For more
|
|
7955
7961
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
7956
|
-
# the *Amazon
|
|
7962
|
+
# the *Amazon S3 User Guide*.
|
|
7957
7963
|
#
|
|
7958
7964
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
7959
7965
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -7962,12 +7968,12 @@ module Aws::S3
|
|
|
7962
7968
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
7963
7969
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
7964
7970
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
7965
|
-
# in the *Amazon
|
|
7971
|
+
# in the *Amazon S3 User Guide*.
|
|
7966
7972
|
#
|
|
7967
7973
|
#
|
|
7968
7974
|
#
|
|
7969
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
7970
|
-
# [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
|
|
7971
7977
|
#
|
|
7972
7978
|
# @option params [required, String] :key
|
|
7973
7979
|
# Object key for which the multipart upload was initiated.
|
|
@@ -7995,7 +8001,7 @@ module Aws::S3
|
|
|
7995
8001
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
7996
8002
|
#
|
|
7997
8003
|
# @option params [String] :expected_bucket_owner
|
|
7998
|
-
# The account
|
|
8004
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
7999
8005
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8000
8006
|
# Denied)` error.
|
|
8001
8007
|
#
|
|
@@ -8140,8 +8146,8 @@ module Aws::S3
|
|
|
8140
8146
|
#
|
|
8141
8147
|
#
|
|
8142
8148
|
#
|
|
8143
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
8144
|
-
# [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
|
|
8145
8151
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
|
8146
8152
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
|
8147
8153
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
|
@@ -8153,7 +8159,7 @@ module Aws::S3
|
|
|
8153
8159
|
# Container for setting the transfer acceleration state.
|
|
8154
8160
|
#
|
|
8155
8161
|
# @option params [String] :expected_bucket_owner
|
|
8156
|
-
# The account
|
|
8162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
8157
8163
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8158
8164
|
# Denied)` error.
|
|
8159
8165
|
#
|
|
@@ -8375,7 +8381,7 @@ module Aws::S3
|
|
|
8375
8381
|
# Allows grantee to write the ACL for the applicable bucket.
|
|
8376
8382
|
#
|
|
8377
8383
|
# @option params [String] :expected_bucket_owner
|
|
8378
|
-
# The account
|
|
8384
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
8379
8385
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8380
8386
|
# Denied)` error.
|
|
8381
8387
|
#
|
|
@@ -8497,8 +8503,8 @@ module Aws::S3
|
|
|
8497
8503
|
#
|
|
8498
8504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
|
8499
8505
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
|
8500
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
8501
|
-
# [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
|
|
8502
8508
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
|
8503
8509
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
|
8504
8510
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
|
@@ -8513,7 +8519,7 @@ module Aws::S3
|
|
|
8513
8519
|
# The configuration and any analyses for the analytics filter.
|
|
8514
8520
|
#
|
|
8515
8521
|
# @option params [String] :expected_bucket_owner
|
|
8516
|
-
# The account
|
|
8522
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
8517
8523
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8518
8524
|
# Denied)` error.
|
|
8519
8525
|
#
|
|
@@ -8604,7 +8610,7 @@ module Aws::S3
|
|
|
8604
8610
|
# element.
|
|
8605
8611
|
#
|
|
8606
8612
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
|
8607
|
-
# Sharing][1] in the *Amazon
|
|
8613
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
|
8608
8614
|
#
|
|
8609
8615
|
# **Related Resources**
|
|
8610
8616
|
#
|
|
@@ -8627,8 +8633,7 @@ module Aws::S3
|
|
|
8627
8633
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
|
8628
8634
|
# Describes the cross-origin access configuration for objects in an
|
|
8629
8635
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
|
8630
|
-
# Resource Sharing][1] in the *Amazon
|
|
8631
|
-
# Guide*.
|
|
8636
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
|
8632
8637
|
#
|
|
8633
8638
|
#
|
|
8634
8639
|
#
|
|
@@ -8647,7 +8652,7 @@ module Aws::S3
|
|
|
8647
8652
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
|
8648
8653
|
#
|
|
8649
8654
|
# @option params [String] :expected_bucket_owner
|
|
8650
|
-
# The account
|
|
8655
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
8651
8656
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8652
8657
|
# Denied)` error.
|
|
8653
8658
|
#
|
|
@@ -8704,6 +8709,7 @@ module Aws::S3
|
|
|
8704
8709
|
# cors_configuration: { # required
|
|
8705
8710
|
# cors_rules: [ # required
|
|
8706
8711
|
# {
|
|
8712
|
+
# id: "ID",
|
|
8707
8713
|
# allowed_headers: ["AllowedHeader"],
|
|
8708
8714
|
# allowed_methods: ["AllowedMethod"], # required
|
|
8709
8715
|
# allowed_origins: ["AllowedOrigin"], # required
|
|
@@ -8733,9 +8739,8 @@ module Aws::S3
|
|
|
8733
8739
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
|
8734
8740
|
# also configure Amazon S3 Bucket Key. For information about default
|
|
8735
8741
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
|
8736
|
-
# *Amazon
|
|
8737
|
-
#
|
|
8738
|
-
# 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*.
|
|
8739
8744
|
#
|
|
8740
8745
|
# This action requires AWS Signature Version 4. For more information,
|
|
8741
8746
|
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
|
@@ -8745,8 +8750,8 @@ module Aws::S3
|
|
|
8745
8750
|
# permission by default. The bucket owner can grant this permission to
|
|
8746
8751
|
# others. For more information about permissions, see [Permissions
|
|
8747
8752
|
# Related to Bucket Subresource Operations][4] and [Managing Access
|
|
8748
|
-
# Permissions to Your Amazon S3 Resources][5] in the Amazon
|
|
8749
|
-
#
|
|
8753
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
|
8754
|
+
# Guide.
|
|
8750
8755
|
#
|
|
8751
8756
|
# **Related Resources**
|
|
8752
8757
|
#
|
|
@@ -8759,8 +8764,8 @@ module Aws::S3
|
|
|
8759
8764
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
|
8760
8765
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
|
8761
8766
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
|
8762
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
8763
|
-
# [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
|
|
8764
8769
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
|
8765
8770
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
|
8766
8771
|
#
|
|
@@ -8769,7 +8774,7 @@ module Aws::S3
|
|
|
8769
8774
|
# with Amazon S3-managed keys (SSE-S3) or customer master keys stored in
|
|
8770
8775
|
# AWS KMS (SSE-KMS). For information about the Amazon S3 default
|
|
8771
8776
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
|
8772
|
-
# the *Amazon
|
|
8777
|
+
# the *Amazon S3 User Guide*.
|
|
8773
8778
|
#
|
|
8774
8779
|
#
|
|
8775
8780
|
#
|
|
@@ -8786,7 +8791,7 @@ module Aws::S3
|
|
|
8786
8791
|
# Specifies the default server-side-encryption configuration.
|
|
8787
8792
|
#
|
|
8788
8793
|
# @option params [String] :expected_bucket_owner
|
|
8789
|
-
# The account
|
|
8794
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
8790
8795
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
8791
8796
|
# Denied)` error.
|
|
8792
8797
|
#
|
|
@@ -8957,8 +8962,7 @@ module Aws::S3
|
|
|
8957
8962
|
# whether to generate the inventory daily or weekly. You can also
|
|
8958
8963
|
# configure what object metadata to include and whether to inventory all
|
|
8959
8964
|
# object versions or only current versions. For more information, see
|
|
8960
|
-
# [Amazon S3 Inventory][1] in the Amazon
|
|
8961
|
-
# Guide.
|
|
8965
|
+
# [Amazon S3 Inventory][1] in the Amazon S3 User Guide.
|
|
8962
8966
|
#
|
|
8963
8967
|
# You must create a bucket policy on the *destination* bucket to grant
|
|
8964
8968
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
|
@@ -8970,8 +8974,7 @@ module Aws::S3
|
|
|
8970
8974
|
# permission by default and can grant this permission to others. For
|
|
8971
8975
|
# more information about permissions, see [Permissions Related to Bucket
|
|
8972
8976
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
|
8973
|
-
# Amazon S3 Resources][4] in the Amazon
|
|
8974
|
-
# Guide.
|
|
8977
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
|
8975
8978
|
#
|
|
8976
8979
|
# **Special Errors**
|
|
8977
8980
|
#
|
|
@@ -9008,8 +9011,8 @@ module Aws::S3
|
|
|
9008
9011
|
#
|
|
9009
9012
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
|
9010
9013
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
|
9011
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
9012
|
-
# [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
|
|
9013
9016
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
|
9014
9017
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
|
9015
9018
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
|
@@ -9025,7 +9028,7 @@ module Aws::S3
|
|
|
9025
9028
|
# Specifies the inventory configuration.
|
|
9026
9029
|
#
|
|
9027
9030
|
# @option params [String] :expected_bucket_owner
|
|
9028
|
-
# The account
|
|
9031
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9029
9032
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9030
9033
|
# Denied)` error.
|
|
9031
9034
|
#
|
|
@@ -9082,8 +9085,8 @@ module Aws::S3
|
|
|
9082
9085
|
#
|
|
9083
9086
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
|
9084
9087
|
# existing lifecycle configuration. For information about lifecycle
|
|
9085
|
-
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
|
9086
|
-
#
|
|
9088
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon S3
|
|
9089
|
+
# User Guide*.
|
|
9087
9090
|
#
|
|
9088
9091
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
|
9089
9092
|
# related subresources (for example, lifecycle configuration and website
|
|
@@ -9105,8 +9108,8 @@ module Aws::S3
|
|
|
9105
9108
|
# * `s3:PutLifecycleConfiguration`
|
|
9106
9109
|
#
|
|
9107
9110
|
# For more information about permissions, see [Managing Access
|
|
9108
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
|
9109
|
-
#
|
|
9111
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
|
9112
|
+
# Guide*.
|
|
9110
9113
|
#
|
|
9111
9114
|
# For more examples of transitioning objects to storage classes such as
|
|
9112
9115
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
|
@@ -9124,7 +9127,7 @@ module Aws::S3
|
|
|
9124
9127
|
# the AWS account that created the bucket—can perform any of the
|
|
9125
9128
|
# operations. A resource owner can also grant others permission to
|
|
9126
9129
|
# perform the operation. For more information, see the following
|
|
9127
|
-
# topics in the Amazon
|
|
9130
|
+
# topics in the Amazon S3 User Guide:
|
|
9128
9131
|
#
|
|
9129
9132
|
# * [Specifying Permissions in a Policy][8]
|
|
9130
9133
|
#
|
|
@@ -9134,7 +9137,7 @@ module Aws::S3
|
|
|
9134
9137
|
#
|
|
9135
9138
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
|
9136
9139
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
|
9137
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
9140
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
|
9138
9141
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
|
9139
9142
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
|
9140
9143
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
|
@@ -9150,7 +9153,7 @@ module Aws::S3
|
|
|
9150
9153
|
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
|
|
9151
9154
|
#
|
|
9152
9155
|
# @option params [String] :expected_bucket_owner
|
|
9153
|
-
# The account
|
|
9156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9154
9157
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9155
9158
|
# Denied)` error.
|
|
9156
9159
|
#
|
|
@@ -9274,7 +9277,7 @@ module Aws::S3
|
|
|
9274
9277
|
#
|
|
9275
9278
|
#
|
|
9276
9279
|
#
|
|
9277
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
9280
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
|
9278
9281
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
|
9279
9282
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
|
9280
9283
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
|
@@ -9289,7 +9292,7 @@ module Aws::S3
|
|
|
9289
9292
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
|
9290
9293
|
#
|
|
9291
9294
|
# @option params [String] :expected_bucket_owner
|
|
9292
|
-
# The account
|
|
9295
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9293
9296
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9294
9297
|
# Denied)` error.
|
|
9295
9298
|
#
|
|
@@ -9470,7 +9473,7 @@ module Aws::S3
|
|
|
9470
9473
|
# SDKs, this field is calculated automatically.
|
|
9471
9474
|
#
|
|
9472
9475
|
# @option params [String] :expected_bucket_owner
|
|
9473
|
-
# The account
|
|
9476
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9474
9477
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9475
9478
|
# Denied)` error.
|
|
9476
9479
|
#
|
|
@@ -9573,8 +9576,8 @@ module Aws::S3
|
|
|
9573
9576
|
#
|
|
9574
9577
|
#
|
|
9575
9578
|
#
|
|
9576
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
9577
|
-
# [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
|
|
9578
9581
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
|
9579
9582
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
|
9580
9583
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
|
@@ -9590,7 +9593,7 @@ module Aws::S3
|
|
|
9590
9593
|
# Specifies the metrics configuration.
|
|
9591
9594
|
#
|
|
9592
9595
|
# @option params [String] :expected_bucket_owner
|
|
9593
|
-
# The account
|
|
9596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9594
9597
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9595
9598
|
# Denied)` error.
|
|
9596
9599
|
#
|
|
@@ -9652,7 +9655,7 @@ module Aws::S3
|
|
|
9652
9655
|
# The container for the configuration.
|
|
9653
9656
|
#
|
|
9654
9657
|
# @option params [String] :expected_bucket_owner
|
|
9655
|
-
# The account
|
|
9658
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9656
9659
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9657
9660
|
# Denied)` error.
|
|
9658
9661
|
#
|
|
@@ -9772,7 +9775,7 @@ module Aws::S3
|
|
|
9772
9775
|
# bucket.
|
|
9773
9776
|
#
|
|
9774
9777
|
# @option params [String] :expected_bucket_owner
|
|
9775
|
-
# The account
|
|
9778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9776
9779
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9777
9780
|
# Denied)` error.
|
|
9778
9781
|
#
|
|
@@ -9896,7 +9899,7 @@ module Aws::S3
|
|
|
9896
9899
|
# SDKs, this field is calculated automatically.
|
|
9897
9900
|
#
|
|
9898
9901
|
# @option params [String] :expected_bucket_owner
|
|
9899
|
-
# The account
|
|
9902
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9900
9903
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9901
9904
|
# Denied)` error.
|
|
9902
9905
|
#
|
|
@@ -9977,7 +9980,7 @@ module Aws::S3
|
|
|
9977
9980
|
# The bucket policy as a JSON document.
|
|
9978
9981
|
#
|
|
9979
9982
|
# @option params [String] :expected_bucket_owner
|
|
9980
|
-
# The account
|
|
9983
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
9981
9984
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
9982
9985
|
# Denied)` error.
|
|
9983
9986
|
#
|
|
@@ -10082,7 +10085,7 @@ module Aws::S3
|
|
|
10082
10085
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
|
10083
10086
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
|
10084
10087
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
|
10085
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
10088
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
|
10086
10089
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
|
10087
10090
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
|
10088
10091
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
|
@@ -10111,7 +10114,7 @@ module Aws::S3
|
|
|
10111
10114
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
|
10112
10115
|
#
|
|
10113
10116
|
# @option params [String] :expected_bucket_owner
|
|
10114
|
-
# The account
|
|
10117
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
10115
10118
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
10116
10119
|
# Denied)` error.
|
|
10117
10120
|
#
|
|
@@ -10258,7 +10261,7 @@ module Aws::S3
|
|
|
10258
10261
|
# Container for Payer.
|
|
10259
10262
|
#
|
|
10260
10263
|
# @option params [String] :expected_bucket_owner
|
|
10261
|
-
# The account
|
|
10264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
10262
10265
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
10263
10266
|
# Denied)` error.
|
|
10264
10267
|
#
|
|
@@ -10361,8 +10364,8 @@ module Aws::S3
|
|
|
10361
10364
|
#
|
|
10362
10365
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
|
10363
10366
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
|
10364
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
10365
|
-
# [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
|
|
10366
10369
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
|
10367
10370
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
|
10368
10371
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
|
@@ -10387,7 +10390,7 @@ module Aws::S3
|
|
|
10387
10390
|
# Container for the `TagSet` and `Tag` elements.
|
|
10388
10391
|
#
|
|
10389
10392
|
# @option params [String] :expected_bucket_owner
|
|
10390
|
-
# The account
|
|
10393
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
10391
10394
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
10392
10395
|
# Denied)` error.
|
|
10393
10396
|
#
|
|
@@ -10507,7 +10510,7 @@ module Aws::S3
|
|
|
10507
10510
|
# Container for setting the versioning state.
|
|
10508
10511
|
#
|
|
10509
10512
|
# @option params [String] :expected_bucket_owner
|
|
10510
|
-
# The account
|
|
10513
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
10511
10514
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
10512
10515
|
# Denied)` error.
|
|
10513
10516
|
#
|
|
@@ -10614,7 +10617,7 @@ module Aws::S3
|
|
|
10614
10617
|
# Amazon S3 has a limitation of 50 routing rules per website
|
|
10615
10618
|
# configuration. If you require more than 50 routing rules, you can use
|
|
10616
10619
|
# object redirect. For more information, see [Configuring an Object
|
|
10617
|
-
# Redirect][2] in the *Amazon
|
|
10620
|
+
# Redirect][2] in the *Amazon S3 User Guide*.
|
|
10618
10621
|
#
|
|
10619
10622
|
#
|
|
10620
10623
|
#
|
|
@@ -10640,7 +10643,7 @@ module Aws::S3
|
|
|
10640
10643
|
# Container for the request.
|
|
10641
10644
|
#
|
|
10642
10645
|
# @option params [String] :expected_bucket_owner
|
|
10643
|
-
# The account
|
|
10646
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
10644
10647
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
10645
10648
|
# Denied)` error.
|
|
10646
10649
|
#
|
|
@@ -10730,8 +10733,7 @@ module Aws::S3
|
|
|
10730
10733
|
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
|
10731
10734
|
# object with a retention period configured using Amazon S3 Object Lock.
|
|
10732
10735
|
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
|
10733
|
-
# Object Lock Overview][1] in the *Amazon
|
|
10734
|
-
# Developer Guide*.
|
|
10736
|
+
# Object Lock Overview][1] in the *Amazon S3 User Guide*.
|
|
10735
10737
|
#
|
|
10736
10738
|
# </note>
|
|
10737
10739
|
#
|
|
@@ -10746,8 +10748,8 @@ module Aws::S3
|
|
|
10746
10748
|
#
|
|
10747
10749
|
# If you request server-side encryption using AWS Key Management Service
|
|
10748
10750
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
|
10749
|
-
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon
|
|
10750
|
-
#
|
|
10751
|
+
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon S3
|
|
10752
|
+
# User Guide*.
|
|
10751
10753
|
#
|
|
10752
10754
|
# **Access Control List (ACL)-Specific Request Headers**
|
|
10753
10755
|
#
|
|
@@ -10821,7 +10823,7 @@ module Aws::S3
|
|
|
10821
10823
|
# When using this action with an access point through the AWS SDKs, you
|
|
10822
10824
|
# provide the access point ARN in place of the bucket name. For more
|
|
10823
10825
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
10824
|
-
# the *Amazon
|
|
10826
|
+
# the *Amazon S3 User Guide*.
|
|
10825
10827
|
#
|
|
10826
10828
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
10827
10829
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -10830,12 +10832,12 @@ module Aws::S3
|
|
|
10830
10832
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
10831
10833
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
10832
10834
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
10833
|
-
# in the *Amazon
|
|
10835
|
+
# in the *Amazon S3 User Guide*.
|
|
10834
10836
|
#
|
|
10835
10837
|
#
|
|
10836
10838
|
#
|
|
10837
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
10838
|
-
# [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
|
|
10839
10841
|
#
|
|
10840
10842
|
# @option params [String] :cache_control
|
|
10841
10843
|
# Can be used to specify caching behavior along the request/reply chain.
|
|
@@ -11050,7 +11052,7 @@ module Aws::S3
|
|
|
11050
11052
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
|
11051
11053
|
#
|
|
11052
11054
|
# @option params [String] :expected_bucket_owner
|
|
11053
|
-
# The account
|
|
11055
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11054
11056
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11055
11057
|
# Denied)` error.
|
|
11056
11058
|
#
|
|
@@ -11068,134 +11070,134 @@ module Aws::S3
|
|
|
11068
11070
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
|
11069
11071
|
#
|
|
11070
11072
|
#
|
|
11071
|
-
# @example Example: To upload an object
|
|
11073
|
+
# @example Example: To upload an object and specify optional tags
|
|
11072
11074
|
#
|
|
11073
|
-
# # The following example uploads an object
|
|
11074
|
-
# #
|
|
11075
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
|
11076
|
+
# # S3 returns version ID of the newly created object.
|
|
11075
11077
|
#
|
|
11076
11078
|
# resp = client.put_object({
|
|
11077
|
-
# body: "HappyFace.jpg",
|
|
11079
|
+
# body: "c:\\HappyFace.jpg",
|
|
11078
11080
|
# bucket: "examplebucket",
|
|
11079
11081
|
# key: "HappyFace.jpg",
|
|
11082
|
+
# tagging: "key1=value1&key2=value2",
|
|
11080
11083
|
# })
|
|
11081
11084
|
#
|
|
11082
11085
|
# resp.to_h outputs the following:
|
|
11083
11086
|
# {
|
|
11084
11087
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11085
|
-
# version_id: "
|
|
11088
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
|
11086
11089
|
# }
|
|
11087
11090
|
#
|
|
11088
|
-
# @example Example: To
|
|
11091
|
+
# @example Example: To create an object.
|
|
11089
11092
|
#
|
|
11090
|
-
# # The following example
|
|
11091
|
-
# # also specifies optional object tags. 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.
|
|
11092
11094
|
#
|
|
11093
11095
|
# resp = client.put_object({
|
|
11094
11096
|
# body: "filetoupload",
|
|
11095
11097
|
# bucket: "examplebucket",
|
|
11096
|
-
# key: "
|
|
11097
|
-
# server_side_encryption: "AES256",
|
|
11098
|
-
# tagging: "key1=value1&key2=value2",
|
|
11098
|
+
# key: "objectkey",
|
|
11099
11099
|
# })
|
|
11100
11100
|
#
|
|
11101
11101
|
# resp.to_h outputs the following:
|
|
11102
11102
|
# {
|
|
11103
11103
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11104
|
-
#
|
|
11105
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
|
11104
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
|
11106
11105
|
# }
|
|
11107
11106
|
#
|
|
11108
|
-
# @example Example: To upload
|
|
11107
|
+
# @example Example: To upload object and specify user-defined metadata
|
|
11109
11108
|
#
|
|
11110
|
-
# # The following example
|
|
11111
|
-
# #
|
|
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
|
-
# body: "
|
|
11113
|
+
# body: "filetoupload",
|
|
11115
11114
|
# bucket: "examplebucket",
|
|
11116
|
-
# key: "
|
|
11117
|
-
#
|
|
11118
|
-
#
|
|
11115
|
+
# key: "exampleobject",
|
|
11116
|
+
# metadata: {
|
|
11117
|
+
# "metadata1" => "value1",
|
|
11118
|
+
# "metadata2" => "value2",
|
|
11119
|
+
# },
|
|
11119
11120
|
# })
|
|
11120
11121
|
#
|
|
11121
11122
|
# resp.to_h outputs the following:
|
|
11122
11123
|
# {
|
|
11123
11124
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11124
|
-
#
|
|
11125
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
|
11125
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
|
11126
11126
|
# }
|
|
11127
11127
|
#
|
|
11128
|
-
# @example Example: To
|
|
11128
|
+
# @example Example: To upload an object
|
|
11129
11129
|
#
|
|
11130
|
-
# # The following example
|
|
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.
|
|
11131
11132
|
#
|
|
11132
11133
|
# resp = client.put_object({
|
|
11133
|
-
# body: "
|
|
11134
|
+
# body: "HappyFace.jpg",
|
|
11134
11135
|
# bucket: "examplebucket",
|
|
11135
|
-
# key: "
|
|
11136
|
+
# key: "HappyFace.jpg",
|
|
11136
11137
|
# })
|
|
11137
11138
|
#
|
|
11138
11139
|
# resp.to_h outputs the following:
|
|
11139
11140
|
# {
|
|
11140
11141
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11141
|
-
# version_id: "
|
|
11142
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
|
11142
11143
|
# }
|
|
11143
11144
|
#
|
|
11144
|
-
# @example Example: To upload an object and specify
|
|
11145
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
|
11145
11146
|
#
|
|
11146
|
-
# # The following example uploads and object. The request specifies optional
|
|
11147
|
-
# #
|
|
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.
|
|
11148
11149
|
#
|
|
11149
11150
|
# resp = client.put_object({
|
|
11150
|
-
# acl: "authenticated-read",
|
|
11151
11151
|
# body: "filetoupload",
|
|
11152
11152
|
# bucket: "examplebucket",
|
|
11153
11153
|
# key: "exampleobject",
|
|
11154
|
+
# server_side_encryption: "AES256",
|
|
11155
|
+
# tagging: "key1=value1&key2=value2",
|
|
11154
11156
|
# })
|
|
11155
11157
|
#
|
|
11156
11158
|
# resp.to_h outputs the following:
|
|
11157
11159
|
# {
|
|
11158
11160
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11159
|
-
#
|
|
11161
|
+
# server_side_encryption: "AES256",
|
|
11162
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
|
11160
11163
|
# }
|
|
11161
11164
|
#
|
|
11162
|
-
# @example Example: To upload an object and specify
|
|
11165
|
+
# @example Example: To upload an object and specify canned ACL.
|
|
11163
11166
|
#
|
|
11164
|
-
# # The following example uploads
|
|
11165
|
-
# # S3 returns version ID
|
|
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.
|
|
11166
11169
|
#
|
|
11167
11170
|
# resp = client.put_object({
|
|
11168
|
-
#
|
|
11171
|
+
# acl: "authenticated-read",
|
|
11172
|
+
# body: "filetoupload",
|
|
11169
11173
|
# bucket: "examplebucket",
|
|
11170
|
-
# key: "
|
|
11171
|
-
# tagging: "key1=value1&key2=value2",
|
|
11174
|
+
# key: "exampleobject",
|
|
11172
11175
|
# })
|
|
11173
11176
|
#
|
|
11174
11177
|
# resp.to_h outputs the following:
|
|
11175
11178
|
# {
|
|
11176
11179
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11177
|
-
# version_id: "
|
|
11180
|
+
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
|
11178
11181
|
# }
|
|
11179
11182
|
#
|
|
11180
|
-
# @example Example: To upload object
|
|
11183
|
+
# @example Example: To upload an object (specify optional headers)
|
|
11181
11184
|
#
|
|
11182
|
-
# # The following example
|
|
11183
|
-
# #
|
|
11185
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
|
11186
|
+
# # storage class and use server-side encryption.
|
|
11184
11187
|
#
|
|
11185
11188
|
# resp = client.put_object({
|
|
11186
|
-
# body: "
|
|
11189
|
+
# body: "HappyFace.jpg",
|
|
11187
11190
|
# bucket: "examplebucket",
|
|
11188
|
-
# key: "
|
|
11189
|
-
#
|
|
11190
|
-
#
|
|
11191
|
-
# "metadata2" => "value2",
|
|
11192
|
-
# },
|
|
11191
|
+
# key: "HappyFace.jpg",
|
|
11192
|
+
# server_side_encryption: "AES256",
|
|
11193
|
+
# storage_class: "STANDARD_IA",
|
|
11193
11194
|
# })
|
|
11194
11195
|
#
|
|
11195
11196
|
# resp.to_h outputs the following:
|
|
11196
11197
|
# {
|
|
11197
11198
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
|
11198
|
-
#
|
|
11199
|
+
# server_side_encryption: "AES256",
|
|
11200
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
|
11199
11201
|
# }
|
|
11200
11202
|
#
|
|
11201
11203
|
# @example Streaming a file from disk
|
|
@@ -11268,8 +11270,8 @@ module Aws::S3
|
|
|
11268
11270
|
# Uses the `acl` subresource to set the access control list (ACL)
|
|
11269
11271
|
# permissions for a new or existing object in an S3 bucket. You must
|
|
11270
11272
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
|
11271
|
-
# information, see [What permissions can I grant?][1] in the *Amazon
|
|
11272
|
-
#
|
|
11273
|
+
# information, see [What permissions can I grant?][1] in the *Amazon S3
|
|
11274
|
+
# User Guide*.
|
|
11273
11275
|
#
|
|
11274
11276
|
# This action is not supported by Amazon S3 on Outposts.
|
|
11275
11277
|
#
|
|
@@ -11439,11 +11441,11 @@ module Aws::S3
|
|
|
11439
11441
|
# When using this action with an access point through the AWS SDKs, you
|
|
11440
11442
|
# provide the access point ARN in place of the bucket name. For more
|
|
11441
11443
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
11442
|
-
# the *Amazon
|
|
11444
|
+
# the *Amazon S3 User Guide*.
|
|
11443
11445
|
#
|
|
11444
11446
|
#
|
|
11445
11447
|
#
|
|
11446
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
11448
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
11447
11449
|
#
|
|
11448
11450
|
# @option params [String] :content_md5
|
|
11449
11451
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
|
@@ -11492,7 +11494,7 @@ module Aws::S3
|
|
|
11492
11494
|
# When using this action with an access point through the AWS SDKs, you
|
|
11493
11495
|
# provide the access point ARN in place of the bucket name. For more
|
|
11494
11496
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
11495
|
-
# the *Amazon
|
|
11497
|
+
# the *Amazon S3 User Guide*.
|
|
11496
11498
|
#
|
|
11497
11499
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
11498
11500
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -11501,12 +11503,12 @@ module Aws::S3
|
|
|
11501
11503
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
11502
11504
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
11503
11505
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
11504
|
-
# in the *Amazon
|
|
11506
|
+
# in the *Amazon S3 User Guide*.
|
|
11505
11507
|
#
|
|
11506
11508
|
#
|
|
11507
11509
|
#
|
|
11508
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
11509
|
-
# [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
|
|
11510
11512
|
#
|
|
11511
11513
|
# @option params [String] :request_payer
|
|
11512
11514
|
# Confirms that the requester knows that they will be charged for the
|
|
@@ -11523,7 +11525,7 @@ module Aws::S3
|
|
|
11523
11525
|
# VersionId used to reference a specific version of the object.
|
|
11524
11526
|
#
|
|
11525
11527
|
# @option params [String] :expected_bucket_owner
|
|
11526
|
-
# The account
|
|
11528
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11527
11529
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11528
11530
|
# Denied)` error.
|
|
11529
11531
|
#
|
|
@@ -11598,16 +11600,11 @@ module Aws::S3
|
|
|
11598
11600
|
req.send_request(options)
|
|
11599
11601
|
end
|
|
11600
11602
|
|
|
11601
|
-
# 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].
|
|
11602
11605
|
#
|
|
11603
11606
|
# This action is not supported by Amazon S3 on Outposts.
|
|
11604
11607
|
#
|
|
11605
|
-
# **Related Resources**
|
|
11606
|
-
#
|
|
11607
|
-
# * [Locking Objects][1]
|
|
11608
|
-
#
|
|
11609
|
-
# ^
|
|
11610
|
-
#
|
|
11611
11608
|
#
|
|
11612
11609
|
#
|
|
11613
11610
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
|
@@ -11622,11 +11619,11 @@ module Aws::S3
|
|
|
11622
11619
|
# When using this action with an access point through the AWS SDKs, you
|
|
11623
11620
|
# provide the access point ARN in place of the bucket name. For more
|
|
11624
11621
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
11625
|
-
# the *Amazon
|
|
11622
|
+
# the *Amazon S3 User Guide*.
|
|
11626
11623
|
#
|
|
11627
11624
|
#
|
|
11628
11625
|
#
|
|
11629
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
11626
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
11630
11627
|
#
|
|
11631
11628
|
# @option params [required, String] :key
|
|
11632
11629
|
# The key name for the object that you want to place a Legal Hold on.
|
|
@@ -11656,7 +11653,7 @@ module Aws::S3
|
|
|
11656
11653
|
# SDKs, this field is calculated automatically.
|
|
11657
11654
|
#
|
|
11658
11655
|
# @option params [String] :expected_bucket_owner
|
|
11659
|
-
# The account
|
|
11656
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11660
11657
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11661
11658
|
# Denied)` error.
|
|
11662
11659
|
#
|
|
@@ -11693,18 +11690,19 @@ module Aws::S3
|
|
|
11693
11690
|
|
|
11694
11691
|
# Places an Object Lock configuration on the specified bucket. The rule
|
|
11695
11692
|
# specified in the Object Lock configuration will be applied by default
|
|
11696
|
-
# to every new object placed in the specified bucket.
|
|
11697
|
-
#
|
|
11698
|
-
# <note markdown="1"> `DefaultRetention` requires either Days or Years. You can't specify
|
|
11699
|
-
# both at the same time.
|
|
11693
|
+
# to every new object placed in the specified bucket. For more
|
|
11694
|
+
# information, see [Locking Objects][1].
|
|
11700
11695
|
#
|
|
11701
|
-
#
|
|
11696
|
+
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
|
11702
11697
|
#
|
|
11703
|
-
#
|
|
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.
|
|
11704
11701
|
#
|
|
11705
|
-
# *
|
|
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.
|
|
11706
11704
|
#
|
|
11707
|
-
#
|
|
11705
|
+
# </note>
|
|
11708
11706
|
#
|
|
11709
11707
|
#
|
|
11710
11708
|
#
|
|
@@ -11739,7 +11737,7 @@ module Aws::S3
|
|
|
11739
11737
|
# SDKs, this field is calculated automatically.
|
|
11740
11738
|
#
|
|
11741
11739
|
# @option params [String] :expected_bucket_owner
|
|
11742
|
-
# The account
|
|
11740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11743
11741
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11744
11742
|
# Denied)` error.
|
|
11745
11743
|
#
|
|
@@ -11780,16 +11778,11 @@ module Aws::S3
|
|
|
11780
11778
|
req.send_request(options)
|
|
11781
11779
|
end
|
|
11782
11780
|
|
|
11783
|
-
# 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].
|
|
11784
11783
|
#
|
|
11785
11784
|
# This action is not supported by Amazon S3 on Outposts.
|
|
11786
11785
|
#
|
|
11787
|
-
# **Related Resources**
|
|
11788
|
-
#
|
|
11789
|
-
# * [Locking Objects][1]
|
|
11790
|
-
#
|
|
11791
|
-
# ^
|
|
11792
|
-
#
|
|
11793
11786
|
#
|
|
11794
11787
|
#
|
|
11795
11788
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
|
@@ -11804,11 +11797,11 @@ module Aws::S3
|
|
|
11804
11797
|
# When using this action with an access point through the AWS SDKs, you
|
|
11805
11798
|
# provide the access point ARN in place of the bucket name. For more
|
|
11806
11799
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
11807
|
-
# the *Amazon
|
|
11800
|
+
# the *Amazon S3 User Guide*.
|
|
11808
11801
|
#
|
|
11809
11802
|
#
|
|
11810
11803
|
#
|
|
11811
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
11804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
|
11812
11805
|
#
|
|
11813
11806
|
# @option params [required, String] :key
|
|
11814
11807
|
# The key name for the object that you want to apply this Object
|
|
@@ -11843,7 +11836,7 @@ module Aws::S3
|
|
|
11843
11836
|
# SDKs, this field is calculated automatically.
|
|
11844
11837
|
#
|
|
11845
11838
|
# @option params [String] :expected_bucket_owner
|
|
11846
|
-
# The account
|
|
11839
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11847
11840
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11848
11841
|
# Denied)` error.
|
|
11849
11842
|
#
|
|
@@ -11946,7 +11939,7 @@ module Aws::S3
|
|
|
11946
11939
|
# When using this action with an access point through the AWS SDKs, you
|
|
11947
11940
|
# provide the access point ARN in place of the bucket name. For more
|
|
11948
11941
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
11949
|
-
# the *Amazon
|
|
11942
|
+
# the *Amazon S3 User Guide*.
|
|
11950
11943
|
#
|
|
11951
11944
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
11952
11945
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -11955,12 +11948,12 @@ module Aws::S3
|
|
|
11955
11948
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
11956
11949
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
11957
11950
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
11958
|
-
# in the *Amazon
|
|
11951
|
+
# in the *Amazon S3 User Guide*.
|
|
11959
11952
|
#
|
|
11960
11953
|
#
|
|
11961
11954
|
#
|
|
11962
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
11963
|
-
# [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
|
|
11964
11957
|
#
|
|
11965
11958
|
# @option params [required, String] :key
|
|
11966
11959
|
# Name of the object key.
|
|
@@ -11978,7 +11971,7 @@ module Aws::S3
|
|
|
11978
11971
|
# Container for the `TagSet` and `Tag` elements
|
|
11979
11972
|
#
|
|
11980
11973
|
# @option params [String] :expected_bucket_owner
|
|
11981
|
-
# The account
|
|
11974
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
11982
11975
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
11983
11976
|
# Denied)` error.
|
|
11984
11977
|
#
|
|
@@ -12106,14 +12099,14 @@ module Aws::S3
|
|
|
12106
12099
|
# Amazon S3 bucket. You can enable the configuration options in any
|
|
12107
12100
|
# combination. For more information about when Amazon S3 considers a
|
|
12108
12101
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
|
12109
|
-
# *Amazon
|
|
12102
|
+
# *Amazon S3 User Guide*.
|
|
12110
12103
|
#
|
|
12111
12104
|
#
|
|
12112
12105
|
#
|
|
12113
12106
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
|
12114
12107
|
#
|
|
12115
12108
|
# @option params [String] :expected_bucket_owner
|
|
12116
|
-
# The account
|
|
12109
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
12117
12110
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
12118
12111
|
# Denied)` error.
|
|
12119
12112
|
#
|
|
@@ -12157,7 +12150,7 @@ module Aws::S3
|
|
|
12157
12150
|
# default and can grant this permission to others. For more information
|
|
12158
12151
|
# about permissions, see [Permissions Related to Bucket Subresource
|
|
12159
12152
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
|
12160
|
-
# Resources][2] in the *Amazon
|
|
12153
|
+
# Resources][2] in the *Amazon S3 User Guide*.
|
|
12161
12154
|
#
|
|
12162
12155
|
# **Querying Archives with Select Requests**
|
|
12163
12156
|
#
|
|
@@ -12167,7 +12160,7 @@ module Aws::S3
|
|
|
12167
12160
|
# files. You can run queries and custom analytics on your archived data
|
|
12168
12161
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
|
12169
12162
|
# overview about select requests, see [Querying Archived Objects][3] in
|
|
12170
|
-
# the *Amazon
|
|
12163
|
+
# the *Amazon S3 User Guide*.
|
|
12171
12164
|
#
|
|
12172
12165
|
# When making a select request, do the following:
|
|
12173
12166
|
#
|
|
@@ -12177,19 +12170,18 @@ module Aws::S3
|
|
|
12177
12170
|
# that initiates the job must have permissions to write to the S3
|
|
12178
12171
|
# bucket. You can specify the storage class and encryption for the
|
|
12179
12172
|
# output objects stored in the bucket. For more information about
|
|
12180
|
-
# output, see [Querying Archived Objects][3] in the *Amazon
|
|
12181
|
-
#
|
|
12173
|
+
# output, see [Querying Archived Objects][3] in the *Amazon S3 User
|
|
12174
|
+
# Guide*.
|
|
12182
12175
|
#
|
|
12183
12176
|
# For more information about the `S3` structure in the request body,
|
|
12184
12177
|
# see the following:
|
|
12185
12178
|
#
|
|
12186
12179
|
# * [PutObject][4]
|
|
12187
12180
|
#
|
|
12188
|
-
# * [Managing Access with ACLs][5] in the *Amazon
|
|
12189
|
-
# Service User Guide*
|
|
12181
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
|
12190
12182
|
#
|
|
12191
12183
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
|
12192
|
-
#
|
|
12184
|
+
# S3 User Guide*
|
|
12193
12185
|
#
|
|
12194
12186
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
|
12195
12187
|
# your query in the request body's `SelectParameters` structure. You
|
|
@@ -12215,7 +12207,7 @@ module Aws::S3
|
|
|
12215
12207
|
#
|
|
12216
12208
|
# For more information about using SQL with S3 Glacier Select restore,
|
|
12217
12209
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
|
12218
|
-
# the *Amazon
|
|
12210
|
+
# the *Amazon S3 User Guide*.
|
|
12219
12211
|
#
|
|
12220
12212
|
# When making a select request, you can also do the following:
|
|
12221
12213
|
#
|
|
@@ -12294,20 +12286,19 @@ module Aws::S3
|
|
|
12294
12286
|
#
|
|
12295
12287
|
# For more information about archive retrieval options and provisioned
|
|
12296
12288
|
# capacity for `Expedited` data access, see [Restoring Archived
|
|
12297
|
-
# Objects][8] in the *Amazon
|
|
12289
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
|
12298
12290
|
#
|
|
12299
12291
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
|
12300
12292
|
# speed to a faster speed while it is in progress. For more information,
|
|
12301
12293
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
|
12302
|
-
#
|
|
12294
|
+
# S3 User Guide*.
|
|
12303
12295
|
#
|
|
12304
12296
|
# To get the status of object restoration, you can send a `HEAD`
|
|
12305
12297
|
# request. Operations return the `x-amz-restore` header, which provides
|
|
12306
12298
|
# information about the restoration status, in the response. You can use
|
|
12307
12299
|
# Amazon S3 event notifications to notify you when a restore is
|
|
12308
12300
|
# initiated or completed. For more information, see [Configuring Amazon
|
|
12309
|
-
# S3 Event Notifications][10] in the *Amazon
|
|
12310
|
-
# Guide*.
|
|
12301
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
|
12311
12302
|
#
|
|
12312
12303
|
# After restoring an archived object, you can update the restoration
|
|
12313
12304
|
# period by reissuing the request with a new period. Amazon S3 updates
|
|
@@ -12323,7 +12314,7 @@ module Aws::S3
|
|
|
12323
12314
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
|
12324
12315
|
# about lifecycle configuration, see
|
|
12325
12316
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
|
12326
|
-
# Management][12] in *Amazon
|
|
12317
|
+
# Management][12] in *Amazon S3 User Guide*.
|
|
12327
12318
|
#
|
|
12328
12319
|
# **Responses**
|
|
12329
12320
|
#
|
|
@@ -12365,12 +12356,12 @@ module Aws::S3
|
|
|
12365
12356
|
# * [GetBucketNotificationConfiguration][13]
|
|
12366
12357
|
#
|
|
12367
12358
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
|
12368
|
-
# the *Amazon
|
|
12359
|
+
# the *Amazon S3 User Guide*
|
|
12369
12360
|
#
|
|
12370
12361
|
#
|
|
12371
12362
|
#
|
|
12372
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
12373
|
-
# [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
|
|
12374
12365
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
|
12375
12366
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
|
12376
12367
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
|
@@ -12392,7 +12383,7 @@ module Aws::S3
|
|
|
12392
12383
|
# When using this action with an access point through the AWS SDKs, you
|
|
12393
12384
|
# provide the access point ARN in place of the bucket name. For more
|
|
12394
12385
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
12395
|
-
# the *Amazon
|
|
12386
|
+
# the *Amazon S3 User Guide*.
|
|
12396
12387
|
#
|
|
12397
12388
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
12398
12389
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -12401,12 +12392,12 @@ module Aws::S3
|
|
|
12401
12392
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
12402
12393
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
12403
12394
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
12404
|
-
# in the *Amazon
|
|
12395
|
+
# in the *Amazon S3 User Guide*.
|
|
12405
12396
|
#
|
|
12406
12397
|
#
|
|
12407
12398
|
#
|
|
12408
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
12409
|
-
# [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
|
|
12410
12401
|
#
|
|
12411
12402
|
# @option params [required, String] :key
|
|
12412
12403
|
# Object key for which the action was initiated.
|
|
@@ -12429,7 +12420,7 @@ module Aws::S3
|
|
|
12429
12420
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
12430
12421
|
#
|
|
12431
12422
|
# @option params [String] :expected_bucket_owner
|
|
12432
|
-
# The account
|
|
12423
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
12433
12424
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
12434
12425
|
# Denied)` error.
|
|
12435
12426
|
#
|
|
@@ -12574,11 +12565,11 @@ module Aws::S3
|
|
|
12574
12565
|
# This action is not supported by Amazon S3 on Outposts.
|
|
12575
12566
|
#
|
|
12576
12567
|
# For more information about Amazon S3 Select, see [Selecting Content
|
|
12577
|
-
# from Objects][1] in the *Amazon
|
|
12568
|
+
# from Objects][1] in the *Amazon S3 User Guide*.
|
|
12578
12569
|
#
|
|
12579
12570
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
|
12580
12571
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
|
12581
|
-
# *Amazon
|
|
12572
|
+
# *Amazon S3 User Guide*.
|
|
12582
12573
|
#
|
|
12583
12574
|
#
|
|
12584
12575
|
#
|
|
@@ -12587,7 +12578,7 @@ module Aws::S3
|
|
|
12587
12578
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
|
12588
12579
|
# Select does not support anonymous access. For more information about
|
|
12589
12580
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
|
12590
|
-
# *Amazon
|
|
12581
|
+
# *Amazon S3 User Guide*.
|
|
12591
12582
|
#
|
|
12592
12583
|
#
|
|
12593
12584
|
#
|
|
@@ -12615,8 +12606,7 @@ module Aws::S3
|
|
|
12615
12606
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
|
12616
12607
|
# are documented in the [GetObject][4]. For more information about
|
|
12617
12608
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
|
12618
|
-
# Encryption Keys)][5] in the *Amazon
|
|
12619
|
-
# Guide*.
|
|
12609
|
+
# Encryption Keys)][5] in the *Amazon S3 User Guide*.
|
|
12620
12610
|
#
|
|
12621
12611
|
# For objects that are encrypted with Amazon S3 managed encryption
|
|
12622
12612
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
|
@@ -12624,7 +12614,7 @@ module Aws::S3
|
|
|
12624
12614
|
# transparently, so you don't need to specify anything. For more
|
|
12625
12615
|
# information about server-side encryption, including SSE-S3 and
|
|
12626
12616
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
|
12627
|
-
# the *Amazon
|
|
12617
|
+
# the *Amazon S3 User Guide*.
|
|
12628
12618
|
#
|
|
12629
12619
|
# **Working with the Response Body**
|
|
12630
12620
|
#
|
|
@@ -12648,8 +12638,7 @@ module Aws::S3
|
|
|
12648
12638
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
|
12649
12639
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
|
12650
12640
|
# storage classes. For more information, about storage classes see
|
|
12651
|
-
# [Storage Classes][9] in the *Amazon
|
|
12652
|
-
# Guide*.
|
|
12641
|
+
# [Storage Classes][9] in the *Amazon S3 User Guide*.
|
|
12653
12642
|
#
|
|
12654
12643
|
#
|
|
12655
12644
|
#
|
|
@@ -12748,7 +12737,7 @@ module Aws::S3
|
|
|
12748
12737
|
# within the last 50 bytes of the file.
|
|
12749
12738
|
#
|
|
12750
12739
|
# @option params [String] :expected_bucket_owner
|
|
12751
|
-
# The account
|
|
12740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
12752
12741
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
12753
12742
|
# Denied)` error.
|
|
12754
12743
|
#
|
|
@@ -13015,11 +13004,11 @@ module Aws::S3
|
|
|
13015
13004
|
# parts storage and stops charging you for the parts storage.
|
|
13016
13005
|
#
|
|
13017
13006
|
# For more information on multipart uploads, go to [Multipart Upload
|
|
13018
|
-
# Overview][4] in the <i>Amazon
|
|
13007
|
+
# Overview][4] in the <i>Amazon S3 User Guide </i>.
|
|
13019
13008
|
#
|
|
13020
13009
|
# For information on the permissions required to use the multipart
|
|
13021
13010
|
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
|
13022
|
-
#
|
|
13011
|
+
# S3 User Guide*.
|
|
13023
13012
|
#
|
|
13024
13013
|
# You can optionally request server-side encryption where Amazon S3
|
|
13025
13014
|
# encrypts your data as it writes it to disks in its data centers and
|
|
@@ -13029,8 +13018,7 @@ module Aws::S3
|
|
|
13029
13018
|
# request headers you provide in the request must match the headers you
|
|
13030
13019
|
# used in the request to initiate the upload by using
|
|
13031
13020
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
|
13032
|
-
# Server-Side Encryption][6] in the *Amazon
|
|
13033
|
-
# Guide*.
|
|
13021
|
+
# Server-Side Encryption][6] in the *Amazon S3 User Guide*.
|
|
13034
13022
|
#
|
|
13035
13023
|
# Server-side encryption is supported by the S3 Multipart Upload
|
|
13036
13024
|
# actions. Unless you are using a customer-provided encryption key, you
|
|
@@ -13099,7 +13087,7 @@ module Aws::S3
|
|
|
13099
13087
|
# When using this action with an access point through the AWS SDKs, you
|
|
13100
13088
|
# provide the access point ARN in place of the bucket name. For more
|
|
13101
13089
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
13102
|
-
# the *Amazon
|
|
13090
|
+
# the *Amazon S3 User Guide*.
|
|
13103
13091
|
#
|
|
13104
13092
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
13105
13093
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -13108,12 +13096,12 @@ module Aws::S3
|
|
|
13108
13096
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
13109
13097
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
13110
13098
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
13111
|
-
# in the *Amazon
|
|
13099
|
+
# in the *Amazon S3 User Guide*.
|
|
13112
13100
|
#
|
|
13113
13101
|
#
|
|
13114
13102
|
#
|
|
13115
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
13116
|
-
# [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
|
|
13117
13105
|
#
|
|
13118
13106
|
# @option params [Integer] :content_length
|
|
13119
13107
|
# Size of the body in bytes. This parameter is useful when the size of
|
|
@@ -13165,7 +13153,7 @@ module Aws::S3
|
|
|
13165
13153
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
13166
13154
|
#
|
|
13167
13155
|
# @option params [String] :expected_bucket_owner
|
|
13168
|
-
# The account
|
|
13156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
|
13169
13157
|
# a different account, the request will fail with an HTTP `403 (Access
|
|
13170
13158
|
# Denied)` error.
|
|
13171
13159
|
#
|
|
@@ -13241,7 +13229,7 @@ module Aws::S3
|
|
|
13241
13229
|
#
|
|
13242
13230
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
|
13243
13231
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
|
13244
|
-
# in the *Amazon
|
|
13232
|
+
# in the *Amazon S3 User Guide*.
|
|
13245
13233
|
#
|
|
13246
13234
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
|
13247
13235
|
# [UploadPart][2] action and provide data in your request.
|
|
@@ -13257,16 +13245,15 @@ module Aws::S3
|
|
|
13257
13245
|
# the following:
|
|
13258
13246
|
#
|
|
13259
13247
|
# * For conceptual information about multipart uploads, see [Uploading
|
|
13260
|
-
# Objects Using Multipart Upload][3] in the *Amazon
|
|
13261
|
-
# Service User Guide*.
|
|
13248
|
+
# Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*.
|
|
13262
13249
|
#
|
|
13263
13250
|
# * For information about permissions required to use the multipart
|
|
13264
13251
|
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
|
13265
|
-
#
|
|
13252
|
+
# S3 User Guide*.
|
|
13266
13253
|
#
|
|
13267
13254
|
# * For information about copying objects using a single atomic action
|
|
13268
13255
|
# vs. the multipart upload, see [Operations on Objects][5] in the
|
|
13269
|
-
# *Amazon
|
|
13256
|
+
# *Amazon S3 User Guide*.
|
|
13270
13257
|
#
|
|
13271
13258
|
# * For information about using server-side encryption with
|
|
13272
13259
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
|
@@ -13374,7 +13361,7 @@ module Aws::S3
|
|
|
13374
13361
|
# When using this action with an access point through the AWS SDKs, you
|
|
13375
13362
|
# provide the access point ARN in place of the bucket name. For more
|
|
13376
13363
|
# information about access point ARNs, see [Using Access Points][1] in
|
|
13377
|
-
# the *Amazon
|
|
13364
|
+
# the *Amazon S3 User Guide*.
|
|
13378
13365
|
#
|
|
13379
13366
|
# When using this action with Amazon S3 on Outposts, you must direct
|
|
13380
13367
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
|
@@ -13383,12 +13370,12 @@ module Aws::S3
|
|
|
13383
13370
|
# When using this action using S3 on Outposts through the AWS SDKs, you
|
|
13384
13371
|
# provide the Outposts bucket ARN in place of the bucket name. For more
|
|
13385
13372
|
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
|
13386
|
-
# in the *Amazon
|
|
13373
|
+
# in the *Amazon S3 User Guide*.
|
|
13387
13374
|
#
|
|
13388
13375
|
#
|
|
13389
13376
|
#
|
|
13390
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
13391
|
-
# [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
|
|
13392
13379
|
#
|
|
13393
13380
|
# @option params [required, String] :copy_source
|
|
13394
13381
|
# Specifies the source object for the copy operation. You specify the
|
|
@@ -13434,7 +13421,7 @@ module Aws::S3
|
|
|
13434
13421
|
#
|
|
13435
13422
|
#
|
|
13436
13423
|
#
|
|
13437
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
|
13424
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
|
13438
13425
|
#
|
|
13439
13426
|
# @option params [String] :copy_source_if_match
|
|
13440
13427
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
|
@@ -13511,12 +13498,12 @@ module Aws::S3
|
|
|
13511
13498
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
|
13512
13499
|
#
|
|
13513
13500
|
# @option params [String] :expected_bucket_owner
|
|
13514
|
-
# The account
|
|
13501
|
+
# The account ID of the expected destination bucket owner. If the
|
|
13515
13502
|
# destination bucket is owned by a different account, the request will
|
|
13516
13503
|
# fail with an HTTP `403 (Access Denied)` error.
|
|
13517
13504
|
#
|
|
13518
13505
|
# @option params [String] :expected_source_bucket_owner
|
|
13519
|
-
# The account
|
|
13506
|
+
# The account ID of the expected source bucket owner. If the source
|
|
13520
13507
|
# bucket is owned by a different account, the request will fail with an
|
|
13521
13508
|
# HTTP `403 (Access Denied)` error.
|
|
13522
13509
|
#
|
|
@@ -13619,6 +13606,297 @@ module Aws::S3
|
|
|
13619
13606
|
req.send_request(options)
|
|
13620
13607
|
end
|
|
13621
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
|
+
|
|
13622
13900
|
# @!endgroup
|
|
13623
13901
|
|
|
13624
13902
|
# @param params ({})
|
|
@@ -13632,7 +13910,7 @@ module Aws::S3
|
|
|
13632
13910
|
params: params,
|
|
13633
13911
|
config: config)
|
|
13634
13912
|
context[:gem_name] = 'aws-sdk-s3'
|
|
13635
|
-
context[:gem_version] = '1.
|
|
13913
|
+
context[:gem_version] = '1.94.0'
|
|
13636
13914
|
Seahorse::Client::Request.new(handlers, context)
|
|
13637
13915
|
end
|
|
13638
13916
|
|