aws-sdk-s3 1.89.0 → 1.93.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +748 -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 +4 -6
- data/lib/aws-sdk-s3/arn/object_lambda_arn.rb +64 -0
- data/lib/aws-sdk-s3/arn/outpost_access_point_arn.rb +4 -6
- data/lib/aws-sdk-s3/bucket.rb +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 +2 -2
- data/lib/aws-sdk-s3/bucket_tagging.rb +3 -3
- data/lib/aws-sdk-s3/bucket_versioning.rb +4 -4
- data/lib/aws-sdk-s3/bucket_website.rb +3 -3
- data/lib/aws-sdk-s3/client.rb +1104 -832
- data/lib/aws-sdk-s3/client_api.rb +60 -1
- data/lib/aws-sdk-s3/errors.rb +1 -1
- data/lib/aws-sdk-s3/event_streams.rb +1 -1
- data/lib/aws-sdk-s3/file_uploader.rb +2 -2
- data/lib/aws-sdk-s3/multipart_upload.rb +4 -4
- data/lib/aws-sdk-s3/multipart_upload_part.rb +5 -5
- data/lib/aws-sdk-s3/object.rb +103 -17
- data/lib/aws-sdk-s3/object_acl.rb +2 -2
- data/lib/aws-sdk-s3/object_summary.rb +16 -16
- data/lib/aws-sdk-s3/object_version.rb +5 -5
- data/lib/aws-sdk-s3/plugins/arn.rb +57 -34
- data/lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb +9 -9
- data/lib/aws-sdk-s3/plugins/object_lambda_endpoint.rb +25 -0
- data/lib/aws-sdk-s3/plugins/s3_signer.rb +6 -0
- data/lib/aws-sdk-s3/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +775 -439
- data/lib/aws-sdk-s3/waiters.rb +1 -1
- metadata +10 -5
@@ -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
|
|
@@ -182,7 +182,7 @@ module Aws::S3
|
|
182
182
|
# })
|
183
183
|
# @param [Hash] options ({})
|
184
184
|
# @option options [String] :expected_bucket_owner
|
185
|
-
# The account
|
185
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
186
186
|
# a different account, the request will fail with an HTTP `403 (Access
|
187
187
|
# Denied)` error.
|
188
188
|
# @return [EmptyStructure]
|
@@ -198,6 +198,7 @@ module Aws::S3
|
|
198
198
|
# cors_configuration: { # required
|
199
199
|
# cors_rules: [ # required
|
200
200
|
# {
|
201
|
+
# id: "ID",
|
201
202
|
# allowed_headers: ["AllowedHeader"],
|
202
203
|
# allowed_methods: ["AllowedMethod"], # required
|
203
204
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -213,8 +214,7 @@ module Aws::S3
|
|
213
214
|
# @option options [required, Types::CORSConfiguration] :cors_configuration
|
214
215
|
# Describes the cross-origin access configuration for objects in an
|
215
216
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
216
|
-
# Resource Sharing][1] in the *Amazon
|
217
|
-
# Guide*.
|
217
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
218
218
|
#
|
219
219
|
#
|
220
220
|
#
|
@@ -231,7 +231,7 @@ module Aws::S3
|
|
231
231
|
#
|
232
232
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
233
233
|
# @option options [String] :expected_bucket_owner
|
234
|
-
# The account
|
234
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
235
235
|
# a different account, the request will fail with an HTTP `403 (Access
|
236
236
|
# Denied)` error.
|
237
237
|
# @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]
|
@@ -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
|
|
@@ -198,7 +198,7 @@ module Aws::S3
|
|
198
198
|
# @option options [required, Types::RequestPaymentConfiguration] :request_payment_configuration
|
199
199
|
# Container for Payer.
|
200
200
|
# @option options [String] :expected_bucket_owner
|
201
|
-
# The account
|
201
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
202
202
|
# a different account, the request will fail with an HTTP `403 (Access
|
203
203
|
# Denied)` error.
|
204
204
|
# @return [EmptyStructure]
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -181,7 +181,7 @@ module Aws::S3
|
|
181
181
|
# })
|
182
182
|
# @param [Hash] options ({})
|
183
183
|
# @option options [String] :expected_bucket_owner
|
184
|
-
# The account
|
184
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
185
185
|
# a different account, the request will fail with an HTTP `403 (Access
|
186
186
|
# Denied)` error.
|
187
187
|
# @return [EmptyStructure]
|
@@ -220,7 +220,7 @@ module Aws::S3
|
|
220
220
|
# @option options [required, Types::Tagging] :tagging
|
221
221
|
# Container for the `TagSet` and `Tag` elements.
|
222
222
|
# @option options [String] :expected_bucket_owner
|
223
|
-
# The account
|
223
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
224
224
|
# a different account, the request will fail with an HTTP `403 (Access
|
225
225
|
# Denied)` error.
|
226
226
|
# @return [EmptyStructure]
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -207,7 +207,7 @@ module Aws::S3
|
|
207
207
|
# The concatenation of the authentication device's serial number, a
|
208
208
|
# space, and the value that is displayed on your authentication device.
|
209
209
|
# @option options [String] :expected_bucket_owner
|
210
|
-
# The account
|
210
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
211
211
|
# a different account, the request will fail with an HTTP `403 (Access
|
212
212
|
# Denied)` error.
|
213
213
|
# @return [EmptyStructure]
|
@@ -252,7 +252,7 @@ module Aws::S3
|
|
252
252
|
# @option options [required, Types::VersioningConfiguration] :versioning_configuration
|
253
253
|
# Container for setting the versioning state.
|
254
254
|
# @option options [String] :expected_bucket_owner
|
255
|
-
# The account
|
255
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
256
256
|
# a different account, the request will fail with an HTTP `403 (Access
|
257
257
|
# Denied)` error.
|
258
258
|
# @return [EmptyStructure]
|
@@ -286,7 +286,7 @@ module Aws::S3
|
|
286
286
|
# The concatenation of the authentication device's serial number, a
|
287
287
|
# space, and the value that is displayed on your authentication device.
|
288
288
|
# @option options [String] :expected_bucket_owner
|
289
|
-
# The account
|
289
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
290
290
|
# a different account, the request will fail with an HTTP `403 (Access
|
291
291
|
# Denied)` error.
|
292
292
|
# @return [EmptyStructure]
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -203,7 +203,7 @@ module Aws::S3
|
|
203
203
|
# })
|
204
204
|
# @param [Hash] options ({})
|
205
205
|
# @option options [String] :expected_bucket_owner
|
206
|
-
# The account
|
206
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
207
207
|
# a different account, the request will fail with an HTTP `403 (Access
|
208
208
|
# Denied)` error.
|
209
209
|
# @return [EmptyStructure]
|
@@ -261,7 +261,7 @@ module Aws::S3
|
|
261
261
|
# @option options [required, Types::WebsiteConfiguration] :website_configuration
|
262
262
|
# Container for the request.
|
263
263
|
# @option options [String] :expected_bucket_owner
|
264
|
-
# The account
|
264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
265
265
|
# a different account, the request will fail with an HTTP `403 (Access
|
266
266
|
# Denied)` error.
|
267
267
|
# @return [EmptyStructure]
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -39,6 +39,7 @@ require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
|
39
39
|
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
40
40
|
require 'aws-sdk-s3/plugins/location_constraint.rb'
|
41
41
|
require 'aws-sdk-s3/plugins/md5s.rb'
|
42
|
+
require 'aws-sdk-s3/plugins/object_lambda_endpoint.rb'
|
42
43
|
require 'aws-sdk-s3/plugins/redirects.rb'
|
43
44
|
require 'aws-sdk-s3/plugins/s3_host_id.rb'
|
44
45
|
require 'aws-sdk-s3/plugins/s3_signer.rb'
|
@@ -102,6 +103,7 @@ module Aws::S3
|
|
102
103
|
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
103
104
|
add_plugin(Aws::S3::Plugins::LocationConstraint)
|
104
105
|
add_plugin(Aws::S3::Plugins::Md5s)
|
106
|
+
add_plugin(Aws::S3::Plugins::ObjectLambdaEndpoint)
|
105
107
|
add_plugin(Aws::S3::Plugins::Redirects)
|
106
108
|
add_plugin(Aws::S3::Plugins::S3HostId)
|
107
109
|
add_plugin(Aws::S3::Plugins::S3Signer)
|
@@ -326,8 +328,8 @@ module Aws::S3
|
|
326
328
|
#
|
327
329
|
#
|
328
330
|
# @option options [String] :s3_us_east_1_regional_endpoint ("legacy")
|
329
|
-
#
|
330
|
-
#
|
331
|
+
# Pass in `regional` to enable the `us-east-1` regional endpoint.
|
332
|
+
# Defaults to `legacy` mode which uses the global endpoint.
|
331
333
|
#
|
332
334
|
# @option options [Boolean] :s3_use_arn_region (true)
|
333
335
|
# For S3 ARNs passed into the `:bucket` parameter, this option will
|
@@ -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
|
-
# the *Amazon
|
458
|
+
# the *Amazon S3 User 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 S3 User Guide*.
|
466
468
|
#
|
467
469
|
#
|
468
470
|
#
|
469
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
470
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
471
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
472
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
471
473
|
#
|
472
474
|
# @option params [required, String] :key
|
473
475
|
# Key of the object for which the multipart upload was initiated.
|
@@ -487,7 +489,7 @@ module Aws::S3
|
|
487
489
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
488
490
|
#
|
489
491
|
# @option params [String] :expected_bucket_owner
|
490
|
-
# The account
|
492
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
491
493
|
# a different account, the request will fail with an HTTP `403 (Access
|
492
494
|
# Denied)` error.
|
493
495
|
#
|
@@ -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
|
-
# the *Amazon
|
929
|
+
# the *Amazon S3 User 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 S3 User 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
|
#
|
@@ -1418,33 +1419,33 @@ module Aws::S3
|
|
1418
1419
|
# * {Types::CreateBucketOutput#location #location} => String
|
1419
1420
|
#
|
1420
1421
|
#
|
1421
|
-
# @example Example: To create a bucket
|
1422
|
+
# @example Example: To create a bucket in a specific region
|
1422
1423
|
#
|
1423
|
-
# # The following example creates a bucket.
|
1424
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
1424
1425
|
#
|
1425
1426
|
# resp = client.create_bucket({
|
1426
1427
|
# bucket: "examplebucket",
|
1428
|
+
# create_bucket_configuration: {
|
1429
|
+
# location_constraint: "eu-west-1",
|
1430
|
+
# },
|
1427
1431
|
# })
|
1428
1432
|
#
|
1429
1433
|
# resp.to_h outputs the following:
|
1430
1434
|
# {
|
1431
|
-
# location: "/
|
1435
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1432
1436
|
# }
|
1433
1437
|
#
|
1434
|
-
# @example Example: To create a bucket
|
1438
|
+
# @example Example: To create a bucket
|
1435
1439
|
#
|
1436
|
-
# # The following example creates a bucket.
|
1440
|
+
# # The following example creates a bucket.
|
1437
1441
|
#
|
1438
1442
|
# resp = client.create_bucket({
|
1439
1443
|
# bucket: "examplebucket",
|
1440
|
-
# create_bucket_configuration: {
|
1441
|
-
# location_constraint: "eu-west-1",
|
1442
|
-
# },
|
1443
1444
|
# })
|
1444
1445
|
#
|
1445
1446
|
# resp.to_h outputs the following:
|
1446
1447
|
# {
|
1447
|
-
# location: "
|
1448
|
+
# location: "/examplebucket",
|
1448
1449
|
# }
|
1449
1450
|
#
|
1450
1451
|
# @example Request syntax with placeholder values
|
@@ -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
|
-
# the *Amazon
|
1727
|
+
# the *Amazon S3 User 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 S3 User 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
|
#
|
@@ -2741,7 +2742,8 @@ module Aws::S3
|
|
2741
2742
|
|
2742
2743
|
# Removes the null version (if there is one) of an object and inserts a
|
2743
2744
|
# delete marker, which becomes the latest version of the object. If
|
2744
|
-
# there isn't a null version, Amazon S3 does not remove any objects
|
2745
|
+
# there isn't a null version, Amazon S3 does not remove any objects but
|
2746
|
+
# will still respond that the command was successful.
|
2745
2747
|
#
|
2746
2748
|
# To remove a specific version, you must be the bucket owner and you
|
2747
2749
|
# must use the version Id subresource. Using this subresource
|
@@ -2757,14 +2759,14 @@ module Aws::S3
|
|
2757
2759
|
# For more information about MFA Delete, see [Using MFA Delete][1]. To
|
2758
2760
|
# see sample requests that use versioning, see [Sample Request][2].
|
2759
2761
|
#
|
2760
|
-
# You can delete objects by explicitly calling
|
2762
|
+
# You can delete objects by explicitly calling DELETE Object or
|
2761
2763
|
# configure its lifecycle ([PutBucketLifecycle][3]) to enable Amazon S3
|
2762
2764
|
# to remove them for you. If you want to block users or accounts from
|
2763
2765
|
# removing or deleting objects from your bucket, you must deny them the
|
2764
2766
|
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
|
2765
2767
|
# `s3:PutLifeCycleConfiguration` actions.
|
2766
2768
|
#
|
2767
|
-
# The following
|
2769
|
+
# The following action is related to `DeleteObject`\:
|
2768
2770
|
#
|
2769
2771
|
# * [PutObject][4]
|
2770
2772
|
#
|
@@ -2780,27 +2782,27 @@ module Aws::S3
|
|
2780
2782
|
# @option params [required, String] :bucket
|
2781
2783
|
# The bucket name of the bucket containing the object.
|
2782
2784
|
#
|
2783
|
-
# When using this
|
2784
|
-
# the access point hostname. The access point hostname takes the form
|
2785
|
+
# When using this action with an access point, you must direct requests
|
2786
|
+
# to the access point hostname. The access point hostname takes the form
|
2785
2787
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2786
|
-
# When using this
|
2787
|
-
#
|
2788
|
+
# When using this action with an access point through the AWS SDKs, you
|
2789
|
+
# provide the access point ARN in place of the bucket name. For more
|
2788
2790
|
# information about access point ARNs, see [Using Access Points][1] in
|
2789
|
-
# the *Amazon
|
2791
|
+
# the *Amazon S3 User Guide*.
|
2790
2792
|
#
|
2791
|
-
# When using this
|
2793
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2792
2794
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2793
2795
|
# takes the form
|
2794
2796
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2795
|
-
# When using this
|
2796
|
-
#
|
2797
|
-
#
|
2798
|
-
#
|
2797
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2798
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2799
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2800
|
+
# in the *Amazon S3 User Guide*.
|
2799
2801
|
#
|
2800
2802
|
#
|
2801
2803
|
#
|
2802
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2803
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2805
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2804
2806
|
#
|
2805
2807
|
# @option params [required, String] :key
|
2806
2808
|
# Key name of the object to delete.
|
@@ -2830,7 +2832,7 @@ module Aws::S3
|
|
2830
2832
|
# restrictions to process this operation.
|
2831
2833
|
#
|
2832
2834
|
# @option params [String] :expected_bucket_owner
|
2833
|
-
# The account
|
2835
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2834
2836
|
# a different account, the request will fail with an HTTP `403 (Access
|
2835
2837
|
# Denied)` error.
|
2836
2838
|
#
|
@@ -2841,6 +2843,15 @@ module Aws::S3
|
|
2841
2843
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2842
2844
|
#
|
2843
2845
|
#
|
2846
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2847
|
+
#
|
2848
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2849
|
+
#
|
2850
|
+
# resp = client.delete_object({
|
2851
|
+
# bucket: "ExampleBucket",
|
2852
|
+
# key: "HappyFace.jpg",
|
2853
|
+
# })
|
2854
|
+
#
|
2844
2855
|
# @example Example: To delete an object
|
2845
2856
|
#
|
2846
2857
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2854,15 +2865,6 @@ module Aws::S3
|
|
2854
2865
|
# {
|
2855
2866
|
# }
|
2856
2867
|
#
|
2857
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
2858
|
-
#
|
2859
|
-
# # The following example deletes an object from a non-versioned bucket.
|
2860
|
-
#
|
2861
|
-
# resp = client.delete_object({
|
2862
|
-
# bucket: "ExampleBucket",
|
2863
|
-
# key: "HappyFace.jpg",
|
2864
|
-
# })
|
2865
|
-
#
|
2866
2868
|
# @example Request syntax with placeholder values
|
2867
2869
|
#
|
2868
2870
|
# resp = client.delete_object({
|
@@ -2916,27 +2918,27 @@ module Aws::S3
|
|
2916
2918
|
# @option params [required, String] :bucket
|
2917
2919
|
# The bucket name containing the objects from which to remove the tags.
|
2918
2920
|
#
|
2919
|
-
# When using this
|
2920
|
-
# the access point hostname. The access point hostname takes the form
|
2921
|
+
# When using this action with an access point, you must direct requests
|
2922
|
+
# to the access point hostname. The access point hostname takes the form
|
2921
2923
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2922
|
-
# When using this
|
2923
|
-
#
|
2924
|
+
# When using this action with an access point through the AWS SDKs, you
|
2925
|
+
# provide the access point ARN in place of the bucket name. For more
|
2924
2926
|
# information about access point ARNs, see [Using Access Points][1] in
|
2925
|
-
# the *Amazon
|
2927
|
+
# the *Amazon S3 User Guide*.
|
2926
2928
|
#
|
2927
|
-
# When using this
|
2929
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2928
2930
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2929
2931
|
# takes the form
|
2930
2932
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2931
|
-
# When using this
|
2932
|
-
#
|
2933
|
-
#
|
2934
|
-
#
|
2933
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2934
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2935
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2936
|
+
# in the *Amazon S3 User Guide*.
|
2935
2937
|
#
|
2936
2938
|
#
|
2937
2939
|
#
|
2938
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2939
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2940
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
2941
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
2940
2942
|
#
|
2941
2943
|
# @option params [required, String] :key
|
2942
2944
|
# The key that identifies the object in the bucket from which to remove
|
@@ -2946,7 +2948,7 @@ module Aws::S3
|
|
2946
2948
|
# The versionId of the object that the tag-set will be removed from.
|
2947
2949
|
#
|
2948
2950
|
# @option params [String] :expected_bucket_owner
|
2949
|
-
# The account
|
2951
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
2950
2952
|
# a different account, the request will fail with an HTTP `403 (Access
|
2951
2953
|
# Denied)` error.
|
2952
2954
|
#
|
@@ -2955,35 +2957,35 @@ module Aws::S3
|
|
2955
2957
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2956
2958
|
#
|
2957
2959
|
#
|
2958
|
-
# @example Example: To remove tag set from an object
|
2960
|
+
# @example Example: To remove tag set from an object
|
2959
2961
|
#
|
2960
|
-
# # The following example removes tag set associated with the specified object
|
2961
|
-
# #
|
2962
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2963
|
+
# # operation removes tag set from the latest object version.
|
2962
2964
|
#
|
2963
2965
|
# resp = client.delete_object_tagging({
|
2964
2966
|
# bucket: "examplebucket",
|
2965
2967
|
# key: "HappyFace.jpg",
|
2966
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2967
2968
|
# })
|
2968
2969
|
#
|
2969
2970
|
# resp.to_h outputs the following:
|
2970
2971
|
# {
|
2971
|
-
# version_id: "
|
2972
|
+
# version_id: "null",
|
2972
2973
|
# }
|
2973
2974
|
#
|
2974
|
-
# @example Example: To remove tag set from an object
|
2975
|
+
# @example Example: To remove tag set from an object version
|
2975
2976
|
#
|
2976
|
-
# # The following example removes tag set associated with the specified object.
|
2977
|
-
# #
|
2977
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2978
|
+
# # object key and object version.
|
2978
2979
|
#
|
2979
2980
|
# resp = client.delete_object_tagging({
|
2980
2981
|
# bucket: "examplebucket",
|
2981
2982
|
# key: "HappyFace.jpg",
|
2983
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2982
2984
|
# })
|
2983
2985
|
#
|
2984
2986
|
# resp.to_h outputs the following:
|
2985
2987
|
# {
|
2986
|
-
# version_id: "
|
2988
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2987
2989
|
# }
|
2988
2990
|
#
|
2989
2991
|
# @example Request syntax with placeholder values
|
@@ -3008,27 +3010,27 @@ module Aws::S3
|
|
3008
3010
|
req.send_request(options)
|
3009
3011
|
end
|
3010
3012
|
|
3011
|
-
# This
|
3012
|
-
#
|
3013
|
-
#
|
3014
|
-
#
|
3013
|
+
# This action enables you to delete multiple objects from a bucket using
|
3014
|
+
# a single HTTP request. If you know the object keys that you want to
|
3015
|
+
# delete, then this action provides a suitable alternative to sending
|
3016
|
+
# individual delete requests, reducing per-request overhead.
|
3015
3017
|
#
|
3016
3018
|
# The request contains a list of up to 1000 keys that you want to
|
3017
3019
|
# delete. In the XML, you provide the object key names, and optionally,
|
3018
3020
|
# version IDs if you want to delete a specific version of the object
|
3019
3021
|
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
3020
|
-
# delete
|
3022
|
+
# delete action and returns the result of that delete, success, or
|
3021
3023
|
# failure, in the response. Note that if the object specified in the
|
3022
3024
|
# request is not found, Amazon S3 returns the result as deleted.
|
3023
3025
|
#
|
3024
|
-
# The
|
3025
|
-
#
|
3026
|
-
#
|
3027
|
-
#
|
3028
|
-
#
|
3029
|
-
#
|
3026
|
+
# The action supports two modes for the response: verbose and quiet. By
|
3027
|
+
# default, the action uses verbose mode in which the response includes
|
3028
|
+
# the result of deletion of each key in your request. In quiet mode the
|
3029
|
+
# response includes only keys where the delete action encountered an
|
3030
|
+
# error. For a successful deletion, the action does not return any
|
3031
|
+
# information about the delete in the response body.
|
3030
3032
|
#
|
3031
|
-
# When performing this
|
3033
|
+
# When performing this action on an MFA Delete enabled bucket, that
|
3032
3034
|
# attempts to delete any versioned objects, you must include an MFA
|
3033
3035
|
# token. If you do not provide one, the entire request will fail, even
|
3034
3036
|
# if there are non-versioned objects you are trying to delete. If you
|
@@ -3064,27 +3066,27 @@ module Aws::S3
|
|
3064
3066
|
# @option params [required, String] :bucket
|
3065
3067
|
# The bucket name containing the objects to delete.
|
3066
3068
|
#
|
3067
|
-
# When using this
|
3068
|
-
# the access point hostname. The access point hostname takes the form
|
3069
|
+
# When using this action with an access point, you must direct requests
|
3070
|
+
# to the access point hostname. The access point hostname takes the form
|
3069
3071
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3070
|
-
# When using this
|
3071
|
-
#
|
3072
|
+
# When using this action with an access point through the AWS SDKs, you
|
3073
|
+
# provide the access point ARN in place of the bucket name. For more
|
3072
3074
|
# information about access point ARNs, see [Using Access Points][1] in
|
3073
|
-
# the *Amazon
|
3075
|
+
# the *Amazon S3 User Guide*.
|
3074
3076
|
#
|
3075
|
-
# When using this
|
3077
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3076
3078
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3077
3079
|
# takes the form
|
3078
3080
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
3079
|
-
# When using this
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3081
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
3082
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
3083
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
3084
|
+
# in the *Amazon S3 User Guide*.
|
3083
3085
|
#
|
3084
3086
|
#
|
3085
3087
|
#
|
3086
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3087
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3088
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
3089
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
3088
3090
|
#
|
3089
3091
|
# @option params [required, Types::Delete] :delete
|
3090
3092
|
# Container for the request.
|
@@ -3112,7 +3114,7 @@ module Aws::S3
|
|
3112
3114
|
# permissions to perform this operation.
|
3113
3115
|
#
|
3114
3116
|
# @option params [String] :expected_bucket_owner
|
3115
|
-
# The account
|
3117
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3116
3118
|
# a different account, the request will fail with an HTTP `403 (Access
|
3117
3119
|
# Denied)` error.
|
3118
3120
|
#
|
@@ -3123,20 +3125,22 @@ module Aws::S3
|
|
3123
3125
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3124
3126
|
#
|
3125
3127
|
#
|
3126
|
-
# @example Example: To delete multiple
|
3128
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3127
3129
|
#
|
3128
|
-
# # The following example deletes objects from a bucket. The
|
3129
|
-
# #
|
3130
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3131
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3130
3132
|
#
|
3131
3133
|
# resp = client.delete_objects({
|
3132
3134
|
# bucket: "examplebucket",
|
3133
3135
|
# delete: {
|
3134
3136
|
# objects: [
|
3135
3137
|
# {
|
3136
|
-
# key: "
|
3138
|
+
# key: "HappyFace.jpg",
|
3139
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3137
3140
|
# },
|
3138
3141
|
# {
|
3139
|
-
# key: "
|
3142
|
+
# key: "HappyFace.jpg",
|
3143
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3140
3144
|
# },
|
3141
3145
|
# ],
|
3142
3146
|
# quiet: false,
|
@@ -3147,34 +3151,30 @@ module Aws::S3
|
|
3147
3151
|
# {
|
3148
3152
|
# deleted: [
|
3149
3153
|
# {
|
3150
|
-
#
|
3151
|
-
#
|
3152
|
-
# key: "objectkey1",
|
3154
|
+
# key: "HappyFace.jpg",
|
3155
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3153
3156
|
# },
|
3154
3157
|
# {
|
3155
|
-
#
|
3156
|
-
#
|
3157
|
-
# key: "objectkey2",
|
3158
|
+
# key: "HappyFace.jpg",
|
3159
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3158
3160
|
# },
|
3159
3161
|
# ],
|
3160
3162
|
# }
|
3161
3163
|
#
|
3162
|
-
# @example Example: To delete multiple
|
3164
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3163
3165
|
#
|
3164
|
-
# # The following example deletes objects from a bucket. The
|
3165
|
-
# #
|
3166
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3167
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3166
3168
|
#
|
3167
3169
|
# resp = client.delete_objects({
|
3168
3170
|
# bucket: "examplebucket",
|
3169
3171
|
# delete: {
|
3170
3172
|
# objects: [
|
3171
3173
|
# {
|
3172
|
-
# key: "
|
3173
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3174
|
+
# key: "objectkey1",
|
3174
3175
|
# },
|
3175
3176
|
# {
|
3176
|
-
# key: "
|
3177
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3177
|
+
# key: "objectkey2",
|
3178
3178
|
# },
|
3179
3179
|
# ],
|
3180
3180
|
# quiet: false,
|
@@ -3185,12 +3185,14 @@ module Aws::S3
|
|
3185
3185
|
# {
|
3186
3186
|
# deleted: [
|
3187
3187
|
# {
|
3188
|
-
#
|
3189
|
-
#
|
3188
|
+
# delete_marker: true,
|
3189
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3190
|
+
# key: "objectkey1",
|
3190
3191
|
# },
|
3191
3192
|
# {
|
3192
|
-
#
|
3193
|
-
#
|
3193
|
+
# delete_marker: true,
|
3194
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3195
|
+
# key: "objectkey2",
|
3194
3196
|
# },
|
3195
3197
|
# ],
|
3196
3198
|
# }
|
@@ -3256,8 +3258,8 @@ module Aws::S3
|
|
3256
3258
|
#
|
3257
3259
|
#
|
3258
3260
|
#
|
3259
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3260
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3261
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3262
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3261
3263
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html
|
3262
3264
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html
|
3263
3265
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html
|
@@ -3268,7 +3270,7 @@ module Aws::S3
|
|
3268
3270
|
# to delete.
|
3269
3271
|
#
|
3270
3272
|
# @option params [String] :expected_bucket_owner
|
3271
|
-
# The account
|
3273
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3272
3274
|
# a different account, the request will fail with an HTTP `403 (Access
|
3273
3275
|
# Denied)` error.
|
3274
3276
|
#
|
@@ -3290,7 +3292,7 @@ module Aws::S3
|
|
3290
3292
|
req.send_request(options)
|
3291
3293
|
end
|
3292
3294
|
|
3293
|
-
# This implementation of the GET
|
3295
|
+
# This implementation of the GET action uses the `accelerate`
|
3294
3296
|
# subresource to return the Transfer Acceleration state of a bucket,
|
3295
3297
|
# which is either `Enabled` or `Suspended`. Amazon S3 Transfer
|
3296
3298
|
# Acceleration is a bucket-level feature that enables you to perform
|
@@ -3301,8 +3303,8 @@ module Aws::S3
|
|
3301
3303
|
# permission by default. The bucket owner can grant this permission to
|
3302
3304
|
# others. For more information about permissions, see [Permissions
|
3303
3305
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3304
|
-
# Permissions to your Amazon S3 Resources][2] in the *Amazon
|
3305
|
-
#
|
3306
|
+
# Permissions to your Amazon S3 Resources][2] in the *Amazon S3 User
|
3307
|
+
# Guide*.
|
3306
3308
|
#
|
3307
3309
|
# You set the Transfer Acceleration state of an existing bucket to
|
3308
3310
|
# `Enabled` or `Suspended` by using the
|
@@ -3313,7 +3315,7 @@ module Aws::S3
|
|
3313
3315
|
# Acceleration state if a state has never been set on the bucket.
|
3314
3316
|
#
|
3315
3317
|
# For more information about transfer acceleration, see [Transfer
|
3316
|
-
# Acceleration][4] in the Amazon
|
3318
|
+
# Acceleration][4] in the Amazon S3 User Guide.
|
3317
3319
|
#
|
3318
3320
|
# **Related Resources**
|
3319
3321
|
#
|
@@ -3323,8 +3325,8 @@ module Aws::S3
|
|
3323
3325
|
#
|
3324
3326
|
#
|
3325
3327
|
#
|
3326
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3327
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3328
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3329
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3328
3330
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html
|
3329
3331
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
3330
3332
|
#
|
@@ -3333,7 +3335,7 @@ module Aws::S3
|
|
3333
3335
|
# retrieved.
|
3334
3336
|
#
|
3335
3337
|
# @option params [String] :expected_bucket_owner
|
3336
|
-
# The account
|
3338
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3337
3339
|
# a different account, the request will fail with an HTTP `403 (Access
|
3338
3340
|
# Denied)` error.
|
3339
3341
|
#
|
@@ -3361,8 +3363,8 @@ module Aws::S3
|
|
3361
3363
|
req.send_request(options)
|
3362
3364
|
end
|
3363
3365
|
|
3364
|
-
# This implementation of the `GET`
|
3365
|
-
#
|
3366
|
+
# This implementation of the `GET` action uses the `acl` subresource to
|
3367
|
+
# return the access control list (ACL) of a bucket. To use `GET` to
|
3366
3368
|
# return the ACL of the bucket, you must have `READ_ACP` access to the
|
3367
3369
|
# bucket. If `READ_ACP` permission is granted to the anonymous user, you
|
3368
3370
|
# can return the ACL of the bucket without using an authorization
|
@@ -3382,7 +3384,7 @@ module Aws::S3
|
|
3382
3384
|
# Specifies the S3 bucket whose ACL is being requested.
|
3383
3385
|
#
|
3384
3386
|
# @option params [String] :expected_bucket_owner
|
3385
|
-
# The account
|
3387
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3386
3388
|
# a different account, the request will fail with an HTTP `403 (Access
|
3387
3389
|
# Denied)` error.
|
3388
3390
|
#
|
@@ -3419,7 +3421,7 @@ module Aws::S3
|
|
3419
3421
|
req.send_request(options)
|
3420
3422
|
end
|
3421
3423
|
|
3422
|
-
# This implementation of the GET
|
3424
|
+
# This implementation of the GET action returns an analytics
|
3423
3425
|
# configuration (identified by the analytics configuration ID) from the
|
3424
3426
|
# bucket.
|
3425
3427
|
#
|
@@ -3428,12 +3430,11 @@ module Aws::S3
|
|
3428
3430
|
# permission by default. The bucket owner can grant this permission to
|
3429
3431
|
# others. For more information about permissions, see [ Permissions
|
3430
3432
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3431
|
-
# Permissions to Your Amazon S3 Resources][2] in the *Amazon
|
3432
|
-
#
|
3433
|
+
# Permissions to Your Amazon S3 Resources][2] in the *Amazon S3 User
|
3434
|
+
# Guide*.
|
3433
3435
|
#
|
3434
3436
|
# For information about Amazon S3 analytics feature, see [Amazon S3
|
3435
|
-
# Analytics – Storage Class Analysis][3] in the *Amazon
|
3436
|
-
# Service Developer Guide*.
|
3437
|
+
# Analytics – Storage Class Analysis][3] in the *Amazon S3 User Guide*.
|
3437
3438
|
#
|
3438
3439
|
# **Related Resources**
|
3439
3440
|
#
|
@@ -3445,8 +3446,8 @@ module Aws::S3
|
|
3445
3446
|
#
|
3446
3447
|
#
|
3447
3448
|
#
|
3448
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3449
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3449
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3450
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3450
3451
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
3451
3452
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
3452
3453
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -3460,7 +3461,7 @@ module Aws::S3
|
|
3460
3461
|
# The ID that identifies the analytics configuration.
|
3461
3462
|
#
|
3462
3463
|
# @option params [String] :expected_bucket_owner
|
3463
|
-
# The account
|
3464
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3464
3465
|
# a different account, the request will fail with an HTTP `403 (Access
|
3465
3466
|
# Denied)` error.
|
3466
3467
|
#
|
@@ -3526,7 +3527,7 @@ module Aws::S3
|
|
3526
3527
|
# The bucket name for which to get the cors configuration.
|
3527
3528
|
#
|
3528
3529
|
# @option params [String] :expected_bucket_owner
|
3529
|
-
# The account
|
3530
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3530
3531
|
# a different account, the request will fail with an HTTP `403 (Access
|
3531
3532
|
# Denied)` error.
|
3532
3533
|
#
|
@@ -3571,6 +3572,7 @@ module Aws::S3
|
|
3571
3572
|
# @example Response structure
|
3572
3573
|
#
|
3573
3574
|
# resp.cors_rules #=> Array
|
3575
|
+
# resp.cors_rules[0].id #=> String
|
3574
3576
|
# resp.cors_rules[0].allowed_headers #=> Array
|
3575
3577
|
# resp.cors_rules[0].allowed_headers[0] #=> String
|
3576
3578
|
# resp.cors_rules[0].allowed_methods #=> Array
|
@@ -3614,8 +3616,8 @@ module Aws::S3
|
|
3614
3616
|
#
|
3615
3617
|
#
|
3616
3618
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
3617
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3618
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3619
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3620
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3619
3621
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html
|
3620
3622
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
3621
3623
|
#
|
@@ -3624,7 +3626,7 @@ module Aws::S3
|
|
3624
3626
|
# configuration is retrieved.
|
3625
3627
|
#
|
3626
3628
|
# @option params [String] :expected_bucket_owner
|
3627
|
-
# The account
|
3629
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3628
3630
|
# a different account, the request will fail with an HTTP `403 (Access
|
3629
3631
|
# Denied)` error.
|
3630
3632
|
#
|
@@ -3758,8 +3760,8 @@ module Aws::S3
|
|
3758
3760
|
#
|
3759
3761
|
#
|
3760
3762
|
#
|
3761
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3762
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3763
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3764
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3763
3765
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
3764
3766
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
3765
3767
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -3773,7 +3775,7 @@ module Aws::S3
|
|
3773
3775
|
# The ID used to identify the inventory configuration.
|
3774
3776
|
#
|
3775
3777
|
# @option params [String] :expected_bucket_owner
|
3776
|
-
# The account
|
3778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3777
3779
|
# a different account, the request will fail with an HTTP `403 (Access
|
3778
3780
|
# Denied)` error.
|
3779
3781
|
#
|
@@ -3852,8 +3854,8 @@ module Aws::S3
|
|
3852
3854
|
#
|
3853
3855
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
3854
3856
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3855
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3856
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3857
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3858
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3857
3859
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3858
3860
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3859
3861
|
#
|
@@ -3861,7 +3863,7 @@ module Aws::S3
|
|
3861
3863
|
# The name of the bucket for which to get the lifecycle information.
|
3862
3864
|
#
|
3863
3865
|
# @option params [String] :expected_bucket_owner
|
3864
|
-
# The account
|
3866
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3865
3867
|
# a different account, the request will fail with an HTTP `403 (Access
|
3866
3868
|
# Denied)` error.
|
3867
3869
|
#
|
@@ -3931,7 +3933,7 @@ module Aws::S3
|
|
3931
3933
|
# API. The response describes the new filter element that you can use to
|
3932
3934
|
# specify a filter to select a subset of objects to which the rule
|
3933
3935
|
# applies. If you are using a previous version of the lifecycle
|
3934
|
-
# configuration, it still works. For the earlier
|
3936
|
+
# configuration, it still works. For the earlier action, see
|
3935
3937
|
# [GetBucketLifecycle][1].
|
3936
3938
|
#
|
3937
3939
|
# </note>
|
@@ -3970,8 +3972,8 @@ module Aws::S3
|
|
3970
3972
|
#
|
3971
3973
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
3972
3974
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
3973
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3974
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
3975
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
3976
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
3975
3977
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
3976
3978
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html
|
3977
3979
|
#
|
@@ -3979,7 +3981,7 @@ module Aws::S3
|
|
3979
3981
|
# The name of the bucket for which to get the lifecycle information.
|
3980
3982
|
#
|
3981
3983
|
# @option params [String] :expected_bucket_owner
|
3982
|
-
# The account
|
3984
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
3983
3985
|
# a different account, the request will fail with an HTTP `403 (Access
|
3984
3986
|
# Denied)` error.
|
3985
3987
|
#
|
@@ -4077,7 +4079,7 @@ module Aws::S3
|
|
4077
4079
|
# The name of the bucket for which to get the location.
|
4078
4080
|
#
|
4079
4081
|
# @option params [String] :expected_bucket_owner
|
4080
|
-
# The account
|
4082
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4081
4083
|
# a different account, the request will fail with an HTTP `403 (Access
|
4082
4084
|
# Denied)` error.
|
4083
4085
|
#
|
@@ -4138,7 +4140,7 @@ module Aws::S3
|
|
4138
4140
|
# The bucket name for which to get the logging information.
|
4139
4141
|
#
|
4140
4142
|
# @option params [String] :expected_bucket_owner
|
4141
|
-
# The account
|
4143
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4142
4144
|
# a different account, the request will fail with an HTTP `403 (Access
|
4143
4145
|
# Denied)` error.
|
4144
4146
|
#
|
@@ -4201,8 +4203,8 @@ module Aws::S3
|
|
4201
4203
|
#
|
4202
4204
|
#
|
4203
4205
|
#
|
4204
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4205
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
4206
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
4207
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
4206
4208
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
4207
4209
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
4208
4210
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
@@ -4216,7 +4218,7 @@ module Aws::S3
|
|
4216
4218
|
# The ID used to identify the metrics configuration.
|
4217
4219
|
#
|
4218
4220
|
# @option params [String] :expected_bucket_owner
|
4219
|
-
# The account
|
4221
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4220
4222
|
# a different account, the request will fail with an HTTP `403 (Access
|
4221
4223
|
# Denied)` error.
|
4222
4224
|
#
|
@@ -4263,7 +4265,7 @@ module Aws::S3
|
|
4263
4265
|
# configuration.
|
4264
4266
|
#
|
4265
4267
|
# @option params [String] :expected_bucket_owner
|
4266
|
-
# The account
|
4268
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4267
4269
|
# a different account, the request will fail with an HTTP `403 (Access
|
4268
4270
|
# Denied)` error.
|
4269
4271
|
#
|
@@ -4367,8 +4369,8 @@ module Aws::S3
|
|
4367
4369
|
|
4368
4370
|
# Returns the notification configuration of a bucket.
|
4369
4371
|
#
|
4370
|
-
# If notifications are not enabled on the bucket, the
|
4371
|
-
#
|
4372
|
+
# If notifications are not enabled on the bucket, the action returns an
|
4373
|
+
# empty `NotificationConfiguration` element.
|
4372
4374
|
#
|
4373
4375
|
# By default, you must be the bucket owner to read the notification
|
4374
4376
|
# configuration of a bucket. However, the bucket owner can use a bucket
|
@@ -4380,7 +4382,7 @@ module Aws::S3
|
|
4380
4382
|
# Events][1]. For more information about bucket policies, see [Using
|
4381
4383
|
# Bucket Policies][2].
|
4382
4384
|
#
|
4383
|
-
# The following
|
4385
|
+
# The following action is related to `GetBucketNotification`\:
|
4384
4386
|
#
|
4385
4387
|
# * [PutBucketNotification][3]
|
4386
4388
|
#
|
@@ -4397,7 +4399,7 @@ module Aws::S3
|
|
4397
4399
|
# configuration.
|
4398
4400
|
#
|
4399
4401
|
# @option params [String] :expected_bucket_owner
|
4400
|
-
# The account
|
4402
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4401
4403
|
# a different account, the request will fail with an HTTP `403 (Access
|
4402
4404
|
# Denied)` error.
|
4403
4405
|
#
|
@@ -4474,7 +4476,7 @@ module Aws::S3
|
|
4474
4476
|
# retrieve.
|
4475
4477
|
#
|
4476
4478
|
# @option params [String] :expected_bucket_owner
|
4477
|
-
# The account
|
4479
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4478
4480
|
# a different account, the request will fail with an HTTP `403 (Access
|
4479
4481
|
# Denied)` error.
|
4480
4482
|
#
|
@@ -4521,7 +4523,7 @@ module Aws::S3
|
|
4521
4523
|
# For more information about bucket policies, see [Using Bucket Policies
|
4522
4524
|
# and User Policies][1].
|
4523
4525
|
#
|
4524
|
-
# The following
|
4526
|
+
# The following action is related to `GetBucketPolicy`\:
|
4525
4527
|
#
|
4526
4528
|
# * [GetObject][2]
|
4527
4529
|
#
|
@@ -4536,7 +4538,7 @@ module Aws::S3
|
|
4536
4538
|
# The bucket name for which to get the bucket policy.
|
4537
4539
|
#
|
4538
4540
|
# @option params [String] :expected_bucket_owner
|
4539
|
-
# The account
|
4541
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4540
4542
|
# a different account, the request will fail with an HTTP `403 (Access
|
4541
4543
|
# Denied)` error.
|
4542
4544
|
#
|
@@ -4611,7 +4613,7 @@ module Aws::S3
|
|
4611
4613
|
# retrieve.
|
4612
4614
|
#
|
4613
4615
|
# @option params [String] :expected_bucket_owner
|
4614
|
-
# The account
|
4616
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4615
4617
|
# a different account, the request will fail with an HTTP `403 (Access
|
4616
4618
|
# Denied)` error.
|
4617
4619
|
#
|
@@ -4648,9 +4650,9 @@ module Aws::S3
|
|
4648
4650
|
# </note>
|
4649
4651
|
#
|
4650
4652
|
# For information about replication configuration, see [Replication][1]
|
4651
|
-
# in the *Amazon
|
4653
|
+
# in the *Amazon S3 User Guide*.
|
4652
4654
|
#
|
4653
|
-
# This
|
4655
|
+
# This action requires permissions for the
|
4654
4656
|
# `s3:GetReplicationConfiguration` action. For more information about
|
4655
4657
|
# permissions, see [Using Bucket Policies and User Policies][2].
|
4656
4658
|
#
|
@@ -4679,7 +4681,7 @@ module Aws::S3
|
|
4679
4681
|
# The bucket name for which to get the replication information.
|
4680
4682
|
#
|
4681
4683
|
# @option params [String] :expected_bucket_owner
|
4682
|
-
# The account
|
4684
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4683
4685
|
# a different account, the request will fail with an HTTP `403 (Access
|
4684
4686
|
# Denied)` error.
|
4685
4687
|
#
|
@@ -4778,7 +4780,7 @@ module Aws::S3
|
|
4778
4780
|
# configuration
|
4779
4781
|
#
|
4780
4782
|
# @option params [String] :expected_bucket_owner
|
4781
|
-
# The account
|
4783
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4782
4784
|
# a different account, the request will fail with an HTTP `403 (Access
|
4783
4785
|
# Denied)` error.
|
4784
4786
|
#
|
@@ -4849,7 +4851,7 @@ module Aws::S3
|
|
4849
4851
|
# The name of the bucket for which to get the tagging information.
|
4850
4852
|
#
|
4851
4853
|
# @option params [String] :expected_bucket_owner
|
4852
|
-
# The account
|
4854
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4853
4855
|
# a different account, the request will fail with an HTTP `403 (Access
|
4854
4856
|
# Denied)` error.
|
4855
4857
|
#
|
@@ -4930,7 +4932,7 @@ module Aws::S3
|
|
4930
4932
|
# The name of the bucket for which to get the versioning information.
|
4931
4933
|
#
|
4932
4934
|
# @option params [String] :expected_bucket_owner
|
4933
|
-
# The account
|
4935
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
4934
4936
|
# a different account, the request will fail with an HTTP `403 (Access
|
4935
4937
|
# Denied)` error.
|
4936
4938
|
#
|
@@ -4980,7 +4982,7 @@ module Aws::S3
|
|
4980
4982
|
# configuration. For more information about hosting websites, see
|
4981
4983
|
# [Hosting Websites on Amazon S3][1].
|
4982
4984
|
#
|
4983
|
-
# This GET
|
4985
|
+
# This GET action requires the `S3:GetBucketWebsite` permission. By
|
4984
4986
|
# default, only the bucket owner can read the bucket website
|
4985
4987
|
# configuration. However, bucket owners can allow other users to read
|
4986
4988
|
# the website configuration by writing a bucket policy granting them the
|
@@ -5002,7 +5004,7 @@ module Aws::S3
|
|
5002
5004
|
# The bucket name for which to get the website configuration.
|
5003
5005
|
#
|
5004
5006
|
# @option params [String] :expected_bucket_owner
|
5005
|
-
# The account
|
5007
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5006
5008
|
# a different account, the request will fail with an HTTP `403 (Access
|
5007
5009
|
# Denied)` error.
|
5008
5010
|
#
|
@@ -5092,9 +5094,9 @@ module Aws::S3
|
|
5092
5094
|
# Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive
|
5093
5095
|
# or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve
|
5094
5096
|
# the object you must first restore a copy using [RestoreObject][4].
|
5095
|
-
# Otherwise, this
|
5096
|
-
#
|
5097
|
-
#
|
5097
|
+
# Otherwise, this action returns an `InvalidObjectStateError` error. For
|
5098
|
+
# information about restoring archived objects, see [Restoring Archived
|
5099
|
+
# Objects][5].
|
5098
5100
|
#
|
5099
5101
|
# Encryption request headers, like `x-amz-server-side-encryption`,
|
5100
5102
|
# should not be sent for GET requests if your object uses server-side
|
@@ -5138,9 +5140,8 @@ module Aws::S3
|
|
5138
5140
|
#
|
5139
5141
|
# **Versioning**
|
5140
5142
|
#
|
5141
|
-
# By default, the GET
|
5142
|
-
#
|
5143
|
-
# subresource.
|
5143
|
+
# By default, the GET action returns the current version of an object.
|
5144
|
+
# To return a different version, use the `versionId` subresource.
|
5144
5145
|
#
|
5145
5146
|
# <note markdown="1"> If the current version of the object is a delete marker, Amazon S3
|
5146
5147
|
# behaves as if the object was deleted and includes
|
@@ -5225,27 +5226,27 @@ module Aws::S3
|
|
5225
5226
|
# @option params [required, String] :bucket
|
5226
5227
|
# The bucket name containing the object.
|
5227
5228
|
#
|
5228
|
-
# When using this
|
5229
|
-
# the access point hostname. The access point hostname takes the form
|
5229
|
+
# When using this action with an access point, you must direct requests
|
5230
|
+
# to the access point hostname. The access point hostname takes the form
|
5230
5231
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5231
|
-
# When using this
|
5232
|
-
#
|
5232
|
+
# When using this action with an access point through the AWS SDKs, you
|
5233
|
+
# provide the access point ARN in place of the bucket name. For more
|
5233
5234
|
# information about access point ARNs, see [Using Access Points][1] in
|
5234
|
-
# the *Amazon
|
5235
|
+
# the *Amazon S3 User Guide*.
|
5235
5236
|
#
|
5236
|
-
# When using this
|
5237
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5237
5238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5238
5239
|
# takes the form
|
5239
5240
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5240
|
-
# When using this
|
5241
|
-
#
|
5242
|
-
#
|
5243
|
-
#
|
5241
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5242
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5243
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5244
|
+
# in the *Amazon S3 User Guide*.
|
5244
5245
|
#
|
5245
5246
|
#
|
5246
5247
|
#
|
5247
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5248
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5248
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5249
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5249
5250
|
#
|
5250
5251
|
# @option params [String] :if_match
|
5251
5252
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -5335,7 +5336,7 @@ module Aws::S3
|
|
5335
5336
|
# object.
|
5336
5337
|
#
|
5337
5338
|
# @option params [String] :expected_bucket_owner
|
5338
|
-
# The account
|
5339
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5339
5340
|
# a different account, the request will fail with an HTTP `403 (Access
|
5340
5341
|
# Denied)` error.
|
5341
5342
|
#
|
@@ -5551,17 +5552,17 @@ module Aws::S3
|
|
5551
5552
|
# The bucket name that contains the object for which to get the ACL
|
5552
5553
|
# information.
|
5553
5554
|
#
|
5554
|
-
# When using this
|
5555
|
-
# the access point hostname. The access point hostname takes the form
|
5555
|
+
# When using this action with an access point, you must direct requests
|
5556
|
+
# to the access point hostname. The access point hostname takes the form
|
5556
5557
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5557
|
-
# When using this
|
5558
|
-
#
|
5558
|
+
# When using this action with an access point through the AWS SDKs, you
|
5559
|
+
# provide the access point ARN in place of the bucket name. For more
|
5559
5560
|
# information about access point ARNs, see [Using Access Points][1] in
|
5560
|
-
# the *Amazon
|
5561
|
+
# the *Amazon S3 User Guide*.
|
5561
5562
|
#
|
5562
5563
|
#
|
5563
5564
|
#
|
5564
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5565
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5565
5566
|
#
|
5566
5567
|
# @option params [required, String] :key
|
5567
5568
|
# The key of the object for which to get the ACL information.
|
@@ -5581,7 +5582,7 @@ module Aws::S3
|
|
5581
5582
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5582
5583
|
#
|
5583
5584
|
# @option params [String] :expected_bucket_owner
|
5584
|
-
# The account
|
5585
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5585
5586
|
# a different account, the request will fail with an HTTP `403 (Access
|
5586
5587
|
# Denied)` error.
|
5587
5588
|
#
|
@@ -5688,17 +5689,17 @@ module Aws::S3
|
|
5688
5689
|
# The bucket name containing the object whose Legal Hold status you want
|
5689
5690
|
# to retrieve.
|
5690
5691
|
#
|
5691
|
-
# When using this
|
5692
|
-
# the access point hostname. The access point hostname takes the form
|
5692
|
+
# When using this action with an access point, you must direct requests
|
5693
|
+
# to the access point hostname. The access point hostname takes the form
|
5693
5694
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5694
|
-
# When using this
|
5695
|
-
#
|
5695
|
+
# When using this action with an access point through the AWS SDKs, you
|
5696
|
+
# provide the access point ARN in place of the bucket name. For more
|
5696
5697
|
# information about access point ARNs, see [Using Access Points][1] in
|
5697
|
-
# the *Amazon
|
5698
|
+
# the *Amazon S3 User Guide*.
|
5698
5699
|
#
|
5699
5700
|
#
|
5700
5701
|
#
|
5701
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5702
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5702
5703
|
#
|
5703
5704
|
# @option params [required, String] :key
|
5704
5705
|
# The key name for the object whose Legal Hold status you want to
|
@@ -5720,7 +5721,7 @@ module Aws::S3
|
|
5720
5721
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5721
5722
|
#
|
5722
5723
|
# @option params [String] :expected_bucket_owner
|
5723
|
-
# The account
|
5724
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5724
5725
|
# a different account, the request will fail with an HTTP `403 (Access
|
5725
5726
|
# Denied)` error.
|
5726
5727
|
#
|
@@ -5763,20 +5764,20 @@ module Aws::S3
|
|
5763
5764
|
# @option params [required, String] :bucket
|
5764
5765
|
# The bucket whose Object Lock configuration you want to retrieve.
|
5765
5766
|
#
|
5766
|
-
# When using this
|
5767
|
-
# the access point hostname. The access point hostname takes the form
|
5767
|
+
# When using this action with an access point, you must direct requests
|
5768
|
+
# to the access point hostname. The access point hostname takes the form
|
5768
5769
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5769
|
-
# When using this
|
5770
|
-
#
|
5770
|
+
# When using this action with an access point through the AWS SDKs, you
|
5771
|
+
# provide the access point ARN in place of the bucket name. For more
|
5771
5772
|
# information about access point ARNs, see [Using Access Points][1] in
|
5772
|
-
# the *Amazon
|
5773
|
+
# the *Amazon S3 User Guide*.
|
5773
5774
|
#
|
5774
5775
|
#
|
5775
5776
|
#
|
5776
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5777
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5777
5778
|
#
|
5778
5779
|
# @option params [String] :expected_bucket_owner
|
5779
|
-
# The account
|
5780
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5780
5781
|
# a different account, the request will fail with an HTTP `403 (Access
|
5781
5782
|
# Denied)` error.
|
5782
5783
|
#
|
@@ -5820,17 +5821,17 @@ module Aws::S3
|
|
5820
5821
|
# The bucket name containing the object whose retention settings you
|
5821
5822
|
# want to retrieve.
|
5822
5823
|
#
|
5823
|
-
# When using this
|
5824
|
-
# the access point hostname. The access point hostname takes the form
|
5824
|
+
# When using this action with an access point, you must direct requests
|
5825
|
+
# to the access point hostname. The access point hostname takes the form
|
5825
5826
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5826
|
-
# When using this
|
5827
|
-
#
|
5827
|
+
# When using this action with an access point through the AWS SDKs, you
|
5828
|
+
# provide the access point ARN in place of the bucket name. For more
|
5828
5829
|
# information about access point ARNs, see [Using Access Points][1] in
|
5829
|
-
# the *Amazon
|
5830
|
+
# the *Amazon S3 User Guide*.
|
5830
5831
|
#
|
5831
5832
|
#
|
5832
5833
|
#
|
5833
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5834
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5834
5835
|
#
|
5835
5836
|
# @option params [required, String] :key
|
5836
5837
|
# The key name for the object whose retention settings you want to
|
@@ -5852,7 +5853,7 @@ module Aws::S3
|
|
5852
5853
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5853
5854
|
#
|
5854
5855
|
# @option params [String] :expected_bucket_owner
|
5855
|
-
# The account
|
5856
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5856
5857
|
# a different account, the request will fail with an HTTP `403 (Access
|
5857
5858
|
# Denied)` error.
|
5858
5859
|
#
|
@@ -5888,7 +5889,7 @@ module Aws::S3
|
|
5888
5889
|
# tagging subresource associated with the object.
|
5889
5890
|
#
|
5890
5891
|
# To use this operation, you must have permission to perform the
|
5891
|
-
# `s3:GetObjectTagging` action. By default, the GET
|
5892
|
+
# `s3:GetObjectTagging` action. By default, the GET action returns
|
5892
5893
|
# information about current version of an object. For a versioned
|
5893
5894
|
# bucket, you can have multiple versions of an object in your bucket. To
|
5894
5895
|
# retrieve tags of any other version, use the versionId query parameter.
|
@@ -5900,7 +5901,7 @@ module Aws::S3
|
|
5900
5901
|
# For information about the Amazon S3 object tagging feature, see
|
5901
5902
|
# [Object Tagging][1].
|
5902
5903
|
#
|
5903
|
-
# The following
|
5904
|
+
# The following action is related to `GetObjectTagging`\:
|
5904
5905
|
#
|
5905
5906
|
# * [PutObjectTagging][2]
|
5906
5907
|
#
|
@@ -5916,27 +5917,27 @@ module Aws::S3
|
|
5916
5917
|
# The bucket name containing the object for which to get the tagging
|
5917
5918
|
# information.
|
5918
5919
|
#
|
5919
|
-
# When using this
|
5920
|
-
# the access point hostname. The access point hostname takes the form
|
5920
|
+
# When using this action with an access point, you must direct requests
|
5921
|
+
# to the access point hostname. The access point hostname takes the form
|
5921
5922
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5922
|
-
# When using this
|
5923
|
-
#
|
5923
|
+
# When using this action with an access point through the AWS SDKs, you
|
5924
|
+
# provide the access point ARN in place of the bucket name. For more
|
5924
5925
|
# information about access point ARNs, see [Using Access Points][1] in
|
5925
|
-
# the *Amazon
|
5926
|
+
# the *Amazon S3 User Guide*.
|
5926
5927
|
#
|
5927
|
-
# When using this
|
5928
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5928
5929
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5929
5930
|
# takes the form
|
5930
5931
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5931
|
-
# When using this
|
5932
|
-
#
|
5933
|
-
#
|
5934
|
-
#
|
5932
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5933
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5934
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5935
|
+
# in the *Amazon S3 User Guide*.
|
5935
5936
|
#
|
5936
5937
|
#
|
5937
5938
|
#
|
5938
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5939
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
5939
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
5940
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
5940
5941
|
#
|
5941
5942
|
# @option params [required, String] :key
|
5942
5943
|
# Object key for which to get the tagging information.
|
@@ -5945,7 +5946,7 @@ module Aws::S3
|
|
5945
5946
|
# The versionId of the object for which to get the tagging information.
|
5946
5947
|
#
|
5947
5948
|
# @option params [String] :expected_bucket_owner
|
5948
|
-
# The account
|
5949
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
5949
5950
|
# a different account, the request will fail with an HTTP `403 (Access
|
5950
5951
|
# Denied)` error.
|
5951
5952
|
#
|
@@ -6051,7 +6052,7 @@ module Aws::S3
|
|
6051
6052
|
#
|
6052
6053
|
# This action is not supported by Amazon S3 on Outposts.
|
6053
6054
|
#
|
6054
|
-
# The following
|
6055
|
+
# The following action is related to `GetObjectTorrent`\:
|
6055
6056
|
#
|
6056
6057
|
# * [GetObject][2]
|
6057
6058
|
#
|
@@ -6084,7 +6085,7 @@ module Aws::S3
|
|
6084
6085
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
6085
6086
|
#
|
6086
6087
|
# @option params [String] :expected_bucket_owner
|
6087
|
-
# The account
|
6088
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6088
6089
|
# a different account, the request will fail with an HTTP `403 (Access
|
6089
6090
|
# Denied)` error.
|
6090
6091
|
#
|
@@ -6170,7 +6171,7 @@ module Aws::S3
|
|
6170
6171
|
# configuration you want to retrieve.
|
6171
6172
|
#
|
6172
6173
|
# @option params [String] :expected_bucket_owner
|
6173
|
-
# The account
|
6174
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6174
6175
|
# a different account, the request will fail with an HTTP `403 (Access
|
6175
6176
|
# Denied)` error.
|
6176
6177
|
#
|
@@ -6201,9 +6202,9 @@ module Aws::S3
|
|
6201
6202
|
req.send_request(options)
|
6202
6203
|
end
|
6203
6204
|
|
6204
|
-
# This
|
6205
|
-
# permission to access it. The
|
6206
|
-
#
|
6205
|
+
# This action is useful to determine if a bucket exists and you have
|
6206
|
+
# permission to access it. The action returns a `200 OK` if the bucket
|
6207
|
+
# exists and you have permission to access it.
|
6207
6208
|
#
|
6208
6209
|
# If the bucket does not exist or you do not have permission to access
|
6209
6210
|
# it, the `HEAD` request returns a generic `404 Not Found` or `403
|
@@ -6219,36 +6220,36 @@ module Aws::S3
|
|
6219
6220
|
#
|
6220
6221
|
#
|
6221
6222
|
#
|
6222
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6223
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6223
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6224
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6224
6225
|
#
|
6225
6226
|
# @option params [required, String] :bucket
|
6226
6227
|
# The bucket name.
|
6227
6228
|
#
|
6228
|
-
# When using this
|
6229
|
-
# the access point hostname. The access point hostname takes the form
|
6229
|
+
# When using this action with an access point, you must direct requests
|
6230
|
+
# to the access point hostname. The access point hostname takes the form
|
6230
6231
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6231
|
-
# When using this
|
6232
|
-
#
|
6232
|
+
# When using this action with an access point through the AWS SDKs, you
|
6233
|
+
# provide the access point ARN in place of the bucket name. For more
|
6233
6234
|
# information about access point ARNs, see [Using Access Points][1] in
|
6234
|
-
# the *Amazon
|
6235
|
+
# the *Amazon S3 User Guide*.
|
6235
6236
|
#
|
6236
|
-
# When using this
|
6237
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6237
6238
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6238
6239
|
# takes the form
|
6239
6240
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6240
|
-
# When using this
|
6241
|
-
#
|
6242
|
-
#
|
6243
|
-
#
|
6241
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6242
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6243
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6244
|
+
# in the *Amazon S3 User Guide*.
|
6244
6245
|
#
|
6245
6246
|
#
|
6246
6247
|
#
|
6247
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6248
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6248
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6249
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6249
6250
|
#
|
6250
6251
|
# @option params [String] :expected_bucket_owner
|
6251
|
-
# The account
|
6252
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6252
6253
|
# a different account, the request will fail with an HTTP `403 (Access
|
6253
6254
|
# Denied)` error.
|
6254
6255
|
#
|
@@ -6285,17 +6286,17 @@ module Aws::S3
|
|
6285
6286
|
req.send_request(options)
|
6286
6287
|
end
|
6287
6288
|
|
6288
|
-
# The HEAD
|
6289
|
-
# the object itself. This
|
6290
|
-
#
|
6291
|
-
#
|
6292
|
-
#
|
6293
|
-
# A `HEAD` request has the same options as a `GET`
|
6294
|
-
#
|
6295
|
-
#
|
6296
|
-
#
|
6297
|
-
#
|
6298
|
-
#
|
6289
|
+
# The HEAD action retrieves metadata from an object without returning
|
6290
|
+
# the object itself. This action is useful if you're only interested in
|
6291
|
+
# an object's metadata. To use HEAD, you must have READ access to the
|
6292
|
+
# object.
|
6293
|
+
#
|
6294
|
+
# A `HEAD` request has the same options as a `GET` action on an object.
|
6295
|
+
# The response is identical to the `GET` response except that there is
|
6296
|
+
# no response body. Because of this, if the `HEAD` request generates an
|
6297
|
+
# error, it returns a generic `404 Not Found` or `403 Forbidden` code.
|
6298
|
+
# It is not possible to retrieve the exact exception beyond these error
|
6299
|
+
# codes.
|
6299
6300
|
#
|
6300
6301
|
# If you encrypt an object by using server-side encryption with
|
6301
6302
|
# customer-provided encryption keys (SSE-C) when you store the object in
|
@@ -6361,7 +6362,7 @@ module Aws::S3
|
|
6361
6362
|
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
|
6362
6363
|
# an HTTP status code 403 ("access denied") error.
|
6363
6364
|
#
|
6364
|
-
# The following
|
6365
|
+
# The following action is related to `HeadObject`\:
|
6365
6366
|
#
|
6366
6367
|
# * [GetObject][5]
|
6367
6368
|
#
|
@@ -6378,27 +6379,27 @@ module Aws::S3
|
|
6378
6379
|
# @option params [required, String] :bucket
|
6379
6380
|
# The name of the bucket containing the object.
|
6380
6381
|
#
|
6381
|
-
# When using this
|
6382
|
-
# the access point hostname. The access point hostname takes the form
|
6382
|
+
# When using this action with an access point, you must direct requests
|
6383
|
+
# to the access point hostname. The access point hostname takes the form
|
6383
6384
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6384
|
-
# When using this
|
6385
|
-
#
|
6385
|
+
# When using this action with an access point through the AWS SDKs, you
|
6386
|
+
# provide the access point ARN in place of the bucket name. For more
|
6386
6387
|
# information about access point ARNs, see [Using Access Points][1] in
|
6387
|
-
# the *Amazon
|
6388
|
+
# the *Amazon S3 User Guide*.
|
6388
6389
|
#
|
6389
|
-
# When using this
|
6390
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6390
6391
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6391
6392
|
# takes the form
|
6392
6393
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6393
|
-
# When using this
|
6394
|
-
#
|
6395
|
-
#
|
6396
|
-
#
|
6394
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6395
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6396
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6397
|
+
# in the *Amazon S3 User Guide*.
|
6397
6398
|
#
|
6398
6399
|
#
|
6399
6400
|
#
|
6400
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6401
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6401
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
6402
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
6402
6403
|
#
|
6403
6404
|
# @option params [String] :if_match
|
6404
6405
|
# Return the object only if its entity tag (ETag) is the same as the one
|
@@ -6470,7 +6471,7 @@ module Aws::S3
|
|
6470
6471
|
# the number of parts in this object.
|
6471
6472
|
#
|
6472
6473
|
# @option params [String] :expected_bucket_owner
|
6473
|
-
# The account
|
6474
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6474
6475
|
# a different account, the request will fail with an HTTP `403 (Access
|
6475
6476
|
# Denied)` error.
|
6476
6477
|
#
|
@@ -6602,15 +6603,14 @@ module Aws::S3
|
|
6602
6603
|
# Lists the analytics configurations for the bucket. You can have up to
|
6603
6604
|
# 1,000 analytics configurations per bucket.
|
6604
6605
|
#
|
6605
|
-
# This
|
6606
|
-
#
|
6607
|
-
#
|
6608
|
-
#
|
6609
|
-
#
|
6610
|
-
#
|
6611
|
-
#
|
6612
|
-
#
|
6613
|
-
# next page.
|
6606
|
+
# This action supports list pagination and does not return more than 100
|
6607
|
+
# configurations at a time. You should always check the `IsTruncated`
|
6608
|
+
# element in the response. If there are no more configurations to list,
|
6609
|
+
# `IsTruncated` is set to false. If there are more configurations to
|
6610
|
+
# list, `IsTruncated` is set to true, and there will be a value in
|
6611
|
+
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
6612
|
+
# continue the pagination of the list by passing the value in
|
6613
|
+
# continuation-token in the request to `GET` the next page.
|
6614
6614
|
#
|
6615
6615
|
# To use this operation, you must have permissions to perform the
|
6616
6616
|
# `s3:GetAnalyticsConfiguration` action. The bucket owner has this
|
@@ -6633,8 +6633,8 @@ module Aws::S3
|
|
6633
6633
|
#
|
6634
6634
|
#
|
6635
6635
|
#
|
6636
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6637
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6636
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6637
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6638
6638
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
6639
6639
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
6640
6640
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
@@ -6649,7 +6649,7 @@ module Aws::S3
|
|
6649
6649
|
# request should begin.
|
6650
6650
|
#
|
6651
6651
|
# @option params [String] :expected_bucket_owner
|
6652
|
-
# The account
|
6652
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6653
6653
|
# a different account, the request will fail with an HTTP `403 (Access
|
6654
6654
|
# Denied)` error.
|
6655
6655
|
#
|
@@ -6787,9 +6787,9 @@ module Aws::S3
|
|
6787
6787
|
# Returns a list of inventory configurations for the bucket. You can
|
6788
6788
|
# have up to 1,000 analytics configurations per bucket.
|
6789
6789
|
#
|
6790
|
-
# This
|
6791
|
-
#
|
6792
|
-
#
|
6790
|
+
# This action supports list pagination and does not return more than 100
|
6791
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6792
|
+
# the response. If there are no more configurations to list,
|
6793
6793
|
# `IsTruncated` is set to false. If there are more configurations to
|
6794
6794
|
# list, `IsTruncated` is set to true, and there is a value in
|
6795
6795
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -6817,8 +6817,8 @@ module Aws::S3
|
|
6817
6817
|
#
|
6818
6818
|
#
|
6819
6819
|
#
|
6820
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6821
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6820
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6821
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6822
6822
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
6823
6823
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
6824
6824
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
@@ -6835,7 +6835,7 @@ module Aws::S3
|
|
6835
6835
|
# token is an opaque value that Amazon S3 understands.
|
6836
6836
|
#
|
6837
6837
|
# @option params [String] :expected_bucket_owner
|
6838
|
-
# The account
|
6838
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6839
6839
|
# a different account, the request will fail with an HTTP `403 (Access
|
6840
6840
|
# Denied)` error.
|
6841
6841
|
#
|
@@ -6887,9 +6887,9 @@ module Aws::S3
|
|
6887
6887
|
# not provide information on daily storage metrics. You can have up to
|
6888
6888
|
# 1,000 configurations per bucket.
|
6889
6889
|
#
|
6890
|
-
# This
|
6891
|
-
#
|
6892
|
-
#
|
6890
|
+
# This action supports list pagination and does not return more than 100
|
6891
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6892
|
+
# the response. If there are no more configurations to list,
|
6893
6893
|
# `IsTruncated` is set to false. If there are more configurations to
|
6894
6894
|
# list, `IsTruncated` is set to true, and there is a value in
|
6895
6895
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -6917,8 +6917,8 @@ module Aws::S3
|
|
6917
6917
|
#
|
6918
6918
|
#
|
6919
6919
|
#
|
6920
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6921
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
6920
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
6921
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
6922
6922
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
6923
6923
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
6924
6924
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html
|
@@ -6935,7 +6935,7 @@ module Aws::S3
|
|
6935
6935
|
# continuation token is an opaque value that Amazon S3 understands.
|
6936
6936
|
#
|
6937
6937
|
# @option params [String] :expected_bucket_owner
|
6938
|
-
# The account
|
6938
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
6939
6939
|
# a different account, the request will fail with an HTTP `403 (Access
|
6940
6940
|
# Denied)` error.
|
6941
6941
|
#
|
@@ -7035,20 +7035,19 @@ module Aws::S3
|
|
7035
7035
|
req.send_request(options)
|
7036
7036
|
end
|
7037
7037
|
|
7038
|
-
# This
|
7038
|
+
# This action lists in-progress multipart uploads. An in-progress
|
7039
7039
|
# multipart upload is a multipart upload that has been initiated using
|
7040
7040
|
# the Initiate Multipart Upload request, but has not yet been completed
|
7041
7041
|
# or aborted.
|
7042
7042
|
#
|
7043
|
-
# This
|
7044
|
-
#
|
7045
|
-
#
|
7046
|
-
#
|
7047
|
-
#
|
7048
|
-
#
|
7049
|
-
#
|
7050
|
-
#
|
7051
|
-
# parameters.
|
7043
|
+
# This action returns at most 1,000 multipart uploads in the response.
|
7044
|
+
# 1,000 multipart uploads is the maximum number of uploads a response
|
7045
|
+
# can include, which is also the default value. You can further limit
|
7046
|
+
# the number of uploads in a response by specifying the `max-uploads`
|
7047
|
+
# parameter in the response. If additional multipart uploads satisfy the
|
7048
|
+
# list criteria, the response will contain an `IsTruncated` element with
|
7049
|
+
# the value true. To list the additional multipart uploads, use the
|
7050
|
+
# `key-marker` and `upload-id-marker` request parameters.
|
7052
7051
|
#
|
7053
7052
|
# In the response, the uploads are sorted by key. If your application
|
7054
7053
|
# has initiated more than one multipart upload using the same object
|
@@ -7060,7 +7059,7 @@ module Aws::S3
|
|
7060
7059
|
# Using Multipart Upload][1].
|
7061
7060
|
#
|
7062
7061
|
# For information on permissions required to use the multipart upload
|
7063
|
-
# API, see [Multipart Upload
|
7062
|
+
# API, see [Multipart Upload and Permissions][2].
|
7064
7063
|
#
|
7065
7064
|
# The following operations are related to `ListMultipartUploads`\:
|
7066
7065
|
#
|
@@ -7087,27 +7086,27 @@ module Aws::S3
|
|
7087
7086
|
# @option params [required, String] :bucket
|
7088
7087
|
# The name of the bucket to which the multipart upload was initiated.
|
7089
7088
|
#
|
7090
|
-
# When using this
|
7091
|
-
# the access point hostname. The access point hostname takes the form
|
7089
|
+
# When using this action with an access point, you must direct requests
|
7090
|
+
# to the access point hostname. The access point hostname takes the form
|
7092
7091
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7093
|
-
# When using this
|
7094
|
-
#
|
7092
|
+
# When using this action with an access point through the AWS SDKs, you
|
7093
|
+
# provide the access point ARN in place of the bucket name. For more
|
7095
7094
|
# information about access point ARNs, see [Using Access Points][1] in
|
7096
|
-
# the *Amazon
|
7095
|
+
# the *Amazon S3 User Guide*.
|
7097
7096
|
#
|
7098
|
-
# When using this
|
7097
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7099
7098
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7100
7099
|
# takes the form
|
7101
7100
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7102
|
-
# When using this
|
7103
|
-
#
|
7104
|
-
#
|
7105
|
-
#
|
7101
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7102
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7103
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7104
|
+
# in the *Amazon S3 User Guide*.
|
7106
7105
|
#
|
7107
7106
|
#
|
7108
7107
|
#
|
7109
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7110
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7108
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7109
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7111
7110
|
#
|
7112
7111
|
# @option params [String] :delimiter
|
7113
7112
|
# Character you use to group keys.
|
@@ -7160,7 +7159,7 @@ module Aws::S3
|
|
7160
7159
|
# specified `upload-id-marker`.
|
7161
7160
|
#
|
7162
7161
|
# @option params [String] :expected_bucket_owner
|
7163
|
-
# The account
|
7162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7164
7163
|
# a different account, the request will fail with an HTTP `403 (Access
|
7165
7164
|
# Denied)` error.
|
7166
7165
|
#
|
@@ -7182,97 +7181,97 @@ module Aws::S3
|
|
7182
7181
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7183
7182
|
#
|
7184
7183
|
#
|
7185
|
-
# @example Example:
|
7184
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
7186
7185
|
#
|
7187
|
-
# # The following example
|
7188
|
-
# # setup of multipart uploads.
|
7186
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
7189
7187
|
#
|
7190
7188
|
# resp = client.list_multipart_uploads({
|
7191
7189
|
# bucket: "examplebucket",
|
7192
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
7193
|
-
# max_uploads: 2,
|
7194
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
7195
7190
|
# })
|
7196
7191
|
#
|
7197
7192
|
# resp.to_h outputs the following:
|
7198
7193
|
# {
|
7199
|
-
# bucket: "acl1",
|
7200
|
-
# is_truncated: true,
|
7201
|
-
# key_marker: "",
|
7202
|
-
# max_uploads: 2,
|
7203
|
-
# next_key_marker: "someobjectkey",
|
7204
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7205
|
-
# upload_id_marker: "",
|
7206
7194
|
# uploads: [
|
7207
7195
|
# {
|
7208
7196
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7209
7197
|
# initiator: {
|
7210
|
-
# display_name: "
|
7198
|
+
# display_name: "display-name",
|
7211
7199
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7212
7200
|
# },
|
7213
7201
|
# key: "JavaFile",
|
7214
7202
|
# owner: {
|
7215
|
-
# display_name: "
|
7216
|
-
# id: "
|
7203
|
+
# display_name: "display-name",
|
7204
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7217
7205
|
# },
|
7218
7206
|
# storage_class: "STANDARD",
|
7219
|
-
# upload_id: "
|
7207
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7220
7208
|
# },
|
7221
7209
|
# {
|
7222
7210
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7223
7211
|
# initiator: {
|
7224
|
-
# display_name: "
|
7212
|
+
# display_name: "display-name",
|
7225
7213
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7226
7214
|
# },
|
7227
7215
|
# key: "JavaFile",
|
7228
7216
|
# owner: {
|
7229
|
-
# display_name: "
|
7217
|
+
# display_name: "display-name",
|
7230
7218
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7231
7219
|
# },
|
7232
7220
|
# storage_class: "STANDARD",
|
7233
|
-
# upload_id: "
|
7221
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7234
7222
|
# },
|
7235
7223
|
# ],
|
7236
7224
|
# }
|
7237
7225
|
#
|
7238
|
-
# @example Example:
|
7226
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
7239
7227
|
#
|
7240
|
-
# # The following example
|
7228
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
7229
|
+
# # setup of multipart uploads.
|
7241
7230
|
#
|
7242
7231
|
# resp = client.list_multipart_uploads({
|
7243
7232
|
# bucket: "examplebucket",
|
7233
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
7234
|
+
# max_uploads: 2,
|
7235
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
7244
7236
|
# })
|
7245
7237
|
#
|
7246
7238
|
# resp.to_h outputs the following:
|
7247
7239
|
# {
|
7240
|
+
# bucket: "acl1",
|
7241
|
+
# is_truncated: true,
|
7242
|
+
# key_marker: "",
|
7243
|
+
# max_uploads: 2,
|
7244
|
+
# next_key_marker: "someobjectkey",
|
7245
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7246
|
+
# upload_id_marker: "",
|
7248
7247
|
# uploads: [
|
7249
7248
|
# {
|
7250
7249
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7251
7250
|
# initiator: {
|
7252
|
-
# display_name: "display-name",
|
7251
|
+
# display_name: "ownder-display-name",
|
7253
7252
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7254
7253
|
# },
|
7255
7254
|
# key: "JavaFile",
|
7256
7255
|
# owner: {
|
7257
|
-
# display_name: "
|
7258
|
-
# id: "
|
7256
|
+
# display_name: "mohanataws",
|
7257
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7259
7258
|
# },
|
7260
7259
|
# storage_class: "STANDARD",
|
7261
|
-
# upload_id: "
|
7260
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7262
7261
|
# },
|
7263
7262
|
# {
|
7264
7263
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7265
7264
|
# initiator: {
|
7266
|
-
# display_name: "display-name",
|
7265
|
+
# display_name: "ownder-display-name",
|
7267
7266
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7268
7267
|
# },
|
7269
7268
|
# key: "JavaFile",
|
7270
7269
|
# owner: {
|
7271
|
-
# display_name: "display-name",
|
7270
|
+
# display_name: "ownder-display-name",
|
7272
7271
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7273
7272
|
# },
|
7274
7273
|
# storage_class: "STANDARD",
|
7275
|
-
# upload_id: "
|
7274
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7276
7275
|
# },
|
7277
7276
|
# ],
|
7278
7277
|
# }
|
@@ -7327,6 +7326,9 @@ module Aws::S3
|
|
7327
7326
|
# can also use request parameters as selection criteria to return
|
7328
7327
|
# metadata about a subset of all the object versions.
|
7329
7328
|
#
|
7329
|
+
# To use this operation, you must have permissions to perform the
|
7330
|
+
# `s3:ListBucketVersions` action. Be aware of the name difference.
|
7331
|
+
#
|
7330
7332
|
# <note markdown="1"> A 200 OK response can contain valid or invalid XML. Make sure to
|
7331
7333
|
# design your application to parse the contents of the response and
|
7332
7334
|
# handle it appropriately.
|
@@ -7378,7 +7380,7 @@ module Aws::S3
|
|
7378
7380
|
#
|
7379
7381
|
# @option params [Integer] :max_keys
|
7380
7382
|
# Sets the maximum number of keys returned in the response. By default
|
7381
|
-
# the
|
7383
|
+
# the action returns up to 1,000 key names. The response might contain
|
7382
7384
|
# fewer keys but will never contain more. If additional keys satisfy the
|
7383
7385
|
# search criteria, but were not returned because max-keys was exceeded,
|
7384
7386
|
# the response contains <isTruncated>true</isTruncated>. To
|
@@ -7396,7 +7398,7 @@ module Aws::S3
|
|
7396
7398
|
# Specifies the object version you want to start listing from.
|
7397
7399
|
#
|
7398
7400
|
# @option params [String] :expected_bucket_owner
|
7399
|
-
# The account
|
7401
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7400
7402
|
# a different account, the request will fail with an HTTP `403 (Access
|
7401
7403
|
# Denied)` error.
|
7402
7404
|
#
|
@@ -7522,7 +7524,7 @@ module Aws::S3
|
|
7522
7524
|
# invalid XML. Be sure to design your application to parse the contents
|
7523
7525
|
# of the response and handle it appropriately.
|
7524
7526
|
#
|
7525
|
-
# This
|
7527
|
+
# This action has been revised. We recommend that you use the newer
|
7526
7528
|
# version, [ListObjectsV2][1], when developing applications. For
|
7527
7529
|
# backward compatibility, Amazon S3 continues to support `ListObjects`.
|
7528
7530
|
#
|
@@ -7549,27 +7551,27 @@ module Aws::S3
|
|
7549
7551
|
# @option params [required, String] :bucket
|
7550
7552
|
# The name of the bucket containing the objects.
|
7551
7553
|
#
|
7552
|
-
# When using this
|
7553
|
-
# the access point hostname. The access point hostname takes the form
|
7554
|
+
# When using this action with an access point, you must direct requests
|
7555
|
+
# to the access point hostname. The access point hostname takes the form
|
7554
7556
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7555
|
-
# When using this
|
7556
|
-
#
|
7557
|
+
# When using this action with an access point through the AWS SDKs, you
|
7558
|
+
# provide the access point ARN in place of the bucket name. For more
|
7557
7559
|
# information about access point ARNs, see [Using Access Points][1] in
|
7558
|
-
# the *Amazon
|
7560
|
+
# the *Amazon S3 User Guide*.
|
7559
7561
|
#
|
7560
|
-
# When using this
|
7562
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7561
7563
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7562
7564
|
# takes the form
|
7563
7565
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7564
|
-
# When using this
|
7565
|
-
#
|
7566
|
-
#
|
7567
|
-
#
|
7566
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7567
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7568
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7569
|
+
# in the *Amazon S3 User Guide*.
|
7568
7570
|
#
|
7569
7571
|
#
|
7570
7572
|
#
|
7571
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7572
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7573
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7574
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7573
7575
|
#
|
7574
7576
|
# @option params [String] :delimiter
|
7575
7577
|
# A delimiter is a character you use to group keys.
|
@@ -7587,7 +7589,7 @@ module Aws::S3
|
|
7587
7589
|
#
|
7588
7590
|
# @option params [Integer] :max_keys
|
7589
7591
|
# Sets the maximum number of keys returned in the response. By default
|
7590
|
-
# the
|
7592
|
+
# the action returns up to 1,000 key names. The response might contain
|
7591
7593
|
# fewer keys but will never contain more.
|
7592
7594
|
#
|
7593
7595
|
# @option params [String] :prefix
|
@@ -7599,7 +7601,7 @@ module Aws::S3
|
|
7599
7601
|
# parameter in their requests.
|
7600
7602
|
#
|
7601
7603
|
# @option params [String] :expected_bucket_owner
|
7602
|
-
# The account
|
7604
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7603
7605
|
# a different account, the request will fail with an HTTP `403 (Access
|
7604
7606
|
# Denied)` error.
|
7605
7607
|
#
|
@@ -7710,16 +7712,16 @@ module Aws::S3
|
|
7710
7712
|
#
|
7711
7713
|
# To use this operation, you must have READ access to the bucket.
|
7712
7714
|
#
|
7713
|
-
# To use this
|
7715
|
+
# To use this action in an AWS Identity and Access Management (IAM)
|
7714
7716
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
7715
7717
|
# action. The bucket owner has this permission by default and can grant
|
7716
7718
|
# this permission to others. For more information about permissions, see
|
7717
7719
|
# [Permissions Related to Bucket Subresource Operations][1] and
|
7718
7720
|
# [Managing Access Permissions to Your Amazon S3 Resources][2].
|
7719
7721
|
#
|
7720
|
-
# This section describes the latest revision of
|
7721
|
-
# that you use this revised API for application development.
|
7722
|
-
# backward compatibility, Amazon S3 continues to support the prior
|
7722
|
+
# This section describes the latest revision of this action. We
|
7723
|
+
# recommend that you use this revised API for application development.
|
7724
|
+
# For backward compatibility, Amazon S3 continues to support the prior
|
7723
7725
|
# version of this API, [ListObjects][3].
|
7724
7726
|
#
|
7725
7727
|
# To get a list of your buckets, see [ListBuckets][4].
|
@@ -7734,8 +7736,8 @@ module Aws::S3
|
|
7734
7736
|
#
|
7735
7737
|
#
|
7736
7738
|
#
|
7737
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7738
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7739
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7740
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
7739
7741
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
|
7740
7742
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
|
7741
7743
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
@@ -7745,27 +7747,27 @@ module Aws::S3
|
|
7745
7747
|
# @option params [required, String] :bucket
|
7746
7748
|
# Bucket name to list.
|
7747
7749
|
#
|
7748
|
-
# When using this
|
7749
|
-
# the access point hostname. The access point hostname takes the form
|
7750
|
+
# When using this action with an access point, you must direct requests
|
7751
|
+
# to the access point hostname. The access point hostname takes the form
|
7750
7752
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7751
|
-
# When using this
|
7752
|
-
#
|
7753
|
+
# When using this action with an access point through the AWS SDKs, you
|
7754
|
+
# provide the access point ARN in place of the bucket name. For more
|
7753
7755
|
# information about access point ARNs, see [Using Access Points][1] in
|
7754
|
-
# the *Amazon
|
7756
|
+
# the *Amazon S3 User Guide*.
|
7755
7757
|
#
|
7756
|
-
# When using this
|
7758
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7757
7759
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7758
7760
|
# takes the form
|
7759
7761
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7760
|
-
# When using this
|
7761
|
-
#
|
7762
|
-
#
|
7763
|
-
#
|
7762
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7763
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7764
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7765
|
+
# in the *Amazon S3 User Guide*.
|
7764
7766
|
#
|
7765
7767
|
#
|
7766
7768
|
#
|
7767
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7768
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7769
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7770
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7769
7771
|
#
|
7770
7772
|
# @option params [String] :delimiter
|
7771
7773
|
# A delimiter is a character you use to group keys.
|
@@ -7775,7 +7777,7 @@ module Aws::S3
|
|
7775
7777
|
#
|
7776
7778
|
# @option params [Integer] :max_keys
|
7777
7779
|
# Sets the maximum number of keys returned in the response. By default
|
7778
|
-
# the
|
7780
|
+
# the action returns up to 1,000 key names. The response might contain
|
7779
7781
|
# fewer keys but will never contain more.
|
7780
7782
|
#
|
7781
7783
|
# @option params [String] :prefix
|
@@ -7802,7 +7804,7 @@ module Aws::S3
|
|
7802
7804
|
# this parameter in their requests.
|
7803
7805
|
#
|
7804
7806
|
# @option params [String] :expected_bucket_owner
|
7805
|
-
# The account
|
7807
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
7806
7808
|
# a different account, the request will fail with an HTTP `403 (Access
|
7807
7809
|
# Denied)` error.
|
7808
7810
|
#
|
@@ -7924,7 +7926,7 @@ module Aws::S3
|
|
7924
7926
|
# Using Multipart Upload][2].
|
7925
7927
|
#
|
7926
7928
|
# For information on permissions required to use the multipart upload
|
7927
|
-
# API, see [Multipart Upload
|
7929
|
+
# API, see [Multipart Upload and Permissions][3].
|
7928
7930
|
#
|
7929
7931
|
# The following operations are related to `ListParts`\:
|
7930
7932
|
#
|
@@ -7951,27 +7953,27 @@ module Aws::S3
|
|
7951
7953
|
# @option params [required, String] :bucket
|
7952
7954
|
# The name of the bucket to which the parts are being uploaded.
|
7953
7955
|
#
|
7954
|
-
# When using this
|
7955
|
-
# the access point hostname. The access point hostname takes the form
|
7956
|
+
# When using this action with an access point, you must direct requests
|
7957
|
+
# to the access point hostname. The access point hostname takes the form
|
7956
7958
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7957
|
-
# When using this
|
7958
|
-
#
|
7959
|
+
# When using this action with an access point through the AWS SDKs, you
|
7960
|
+
# provide the access point ARN in place of the bucket name. For more
|
7959
7961
|
# information about access point ARNs, see [Using Access Points][1] in
|
7960
|
-
# the *Amazon
|
7962
|
+
# the *Amazon S3 User Guide*.
|
7961
7963
|
#
|
7962
|
-
# When using this
|
7964
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7963
7965
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7964
7966
|
# takes the form
|
7965
7967
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7966
|
-
# When using this
|
7967
|
-
#
|
7968
|
-
#
|
7969
|
-
#
|
7968
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7969
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7970
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7971
|
+
# in the *Amazon S3 User Guide*.
|
7970
7972
|
#
|
7971
7973
|
#
|
7972
7974
|
#
|
7973
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7974
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
7975
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
7976
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
7975
7977
|
#
|
7976
7978
|
# @option params [required, String] :key
|
7977
7979
|
# Object key for which the multipart upload was initiated.
|
@@ -7999,7 +8001,7 @@ module Aws::S3
|
|
7999
8001
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
8000
8002
|
#
|
8001
8003
|
# @option params [String] :expected_bucket_owner
|
8002
|
-
# The account
|
8004
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8003
8005
|
# a different account, the request will fail with an HTTP `403 (Access
|
8004
8006
|
# Denied)` error.
|
8005
8007
|
#
|
@@ -8122,8 +8124,8 @@ module Aws::S3
|
|
8122
8124
|
#
|
8123
8125
|
# * Suspended – Disables accelerated data transfers to the bucket.
|
8124
8126
|
#
|
8125
|
-
# The [GetBucketAccelerateConfiguration][3]
|
8126
|
-
#
|
8127
|
+
# The [GetBucketAccelerateConfiguration][3] action returns the transfer
|
8128
|
+
# acceleration state of a bucket.
|
8127
8129
|
#
|
8128
8130
|
# After setting the Transfer Acceleration state of a bucket to Enabled,
|
8129
8131
|
# it might take up to thirty minutes before the data transfer rates to
|
@@ -8144,8 +8146,8 @@ module Aws::S3
|
|
8144
8146
|
#
|
8145
8147
|
#
|
8146
8148
|
#
|
8147
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8148
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8149
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8150
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8149
8151
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html
|
8150
8152
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
8151
8153
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
@@ -8157,7 +8159,7 @@ module Aws::S3
|
|
8157
8159
|
# Container for setting the transfer acceleration state.
|
8158
8160
|
#
|
8159
8161
|
# @option params [String] :expected_bucket_owner
|
8160
|
-
# The account
|
8162
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8161
8163
|
# a different account, the request will fail with an HTTP `403 (Access
|
8162
8164
|
# Denied)` error.
|
8163
8165
|
#
|
@@ -8379,7 +8381,7 @@ module Aws::S3
|
|
8379
8381
|
# Allows grantee to write the ACL for the applicable bucket.
|
8380
8382
|
#
|
8381
8383
|
# @option params [String] :expected_bucket_owner
|
8382
|
-
# The account
|
8384
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8383
8385
|
# a different account, the request will fail with an HTTP `403 (Access
|
8384
8386
|
# Denied)` error.
|
8385
8387
|
#
|
@@ -8501,8 +8503,8 @@ module Aws::S3
|
|
8501
8503
|
#
|
8502
8504
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
8503
8505
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
8504
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8505
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8506
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8507
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8506
8508
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html
|
8507
8509
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html
|
8508
8510
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html
|
@@ -8517,7 +8519,7 @@ module Aws::S3
|
|
8517
8519
|
# The configuration and any analyses for the analytics filter.
|
8518
8520
|
#
|
8519
8521
|
# @option params [String] :expected_bucket_owner
|
8520
|
-
# The account
|
8522
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8521
8523
|
# a different account, the request will fail with an HTTP `403 (Access
|
8522
8524
|
# Denied)` error.
|
8523
8525
|
#
|
@@ -8608,7 +8610,7 @@ module Aws::S3
|
|
8608
8610
|
# element.
|
8609
8611
|
#
|
8610
8612
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
8611
|
-
# Sharing][1] in the *Amazon
|
8613
|
+
# Sharing][1] in the *Amazon S3 User Guide*.
|
8612
8614
|
#
|
8613
8615
|
# **Related Resources**
|
8614
8616
|
#
|
@@ -8631,8 +8633,7 @@ module Aws::S3
|
|
8631
8633
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
8632
8634
|
# Describes the cross-origin access configuration for objects in an
|
8633
8635
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8634
|
-
# Resource Sharing][1] in the *Amazon
|
8635
|
-
# Guide*.
|
8636
|
+
# Resource Sharing][1] in the *Amazon S3 User Guide*.
|
8636
8637
|
#
|
8637
8638
|
#
|
8638
8639
|
#
|
@@ -8651,7 +8652,7 @@ module Aws::S3
|
|
8651
8652
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
8652
8653
|
#
|
8653
8654
|
# @option params [String] :expected_bucket_owner
|
8654
|
-
# The account
|
8655
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8655
8656
|
# a different account, the request will fail with an HTTP `403 (Access
|
8656
8657
|
# Denied)` error.
|
8657
8658
|
#
|
@@ -8708,6 +8709,7 @@ module Aws::S3
|
|
8708
8709
|
# cors_configuration: { # required
|
8709
8710
|
# cors_rules: [ # required
|
8710
8711
|
# {
|
8712
|
+
# id: "ID",
|
8711
8713
|
# allowed_headers: ["AllowedHeader"],
|
8712
8714
|
# allowed_methods: ["AllowedMethod"], # required
|
8713
8715
|
# allowed_origins: ["AllowedOrigin"], # required
|
@@ -8729,7 +8731,7 @@ module Aws::S3
|
|
8729
8731
|
req.send_request(options)
|
8730
8732
|
end
|
8731
8733
|
|
8732
|
-
# This
|
8734
|
+
# This action uses the `encryption` subresource to configure default
|
8733
8735
|
# encryption and Amazon S3 Bucket Key for an existing bucket.
|
8734
8736
|
#
|
8735
8737
|
# Default encryption for a bucket can use server-side encryption with
|
@@ -8737,43 +8739,42 @@ module Aws::S3
|
|
8737
8739
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
8738
8740
|
# also configure Amazon S3 Bucket Key. For information about default
|
8739
8741
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
8740
|
-
# *Amazon
|
8741
|
-
#
|
8742
|
-
# Simple Storage Service Developer Guide*.
|
8742
|
+
# *Amazon S3 User Guide*. For more information about S3 Bucket Keys, see
|
8743
|
+
# [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*.
|
8743
8744
|
#
|
8744
|
-
# This
|
8745
|
-
# see [ Authenticating Requests (AWS Signature Version
|
8746
|
-
# 4)](sig-v4-authenticating-requests.html).
|
8745
|
+
# This action requires AWS Signature Version 4. For more information,
|
8746
|
+
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
8747
8747
|
#
|
8748
8748
|
# To use this operation, you must have permissions to perform the
|
8749
8749
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
8750
8750
|
# permission by default. The bucket owner can grant this permission to
|
8751
8751
|
# others. For more information about permissions, see [Permissions
|
8752
|
-
# Related to Bucket Subresource Operations][
|
8753
|
-
# Permissions to Your Amazon S3 Resources][
|
8754
|
-
#
|
8752
|
+
# Related to Bucket Subresource Operations][4] and [Managing Access
|
8753
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon S3 User
|
8754
|
+
# Guide.
|
8755
8755
|
#
|
8756
8756
|
# **Related Resources**
|
8757
8757
|
#
|
8758
|
-
# * [GetBucketEncryption][
|
8758
|
+
# * [GetBucketEncryption][6]
|
8759
8759
|
#
|
8760
|
-
# * [DeleteBucketEncryption][
|
8760
|
+
# * [DeleteBucketEncryption][7]
|
8761
8761
|
#
|
8762
8762
|
#
|
8763
8763
|
#
|
8764
8764
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
8765
8765
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
8766
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8767
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8768
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8769
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8766
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
8767
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8768
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
8769
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
8770
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
8770
8771
|
#
|
8771
8772
|
# @option params [required, String] :bucket
|
8772
8773
|
# Specifies default encryption for a bucket using server-side encryption
|
8773
8774
|
# with Amazon S3-managed keys (SSE-S3) or customer master keys stored in
|
8774
8775
|
# AWS KMS (SSE-KMS). For information about the Amazon S3 default
|
8775
8776
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
8776
|
-
# the *Amazon
|
8777
|
+
# the *Amazon S3 User Guide*.
|
8777
8778
|
#
|
8778
8779
|
#
|
8779
8780
|
#
|
@@ -8790,7 +8791,7 @@ module Aws::S3
|
|
8790
8791
|
# Specifies the default server-side-encryption configuration.
|
8791
8792
|
#
|
8792
8793
|
# @option params [String] :expected_bucket_owner
|
8793
|
-
# The account
|
8794
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
8794
8795
|
# a different account, the request will fail with an HTTP `403 (Access
|
8795
8796
|
# Denied)` error.
|
8796
8797
|
#
|
@@ -8945,7 +8946,7 @@ module Aws::S3
|
|
8945
8946
|
req.send_request(options)
|
8946
8947
|
end
|
8947
8948
|
|
8948
|
-
# This implementation of the `PUT`
|
8949
|
+
# This implementation of the `PUT` action adds an inventory
|
8949
8950
|
# configuration (identified by the inventory ID) to the bucket. You can
|
8950
8951
|
# have up to 1,000 inventory configurations per bucket.
|
8951
8952
|
#
|
@@ -8961,8 +8962,7 @@ module Aws::S3
|
|
8961
8962
|
# whether to generate the inventory daily or weekly. You can also
|
8962
8963
|
# configure what object metadata to include and whether to inventory all
|
8963
8964
|
# object versions or only current versions. For more information, see
|
8964
|
-
# [Amazon S3 Inventory][1] in the Amazon
|
8965
|
-
# Developer Guide.
|
8965
|
+
# [Amazon S3 Inventory][1] in the Amazon S3 User Guide.
|
8966
8966
|
#
|
8967
8967
|
# You must create a bucket policy on the *destination* bucket to grant
|
8968
8968
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
@@ -8974,8 +8974,7 @@ module Aws::S3
|
|
8974
8974
|
# permission by default and can grant this permission to others. For
|
8975
8975
|
# more information about permissions, see [Permissions Related to Bucket
|
8976
8976
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
8977
|
-
# Amazon S3 Resources][4] in the Amazon
|
8978
|
-
# Guide.
|
8977
|
+
# Amazon S3 Resources][4] in the Amazon S3 User Guide.
|
8979
8978
|
#
|
8980
8979
|
# **Special Errors**
|
8981
8980
|
#
|
@@ -9012,8 +9011,8 @@ module Aws::S3
|
|
9012
9011
|
#
|
9013
9012
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
9014
9013
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
9015
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9016
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9014
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9015
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9017
9016
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html
|
9018
9017
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html
|
9019
9018
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html
|
@@ -9029,7 +9028,7 @@ module Aws::S3
|
|
9029
9028
|
# Specifies the inventory configuration.
|
9030
9029
|
#
|
9031
9030
|
# @option params [String] :expected_bucket_owner
|
9032
|
-
# The account
|
9031
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9033
9032
|
# a different account, the request will fail with an HTTP `403 (Access
|
9034
9033
|
# Denied)` error.
|
9035
9034
|
#
|
@@ -9086,8 +9085,8 @@ module Aws::S3
|
|
9086
9085
|
#
|
9087
9086
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9088
9087
|
# existing lifecycle configuration. For information about lifecycle
|
9089
|
-
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
9090
|
-
#
|
9088
|
+
# configuration, see [Object Lifecycle Management][2] in the *Amazon S3
|
9089
|
+
# User Guide*.
|
9091
9090
|
#
|
9092
9091
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
9093
9092
|
# related subresources (for example, lifecycle configuration and website
|
@@ -9109,8 +9108,8 @@ module Aws::S3
|
|
9109
9108
|
# * `s3:PutLifecycleConfiguration`
|
9110
9109
|
#
|
9111
9110
|
# For more information about permissions, see [Managing Access
|
9112
|
-
# Permissions to your Amazon S3 Resources][3] in the *Amazon
|
9113
|
-
#
|
9111
|
+
# Permissions to your Amazon S3 Resources][3] in the *Amazon S3 User
|
9112
|
+
# Guide*.
|
9114
9113
|
#
|
9115
9114
|
# For more examples of transitioning objects to storage classes such as
|
9116
9115
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
@@ -9128,7 +9127,7 @@ module Aws::S3
|
|
9128
9127
|
# the AWS account that created the bucket—can perform any of the
|
9129
9128
|
# operations. A resource owner can also grant others permission to
|
9130
9129
|
# perform the operation. For more information, see the following
|
9131
|
-
# topics in the Amazon
|
9130
|
+
# topics in the Amazon S3 User Guide:
|
9132
9131
|
#
|
9133
9132
|
# * [Specifying Permissions in a Policy][8]
|
9134
9133
|
#
|
@@ -9138,7 +9137,7 @@ module Aws::S3
|
|
9138
9137
|
#
|
9139
9138
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html
|
9140
9139
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9141
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9140
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9142
9141
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
9143
9142
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html
|
9144
9143
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html
|
@@ -9154,7 +9153,7 @@ module Aws::S3
|
|
9154
9153
|
# @option params [Types::LifecycleConfiguration] :lifecycle_configuration
|
9155
9154
|
#
|
9156
9155
|
# @option params [String] :expected_bucket_owner
|
9157
|
-
# The account
|
9156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9158
9157
|
# a different account, the request will fail with an HTTP `403 (Access
|
9159
9158
|
# Denied)` error.
|
9160
9159
|
#
|
@@ -9278,7 +9277,7 @@ module Aws::S3
|
|
9278
9277
|
#
|
9279
9278
|
#
|
9280
9279
|
#
|
9281
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9280
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9282
9281
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html
|
9283
9282
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
9284
9283
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html
|
@@ -9293,7 +9292,7 @@ module Aws::S3
|
|
9293
9292
|
# Container for lifecycle rules. You can add as many as 1,000 rules.
|
9294
9293
|
#
|
9295
9294
|
# @option params [String] :expected_bucket_owner
|
9296
|
-
# The account
|
9295
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9297
9296
|
# a different account, the request will fail with an HTTP `403 (Access
|
9298
9297
|
# Denied)` error.
|
9299
9298
|
#
|
@@ -9474,7 +9473,7 @@ module Aws::S3
|
|
9474
9473
|
# SDKs, this field is calculated automatically.
|
9475
9474
|
#
|
9476
9475
|
# @option params [String] :expected_bucket_owner
|
9477
|
-
# The account
|
9476
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9478
9477
|
# a different account, the request will fail with an HTTP `403 (Access
|
9479
9478
|
# Denied)` error.
|
9480
9479
|
#
|
@@ -9577,8 +9576,8 @@ module Aws::S3
|
|
9577
9576
|
#
|
9578
9577
|
#
|
9579
9578
|
#
|
9580
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9581
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
9579
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
9580
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
9582
9581
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html
|
9583
9582
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html
|
9584
9583
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html
|
@@ -9594,7 +9593,7 @@ module Aws::S3
|
|
9594
9593
|
# Specifies the metrics configuration.
|
9595
9594
|
#
|
9596
9595
|
# @option params [String] :expected_bucket_owner
|
9597
|
-
# The account
|
9596
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9598
9597
|
# a different account, the request will fail with an HTTP `403 (Access
|
9599
9598
|
# Denied)` error.
|
9600
9599
|
#
|
@@ -9656,7 +9655,7 @@ module Aws::S3
|
|
9656
9655
|
# The container for the configuration.
|
9657
9656
|
#
|
9658
9657
|
# @option params [String] :expected_bucket_owner
|
9659
|
-
# The account
|
9658
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9660
9659
|
# a different account, the request will fail with an HTTP `403 (Access
|
9661
9660
|
# Denied)` error.
|
9662
9661
|
#
|
@@ -9718,8 +9717,8 @@ module Aws::S3
|
|
9718
9717
|
#
|
9719
9718
|
# `</NotificationConfiguration>`
|
9720
9719
|
#
|
9721
|
-
# This
|
9722
|
-
#
|
9720
|
+
# This action replaces the existing notification configuration with the
|
9721
|
+
# configuration you include in the request body.
|
9723
9722
|
#
|
9724
9723
|
# After Amazon S3 receives this request, it first verifies that any
|
9725
9724
|
# Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
|
@@ -9742,8 +9741,8 @@ module Aws::S3
|
|
9742
9741
|
# notification configuration includes SNS topic, SQS queue, and Lambda
|
9743
9742
|
# function configurations. When you send a PUT request with this
|
9744
9743
|
# configuration, Amazon S3 sends test messages to your SNS topic. If the
|
9745
|
-
# message fails, the entire PUT
|
9746
|
-
#
|
9744
|
+
# message fails, the entire PUT action will fail, and Amazon S3 will not
|
9745
|
+
# add the configuration to your bucket.
|
9747
9746
|
#
|
9748
9747
|
# </note>
|
9749
9748
|
#
|
@@ -9755,7 +9754,7 @@ module Aws::S3
|
|
9755
9754
|
# include the `x-amz-sns-test-message-id` header containing the message
|
9756
9755
|
# ID of the test notification sent to the topic.
|
9757
9756
|
#
|
9758
|
-
# The following
|
9757
|
+
# The following action is related to
|
9759
9758
|
# `PutBucketNotificationConfiguration`\:
|
9760
9759
|
#
|
9761
9760
|
# * [GetBucketNotificationConfiguration][2]
|
@@ -9776,7 +9775,7 @@ module Aws::S3
|
|
9776
9775
|
# bucket.
|
9777
9776
|
#
|
9778
9777
|
# @option params [String] :expected_bucket_owner
|
9779
|
-
# The account
|
9778
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9780
9779
|
# a different account, the request will fail with an HTTP `403 (Access
|
9781
9780
|
# Denied)` error.
|
9782
9781
|
#
|
@@ -9900,7 +9899,7 @@ module Aws::S3
|
|
9900
9899
|
# SDKs, this field is calculated automatically.
|
9901
9900
|
#
|
9902
9901
|
# @option params [String] :expected_bucket_owner
|
9903
|
-
# The account
|
9902
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9904
9903
|
# a different account, the request will fail with an HTTP `403 (Access
|
9905
9904
|
# Denied)` error.
|
9906
9905
|
#
|
@@ -9981,7 +9980,7 @@ module Aws::S3
|
|
9981
9980
|
# The bucket policy as a JSON document.
|
9982
9981
|
#
|
9983
9982
|
# @option params [String] :expected_bucket_owner
|
9984
|
-
# The account
|
9983
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
9985
9984
|
# a different account, the request will fail with an HTTP `403 (Access
|
9986
9985
|
# Denied)` error.
|
9987
9986
|
#
|
@@ -10020,8 +10019,8 @@ module Aws::S3
|
|
10020
10019
|
# more information, see [Replication][1] in the *Amazon S3 Developer
|
10021
10020
|
# Guide*.
|
10022
10021
|
#
|
10023
|
-
# <note markdown="1"> To perform this operation, the user or role performing the
|
10024
|
-
#
|
10022
|
+
# <note markdown="1"> To perform this operation, the user or role performing the action must
|
10023
|
+
# have the [iam:PassRole][2] permission.
|
10025
10024
|
#
|
10026
10025
|
# </note>
|
10027
10026
|
#
|
@@ -10086,7 +10085,7 @@ module Aws::S3
|
|
10086
10085
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations
|
10087
10086
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html
|
10088
10087
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
10089
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10088
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10090
10089
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html
|
10091
10090
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList
|
10092
10091
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
@@ -10115,7 +10114,7 @@ module Aws::S3
|
|
10115
10114
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
10116
10115
|
#
|
10117
10116
|
# @option params [String] :expected_bucket_owner
|
10118
|
-
# The account
|
10117
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10119
10118
|
# a different account, the request will fail with an HTTP `403 (Access
|
10120
10119
|
# Denied)` error.
|
10121
10120
|
#
|
@@ -10262,7 +10261,7 @@ module Aws::S3
|
|
10262
10261
|
# Container for Payer.
|
10263
10262
|
#
|
10264
10263
|
# @option params [String] :expected_bucket_owner
|
10265
|
-
# The account
|
10264
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10266
10265
|
# a different account, the request will fail with an HTTP `403 (Access
|
10267
10266
|
# Denied)` error.
|
10268
10267
|
#
|
@@ -10343,7 +10342,7 @@ module Aws::S3
|
|
10343
10342
|
#
|
10344
10343
|
# * Error code: `OperationAbortedError `
|
10345
10344
|
#
|
10346
|
-
# * Description: A conflicting conditional
|
10345
|
+
# * Description: A conflicting conditional action is currently in
|
10347
10346
|
# progress against this resource. Please try again.
|
10348
10347
|
#
|
10349
10348
|
# ^
|
@@ -10365,8 +10364,8 @@ module Aws::S3
|
|
10365
10364
|
#
|
10366
10365
|
# [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
|
10367
10366
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
10368
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10369
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10367
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
10368
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
10370
10369
|
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
10371
10370
|
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
10372
10371
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html
|
@@ -10391,7 +10390,7 @@ module Aws::S3
|
|
10391
10390
|
# Container for the `TagSet` and `Tag` elements.
|
10392
10391
|
#
|
10393
10392
|
# @option params [String] :expected_bucket_owner
|
10394
|
-
# The account
|
10393
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10395
10394
|
# a different account, the request will fail with an HTTP `403 (Access
|
10396
10395
|
# Denied)` error.
|
10397
10396
|
#
|
@@ -10511,7 +10510,7 @@ module Aws::S3
|
|
10511
10510
|
# Container for setting the versioning state.
|
10512
10511
|
#
|
10513
10512
|
# @option params [String] :expected_bucket_owner
|
10514
|
-
# The account
|
10513
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10515
10514
|
# a different account, the request will fail with an HTTP `403 (Access
|
10516
10515
|
# Denied)` error.
|
10517
10516
|
#
|
@@ -10558,7 +10557,7 @@ module Aws::S3
|
|
10558
10557
|
# such as the file name of the index document and any redirect rules.
|
10559
10558
|
# For more information, see [Hosting Websites on Amazon S3][1].
|
10560
10559
|
#
|
10561
|
-
# This PUT
|
10560
|
+
# This PUT action requires the `S3:PutBucketWebsite` permission. By
|
10562
10561
|
# default, only the bucket owner can configure the website attached to a
|
10563
10562
|
# bucket; however, bucket owners can allow other users to set the
|
10564
10563
|
# website configuration by writing a bucket policy that grants them the
|
@@ -10618,7 +10617,7 @@ module Aws::S3
|
|
10618
10617
|
# Amazon S3 has a limitation of 50 routing rules per website
|
10619
10618
|
# configuration. If you require more than 50 routing rules, you can use
|
10620
10619
|
# object redirect. For more information, see [Configuring an Object
|
10621
|
-
# Redirect][2] in the *Amazon
|
10620
|
+
# Redirect][2] in the *Amazon S3 User Guide*.
|
10622
10621
|
#
|
10623
10622
|
#
|
10624
10623
|
#
|
@@ -10644,7 +10643,7 @@ module Aws::S3
|
|
10644
10643
|
# Container for the request.
|
10645
10644
|
#
|
10646
10645
|
# @option params [String] :expected_bucket_owner
|
10647
|
-
# The account
|
10646
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
10648
10647
|
# a different account, the request will fail with an HTTP `403 (Access
|
10649
10648
|
# Denied)` error.
|
10650
10649
|
#
|
@@ -10734,8 +10733,7 @@ module Aws::S3
|
|
10734
10733
|
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
10735
10734
|
# object with a retention period configured using Amazon S3 Object Lock.
|
10736
10735
|
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
10737
|
-
# Object Lock Overview][1] in the *Amazon
|
10738
|
-
# Developer Guide*.
|
10736
|
+
# Object Lock Overview][1] in the *Amazon S3 User Guide*.
|
10739
10737
|
#
|
10740
10738
|
# </note>
|
10741
10739
|
#
|
@@ -10750,8 +10748,8 @@ module Aws::S3
|
|
10750
10748
|
#
|
10751
10749
|
# If you request server-side encryption using AWS Key Management Service
|
10752
10750
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
10753
|
-
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon
|
10754
|
-
#
|
10751
|
+
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon S3
|
10752
|
+
# User Guide*.
|
10755
10753
|
#
|
10756
10754
|
# **Access Control List (ACL)-Specific Request Headers**
|
10757
10755
|
#
|
@@ -10817,29 +10815,29 @@ module Aws::S3
|
|
10817
10815
|
# Object data.
|
10818
10816
|
#
|
10819
10817
|
# @option params [required, String] :bucket
|
10820
|
-
# The bucket name to which the PUT
|
10818
|
+
# The bucket name to which the PUT action was initiated.
|
10821
10819
|
#
|
10822
|
-
# When using this
|
10823
|
-
# the access point hostname. The access point hostname takes the form
|
10820
|
+
# When using this action with an access point, you must direct requests
|
10821
|
+
# to the access point hostname. The access point hostname takes the form
|
10824
10822
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10825
|
-
# When using this
|
10826
|
-
#
|
10823
|
+
# When using this action with an access point through the AWS SDKs, you
|
10824
|
+
# provide the access point ARN in place of the bucket name. For more
|
10827
10825
|
# information about access point ARNs, see [Using Access Points][1] in
|
10828
|
-
# the *Amazon
|
10826
|
+
# the *Amazon S3 User Guide*.
|
10829
10827
|
#
|
10830
|
-
# When using this
|
10828
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
10831
10829
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10832
10830
|
# takes the form
|
10833
10831
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
10834
|
-
# When using this
|
10835
|
-
#
|
10836
|
-
#
|
10837
|
-
#
|
10832
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
10833
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
10834
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
10835
|
+
# in the *Amazon S3 User Guide*.
|
10838
10836
|
#
|
10839
10837
|
#
|
10840
10838
|
#
|
10841
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10842
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
10839
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
10840
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
10843
10841
|
#
|
10844
10842
|
# @option params [String] :cache_control
|
10845
10843
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -10934,7 +10932,7 @@ module Aws::S3
|
|
10934
10932
|
# This action is not supported by Amazon S3 on Outposts.
|
10935
10933
|
#
|
10936
10934
|
# @option params [required, String] :key
|
10937
|
-
# Object key for which the PUT
|
10935
|
+
# Object key for which the PUT action was initiated.
|
10938
10936
|
#
|
10939
10937
|
# @option params [Hash<String,String>] :metadata
|
10940
10938
|
# A map of metadata to store with the object in S3.
|
@@ -11021,8 +11019,8 @@ module Aws::S3
|
|
11021
11019
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
11022
11020
|
# for object encryption with SSE-KMS.
|
11023
11021
|
#
|
11024
|
-
# Specifying this header with a PUT
|
11025
|
-
#
|
11022
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11023
|
+
# settings for S3 Bucket Key.
|
11026
11024
|
#
|
11027
11025
|
# @option params [String] :request_payer
|
11028
11026
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11054,7 +11052,7 @@ module Aws::S3
|
|
11054
11052
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
11055
11053
|
#
|
11056
11054
|
# @option params [String] :expected_bucket_owner
|
11057
|
-
# The account
|
11055
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11058
11056
|
# a different account, the request will fail with an HTTP `403 (Access
|
11059
11057
|
# Denied)` error.
|
11060
11058
|
#
|
@@ -11072,45 +11070,59 @@ module Aws::S3
|
|
11072
11070
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11073
11071
|
#
|
11074
11072
|
#
|
11075
|
-
# @example Example: To upload object and specify
|
11073
|
+
# @example Example: To upload an object and specify optional tags
|
11076
11074
|
#
|
11077
|
-
# # The following example
|
11078
|
-
# #
|
11075
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11076
|
+
# # S3 returns version ID of the newly created object.
|
11077
|
+
#
|
11078
|
+
# resp = client.put_object({
|
11079
|
+
# body: "c:\\HappyFace.jpg",
|
11080
|
+
# bucket: "examplebucket",
|
11081
|
+
# key: "HappyFace.jpg",
|
11082
|
+
# tagging: "key1=value1&key2=value2",
|
11083
|
+
# })
|
11084
|
+
#
|
11085
|
+
# resp.to_h outputs the following:
|
11086
|
+
# {
|
11087
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11088
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11089
|
+
# }
|
11090
|
+
#
|
11091
|
+
# @example Example: To create an object.
|
11092
|
+
#
|
11093
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
11079
11094
|
#
|
11080
11095
|
# resp = client.put_object({
|
11081
11096
|
# body: "filetoupload",
|
11082
11097
|
# bucket: "examplebucket",
|
11083
|
-
# key: "
|
11084
|
-
# metadata: {
|
11085
|
-
# "metadata1" => "value1",
|
11086
|
-
# "metadata2" => "value2",
|
11087
|
-
# },
|
11098
|
+
# key: "objectkey",
|
11088
11099
|
# })
|
11089
11100
|
#
|
11090
11101
|
# resp.to_h outputs the following:
|
11091
11102
|
# {
|
11092
11103
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11093
|
-
# version_id: "
|
11104
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
11094
11105
|
# }
|
11095
11106
|
#
|
11096
|
-
# @example Example: To upload
|
11107
|
+
# @example Example: To upload object and specify user-defined metadata
|
11097
11108
|
#
|
11098
|
-
# # The following example
|
11099
|
-
# #
|
11109
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
11110
|
+
# # enabled, S3 returns version ID in response.
|
11100
11111
|
#
|
11101
11112
|
# resp = client.put_object({
|
11102
11113
|
# body: "filetoupload",
|
11103
11114
|
# bucket: "examplebucket",
|
11104
11115
|
# key: "exampleobject",
|
11105
|
-
#
|
11106
|
-
#
|
11116
|
+
# metadata: {
|
11117
|
+
# "metadata1" => "value1",
|
11118
|
+
# "metadata2" => "value2",
|
11119
|
+
# },
|
11107
11120
|
# })
|
11108
11121
|
#
|
11109
11122
|
# resp.to_h outputs the following:
|
11110
11123
|
# {
|
11111
11124
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11112
|
-
#
|
11113
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11125
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11114
11126
|
# }
|
11115
11127
|
#
|
11116
11128
|
# @example Example: To upload an object
|
@@ -11130,20 +11142,24 @@ module Aws::S3
|
|
11130
11142
|
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11131
11143
|
# }
|
11132
11144
|
#
|
11133
|
-
# @example Example: To
|
11145
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
11134
11146
|
#
|
11135
|
-
# # The following example
|
11147
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
11148
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
11136
11149
|
#
|
11137
11150
|
# resp = client.put_object({
|
11138
11151
|
# body: "filetoupload",
|
11139
11152
|
# bucket: "examplebucket",
|
11140
|
-
# key: "
|
11153
|
+
# key: "exampleobject",
|
11154
|
+
# server_side_encryption: "AES256",
|
11155
|
+
# tagging: "key1=value1&key2=value2",
|
11141
11156
|
# })
|
11142
11157
|
#
|
11143
11158
|
# resp.to_h outputs the following:
|
11144
11159
|
# {
|
11145
11160
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11146
|
-
#
|
11161
|
+
# server_side_encryption: "AES256",
|
11162
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11147
11163
|
# }
|
11148
11164
|
#
|
11149
11165
|
# @example Example: To upload an object and specify canned ACL.
|
@@ -11164,24 +11180,6 @@ module Aws::S3
|
|
11164
11180
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
11165
11181
|
# }
|
11166
11182
|
#
|
11167
|
-
# @example Example: To upload an object and specify optional tags
|
11168
|
-
#
|
11169
|
-
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
11170
|
-
# # S3 returns version ID of the newly created object.
|
11171
|
-
#
|
11172
|
-
# resp = client.put_object({
|
11173
|
-
# body: "c:\\HappyFace.jpg",
|
11174
|
-
# bucket: "examplebucket",
|
11175
|
-
# key: "HappyFace.jpg",
|
11176
|
-
# tagging: "key1=value1&key2=value2",
|
11177
|
-
# })
|
11178
|
-
#
|
11179
|
-
# resp.to_h outputs the following:
|
11180
|
-
# {
|
11181
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11182
|
-
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11183
|
-
# }
|
11184
|
-
#
|
11185
11183
|
# @example Example: To upload an object (specify optional headers)
|
11186
11184
|
#
|
11187
11185
|
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
@@ -11272,8 +11270,8 @@ module Aws::S3
|
|
11272
11270
|
# Uses the `acl` subresource to set the access control list (ACL)
|
11273
11271
|
# permissions for a new or existing object in an S3 bucket. You must
|
11274
11272
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
11275
|
-
# information, see [What permissions can I grant?][1] in the *Amazon
|
11276
|
-
#
|
11273
|
+
# information, see [What permissions can I grant?][1] in the *Amazon S3
|
11274
|
+
# User Guide*.
|
11277
11275
|
#
|
11278
11276
|
# This action is not supported by Amazon S3 on Outposts.
|
11279
11277
|
#
|
@@ -11437,17 +11435,17 @@ module Aws::S3
|
|
11437
11435
|
# The bucket name that contains the object to which you want to attach
|
11438
11436
|
# the ACL.
|
11439
11437
|
#
|
11440
|
-
# When using this
|
11441
|
-
# the access point hostname. The access point hostname takes the form
|
11438
|
+
# When using this action with an access point, you must direct requests
|
11439
|
+
# to the access point hostname. The access point hostname takes the form
|
11442
11440
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11443
|
-
# When using this
|
11444
|
-
#
|
11441
|
+
# When using this action with an access point through the AWS SDKs, you
|
11442
|
+
# provide the access point ARN in place of the bucket name. For more
|
11445
11443
|
# information about access point ARNs, see [Using Access Points][1] in
|
11446
|
-
# the *Amazon
|
11444
|
+
# the *Amazon S3 User Guide*.
|
11447
11445
|
#
|
11448
11446
|
#
|
11449
11447
|
#
|
11450
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11448
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11451
11449
|
#
|
11452
11450
|
# @option params [String] :content_md5
|
11453
11451
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -11488,29 +11486,29 @@ module Aws::S3
|
|
11488
11486
|
# This action is not supported by Amazon S3 on Outposts.
|
11489
11487
|
#
|
11490
11488
|
# @option params [required, String] :key
|
11491
|
-
# Key for which the PUT
|
11489
|
+
# Key for which the PUT action was initiated.
|
11492
11490
|
#
|
11493
|
-
# When using this
|
11494
|
-
# the access point hostname. The access point hostname takes the form
|
11491
|
+
# When using this action with an access point, you must direct requests
|
11492
|
+
# to the access point hostname. The access point hostname takes the form
|
11495
11493
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11496
|
-
# When using this
|
11497
|
-
#
|
11494
|
+
# When using this action with an access point through the AWS SDKs, you
|
11495
|
+
# provide the access point ARN in place of the bucket name. For more
|
11498
11496
|
# information about access point ARNs, see [Using Access Points][1] in
|
11499
|
-
# the *Amazon
|
11497
|
+
# the *Amazon S3 User Guide*.
|
11500
11498
|
#
|
11501
|
-
# When using this
|
11499
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11502
11500
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11503
11501
|
# takes the form
|
11504
11502
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11505
|
-
# When using this
|
11506
|
-
#
|
11507
|
-
#
|
11508
|
-
#
|
11503
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11504
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11505
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11506
|
+
# in the *Amazon S3 User Guide*.
|
11509
11507
|
#
|
11510
11508
|
#
|
11511
11509
|
#
|
11512
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11513
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11510
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11511
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11514
11512
|
#
|
11515
11513
|
# @option params [String] :request_payer
|
11516
11514
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11527,7 +11525,7 @@ module Aws::S3
|
|
11527
11525
|
# VersionId used to reference a specific version of the object.
|
11528
11526
|
#
|
11529
11527
|
# @option params [String] :expected_bucket_owner
|
11530
|
-
# The account
|
11528
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11531
11529
|
# a different account, the request will fail with an HTTP `403 (Access
|
11532
11530
|
# Denied)` error.
|
11533
11531
|
#
|
@@ -11602,16 +11600,11 @@ module Aws::S3
|
|
11602
11600
|
req.send_request(options)
|
11603
11601
|
end
|
11604
11602
|
|
11605
|
-
# Applies a Legal Hold configuration to the specified object.
|
11603
|
+
# Applies a Legal Hold configuration to the specified object. For more
|
11604
|
+
# information, see [Locking Objects][1].
|
11606
11605
|
#
|
11607
11606
|
# This action is not supported by Amazon S3 on Outposts.
|
11608
11607
|
#
|
11609
|
-
# **Related Resources**
|
11610
|
-
#
|
11611
|
-
# * [Locking Objects][1]
|
11612
|
-
#
|
11613
|
-
# ^
|
11614
|
-
#
|
11615
11608
|
#
|
11616
11609
|
#
|
11617
11610
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11620,17 +11613,17 @@ module Aws::S3
|
|
11620
11613
|
# The bucket name containing the object that you want to place a Legal
|
11621
11614
|
# Hold on.
|
11622
11615
|
#
|
11623
|
-
# When using this
|
11624
|
-
# the access point hostname. The access point hostname takes the form
|
11616
|
+
# When using this action with an access point, you must direct requests
|
11617
|
+
# to the access point hostname. The access point hostname takes the form
|
11625
11618
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11626
|
-
# When using this
|
11627
|
-
#
|
11619
|
+
# When using this action with an access point through the AWS SDKs, you
|
11620
|
+
# provide the access point ARN in place of the bucket name. For more
|
11628
11621
|
# information about access point ARNs, see [Using Access Points][1] in
|
11629
|
-
# the *Amazon
|
11622
|
+
# the *Amazon S3 User Guide*.
|
11630
11623
|
#
|
11631
11624
|
#
|
11632
11625
|
#
|
11633
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11626
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11634
11627
|
#
|
11635
11628
|
# @option params [required, String] :key
|
11636
11629
|
# The key name for the object that you want to place a Legal Hold on.
|
@@ -11660,7 +11653,7 @@ module Aws::S3
|
|
11660
11653
|
# SDKs, this field is calculated automatically.
|
11661
11654
|
#
|
11662
11655
|
# @option params [String] :expected_bucket_owner
|
11663
|
-
# The account
|
11656
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11664
11657
|
# a different account, the request will fail with an HTTP `403 (Access
|
11665
11658
|
# Denied)` error.
|
11666
11659
|
#
|
@@ -11697,18 +11690,19 @@ module Aws::S3
|
|
11697
11690
|
|
11698
11691
|
# Places an Object Lock configuration on the specified bucket. The rule
|
11699
11692
|
# specified in the Object Lock configuration will be applied by default
|
11700
|
-
# to every new object placed in the specified bucket.
|
11693
|
+
# to every new object placed in the specified bucket. For more
|
11694
|
+
# information, see [Locking Objects][1].
|
11701
11695
|
#
|
11702
|
-
# <note markdown="1"> `DefaultRetention`
|
11703
|
-
# both at the same time.
|
11696
|
+
# <note markdown="1"> * The `DefaultRetention` settings require both a mode and a period.
|
11704
11697
|
#
|
11705
|
-
#
|
11698
|
+
# * The `DefaultRetention` period can be either `Days` or `Years` but
|
11699
|
+
# you must select one. You cannot specify `Days` and `Years` at the
|
11700
|
+
# same time.
|
11706
11701
|
#
|
11707
|
-
#
|
11702
|
+
# * You can only enable Object Lock for new buckets. If you want to turn
|
11703
|
+
# on Object Lock for an existing bucket, contact AWS Support.
|
11708
11704
|
#
|
11709
|
-
#
|
11710
|
-
#
|
11711
|
-
# ^
|
11705
|
+
# </note>
|
11712
11706
|
#
|
11713
11707
|
#
|
11714
11708
|
#
|
@@ -11743,7 +11737,7 @@ module Aws::S3
|
|
11743
11737
|
# SDKs, this field is calculated automatically.
|
11744
11738
|
#
|
11745
11739
|
# @option params [String] :expected_bucket_owner
|
11746
|
-
# The account
|
11740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11747
11741
|
# a different account, the request will fail with an HTTP `403 (Access
|
11748
11742
|
# Denied)` error.
|
11749
11743
|
#
|
@@ -11784,16 +11778,11 @@ module Aws::S3
|
|
11784
11778
|
req.send_request(options)
|
11785
11779
|
end
|
11786
11780
|
|
11787
|
-
# Places an Object Retention configuration on an object.
|
11781
|
+
# Places an Object Retention configuration on an object. For more
|
11782
|
+
# information, see [Locking Objects][1].
|
11788
11783
|
#
|
11789
11784
|
# This action is not supported by Amazon S3 on Outposts.
|
11790
11785
|
#
|
11791
|
-
# **Related Resources**
|
11792
|
-
#
|
11793
|
-
# * [Locking Objects][1]
|
11794
|
-
#
|
11795
|
-
# ^
|
11796
|
-
#
|
11797
11786
|
#
|
11798
11787
|
#
|
11799
11788
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
@@ -11802,17 +11791,17 @@ module Aws::S3
|
|
11802
11791
|
# The bucket name that contains the object you want to apply this Object
|
11803
11792
|
# Retention configuration to.
|
11804
11793
|
#
|
11805
|
-
# When using this
|
11806
|
-
# the access point hostname. The access point hostname takes the form
|
11794
|
+
# When using this action with an access point, you must direct requests
|
11795
|
+
# to the access point hostname. The access point hostname takes the form
|
11807
11796
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11808
|
-
# When using this
|
11809
|
-
#
|
11797
|
+
# When using this action with an access point through the AWS SDKs, you
|
11798
|
+
# provide the access point ARN in place of the bucket name. For more
|
11810
11799
|
# information about access point ARNs, see [Using Access Points][1] in
|
11811
|
-
# the *Amazon
|
11800
|
+
# the *Amazon S3 User Guide*.
|
11812
11801
|
#
|
11813
11802
|
#
|
11814
11803
|
#
|
11815
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11804
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11816
11805
|
#
|
11817
11806
|
# @option params [required, String] :key
|
11818
11807
|
# The key name for the object that you want to apply this Object
|
@@ -11837,7 +11826,7 @@ module Aws::S3
|
|
11837
11826
|
# Retention configuration to.
|
11838
11827
|
#
|
11839
11828
|
# @option params [Boolean] :bypass_governance_retention
|
11840
|
-
# Indicates whether this
|
11829
|
+
# Indicates whether this action should bypass Governance-mode
|
11841
11830
|
# restrictions.
|
11842
11831
|
#
|
11843
11832
|
# @option params [String] :content_md5
|
@@ -11847,7 +11836,7 @@ module Aws::S3
|
|
11847
11836
|
# SDKs, this field is calculated automatically.
|
11848
11837
|
#
|
11849
11838
|
# @option params [String] :expected_bucket_owner
|
11850
|
-
# The account
|
11839
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11851
11840
|
# a different account, the request will fail with an HTTP `403 (Access
|
11852
11841
|
# Denied)` error.
|
11853
11842
|
#
|
@@ -11920,8 +11909,8 @@ module Aws::S3
|
|
11920
11909
|
#
|
11921
11910
|
# * * <i>Code: OperationAbortedError </i>
|
11922
11911
|
#
|
11923
|
-
# * *Cause: A conflicting conditional
|
11924
|
-
#
|
11912
|
+
# * *Cause: A conflicting conditional action is currently in progress
|
11913
|
+
# against this resource. Please try again.*
|
11925
11914
|
#
|
11926
11915
|
# * * *Code: InternalError*
|
11927
11916
|
#
|
@@ -11944,27 +11933,27 @@ module Aws::S3
|
|
11944
11933
|
# @option params [required, String] :bucket
|
11945
11934
|
# The bucket name containing the object.
|
11946
11935
|
#
|
11947
|
-
# When using this
|
11948
|
-
# the access point hostname. The access point hostname takes the form
|
11936
|
+
# When using this action with an access point, you must direct requests
|
11937
|
+
# to the access point hostname. The access point hostname takes the form
|
11949
11938
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11950
|
-
# When using this
|
11951
|
-
#
|
11939
|
+
# When using this action with an access point through the AWS SDKs, you
|
11940
|
+
# provide the access point ARN in place of the bucket name. For more
|
11952
11941
|
# information about access point ARNs, see [Using Access Points][1] in
|
11953
|
-
# the *Amazon
|
11942
|
+
# the *Amazon S3 User Guide*.
|
11954
11943
|
#
|
11955
|
-
# When using this
|
11944
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11956
11945
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11957
11946
|
# takes the form
|
11958
11947
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11959
|
-
# When using this
|
11960
|
-
#
|
11961
|
-
#
|
11962
|
-
#
|
11948
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11949
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11950
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11951
|
+
# in the *Amazon S3 User Guide*.
|
11963
11952
|
#
|
11964
11953
|
#
|
11965
11954
|
#
|
11966
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11967
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
11955
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
11956
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
11968
11957
|
#
|
11969
11958
|
# @option params [required, String] :key
|
11970
11959
|
# Name of the object key.
|
@@ -11982,7 +11971,7 @@ module Aws::S3
|
|
11982
11971
|
# Container for the `TagSet` and `Tag` elements
|
11983
11972
|
#
|
11984
11973
|
# @option params [String] :expected_bucket_owner
|
11985
|
-
# The account
|
11974
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
11986
11975
|
# a different account, the request will fail with an HTTP `403 (Access
|
11987
11976
|
# Denied)` error.
|
11988
11977
|
#
|
@@ -12110,14 +12099,14 @@ module Aws::S3
|
|
12110
12099
|
# Amazon S3 bucket. You can enable the configuration options in any
|
12111
12100
|
# combination. For more information about when Amazon S3 considers a
|
12112
12101
|
# bucket or object public, see [The Meaning of "Public"][1] in the
|
12113
|
-
# *Amazon
|
12102
|
+
# *Amazon S3 User Guide*.
|
12114
12103
|
#
|
12115
12104
|
#
|
12116
12105
|
#
|
12117
12106
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status
|
12118
12107
|
#
|
12119
12108
|
# @option params [String] :expected_bucket_owner
|
12120
|
-
# The account
|
12109
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12121
12110
|
# a different account, the request will fail with an HTTP `403 (Access
|
12122
12111
|
# Denied)` error.
|
12123
12112
|
#
|
@@ -12161,7 +12150,7 @@ module Aws::S3
|
|
12161
12150
|
# default and can grant this permission to others. For more information
|
12162
12151
|
# about permissions, see [Permissions Related to Bucket Subresource
|
12163
12152
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
12164
|
-
# Resources][2] in the *Amazon
|
12153
|
+
# Resources][2] in the *Amazon S3 User Guide*.
|
12165
12154
|
#
|
12166
12155
|
# **Querying Archives with Select Requests**
|
12167
12156
|
#
|
@@ -12171,7 +12160,7 @@ module Aws::S3
|
|
12171
12160
|
# files. You can run queries and custom analytics on your archived data
|
12172
12161
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
12173
12162
|
# overview about select requests, see [Querying Archived Objects][3] in
|
12174
|
-
# the *Amazon
|
12163
|
+
# the *Amazon S3 User Guide*.
|
12175
12164
|
#
|
12176
12165
|
# When making a select request, do the following:
|
12177
12166
|
#
|
@@ -12181,19 +12170,18 @@ module Aws::S3
|
|
12181
12170
|
# that initiates the job must have permissions to write to the S3
|
12182
12171
|
# bucket. You can specify the storage class and encryption for the
|
12183
12172
|
# output objects stored in the bucket. For more information about
|
12184
|
-
# output, see [Querying Archived Objects][3] in the *Amazon
|
12185
|
-
#
|
12173
|
+
# output, see [Querying Archived Objects][3] in the *Amazon S3 User
|
12174
|
+
# Guide*.
|
12186
12175
|
#
|
12187
12176
|
# For more information about the `S3` structure in the request body,
|
12188
12177
|
# see the following:
|
12189
12178
|
#
|
12190
12179
|
# * [PutObject][4]
|
12191
12180
|
#
|
12192
|
-
# * [Managing Access with ACLs][5] in the *Amazon
|
12193
|
-
# Service Developer Guide*
|
12181
|
+
# * [Managing Access with ACLs][5] in the *Amazon S3 User Guide*
|
12194
12182
|
#
|
12195
12183
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
12196
|
-
#
|
12184
|
+
# S3 User Guide*
|
12197
12185
|
#
|
12198
12186
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
12199
12187
|
# your query in the request body's `SelectParameters` structure. You
|
@@ -12219,7 +12207,7 @@ module Aws::S3
|
|
12219
12207
|
#
|
12220
12208
|
# For more information about using SQL with S3 Glacier Select restore,
|
12221
12209
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
12222
|
-
# the *Amazon
|
12210
|
+
# the *Amazon S3 User Guide*.
|
12223
12211
|
#
|
12224
12212
|
# When making a select request, you can also do the following:
|
12225
12213
|
#
|
@@ -12298,20 +12286,19 @@ module Aws::S3
|
|
12298
12286
|
#
|
12299
12287
|
# For more information about archive retrieval options and provisioned
|
12300
12288
|
# capacity for `Expedited` data access, see [Restoring Archived
|
12301
|
-
# Objects][8] in the *Amazon
|
12289
|
+
# Objects][8] in the *Amazon S3 User Guide*.
|
12302
12290
|
#
|
12303
12291
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
12304
12292
|
# speed to a faster speed while it is in progress. For more information,
|
12305
12293
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
12306
|
-
#
|
12294
|
+
# S3 User Guide*.
|
12307
12295
|
#
|
12308
12296
|
# To get the status of object restoration, you can send a `HEAD`
|
12309
12297
|
# request. Operations return the `x-amz-restore` header, which provides
|
12310
12298
|
# information about the restoration status, in the response. You can use
|
12311
12299
|
# Amazon S3 event notifications to notify you when a restore is
|
12312
12300
|
# initiated or completed. For more information, see [Configuring Amazon
|
12313
|
-
# S3 Event Notifications][10] in the *Amazon
|
12314
|
-
# Developer Guide*.
|
12301
|
+
# S3 Event Notifications][10] in the *Amazon S3 User Guide*.
|
12315
12302
|
#
|
12316
12303
|
# After restoring an archived object, you can update the restoration
|
12317
12304
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -12327,11 +12314,11 @@ module Aws::S3
|
|
12327
12314
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
12328
12315
|
# about lifecycle configuration, see
|
12329
12316
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
12330
|
-
# Management][12] in *Amazon
|
12317
|
+
# Management][12] in *Amazon S3 User Guide*.
|
12331
12318
|
#
|
12332
12319
|
# **Responses**
|
12333
12320
|
#
|
12334
|
-
# A successful
|
12321
|
+
# A successful action returns either the `200 OK` or `202 Accepted`
|
12335
12322
|
# status code.
|
12336
12323
|
#
|
12337
12324
|
# * If the object is not previously restored, then Amazon S3 returns
|
@@ -12369,12 +12356,12 @@ module Aws::S3
|
|
12369
12356
|
# * [GetBucketNotificationConfiguration][13]
|
12370
12357
|
#
|
12371
12358
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
12372
|
-
# the *Amazon
|
12359
|
+
# the *Amazon S3 User Guide*
|
12373
12360
|
#
|
12374
12361
|
#
|
12375
12362
|
#
|
12376
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12377
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12363
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
12364
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html
|
12378
12365
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html
|
12379
12366
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
12380
12367
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
@@ -12390,30 +12377,30 @@ module Aws::S3
|
|
12390
12377
|
# @option params [required, String] :bucket
|
12391
12378
|
# The bucket name containing the object to restore.
|
12392
12379
|
#
|
12393
|
-
# When using this
|
12394
|
-
# the access point hostname. The access point hostname takes the form
|
12380
|
+
# When using this action with an access point, you must direct requests
|
12381
|
+
# to the access point hostname. The access point hostname takes the form
|
12395
12382
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12396
|
-
# When using this
|
12397
|
-
#
|
12383
|
+
# When using this action with an access point through the AWS SDKs, you
|
12384
|
+
# provide the access point ARN in place of the bucket name. For more
|
12398
12385
|
# information about access point ARNs, see [Using Access Points][1] in
|
12399
|
-
# the *Amazon
|
12386
|
+
# the *Amazon S3 User Guide*.
|
12400
12387
|
#
|
12401
|
-
# When using this
|
12388
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
12402
12389
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12403
12390
|
# takes the form
|
12404
12391
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12405
|
-
# When using this
|
12406
|
-
#
|
12407
|
-
#
|
12408
|
-
#
|
12392
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
12393
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
12394
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
12395
|
+
# in the *Amazon S3 User Guide*.
|
12409
12396
|
#
|
12410
12397
|
#
|
12411
12398
|
#
|
12412
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12413
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
12399
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
12400
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
12414
12401
|
#
|
12415
12402
|
# @option params [required, String] :key
|
12416
|
-
# Object key for which the
|
12403
|
+
# Object key for which the action was initiated.
|
12417
12404
|
#
|
12418
12405
|
# @option params [String] :version_id
|
12419
12406
|
# VersionId used to reference a specific version of the object.
|
@@ -12433,7 +12420,7 @@ module Aws::S3
|
|
12433
12420
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
12434
12421
|
#
|
12435
12422
|
# @option params [String] :expected_bucket_owner
|
12436
|
-
# The account
|
12423
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12437
12424
|
# a different account, the request will fail with an HTTP `403 (Access
|
12438
12425
|
# Denied)` error.
|
12439
12426
|
#
|
@@ -12567,7 +12554,7 @@ module Aws::S3
|
|
12567
12554
|
req.send_request(options)
|
12568
12555
|
end
|
12569
12556
|
|
12570
|
-
# This
|
12557
|
+
# This action filters the contents of an Amazon S3 object based on a
|
12571
12558
|
# simple structured query language (SQL) statement. In the request,
|
12572
12559
|
# along with the SQL expression, you must also specify a data
|
12573
12560
|
# serialization format (JSON, CSV, or Apache Parquet) of the object.
|
@@ -12578,12 +12565,11 @@ module Aws::S3
|
|
12578
12565
|
# This action is not supported by Amazon S3 on Outposts.
|
12579
12566
|
#
|
12580
12567
|
# For more information about Amazon S3 Select, see [Selecting Content
|
12581
|
-
# from Objects][1] in the *Amazon
|
12582
|
-
# Guide*.
|
12568
|
+
# from Objects][1] in the *Amazon S3 User Guide*.
|
12583
12569
|
#
|
12584
12570
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
12585
12571
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
12586
|
-
# *Amazon
|
12572
|
+
# *Amazon S3 User Guide*.
|
12587
12573
|
#
|
12588
12574
|
#
|
12589
12575
|
#
|
@@ -12592,7 +12578,7 @@ module Aws::S3
|
|
12592
12578
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
12593
12579
|
# Select does not support anonymous access. For more information about
|
12594
12580
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
12595
|
-
# *Amazon
|
12581
|
+
# *Amazon S3 User Guide*.
|
12596
12582
|
#
|
12597
12583
|
#
|
12598
12584
|
#
|
@@ -12620,8 +12606,7 @@ module Aws::S3
|
|
12620
12606
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
12621
12607
|
# are documented in the [GetObject][4]. For more information about
|
12622
12608
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
12623
|
-
# Encryption Keys)][5] in the *Amazon
|
12624
|
-
# Guide*.
|
12609
|
+
# Encryption Keys)][5] in the *Amazon S3 User Guide*.
|
12625
12610
|
#
|
12626
12611
|
# For objects that are encrypted with Amazon S3 managed encryption
|
12627
12612
|
# keys (SSE-S3) and customer master keys (CMKs) stored in AWS Key
|
@@ -12629,7 +12614,7 @@ module Aws::S3
|
|
12629
12614
|
# transparently, so you don't need to specify anything. For more
|
12630
12615
|
# information about server-side encryption, including SSE-S3 and
|
12631
12616
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
12632
|
-
# the *Amazon
|
12617
|
+
# the *Amazon S3 User Guide*.
|
12633
12618
|
#
|
12634
12619
|
# **Working with the Response Body**
|
12635
12620
|
#
|
@@ -12642,7 +12627,7 @@ module Aws::S3
|
|
12642
12627
|
#
|
12643
12628
|
# **GetObject Support**
|
12644
12629
|
#
|
12645
|
-
# The `SelectObjectContent`
|
12630
|
+
# The `SelectObjectContent` action does not support the following
|
12646
12631
|
# `GetObject` functionality. For more information, see [GetObject][4].
|
12647
12632
|
#
|
12648
12633
|
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
@@ -12653,8 +12638,7 @@ module Aws::S3
|
|
12653
12638
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
12654
12639
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
12655
12640
|
# storage classes. For more information, about storage classes see
|
12656
|
-
# [Storage Classes][9] in the *Amazon
|
12657
|
-
# Guide*.
|
12641
|
+
# [Storage Classes][9] in the *Amazon S3 User Guide*.
|
12658
12642
|
#
|
12659
12643
|
#
|
12660
12644
|
#
|
@@ -12753,7 +12737,7 @@ module Aws::S3
|
|
12753
12737
|
# within the last 50 bytes of the file.
|
12754
12738
|
#
|
12755
12739
|
# @option params [String] :expected_bucket_owner
|
12756
|
-
# The account
|
12740
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
12757
12741
|
# a different account, the request will fail with an HTTP `403 (Access
|
12758
12742
|
# Denied)` error.
|
12759
12743
|
#
|
@@ -13020,12 +13004,11 @@ module Aws::S3
|
|
13020
13004
|
# parts storage and stops charging you for the parts storage.
|
13021
13005
|
#
|
13022
13006
|
# For more information on multipart uploads, go to [Multipart Upload
|
13023
|
-
# Overview][4] in the <i>Amazon
|
13024
|
-
# </i>.
|
13007
|
+
# Overview][4] in the <i>Amazon S3 User Guide </i>.
|
13025
13008
|
#
|
13026
13009
|
# For information on the permissions required to use the multipart
|
13027
|
-
# upload API, go to [Multipart Upload
|
13028
|
-
#
|
13010
|
+
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
13011
|
+
# S3 User Guide*.
|
13029
13012
|
#
|
13030
13013
|
# You can optionally request server-side encryption where Amazon S3
|
13031
13014
|
# encrypts your data as it writes it to disks in its data centers and
|
@@ -13035,8 +13018,7 @@ module Aws::S3
|
|
13035
13018
|
# request headers you provide in the request must match the headers you
|
13036
13019
|
# used in the request to initiate the upload by using
|
13037
13020
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
13038
|
-
# Server-Side Encryption][6] in the *Amazon
|
13039
|
-
# Developer Guide*.
|
13021
|
+
# Server-Side Encryption][6] in the *Amazon S3 User Guide*.
|
13040
13022
|
#
|
13041
13023
|
# Server-side encryption is supported by the S3 Multipart Upload
|
13042
13024
|
# actions. Unless you are using a customer-provided encryption key, you
|
@@ -13099,27 +13081,27 @@ module Aws::S3
|
|
13099
13081
|
# @option params [required, String] :bucket
|
13100
13082
|
# The name of the bucket to which the multipart upload was initiated.
|
13101
13083
|
#
|
13102
|
-
# When using this
|
13103
|
-
# the access point hostname. The access point hostname takes the form
|
13084
|
+
# When using this action with an access point, you must direct requests
|
13085
|
+
# to the access point hostname. The access point hostname takes the form
|
13104
13086
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13105
|
-
# When using this
|
13106
|
-
#
|
13087
|
+
# When using this action with an access point through the AWS SDKs, you
|
13088
|
+
# provide the access point ARN in place of the bucket name. For more
|
13107
13089
|
# information about access point ARNs, see [Using Access Points][1] in
|
13108
|
-
# the *Amazon
|
13090
|
+
# the *Amazon S3 User Guide*.
|
13109
13091
|
#
|
13110
|
-
# When using this
|
13092
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13111
13093
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13112
13094
|
# takes the form
|
13113
13095
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13114
|
-
# When using this
|
13115
|
-
#
|
13116
|
-
#
|
13117
|
-
#
|
13096
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13097
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13098
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13099
|
+
# in the *Amazon S3 User Guide*.
|
13118
13100
|
#
|
13119
13101
|
#
|
13120
13102
|
#
|
13121
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13122
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13103
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13104
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13123
13105
|
#
|
13124
13106
|
# @option params [Integer] :content_length
|
13125
13107
|
# Size of the body in bytes. This parameter is useful when the size of
|
@@ -13171,7 +13153,7 @@ module Aws::S3
|
|
13171
13153
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13172
13154
|
#
|
13173
13155
|
# @option params [String] :expected_bucket_owner
|
13174
|
-
# The account
|
13156
|
+
# The account ID of the expected bucket owner. If the bucket is owned by
|
13175
13157
|
# a different account, the request will fail with an HTTP `403 (Access
|
13176
13158
|
# Denied)` error.
|
13177
13159
|
#
|
@@ -13247,10 +13229,10 @@ module Aws::S3
|
|
13247
13229
|
#
|
13248
13230
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
13249
13231
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
13250
|
-
# in the *Amazon
|
13232
|
+
# in the *Amazon S3 User Guide*.
|
13251
13233
|
#
|
13252
13234
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
13253
|
-
# [UploadPart][2]
|
13235
|
+
# [UploadPart][2] action and provide data in your request.
|
13254
13236
|
#
|
13255
13237
|
# </note>
|
13256
13238
|
#
|
@@ -13263,16 +13245,15 @@ module Aws::S3
|
|
13263
13245
|
# the following:
|
13264
13246
|
#
|
13265
13247
|
# * For conceptual information about multipart uploads, see [Uploading
|
13266
|
-
# Objects Using Multipart Upload][3] in the *Amazon
|
13267
|
-
# Service Developer Guide*.
|
13248
|
+
# Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*.
|
13268
13249
|
#
|
13269
13250
|
# * For information about permissions required to use the multipart
|
13270
|
-
# upload API, see [Multipart Upload
|
13271
|
-
#
|
13251
|
+
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
13252
|
+
# S3 User Guide*.
|
13272
13253
|
#
|
13273
|
-
# * For information about copying objects using a single atomic
|
13274
|
-
#
|
13275
|
-
#
|
13254
|
+
# * For information about copying objects using a single atomic action
|
13255
|
+
# vs. the multipart upload, see [Operations on Objects][5] in the
|
13256
|
+
# *Amazon S3 User Guide*.
|
13276
13257
|
#
|
13277
13258
|
# * For information about using server-side encryption with
|
13278
13259
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
@@ -13374,27 +13355,27 @@ module Aws::S3
|
|
13374
13355
|
# @option params [required, String] :bucket
|
13375
13356
|
# The bucket name.
|
13376
13357
|
#
|
13377
|
-
# When using this
|
13378
|
-
# the access point hostname. The access point hostname takes the form
|
13358
|
+
# When using this action with an access point, you must direct requests
|
13359
|
+
# to the access point hostname. The access point hostname takes the form
|
13379
13360
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13380
|
-
# When using this
|
13381
|
-
#
|
13361
|
+
# When using this action with an access point through the AWS SDKs, you
|
13362
|
+
# provide the access point ARN in place of the bucket name. For more
|
13382
13363
|
# information about access point ARNs, see [Using Access Points][1] in
|
13383
|
-
# the *Amazon
|
13364
|
+
# the *Amazon S3 User Guide*.
|
13384
13365
|
#
|
13385
|
-
# When using this
|
13366
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13386
13367
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13387
13368
|
# takes the form
|
13388
13369
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13389
|
-
# When using this
|
13390
|
-
#
|
13391
|
-
#
|
13392
|
-
#
|
13370
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13371
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13372
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13373
|
+
# in the *Amazon S3 User Guide*.
|
13393
13374
|
#
|
13394
13375
|
#
|
13395
13376
|
#
|
13396
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13397
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13377
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
|
13378
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
|
13398
13379
|
#
|
13399
13380
|
# @option params [required, String] :copy_source
|
13400
13381
|
# Specifies the source object for the copy operation. You specify the
|
@@ -13440,7 +13421,7 @@ module Aws::S3
|
|
13440
13421
|
#
|
13441
13422
|
#
|
13442
13423
|
#
|
13443
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
13424
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html
|
13444
13425
|
#
|
13445
13426
|
# @option params [String] :copy_source_if_match
|
13446
13427
|
# Copies the object if its entity tag (ETag) matches the specified tag.
|
@@ -13517,12 +13498,12 @@ module Aws::S3
|
|
13517
13498
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
13518
13499
|
#
|
13519
13500
|
# @option params [String] :expected_bucket_owner
|
13520
|
-
# The account
|
13501
|
+
# The account ID of the expected destination bucket owner. If the
|
13521
13502
|
# destination bucket is owned by a different account, the request will
|
13522
13503
|
# fail with an HTTP `403 (Access Denied)` error.
|
13523
13504
|
#
|
13524
13505
|
# @option params [String] :expected_source_bucket_owner
|
13525
|
-
# The account
|
13506
|
+
# The account ID of the expected source bucket owner. If the source
|
13526
13507
|
# bucket is owned by a different account, the request will fail with an
|
13527
13508
|
# HTTP `403 (Access Denied)` error.
|
13528
13509
|
#
|
@@ -13538,45 +13519,45 @@ module Aws::S3
|
|
13538
13519
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
13539
13520
|
#
|
13540
13521
|
#
|
13541
|
-
# @example Example: To upload a part by copying
|
13522
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
13542
13523
|
#
|
13543
|
-
# # The following example uploads a part of a multipart upload by copying
|
13524
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
13525
|
+
# # data source.
|
13544
13526
|
#
|
13545
13527
|
# resp = client.upload_part_copy({
|
13546
13528
|
# bucket: "examplebucket",
|
13547
13529
|
# copy_source: "/bucketname/sourceobjectkey",
|
13530
|
+
# copy_source_range: "bytes=1-100000",
|
13548
13531
|
# key: "examplelargeobject",
|
13549
|
-
# part_number:
|
13532
|
+
# part_number: 2,
|
13550
13533
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13551
13534
|
# })
|
13552
13535
|
#
|
13553
13536
|
# resp.to_h outputs the following:
|
13554
13537
|
# {
|
13555
13538
|
# copy_part_result: {
|
13556
|
-
# etag: "\"
|
13557
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13539
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
13540
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
13558
13541
|
# },
|
13559
13542
|
# }
|
13560
13543
|
#
|
13561
|
-
# @example Example: To upload a part by copying
|
13544
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
13562
13545
|
#
|
13563
|
-
# # The following example uploads a part of a multipart upload by copying
|
13564
|
-
# # data source.
|
13546
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
13565
13547
|
#
|
13566
13548
|
# resp = client.upload_part_copy({
|
13567
13549
|
# bucket: "examplebucket",
|
13568
13550
|
# copy_source: "/bucketname/sourceobjectkey",
|
13569
|
-
# copy_source_range: "bytes=1-100000",
|
13570
13551
|
# key: "examplelargeobject",
|
13571
|
-
# part_number:
|
13552
|
+
# part_number: 1,
|
13572
13553
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13573
13554
|
# })
|
13574
13555
|
#
|
13575
13556
|
# resp.to_h outputs the following:
|
13576
13557
|
# {
|
13577
13558
|
# copy_part_result: {
|
13578
|
-
# etag: "\"
|
13579
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13559
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
13560
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
13580
13561
|
# },
|
13581
13562
|
# }
|
13582
13563
|
#
|
@@ -13625,6 +13606,297 @@ module Aws::S3
|
|
13625
13606
|
req.send_request(options)
|
13626
13607
|
end
|
13627
13608
|
|
13609
|
+
# Passes transformed objects to a `GetObject` operation when using
|
13610
|
+
# Object Lambda Access Points. For information about Object Lambda
|
13611
|
+
# Access Points, see [Transforming objects with Object Lambda Access
|
13612
|
+
# Points][1] in the *Amazon S3 User Guide*.
|
13613
|
+
#
|
13614
|
+
# This operation supports metadata that can be returned by
|
13615
|
+
# [GetObject][2], in addition to `RequestRoute`, `RequestToken`,
|
13616
|
+
# `StatusCode`, `ErrorCode`, and `ErrorMessage`. The `GetObject`
|
13617
|
+
# response metadata is supported so that the `WriteGetObjectResponse`
|
13618
|
+
# caller, typically an AWS Lambda function, can provide the same
|
13619
|
+
# metadata when it internally invokes `GetObject`. When
|
13620
|
+
# `WriteGetObjectResponse` is called by a customer-owned Lambda
|
13621
|
+
# function, the metadata returned to the end user `GetObject` call might
|
13622
|
+
# differ from what Amazon S3 would normally return.
|
13623
|
+
#
|
13624
|
+
# AWS provides some prebuilt Lambda functions that you can use with S3
|
13625
|
+
# Object Lambda to detect and redact personally identifiable information
|
13626
|
+
# (PII) and decompress S3 objects. These Lambda functions are available
|
13627
|
+
# in the AWS Serverless Application Repository, and can be selected
|
13628
|
+
# through the AWS Management Console when you create your Object Lambda
|
13629
|
+
# Access Point.
|
13630
|
+
#
|
13631
|
+
# Example 1: PII Access Control - This Lambda function uses Amazon
|
13632
|
+
# Comprehend, a natural language processing (NLP) service using machine
|
13633
|
+
# learning to find insights and relationships in text. It automatically
|
13634
|
+
# detects personally identifiable information (PII) such as names,
|
13635
|
+
# addresses, dates, credit card numbers, and social security numbers
|
13636
|
+
# from documents in your Amazon S3 bucket.
|
13637
|
+
#
|
13638
|
+
# Example 2: PII Redaction - This Lambda function uses Amazon
|
13639
|
+
# Comprehend, a natural language processing (NLP) service using machine
|
13640
|
+
# learning to find insights and relationships in text. It automatically
|
13641
|
+
# redacts personally identifiable information (PII) such as names,
|
13642
|
+
# addresses, dates, credit card numbers, and social security numbers
|
13643
|
+
# from documents in your Amazon S3 bucket.
|
13644
|
+
#
|
13645
|
+
# Example 3: Decompression - The Lambda function
|
13646
|
+
# S3ObjectLambdaDecompression, is equipped to decompress objects stored
|
13647
|
+
# in S3 in one of six compressed file formats including bzip2, gzip,
|
13648
|
+
# snappy, zlib, zstandard and ZIP.
|
13649
|
+
#
|
13650
|
+
# For information on how to view and use these functions, see [Using AWS
|
13651
|
+
# built Lambda functions][3] in the *Amazon S3 User Guide*.
|
13652
|
+
#
|
13653
|
+
#
|
13654
|
+
#
|
13655
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html
|
13656
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
|
13657
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html
|
13658
|
+
#
|
13659
|
+
# @option params [required, String] :request_route
|
13660
|
+
# Route prefix to the HTTP URL generated.
|
13661
|
+
#
|
13662
|
+
# @option params [required, String] :request_token
|
13663
|
+
# A single use encrypted token that maps `WriteGetObjectResponse` to the
|
13664
|
+
# end user `GetObject` request.
|
13665
|
+
#
|
13666
|
+
# @option params [String, IO] :body
|
13667
|
+
# The object data.
|
13668
|
+
#
|
13669
|
+
# @option params [Integer] :status_code
|
13670
|
+
# The integer status code for an HTTP response of a corresponding
|
13671
|
+
# `GetObject` request.
|
13672
|
+
#
|
13673
|
+
# **Status Codes**
|
13674
|
+
#
|
13675
|
+
# * *200 - OK*
|
13676
|
+
#
|
13677
|
+
# * *206 - Partial Content*
|
13678
|
+
#
|
13679
|
+
# * *304 - Not Modified*
|
13680
|
+
#
|
13681
|
+
# * *400 - Bad Request*
|
13682
|
+
#
|
13683
|
+
# * *401 - Unauthorized*
|
13684
|
+
#
|
13685
|
+
# * *403 - Forbidden*
|
13686
|
+
#
|
13687
|
+
# * *404 - Not Found*
|
13688
|
+
#
|
13689
|
+
# * *405 - Method Not Allowed*
|
13690
|
+
#
|
13691
|
+
# * *409 - Conflict*
|
13692
|
+
#
|
13693
|
+
# * *411 - Length Required*
|
13694
|
+
#
|
13695
|
+
# * *412 - Precondition Failed*
|
13696
|
+
#
|
13697
|
+
# * *416 - Range Not Satisfiable*
|
13698
|
+
#
|
13699
|
+
# * *500 - Internal Server Error*
|
13700
|
+
#
|
13701
|
+
# * *503 - Service Unavailable*
|
13702
|
+
#
|
13703
|
+
# @option params [String] :error_code
|
13704
|
+
# A string that uniquely identifies an error condition. Returned in the
|
13705
|
+
# <Code> tag of the error XML response for a corresponding
|
13706
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13707
|
+
# or when the transformed object is provided in the body. All error
|
13708
|
+
# codes from S3 are sentence-cased. Regex value is
|
13709
|
+
# "^\[A-Z\]\[a-zA-Z\]+$".
|
13710
|
+
#
|
13711
|
+
# @option params [String] :error_message
|
13712
|
+
# Contains a generic description of the error condition. Returned in the
|
13713
|
+
# <Message> tag of the error XML response for a corresponding
|
13714
|
+
# `GetObject` call. Cannot be used with a successful `StatusCode` header
|
13715
|
+
# or when the transformed object is provided in body.
|
13716
|
+
#
|
13717
|
+
# @option params [String] :accept_ranges
|
13718
|
+
# Indicates that a range of bytes was specified.
|
13719
|
+
#
|
13720
|
+
# @option params [String] :cache_control
|
13721
|
+
# Specifies caching behavior along the request/reply chain.
|
13722
|
+
#
|
13723
|
+
# @option params [String] :content_disposition
|
13724
|
+
# Specifies presentational information for the object.
|
13725
|
+
#
|
13726
|
+
# @option params [String] :content_encoding
|
13727
|
+
# Specifies what content encodings have been applied to the object and
|
13728
|
+
# thus what decoding mechanisms must be applied to obtain the media-type
|
13729
|
+
# referenced by the Content-Type header field.
|
13730
|
+
#
|
13731
|
+
# @option params [String] :content_language
|
13732
|
+
# The language the content is in.
|
13733
|
+
#
|
13734
|
+
# @option params [Integer] :content_length
|
13735
|
+
# The size of the content body in bytes.
|
13736
|
+
#
|
13737
|
+
# @option params [String] :content_range
|
13738
|
+
# The portion of the object returned in the response.
|
13739
|
+
#
|
13740
|
+
# @option params [String] :content_type
|
13741
|
+
# A standard MIME type describing the format of the object data.
|
13742
|
+
#
|
13743
|
+
# @option params [Boolean] :delete_marker
|
13744
|
+
# Specifies whether an object stored in Amazon S3 is (`true`) or is not
|
13745
|
+
# (`false`) a delete marker.
|
13746
|
+
#
|
13747
|
+
# @option params [String] :etag
|
13748
|
+
# An opaque identifier assigned by a web server to a specific version of
|
13749
|
+
# a resource found at a URL.
|
13750
|
+
#
|
13751
|
+
# @option params [Time,DateTime,Date,Integer,String] :expires
|
13752
|
+
# The date and time at which the object is no longer cacheable.
|
13753
|
+
#
|
13754
|
+
# @option params [String] :expiration
|
13755
|
+
# If object stored in Amazon S3 expiration is configured (see PUT Bucket
|
13756
|
+
# lifecycle) it includes expiry-date and rule-id key-value pairs
|
13757
|
+
# providing object expiration information. The value of the rule-id is
|
13758
|
+
# URL encoded.
|
13759
|
+
#
|
13760
|
+
# @option params [Time,DateTime,Date,Integer,String] :last_modified
|
13761
|
+
# The date and time that the object was last modified.
|
13762
|
+
#
|
13763
|
+
# @option params [Integer] :missing_meta
|
13764
|
+
# Set to the number of metadata entries not returned in `x-amz-meta`
|
13765
|
+
# headers. This can happen if you create metadata using an API like SOAP
|
13766
|
+
# that supports more flexible metadata than the REST API. For example,
|
13767
|
+
# using SOAP, you can create metadata whose values are not legal HTTP
|
13768
|
+
# headers.
|
13769
|
+
#
|
13770
|
+
# @option params [Hash<String,String>] :metadata
|
13771
|
+
# A map of metadata to store with the object in S3.
|
13772
|
+
#
|
13773
|
+
# @option params [String] :object_lock_mode
|
13774
|
+
# Indicates whether an object stored in Amazon S3 has Object Lock
|
13775
|
+
# enabled. For more information about S3 Object Lock, see [Object
|
13776
|
+
# Lock][1].
|
13777
|
+
#
|
13778
|
+
#
|
13779
|
+
#
|
13780
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html
|
13781
|
+
#
|
13782
|
+
# @option params [String] :object_lock_legal_hold_status
|
13783
|
+
# Indicates whether an object stored in Amazon S3 has an active legal
|
13784
|
+
# hold.
|
13785
|
+
#
|
13786
|
+
# @option params [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
13787
|
+
# The date and time when Object Lock is configured to expire.
|
13788
|
+
#
|
13789
|
+
# @option params [Integer] :parts_count
|
13790
|
+
# The count of parts this object has.
|
13791
|
+
#
|
13792
|
+
# @option params [String] :replication_status
|
13793
|
+
# Indicates if request involves bucket that is either a source or
|
13794
|
+
# destination in a Replication rule. For more information about S3
|
13795
|
+
# Replication, see [Replication][1].
|
13796
|
+
#
|
13797
|
+
#
|
13798
|
+
#
|
13799
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html
|
13800
|
+
#
|
13801
|
+
# @option params [String] :request_charged
|
13802
|
+
# If present, indicates that the requester was successfully charged for
|
13803
|
+
# the request.
|
13804
|
+
#
|
13805
|
+
# @option params [String] :restore
|
13806
|
+
# Provides information about object restoration operation and expiration
|
13807
|
+
# time of the restored object copy.
|
13808
|
+
#
|
13809
|
+
# @option params [String] :server_side_encryption
|
13810
|
+
# The server-side encryption algorithm used when storing requested
|
13811
|
+
# object in Amazon S3 (for example, AES256, aws:kms).
|
13812
|
+
#
|
13813
|
+
# @option params [String] :sse_customer_algorithm
|
13814
|
+
# Encryption algorithm used if server-side encryption with a
|
13815
|
+
# customer-provided encryption key was specified for object stored in
|
13816
|
+
# Amazon S3.
|
13817
|
+
#
|
13818
|
+
# @option params [String] :ssekms_key_id
|
13819
|
+
# If present, specifies the ID of the AWS Key Management Service (AWS
|
13820
|
+
# KMS) symmetric customer managed customer master key (CMK) that was
|
13821
|
+
# used for stored in Amazon S3 object.
|
13822
|
+
#
|
13823
|
+
# @option params [String] :sse_customer_key_md5
|
13824
|
+
# 128-bit MD5 digest of customer-provided encryption key used in Amazon
|
13825
|
+
# S3 to encrypt data stored in S3. For more information, see [Protecting
|
13826
|
+
# data using server-side encryption with customer-provided encryption
|
13827
|
+
# keys (SSE-C)][1].
|
13828
|
+
#
|
13829
|
+
#
|
13830
|
+
#
|
13831
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html
|
13832
|
+
#
|
13833
|
+
# @option params [String] :storage_class
|
13834
|
+
# The class of storage used to store object in Amazon S3.
|
13835
|
+
#
|
13836
|
+
# @option params [Integer] :tag_count
|
13837
|
+
# The number of tags, if any, on the object.
|
13838
|
+
#
|
13839
|
+
# @option params [String] :version_id
|
13840
|
+
# An ID used to reference a specific version of the object.
|
13841
|
+
#
|
13842
|
+
# @option params [Boolean] :bucket_key_enabled
|
13843
|
+
# Indicates whether the object stored in Amazon S3 uses an S3 bucket key
|
13844
|
+
# for server-side encryption with AWS KMS (SSE-KMS).
|
13845
|
+
#
|
13846
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13847
|
+
#
|
13848
|
+
# @example Request syntax with placeholder values
|
13849
|
+
#
|
13850
|
+
# resp = client.write_get_object_response({
|
13851
|
+
# request_route: "RequestRoute", # required
|
13852
|
+
# request_token: "RequestToken", # required
|
13853
|
+
# body: source_file,
|
13854
|
+
# status_code: 1,
|
13855
|
+
# error_code: "ErrorCode",
|
13856
|
+
# error_message: "ErrorMessage",
|
13857
|
+
# accept_ranges: "AcceptRanges",
|
13858
|
+
# cache_control: "CacheControl",
|
13859
|
+
# content_disposition: "ContentDisposition",
|
13860
|
+
# content_encoding: "ContentEncoding",
|
13861
|
+
# content_language: "ContentLanguage",
|
13862
|
+
# content_length: 1,
|
13863
|
+
# content_range: "ContentRange",
|
13864
|
+
# content_type: "ContentType",
|
13865
|
+
# delete_marker: false,
|
13866
|
+
# etag: "ETag",
|
13867
|
+
# expires: Time.now,
|
13868
|
+
# expiration: "Expiration",
|
13869
|
+
# last_modified: Time.now,
|
13870
|
+
# missing_meta: 1,
|
13871
|
+
# metadata: {
|
13872
|
+
# "MetadataKey" => "MetadataValue",
|
13873
|
+
# },
|
13874
|
+
# object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
|
13875
|
+
# object_lock_legal_hold_status: "ON", # accepts ON, OFF
|
13876
|
+
# object_lock_retain_until_date: Time.now,
|
13877
|
+
# parts_count: 1,
|
13878
|
+
# replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA
|
13879
|
+
# request_charged: "requester", # accepts requester
|
13880
|
+
# restore: "Restore",
|
13881
|
+
# server_side_encryption: "AES256", # accepts AES256, aws:kms
|
13882
|
+
# sse_customer_algorithm: "SSECustomerAlgorithm",
|
13883
|
+
# ssekms_key_id: "SSEKMSKeyId",
|
13884
|
+
# sse_customer_key_md5: "SSECustomerKeyMD5",
|
13885
|
+
# storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
|
13886
|
+
# tag_count: 1,
|
13887
|
+
# version_id: "ObjectVersionId",
|
13888
|
+
# bucket_key_enabled: false,
|
13889
|
+
# })
|
13890
|
+
#
|
13891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse AWS API Documentation
|
13892
|
+
#
|
13893
|
+
# @overload write_get_object_response(params = {})
|
13894
|
+
# @param [Hash] params ({})
|
13895
|
+
def write_get_object_response(params = {}, options = {})
|
13896
|
+
req = build_request(:write_get_object_response, params)
|
13897
|
+
req.send_request(options)
|
13898
|
+
end
|
13899
|
+
|
13628
13900
|
# @!endgroup
|
13629
13901
|
|
13630
13902
|
# @param params ({})
|
@@ -13638,7 +13910,7 @@ module Aws::S3
|
|
13638
13910
|
params: params,
|
13639
13911
|
config: config)
|
13640
13912
|
context[:gem_name] = 'aws-sdk-s3'
|
13641
|
-
context[:gem_version] = '1.
|
13913
|
+
context[:gem_version] = '1.93.1'
|
13642
13914
|
Seahorse::Client::Request.new(handlers, context)
|
13643
13915
|
end
|
13644
13916
|
|