aws-sdk-s3 1.88.1 → 1.92.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 +736 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-s3.rb +2 -2
- data/lib/aws-sdk-s3/arn/access_point_arn.rb +2 -2
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +66 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +3 -3
- data/lib/aws-sdk-s3/bucket.rb +10 -10
- 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 +5 -6
- 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 +1091 -773
- data/lib/aws-sdk-s3/client_api.rb +62 -1
- data/lib/aws-sdk-s3/customizations/bucket.rb +8 -3
- data/lib/aws-sdk-s3/customizations/object.rb +9 -3
- data/lib/aws-sdk-s3/errors.rb +1 -1
- data/lib/aws-sdk-s3/event_streams.rb +1 -1
- 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 +22 -22
- data/lib/aws-sdk-s3/object_acl.rb +2 -2
- data/lib/aws-sdk-s3/object_summary.rb +22 -22
- data/lib/aws-sdk-s3/object_version.rb +10 -10
- data/lib/aws-sdk-s3/plugins/arn.rb +20 -13
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +11 -10
- data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +6 -0
- data/lib/aws-sdk-s3/presigner.rb +1 -2
- data/lib/aws-sdk-s3/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +822 -377
- data/lib/aws-sdk-s3/waiters.rb +1 -1
- metadata +8 -3
@@ -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]
|
@@ -232,7 +232,7 @@ module Aws::S3
|
|
232
232
|
# SDKs, this field is calculated automatically.
|
233
233
|
# @option options [Types::LifecycleConfiguration] :lifecycle_configuration
|
234
234
|
# @option options [String] :expected_bucket_owner
|
235
|
-
# The account
|
235
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
236
236
|
# a different account, the request will fail with an HTTP `403 (Access
|
237
237
|
# Denied)` error.
|
238
238
|
# @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]
|
@@ -249,7 +249,7 @@ module Aws::S3
|
|
249
249
|
# @option options [Types::BucketLifecycleConfiguration] :lifecycle_configuration
|
250
250
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
251
251
|
# @option options [String] :expected_bucket_owner
|
252
|
-
# The account
|
252
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
253
253
|
# a different account, the request will fail with an HTTP `403 (Access
|
254
254
|
# Denied)` error.
|
255
255
|
# @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
|
|
@@ -214,7 +214,7 @@ module Aws::S3
|
|
214
214
|
# For requests made using the AWS Command Line Interface (CLI) or AWS
|
215
215
|
# SDKs, this field is calculated automatically.
|
216
216
|
# @option options [String] :expected_bucket_owner
|
217
|
-
# The account
|
217
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
218
218
|
# a different account, the request will fail with an HTTP `403 (Access
|
219
219
|
# Denied)` error.
|
220
220
|
# @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
|
|
@@ -253,7 +253,7 @@ module Aws::S3
|
|
253
253
|
# bucket. If this element is empty, notifications are turned off for the
|
254
254
|
# bucket.
|
255
255
|
# @option options [String] :expected_bucket_owner
|
256
|
-
# The account
|
256
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
257
257
|
# a different account, the request will fail with an HTTP `403 (Access
|
258
258
|
# Denied)` error.
|
259
259
|
# @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]
|
@@ -211,7 +211,7 @@ module Aws::S3
|
|
211
211
|
# @option options [required, String] :policy
|
212
212
|
# The bucket policy as a JSON document.
|
213
213
|
# @option options [String] :expected_bucket_owner
|
214
|
-
# The account
|
214
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
215
215
|
# a different account, the request will fail with an HTTP `403 (Access
|
216
216
|
# Denied)` error.
|
217
217
|
# @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
|
|
@@ -185,10 +185,9 @@ module Aws::S3
|
|
185
185
|
# })
|
186
186
|
# @param [Hash] options ({})
|
187
187
|
# @option options [String] :content_md5
|
188
|
-
#
|
189
|
-
#
|
190
|
-
#
|
191
|
-
# 1864][1].
|
188
|
+
# The base64-encoded 128-bit MD5 digest of the data. You must use this
|
189
|
+
# header as a message integrity check to verify that the request body
|
190
|
+
# was not corrupted in transit. For more information, see [RFC 1864][1].
|
192
191
|
#
|
193
192
|
# For requests made using the AWS Command Line Interface (CLI) or AWS
|
194
193
|
# SDKs, this field is calculated automatically.
|
@@ -199,7 +198,7 @@ module Aws::S3
|
|
199
198
|
# @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
|
200
199
|
# Container for Payer.
|
201
200
|
# @option options [String] :expected_bucket_owner
|
202
|
-
# The account
|
201
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
203
202
|
# a different account, the request will fail with an HTTP `403 (Access
|
204
203
|
# Denied)` error.
|
205
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
|
@@ -408,7 +410,7 @@ module Aws::S3
|
|
408
410
|
|
409
411
|
# @!group API Operations
|
410
412
|
|
411
|
-
# This
|
413
|
+
# This action aborts a multipart upload. After a multipart upload is
|
412
414
|
# aborted, no additional parts can be uploaded using that upload ID. The
|
413
415
|
# storage consumed by any previously uploaded parts will be freed.
|
414
416
|
# However, if any part uploads are currently in progress, those part
|
@@ -417,11 +419,11 @@ module Aws::S3
|
|
417
419
|
# completely free all storage consumed by all parts.
|
418
420
|
#
|
419
421
|
# To verify that all parts have been removed, so you don't get charged
|
420
|
-
# for the part storage, you should call the [ListParts][1]
|
422
|
+
# for the part storage, you should call the [ListParts][1] action and
|
421
423
|
# ensure that the parts list is empty.
|
422
424
|
#
|
423
|
-
# For information about permissions required to use the multipart
|
424
|
-
#
|
425
|
+
# For information about permissions required to use the multipart
|
426
|
+
# upload, see [Multipart Upload and Permissions][2].
|
425
427
|
#
|
426
428
|
# The following operations are related to `AbortMultipartUpload`\:
|
427
429
|
#
|
@@ -447,27 +449,27 @@ module Aws::S3
|
|
447
449
|
# @option params [required, String] :bucket
|
448
450
|
# The bucket name to which the upload was taking place.
|
449
451
|
#
|
450
|
-
# When using this
|
451
|
-
# the access point hostname. The access point hostname takes the form
|
452
|
+
# When using this action with an access point, you must direct requests
|
453
|
+
# to the access point hostname. The access point hostname takes the form
|
452
454
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
453
|
-
# When using this
|
454
|
-
#
|
455
|
+
# When using this action with an access point through the AWS SDKs, you
|
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
458
|
# the *Amazon Simple Storage Service Developer Guide*.
|
457
459
|
#
|
458
|
-
# When using this
|
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
|
460
462
|
# takes the form
|
461
463
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
462
|
-
# When using this
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
464
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
465
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
466
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
467
|
+
# in the *Amazon Simple Storage Service Developer 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
|
#
|
@@ -537,11 +539,11 @@ module Aws::S3
|
|
537
539
|
#
|
538
540
|
# You first initiate the multipart upload and then upload all parts
|
539
541
|
# using the [UploadPart][1] operation. After successfully uploading all
|
540
|
-
# relevant parts of an upload, you call this
|
542
|
+
# relevant parts of an upload, you call this action to complete the
|
541
543
|
# upload. Upon receiving this request, Amazon S3 concatenates all the
|
542
544
|
# parts in ascending order by part number to create a new object. In the
|
543
545
|
# Complete Multipart Upload request, you must provide the parts list.
|
544
|
-
# You must ensure that the parts list is complete. This
|
546
|
+
# You must ensure that the parts list is complete. This action
|
545
547
|
# concatenates the parts that you provide in the list. For each part in
|
546
548
|
# the list, you must provide the part number and the `ETag` value,
|
547
549
|
# returned after that part was uploaded.
|
@@ -563,7 +565,7 @@ module Aws::S3
|
|
563
565
|
# Using Multipart Upload][3].
|
564
566
|
#
|
565
567
|
# For information about permissions required to use the multipart upload
|
566
|
-
# API, see [Multipart Upload
|
568
|
+
# API, see [Multipart Upload and Permissions][4].
|
567
569
|
#
|
568
570
|
# `CompleteMultipartUpload` has the following special errors:
|
569
571
|
#
|
@@ -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
|
#
|
@@ -737,8 +739,8 @@ module Aws::S3
|
|
737
739
|
#
|
738
740
|
# <note markdown="1"> You can store individual objects of up to 5 TB in Amazon S3. You
|
739
741
|
# create a copy of your object up to 5 GB in size in a single atomic
|
740
|
-
#
|
741
|
-
#
|
742
|
+
# action using this API. However, to copy an object greater than 5 GB,
|
743
|
+
# you must use the multipart upload Upload Part - Copy API. For more
|
742
744
|
# information, see [Copy Object Using the REST Multipart Upload API][1].
|
743
745
|
#
|
744
746
|
# </note>
|
@@ -752,12 +754,11 @@ module Aws::S3
|
|
752
754
|
#
|
753
755
|
# A copy request might return an error when Amazon S3 receives the copy
|
754
756
|
# request or while Amazon S3 is copying the files. If the error occurs
|
755
|
-
# before the copy
|
756
|
-
#
|
757
|
-
#
|
758
|
-
#
|
759
|
-
#
|
760
|
-
# appropriately.
|
757
|
+
# before the copy action starts, you receive a standard Amazon S3 error.
|
758
|
+
# If the error occurs during the copy operation, the error response is
|
759
|
+
# embedded in the `200 OK` response. This means that a `200 OK` response
|
760
|
+
# can contain either a success or an error. Design your application to
|
761
|
+
# parse the contents of the response and handle it appropriately.
|
761
762
|
#
|
762
763
|
# If the copy is successful, you receive a response with information
|
763
764
|
# about the copied object.
|
@@ -845,7 +846,7 @@ module Aws::S3
|
|
845
846
|
#
|
846
847
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
847
848
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
848
|
-
# the *Amazon
|
849
|
+
# the *Amazon S3 User Guide*.
|
849
850
|
#
|
850
851
|
# **Access Control List (ACL)-Specific Request Headers**
|
851
852
|
#
|
@@ -859,8 +860,8 @@ module Aws::S3
|
|
859
860
|
#
|
860
861
|
# **Storage Class Options**
|
861
862
|
#
|
862
|
-
# You can use the `CopyObject`
|
863
|
-
#
|
863
|
+
# You can use the `CopyObject` action to change the storage class of an
|
864
|
+
# object that is already stored in Amazon S3 using the `StorageClass`
|
864
865
|
# parameter. For more information, see [Storage Classes][12] in the
|
865
866
|
# *Amazon S3 Service Developer Guide*.
|
866
867
|
#
|
@@ -896,7 +897,7 @@ module Aws::S3
|
|
896
897
|
#
|
897
898
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
|
898
899
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
899
|
-
# [3]:
|
900
|
+
# [3]: http://aws.amazon.com/s3/pricing/
|
900
901
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
901
902
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
902
903
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
|
@@ -919,27 +920,27 @@ module Aws::S3
|
|
919
920
|
# @option params [required, String] :bucket
|
920
921
|
# The name of the destination bucket.
|
921
922
|
#
|
922
|
-
# When using this
|
923
|
-
# the access point hostname. The access point hostname takes the form
|
923
|
+
# When using this action with an access point, you must direct requests
|
924
|
+
# to the access point hostname. The access point hostname takes the form
|
924
925
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
925
|
-
# When using this
|
926
|
-
#
|
926
|
+
# When using this action with an access point through the AWS SDKs, you
|
927
|
+
# provide the access point ARN in place of the bucket name. For more
|
927
928
|
# information about access point ARNs, see [Using Access Points][1] in
|
928
929
|
# the *Amazon Simple Storage Service Developer Guide*.
|
929
930
|
#
|
930
|
-
# When using this
|
931
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
931
932
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
932
933
|
# takes the form
|
933
934
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
934
|
-
# When using this
|
935
|
-
#
|
936
|
-
#
|
937
|
-
#
|
935
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
936
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
937
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
938
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
938
939
|
#
|
939
940
|
#
|
940
941
|
#
|
941
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
942
|
-
# [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
|
943
944
|
#
|
944
945
|
# @option params [String] :cache_control
|
945
946
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1002,7 +1003,7 @@ module Aws::S3
|
|
1002
1003
|
#
|
1003
1004
|
#
|
1004
1005
|
#
|
1005
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1006
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
1006
1007
|
#
|
1007
1008
|
# @option params [String] :copy_source_if_match
|
1008
1009
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -1116,8 +1117,8 @@ module Aws::S3
|
|
1116
1117
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
1117
1118
|
# for object encryption with SSE-KMS.
|
1118
1119
|
#
|
1119
|
-
# Specifying this header with a COPY
|
1120
|
-
#
|
1120
|
+
# Specifying this header with a COPY action doesn’t affect bucket-level
|
1121
|
+
# settings for S3 Bucket Key.
|
1121
1122
|
#
|
1122
1123
|
# @option params [String] :copy_source_sse_customer_algorithm
|
1123
1124
|
# Specifies the algorithm to use when decrypting the source object (for
|
@@ -1160,12 +1161,12 @@ module Aws::S3
|
|
1160
1161
|
# Specifies whether you want to apply a Legal Hold to the copied object.
|
1161
1162
|
#
|
1162
1163
|
# @option params [String] :expected_bucket_owner
|
1163
|
-
# The account
|
1164
|
+
# The account ID of the expected destination bucket owner. If the
|
1164
1165
|
# destination bucket is owned by a different account, the request will
|
1165
1166
|
# fail with an HTTP `403 (Access Denied)` error.
|
1166
1167
|
#
|
1167
1168
|
# @option params [String] :expected_source_bucket_owner
|
1168
|
-
# The account
|
1169
|
+
# The account ID of the expected source bucket owner. If the source
|
1169
1170
|
# bucket is owned by a different account, the request will fail with an
|
1170
1171
|
# HTTP `403 (Access Denied)` error.
|
1171
1172
|
#
|
@@ -1476,7 +1477,7 @@ module Aws::S3
|
|
1476
1477
|
req.send_request(options)
|
1477
1478
|
end
|
1478
1479
|
|
1479
|
-
# This
|
1480
|
+
# This action initiates a multipart upload and returns an upload ID.
|
1480
1481
|
# This upload ID is used to associate all of the parts in the specific
|
1481
1482
|
# multipart upload. You specify this upload ID in each of your
|
1482
1483
|
# subsequent upload part requests (see [UploadPart][1]). You also
|
@@ -1489,12 +1490,12 @@ module Aws::S3
|
|
1489
1490
|
# If you have configured a lifecycle rule to abort incomplete multipart
|
1490
1491
|
# uploads, the upload must complete within the number of days specified
|
1491
1492
|
# in the bucket lifecycle configuration. Otherwise, the incomplete
|
1492
|
-
# multipart upload becomes eligible for an abort
|
1493
|
+
# multipart upload becomes eligible for an abort action and Amazon S3
|
1493
1494
|
# aborts the multipart upload. For more information, see [Aborting
|
1494
1495
|
# Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][3].
|
1495
1496
|
#
|
1496
1497
|
# For information about the permissions required to use the multipart
|
1497
|
-
# upload API, see [Multipart Upload
|
1498
|
+
# upload API, see [Multipart Upload and Permissions][4].
|
1498
1499
|
#
|
1499
1500
|
# For request signing, multipart upload is just a series of regular
|
1500
1501
|
# requests. You initiate a multipart upload, send one or more requests
|
@@ -1517,9 +1518,9 @@ module Aws::S3
|
|
1517
1518
|
# your own encryption key, or use AWS Key Management Service (AWS KMS)
|
1518
1519
|
# customer master keys (CMKs) or Amazon S3-managed encryption keys. If
|
1519
1520
|
# you choose to provide your own encryption key, the request headers you
|
1520
|
-
# provide in [UploadPart]
|
1521
|
-
#
|
1522
|
-
#
|
1521
|
+
# provide in [UploadPart][1] and [UploadPartCopy][6] requests must match
|
1522
|
+
# the headers you used in the request to initiate the upload by using
|
1523
|
+
# `CreateMultipartUpload`.
|
1523
1524
|
#
|
1524
1525
|
# To perform a multipart upload with encryption using an AWS KMS CMK,
|
1525
1526
|
# the requester must have permission to the `kms:Encrypt`,
|
@@ -1717,27 +1718,27 @@ module Aws::S3
|
|
1717
1718
|
# @option params [required, String] :bucket
|
1718
1719
|
# The name of the bucket to which to initiate the upload
|
1719
1720
|
#
|
1720
|
-
# When using this
|
1721
|
-
# the access point hostname. The access point hostname takes the form
|
1721
|
+
# When using this action with an access point, you must direct requests
|
1722
|
+
# to the access point hostname. The access point hostname takes the form
|
1722
1723
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1723
|
-
# When using this
|
1724
|
-
#
|
1724
|
+
# When using this action with an access point through the AWS SDKs, you
|
1725
|
+
# provide the access point ARN in place of the bucket name. For more
|
1725
1726
|
# information about access point ARNs, see [Using Access Points][1] in
|
1726
1727
|
# the *Amazon Simple Storage Service Developer Guide*.
|
1727
1728
|
#
|
1728
|
-
# When using this
|
1729
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1729
1730
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1730
1731
|
# takes the form
|
1731
1732
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1732
|
-
# When using this
|
1733
|
-
#
|
1734
|
-
#
|
1735
|
-
#
|
1733
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
1734
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
1735
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
1736
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
1736
1737
|
#
|
1737
1738
|
#
|
1738
1739
|
#
|
1739
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
1740
|
-
# [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
|
1741
1742
|
#
|
1742
1743
|
# @option params [String] :cache_control
|
1743
1744
|
# Specifies caching behavior along the request/reply chain.
|
@@ -1833,7 +1834,7 @@ module Aws::S3
|
|
1833
1834
|
#
|
1834
1835
|
#
|
1835
1836
|
#
|
1836
|
-
# [1]: https://docs.aws.amazon.com/
|
1837
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
1837
1838
|
#
|
1838
1839
|
# @option params [String] :ssekms_encryption_context
|
1839
1840
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -1846,7 +1847,7 @@ module Aws::S3
|
|
1846
1847
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
1847
1848
|
# for object encryption with SSE-KMS.
|
1848
1849
|
#
|
1849
|
-
# Specifying this header with an object
|
1850
|
+
# Specifying this header with an object action doesn’t affect
|
1850
1851
|
# bucket-level settings for S3 Bucket Key.
|
1851
1852
|
#
|
1852
1853
|
# @option params [String] :request_payer
|
@@ -1876,7 +1877,7 @@ module Aws::S3
|
|
1876
1877
|
# object.
|
1877
1878
|
#
|
1878
1879
|
# @option params [String] :expected_bucket_owner
|
1879
|
-
# The account
|
1880
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1880
1881
|
# a different account, the request will fail with an HTTP `403 (Access
|
1881
1882
|
# Denied)` error.
|
1882
1883
|
#
|
@@ -1991,7 +1992,7 @@ module Aws::S3
|
|
1991
1992
|
# Specifies the bucket being deleted.
|
1992
1993
|
#
|
1993
1994
|
# @option params [String] :expected_bucket_owner
|
1994
|
-
# The account
|
1995
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
1995
1996
|
# a different account, the request will fail with an HTTP `403 (Access
|
1996
1997
|
# Denied)` error.
|
1997
1998
|
#
|
@@ -2046,8 +2047,8 @@ module Aws::S3
|
|
2046
2047
|
#
|
2047
2048
|
#
|
2048
2049
|
#
|
2049
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2050
|
-
# [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
|
2051
2052
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
2052
2053
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
2053
2054
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -2061,7 +2062,7 @@ module Aws::S3
|
|
2061
2062
|
# The ID that identifies the analytics configuration.
|
2062
2063
|
#
|
2063
2064
|
# @option params [String] :expected_bucket_owner
|
2064
|
-
# The account
|
2065
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2065
2066
|
# a different account, the request will fail with an HTTP `403 (Access
|
2066
2067
|
# Denied)` error.
|
2067
2068
|
#
|
@@ -2091,7 +2092,7 @@ module Aws::S3
|
|
2091
2092
|
# default and can grant this permission to others.
|
2092
2093
|
#
|
2093
2094
|
# For information about `cors`, see [Enabling Cross-Origin Resource
|
2094
|
-
# Sharing][1] in the *Amazon
|
2095
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
2095
2096
|
#
|
2096
2097
|
# **Related Resources:**
|
2097
2098
|
#
|
@@ -2109,7 +2110,7 @@ module Aws::S3
|
|
2109
2110
|
# Specifies the bucket whose `cors` configuration is being deleted.
|
2110
2111
|
#
|
2111
2112
|
# @option params [String] :expected_bucket_owner
|
2112
|
-
# The account
|
2113
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2113
2114
|
# a different account, the request will fail with an HTTP `403 (Access
|
2114
2115
|
# Denied)` error.
|
2115
2116
|
#
|
@@ -2140,18 +2141,18 @@ module Aws::S3
|
|
2140
2141
|
req.send_request(options)
|
2141
2142
|
end
|
2142
2143
|
|
2143
|
-
# This implementation of the DELETE
|
2144
|
+
# This implementation of the DELETE action removes default encryption
|
2144
2145
|
# from the bucket. For information about the Amazon S3 default
|
2145
2146
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
2146
|
-
# the *Amazon
|
2147
|
+
# the *Amazon S3 User Guide*.
|
2147
2148
|
#
|
2148
2149
|
# To use this operation, you must have permissions to perform the
|
2149
2150
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
2150
2151
|
# permission by default. The bucket owner can grant this permission to
|
2151
2152
|
# others. For more information about permissions, see [Permissions
|
2152
2153
|
# Related to Bucket Subresource Operations][2] and [Managing Access
|
2153
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
2154
|
-
#
|
2154
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
2155
|
+
# Guide*.
|
2155
2156
|
#
|
2156
2157
|
# **Related Resources**
|
2157
2158
|
#
|
@@ -2162,8 +2163,8 @@ module Aws::S3
|
|
2162
2163
|
#
|
2163
2164
|
#
|
2164
2165
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
2165
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2166
|
-
# [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
|
2167
2168
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
2168
2169
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
2169
2170
|
#
|
@@ -2172,7 +2173,7 @@ module Aws::S3
|
|
2172
2173
|
# configuration to delete.
|
2173
2174
|
#
|
2174
2175
|
# @option params [String] :expected_bucket_owner
|
2175
|
-
# The account
|
2176
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2176
2177
|
# a different account, the request will fail with an HTTP `403 (Access
|
2177
2178
|
# Denied)` error.
|
2178
2179
|
#
|
@@ -2279,8 +2280,8 @@ module Aws::S3
|
|
2279
2280
|
#
|
2280
2281
|
#
|
2281
2282
|
#
|
2282
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2283
|
-
# [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
|
2284
2285
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
2285
2286
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
2286
2287
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html
|
@@ -2294,7 +2295,7 @@ module Aws::S3
|
|
2294
2295
|
# The ID used to identify the inventory configuration.
|
2295
2296
|
#
|
2296
2297
|
# @option params [String] :expected_bucket_owner
|
2297
|
-
# The account
|
2298
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2298
2299
|
# a different account, the request will fail with an HTTP `403 (Access
|
2299
2300
|
# Denied)` error.
|
2300
2301
|
#
|
@@ -2350,7 +2351,7 @@ module Aws::S3
|
|
2350
2351
|
# The bucket name of the lifecycle to delete.
|
2351
2352
|
#
|
2352
2353
|
# @option params [String] :expected_bucket_owner
|
2353
|
-
# The account
|
2354
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2354
2355
|
# a different account, the request will fail with an HTTP `403 (Access
|
2355
2356
|
# Denied)` error.
|
2356
2357
|
#
|
@@ -2408,8 +2409,8 @@ module Aws::S3
|
|
2408
2409
|
#
|
2409
2410
|
#
|
2410
2411
|
#
|
2411
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2412
|
-
# [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
|
2413
2414
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
2414
2415
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
2415
2416
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -2422,7 +2423,7 @@ module Aws::S3
|
|
2422
2423
|
# The ID used to identify the metrics configuration.
|
2423
2424
|
#
|
2424
2425
|
# @option params [String] :expected_bucket_owner
|
2425
|
-
# The account
|
2426
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2426
2427
|
# a different account, the request will fail with an HTTP `403 (Access
|
2427
2428
|
# Denied)` error.
|
2428
2429
|
#
|
@@ -2469,7 +2470,7 @@ module Aws::S3
|
|
2469
2470
|
# The Amazon S3 bucket whose `OwnershipControls` you want to delete.
|
2470
2471
|
#
|
2471
2472
|
# @option params [String] :expected_bucket_owner
|
2472
|
-
# The account
|
2473
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2473
2474
|
# a different account, the request will fail with an HTTP `403 (Access
|
2474
2475
|
# Denied)` error.
|
2475
2476
|
#
|
@@ -2491,12 +2492,12 @@ module Aws::S3
|
|
2491
2492
|
req.send_request(options)
|
2492
2493
|
end
|
2493
2494
|
|
2494
|
-
# This implementation of the DELETE
|
2495
|
-
#
|
2496
|
-
#
|
2497
|
-
#
|
2498
|
-
#
|
2499
|
-
#
|
2495
|
+
# This implementation of the DELETE action uses the policy subresource
|
2496
|
+
# to delete the policy of a specified bucket. If you are using an
|
2497
|
+
# identity other than the root user of the AWS account that owns the
|
2498
|
+
# bucket, the calling identity must have the `DeleteBucketPolicy`
|
2499
|
+
# permissions on the specified bucket and belong to the bucket owner's
|
2500
|
+
# account to use this operation.
|
2500
2501
|
#
|
2501
2502
|
# If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns
|
2502
2503
|
# a `403 Access Denied` error. If you have the correct permissions, but
|
@@ -2508,25 +2509,25 @@ module Aws::S3
|
|
2508
2509
|
# denies the root user the ability to perform this action.
|
2509
2510
|
#
|
2510
2511
|
# For more information about bucket policies, see [Using Bucket Policies
|
2511
|
-
# and UserPolicies]
|
2512
|
-
# https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
|
2512
|
+
# and UserPolicies][1].
|
2513
2513
|
#
|
2514
2514
|
# The following operations are related to `DeleteBucketPolicy`
|
2515
2515
|
#
|
2516
|
-
# * [CreateBucket][
|
2516
|
+
# * [CreateBucket][2]
|
2517
2517
|
#
|
2518
|
-
# * [DeleteObject][
|
2518
|
+
# * [DeleteObject][3]
|
2519
2519
|
#
|
2520
2520
|
#
|
2521
2521
|
#
|
2522
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2523
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2522
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
2523
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
2524
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
2524
2525
|
#
|
2525
2526
|
# @option params [required, String] :bucket
|
2526
2527
|
# The bucket name.
|
2527
2528
|
#
|
2528
2529
|
# @option params [String] :expected_bucket_owner
|
2529
|
-
# The account
|
2530
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2530
2531
|
# a different account, the request will fail with an HTTP `403 (Access
|
2531
2532
|
# Denied)` error.
|
2532
2533
|
#
|
@@ -2571,28 +2572,28 @@ module Aws::S3
|
|
2571
2572
|
#
|
2572
2573
|
# </note>
|
2573
2574
|
#
|
2574
|
-
# For information about replication configuration, see [Replication]
|
2575
|
-
#
|
2576
|
-
# the *Amazon S3 Developer Guide*.
|
2575
|
+
# For information about replication configuration, see [Replication][3]
|
2576
|
+
# in the *Amazon S3 Developer Guide*.
|
2577
2577
|
#
|
2578
2578
|
# The following operations are related to `DeleteBucketReplication`\:
|
2579
2579
|
#
|
2580
|
-
# * [PutBucketReplication][
|
2580
|
+
# * [PutBucketReplication][4]
|
2581
2581
|
#
|
2582
|
-
# * [GetBucketReplication][
|
2582
|
+
# * [GetBucketReplication][5]
|
2583
2583
|
#
|
2584
2584
|
#
|
2585
2585
|
#
|
2586
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2587
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2588
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2589
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
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
|
2588
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
2589
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
2590
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
2590
2591
|
#
|
2591
2592
|
# @option params [required, String] :bucket
|
2592
2593
|
# The bucket name.
|
2593
2594
|
#
|
2594
2595
|
# @option params [String] :expected_bucket_owner
|
2595
|
-
# The account
|
2596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2596
2597
|
# a different account, the request will fail with an HTTP `403 (Access
|
2597
2598
|
# Denied)` error.
|
2598
2599
|
#
|
@@ -2644,7 +2645,7 @@ module Aws::S3
|
|
2644
2645
|
# The bucket that has the tag set to be removed.
|
2645
2646
|
#
|
2646
2647
|
# @option params [String] :expected_bucket_owner
|
2647
|
-
# The account
|
2648
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2648
2649
|
# a different account, the request will fail with an HTTP `403 (Access
|
2649
2650
|
# Denied)` error.
|
2650
2651
|
#
|
@@ -2675,18 +2676,18 @@ module Aws::S3
|
|
2675
2676
|
req.send_request(options)
|
2676
2677
|
end
|
2677
2678
|
|
2678
|
-
# This
|
2679
|
-
#
|
2679
|
+
# This action removes the website configuration for a bucket. Amazon S3
|
2680
|
+
# returns a `200 OK` response upon successfully deleting a website
|
2680
2681
|
# configuration on the specified bucket. You will get a `200 OK`
|
2681
2682
|
# response if the website configuration you are trying to delete does
|
2682
2683
|
# not exist on the bucket. Amazon S3 returns a `404` response if the
|
2683
2684
|
# bucket specified in the request does not exist.
|
2684
2685
|
#
|
2685
|
-
# This DELETE
|
2686
|
-
#
|
2687
|
-
#
|
2688
|
-
#
|
2689
|
-
#
|
2686
|
+
# This DELETE action requires the `S3:DeleteBucketWebsite` permission.
|
2687
|
+
# By default, only the bucket owner can delete the website configuration
|
2688
|
+
# attached to a bucket. However, bucket owners can grant other users
|
2689
|
+
# permission to delete the website configuration by writing a bucket
|
2690
|
+
# policy granting them the `S3:DeleteBucketWebsite` permission.
|
2690
2691
|
#
|
2691
2692
|
# For more information about hosting websites, see [Hosting Websites on
|
2692
2693
|
# Amazon S3][1].
|
@@ -2708,7 +2709,7 @@ module Aws::S3
|
|
2708
2709
|
# configuration.
|
2709
2710
|
#
|
2710
2711
|
# @option params [String] :expected_bucket_owner
|
2711
|
-
# The account
|
2712
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2712
2713
|
# a different account, the request will fail with an HTTP `403 (Access
|
2713
2714
|
# Denied)` error.
|
2714
2715
|
#
|
@@ -2757,14 +2758,14 @@ module Aws::S3
|
|
2757
2758
|
# For more information about MFA Delete, see [Using MFA Delete][1]. To
|
2758
2759
|
# see sample requests that use versioning, see [Sample Request][2].
|
2759
2760
|
#
|
2760
|
-
# You can delete objects by explicitly calling
|
2761
|
+
# You can delete objects by explicitly calling DELETE Object or
|
2761
2762
|
# configure its lifecycle ([PutBucketLifecycle][3]) to enable Amazon S3
|
2762
2763
|
# to remove them for you. If you want to block users or accounts from
|
2763
2764
|
# removing or deleting objects from your bucket, you must deny them the
|
2764
2765
|
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
|
2765
2766
|
# `s3:PutLifeCycleConfiguration` actions.
|
2766
2767
|
#
|
2767
|
-
# The following
|
2768
|
+
# The following action is related to `DeleteObject`\:
|
2768
2769
|
#
|
2769
2770
|
# * [PutObject][4]
|
2770
2771
|
#
|
@@ -2780,27 +2781,27 @@ module Aws::S3
|
|
2780
2781
|
# @option params [required, String] :bucket
|
2781
2782
|
# The bucket name of the bucket containing the object.
|
2782
2783
|
#
|
2783
|
-
# When using this
|
2784
|
-
# the access point hostname. The access point hostname takes the form
|
2784
|
+
# When using this action with an access point, you must direct requests
|
2785
|
+
# to the access point hostname. The access point hostname takes the form
|
2785
2786
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2786
|
-
# When using this
|
2787
|
-
#
|
2787
|
+
# When using this action with an access point through the AWS SDKs, you
|
2788
|
+
# provide the access point ARN in place of the bucket name. For more
|
2788
2789
|
# information about access point ARNs, see [Using Access Points][1] in
|
2789
2790
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2790
2791
|
#
|
2791
|
-
# When using this
|
2792
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2792
2793
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2793
2794
|
# takes the form
|
2794
2795
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2795
|
-
# When using this
|
2796
|
-
#
|
2797
|
-
#
|
2798
|
-
#
|
2796
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2797
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2798
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2799
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
2799
2800
|
#
|
2800
2801
|
#
|
2801
2802
|
#
|
2802
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2803
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2803
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2804
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2804
2805
|
#
|
2805
2806
|
# @option params [required, String] :key
|
2806
2807
|
# Key name of the object to delete.
|
@@ -2830,7 +2831,7 @@ module Aws::S3
|
|
2830
2831
|
# restrictions to process this operation.
|
2831
2832
|
#
|
2832
2833
|
# @option params [String] :expected_bucket_owner
|
2833
|
-
# The account
|
2834
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2834
2835
|
# a different account, the request will fail with an HTTP `403 (Access
|
2835
2836
|
# Denied)` error.
|
2836
2837
|
#
|
@@ -2916,36 +2917,37 @@ module Aws::S3
|
|
2916
2917
|
# @option params [required, String] :bucket
|
2917
2918
|
# The bucket name containing the objects from which to remove the tags.
|
2918
2919
|
#
|
2919
|
-
# When using this
|
2920
|
-
# the access point hostname. The access point hostname takes the form
|
2920
|
+
# When using this action with an access point, you must direct requests
|
2921
|
+
# to the access point hostname. The access point hostname takes the form
|
2921
2922
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2922
|
-
# When using this
|
2923
|
-
#
|
2923
|
+
# When using this action with an access point through the AWS SDKs, you
|
2924
|
+
# provide the access point ARN in place of the bucket name. For more
|
2924
2925
|
# information about access point ARNs, see [Using Access Points][1] in
|
2925
2926
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2926
2927
|
#
|
2927
|
-
# When using this
|
2928
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2928
2929
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2929
2930
|
# takes the form
|
2930
2931
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2931
|
-
# When using this
|
2932
|
-
#
|
2933
|
-
#
|
2934
|
-
#
|
2932
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2933
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2934
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2935
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
2935
2936
|
#
|
2936
2937
|
#
|
2937
2938
|
#
|
2938
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2939
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2939
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2940
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2940
2941
|
#
|
2941
2942
|
# @option params [required, String] :key
|
2942
|
-
#
|
2943
|
+
# The key that identifies the object in the bucket from which to remove
|
2944
|
+
# all tags.
|
2943
2945
|
#
|
2944
2946
|
# @option params [String] :version_id
|
2945
2947
|
# The versionId of the object that the tag-set will be removed from.
|
2946
2948
|
#
|
2947
2949
|
# @option params [String] :expected_bucket_owner
|
2948
|
-
# The account
|
2950
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2949
2951
|
# a different account, the request will fail with an HTTP `403 (Access
|
2950
2952
|
# Denied)` error.
|
2951
2953
|
#
|
@@ -2954,35 +2956,35 @@ module Aws::S3
|
|
2954
2956
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2955
2957
|
#
|
2956
2958
|
#
|
2957
|
-
# @example Example: To remove tag set from an object
|
2959
|
+
# @example Example: To remove tag set from an object
|
2958
2960
|
#
|
2959
|
-
# # The following example removes tag set associated with the specified object
|
2960
|
-
# #
|
2961
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2962
|
+
# # operation removes tag set from the latest object version.
|
2961
2963
|
#
|
2962
2964
|
# resp = client.delete_object_tagging({
|
2963
2965
|
# bucket: "examplebucket",
|
2964
2966
|
# key: "HappyFace.jpg",
|
2965
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2966
2967
|
# })
|
2967
2968
|
#
|
2968
2969
|
# resp.to_h outputs the following:
|
2969
2970
|
# {
|
2970
|
-
# version_id: "
|
2971
|
+
# version_id: "null",
|
2971
2972
|
# }
|
2972
2973
|
#
|
2973
|
-
# @example Example: To remove tag set from an object
|
2974
|
+
# @example Example: To remove tag set from an object version
|
2974
2975
|
#
|
2975
|
-
# # The following example removes tag set associated with the specified object.
|
2976
|
-
# #
|
2976
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2977
|
+
# # object key and object version.
|
2977
2978
|
#
|
2978
2979
|
# resp = client.delete_object_tagging({
|
2979
2980
|
# bucket: "examplebucket",
|
2980
2981
|
# key: "HappyFace.jpg",
|
2982
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2981
2983
|
# })
|
2982
2984
|
#
|
2983
2985
|
# resp.to_h outputs the following:
|
2984
2986
|
# {
|
2985
|
-
# version_id: "
|
2987
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2986
2988
|
# }
|
2987
2989
|
#
|
2988
2990
|
# @example Request syntax with placeholder values
|
@@ -3007,27 +3009,27 @@ module Aws::S3
|
|
3007
3009
|
req.send_request(options)
|
3008
3010
|
end
|
3009
3011
|
|
3010
|
-
# This
|
3011
|
-
#
|
3012
|
-
#
|
3013
|
-
#
|
3012
|
+
# This action enables you to delete multiple objects from a bucket using
|
3013
|
+
# a single HTTP request. If you know the object keys that you want to
|
3014
|
+
# delete, then this action provides a suitable alternative to sending
|
3015
|
+
# individual delete requests, reducing per-request overhead.
|
3014
3016
|
#
|
3015
3017
|
# The request contains a list of up to 1000 keys that you want to
|
3016
3018
|
# delete. In the XML, you provide the object key names, and optionally,
|
3017
3019
|
# version IDs if you want to delete a specific version of the object
|
3018
3020
|
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
3019
|
-
# delete
|
3021
|
+
# delete action and returns the result of that delete, success, or
|
3020
3022
|
# failure, in the response. Note that if the object specified in the
|
3021
3023
|
# request is not found, Amazon S3 returns the result as deleted.
|
3022
3024
|
#
|
3023
|
-
# The
|
3024
|
-
#
|
3025
|
-
#
|
3026
|
-
#
|
3027
|
-
#
|
3028
|
-
#
|
3025
|
+
# The action supports two modes for the response: verbose and quiet. By
|
3026
|
+
# default, the action uses verbose mode in which the response includes
|
3027
|
+
# the result of deletion of each key in your request. In quiet mode the
|
3028
|
+
# response includes only keys where the delete action encountered an
|
3029
|
+
# error. For a successful deletion, the action does not return any
|
3030
|
+
# information about the delete in the response body.
|
3029
3031
|
#
|
3030
|
-
# When performing this
|
3032
|
+
# When performing this action on an MFA Delete enabled bucket, that
|
3031
3033
|
# attempts to delete any versioned objects, you must include an MFA
|
3032
3034
|
# token. If you do not provide one, the entire request will fail, even
|
3033
3035
|
# if there are non-versioned objects you are trying to delete. If you
|
@@ -3063,27 +3065,27 @@ module Aws::S3
|
|
3063
3065
|
# @option params [required, String] :bucket
|
3064
3066
|
# The bucket name containing the objects to delete.
|
3065
3067
|
#
|
3066
|
-
# When using this
|
3067
|
-
# the access point hostname. The access point hostname takes the form
|
3068
|
+
# When using this action with an access point, you must direct requests
|
3069
|
+
# to the access point hostname. The access point hostname takes the form
|
3068
3070
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3069
|
-
# When using this
|
3070
|
-
#
|
3071
|
+
# When using this action with an access point through the AWS SDKs, you
|
3072
|
+
# provide the access point ARN in place of the bucket name. For more
|
3071
3073
|
# information about access point ARNs, see [Using Access Points][1] in
|
3072
3074
|
# the *Amazon Simple Storage Service Developer Guide*.
|
3073
3075
|
#
|
3074
|
-
# When using this
|
3076
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3075
3077
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3076
3078
|
# takes the form
|
3077
3079
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
3078
|
-
# When using this
|
3079
|
-
#
|
3080
|
-
#
|
3081
|
-
#
|
3080
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
3081
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
3082
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
3083
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
3082
3084
|
#
|
3083
3085
|
#
|
3084
3086
|
#
|
3085
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3086
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3087
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
3088
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
3087
3089
|
#
|
3088
3090
|
# @option params [required, Types::Delete] :delete
|
3089
3091
|
# Container for the request.
|
@@ -3111,7 +3113,7 @@ module Aws::S3
|
|
3111
3113
|
# permissions to perform this operation.
|
3112
3114
|
#
|
3113
3115
|
# @option params [String] :expected_bucket_owner
|
3114
|
-
# The account
|
3116
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3115
3117
|
# a different account, the request will fail with an HTTP `403 (Access
|
3116
3118
|
# Denied)` error.
|
3117
3119
|
#
|
@@ -3255,8 +3257,8 @@ module Aws::S3
|
|
3255
3257
|
#
|
3256
3258
|
#
|
3257
3259
|
#
|
3258
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3259
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3260
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3261
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3260
3262
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
3261
3263
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
3262
3264
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
@@ -3267,7 +3269,7 @@ module Aws::S3
|
|
3267
3269
|
# to delete.
|
3268
3270
|
#
|
3269
3271
|
# @option params [String] :expected_bucket_owner
|
3270
|
-
# The account
|
3272
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3271
3273
|
# a different account, the request will fail with an HTTP `403 (Access
|
3272
3274
|
# Denied)` error.
|
3273
3275
|
#
|
@@ -3289,7 +3291,7 @@ module Aws::S3
|
|
3289
3291
|
req.send_request(options)
|
3290
3292
|
end
|
3291
3293
|
|
3292
|
-
# This implementation of the GET
|
3294
|
+
# This implementation of the GET action uses the `accelerate`
|
3293
3295
|
# subresource to return the Transfer Acceleration state of a bucket,
|
3294
3296
|
# which is either `Enabled` or `Suspended`. Amazon S3 Transfer
|
3295
3297
|
# Acceleration is a bucket-level feature that enables you to perform
|
@@ -3300,8 +3302,8 @@ module Aws::S3
|
|
3300
3302
|
# permission by default. The bucket owner can grant this permission to
|
3301
3303
|
# others. For more information about permissions, see [Permissions
|
3302
3304
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3303
|
-
# Permissions to your Amazon S3 Resources][2] in the *Amazon
|
3304
|
-
#
|
3305
|
+
# Permissions to your Amazon S3 Resources][2] in the *Amazon S3 User
|
3306
|
+
# Guide*.
|
3305
3307
|
#
|
3306
3308
|
# You set the Transfer Acceleration state of an existing bucket to
|
3307
3309
|
# `Enabled` or `Suspended` by using the
|
@@ -3312,7 +3314,7 @@ module Aws::S3
|
|
3312
3314
|
# Acceleration state if a state has never been set on the bucket.
|
3313
3315
|
#
|
3314
3316
|
# For more information about transfer acceleration, see [Transfer
|
3315
|
-
# Acceleration][4] in the Amazon
|
3317
|
+
# Acceleration][4] in the Amazon S3 User Guide.
|
3316
3318
|
#
|
3317
3319
|
# **Related Resources**
|
3318
3320
|
#
|
@@ -3322,8 +3324,8 @@ module Aws::S3
|
|
3322
3324
|
#
|
3323
3325
|
#
|
3324
3326
|
#
|
3325
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3326
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3327
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3328
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3327
3329
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html
|
3328
3330
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
3329
3331
|
#
|
@@ -3332,7 +3334,7 @@ module Aws::S3
|
|
3332
3334
|
# retrieved.
|
3333
3335
|
#
|
3334
3336
|
# @option params [String] :expected_bucket_owner
|
3335
|
-
# The account
|
3337
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3336
3338
|
# a different account, the request will fail with an HTTP `403 (Access
|
3337
3339
|
# Denied)` error.
|
3338
3340
|
#
|
@@ -3360,8 +3362,8 @@ module Aws::S3
|
|
3360
3362
|
req.send_request(options)
|
3361
3363
|
end
|
3362
3364
|
|
3363
|
-
# This implementation of the `GET`
|
3364
|
-
#
|
3365
|
+
# This implementation of the `GET` action uses the `acl` subresource to
|
3366
|
+
# return the access control list (ACL) of a bucket. To use `GET` to
|
3365
3367
|
# return the ACL of the bucket, you must have `READ_ACP` access to the
|
3366
3368
|
# bucket. If `READ_ACP` permission is granted to the anonymous user, you
|
3367
3369
|
# can return the ACL of the bucket without using an authorization
|
@@ -3381,7 +3383,7 @@ module Aws::S3
|
|
3381
3383
|
# Specifies the S3 bucket whose ACL is being requested.
|
3382
3384
|
#
|
3383
3385
|
# @option params [String] :expected_bucket_owner
|
3384
|
-
# The account
|
3386
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3385
3387
|
# a different account, the request will fail with an HTTP `403 (Access
|
3386
3388
|
# Denied)` error.
|
3387
3389
|
#
|
@@ -3418,7 +3420,7 @@ module Aws::S3
|
|
3418
3420
|
req.send_request(options)
|
3419
3421
|
end
|
3420
3422
|
|
3421
|
-
# This implementation of the GET
|
3423
|
+
# This implementation of the GET action returns an analytics
|
3422
3424
|
# configuration (identified by the analytics configuration ID) from the
|
3423
3425
|
# bucket.
|
3424
3426
|
#
|
@@ -3427,12 +3429,11 @@ module Aws::S3
|
|
3427
3429
|
# permission by default. The bucket owner can grant this permission to
|
3428
3430
|
# others. For more information about permissions, see [ Permissions
|
3429
3431
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3430
|
-
# Permissions to Your Amazon S3 Resources][2] in the *Amazon
|
3431
|
-
#
|
3432
|
+
# Permissions to Your Amazon S3 Resources][2] in the *Amazon S3 User
|
3433
|
+
# Guide*.
|
3432
3434
|
#
|
3433
3435
|
# For information about Amazon S3 analytics feature, see [Amazon S3
|
3434
|
-
# Analytics – Storage Class Analysis][3] in the *Amazon
|
3435
|
-
# Service Developer Guide*.
|
3436
|
+
# Analytics – Storage Class Analysis][3] in the *Amazon S3 User Guide*.
|
3436
3437
|
#
|
3437
3438
|
# **Related Resources**
|
3438
3439
|
#
|
@@ -3444,8 +3445,8 @@ module Aws::S3
|
|
3444
3445
|
#
|
3445
3446
|
#
|
3446
3447
|
#
|
3447
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3448
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3448
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3449
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3449
3450
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
3450
3451
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
3451
3452
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -3459,7 +3460,7 @@ module Aws::S3
|
|
3459
3460
|
# The ID that identifies the analytics configuration.
|
3460
3461
|
#
|
3461
3462
|
# @option params [String] :expected_bucket_owner
|
3462
|
-
# The account
|
3463
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3463
3464
|
# a different account, the request will fail with an HTTP `403 (Access
|
3464
3465
|
# Denied)` error.
|
3465
3466
|
#
|
@@ -3525,7 +3526,7 @@ module Aws::S3
|
|
3525
3526
|
# The bucket name for which to get the cors configuration.
|
3526
3527
|
#
|
3527
3528
|
# @option params [String] :expected_bucket_owner
|
3528
|
-
# The account
|
3529
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3529
3530
|
# a different account, the request will fail with an HTTP `403 (Access
|
3530
3531
|
# Denied)` error.
|
3531
3532
|
#
|
@@ -3570,6 +3571,7 @@ module Aws::S3
|
|
3570
3571
|
# @example Response structure
|
3571
3572
|
#
|
3572
3573
|
# resp.cors_rules #=> Array
|
3574
|
+
# resp.cors_rules[0].id #=> String
|
3573
3575
|
# resp.cors_rules[0].allowed_headers #=> Array
|
3574
3576
|
# resp.cors_rules[0].allowed_headers[0] #=> String
|
3575
3577
|
# resp.cors_rules[0].allowed_methods #=> Array
|
@@ -3590,6 +3592,10 @@ module Aws::S3
|
|
3590
3592
|
end
|
3591
3593
|
|
3592
3594
|
# Returns the default encryption configuration for an Amazon S3 bucket.
|
3595
|
+
# If the bucket does not have a default encryption configuration,
|
3596
|
+
# GetBucketEncryption returns
|
3597
|
+
# `ServerSideEncryptionConfigurationNotFoundError`.
|
3598
|
+
#
|
3593
3599
|
# For information about the Amazon S3 default encryption feature, see
|
3594
3600
|
# [Amazon S3 Default Bucket Encryption][1].
|
3595
3601
|
#
|
@@ -3609,8 +3615,8 @@ module Aws::S3
|
|
3609
3615
|
#
|
3610
3616
|
#
|
3611
3617
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
3612
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3613
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3618
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3619
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3614
3620
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
3615
3621
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
3616
3622
|
#
|
@@ -3619,7 +3625,7 @@ module Aws::S3
|
|
3619
3625
|
# configuration is retrieved.
|
3620
3626
|
#
|
3621
3627
|
# @option params [String] :expected_bucket_owner
|
3622
|
-
# The account
|
3628
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3623
3629
|
# a different account, the request will fail with an HTTP `403 (Access
|
3624
3630
|
# Denied)` error.
|
3625
3631
|
#
|
@@ -3753,8 +3759,8 @@ module Aws::S3
|
|
3753
3759
|
#
|
3754
3760
|
#
|
3755
3761
|
#
|
3756
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3757
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3762
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3763
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3758
3764
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
3759
3765
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
3760
3766
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -3768,7 +3774,7 @@ module Aws::S3
|
|
3768
3774
|
# The ID used to identify the inventory configuration.
|
3769
3775
|
#
|
3770
3776
|
# @option params [String] :expected_bucket_owner
|
3771
|
-
# The account
|
3777
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3772
3778
|
# a different account, the request will fail with an HTTP `403 (Access
|
3773
3779
|
# Denied)` error.
|
3774
3780
|
#
|
@@ -3847,8 +3853,8 @@ module Aws::S3
|
|
3847
3853
|
#
|
3848
3854
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
3849
3855
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3850
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3851
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3856
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3857
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3852
3858
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3853
3859
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3854
3860
|
#
|
@@ -3856,7 +3862,7 @@ module Aws::S3
|
|
3856
3862
|
# The name of the bucket for which to get the lifecycle information.
|
3857
3863
|
#
|
3858
3864
|
# @option params [String] :expected_bucket_owner
|
3859
|
-
# The account
|
3865
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3860
3866
|
# a different account, the request will fail with an HTTP `403 (Access
|
3861
3867
|
# Denied)` error.
|
3862
3868
|
#
|
@@ -3926,7 +3932,7 @@ module Aws::S3
|
|
3926
3932
|
# API. The response describes the new filter element that you can use to
|
3927
3933
|
# specify a filter to select a subset of objects to which the rule
|
3928
3934
|
# applies. If you are using a previous version of the lifecycle
|
3929
|
-
# configuration, it still works. For the earlier
|
3935
|
+
# configuration, it still works. For the earlier action, see
|
3930
3936
|
# [GetBucketLifecycle][1].
|
3931
3937
|
#
|
3932
3938
|
# </note>
|
@@ -3965,8 +3971,8 @@ module Aws::S3
|
|
3965
3971
|
#
|
3966
3972
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
3967
3973
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3968
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3969
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3974
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3975
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3970
3976
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3971
3977
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3972
3978
|
#
|
@@ -3974,7 +3980,7 @@ module Aws::S3
|
|
3974
3980
|
# The name of the bucket for which to get the lifecycle information.
|
3975
3981
|
#
|
3976
3982
|
# @option params [String] :expected_bucket_owner
|
3977
|
-
# The account
|
3983
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3978
3984
|
# a different account, the request will fail with an HTTP `403 (Access
|
3979
3985
|
# Denied)` error.
|
3980
3986
|
#
|
@@ -4072,7 +4078,7 @@ module Aws::S3
|
|
4072
4078
|
# The name of the bucket for which to get the location.
|
4073
4079
|
#
|
4074
4080
|
# @option params [String] :expected_bucket_owner
|
4075
|
-
# The account
|
4081
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4076
4082
|
# a different account, the request will fail with an HTTP `403 (Access
|
4077
4083
|
# Denied)` error.
|
4078
4084
|
#
|
@@ -4133,7 +4139,7 @@ module Aws::S3
|
|
4133
4139
|
# The bucket name for which to get the logging information.
|
4134
4140
|
#
|
4135
4141
|
# @option params [String] :expected_bucket_owner
|
4136
|
-
# The account
|
4142
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4137
4143
|
# a different account, the request will fail with an HTTP `403 (Access
|
4138
4144
|
# Denied)` error.
|
4139
4145
|
#
|
@@ -4196,8 +4202,8 @@ module Aws::S3
|
|
4196
4202
|
#
|
4197
4203
|
#
|
4198
4204
|
#
|
4199
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4200
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4205
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
4206
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4201
4207
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
4202
4208
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
4203
4209
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
@@ -4211,7 +4217,7 @@ module Aws::S3
|
|
4211
4217
|
# The ID used to identify the metrics configuration.
|
4212
4218
|
#
|
4213
4219
|
# @option params [String] :expected_bucket_owner
|
4214
|
-
# The account
|
4220
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4215
4221
|
# a different account, the request will fail with an HTTP `403 (Access
|
4216
4222
|
# Denied)` error.
|
4217
4223
|
#
|
@@ -4258,7 +4264,7 @@ module Aws::S3
|
|
4258
4264
|
# configuration.
|
4259
4265
|
#
|
4260
4266
|
# @option params [String] :expected_bucket_owner
|
4261
|
-
# The account
|
4267
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4262
4268
|
# a different account, the request will fail with an HTTP `403 (Access
|
4263
4269
|
# Denied)` error.
|
4264
4270
|
#
|
@@ -4362,8 +4368,8 @@ module Aws::S3
|
|
4362
4368
|
|
4363
4369
|
# Returns the notification configuration of a bucket.
|
4364
4370
|
#
|
4365
|
-
# If notifications are not enabled on the bucket, the
|
4366
|
-
#
|
4371
|
+
# If notifications are not enabled on the bucket, the action returns an
|
4372
|
+
# empty `NotificationConfiguration` element.
|
4367
4373
|
#
|
4368
4374
|
# By default, you must be the bucket owner to read the notification
|
4369
4375
|
# configuration of a bucket. However, the bucket owner can use a bucket
|
@@ -4375,7 +4381,7 @@ module Aws::S3
|
|
4375
4381
|
# Events][1]. For more information about bucket policies, see [Using
|
4376
4382
|
# Bucket Policies][2].
|
4377
4383
|
#
|
4378
|
-
# The following
|
4384
|
+
# The following action is related to `GetBucketNotification`\:
|
4379
4385
|
#
|
4380
4386
|
# * [PutBucketNotification][3]
|
4381
4387
|
#
|
@@ -4392,7 +4398,7 @@ module Aws::S3
|
|
4392
4398
|
# configuration.
|
4393
4399
|
#
|
4394
4400
|
# @option params [String] :expected_bucket_owner
|
4395
|
-
# The account
|
4401
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4396
4402
|
# a different account, the request will fail with an HTTP `403 (Access
|
4397
4403
|
# Denied)` error.
|
4398
4404
|
#
|
@@ -4469,7 +4475,7 @@ module Aws::S3
|
|
4469
4475
|
# retrieve.
|
4470
4476
|
#
|
4471
4477
|
# @option params [String] :expected_bucket_owner
|
4472
|
-
# The account
|
4478
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4473
4479
|
# a different account, the request will fail with an HTTP `403 (Access
|
4474
4480
|
# Denied)` error.
|
4475
4481
|
#
|
@@ -4516,7 +4522,7 @@ module Aws::S3
|
|
4516
4522
|
# For more information about bucket policies, see [Using Bucket Policies
|
4517
4523
|
# and User Policies][1].
|
4518
4524
|
#
|
4519
|
-
# The following
|
4525
|
+
# The following action is related to `GetBucketPolicy`\:
|
4520
4526
|
#
|
4521
4527
|
# * [GetObject][2]
|
4522
4528
|
#
|
@@ -4531,7 +4537,7 @@ module Aws::S3
|
|
4531
4537
|
# The bucket name for which to get the bucket policy.
|
4532
4538
|
#
|
4533
4539
|
# @option params [String] :expected_bucket_owner
|
4534
|
-
# The account
|
4540
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4535
4541
|
# a different account, the request will fail with an HTTP `403 (Access
|
4536
4542
|
# Denied)` error.
|
4537
4543
|
#
|
@@ -4606,7 +4612,7 @@ module Aws::S3
|
|
4606
4612
|
# retrieve.
|
4607
4613
|
#
|
4608
4614
|
# @option params [String] :expected_bucket_owner
|
4609
|
-
# The account
|
4615
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4610
4616
|
# a different account, the request will fail with an HTTP `403 (Access
|
4611
4617
|
# Denied)` error.
|
4612
4618
|
#
|
@@ -4643,9 +4649,9 @@ module Aws::S3
|
|
4643
4649
|
# </note>
|
4644
4650
|
#
|
4645
4651
|
# For information about replication configuration, see [Replication][1]
|
4646
|
-
# in the *Amazon
|
4652
|
+
# in the *Amazon S3 User Guide*.
|
4647
4653
|
#
|
4648
|
-
# This
|
4654
|
+
# This action requires permissions for the
|
4649
4655
|
# `s3:GetReplicationConfiguration` action. For more information about
|
4650
4656
|
# permissions, see [Using Bucket Policies and User Policies][2].
|
4651
4657
|
#
|
@@ -4674,7 +4680,7 @@ module Aws::S3
|
|
4674
4680
|
# The bucket name for which to get the replication information.
|
4675
4681
|
#
|
4676
4682
|
# @option params [String] :expected_bucket_owner
|
4677
|
-
# The account
|
4683
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4678
4684
|
# a different account, the request will fail with an HTTP `403 (Access
|
4679
4685
|
# Denied)` error.
|
4680
4686
|
#
|
@@ -4773,7 +4779,7 @@ module Aws::S3
|
|
4773
4779
|
# configuration
|
4774
4780
|
#
|
4775
4781
|
# @option params [String] :expected_bucket_owner
|
4776
|
-
# The account
|
4782
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4777
4783
|
# a different account, the request will fail with an HTTP `403 (Access
|
4778
4784
|
# Denied)` error.
|
4779
4785
|
#
|
@@ -4844,7 +4850,7 @@ module Aws::S3
|
|
4844
4850
|
# The name of the bucket for which to get the tagging information.
|
4845
4851
|
#
|
4846
4852
|
# @option params [String] :expected_bucket_owner
|
4847
|
-
# The account
|
4853
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4848
4854
|
# a different account, the request will fail with an HTTP `403 (Access
|
4849
4855
|
# Denied)` error.
|
4850
4856
|
#
|
@@ -4925,7 +4931,7 @@ module Aws::S3
|
|
4925
4931
|
# The name of the bucket for which to get the versioning information.
|
4926
4932
|
#
|
4927
4933
|
# @option params [String] :expected_bucket_owner
|
4928
|
-
# The account
|
4934
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4929
4935
|
# a different account, the request will fail with an HTTP `403 (Access
|
4930
4936
|
# Denied)` error.
|
4931
4937
|
#
|
@@ -4975,7 +4981,7 @@ module Aws::S3
|
|
4975
4981
|
# configuration. For more information about hosting websites, see
|
4976
4982
|
# [Hosting Websites on Amazon S3][1].
|
4977
4983
|
#
|
4978
|
-
# This GET
|
4984
|
+
# This GET action requires the `S3:GetBucketWebsite` permission. By
|
4979
4985
|
# default, only the bucket owner can read the bucket website
|
4980
4986
|
# configuration. However, bucket owners can allow other users to read
|
4981
4987
|
# the website configuration by writing a bucket policy granting them the
|
@@ -4997,7 +5003,7 @@ module Aws::S3
|
|
4997
5003
|
# The bucket name for which to get the website configuration.
|
4998
5004
|
#
|
4999
5005
|
# @option params [String] :expected_bucket_owner
|
5000
|
-
# The account
|
5006
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5001
5007
|
# a different account, the request will fail with an HTTP `403 (Access
|
5002
5008
|
# Denied)` error.
|
5003
5009
|
#
|
@@ -5087,9 +5093,9 @@ module Aws::S3
|
|
5087
5093
|
# Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive
|
5088
5094
|
# or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve
|
5089
5095
|
# the object you must first restore a copy using [RestoreObject][4].
|
5090
|
-
# Otherwise, this
|
5091
|
-
#
|
5092
|
-
#
|
5096
|
+
# Otherwise, this action returns an `InvalidObjectStateError` error. For
|
5097
|
+
# information about restoring archived objects, see [Restoring Archived
|
5098
|
+
# Objects][5].
|
5093
5099
|
#
|
5094
5100
|
# Encryption request headers, like `x-amz-server-side-encryption`,
|
5095
5101
|
# should not be sent for GET requests if your object uses server-side
|
@@ -5133,9 +5139,8 @@ module Aws::S3
|
|
5133
5139
|
#
|
5134
5140
|
# **Versioning**
|
5135
5141
|
#
|
5136
|
-
# By default, the GET
|
5137
|
-
#
|
5138
|
-
# subresource.
|
5142
|
+
# By default, the GET action returns the current version of an object.
|
5143
|
+
# To return a different version, use the `versionId` subresource.
|
5139
5144
|
#
|
5140
5145
|
# <note markdown="1"> If the current version of the object is a delete marker, Amazon S3
|
5141
5146
|
# behaves as if the object was deleted and includes
|
@@ -5220,27 +5225,27 @@ module Aws::S3
|
|
5220
5225
|
# @option params [required, String] :bucket
|
5221
5226
|
# The bucket name containing the object.
|
5222
5227
|
#
|
5223
|
-
# When using this
|
5224
|
-
# the access point hostname. The access point hostname takes the form
|
5228
|
+
# When using this action with an access point, you must direct requests
|
5229
|
+
# to the access point hostname. The access point hostname takes the form
|
5225
5230
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5226
|
-
# When using this
|
5227
|
-
#
|
5231
|
+
# When using this action with an access point through the AWS SDKs, you
|
5232
|
+
# provide the access point ARN in place of the bucket name. For more
|
5228
5233
|
# information about access point ARNs, see [Using Access Points][1] in
|
5229
5234
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5230
5235
|
#
|
5231
|
-
# When using this
|
5236
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5232
5237
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5233
5238
|
# takes the form
|
5234
5239
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5235
|
-
# When using this
|
5236
|
-
#
|
5237
|
-
#
|
5238
|
-
#
|
5240
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5241
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5242
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5243
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
5239
5244
|
#
|
5240
5245
|
#
|
5241
5246
|
#
|
5242
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5243
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5247
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5248
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5244
5249
|
#
|
5245
5250
|
# @option params [String] :if_match
|
5246
5251
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -5297,14 +5302,14 @@ module Aws::S3
|
|
5297
5302
|
# VersionId used to reference a specific version of the object.
|
5298
5303
|
#
|
5299
5304
|
# @option params [String] :sse_customer_algorithm
|
5300
|
-
# Specifies the algorithm to use to when
|
5305
|
+
# Specifies the algorithm to use to when decrypting the object (for
|
5301
5306
|
# example, AES256).
|
5302
5307
|
#
|
5303
5308
|
# @option params [String] :sse_customer_key
|
5304
|
-
# Specifies the customer-provided encryption key for Amazon S3 to
|
5305
|
-
#
|
5306
|
-
#
|
5307
|
-
# be appropriate for use with the algorithm specified in the
|
5309
|
+
# Specifies the customer-provided encryption key for Amazon S3 used to
|
5310
|
+
# encrypt the data. This value is used to decrypt the object when
|
5311
|
+
# recovering it and must match the one used when storing the data. The
|
5312
|
+
# key must be appropriate for use with the algorithm specified in the
|
5308
5313
|
# `x-amz-server-side-encryption-customer-algorithm` header.
|
5309
5314
|
#
|
5310
5315
|
# @option params [String] :sse_customer_key_md5
|
@@ -5330,7 +5335,7 @@ module Aws::S3
|
|
5330
5335
|
# object.
|
5331
5336
|
#
|
5332
5337
|
# @option params [String] :expected_bucket_owner
|
5333
|
-
# The account
|
5338
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5334
5339
|
# a different account, the request will fail with an HTTP `403 (Access
|
5335
5340
|
# Denied)` error.
|
5336
5341
|
#
|
@@ -5371,49 +5376,49 @@ module Aws::S3
|
|
5371
5376
|
# * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String
|
5372
5377
|
#
|
5373
5378
|
#
|
5374
|
-
# @example Example: To retrieve
|
5379
|
+
# @example Example: To retrieve an object
|
5375
5380
|
#
|
5376
|
-
# # The following example retrieves an object for an S3 bucket.
|
5377
|
-
# # specific byte range.
|
5381
|
+
# # The following example retrieves an object for an S3 bucket.
|
5378
5382
|
#
|
5379
5383
|
# resp = client.get_object({
|
5380
5384
|
# bucket: "examplebucket",
|
5381
|
-
# key: "
|
5382
|
-
# range: "bytes=0-9",
|
5385
|
+
# key: "HappyFace.jpg",
|
5383
5386
|
# })
|
5384
5387
|
#
|
5385
5388
|
# resp.to_h outputs the following:
|
5386
5389
|
# {
|
5387
5390
|
# accept_ranges: "bytes",
|
5388
|
-
# content_length:
|
5389
|
-
#
|
5390
|
-
#
|
5391
|
-
#
|
5392
|
-
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5391
|
+
# content_length: 3191,
|
5392
|
+
# content_type: "image/jpeg",
|
5393
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
5394
|
+
# last_modified: Time.parse("Thu, 15 Dec 2016 01:19:41 GMT"),
|
5393
5395
|
# metadata: {
|
5394
5396
|
# },
|
5397
|
+
# tag_count: 2,
|
5395
5398
|
# version_id: "null",
|
5396
5399
|
# }
|
5397
5400
|
#
|
5398
|
-
# @example Example: To retrieve an object
|
5401
|
+
# @example Example: To retrieve a byte range of an object
|
5399
5402
|
#
|
5400
|
-
# # The following example retrieves an object for an S3 bucket.
|
5403
|
+
# # The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a
|
5404
|
+
# # specific byte range.
|
5401
5405
|
#
|
5402
5406
|
# resp = client.get_object({
|
5403
5407
|
# bucket: "examplebucket",
|
5404
|
-
# key: "
|
5408
|
+
# key: "SampleFile.txt",
|
5409
|
+
# range: "bytes=0-9",
|
5405
5410
|
# })
|
5406
5411
|
#
|
5407
5412
|
# resp.to_h outputs the following:
|
5408
5413
|
# {
|
5409
5414
|
# accept_ranges: "bytes",
|
5410
|
-
# content_length:
|
5411
|
-
#
|
5412
|
-
#
|
5413
|
-
#
|
5415
|
+
# content_length: 10,
|
5416
|
+
# content_range: "bytes 0-9/43",
|
5417
|
+
# content_type: "text/plain",
|
5418
|
+
# etag: "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
|
5419
|
+
# last_modified: Time.parse("Thu, 09 Oct 2014 22:57:28 GMT"),
|
5414
5420
|
# metadata: {
|
5415
5421
|
# },
|
5416
|
-
# tag_count: 2,
|
5417
5422
|
# version_id: "null",
|
5418
5423
|
# }
|
5419
5424
|
#
|
@@ -5546,17 +5551,17 @@ module Aws::S3
|
|
5546
5551
|
# The bucket name that contains the object for which to get the ACL
|
5547
5552
|
# information.
|
5548
5553
|
#
|
5549
|
-
# When using this
|
5550
|
-
# the access point hostname. The access point hostname takes the form
|
5554
|
+
# When using this action with an access point, you must direct requests
|
5555
|
+
# to the access point hostname. The access point hostname takes the form
|
5551
5556
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5552
|
-
# When using this
|
5553
|
-
#
|
5557
|
+
# When using this action with an access point through the AWS SDKs, you
|
5558
|
+
# provide the access point ARN in place of the bucket name. For more
|
5554
5559
|
# information about access point ARNs, see [Using Access Points][1] in
|
5555
5560
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5556
5561
|
#
|
5557
5562
|
#
|
5558
5563
|
#
|
5559
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5564
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5560
5565
|
#
|
5561
5566
|
# @option params [required, String] :key
|
5562
5567
|
# The key of the object for which to get the ACL information.
|
@@ -5576,7 +5581,7 @@ module Aws::S3
|
|
5576
5581
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5577
5582
|
#
|
5578
5583
|
# @option params [String] :expected_bucket_owner
|
5579
|
-
# The account
|
5584
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5580
5585
|
# a different account, the request will fail with an HTTP `403 (Access
|
5581
5586
|
# Denied)` error.
|
5582
5587
|
#
|
@@ -5683,17 +5688,17 @@ module Aws::S3
|
|
5683
5688
|
# The bucket name containing the object whose Legal Hold status you want
|
5684
5689
|
# to retrieve.
|
5685
5690
|
#
|
5686
|
-
# When using this
|
5687
|
-
# the access point hostname. The access point hostname takes the form
|
5691
|
+
# When using this action with an access point, you must direct requests
|
5692
|
+
# to the access point hostname. The access point hostname takes the form
|
5688
5693
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5689
|
-
# When using this
|
5690
|
-
#
|
5694
|
+
# When using this action with an access point through the AWS SDKs, you
|
5695
|
+
# provide the access point ARN in place of the bucket name. For more
|
5691
5696
|
# information about access point ARNs, see [Using Access Points][1] in
|
5692
5697
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5693
5698
|
#
|
5694
5699
|
#
|
5695
5700
|
#
|
5696
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5701
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5697
5702
|
#
|
5698
5703
|
# @option params [required, String] :key
|
5699
5704
|
# The key name for the object whose Legal Hold status you want to
|
@@ -5715,7 +5720,7 @@ module Aws::S3
|
|
5715
5720
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5716
5721
|
#
|
5717
5722
|
# @option params [String] :expected_bucket_owner
|
5718
|
-
# The account
|
5723
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5719
5724
|
# a different account, the request will fail with an HTTP `403 (Access
|
5720
5725
|
# Denied)` error.
|
5721
5726
|
#
|
@@ -5758,20 +5763,20 @@ module Aws::S3
|
|
5758
5763
|
# @option params [required, String] :bucket
|
5759
5764
|
# The bucket whose Object Lock configuration you want to retrieve.
|
5760
5765
|
#
|
5761
|
-
# When using this
|
5762
|
-
# the access point hostname. The access point hostname takes the form
|
5766
|
+
# When using this action with an access point, you must direct requests
|
5767
|
+
# to the access point hostname. The access point hostname takes the form
|
5763
5768
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5764
|
-
# When using this
|
5765
|
-
#
|
5769
|
+
# When using this action with an access point through the AWS SDKs, you
|
5770
|
+
# provide the access point ARN in place of the bucket name. For more
|
5766
5771
|
# information about access point ARNs, see [Using Access Points][1] in
|
5767
5772
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5768
5773
|
#
|
5769
5774
|
#
|
5770
5775
|
#
|
5771
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5776
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5772
5777
|
#
|
5773
5778
|
# @option params [String] :expected_bucket_owner
|
5774
|
-
# The account
|
5779
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5775
5780
|
# a different account, the request will fail with an HTTP `403 (Access
|
5776
5781
|
# Denied)` error.
|
5777
5782
|
#
|
@@ -5815,17 +5820,17 @@ module Aws::S3
|
|
5815
5820
|
# The bucket name containing the object whose retention settings you
|
5816
5821
|
# want to retrieve.
|
5817
5822
|
#
|
5818
|
-
# When using this
|
5819
|
-
# the access point hostname. The access point hostname takes the form
|
5823
|
+
# When using this action with an access point, you must direct requests
|
5824
|
+
# to the access point hostname. The access point hostname takes the form
|
5820
5825
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5821
|
-
# When using this
|
5822
|
-
#
|
5826
|
+
# When using this action with an access point through the AWS SDKs, you
|
5827
|
+
# provide the access point ARN in place of the bucket name. For more
|
5823
5828
|
# information about access point ARNs, see [Using Access Points][1] in
|
5824
5829
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5825
5830
|
#
|
5826
5831
|
#
|
5827
5832
|
#
|
5828
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5833
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5829
5834
|
#
|
5830
5835
|
# @option params [required, String] :key
|
5831
5836
|
# The key name for the object whose retention settings you want to
|
@@ -5847,7 +5852,7 @@ module Aws::S3
|
|
5847
5852
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5848
5853
|
#
|
5849
5854
|
# @option params [String] :expected_bucket_owner
|
5850
|
-
# The account
|
5855
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5851
5856
|
# a different account, the request will fail with an HTTP `403 (Access
|
5852
5857
|
# Denied)` error.
|
5853
5858
|
#
|
@@ -5883,7 +5888,7 @@ module Aws::S3
|
|
5883
5888
|
# tagging subresource associated with the object.
|
5884
5889
|
#
|
5885
5890
|
# To use this operation, you must have permission to perform the
|
5886
|
-
# `s3:GetObjectTagging` action. By default, the GET
|
5891
|
+
# `s3:GetObjectTagging` action. By default, the GET action returns
|
5887
5892
|
# information about current version of an object. For a versioned
|
5888
5893
|
# bucket, you can have multiple versions of an object in your bucket. To
|
5889
5894
|
# retrieve tags of any other version, use the versionId query parameter.
|
@@ -5895,42 +5900,43 @@ module Aws::S3
|
|
5895
5900
|
# For information about the Amazon S3 object tagging feature, see
|
5896
5901
|
# [Object Tagging][1].
|
5897
5902
|
#
|
5898
|
-
# The following
|
5903
|
+
# The following action is related to `GetObjectTagging`\:
|
5899
5904
|
#
|
5900
5905
|
# * [PutObjectTagging][2]
|
5901
5906
|
#
|
5902
|
-
#
|
5907
|
+
# * [DeleteObjectTagging][3]
|
5903
5908
|
#
|
5904
5909
|
#
|
5905
5910
|
#
|
5906
5911
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
5907
5912
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html
|
5913
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html
|
5908
5914
|
#
|
5909
5915
|
# @option params [required, String] :bucket
|
5910
5916
|
# The bucket name containing the object for which to get the tagging
|
5911
5917
|
# information.
|
5912
5918
|
#
|
5913
|
-
# When using this
|
5914
|
-
# the access point hostname. The access point hostname takes the form
|
5919
|
+
# When using this action with an access point, you must direct requests
|
5920
|
+
# to the access point hostname. The access point hostname takes the form
|
5915
5921
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5916
|
-
# When using this
|
5917
|
-
#
|
5922
|
+
# When using this action with an access point through the AWS SDKs, you
|
5923
|
+
# provide the access point ARN in place of the bucket name. For more
|
5918
5924
|
# information about access point ARNs, see [Using Access Points][1] in
|
5919
5925
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5920
5926
|
#
|
5921
|
-
# When using this
|
5927
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5922
5928
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5923
5929
|
# takes the form
|
5924
5930
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5925
|
-
# When using this
|
5926
|
-
#
|
5927
|
-
#
|
5928
|
-
#
|
5931
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5932
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5933
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5934
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
5929
5935
|
#
|
5930
5936
|
#
|
5931
5937
|
#
|
5932
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5933
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5938
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5939
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5934
5940
|
#
|
5935
5941
|
# @option params [required, String] :key
|
5936
5942
|
# Object key for which to get the tagging information.
|
@@ -5939,59 +5945,70 @@ module Aws::S3
|
|
5939
5945
|
# The versionId of the object for which to get the tagging information.
|
5940
5946
|
#
|
5941
5947
|
# @option params [String] :expected_bucket_owner
|
5942
|
-
# The account
|
5948
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5943
5949
|
# a different account, the request will fail with an HTTP `403 (Access
|
5944
5950
|
# Denied)` error.
|
5945
5951
|
#
|
5952
|
+
# @option params [String] :request_payer
|
5953
|
+
# Confirms that the requester knows that they will be charged for the
|
5954
|
+
# request. Bucket owners need not specify this parameter in their
|
5955
|
+
# requests. For information about downloading objects from requester
|
5956
|
+
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5957
|
+
# in the *Amazon S3 Developer Guide*.
|
5958
|
+
#
|
5959
|
+
#
|
5960
|
+
#
|
5961
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5962
|
+
#
|
5946
5963
|
# @return [Types::GetObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5947
5964
|
#
|
5948
5965
|
# * {Types::GetObjectTaggingOutput#version_id #version_id} => String
|
5949
5966
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
5950
5967
|
#
|
5951
5968
|
#
|
5952
|
-
# @example Example: To retrieve tag set of
|
5969
|
+
# @example Example: To retrieve tag set of a specific object version
|
5953
5970
|
#
|
5954
|
-
# # The following example retrieves tag set of an object.
|
5971
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
5955
5972
|
#
|
5956
5973
|
# resp = client.get_object_tagging({
|
5957
5974
|
# bucket: "examplebucket",
|
5958
|
-
# key: "
|
5975
|
+
# key: "exampleobject",
|
5976
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5959
5977
|
# })
|
5960
5978
|
#
|
5961
5979
|
# resp.to_h outputs the following:
|
5962
5980
|
# {
|
5963
5981
|
# tag_set: [
|
5964
5982
|
# {
|
5965
|
-
# key: "
|
5966
|
-
# value: "
|
5967
|
-
# },
|
5968
|
-
# {
|
5969
|
-
# key: "Key3",
|
5970
|
-
# value: "Value3",
|
5983
|
+
# key: "Key1",
|
5984
|
+
# value: "Value1",
|
5971
5985
|
# },
|
5972
5986
|
# ],
|
5973
|
-
# version_id: "
|
5987
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5974
5988
|
# }
|
5975
5989
|
#
|
5976
|
-
# @example Example: To retrieve tag set of
|
5990
|
+
# @example Example: To retrieve tag set of an object
|
5977
5991
|
#
|
5978
|
-
# # The following example retrieves tag set of an object.
|
5992
|
+
# # The following example retrieves tag set of an object.
|
5979
5993
|
#
|
5980
5994
|
# resp = client.get_object_tagging({
|
5981
5995
|
# bucket: "examplebucket",
|
5982
|
-
# key: "
|
5983
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5996
|
+
# key: "HappyFace.jpg",
|
5984
5997
|
# })
|
5985
5998
|
#
|
5986
5999
|
# resp.to_h outputs the following:
|
5987
6000
|
# {
|
5988
6001
|
# tag_set: [
|
5989
6002
|
# {
|
5990
|
-
# key: "
|
5991
|
-
# value: "
|
6003
|
+
# key: "Key4",
|
6004
|
+
# value: "Value4",
|
6005
|
+
# },
|
6006
|
+
# {
|
6007
|
+
# key: "Key3",
|
6008
|
+
# value: "Value3",
|
5992
6009
|
# },
|
5993
6010
|
# ],
|
5994
|
-
# version_id: "
|
6011
|
+
# version_id: "null",
|
5995
6012
|
# }
|
5996
6013
|
#
|
5997
6014
|
# @example Request syntax with placeholder values
|
@@ -6001,6 +6018,7 @@ module Aws::S3
|
|
6001
6018
|
# key: "ObjectKey", # required
|
6002
6019
|
# version_id: "ObjectVersionId",
|
6003
6020
|
# expected_bucket_owner: "AccountId",
|
6021
|
+
# request_payer: "requester", # accepts requester
|
6004
6022
|
# })
|
6005
6023
|
#
|
6006
6024
|
# @example Response structure
|
@@ -6033,7 +6051,7 @@ module Aws::S3
|
|
6033
6051
|
#
|
6034
6052
|
# This action is not supported by Amazon S3 on Outposts.
|
6035
6053
|
#
|
6036
|
-
# The following
|
6054
|
+
# The following action is related to `GetObjectTorrent`\:
|
6037
6055
|
#
|
6038
6056
|
# * [GetObject][2]
|
6039
6057
|
#
|
@@ -6066,7 +6084,7 @@ module Aws::S3
|
|
6066
6084
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
6067
6085
|
#
|
6068
6086
|
# @option params [String] :expected_bucket_owner
|
6069
|
-
# The account
|
6087
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6070
6088
|
# a different account, the request will fail with an HTTP `403 (Access
|
6071
6089
|
# Denied)` error.
|
6072
6090
|
#
|
@@ -6152,7 +6170,7 @@ module Aws::S3
|
|
6152
6170
|
# configuration you want to retrieve.
|
6153
6171
|
#
|
6154
6172
|
# @option params [String] :expected_bucket_owner
|
6155
|
-
# The account
|
6173
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6156
6174
|
# a different account, the request will fail with an HTTP `403 (Access
|
6157
6175
|
# Denied)` error.
|
6158
6176
|
#
|
@@ -6183,11 +6201,14 @@ module Aws::S3
|
|
6183
6201
|
req.send_request(options)
|
6184
6202
|
end
|
6185
6203
|
|
6186
|
-
# This
|
6187
|
-
# permission to access it. The
|
6188
|
-
#
|
6189
|
-
#
|
6190
|
-
#
|
6204
|
+
# This action is useful to determine if a bucket exists and you have
|
6205
|
+
# permission to access it. The action returns a `200 OK` if the bucket
|
6206
|
+
# exists and you have permission to access it.
|
6207
|
+
#
|
6208
|
+
# If the bucket does not exist or you do not have permission to access
|
6209
|
+
# it, the `HEAD` request returns a generic `404 Not Found` or `403
|
6210
|
+
# Forbidden` code. A message body is not included, so you cannot
|
6211
|
+
# determine the exception beyond these error codes.
|
6191
6212
|
#
|
6192
6213
|
# To use this operation, you must have permissions to perform the
|
6193
6214
|
# `s3:ListBucket` action. The bucket owner has this permission by
|
@@ -6198,36 +6219,36 @@ module Aws::S3
|
|
6198
6219
|
#
|
6199
6220
|
#
|
6200
6221
|
#
|
6201
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6202
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6222
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6223
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6203
6224
|
#
|
6204
6225
|
# @option params [required, String] :bucket
|
6205
6226
|
# The bucket name.
|
6206
6227
|
#
|
6207
|
-
# When using this
|
6208
|
-
# the access point hostname. The access point hostname takes the form
|
6228
|
+
# When using this action with an access point, you must direct requests
|
6229
|
+
# to the access point hostname. The access point hostname takes the form
|
6209
6230
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6210
|
-
# When using this
|
6211
|
-
#
|
6231
|
+
# When using this action with an access point through the AWS SDKs, you
|
6232
|
+
# provide the access point ARN in place of the bucket name. For more
|
6212
6233
|
# information about access point ARNs, see [Using Access Points][1] in
|
6213
6234
|
# the *Amazon Simple Storage Service Developer Guide*.
|
6214
6235
|
#
|
6215
|
-
# When using this
|
6236
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6216
6237
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6217
6238
|
# takes the form
|
6218
6239
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6219
|
-
# When using this
|
6220
|
-
#
|
6221
|
-
#
|
6222
|
-
#
|
6240
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6241
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6242
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6243
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
6223
6244
|
#
|
6224
6245
|
#
|
6225
6246
|
#
|
6226
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6227
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6247
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6248
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6228
6249
|
#
|
6229
6250
|
# @option params [String] :expected_bucket_owner
|
6230
|
-
# The account
|
6251
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6231
6252
|
# a different account, the request will fail with an HTTP `403 (Access
|
6232
6253
|
# Denied)` error.
|
6233
6254
|
#
|
@@ -6264,14 +6285,17 @@ module Aws::S3
|
|
6264
6285
|
req.send_request(options)
|
6265
6286
|
end
|
6266
6287
|
|
6267
|
-
# The HEAD
|
6268
|
-
# the object itself. This
|
6269
|
-
#
|
6270
|
-
#
|
6271
|
-
#
|
6272
|
-
# A `HEAD` request has the same options as a `GET`
|
6273
|
-
#
|
6274
|
-
#
|
6288
|
+
# The HEAD action retrieves metadata from an object without returning
|
6289
|
+
# the object itself. This action is useful if you're only interested in
|
6290
|
+
# an object's metadata. To use HEAD, you must have READ access to the
|
6291
|
+
# object.
|
6292
|
+
#
|
6293
|
+
# A `HEAD` request has the same options as a `GET` action on an object.
|
6294
|
+
# The response is identical to the `GET` response except that there is
|
6295
|
+
# no response body. Because of this, if the `HEAD` request generates an
|
6296
|
+
# error, it returns a generic `404 Not Found` or `403 Forbidden` code.
|
6297
|
+
# It is not possible to retrieve the exact exception beyond these error
|
6298
|
+
# codes.
|
6275
6299
|
#
|
6276
6300
|
# If you encrypt an object by using server-side encryption with
|
6277
6301
|
# customer-provided encryption keys (SSE-C) when you store the object in
|
@@ -6287,12 +6311,15 @@ module Aws::S3
|
|
6287
6311
|
# For more information about SSE-C, see [Server-Side Encryption (Using
|
6288
6312
|
# Customer-Provided Encryption Keys)][1].
|
6289
6313
|
#
|
6290
|
-
# <note markdown="1"> Encryption request headers, like `x-amz-server-side-encryption`,
|
6291
|
-
#
|
6292
|
-
#
|
6293
|
-
#
|
6294
|
-
#
|
6295
|
-
# error.
|
6314
|
+
# <note markdown="1"> * Encryption request headers, like `x-amz-server-side-encryption`,
|
6315
|
+
# should not be sent for GET requests if your object uses server-side
|
6316
|
+
# encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side
|
6317
|
+
# encryption with Amazon S3–managed encryption keys (SSE-S3). If your
|
6318
|
+
# object does use these types of keys, you’ll get an HTTP 400
|
6319
|
+
# BadRequest error.
|
6320
|
+
#
|
6321
|
+
# * The last modified property in this case is the creation date of the
|
6322
|
+
# object.
|
6296
6323
|
#
|
6297
6324
|
# </note>
|
6298
6325
|
#
|
@@ -6334,7 +6361,7 @@ module Aws::S3
|
|
6334
6361
|
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
|
6335
6362
|
# an HTTP status code 403 ("access denied") error.
|
6336
6363
|
#
|
6337
|
-
# The following
|
6364
|
+
# The following action is related to `HeadObject`\:
|
6338
6365
|
#
|
6339
6366
|
# * [GetObject][5]
|
6340
6367
|
#
|
@@ -6351,27 +6378,27 @@ module Aws::S3
|
|
6351
6378
|
# @option params [required, String] :bucket
|
6352
6379
|
# The name of the bucket containing the object.
|
6353
6380
|
#
|
6354
|
-
# When using this
|
6355
|
-
# the access point hostname. The access point hostname takes the form
|
6381
|
+
# When using this action with an access point, you must direct requests
|
6382
|
+
# to the access point hostname. The access point hostname takes the form
|
6356
6383
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6357
|
-
# When using this
|
6358
|
-
#
|
6384
|
+
# When using this action with an access point through the AWS SDKs, you
|
6385
|
+
# provide the access point ARN in place of the bucket name. For more
|
6359
6386
|
# information about access point ARNs, see [Using Access Points][1] in
|
6360
6387
|
# the *Amazon Simple Storage Service Developer Guide*.
|
6361
6388
|
#
|
6362
|
-
# When using this
|
6389
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6363
6390
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6364
6391
|
# takes the form
|
6365
6392
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6366
|
-
# When using this
|
6367
|
-
#
|
6368
|
-
#
|
6369
|
-
#
|
6393
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6394
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6395
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6396
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
6370
6397
|
#
|
6371
6398
|
#
|
6372
6399
|
#
|
6373
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6374
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6400
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6401
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6375
6402
|
#
|
6376
6403
|
# @option params [String] :if_match
|
6377
6404
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -6443,7 +6470,7 @@ module Aws::S3
|
|
6443
6470
|
# the number of parts in this object.
|
6444
6471
|
#
|
6445
6472
|
# @option params [String] :expected_bucket_owner
|
6446
|
-
# The account
|
6473
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6447
6474
|
# a different account, the request will fail with an HTTP `403 (Access
|
6448
6475
|
# Denied)` error.
|
6449
6476
|
#
|
@@ -6575,15 +6602,14 @@ module Aws::S3
|
|
6575
6602
|
# Lists the analytics configurations for the bucket. You can have up to
|
6576
6603
|
# 1,000 analytics configurations per bucket.
|
6577
6604
|
#
|
6578
|
-
# This
|
6579
|
-
#
|
6580
|
-
#
|
6581
|
-
#
|
6582
|
-
#
|
6583
|
-
#
|
6584
|
-
#
|
6585
|
-
#
|
6586
|
-
# next page.
|
6605
|
+
# This action supports list pagination and does not return more than 100
|
6606
|
+
# configurations at a time. You should always check the `IsTruncated`
|
6607
|
+
# element in the response. If there are no more configurations to list,
|
6608
|
+
# `IsTruncated` is set to false. If there are more configurations to
|
6609
|
+
# list, `IsTruncated` is set to true, and there will be a value in
|
6610
|
+
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
6611
|
+
# continue the pagination of the list by passing the value in
|
6612
|
+
# continuation-token in the request to `GET` the next page.
|
6587
6613
|
#
|
6588
6614
|
# To use this operation, you must have permissions to perform the
|
6589
6615
|
# `s3:GetAnalyticsConfiguration` action. The bucket owner has this
|
@@ -6606,8 +6632,8 @@ module Aws::S3
|
|
6606
6632
|
#
|
6607
6633
|
#
|
6608
6634
|
#
|
6609
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6610
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6635
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6636
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6611
6637
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
6612
6638
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
6613
6639
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
@@ -6622,7 +6648,7 @@ module Aws::S3
|
|
6622
6648
|
# request should begin.
|
6623
6649
|
#
|
6624
6650
|
# @option params [String] :expected_bucket_owner
|
6625
|
-
# The account
|
6651
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6626
6652
|
# a different account, the request will fail with an HTTP `403 (Access
|
6627
6653
|
# Denied)` error.
|
6628
6654
|
#
|
@@ -6760,9 +6786,9 @@ module Aws::S3
|
|
6760
6786
|
# Returns a list of inventory configurations for the bucket. You can
|
6761
6787
|
# have up to 1,000 analytics configurations per bucket.
|
6762
6788
|
#
|
6763
|
-
# This
|
6764
|
-
#
|
6765
|
-
#
|
6789
|
+
# This action supports list pagination and does not return more than 100
|
6790
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6791
|
+
# the response. If there are no more configurations to list,
|
6766
6792
|
# `IsTruncated` is set to false. If there are more configurations to
|
6767
6793
|
# list, `IsTruncated` is set to true, and there is a value in
|
6768
6794
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -6790,8 +6816,8 @@ module Aws::S3
|
|
6790
6816
|
#
|
6791
6817
|
#
|
6792
6818
|
#
|
6793
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6794
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6819
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6820
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6795
6821
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
6796
6822
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
6797
6823
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
@@ -6808,7 +6834,7 @@ module Aws::S3
|
|
6808
6834
|
# token is an opaque value that Amazon S3 understands.
|
6809
6835
|
#
|
6810
6836
|
# @option params [String] :expected_bucket_owner
|
6811
|
-
# The account
|
6837
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6812
6838
|
# a different account, the request will fail with an HTTP `403 (Access
|
6813
6839
|
# Denied)` error.
|
6814
6840
|
#
|
@@ -6860,9 +6886,9 @@ module Aws::S3
|
|
6860
6886
|
# not provide information on daily storage metrics. You can have up to
|
6861
6887
|
# 1,000 configurations per bucket.
|
6862
6888
|
#
|
6863
|
-
# This
|
6864
|
-
#
|
6865
|
-
#
|
6889
|
+
# This action supports list pagination and does not return more than 100
|
6890
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6891
|
+
# the response. If there are no more configurations to list,
|
6866
6892
|
# `IsTruncated` is set to false. If there are more configurations to
|
6867
6893
|
# list, `IsTruncated` is set to true, and there is a value in
|
6868
6894
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -6890,8 +6916,8 @@ module Aws::S3
|
|
6890
6916
|
#
|
6891
6917
|
#
|
6892
6918
|
#
|
6893
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6894
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6919
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6920
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6895
6921
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
6896
6922
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
6897
6923
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
@@ -6908,7 +6934,7 @@ module Aws::S3
|
|
6908
6934
|
# continuation token is an opaque value that Amazon S3 understands.
|
6909
6935
|
#
|
6910
6936
|
# @option params [String] :expected_bucket_owner
|
6911
|
-
# The account
|
6937
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6912
6938
|
# a different account, the request will fail with an HTTP `403 (Access
|
6913
6939
|
# Denied)` error.
|
6914
6940
|
#
|
@@ -7008,20 +7034,19 @@ module Aws::S3
|
|
7008
7034
|
req.send_request(options)
|
7009
7035
|
end
|
7010
7036
|
|
7011
|
-
# This
|
7037
|
+
# This action lists in-progress multipart uploads. An in-progress
|
7012
7038
|
# multipart upload is a multipart upload that has been initiated using
|
7013
7039
|
# the Initiate Multipart Upload request, but has not yet been completed
|
7014
7040
|
# or aborted.
|
7015
7041
|
#
|
7016
|
-
# This
|
7017
|
-
#
|
7018
|
-
#
|
7019
|
-
#
|
7020
|
-
#
|
7021
|
-
#
|
7022
|
-
#
|
7023
|
-
#
|
7024
|
-
# parameters.
|
7042
|
+
# This action returns at most 1,000 multipart uploads in the response.
|
7043
|
+
# 1,000 multipart uploads is the maximum number of uploads a response
|
7044
|
+
# can include, which is also the default value. You can further limit
|
7045
|
+
# the number of uploads in a response by specifying the `max-uploads`
|
7046
|
+
# parameter in the response. If additional multipart uploads satisfy the
|
7047
|
+
# list criteria, the response will contain an `IsTruncated` element with
|
7048
|
+
# the value true. To list the additional multipart uploads, use the
|
7049
|
+
# `key-marker` and `upload-id-marker` request parameters.
|
7025
7050
|
#
|
7026
7051
|
# In the response, the uploads are sorted by key. If your application
|
7027
7052
|
# has initiated more than one multipart upload using the same object
|
@@ -7033,7 +7058,7 @@ module Aws::S3
|
|
7033
7058
|
# Using Multipart Upload][1].
|
7034
7059
|
#
|
7035
7060
|
# For information on permissions required to use the multipart upload
|
7036
|
-
# API, see [Multipart Upload
|
7061
|
+
# API, see [Multipart Upload and Permissions][2].
|
7037
7062
|
#
|
7038
7063
|
# The following operations are related to `ListMultipartUploads`\:
|
7039
7064
|
#
|
@@ -7060,27 +7085,27 @@ module Aws::S3
|
|
7060
7085
|
# @option params [required, String] :bucket
|
7061
7086
|
# The name of the bucket to which the multipart upload was initiated.
|
7062
7087
|
#
|
7063
|
-
# When using this
|
7064
|
-
# the access point hostname. The access point hostname takes the form
|
7088
|
+
# When using this action with an access point, you must direct requests
|
7089
|
+
# to the access point hostname. The access point hostname takes the form
|
7065
7090
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7066
|
-
# When using this
|
7067
|
-
#
|
7091
|
+
# When using this action with an access point through the AWS SDKs, you
|
7092
|
+
# provide the access point ARN in place of the bucket name. For more
|
7068
7093
|
# information about access point ARNs, see [Using Access Points][1] in
|
7069
7094
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7070
7095
|
#
|
7071
|
-
# When using this
|
7096
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7072
7097
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7073
7098
|
# takes the form
|
7074
7099
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7075
|
-
# When using this
|
7076
|
-
#
|
7077
|
-
#
|
7078
|
-
#
|
7100
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7101
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7102
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7103
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7079
7104
|
#
|
7080
7105
|
#
|
7081
7106
|
#
|
7082
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7083
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7107
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7108
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7084
7109
|
#
|
7085
7110
|
# @option params [String] :delimiter
|
7086
7111
|
# Character you use to group keys.
|
@@ -7133,7 +7158,7 @@ module Aws::S3
|
|
7133
7158
|
# specified `upload-id-marker`.
|
7134
7159
|
#
|
7135
7160
|
# @option params [String] :expected_bucket_owner
|
7136
|
-
# The account
|
7161
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7137
7162
|
# a different account, the request will fail with an HTTP `403 (Access
|
7138
7163
|
# Denied)` error.
|
7139
7164
|
#
|
@@ -7155,97 +7180,97 @@ module Aws::S3
|
|
7155
7180
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7156
7181
|
#
|
7157
7182
|
#
|
7158
|
-
# @example Example:
|
7183
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
7159
7184
|
#
|
7160
|
-
# # The following example
|
7161
|
-
# # setup of multipart uploads.
|
7185
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
7162
7186
|
#
|
7163
7187
|
# resp = client.list_multipart_uploads({
|
7164
7188
|
# bucket: "examplebucket",
|
7165
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
7166
|
-
# max_uploads: 2,
|
7167
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
7168
7189
|
# })
|
7169
7190
|
#
|
7170
7191
|
# resp.to_h outputs the following:
|
7171
7192
|
# {
|
7172
|
-
# bucket: "acl1",
|
7173
|
-
# is_truncated: true,
|
7174
|
-
# key_marker: "",
|
7175
|
-
# max_uploads: 2,
|
7176
|
-
# next_key_marker: "someobjectkey",
|
7177
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7178
|
-
# upload_id_marker: "",
|
7179
7193
|
# uploads: [
|
7180
7194
|
# {
|
7181
7195
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7182
7196
|
# initiator: {
|
7183
|
-
# display_name: "
|
7197
|
+
# display_name: "display-name",
|
7184
7198
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7185
7199
|
# },
|
7186
7200
|
# key: "JavaFile",
|
7187
7201
|
# owner: {
|
7188
|
-
# display_name: "
|
7189
|
-
# id: "
|
7202
|
+
# display_name: "display-name",
|
7203
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7190
7204
|
# },
|
7191
7205
|
# storage_class: "STANDARD",
|
7192
|
-
# upload_id: "
|
7206
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7193
7207
|
# },
|
7194
7208
|
# {
|
7195
7209
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7196
7210
|
# initiator: {
|
7197
|
-
# display_name: "
|
7211
|
+
# display_name: "display-name",
|
7198
7212
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7199
7213
|
# },
|
7200
7214
|
# key: "JavaFile",
|
7201
7215
|
# owner: {
|
7202
|
-
# display_name: "
|
7216
|
+
# display_name: "display-name",
|
7203
7217
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7204
7218
|
# },
|
7205
7219
|
# storage_class: "STANDARD",
|
7206
|
-
# upload_id: "
|
7220
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7207
7221
|
# },
|
7208
7222
|
# ],
|
7209
7223
|
# }
|
7210
7224
|
#
|
7211
|
-
# @example Example:
|
7225
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
7212
7226
|
#
|
7213
|
-
# # The following example
|
7227
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
7228
|
+
# # setup of multipart uploads.
|
7214
7229
|
#
|
7215
7230
|
# resp = client.list_multipart_uploads({
|
7216
7231
|
# bucket: "examplebucket",
|
7232
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
7233
|
+
# max_uploads: 2,
|
7234
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
7217
7235
|
# })
|
7218
7236
|
#
|
7219
7237
|
# resp.to_h outputs the following:
|
7220
7238
|
# {
|
7239
|
+
# bucket: "acl1",
|
7240
|
+
# is_truncated: true,
|
7241
|
+
# key_marker: "",
|
7242
|
+
# max_uploads: 2,
|
7243
|
+
# next_key_marker: "someobjectkey",
|
7244
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7245
|
+
# upload_id_marker: "",
|
7221
7246
|
# uploads: [
|
7222
7247
|
# {
|
7223
7248
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7224
7249
|
# initiator: {
|
7225
|
-
# display_name: "display-name",
|
7250
|
+
# display_name: "ownder-display-name",
|
7226
7251
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7227
7252
|
# },
|
7228
7253
|
# key: "JavaFile",
|
7229
7254
|
# owner: {
|
7230
|
-
# display_name: "
|
7231
|
-
# id: "
|
7255
|
+
# display_name: "mohanataws",
|
7256
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7232
7257
|
# },
|
7233
7258
|
# storage_class: "STANDARD",
|
7234
|
-
# upload_id: "
|
7259
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7235
7260
|
# },
|
7236
7261
|
# {
|
7237
7262
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7238
7263
|
# initiator: {
|
7239
|
-
# display_name: "display-name",
|
7264
|
+
# display_name: "ownder-display-name",
|
7240
7265
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7241
7266
|
# },
|
7242
7267
|
# key: "JavaFile",
|
7243
7268
|
# owner: {
|
7244
|
-
# display_name: "display-name",
|
7269
|
+
# display_name: "ownder-display-name",
|
7245
7270
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7246
7271
|
# },
|
7247
7272
|
# storage_class: "STANDARD",
|
7248
|
-
# upload_id: "
|
7273
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7249
7274
|
# },
|
7250
7275
|
# ],
|
7251
7276
|
# }
|
@@ -7351,7 +7376,7 @@ module Aws::S3
|
|
7351
7376
|
#
|
7352
7377
|
# @option params [Integer] :max_keys
|
7353
7378
|
# Sets the maximum number of keys returned in the response. By default
|
7354
|
-
# the
|
7379
|
+
# the action returns up to 1,000 key names. The response might contain
|
7355
7380
|
# fewer keys but will never contain more. If additional keys satisfy the
|
7356
7381
|
# search criteria, but were not returned because max-keys was exceeded,
|
7357
7382
|
# the response contains <isTruncated>true</isTruncated>. To
|
@@ -7369,7 +7394,7 @@ module Aws::S3
|
|
7369
7394
|
# Specifies the object version you want to start listing from.
|
7370
7395
|
#
|
7371
7396
|
# @option params [String] :expected_bucket_owner
|
7372
|
-
# The account
|
7397
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7373
7398
|
# a different account, the request will fail with an HTTP `403 (Access
|
7374
7399
|
# Denied)` error.
|
7375
7400
|
#
|
@@ -7495,7 +7520,7 @@ module Aws::S3
|
|
7495
7520
|
# invalid XML. Be sure to design your application to parse the contents
|
7496
7521
|
# of the response and handle it appropriately.
|
7497
7522
|
#
|
7498
|
-
# This
|
7523
|
+
# This action has been revised. We recommend that you use the newer
|
7499
7524
|
# version, [ListObjectsV2][1], when developing applications. For
|
7500
7525
|
# backward compatibility, Amazon S3 continues to support `ListObjects`.
|
7501
7526
|
#
|
@@ -7522,27 +7547,27 @@ module Aws::S3
|
|
7522
7547
|
# @option params [required, String] :bucket
|
7523
7548
|
# The name of the bucket containing the objects.
|
7524
7549
|
#
|
7525
|
-
# When using this
|
7526
|
-
# the access point hostname. The access point hostname takes the form
|
7550
|
+
# When using this action with an access point, you must direct requests
|
7551
|
+
# to the access point hostname. The access point hostname takes the form
|
7527
7552
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7528
|
-
# When using this
|
7529
|
-
#
|
7553
|
+
# When using this action with an access point through the AWS SDKs, you
|
7554
|
+
# provide the access point ARN in place of the bucket name. For more
|
7530
7555
|
# information about access point ARNs, see [Using Access Points][1] in
|
7531
7556
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7532
7557
|
#
|
7533
|
-
# When using this
|
7558
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7534
7559
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7535
7560
|
# takes the form
|
7536
7561
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7537
|
-
# When using this
|
7538
|
-
#
|
7539
|
-
#
|
7540
|
-
#
|
7562
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7563
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7564
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7565
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7541
7566
|
#
|
7542
7567
|
#
|
7543
7568
|
#
|
7544
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7545
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7569
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7570
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7546
7571
|
#
|
7547
7572
|
# @option params [String] :delimiter
|
7548
7573
|
# A delimiter is a character you use to group keys.
|
@@ -7560,7 +7585,7 @@ module Aws::S3
|
|
7560
7585
|
#
|
7561
7586
|
# @option params [Integer] :max_keys
|
7562
7587
|
# Sets the maximum number of keys returned in the response. By default
|
7563
|
-
# the
|
7588
|
+
# the action returns up to 1,000 key names. The response might contain
|
7564
7589
|
# fewer keys but will never contain more.
|
7565
7590
|
#
|
7566
7591
|
# @option params [String] :prefix
|
@@ -7572,7 +7597,7 @@ module Aws::S3
|
|
7572
7597
|
# parameter in their requests.
|
7573
7598
|
#
|
7574
7599
|
# @option params [String] :expected_bucket_owner
|
7575
|
-
# The account
|
7600
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7576
7601
|
# a different account, the request will fail with an HTTP `403 (Access
|
7577
7602
|
# Denied)` error.
|
7578
7603
|
#
|
@@ -7677,20 +7702,22 @@ module Aws::S3
|
|
7677
7702
|
# use the request parameters as selection criteria to return a subset of
|
7678
7703
|
# the objects in a bucket. A `200 OK` response can contain valid or
|
7679
7704
|
# invalid XML. Make sure to design your application to parse the
|
7680
|
-
# contents of the response and handle it appropriately.
|
7705
|
+
# contents of the response and handle it appropriately. Objects are
|
7706
|
+
# returned sorted in an ascending order of the respective key names in
|
7707
|
+
# the list.
|
7681
7708
|
#
|
7682
7709
|
# To use this operation, you must have READ access to the bucket.
|
7683
7710
|
#
|
7684
|
-
# To use this
|
7711
|
+
# To use this action in an AWS Identity and Access Management (IAM)
|
7685
7712
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
7686
7713
|
# action. The bucket owner has this permission by default and can grant
|
7687
7714
|
# this permission to others. For more information about permissions, see
|
7688
7715
|
# [Permissions Related to Bucket Subresource Operations][1] and
|
7689
7716
|
# [Managing Access Permissions to Your Amazon S3 Resources][2].
|
7690
7717
|
#
|
7691
|
-
# This section describes the latest revision of
|
7692
|
-
# that you use this revised API for application development.
|
7693
|
-
# backward compatibility, Amazon S3 continues to support the prior
|
7718
|
+
# This section describes the latest revision of this action. We
|
7719
|
+
# recommend that you use this revised API for application development.
|
7720
|
+
# For backward compatibility, Amazon S3 continues to support the prior
|
7694
7721
|
# version of this API, [ListObjects][3].
|
7695
7722
|
#
|
7696
7723
|
# To get a list of your buckets, see [ListBuckets][4].
|
@@ -7705,8 +7732,8 @@ module Aws::S3
|
|
7705
7732
|
#
|
7706
7733
|
#
|
7707
7734
|
#
|
7708
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7709
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7735
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7736
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7710
7737
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7711
7738
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7712
7739
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
@@ -7716,27 +7743,27 @@ module Aws::S3
|
|
7716
7743
|
# @option params [required, String] :bucket
|
7717
7744
|
# Bucket name to list.
|
7718
7745
|
#
|
7719
|
-
# When using this
|
7720
|
-
# the access point hostname. The access point hostname takes the form
|
7746
|
+
# When using this action with an access point, you must direct requests
|
7747
|
+
# to the access point hostname. The access point hostname takes the form
|
7721
7748
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7722
|
-
# When using this
|
7723
|
-
#
|
7749
|
+
# When using this action with an access point through the AWS SDKs, you
|
7750
|
+
# provide the access point ARN in place of the bucket name. For more
|
7724
7751
|
# information about access point ARNs, see [Using Access Points][1] in
|
7725
7752
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7726
7753
|
#
|
7727
|
-
# When using this
|
7754
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7728
7755
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7729
7756
|
# takes the form
|
7730
7757
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7731
|
-
# When using this
|
7732
|
-
#
|
7733
|
-
#
|
7734
|
-
#
|
7758
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7759
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7760
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7761
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7735
7762
|
#
|
7736
7763
|
#
|
7737
7764
|
#
|
7738
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7739
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7765
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7766
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7740
7767
|
#
|
7741
7768
|
# @option params [String] :delimiter
|
7742
7769
|
# A delimiter is a character you use to group keys.
|
@@ -7746,7 +7773,7 @@ module Aws::S3
|
|
7746
7773
|
#
|
7747
7774
|
# @option params [Integer] :max_keys
|
7748
7775
|
# Sets the maximum number of keys returned in the response. By default
|
7749
|
-
# the
|
7776
|
+
# the action returns up to 1,000 key names. The response might contain
|
7750
7777
|
# fewer keys but will never contain more.
|
7751
7778
|
#
|
7752
7779
|
# @option params [String] :prefix
|
@@ -7773,7 +7800,7 @@ module Aws::S3
|
|
7773
7800
|
# this parameter in their requests.
|
7774
7801
|
#
|
7775
7802
|
# @option params [String] :expected_bucket_owner
|
7776
|
-
# The account
|
7803
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7777
7804
|
# a different account, the request will fail with an HTTP `403 (Access
|
7778
7805
|
# Denied)` error.
|
7779
7806
|
#
|
@@ -7895,7 +7922,7 @@ module Aws::S3
|
|
7895
7922
|
# Using Multipart Upload][2].
|
7896
7923
|
#
|
7897
7924
|
# For information on permissions required to use the multipart upload
|
7898
|
-
# API, see [Multipart Upload
|
7925
|
+
# API, see [Multipart Upload and Permissions][3].
|
7899
7926
|
#
|
7900
7927
|
# The following operations are related to `ListParts`\:
|
7901
7928
|
#
|
@@ -7922,27 +7949,27 @@ module Aws::S3
|
|
7922
7949
|
# @option params [required, String] :bucket
|
7923
7950
|
# The name of the bucket to which the parts are being uploaded.
|
7924
7951
|
#
|
7925
|
-
# When using this
|
7926
|
-
# the access point hostname. The access point hostname takes the form
|
7952
|
+
# When using this action with an access point, you must direct requests
|
7953
|
+
# to the access point hostname. The access point hostname takes the form
|
7927
7954
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7928
|
-
# When using this
|
7929
|
-
#
|
7955
|
+
# When using this action with an access point through the AWS SDKs, you
|
7956
|
+
# provide the access point ARN in place of the bucket name. For more
|
7930
7957
|
# information about access point ARNs, see [Using Access Points][1] in
|
7931
7958
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7932
7959
|
#
|
7933
|
-
# When using this
|
7960
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7934
7961
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7935
7962
|
# takes the form
|
7936
7963
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7937
|
-
# When using this
|
7938
|
-
#
|
7939
|
-
#
|
7940
|
-
#
|
7964
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7965
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7966
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7967
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7941
7968
|
#
|
7942
7969
|
#
|
7943
7970
|
#
|
7944
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7945
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7971
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7972
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7946
7973
|
#
|
7947
7974
|
# @option params [required, String] :key
|
7948
7975
|
# Object key for which the multipart upload was initiated.
|
@@ -7970,7 +7997,7 @@ module Aws::S3
|
|
7970
7997
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
7971
7998
|
#
|
7972
7999
|
# @option params [String] :expected_bucket_owner
|
7973
|
-
# The account
|
8000
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7974
8001
|
# a different account, the request will fail with an HTTP `403 (Access
|
7975
8002
|
# Denied)` error.
|
7976
8003
|
#
|
@@ -8093,8 +8120,8 @@ module Aws::S3
|
|
8093
8120
|
#
|
8094
8121
|
# * Suspended – Disables accelerated data transfers to the bucket.
|
8095
8122
|
#
|
8096
|
-
# The [GetBucketAccelerateConfiguration][3]
|
8097
|
-
#
|
8123
|
+
# The [GetBucketAccelerateConfiguration][3] action returns the transfer
|
8124
|
+
# acceleration state of a bucket.
|
8098
8125
|
#
|
8099
8126
|
# After setting the Transfer Acceleration state of a bucket to Enabled,
|
8100
8127
|
# it might take up to thirty minutes before the data transfer rates to
|
@@ -8115,8 +8142,8 @@ module Aws::S3
|
|
8115
8142
|
#
|
8116
8143
|
#
|
8117
8144
|
#
|
8118
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8119
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8145
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8146
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8120
8147
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
8121
8148
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
8122
8149
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
@@ -8128,7 +8155,7 @@ module Aws::S3
|
|
8128
8155
|
# Container for setting the transfer acceleration state.
|
8129
8156
|
#
|
8130
8157
|
# @option params [String] :expected_bucket_owner
|
8131
|
-
# The account
|
8158
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8132
8159
|
# a different account, the request will fail with an HTTP `403 (Access
|
8133
8160
|
# Denied)` error.
|
8134
8161
|
#
|
@@ -8350,7 +8377,7 @@ module Aws::S3
|
|
8350
8377
|
# Allows grantee to write the ACL for the applicable bucket.
|
8351
8378
|
#
|
8352
8379
|
# @option params [String] :expected_bucket_owner
|
8353
|
-
# The account
|
8380
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8354
8381
|
# a different account, the request will fail with an HTTP `403 (Access
|
8355
8382
|
# Denied)` error.
|
8356
8383
|
#
|
@@ -8472,8 +8499,8 @@ module Aws::S3
|
|
8472
8499
|
#
|
8473
8500
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
8474
8501
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
8475
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8476
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8502
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8503
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8477
8504
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
8478
8505
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
8479
8506
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -8488,7 +8515,7 @@ module Aws::S3
|
|
8488
8515
|
# The configuration and any analyses for the analytics filter.
|
8489
8516
|
#
|
8490
8517
|
# @option params [String] :expected_bucket_owner
|
8491
|
-
# The account
|
8518
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8492
8519
|
# a different account, the request will fail with an HTTP `403 (Access
|
8493
8520
|
# Denied)` error.
|
8494
8521
|
#
|
@@ -8579,7 +8606,7 @@ module Aws::S3
|
|
8579
8606
|
# element.
|
8580
8607
|
#
|
8581
8608
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
8582
|
-
# Sharing][1] in the *Amazon
|
8609
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
8583
8610
|
#
|
8584
8611
|
# **Related Resources**
|
8585
8612
|
#
|
@@ -8602,8 +8629,7 @@ module Aws::S3
|
|
8602
8629
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
8603
8630
|
# Describes the cross-origin access configuration for objects in an
|
8604
8631
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8605
|
-
# Resource Sharing][1] in the *Amazon
|
8606
|
-
# Guide*.
|
8632
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
8607
8633
|
#
|
8608
8634
|
#
|
8609
8635
|
#
|
@@ -8622,7 +8648,7 @@ module Aws::S3
|
|
8622
8648
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
8623
8649
|
#
|
8624
8650
|
# @option params [String] :expected_bucket_owner
|
8625
|
-
# The account
|
8651
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8626
8652
|
# a different account, the request will fail with an HTTP `403 (Access
|
8627
8653
|
# Denied)` error.
|
8628
8654
|
#
|
@@ -8679,6 +8705,7 @@ module Aws::S3
|
|
8679
8705
|
# cors_configuration: { # required
|
8680
8706
|
# cors_rules: [ # required
|
8681
8707
|
# {
|
8708
|
+
# id: "ID",
|
8682
8709
|
# allowed_headers: ["AllowedHeader"],
|
8683
8710
|
# allowed_methods: ["AllowedMethod"], # required
|
8684
8711
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -8700,7 +8727,7 @@ module Aws::S3
|
|
8700
8727
|
req.send_request(options)
|
8701
8728
|
end
|
8702
8729
|
|
8703
|
-
# This
|
8730
|
+
# This action uses the `encryption` subresource to configure default
|
8704
8731
|
# encryption and Amazon S3 Bucket Key for an existing bucket.
|
8705
8732
|
#
|
8706
8733
|
# Default encryption for a bucket can use server-side encryption with
|
@@ -8708,36 +8735,35 @@ module Aws::S3
|
|
8708
8735
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
8709
8736
|
# also configure Amazon S3 Bucket Key. For information about default
|
8710
8737
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
8711
|
-
# *Amazon
|
8712
|
-
#
|
8713
|
-
# Simple Storage Service Developer Guide*.
|
8738
|
+
# *Amazon S3 User Guide*. For more information about S3 Bucket Keys, see
|
8739
|
+
# [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*.
|
8714
8740
|
#
|
8715
|
-
# This
|
8716
|
-
# see [ Authenticating Requests (AWS Signature Version
|
8717
|
-
# 4)](sig-v4-authenticating-requests.html).
|
8741
|
+
# This action requires AWS Signature Version 4. For more information,
|
8742
|
+
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
8718
8743
|
#
|
8719
8744
|
# To use this operation, you must have permissions to perform the
|
8720
8745
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
8721
8746
|
# permission by default. The bucket owner can grant this permission to
|
8722
8747
|
# others. For more information about permissions, see [Permissions
|
8723
|
-
# Related to Bucket Subresource Operations][
|
8724
|
-
# Permissions to Your Amazon S3 Resources][
|
8725
|
-
#
|
8748
|
+
# Related to Bucket Subresource Operations][4] and [Managing Access
|
8749
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
8750
|
+
# Guide.
|
8726
8751
|
#
|
8727
8752
|
# **Related Resources**
|
8728
8753
|
#
|
8729
|
-
# * [GetBucketEncryption][
|
8754
|
+
# * [GetBucketEncryption][6]
|
8730
8755
|
#
|
8731
|
-
# * [DeleteBucketEncryption][
|
8756
|
+
# * [DeleteBucketEncryption][7]
|
8732
8757
|
#
|
8733
8758
|
#
|
8734
8759
|
#
|
8735
8760
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
8736
8761
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
8737
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8738
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8739
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8740
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8762
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
8763
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8764
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8765
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
8766
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
8741
8767
|
#
|
8742
8768
|
# @option params [required, String] :bucket
|
8743
8769
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -8761,7 +8787,7 @@ module Aws::S3
|
|
8761
8787
|
# Specifies the default server-side-encryption configuration.
|
8762
8788
|
#
|
8763
8789
|
# @option params [String] :expected_bucket_owner
|
8764
|
-
# The account
|
8790
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8765
8791
|
# a different account, the request will fail with an HTTP `403 (Access
|
8766
8792
|
# Denied)` error.
|
8767
8793
|
#
|
@@ -8796,6 +8822,8 @@ module Aws::S3
|
|
8796
8822
|
end
|
8797
8823
|
|
8798
8824
|
# Puts a S3 Intelligent-Tiering configuration to the specified bucket.
|
8825
|
+
# You can have up to 1,000 S3 Intelligent-Tiering configurations per
|
8826
|
+
# bucket.
|
8799
8827
|
#
|
8800
8828
|
# The S3 Intelligent-Tiering storage class is designed to optimize
|
8801
8829
|
# storage costs by automatically moving data to the most cost-effective
|
@@ -8824,6 +8852,35 @@ module Aws::S3
|
|
8824
8852
|
#
|
8825
8853
|
# * [ListBucketIntelligentTieringConfigurations][4]
|
8826
8854
|
#
|
8855
|
+
# <note markdown="1"> You only need S3 Intelligent-Tiering enabled on a bucket if you want
|
8856
|
+
# to automatically move objects stored in the S3 Intelligent-Tiering
|
8857
|
+
# storage class to the Archive Access or Deep Archive Access tier.
|
8858
|
+
#
|
8859
|
+
# </note>
|
8860
|
+
#
|
8861
|
+
# **Special Errors**
|
8862
|
+
#
|
8863
|
+
# * **HTTP 400 Bad Request Error**
|
8864
|
+
#
|
8865
|
+
# * *Code:* InvalidArgument
|
8866
|
+
#
|
8867
|
+
# * *Cause:* Invalid Argument
|
8868
|
+
#
|
8869
|
+
# * **HTTP 400 Bad Request Error**
|
8870
|
+
#
|
8871
|
+
# * *Code:* TooManyConfigurations
|
8872
|
+
#
|
8873
|
+
# * *Cause:* You are attempting to create a new configuration but have
|
8874
|
+
# already reached the 1,000-configuration limit.
|
8875
|
+
#
|
8876
|
+
# * **HTTP 403 Forbidden Error**
|
8877
|
+
#
|
8878
|
+
# * *Code:* AccessDenied
|
8879
|
+
#
|
8880
|
+
# * *Cause:* You are not the owner of the specified bucket, or you do
|
8881
|
+
# not have the `s3:PutIntelligentTieringConfiguration` bucket
|
8882
|
+
# permission to set the configuration on the bucket.
|
8883
|
+
#
|
8827
8884
|
#
|
8828
8885
|
#
|
8829
8886
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access
|
@@ -8885,7 +8942,7 @@ module Aws::S3
|
|
8885
8942
|
req.send_request(options)
|
8886
8943
|
end
|
8887
8944
|
|
8888
|
-
# This implementation of the `PUT`
|
8945
|
+
# This implementation of the `PUT` action adds an inventory
|
8889
8946
|
# configuration (identified by the inventory ID) to the bucket. You can
|
8890
8947
|
# have up to 1,000 inventory configurations per bucket.
|
8891
8948
|
#
|
@@ -8901,8 +8958,7 @@ module Aws::S3
|
|
8901
8958
|
# whether to generate the inventory daily or weekly. You can also
|
8902
8959
|
# configure what object metadata to include and whether to inventory all
|
8903
8960
|
# object versions or only current versions. For more information, see
|
8904
|
-
# [Amazon S3 Inventory][1] in the Amazon
|
8905
|
-
# Developer Guide.
|
8961
|
+
# [Amazon S3 Inventory][1] in the Amazon S3 User Guide.
|
8906
8962
|
#
|
8907
8963
|
# You must create a bucket policy on the *destination* bucket to grant
|
8908
8964
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
@@ -8914,8 +8970,7 @@ module Aws::S3
|
|
8914
8970
|
# permission by default and can grant this permission to others. For
|
8915
8971
|
# more information about permissions, see [Permissions Related to Bucket
|
8916
8972
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
8917
|
-
# Amazon S3 Resources][4] in the Amazon
|
8918
|
-
# Guide.
|
8973
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
8919
8974
|
#
|
8920
8975
|
# **Special Errors**
|
8921
8976
|
#
|
@@ -8952,8 +9007,8 @@ module Aws::S3
|
|
8952
9007
|
#
|
8953
9008
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
8954
9009
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
8955
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8956
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9010
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9011
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8957
9012
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
8958
9013
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
8959
9014
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -8969,7 +9024,7 @@ module Aws::S3
|
|
8969
9024
|
# Specifies the inventory configuration.
|
8970
9025
|
#
|
8971
9026
|
# @option params [String] :expected_bucket_owner
|
8972
|
-
# The account
|
9027
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8973
9028
|
# a different account, the request will fail with an HTTP `403 (Access
|
8974
9029
|
# Denied)` error.
|
8975
9030
|
#
|
@@ -9026,8 +9081,8 @@ module Aws::S3
|
|
9026
9081
|
#
|
9027
9082
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9028
9083
|
# existing lifecycle configuration. For information about lifecycle
|
9029
|
-
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
9030
|
-
#
|
9084
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon S3
|
9085
|
+
# User Guide*.
|
9031
9086
|
#
|
9032
9087
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
9033
9088
|
# related subresources (for example, lifecycle configuration and website
|
@@ -9049,8 +9104,8 @@ module Aws::S3
|
|
9049
9104
|
# * `s3:PutLifecycleConfiguration`
|
9050
9105
|
#
|
9051
9106
|
# For more information about permissions, see [Managing Access
|
9052
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
9053
|
-
#
|
9107
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
9108
|
+
# Guide*.
|
9054
9109
|
#
|
9055
9110
|
# For more examples of transitioning objects to storage classes such as
|
9056
9111
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
@@ -9068,7 +9123,7 @@ module Aws::S3
|
|
9068
9123
|
# the AWS account that created the bucket—can perform any of the
|
9069
9124
|
# operations. A resource owner can also grant others permission to
|
9070
9125
|
# perform the operation. For more information, see the following
|
9071
|
-
# topics in the Amazon
|
9126
|
+
# topics in the Amazon S3 User Guide:
|
9072
9127
|
#
|
9073
9128
|
# * [Specifying Permissions in a Policy][8]
|
9074
9129
|
#
|
@@ -9078,7 +9133,7 @@ module Aws::S3
|
|
9078
9133
|
#
|
9079
9134
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
9080
9135
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9081
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9136
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9082
9137
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
9083
9138
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
9084
9139
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
@@ -9094,7 +9149,7 @@ module Aws::S3
|
|
9094
9149
|
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
|
9095
9150
|
#
|
9096
9151
|
# @option params [String] :expected_bucket_owner
|
9097
|
-
# The account
|
9152
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9098
9153
|
# a different account, the request will fail with an HTTP `403 (Access
|
9099
9154
|
# Denied)` error.
|
9100
9155
|
#
|
@@ -9218,7 +9273,7 @@ module Aws::S3
|
|
9218
9273
|
#
|
9219
9274
|
#
|
9220
9275
|
#
|
9221
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9276
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9222
9277
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9223
9278
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9224
9279
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
@@ -9233,7 +9288,7 @@ module Aws::S3
|
|
9233
9288
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
9234
9289
|
#
|
9235
9290
|
# @option params [String] :expected_bucket_owner
|
9236
|
-
# The account
|
9291
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9237
9292
|
# a different account, the request will fail with an HTTP `403 (Access
|
9238
9293
|
# Denied)` error.
|
9239
9294
|
#
|
@@ -9414,7 +9469,7 @@ module Aws::S3
|
|
9414
9469
|
# SDKs, this field is calculated automatically.
|
9415
9470
|
#
|
9416
9471
|
# @option params [String] :expected_bucket_owner
|
9417
|
-
# The account
|
9472
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9418
9473
|
# a different account, the request will fail with an HTTP `403 (Access
|
9419
9474
|
# Denied)` error.
|
9420
9475
|
#
|
@@ -9517,8 +9572,8 @@ module Aws::S3
|
|
9517
9572
|
#
|
9518
9573
|
#
|
9519
9574
|
#
|
9520
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9521
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9575
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9576
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9522
9577
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
9523
9578
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
9524
9579
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -9534,7 +9589,7 @@ module Aws::S3
|
|
9534
9589
|
# Specifies the metrics configuration.
|
9535
9590
|
#
|
9536
9591
|
# @option params [String] :expected_bucket_owner
|
9537
|
-
# The account
|
9592
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9538
9593
|
# a different account, the request will fail with an HTTP `403 (Access
|
9539
9594
|
# Denied)` error.
|
9540
9595
|
#
|
@@ -9596,7 +9651,7 @@ module Aws::S3
|
|
9596
9651
|
# The container for the configuration.
|
9597
9652
|
#
|
9598
9653
|
# @option params [String] :expected_bucket_owner
|
9599
|
-
# The account
|
9654
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9600
9655
|
# a different account, the request will fail with an HTTP `403 (Access
|
9601
9656
|
# Denied)` error.
|
9602
9657
|
#
|
@@ -9658,8 +9713,8 @@ module Aws::S3
|
|
9658
9713
|
#
|
9659
9714
|
# `</NotificationConfiguration>`
|
9660
9715
|
#
|
9661
|
-
# This
|
9662
|
-
#
|
9716
|
+
# This action replaces the existing notification configuration with the
|
9717
|
+
# configuration you include in the request body.
|
9663
9718
|
#
|
9664
9719
|
# After Amazon S3 receives this request, it first verifies that any
|
9665
9720
|
# Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
|
@@ -9682,8 +9737,8 @@ module Aws::S3
|
|
9682
9737
|
# notification configuration includes SNS topic, SQS queue, and Lambda
|
9683
9738
|
# function configurations. When you send a PUT request with this
|
9684
9739
|
# configuration, Amazon S3 sends test messages to your SNS topic. If the
|
9685
|
-
# message fails, the entire PUT
|
9686
|
-
#
|
9740
|
+
# message fails, the entire PUT action will fail, and Amazon S3 will not
|
9741
|
+
# add the configuration to your bucket.
|
9687
9742
|
#
|
9688
9743
|
# </note>
|
9689
9744
|
#
|
@@ -9695,7 +9750,7 @@ module Aws::S3
|
|
9695
9750
|
# include the `x-amz-sns-test-message-id` header containing the message
|
9696
9751
|
# ID of the test notification sent to the topic.
|
9697
9752
|
#
|
9698
|
-
# The following
|
9753
|
+
# The following action is related to
|
9699
9754
|
# `PutBucketNotificationConfiguration`\:
|
9700
9755
|
#
|
9701
9756
|
# * [GetBucketNotificationConfiguration][2]
|
@@ -9716,7 +9771,7 @@ module Aws::S3
|
|
9716
9771
|
# bucket.
|
9717
9772
|
#
|
9718
9773
|
# @option params [String] :expected_bucket_owner
|
9719
|
-
# The account
|
9774
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9720
9775
|
# a different account, the request will fail with an HTTP `403 (Access
|
9721
9776
|
# Denied)` error.
|
9722
9777
|
#
|
@@ -9840,7 +9895,7 @@ module Aws::S3
|
|
9840
9895
|
# SDKs, this field is calculated automatically.
|
9841
9896
|
#
|
9842
9897
|
# @option params [String] :expected_bucket_owner
|
9843
|
-
# The account
|
9898
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9844
9899
|
# a different account, the request will fail with an HTTP `403 (Access
|
9845
9900
|
# Denied)` error.
|
9846
9901
|
#
|
@@ -9921,7 +9976,7 @@ module Aws::S3
|
|
9921
9976
|
# The bucket policy as a JSON document.
|
9922
9977
|
#
|
9923
9978
|
# @option params [String] :expected_bucket_owner
|
9924
|
-
# The account
|
9979
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9925
9980
|
# a different account, the request will fail with an HTTP `403 (Access
|
9926
9981
|
# Denied)` error.
|
9927
9982
|
#
|
@@ -9960,8 +10015,8 @@ module Aws::S3
|
|
9960
10015
|
# more information, see [Replication][1] in the *Amazon S3 Developer
|
9961
10016
|
# Guide*.
|
9962
10017
|
#
|
9963
|
-
# <note markdown="1"> To perform this operation, the user or role performing the
|
9964
|
-
#
|
10018
|
+
# <note markdown="1"> To perform this operation, the user or role performing the action must
|
10019
|
+
# have the [iam:PassRole][2] permission.
|
9965
10020
|
#
|
9966
10021
|
# </note>
|
9967
10022
|
#
|
@@ -10026,7 +10081,7 @@ module Aws::S3
|
|
10026
10081
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
10027
10082
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
10028
10083
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10029
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10084
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10030
10085
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
10031
10086
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
10032
10087
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -10055,7 +10110,7 @@ module Aws::S3
|
|
10055
10110
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
10056
10111
|
#
|
10057
10112
|
# @option params [String] :expected_bucket_owner
|
10058
|
-
# The account
|
10113
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10059
10114
|
# a different account, the request will fail with an HTTP `403 (Access
|
10060
10115
|
# Denied)` error.
|
10061
10116
|
#
|
@@ -10187,10 +10242,9 @@ module Aws::S3
|
|
10187
10242
|
# The bucket name.
|
10188
10243
|
#
|
10189
10244
|
# @option params [String] :content_md5
|
10190
|
-
#
|
10191
|
-
#
|
10192
|
-
#
|
10193
|
-
# 1864][1].
|
10245
|
+
# The base64-encoded 128-bit MD5 digest of the data. You must use this
|
10246
|
+
# header as a message integrity check to verify that the request body
|
10247
|
+
# was not corrupted in transit. For more information, see [RFC 1864][1].
|
10194
10248
|
#
|
10195
10249
|
# For requests made using the AWS Command Line Interface (CLI) or AWS
|
10196
10250
|
# SDKs, this field is calculated automatically.
|
@@ -10203,7 +10257,7 @@ module Aws::S3
|
|
10203
10257
|
# Container for Payer.
|
10204
10258
|
#
|
10205
10259
|
# @option params [String] :expected_bucket_owner
|
10206
|
-
# The account
|
10260
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10207
10261
|
# a different account, the request will fail with an HTTP `403 (Access
|
10208
10262
|
# Denied)` error.
|
10209
10263
|
#
|
@@ -10284,7 +10338,7 @@ module Aws::S3
|
|
10284
10338
|
#
|
10285
10339
|
# * Error code: `OperationAbortedError `
|
10286
10340
|
#
|
10287
|
-
# * Description: A conflicting conditional
|
10341
|
+
# * Description: A conflicting conditional action is currently in
|
10288
10342
|
# progress against this resource. Please try again.
|
10289
10343
|
#
|
10290
10344
|
# ^
|
@@ -10306,8 +10360,8 @@ module Aws::S3
|
|
10306
10360
|
#
|
10307
10361
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
10308
10362
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
10309
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10310
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10363
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
10364
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10311
10365
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
10312
10366
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
10313
10367
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
@@ -10332,7 +10386,7 @@ module Aws::S3
|
|
10332
10386
|
# Container for the `TagSet` and `Tag` elements.
|
10333
10387
|
#
|
10334
10388
|
# @option params [String] :expected_bucket_owner
|
10335
|
-
# The account
|
10389
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10336
10390
|
# a different account, the request will fail with an HTTP `403 (Access
|
10337
10391
|
# Denied)` error.
|
10338
10392
|
#
|
@@ -10452,7 +10506,7 @@ module Aws::S3
|
|
10452
10506
|
# Container for setting the versioning state.
|
10453
10507
|
#
|
10454
10508
|
# @option params [String] :expected_bucket_owner
|
10455
|
-
# The account
|
10509
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10456
10510
|
# a different account, the request will fail with an HTTP `403 (Access
|
10457
10511
|
# Denied)` error.
|
10458
10512
|
#
|
@@ -10499,7 +10553,7 @@ module Aws::S3
|
|
10499
10553
|
# such as the file name of the index document and any redirect rules.
|
10500
10554
|
# For more information, see [Hosting Websites on Amazon S3][1].
|
10501
10555
|
#
|
10502
|
-
# This PUT
|
10556
|
+
# This PUT action requires the `S3:PutBucketWebsite` permission. By
|
10503
10557
|
# default, only the bucket owner can configure the website attached to a
|
10504
10558
|
# bucket; however, bucket owners can allow other users to set the
|
10505
10559
|
# website configuration by writing a bucket policy that grants them the
|
@@ -10559,7 +10613,7 @@ module Aws::S3
|
|
10559
10613
|
# Amazon S3 has a limitation of 50 routing rules per website
|
10560
10614
|
# configuration. If you require more than 50 routing rules, you can use
|
10561
10615
|
# object redirect. For more information, see [Configuring an Object
|
10562
|
-
# Redirect][2] in the *Amazon
|
10616
|
+
# Redirect][2] in the *Amazon S3 User Guide*.
|
10563
10617
|
#
|
10564
10618
|
#
|
10565
10619
|
#
|
@@ -10585,7 +10639,7 @@ module Aws::S3
|
|
10585
10639
|
# Container for the request.
|
10586
10640
|
#
|
10587
10641
|
# @option params [String] :expected_bucket_owner
|
10588
|
-
# The account
|
10642
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10589
10643
|
# a different account, the request will fail with an HTTP `403 (Access
|
10590
10644
|
# Denied)` error.
|
10591
10645
|
#
|
@@ -10691,8 +10745,8 @@ module Aws::S3
|
|
10691
10745
|
#
|
10692
10746
|
# If you request server-side encryption using AWS Key Management Service
|
10693
10747
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
10694
|
-
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon
|
10695
|
-
#
|
10748
|
+
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon S3
|
10749
|
+
# User Guide*.
|
10696
10750
|
#
|
10697
10751
|
# **Access Control List (ACL)-Specific Request Headers**
|
10698
10752
|
#
|
@@ -10758,29 +10812,29 @@ module Aws::S3
|
|
10758
10812
|
# Object data.
|
10759
10813
|
#
|
10760
10814
|
# @option params [required, String] :bucket
|
10761
|
-
# The bucket name to which the PUT
|
10815
|
+
# The bucket name to which the PUT action was initiated.
|
10762
10816
|
#
|
10763
|
-
# When using this
|
10764
|
-
# the access point hostname. The access point hostname takes the form
|
10817
|
+
# When using this action with an access point, you must direct requests
|
10818
|
+
# to the access point hostname. The access point hostname takes the form
|
10765
10819
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10766
|
-
# When using this
|
10767
|
-
#
|
10820
|
+
# When using this action with an access point through the AWS SDKs, you
|
10821
|
+
# provide the access point ARN in place of the bucket name. For more
|
10768
10822
|
# information about access point ARNs, see [Using Access Points][1] in
|
10769
10823
|
# the *Amazon Simple Storage Service Developer Guide*.
|
10770
10824
|
#
|
10771
|
-
# When using this
|
10825
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
10772
10826
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10773
10827
|
# takes the form
|
10774
10828
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
10775
|
-
# When using this
|
10776
|
-
#
|
10777
|
-
#
|
10778
|
-
#
|
10829
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
10830
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
10831
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
10832
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
10779
10833
|
#
|
10780
10834
|
#
|
10781
10835
|
#
|
10782
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10783
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10836
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
10837
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
10784
10838
|
#
|
10785
10839
|
# @option params [String] :cache_control
|
10786
10840
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -10875,7 +10929,7 @@ module Aws::S3
|
|
10875
10929
|
# This action is not supported by Amazon S3 on Outposts.
|
10876
10930
|
#
|
10877
10931
|
# @option params [required, String] :key
|
10878
|
-
# Object key for which the PUT
|
10932
|
+
# Object key for which the PUT action was initiated.
|
10879
10933
|
#
|
10880
10934
|
# @option params [Hash<String,String>] :metadata
|
10881
10935
|
# A map of metadata to store with the object in S3.
|
@@ -10962,8 +11016,8 @@ module Aws::S3
|
|
10962
11016
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
10963
11017
|
# for object encryption with SSE-KMS.
|
10964
11018
|
#
|
10965
|
-
# Specifying this header with a PUT
|
10966
|
-
#
|
11019
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11020
|
+
# settings for S3 Bucket Key.
|
10967
11021
|
#
|
10968
11022
|
# @option params [String] :request_payer
|
10969
11023
|
# Confirms that the requester knows that they will be charged for the
|
@@ -10995,7 +11049,7 @@ module Aws::S3
|
|
10995
11049
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
10996
11050
|
#
|
10997
11051
|
# @option params [String] :expected_bucket_owner
|
10998
|
-
# The account
|
11052
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10999
11053
|
# a different account, the request will fail with an HTTP `403 (Access
|
11000
11054
|
# Denied)` error.
|
11001
11055
|
#
|
@@ -11013,24 +11067,21 @@ module Aws::S3
|
|
11013
11067
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11014
11068
|
#
|
11015
11069
|
#
|
11016
|
-
# @example Example: To upload an object
|
11070
|
+
# @example Example: To upload an object
|
11017
11071
|
#
|
11018
|
-
# # The following example uploads
|
11019
|
-
# #
|
11072
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11073
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11020
11074
|
#
|
11021
11075
|
# resp = client.put_object({
|
11022
|
-
# body: "
|
11076
|
+
# body: "HappyFace.jpg",
|
11023
11077
|
# bucket: "examplebucket",
|
11024
|
-
# key: "
|
11025
|
-
# server_side_encryption: "AES256",
|
11026
|
-
# tagging: "key1=value1&key2=value2",
|
11078
|
+
# key: "HappyFace.jpg",
|
11027
11079
|
# })
|
11028
11080
|
#
|
11029
11081
|
# resp.to_h outputs the following:
|
11030
11082
|
# {
|
11031
11083
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11032
|
-
#
|
11033
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11084
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11034
11085
|
# }
|
11035
11086
|
#
|
11036
11087
|
# @example Example: To create an object.
|
@@ -11049,24 +11100,6 @@ module Aws::S3
|
|
11049
11100
|
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11050
11101
|
# }
|
11051
11102
|
#
|
11052
|
-
# @example Example: To upload an object and specify optional tags
|
11053
|
-
#
|
11054
|
-
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11055
|
-
# # S3 returns version ID of the newly created object.
|
11056
|
-
#
|
11057
|
-
# resp = client.put_object({
|
11058
|
-
# body: "c:\\HappyFace.jpg",
|
11059
|
-
# bucket: "examplebucket",
|
11060
|
-
# key: "HappyFace.jpg",
|
11061
|
-
# tagging: "key1=value1&key2=value2",
|
11062
|
-
# })
|
11063
|
-
#
|
11064
|
-
# resp.to_h outputs the following:
|
11065
|
-
# {
|
11066
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11067
|
-
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11068
|
-
# }
|
11069
|
-
#
|
11070
11103
|
# @example Example: To upload an object (specify optional headers)
|
11071
11104
|
#
|
11072
11105
|
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
@@ -11126,21 +11159,42 @@ module Aws::S3
|
|
11126
11159
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11127
11160
|
# }
|
11128
11161
|
#
|
11129
|
-
# @example Example: To upload an object
|
11162
|
+
# @example Example: To upload an object and specify optional tags
|
11130
11163
|
#
|
11131
|
-
# # The following example uploads an object
|
11132
|
-
# #
|
11164
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11165
|
+
# # S3 returns version ID of the newly created object.
|
11133
11166
|
#
|
11134
11167
|
# resp = client.put_object({
|
11135
|
-
# body: "HappyFace.jpg",
|
11168
|
+
# body: "c:\\HappyFace.jpg",
|
11136
11169
|
# bucket: "examplebucket",
|
11137
11170
|
# key: "HappyFace.jpg",
|
11171
|
+
# tagging: "key1=value1&key2=value2",
|
11138
11172
|
# })
|
11139
11173
|
#
|
11140
11174
|
# resp.to_h outputs the following:
|
11141
11175
|
# {
|
11142
11176
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11143
|
-
# version_id: "
|
11177
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11178
|
+
# }
|
11179
|
+
#
|
11180
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
11181
|
+
#
|
11182
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
11183
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
11184
|
+
#
|
11185
|
+
# resp = client.put_object({
|
11186
|
+
# body: "filetoupload",
|
11187
|
+
# bucket: "examplebucket",
|
11188
|
+
# key: "exampleobject",
|
11189
|
+
# server_side_encryption: "AES256",
|
11190
|
+
# tagging: "key1=value1&key2=value2",
|
11191
|
+
# })
|
11192
|
+
#
|
11193
|
+
# resp.to_h outputs the following:
|
11194
|
+
# {
|
11195
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11196
|
+
# server_side_encryption: "AES256",
|
11197
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11144
11198
|
# }
|
11145
11199
|
#
|
11146
11200
|
# @example Streaming a file from disk
|
@@ -11213,8 +11267,8 @@ module Aws::S3
|
|
11213
11267
|
# Uses the `acl` subresource to set the access control list (ACL)
|
11214
11268
|
# permissions for a new or existing object in an S3 bucket. You must
|
11215
11269
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
11216
|
-
# information, see [What permissions can I grant?][1] in the *Amazon
|
11217
|
-
#
|
11270
|
+
# information, see [What permissions can I grant?][1] in the *Amazon S3
|
11271
|
+
# User Guide*.
|
11218
11272
|
#
|
11219
11273
|
# This action is not supported by Amazon S3 on Outposts.
|
11220
11274
|
#
|
@@ -11378,17 +11432,17 @@ module Aws::S3
|
|
11378
11432
|
# The bucket name that contains the object to which you want to attach
|
11379
11433
|
# the ACL.
|
11380
11434
|
#
|
11381
|
-
# When using this
|
11382
|
-
# the access point hostname. The access point hostname takes the form
|
11435
|
+
# When using this action with an access point, you must direct requests
|
11436
|
+
# to the access point hostname. The access point hostname takes the form
|
11383
11437
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11384
|
-
# When using this
|
11385
|
-
#
|
11438
|
+
# When using this action with an access point through the AWS SDKs, you
|
11439
|
+
# provide the access point ARN in place of the bucket name. For more
|
11386
11440
|
# information about access point ARNs, see [Using Access Points][1] in
|
11387
11441
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11388
11442
|
#
|
11389
11443
|
#
|
11390
11444
|
#
|
11391
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11445
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11392
11446
|
#
|
11393
11447
|
# @option params [String] :content_md5
|
11394
11448
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -11429,29 +11483,29 @@ module Aws::S3
|
|
11429
11483
|
# This action is not supported by Amazon S3 on Outposts.
|
11430
11484
|
#
|
11431
11485
|
# @option params [required, String] :key
|
11432
|
-
# Key for which the PUT
|
11486
|
+
# Key for which the PUT action was initiated.
|
11433
11487
|
#
|
11434
|
-
# When using this
|
11435
|
-
# the access point hostname. The access point hostname takes the form
|
11488
|
+
# When using this action with an access point, you must direct requests
|
11489
|
+
# to the access point hostname. The access point hostname takes the form
|
11436
11490
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11437
|
-
# When using this
|
11438
|
-
#
|
11491
|
+
# When using this action with an access point through the AWS SDKs, you
|
11492
|
+
# provide the access point ARN in place of the bucket name. For more
|
11439
11493
|
# information about access point ARNs, see [Using Access Points][1] in
|
11440
11494
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11441
11495
|
#
|
11442
|
-
# When using this
|
11496
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11443
11497
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11444
11498
|
# takes the form
|
11445
11499
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11446
|
-
# When using this
|
11447
|
-
#
|
11448
|
-
#
|
11449
|
-
#
|
11500
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11501
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11502
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11503
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
11450
11504
|
#
|
11451
11505
|
#
|
11452
11506
|
#
|
11453
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11454
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11507
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11508
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11455
11509
|
#
|
11456
11510
|
# @option params [String] :request_payer
|
11457
11511
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11468,7 +11522,7 @@ module Aws::S3
|
|
11468
11522
|
# VersionId used to reference a specific version of the object.
|
11469
11523
|
#
|
11470
11524
|
# @option params [String] :expected_bucket_owner
|
11471
|
-
# The account
|
11525
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11472
11526
|
# a different account, the request will fail with an HTTP `403 (Access
|
11473
11527
|
# Denied)` error.
|
11474
11528
|
#
|
@@ -11561,17 +11615,17 @@ module Aws::S3
|
|
11561
11615
|
# The bucket name containing the object that you want to place a Legal
|
11562
11616
|
# Hold on.
|
11563
11617
|
#
|
11564
|
-
# When using this
|
11565
|
-
# the access point hostname. The access point hostname takes the form
|
11618
|
+
# When using this action with an access point, you must direct requests
|
11619
|
+
# to the access point hostname. The access point hostname takes the form
|
11566
11620
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11567
|
-
# When using this
|
11568
|
-
#
|
11621
|
+
# When using this action with an access point through the AWS SDKs, you
|
11622
|
+
# provide the access point ARN in place of the bucket name. For more
|
11569
11623
|
# information about access point ARNs, see [Using Access Points][1] in
|
11570
11624
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11571
11625
|
#
|
11572
11626
|
#
|
11573
11627
|
#
|
11574
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11628
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11575
11629
|
#
|
11576
11630
|
# @option params [required, String] :key
|
11577
11631
|
# The key name for the object that you want to place a Legal Hold on.
|
@@ -11601,7 +11655,7 @@ module Aws::S3
|
|
11601
11655
|
# SDKs, this field is calculated automatically.
|
11602
11656
|
#
|
11603
11657
|
# @option params [String] :expected_bucket_owner
|
11604
|
-
# The account
|
11658
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11605
11659
|
# a different account, the request will fail with an HTTP `403 (Access
|
11606
11660
|
# Denied)` error.
|
11607
11661
|
#
|
@@ -11684,7 +11738,7 @@ module Aws::S3
|
|
11684
11738
|
# SDKs, this field is calculated automatically.
|
11685
11739
|
#
|
11686
11740
|
# @option params [String] :expected_bucket_owner
|
11687
|
-
# The account
|
11741
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11688
11742
|
# a different account, the request will fail with an HTTP `403 (Access
|
11689
11743
|
# Denied)` error.
|
11690
11744
|
#
|
@@ -11743,17 +11797,17 @@ module Aws::S3
|
|
11743
11797
|
# The bucket name that contains the object you want to apply this Object
|
11744
11798
|
# Retention configuration to.
|
11745
11799
|
#
|
11746
|
-
# When using this
|
11747
|
-
# the access point hostname. The access point hostname takes the form
|
11800
|
+
# When using this action with an access point, you must direct requests
|
11801
|
+
# to the access point hostname. The access point hostname takes the form
|
11748
11802
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11749
|
-
# When using this
|
11750
|
-
#
|
11803
|
+
# When using this action with an access point through the AWS SDKs, you
|
11804
|
+
# provide the access point ARN in place of the bucket name. For more
|
11751
11805
|
# information about access point ARNs, see [Using Access Points][1] in
|
11752
11806
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11753
11807
|
#
|
11754
11808
|
#
|
11755
11809
|
#
|
11756
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11810
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11757
11811
|
#
|
11758
11812
|
# @option params [required, String] :key
|
11759
11813
|
# The key name for the object that you want to apply this Object
|
@@ -11778,7 +11832,7 @@ module Aws::S3
|
|
11778
11832
|
# Retention configuration to.
|
11779
11833
|
#
|
11780
11834
|
# @option params [Boolean] :bypass_governance_retention
|
11781
|
-
# Indicates whether this
|
11835
|
+
# Indicates whether this action should bypass Governance-mode
|
11782
11836
|
# restrictions.
|
11783
11837
|
#
|
11784
11838
|
# @option params [String] :content_md5
|
@@ -11788,7 +11842,7 @@ module Aws::S3
|
|
11788
11842
|
# SDKs, this field is calculated automatically.
|
11789
11843
|
#
|
11790
11844
|
# @option params [String] :expected_bucket_owner
|
11791
|
-
# The account
|
11845
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11792
11846
|
# a different account, the request will fail with an HTTP `403 (Access
|
11793
11847
|
# Denied)` error.
|
11794
11848
|
#
|
@@ -11861,8 +11915,8 @@ module Aws::S3
|
|
11861
11915
|
#
|
11862
11916
|
# * * <i>Code: OperationAbortedError </i>
|
11863
11917
|
#
|
11864
|
-
# * *Cause: A conflicting conditional
|
11865
|
-
#
|
11918
|
+
# * *Cause: A conflicting conditional action is currently in progress
|
11919
|
+
# against this resource. Please try again.*
|
11866
11920
|
#
|
11867
11921
|
# * * *Code: InternalError*
|
11868
11922
|
#
|
@@ -11873,38 +11927,39 @@ module Aws::S3
|
|
11873
11927
|
#
|
11874
11928
|
# * [GetObjectTagging][1]
|
11875
11929
|
#
|
11876
|
-
#
|
11930
|
+
# * [DeleteObjectTagging][4]
|
11877
11931
|
#
|
11878
11932
|
#
|
11879
11933
|
#
|
11880
11934
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html
|
11881
11935
|
# [2]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
11882
11936
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
11937
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html
|
11883
11938
|
#
|
11884
11939
|
# @option params [required, String] :bucket
|
11885
11940
|
# The bucket name containing the object.
|
11886
11941
|
#
|
11887
|
-
# When using this
|
11888
|
-
# the access point hostname. The access point hostname takes the form
|
11942
|
+
# When using this action with an access point, you must direct requests
|
11943
|
+
# to the access point hostname. The access point hostname takes the form
|
11889
11944
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11890
|
-
# When using this
|
11891
|
-
#
|
11945
|
+
# When using this action with an access point through the AWS SDKs, you
|
11946
|
+
# provide the access point ARN in place of the bucket name. For more
|
11892
11947
|
# information about access point ARNs, see [Using Access Points][1] in
|
11893
11948
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11894
11949
|
#
|
11895
|
-
# When using this
|
11950
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11896
11951
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11897
11952
|
# takes the form
|
11898
11953
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11899
|
-
# When using this
|
11900
|
-
#
|
11901
|
-
#
|
11902
|
-
#
|
11954
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11955
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11956
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11957
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
11903
11958
|
#
|
11904
11959
|
#
|
11905
11960
|
#
|
11906
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11907
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11961
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11962
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11908
11963
|
#
|
11909
11964
|
# @option params [required, String] :key
|
11910
11965
|
# Name of the object key.
|
@@ -11922,10 +11977,21 @@ module Aws::S3
|
|
11922
11977
|
# Container for the `TagSet` and `Tag` elements
|
11923
11978
|
#
|
11924
11979
|
# @option params [String] :expected_bucket_owner
|
11925
|
-
# The account
|
11980
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11926
11981
|
# a different account, the request will fail with an HTTP `403 (Access
|
11927
11982
|
# Denied)` error.
|
11928
11983
|
#
|
11984
|
+
# @option params [String] :request_payer
|
11985
|
+
# Confirms that the requester knows that they will be charged for the
|
11986
|
+
# request. Bucket owners need not specify this parameter in their
|
11987
|
+
# requests. For information about downloading objects from requester
|
11988
|
+
# pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11989
|
+
# in the *Amazon S3 Developer Guide*.
|
11990
|
+
#
|
11991
|
+
#
|
11992
|
+
#
|
11993
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
11994
|
+
#
|
11929
11995
|
# @return [Types::PutObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11930
11996
|
#
|
11931
11997
|
# * {Types::PutObjectTaggingOutput#version_id #version_id} => String
|
@@ -11973,6 +12039,7 @@ module Aws::S3
|
|
11973
12039
|
# ],
|
11974
12040
|
# },
|
11975
12041
|
# expected_bucket_owner: "AccountId",
|
12042
|
+
# request_payer: "requester", # accepts requester
|
11976
12043
|
# })
|
11977
12044
|
#
|
11978
12045
|
# @example Response structure
|
@@ -12045,7 +12112,7 @@ module Aws::S3
|
|
12045
12112
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
12046
12113
|
#
|
12047
12114
|
# @option params [String] :expected_bucket_owner
|
12048
|
-
# The account
|
12115
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12049
12116
|
# a different account, the request will fail with an HTTP `403 (Access
|
12050
12117
|
# Denied)` error.
|
12051
12118
|
#
|
@@ -12089,7 +12156,7 @@ module Aws::S3
|
|
12089
12156
|
# default and can grant this permission to others. For more information
|
12090
12157
|
# about permissions, see [Permissions Related to Bucket Subresource
|
12091
12158
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
12092
|
-
# Resources][2] in the *Amazon
|
12159
|
+
# Resources][2] in the *Amazon S3 User Guide*.
|
12093
12160
|
#
|
12094
12161
|
# **Querying Archives with Select Requests**
|
12095
12162
|
#
|
@@ -12099,7 +12166,7 @@ module Aws::S3
|
|
12099
12166
|
# files. You can run queries and custom analytics on your archived data
|
12100
12167
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
12101
12168
|
# overview about select requests, see [Querying Archived Objects][3] in
|
12102
|
-
# the *Amazon
|
12169
|
+
# the *Amazon S3 User Guide*.
|
12103
12170
|
#
|
12104
12171
|
# When making a select request, do the following:
|
12105
12172
|
#
|
@@ -12109,19 +12176,18 @@ module Aws::S3
|
|
12109
12176
|
# that initiates the job must have permissions to write to the S3
|
12110
12177
|
# bucket. You can specify the storage class and encryption for the
|
12111
12178
|
# output objects stored in the bucket. For more information about
|
12112
|
-
# output, see [Querying Archived Objects][3] in the *Amazon
|
12113
|
-
#
|
12179
|
+
# output, see [Querying Archived Objects][3] in the *Amazon S3 User
|
12180
|
+
# Guide*.
|
12114
12181
|
#
|
12115
12182
|
# For more information about the `S3` structure in the request body,
|
12116
12183
|
# see the following:
|
12117
12184
|
#
|
12118
12185
|
# * [PutObject][4]
|
12119
12186
|
#
|
12120
|
-
# * [Managing Access with ACLs][5] in the *Amazon
|
12121
|
-
# Service Developer Guide*
|
12187
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
12122
12188
|
#
|
12123
12189
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
12124
|
-
#
|
12190
|
+
# S3 User Guide*
|
12125
12191
|
#
|
12126
12192
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
12127
12193
|
# your query in the request body's `SelectParameters` structure. You
|
@@ -12147,7 +12213,7 @@ module Aws::S3
|
|
12147
12213
|
#
|
12148
12214
|
# For more information about using SQL with S3 Glacier Select restore,
|
12149
12215
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
12150
|
-
# the *Amazon
|
12216
|
+
# the *Amazon S3 User Guide*.
|
12151
12217
|
#
|
12152
12218
|
# When making a select request, you can also do the following:
|
12153
12219
|
#
|
@@ -12226,20 +12292,19 @@ module Aws::S3
|
|
12226
12292
|
#
|
12227
12293
|
# For more information about archive retrieval options and provisioned
|
12228
12294
|
# capacity for `Expedited` data access, see [Restoring Archived
|
12229
|
-
# Objects][8] in the *Amazon
|
12295
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
12230
12296
|
#
|
12231
12297
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
12232
12298
|
# speed to a faster speed while it is in progress. For more information,
|
12233
12299
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
12234
|
-
#
|
12300
|
+
# S3 User Guide*.
|
12235
12301
|
#
|
12236
12302
|
# To get the status of object restoration, you can send a `HEAD`
|
12237
12303
|
# request. Operations return the `x-amz-restore` header, which provides
|
12238
12304
|
# information about the restoration status, in the response. You can use
|
12239
12305
|
# Amazon S3 event notifications to notify you when a restore is
|
12240
12306
|
# initiated or completed. For more information, see [Configuring Amazon
|
12241
|
-
# S3 Event Notifications][10] in the *Amazon
|
12242
|
-
# Developer Guide*.
|
12307
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
12243
12308
|
#
|
12244
12309
|
# After restoring an archived object, you can update the restoration
|
12245
12310
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -12255,11 +12320,11 @@ module Aws::S3
|
|
12255
12320
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
12256
12321
|
# about lifecycle configuration, see
|
12257
12322
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
12258
|
-
# Management][12] in *Amazon
|
12323
|
+
# Management][12] in *Amazon S3 User Guide*.
|
12259
12324
|
#
|
12260
12325
|
# **Responses**
|
12261
12326
|
#
|
12262
|
-
# A successful
|
12327
|
+
# A successful action returns either the `200 OK` or `202 Accepted`
|
12263
12328
|
# status code.
|
12264
12329
|
#
|
12265
12330
|
# * If the object is not previously restored, then Amazon S3 returns
|
@@ -12297,12 +12362,12 @@ module Aws::S3
|
|
12297
12362
|
# * [GetBucketNotificationConfiguration][13]
|
12298
12363
|
#
|
12299
12364
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
12300
|
-
# the *Amazon
|
12365
|
+
# the *Amazon S3 User Guide*
|
12301
12366
|
#
|
12302
12367
|
#
|
12303
12368
|
#
|
12304
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12305
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12369
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12370
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
12306
12371
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
12307
12372
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
12308
12373
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
@@ -12318,30 +12383,30 @@ module Aws::S3
|
|
12318
12383
|
# @option params [required, String] :bucket
|
12319
12384
|
# The bucket name containing the object to restore.
|
12320
12385
|
#
|
12321
|
-
# When using this
|
12322
|
-
# the access point hostname. The access point hostname takes the form
|
12386
|
+
# When using this action with an access point, you must direct requests
|
12387
|
+
# to the access point hostname. The access point hostname takes the form
|
12323
12388
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12324
|
-
# When using this
|
12325
|
-
#
|
12389
|
+
# When using this action with an access point through the AWS SDKs, you
|
12390
|
+
# provide the access point ARN in place of the bucket name. For more
|
12326
12391
|
# information about access point ARNs, see [Using Access Points][1] in
|
12327
12392
|
# the *Amazon Simple Storage Service Developer Guide*.
|
12328
12393
|
#
|
12329
|
-
# When using this
|
12394
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
12330
12395
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12331
12396
|
# takes the form
|
12332
12397
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12333
|
-
# When using this
|
12334
|
-
#
|
12335
|
-
#
|
12336
|
-
#
|
12398
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
12399
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
12400
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
12401
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
12337
12402
|
#
|
12338
12403
|
#
|
12339
12404
|
#
|
12340
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12341
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12405
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12406
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
12342
12407
|
#
|
12343
12408
|
# @option params [required, String] :key
|
12344
|
-
# Object key for which the
|
12409
|
+
# Object key for which the action was initiated.
|
12345
12410
|
#
|
12346
12411
|
# @option params [String] :version_id
|
12347
12412
|
# VersionId used to reference a specific version of the object.
|
@@ -12361,7 +12426,7 @@ module Aws::S3
|
|
12361
12426
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12362
12427
|
#
|
12363
12428
|
# @option params [String] :expected_bucket_owner
|
12364
|
-
# The account
|
12429
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12365
12430
|
# a different account, the request will fail with an HTTP `403 (Access
|
12366
12431
|
# Denied)` error.
|
12367
12432
|
#
|
@@ -12495,7 +12560,7 @@ module Aws::S3
|
|
12495
12560
|
req.send_request(options)
|
12496
12561
|
end
|
12497
12562
|
|
12498
|
-
# This
|
12563
|
+
# This action filters the contents of an Amazon S3 object based on a
|
12499
12564
|
# simple structured query language (SQL) statement. In the request,
|
12500
12565
|
# along with the SQL expression, you must also specify a data
|
12501
12566
|
# serialization format (JSON, CSV, or Apache Parquet) of the object.
|
@@ -12506,12 +12571,11 @@ module Aws::S3
|
|
12506
12571
|
# This action is not supported by Amazon S3 on Outposts.
|
12507
12572
|
#
|
12508
12573
|
# For more information about Amazon S3 Select, see [Selecting Content
|
12509
|
-
# from Objects][1] in the *Amazon
|
12510
|
-
# Guide*.
|
12574
|
+
# from Objects][1] in the *Amazon S3 User Guide*.
|
12511
12575
|
#
|
12512
12576
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
12513
12577
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
12514
|
-
# *Amazon
|
12578
|
+
# *Amazon S3 User Guide*.
|
12515
12579
|
#
|
12516
12580
|
#
|
12517
12581
|
#
|
@@ -12520,7 +12584,7 @@ module Aws::S3
|
|
12520
12584
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
12521
12585
|
# Select does not support anonymous access. For more information about
|
12522
12586
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
12523
|
-
# *Amazon
|
12587
|
+
# *Amazon S3 User Guide*.
|
12524
12588
|
#
|
12525
12589
|
#
|
12526
12590
|
#
|
@@ -12548,8 +12612,7 @@ module Aws::S3
|
|
12548
12612
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
12549
12613
|
# are documented in the [GetObject][4]. For more information about
|
12550
12614
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
12551
|
-
# Encryption Keys)][5] in the *Amazon
|
12552
|
-
# Guide*.
|
12615
|
+
# Encryption Keys)][5] in the *Amazon S3 User Guide*.
|
12553
12616
|
#
|
12554
12617
|
# For objects that are encrypted with Amazon S3 managed encryption
|
12555
12618
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
@@ -12557,7 +12620,7 @@ module Aws::S3
|
|
12557
12620
|
# transparently, so you don't need to specify anything. For more
|
12558
12621
|
# information about server-side encryption, including SSE-S3 and
|
12559
12622
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
12560
|
-
# the *Amazon
|
12623
|
+
# the *Amazon S3 User Guide*.
|
12561
12624
|
#
|
12562
12625
|
# **Working with the Response Body**
|
12563
12626
|
#
|
@@ -12570,7 +12633,7 @@ module Aws::S3
|
|
12570
12633
|
#
|
12571
12634
|
# **GetObject Support**
|
12572
12635
|
#
|
12573
|
-
# The `SelectObjectContent`
|
12636
|
+
# The `SelectObjectContent` action does not support the following
|
12574
12637
|
# `GetObject` functionality. For more information, see [GetObject][4].
|
12575
12638
|
#
|
12576
12639
|
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
@@ -12581,8 +12644,7 @@ module Aws::S3
|
|
12581
12644
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
12582
12645
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
12583
12646
|
# storage classes. For more information, about storage classes see
|
12584
|
-
# [Storage Classes][9] in the *Amazon
|
12585
|
-
# Guide*.
|
12647
|
+
# [Storage Classes][9] in the *Amazon S3 User Guide*.
|
12586
12648
|
#
|
12587
12649
|
#
|
12588
12650
|
#
|
@@ -12681,7 +12743,7 @@ module Aws::S3
|
|
12681
12743
|
# within the last 50 bytes of the file.
|
12682
12744
|
#
|
12683
12745
|
# @option params [String] :expected_bucket_owner
|
12684
|
-
# The account
|
12746
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12685
12747
|
# a different account, the request will fail with an HTTP `403 (Access
|
12686
12748
|
# Denied)` error.
|
12687
12749
|
#
|
@@ -12948,12 +13010,11 @@ module Aws::S3
|
|
12948
13010
|
# parts storage and stops charging you for the parts storage.
|
12949
13011
|
#
|
12950
13012
|
# For more information on multipart uploads, go to [Multipart Upload
|
12951
|
-
# Overview][4] in the <i>Amazon
|
12952
|
-
# </i>.
|
13013
|
+
# Overview][4] in the <i>Amazon S3 User Guide </i>.
|
12953
13014
|
#
|
12954
13015
|
# For information on the permissions required to use the multipart
|
12955
|
-
# upload API, go to [Multipart Upload
|
12956
|
-
#
|
13016
|
+
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
13017
|
+
# S3 User Guide*.
|
12957
13018
|
#
|
12958
13019
|
# You can optionally request server-side encryption where Amazon S3
|
12959
13020
|
# encrypts your data as it writes it to disks in its data centers and
|
@@ -12963,8 +13024,7 @@ module Aws::S3
|
|
12963
13024
|
# request headers you provide in the request must match the headers you
|
12964
13025
|
# used in the request to initiate the upload by using
|
12965
13026
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
12966
|
-
# Server-Side Encryption][6] in the *Amazon
|
12967
|
-
# Developer Guide*.
|
13027
|
+
# Server-Side Encryption][6] in the *Amazon S3 User Guide*.
|
12968
13028
|
#
|
12969
13029
|
# Server-side encryption is supported by the S3 Multipart Upload
|
12970
13030
|
# actions. Unless you are using a customer-provided encryption key, you
|
@@ -13027,27 +13087,27 @@ module Aws::S3
|
|
13027
13087
|
# @option params [required, String] :bucket
|
13028
13088
|
# The name of the bucket to which the multipart upload was initiated.
|
13029
13089
|
#
|
13030
|
-
# When using this
|
13031
|
-
# the access point hostname. The access point hostname takes the form
|
13090
|
+
# When using this action with an access point, you must direct requests
|
13091
|
+
# to the access point hostname. The access point hostname takes the form
|
13032
13092
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13033
|
-
# When using this
|
13034
|
-
#
|
13093
|
+
# When using this action with an access point through the AWS SDKs, you
|
13094
|
+
# provide the access point ARN in place of the bucket name. For more
|
13035
13095
|
# information about access point ARNs, see [Using Access Points][1] in
|
13036
13096
|
# the *Amazon Simple Storage Service Developer Guide*.
|
13037
13097
|
#
|
13038
|
-
# When using this
|
13098
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13039
13099
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13040
13100
|
# takes the form
|
13041
13101
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13042
|
-
# When using this
|
13043
|
-
#
|
13044
|
-
#
|
13045
|
-
#
|
13102
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13103
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13104
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13105
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
13046
13106
|
#
|
13047
13107
|
#
|
13048
13108
|
#
|
13049
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13050
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13109
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13110
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13051
13111
|
#
|
13052
13112
|
# @option params [Integer] :content_length
|
13053
13113
|
# Size of the body in bytes. This parameter is useful when the size of
|
@@ -13099,7 +13159,7 @@ module Aws::S3
|
|
13099
13159
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13100
13160
|
#
|
13101
13161
|
# @option params [String] :expected_bucket_owner
|
13102
|
-
# The account
|
13162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
13103
13163
|
# a different account, the request will fail with an HTTP `403 (Access
|
13104
13164
|
# Denied)` error.
|
13105
13165
|
#
|
@@ -13175,10 +13235,10 @@ module Aws::S3
|
|
13175
13235
|
#
|
13176
13236
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
13177
13237
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
13178
|
-
# in the *Amazon
|
13238
|
+
# in the *Amazon S3 User Guide*.
|
13179
13239
|
#
|
13180
13240
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
13181
|
-
# [UploadPart][2]
|
13241
|
+
# [UploadPart][2] action and provide data in your request.
|
13182
13242
|
#
|
13183
13243
|
# </note>
|
13184
13244
|
#
|
@@ -13191,16 +13251,15 @@ module Aws::S3
|
|
13191
13251
|
# the following:
|
13192
13252
|
#
|
13193
13253
|
# * For conceptual information about multipart uploads, see [Uploading
|
13194
|
-
# Objects Using Multipart Upload][3] in the *Amazon
|
13195
|
-
# Service Developer Guide*.
|
13254
|
+
# Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*.
|
13196
13255
|
#
|
13197
13256
|
# * For information about permissions required to use the multipart
|
13198
|
-
# upload API, see [Multipart Upload
|
13199
|
-
#
|
13257
|
+
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
13258
|
+
# S3 User Guide*.
|
13200
13259
|
#
|
13201
|
-
# * For information about copying objects using a single atomic
|
13202
|
-
#
|
13203
|
-
#
|
13260
|
+
# * For information about copying objects using a single atomic action
|
13261
|
+
# vs. the multipart upload, see [Operations on Objects][5] in the
|
13262
|
+
# *Amazon S3 User Guide*.
|
13204
13263
|
#
|
13205
13264
|
# * For information about using server-side encryption with
|
13206
13265
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
@@ -13302,27 +13361,27 @@ module Aws::S3
|
|
13302
13361
|
# @option params [required, String] :bucket
|
13303
13362
|
# The bucket name.
|
13304
13363
|
#
|
13305
|
-
# When using this
|
13306
|
-
# the access point hostname. The access point hostname takes the form
|
13364
|
+
# When using this action with an access point, you must direct requests
|
13365
|
+
# to the access point hostname. The access point hostname takes the form
|
13307
13366
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13308
|
-
# When using this
|
13309
|
-
#
|
13367
|
+
# When using this action with an access point through the AWS SDKs, you
|
13368
|
+
# provide the access point ARN in place of the bucket name. For more
|
13310
13369
|
# information about access point ARNs, see [Using Access Points][1] in
|
13311
13370
|
# the *Amazon Simple Storage Service Developer Guide*.
|
13312
13371
|
#
|
13313
|
-
# When using this
|
13372
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13314
13373
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13315
13374
|
# takes the form
|
13316
13375
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13317
|
-
# When using this
|
13318
|
-
#
|
13319
|
-
#
|
13320
|
-
#
|
13376
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13377
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13378
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13379
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
13321
13380
|
#
|
13322
13381
|
#
|
13323
13382
|
#
|
13324
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13325
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13383
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13384
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13326
13385
|
#
|
13327
13386
|
# @option params [required, String] :copy_source
|
13328
13387
|
# Specifies the source object for the copy operation. You specify the
|
@@ -13368,7 +13427,7 @@ module Aws::S3
|
|
13368
13427
|
#
|
13369
13428
|
#
|
13370
13429
|
#
|
13371
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13430
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
13372
13431
|
#
|
13373
13432
|
# @option params [String] :copy_source_if_match
|
13374
13433
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -13445,12 +13504,12 @@ module Aws::S3
|
|
13445
13504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13446
13505
|
#
|
13447
13506
|
# @option params [String] :expected_bucket_owner
|
13448
|
-
# The account
|
13507
|
+
# The account ID of the expected destination bucket owner. If the
|
13449
13508
|
# destination bucket is owned by a different account, the request will
|
13450
13509
|
# fail with an HTTP `403 (Access Denied)` error.
|
13451
13510
|
#
|
13452
13511
|
# @option params [String] :expected_source_bucket_owner
|
13453
|
-
# The account
|
13512
|
+
# The account ID of the expected source bucket owner. If the source
|
13454
13513
|
# bucket is owned by a different account, the request will fail with an
|
13455
13514
|
# HTTP `403 (Access Denied)` error.
|
13456
13515
|
#
|
@@ -13553,6 +13612,265 @@ module Aws::S3
|
|
13553
13612
|
req.send_request(options)
|
13554
13613
|
end
|
13555
13614
|
|
13615
|
+
# Passes transformed objects to a `GetObject` operation when using
|
13616
|
+
# Object Lambda Access Points. For information about Object Lambda
|
13617
|
+
# Access Points, see [Transforming objects with Object Lambda Access
|
13618
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
13619
|
+
#
|
13620
|
+
# This operation supports metadata that can be returned by
|
13621
|
+
# [GetObject][2], in addition to `RequestRoute`, `RequestToken`,
|
13622
|
+
# `StatusCode`, `ErrorCode`, and `ErrorMessage`. The `GetObject`
|
13623
|
+
# response metadata is supported so that the `WriteGetObjectResponse`
|
13624
|
+
# caller, typically an AWS Lambda function, can provide the same
|
13625
|
+
# metadata when it internally invokes `GetObject`. When
|
13626
|
+
# `WriteGetObjectResponse` is called by a customer-owned Lambda
|
13627
|
+
# function, the metadata returned to the end user `GetObject` call might
|
13628
|
+
# differ from what Amazon S3 would normally return.
|
13629
|
+
#
|
13630
|
+
#
|
13631
|
+
#
|
13632
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
13633
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13634
|
+
#
|
13635
|
+
# @option params [required, String] :request_route
|
13636
|
+
# Route prefix to the HTTP URL generated.
|
13637
|
+
#
|
13638
|
+
# @option params [required, String] :request_token
|
13639
|
+
# A single use encrypted token that maps `WriteGetObjectResponse` to the
|
13640
|
+
# end user `GetObject` request.
|
13641
|
+
#
|
13642
|
+
# @option params [String, IO] :body
|
13643
|
+
# The object data.
|
13644
|
+
#
|
13645
|
+
# @option params [Integer] :status_code
|
13646
|
+
# The integer status code for an HTTP response of a corresponding
|
13647
|
+
# `GetObject` request.
|
13648
|
+
#
|
13649
|
+
# **Status Codes**
|
13650
|
+
#
|
13651
|
+
# * *200 - OK*
|
13652
|
+
#
|
13653
|
+
# * *206 - Partial Content*
|
13654
|
+
#
|
13655
|
+
# * *304 - Not Modified*
|
13656
|
+
#
|
13657
|
+
# * *400 - Bad Request*
|
13658
|
+
#
|
13659
|
+
# * *401 - Unauthorized*
|
13660
|
+
#
|
13661
|
+
# * *403 - Forbidden*
|
13662
|
+
#
|
13663
|
+
# * *404 - Not Found*
|
13664
|
+
#
|
13665
|
+
# * *405 - Method Not Allowed*
|
13666
|
+
#
|
13667
|
+
# * *409 - Conflict*
|
13668
|
+
#
|
13669
|
+
# * *411 - Length Required*
|
13670
|
+
#
|
13671
|
+
# * *412 - Precondition Failed*
|
13672
|
+
#
|
13673
|
+
# * *416 - Range Not Satisfiable*
|
13674
|
+
#
|
13675
|
+
# * *500 - Internal Server Error*
|
13676
|
+
#
|
13677
|
+
# * *503 - Service Unavailable*
|
13678
|
+
#
|
13679
|
+
# @option params [String] :error_code
|
13680
|
+
# A string that uniquely identifies an error condition. Returned in the
|
13681
|
+
# <Code> tag of the error XML response for a corresponding
|
13682
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13683
|
+
# or when the transformed object is provided in the body.
|
13684
|
+
#
|
13685
|
+
# @option params [String] :error_message
|
13686
|
+
# Contains a generic description of the error condition. Returned in the
|
13687
|
+
# <Message> tag of the error XML response for a corresponding
|
13688
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13689
|
+
# or when the transformed object is provided in body.
|
13690
|
+
#
|
13691
|
+
# @option params [String] :accept_ranges
|
13692
|
+
# Indicates that a range of bytes was specified.
|
13693
|
+
#
|
13694
|
+
# @option params [String] :cache_control
|
13695
|
+
# Specifies caching behavior along the request/reply chain.
|
13696
|
+
#
|
13697
|
+
# @option params [String] :content_disposition
|
13698
|
+
# Specifies presentational information for the object.
|
13699
|
+
#
|
13700
|
+
# @option params [String] :content_encoding
|
13701
|
+
# Specifies what content encodings have been applied to the object and
|
13702
|
+
# thus what decoding mechanisms must be applied to obtain the media-type
|
13703
|
+
# referenced by the Content-Type header field.
|
13704
|
+
#
|
13705
|
+
# @option params [String] :content_language
|
13706
|
+
# The language the content is in.
|
13707
|
+
#
|
13708
|
+
# @option params [Integer] :content_length
|
13709
|
+
# The size of the content body in bytes.
|
13710
|
+
#
|
13711
|
+
# @option params [String] :content_range
|
13712
|
+
# The portion of the object returned in the response.
|
13713
|
+
#
|
13714
|
+
# @option params [String] :content_type
|
13715
|
+
# A standard MIME type describing the format of the object data.
|
13716
|
+
#
|
13717
|
+
# @option params [Boolean] :delete_marker
|
13718
|
+
# Specifies whether an object stored in Amazon S3 is (`true`) or is not
|
13719
|
+
# (`false`) a delete marker.
|
13720
|
+
#
|
13721
|
+
# @option params [String] :etag
|
13722
|
+
# An opaque identifier assigned by a web server to a specific version of
|
13723
|
+
# a resource found at a URL.
|
13724
|
+
#
|
13725
|
+
# @option params [Time,DateTime,Date,Integer,String] :expires
|
13726
|
+
# The date and time at which the object is no longer cacheable.
|
13727
|
+
#
|
13728
|
+
# @option params [String] :expiration
|
13729
|
+
# If object stored in Amazon S3 expiration is configured (see PUT Bucket
|
13730
|
+
# lifecycle) it includes expiry-date and rule-id key-value pairs
|
13731
|
+
# providing object expiration information. The value of the rule-id is
|
13732
|
+
# URL encoded.
|
13733
|
+
#
|
13734
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified
|
13735
|
+
# The date and time that the object was last modified.
|
13736
|
+
#
|
13737
|
+
# @option params [Integer] :missing_meta
|
13738
|
+
# Set to the number of metadata entries not returned in `x-amz-meta`
|
13739
|
+
# headers. This can happen if you create metadata using an API like SOAP
|
13740
|
+
# that supports more flexible metadata than the REST API. For example,
|
13741
|
+
# using SOAP, you can create metadata whose values are not legal HTTP
|
13742
|
+
# headers.
|
13743
|
+
#
|
13744
|
+
# @option params [Hash<String,String>] :metadata
|
13745
|
+
# A map of metadata to store with the object in S3.
|
13746
|
+
#
|
13747
|
+
# @option params [String] :object_lock_mode
|
13748
|
+
# Indicates whether an object stored in Amazon S3 has Object Lock
|
13749
|
+
# enabled. For more information about S3 Object Lock, see [Object
|
13750
|
+
# Lock][1].
|
13751
|
+
#
|
13752
|
+
#
|
13753
|
+
#
|
13754
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
13755
|
+
#
|
13756
|
+
# @option params [String] :object_lock_legal_hold_status
|
13757
|
+
# Indicates whether an object stored in Amazon S3 has an active legal
|
13758
|
+
# hold.
|
13759
|
+
#
|
13760
|
+
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
13761
|
+
# The date and time when Object Lock is configured to expire.
|
13762
|
+
#
|
13763
|
+
# @option params [Integer] :parts_count
|
13764
|
+
# The count of parts this object has.
|
13765
|
+
#
|
13766
|
+
# @option params [String] :replication_status
|
13767
|
+
# Indicates if request involves bucket that is either a source or
|
13768
|
+
# destination in a Replication rule. For more information about S3
|
13769
|
+
# Replication, see [Replication][1].
|
13770
|
+
#
|
13771
|
+
#
|
13772
|
+
#
|
13773
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
|
13774
|
+
#
|
13775
|
+
# @option params [String] :request_charged
|
13776
|
+
# If present, indicates that the requester was successfully charged for
|
13777
|
+
# the request.
|
13778
|
+
#
|
13779
|
+
# @option params [String] :restore
|
13780
|
+
# Provides information about object restoration operation and expiration
|
13781
|
+
# time of the restored object copy.
|
13782
|
+
#
|
13783
|
+
# @option params [String] :server_side_encryption
|
13784
|
+
# The server-side encryption algorithm used when storing requested
|
13785
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
13786
|
+
#
|
13787
|
+
# @option params [String] :sse_customer_algorithm
|
13788
|
+
# Encryption algorithm used if server-side encryption with a
|
13789
|
+
# customer-provided encryption key was specified for object stored in
|
13790
|
+
# Amazon S3.
|
13791
|
+
#
|
13792
|
+
# @option params [String] :ssekms_key_id
|
13793
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
13794
|
+
# KMS) symmetric customer managed customer master key (CMK) that was
|
13795
|
+
# used for stored in Amazon S3 object.
|
13796
|
+
#
|
13797
|
+
# @option params [String] :sse_customer_key_md5
|
13798
|
+
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
13799
|
+
# S3 to encrypt data stored in S3. For more information, see [Protecting
|
13800
|
+
# data using server-side encryption with customer-provided encryption
|
13801
|
+
# keys (SSE-C)][1].
|
13802
|
+
#
|
13803
|
+
#
|
13804
|
+
#
|
13805
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
13806
|
+
#
|
13807
|
+
# @option params [String] :storage_class
|
13808
|
+
# The class of storage used to store object in Amazon S3.
|
13809
|
+
#
|
13810
|
+
# @option params [Integer] :tag_count
|
13811
|
+
# The number of tags, if any, on the object.
|
13812
|
+
#
|
13813
|
+
# @option params [String] :version_id
|
13814
|
+
# An ID used to reference a specific version of the object.
|
13815
|
+
#
|
13816
|
+
# @option params [Boolean] :bucket_key_enabled
|
13817
|
+
# Indicates whether the object stored in Amazon S3 uses an S3 bucket key
|
13818
|
+
# for server-side encryption with AWS KMS (SSE-KMS).
|
13819
|
+
#
|
13820
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13821
|
+
#
|
13822
|
+
# @example Request syntax with placeholder values
|
13823
|
+
#
|
13824
|
+
# resp = client.write_get_object_response({
|
13825
|
+
# request_route: "RequestRoute", # required
|
13826
|
+
# request_token: "RequestToken", # required
|
13827
|
+
# body: source_file,
|
13828
|
+
# status_code: 1,
|
13829
|
+
# error_code: "ErrorCode",
|
13830
|
+
# error_message: "ErrorMessage",
|
13831
|
+
# accept_ranges: "AcceptRanges",
|
13832
|
+
# cache_control: "CacheControl",
|
13833
|
+
# content_disposition: "ContentDisposition",
|
13834
|
+
# content_encoding: "ContentEncoding",
|
13835
|
+
# content_language: "ContentLanguage",
|
13836
|
+
# content_length: 1,
|
13837
|
+
# content_range: "ContentRange",
|
13838
|
+
# content_type: "ContentType",
|
13839
|
+
# delete_marker: false,
|
13840
|
+
# etag: "ETag",
|
13841
|
+
# expires: Time.now,
|
13842
|
+
# expiration: "Expiration",
|
13843
|
+
# last_modified: Time.now,
|
13844
|
+
# missing_meta: 1,
|
13845
|
+
# metadata: {
|
13846
|
+
# "MetadataKey" => "MetadataValue",
|
13847
|
+
# },
|
13848
|
+
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
13849
|
+
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
13850
|
+
# object_lock_retain_until_date: Time.now,
|
13851
|
+
# parts_count: 1,
|
13852
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
13853
|
+
# request_charged: "requester", # accepts requester
|
13854
|
+
# restore: "Restore",
|
13855
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
13856
|
+
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
13857
|
+
# ssekms_key_id: "SSEKMSKeyId",
|
13858
|
+
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
13859
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
13860
|
+
# tag_count: 1,
|
13861
|
+
# version_id: "ObjectVersionId",
|
13862
|
+
# bucket_key_enabled: false,
|
13863
|
+
# })
|
13864
|
+
#
|
13865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse AWS API Documentation
|
13866
|
+
#
|
13867
|
+
# @overload write_get_object_response(params = {})
|
13868
|
+
# @param [Hash] params ({})
|
13869
|
+
def write_get_object_response(params = {}, options = {})
|
13870
|
+
req = build_request(:write_get_object_response, params)
|
13871
|
+
req.send_request(options)
|
13872
|
+
end
|
13873
|
+
|
13556
13874
|
# @!endgroup
|
13557
13875
|
|
13558
13876
|
# @param params ({})
|
@@ -13566,7 +13884,7 @@ module Aws::S3
|
|
13566
13884
|
params: params,
|
13567
13885
|
config: config)
|
13568
13886
|
context[:gem_name] = 'aws-sdk-s3'
|
13569
|
-
context[:gem_version] = '1.
|
13887
|
+
context[:gem_version] = '1.92.0'
|
13570
13888
|
Seahorse::Client::Request.new(handlers, context)
|
13571
13889
|
end
|
13572
13890
|
|