aws-sdk-s3 1.57.0 → 1.58.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/bucket.rb +39 -29
- data/lib/aws-sdk-s3/bucket_acl.rb +1 -0
- data/lib/aws-sdk-s3/bucket_cors.rb +3 -2
- data/lib/aws-sdk-s3/bucket_lifecycle.rb +1 -0
- data/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb +1 -0
- data/lib/aws-sdk-s3/bucket_logging.rb +1 -0
- data/lib/aws-sdk-s3/bucket_notification.rb +1 -0
- data/lib/aws-sdk-s3/bucket_policy.rb +1 -0
- data/lib/aws-sdk-s3/bucket_request_payment.rb +1 -0
- data/lib/aws-sdk-s3/bucket_tagging.rb +2 -1
- data/lib/aws-sdk-s3/bucket_versioning.rb +1 -0
- data/lib/aws-sdk-s3/bucket_website.rb +1 -0
- data/lib/aws-sdk-s3/client.rb +882 -581
- data/lib/aws-sdk-s3/customizations/bucket.rb +41 -14
- data/lib/aws-sdk-s3/multipart_upload.rb +22 -9
- data/lib/aws-sdk-s3/multipart_upload_part.rb +34 -25
- data/lib/aws-sdk-s3/object.rb +156 -115
- data/lib/aws-sdk-s3/object_acl.rb +9 -4
- data/lib/aws-sdk-s3/object_summary.rb +126 -86
- data/lib/aws-sdk-s3/object_version.rb +56 -39
- data/lib/aws-sdk-s3/plugins/bucket_arn.rb +212 -0
- data/lib/aws-sdk-s3/plugins/bucket_dns.rb +7 -7
- data/lib/aws-sdk-s3/plugins/bucket_name_restrictions.rb +23 -3
- data/lib/aws-sdk-s3/types.rb +792 -410
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d2f943e8db73ca607d75f48575b45f13660590cd
|
4
|
+
data.tar.gz: adf442e23d77ae9238960934527fa83129e01123
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7ff2036eac9219d96381fd12e9b208c444ee00d848a0f6206c41af45fd6b68221ecc60a9e71f707190c9d9f515deb9d07674849a9bfd545cebc52b75b4a5b669
|
7
|
+
data.tar.gz: 0d47510d1e30c70784268ddd1b98d23efdc6316b1334a479e112b8fec645af2da89aeba7afdd947ba7596ea157b881e7ffda9178df91fe74d49ad62eb0d2b868
|
data/lib/aws-sdk-s3.rb
CHANGED
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -21,6 +21,7 @@ module Aws::S3
|
|
21
21
|
@name = extract_name(args, options)
|
22
22
|
@data = options.delete(:data)
|
23
23
|
@client = options.delete(:client) || Client.new(options)
|
24
|
+
@waiter_block_warned = false
|
24
25
|
end
|
25
26
|
|
26
27
|
# @!group Read-Only Attributes
|
@@ -286,13 +287,17 @@ module Aws::S3
|
|
286
287
|
# The concatenation of the authentication device's serial number, a
|
287
288
|
# space, and the value that is displayed on your authentication device.
|
288
289
|
# Required to permanently delete a versioned object if versioning is
|
289
|
-
# configured with MFA
|
290
|
+
# configured with MFA delete enabled.
|
290
291
|
# @option options [String] :request_payer
|
291
292
|
# Confirms that the requester knows that she or he will be charged for
|
292
293
|
# the request. Bucket owners need not specify this parameter in their
|
293
|
-
# requests.
|
294
|
-
# buckets
|
295
|
-
#
|
294
|
+
# requests. For information about downloading objects from Requester
|
295
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
296
|
+
# in the *Amazon S3 Developer Guide*.
|
297
|
+
#
|
298
|
+
#
|
299
|
+
#
|
300
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
296
301
|
# @option options [Boolean] :bypass_governance_retention
|
297
302
|
# Specifies whether you want to delete this object even if it has a
|
298
303
|
# Governance-type Object Lock in place. You must have sufficient
|
@@ -426,8 +431,8 @@ module Aws::S3
|
|
426
431
|
# @option options [Hash<String,String>] :metadata
|
427
432
|
# A map of metadata to store with the object in S3.
|
428
433
|
# @option options [String] :server_side_encryption
|
429
|
-
# The
|
430
|
-
# S3 (
|
434
|
+
# The server-side encryption algorithm used when storing this object in
|
435
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
431
436
|
# @option options [String] :storage_class
|
432
437
|
# If you don't specify, Standard is the default storage class. Amazon
|
433
438
|
# S3 supports other storage classes.
|
@@ -435,7 +440,7 @@ module Aws::S3
|
|
435
440
|
# If the bucket is configured as a website, redirects requests for this
|
436
441
|
# object to another object in the same bucket or to an external URL.
|
437
442
|
# Amazon S3 stores the value of this header in the object metadata. For
|
438
|
-
# information about object metadata, see .
|
443
|
+
# information about object metadata, see [Object Key and Metadata][1].
|
439
444
|
#
|
440
445
|
# In the following example, the request header sets the redirect to an
|
441
446
|
# object (anotherPage.html) in the same bucket:
|
@@ -448,37 +453,38 @@ module Aws::S3
|
|
448
453
|
# `x-amz-website-redirect-location: http://www.example.com/`
|
449
454
|
#
|
450
455
|
# For more information about website hosting in Amazon S3, see [Hosting
|
451
|
-
# Websites on Amazon S3][
|
452
|
-
# Redirects][
|
456
|
+
# Websites on Amazon S3][2] and [How to Configure Website Page
|
457
|
+
# Redirects][3].
|
453
458
|
#
|
454
459
|
#
|
455
460
|
#
|
456
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
457
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
461
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
|
462
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
463
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
458
464
|
# @option options [String] :sse_customer_algorithm
|
459
|
-
# Specifies the algorithm to use to when encrypting the object (
|
460
|
-
# AES256).
|
465
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
466
|
+
# example, AES256).
|
461
467
|
# @option options [String] :sse_customer_key
|
462
468
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
463
469
|
# encrypting data. This value is used to store the object and then it is
|
464
|
-
# discarded; Amazon does not store the encryption key. The key must
|
465
|
-
# appropriate for use with the algorithm specified in the
|
466
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
470
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
471
|
+
# be appropriate for use with the algorithm specified in the
|
472
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
467
473
|
# @option options [String] :sse_customer_key_md5
|
468
474
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
469
475
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
470
|
-
# ensure the encryption key was transmitted without error.
|
476
|
+
# ensure that the encryption key was transmitted without error.
|
471
477
|
# @option options [String] :ssekms_key_id
|
472
|
-
# If
|
473
|
-
# aws:kms
|
478
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
479
|
+
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
474
480
|
# Service (AWS KMS) customer master key (CMK) that was used for the
|
475
481
|
# object.
|
476
482
|
#
|
477
|
-
# If the value of x-amz-server-side-encryption is aws:kms
|
478
|
-
# specifies the ID of the AWS KMS CMK that will be used for the
|
479
|
-
# If you specify x-amz-server-side-encryption:aws:kms
|
480
|
-
# provide x-amz-server-side-encryption-aws-kms-key-id
|
481
|
-
# the AWS managed CMK in AWS to protect the data.
|
483
|
+
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
484
|
+
# header specifies the ID of the AWS KMS CMK that will be used for the
|
485
|
+
# object. If you specify `x-amz-server-side-encryption:aws:kms`, but do
|
486
|
+
# not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
487
|
+
# uses the AWS managed CMK in AWS to protect the data.
|
482
488
|
# @option options [String] :ssekms_encryption_context
|
483
489
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
484
490
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -486,9 +492,13 @@ module Aws::S3
|
|
486
492
|
# @option options [String] :request_payer
|
487
493
|
# Confirms that the requester knows that she or he will be charged for
|
488
494
|
# the request. Bucket owners need not specify this parameter in their
|
489
|
-
# requests.
|
490
|
-
# buckets
|
491
|
-
#
|
495
|
+
# requests. For information about downloading objects from Requester
|
496
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
497
|
+
# in the *Amazon S3 Developer Guide*.
|
498
|
+
#
|
499
|
+
#
|
500
|
+
#
|
501
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
492
502
|
# @option options [String] :tagging
|
493
503
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
494
504
|
# parameters. (For example, "Key1=Value1")
|
@@ -605,7 +615,7 @@ module Aws::S3
|
|
605
615
|
# upload-id-marker parameter is ignored. Otherwise, any multipart
|
606
616
|
# uploads for a key equal to the key-marker might be included in the
|
607
617
|
# list only if they have an upload ID lexicographically greater than the
|
608
|
-
# specified upload-id-marker
|
618
|
+
# specified `upload-id-marker`.
|
609
619
|
# @return [MultipartUpload::Collection]
|
610
620
|
def multipart_uploads(options = {})
|
611
621
|
batches = Enumerator.new do |y|
|
@@ -723,7 +733,7 @@ module Aws::S3
|
|
723
733
|
# @option options [Boolean] :fetch_owner
|
724
734
|
# The owner field is not present in listV2 by default, if you want to
|
725
735
|
# return owner field with each key in the result then set the fetch
|
726
|
-
# owner field to true
|
736
|
+
# owner field to true.
|
727
737
|
# @option options [String] :start_after
|
728
738
|
# StartAfter is where you want Amazon S3 to start listing from. Amazon
|
729
739
|
# S3 starts listing after this specified key. StartAfter can be any key
|
@@ -21,6 +21,7 @@ module Aws::S3
|
|
21
21
|
@bucket_name = extract_bucket_name(args, options)
|
22
22
|
@data = options.delete(:data)
|
23
23
|
@client = options.delete(:client) || Client.new(options)
|
24
|
+
@waiter_block_warned = false
|
24
25
|
end
|
25
26
|
|
26
27
|
# @!group Read-Only Attributes
|
@@ -200,8 +201,8 @@ module Aws::S3
|
|
200
201
|
# @option options [required, Types::CORSConfiguration] :cors_configuration
|
201
202
|
# Describes the cross-origin access configuration for objects in an
|
202
203
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
203
|
-
# Resource Sharing][1] in the Amazon Simple Storage Service Developer
|
204
|
-
# Guide
|
204
|
+
# Resource Sharing][1] in the *Amazon Simple Storage Service Developer
|
205
|
+
# Guide*.
|
205
206
|
#
|
206
207
|
#
|
207
208
|
#
|
@@ -21,6 +21,7 @@ module Aws::S3
|
|
21
21
|
@bucket_name = extract_bucket_name(args, options)
|
22
22
|
@data = options.delete(:data)
|
23
23
|
@client = options.delete(:client) || Client.new(options)
|
24
|
+
@waiter_block_warned = false
|
24
25
|
end
|
25
26
|
|
26
27
|
# @!group Read-Only Attributes
|
@@ -202,7 +203,7 @@ module Aws::S3
|
|
202
203
|
#
|
203
204
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
204
205
|
# @option options [required, Types::Tagging] :tagging
|
205
|
-
# Container for the TagSet and Tag elements.
|
206
|
+
# Container for the `TagSet` and `Tag` elements.
|
206
207
|
# @return [EmptyStructure]
|
207
208
|
def put(options = {})
|
208
209
|
options = options.merge(bucket: @bucket_name)
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -28,6 +28,7 @@ require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
|
|
28
28
|
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
29
29
|
require 'aws-sdk-s3/plugins/accelerate.rb'
|
30
30
|
require 'aws-sdk-s3/plugins/dualstack.rb'
|
31
|
+
require 'aws-sdk-s3/plugins/bucket_arn.rb'
|
31
32
|
require 'aws-sdk-s3/plugins/bucket_dns.rb'
|
32
33
|
require 'aws-sdk-s3/plugins/expect_100_continue.rb'
|
33
34
|
require 'aws-sdk-s3/plugins/http_200_errors.rb'
|
@@ -76,6 +77,7 @@ module Aws::S3
|
|
76
77
|
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
77
78
|
add_plugin(Aws::S3::Plugins::Accelerate)
|
78
79
|
add_plugin(Aws::S3::Plugins::Dualstack)
|
80
|
+
add_plugin(Aws::S3::Plugins::BucketARN)
|
79
81
|
add_plugin(Aws::S3::Plugins::BucketDns)
|
80
82
|
add_plugin(Aws::S3::Plugins::Expect100Continue)
|
81
83
|
add_plugin(Aws::S3::Plugins::Http200Errors)
|
@@ -250,6 +252,11 @@ module Aws::S3
|
|
250
252
|
# Passing in `regional` to enable regional endpoint for S3's `us-east-1`
|
251
253
|
# region. Defaults to `legacy` mode using global endpoint.
|
252
254
|
#
|
255
|
+
# @option options [Boolean] :s3_use_arn_region (true)
|
256
|
+
# By default, the SDK will use the S3 ARN region, and cross-region
|
257
|
+
# requests could be made. Set to `false` to not use the region from
|
258
|
+
# the S3 ARN.
|
259
|
+
#
|
253
260
|
# @option options [String] :secret_access_key
|
254
261
|
#
|
255
262
|
# @option options [String] :session_token
|
@@ -335,12 +342,12 @@ module Aws::S3
|
|
335
342
|
#
|
336
343
|
# To verify that all parts have been removed, so you don't get charged
|
337
344
|
# for the part storage, you should call the ListParts operation and
|
338
|
-
# ensure the parts list is empty.
|
345
|
+
# ensure that the parts list is empty.
|
339
346
|
#
|
340
|
-
# For information
|
347
|
+
# For information about permissions required to use the multipart upload
|
341
348
|
# API, see [Multipart Upload API and Permissions][1].
|
342
349
|
#
|
343
|
-
# The following operations are related to `AbortMultipartUpload
|
350
|
+
# The following operations are related to `AbortMultipartUpload`\:
|
344
351
|
#
|
345
352
|
# * CreateMultipartUpload
|
346
353
|
#
|
@@ -357,7 +364,19 @@ module Aws::S3
|
|
357
364
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
358
365
|
#
|
359
366
|
# @option params [required, String] :bucket
|
360
|
-
# The bucket to which the upload was taking place.
|
367
|
+
# The bucket name to which the upload was taking place.
|
368
|
+
#
|
369
|
+
# When using this API with an access point, you must direct requests to
|
370
|
+
# the access point hostname. The access point hostname takes the form
|
371
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
372
|
+
# When using this operation using an access point through the AWS SDKs,
|
373
|
+
# you provide the access point ARN in place of the bucket name. For more
|
374
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
375
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
376
|
+
#
|
377
|
+
#
|
378
|
+
#
|
379
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
361
380
|
#
|
362
381
|
# @option params [required, String] :key
|
363
382
|
# Key of the object for which the multipart upload was initiated.
|
@@ -368,9 +387,13 @@ module Aws::S3
|
|
368
387
|
# @option params [String] :request_payer
|
369
388
|
# Confirms that the requester knows that she or he will be charged for
|
370
389
|
# the request. Bucket owners need not specify this parameter in their
|
371
|
-
# requests.
|
372
|
-
# buckets
|
373
|
-
#
|
390
|
+
# requests. For information about downloading objects from Requester
|
391
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
392
|
+
# in the *Amazon S3 Developer Guide*.
|
393
|
+
#
|
394
|
+
#
|
395
|
+
#
|
396
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
374
397
|
#
|
375
398
|
# @return [Types::AbortMultipartUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
376
399
|
#
|
@@ -421,15 +444,15 @@ module Aws::S3
|
|
421
444
|
# upload. Upon receiving this request, Amazon S3 concatenates all the
|
422
445
|
# parts in ascending order by part number to create a new object. In the
|
423
446
|
# Complete Multipart Upload request, you must provide the parts list.
|
424
|
-
# You must ensure the parts list is complete
|
425
|
-
# concatenates the parts you provide in the list. For each part in
|
426
|
-
# list, you must provide the part number and the `ETag` value,
|
427
|
-
# after that part was uploaded.
|
447
|
+
# You must ensure that the parts list is complete. This operation
|
448
|
+
# concatenates the parts that you provide in the list. For each part in
|
449
|
+
# the list, you must provide the part number and the `ETag` value,
|
450
|
+
# returned after that part was uploaded.
|
428
451
|
#
|
429
452
|
# Processing of a Complete Multipart Upload request could take several
|
430
453
|
# minutes to complete. After Amazon S3 begins processing the request, it
|
431
454
|
# sends an HTTP response header that specifies a 200 OK response. While
|
432
|
-
# processing is in progress, Amazon S3 periodically sends
|
455
|
+
# processing is in progress, Amazon S3 periodically sends white space
|
433
456
|
# characters to keep the connection from timing out. Because a request
|
434
457
|
# could fail after the initial 200 OK response has been sent, it is
|
435
458
|
# important that you check the response body to determine whether the
|
@@ -439,10 +462,10 @@ module Aws::S3
|
|
439
462
|
# prepared to retry the failed requests. For more information, see
|
440
463
|
# [Amazon S3 Error Best Practices][1].
|
441
464
|
#
|
442
|
-
# For more information
|
465
|
+
# For more information about multipart uploads, see [Uploading Objects
|
443
466
|
# Using Multipart Upload][2].
|
444
467
|
#
|
445
|
-
# For information
|
468
|
+
# For information about permissions required to use the multipart upload
|
446
469
|
# API, see [Multipart Upload API and Permissions][3].
|
447
470
|
#
|
448
471
|
# `GetBucketLifecycle` has the following special errors:
|
@@ -512,9 +535,13 @@ module Aws::S3
|
|
512
535
|
# @option params [String] :request_payer
|
513
536
|
# Confirms that the requester knows that she or he will be charged for
|
514
537
|
# the request. Bucket owners need not specify this parameter in their
|
515
|
-
# requests.
|
516
|
-
# buckets
|
517
|
-
#
|
538
|
+
# requests. For information about downloading objects from Requester
|
539
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
540
|
+
# in the *Amazon S3 Developer Guide*.
|
541
|
+
#
|
542
|
+
#
|
543
|
+
#
|
544
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
518
545
|
#
|
519
546
|
# @return [Types::CompleteMultipartUploadOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
520
547
|
#
|
@@ -603,8 +630,8 @@ module Aws::S3
|
|
603
630
|
# create a copy of your object up to 5 GB in size in a single atomic
|
604
631
|
# operation using this API. However, for copying an object greater than
|
605
632
|
# 5 GB, you must use the multipart upload Upload Part - Copy API. For
|
606
|
-
#
|
607
|
-
#
|
633
|
+
# more information, see [Copy Object Using the REST Multipart Upload
|
634
|
+
# API][1].
|
608
635
|
#
|
609
636
|
# </note>
|
610
637
|
#
|
@@ -614,8 +641,8 @@ module Aws::S3
|
|
614
641
|
# setting, specify a new ACL when generating a copy request. For more
|
615
642
|
# information, see [Using ACLs][2].
|
616
643
|
#
|
617
|
-
# Amazon S3
|
618
|
-
# If you request a cross-region copy using a
|
644
|
+
# Amazon S3 transfer acceleration does not support cross-region copies.
|
645
|
+
# If you request a cross-region copy using a transfer acceleration
|
619
646
|
# endpoint, you get a 400 `Bad Request` error. For more information
|
620
647
|
# about transfer acceleration, see [Transfer Acceleration][3].
|
621
648
|
#
|
@@ -627,27 +654,27 @@ module Aws::S3
|
|
627
654
|
# enabled for your account.
|
628
655
|
#
|
629
656
|
# To only copy an object under certain conditions, such as whether the
|
630
|
-
# Etag matches or whether the object was modified before or after a
|
657
|
+
# `Etag` matches or whether the object was modified before or after a
|
631
658
|
# specified date, use the request parameters
|
632
659
|
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`,
|
633
660
|
# `x-amz-copy-source-if-unmodified-since`, or `
|
634
661
|
# x-amz-copy-source-if-modified-since`.
|
635
662
|
#
|
636
|
-
# <note markdown="1"> All headers with the x-amz
|
637
|
-
# be signed.
|
663
|
+
# <note markdown="1"> All headers with the `x-amz-` prefix, including `x-amz-copy-source`,
|
664
|
+
# must be signed.
|
638
665
|
#
|
639
666
|
# </note>
|
640
667
|
#
|
641
668
|
# You can use this operation to change the storage class of an object
|
642
|
-
# that is already stored in Amazon S3 using the StorageClass
|
643
|
-
# For more information, see [Storage Classes][5].
|
669
|
+
# that is already stored in Amazon S3 using the `StorageClass`
|
670
|
+
# parameter. For more information, see [Storage Classes][5].
|
644
671
|
#
|
645
672
|
# The source object that you are copying can be encrypted or
|
646
673
|
# unencrypted. If the source object is encrypted, it can be encrypted by
|
647
|
-
# server-side encryption using AWS
|
674
|
+
# server-side encryption using AWS managed encryption keys or by using a
|
648
675
|
# customer-provided encryption key. When copying an object, you can
|
649
676
|
# request that Amazon S3 encrypt the target object by using either the
|
650
|
-
# AWS
|
677
|
+
# AWS managed encryption keys or by using your own encryption key. You
|
651
678
|
# can do this regardless of the form of server-side encryption that was
|
652
679
|
# used to encrypt the source, or even if the source object was not
|
653
680
|
# encrypted. For more information about server-side encryption, see
|
@@ -657,7 +684,7 @@ module Aws::S3
|
|
657
684
|
# request or while Amazon S3 is copying the files. If the error occurs
|
658
685
|
# before the copy operation starts, you receive a standard Amazon S3
|
659
686
|
# error. If the error occurs during the copy operation, the error
|
660
|
-
# response is embedded in the 200 OK response. This means that a `200
|
687
|
+
# response is embedded in the `200 OK` response. This means that a `200
|
661
688
|
# OK` response can contain either a success or an error. Design your
|
662
689
|
# application to parse the contents of the response and handle it
|
663
690
|
# appropriately.
|
@@ -673,23 +700,24 @@ module Aws::S3
|
|
673
700
|
#
|
674
701
|
# Consider the following when using request headers:
|
675
702
|
#
|
676
|
-
# * Consideration 1 – If both the x-amz-copy-source-if-match and
|
677
|
-
# x-amz-copy-source-if-unmodified-since headers are present in the
|
703
|
+
# * Consideration 1 – If both the `x-amz-copy-source-if-match` and
|
704
|
+
# `x-amz-copy-source-if-unmodified-since` headers are present in the
|
678
705
|
# request and evaluate as follows, Amazon S3 returns 200 OK and copies
|
679
706
|
# the data:
|
680
707
|
#
|
681
|
-
# * x-amz-copy-source-if-match condition evaluates to true
|
708
|
+
# * `x-amz-copy-source-if-match` condition evaluates to true
|
682
709
|
#
|
683
|
-
# * x-amz-copy-source-if-unmodified-since condition evaluates to
|
710
|
+
# * `x-amz-copy-source-if-unmodified-since` condition evaluates to
|
711
|
+
# false
|
684
712
|
#
|
685
|
-
# * Consideration 2 – If both of the x-amz-copy-source-if-none-match
|
686
|
-
# x-amz-copy-source-if-modified-since headers are present in the
|
687
|
-
# request and evaluate as follows, Amazon S3 returns the 412
|
688
|
-
# Precondition Failed response code:
|
713
|
+
# * Consideration 2 – If both of the `x-amz-copy-source-if-none-match`
|
714
|
+
# and `x-amz-copy-source-if-modified-since` headers are present in the
|
715
|
+
# request and evaluate as follows, Amazon S3 returns the `412
|
716
|
+
# Precondition Failed` response code:
|
689
717
|
#
|
690
|
-
# * x-amz-copy-source-if-none-match condition evaluates to false
|
718
|
+
# * `x-amz-copy-source-if-none-match` condition evaluates to false
|
691
719
|
#
|
692
|
-
# * x-amz-copy-source-if-modified-since condition evaluates to true
|
720
|
+
# * `x-amz-copy-source-if-modified-since` condition evaluates to true
|
693
721
|
#
|
694
722
|
# The copy request charge is based on the storage class and Region you
|
695
723
|
# specify for the destination object. For pricing information, see
|
@@ -707,15 +735,15 @@ module Aws::S3
|
|
707
735
|
# If you enable versioning on the target bucket, Amazon S3 generates a
|
708
736
|
# unique version ID for the object being copied. This version ID is
|
709
737
|
# different from the version ID of the source object. Amazon S3
|
710
|
-
# returns the version ID of the copied object in the
|
711
|
-
# response header in the response.
|
738
|
+
# returns the version ID of the copied object in the
|
739
|
+
# `x-amz-version-id` response header in the response.
|
712
740
|
#
|
713
741
|
# If you do not enable versioning or suspend it on the target bucket,
|
714
742
|
# the version ID that Amazon S3 generates is always null.
|
715
743
|
#
|
716
|
-
# If the source object's storage class is GLACIER,
|
717
|
-
#
|
718
|
-
#
|
744
|
+
# If the source object's storage class is GLACIER, you must restore a
|
745
|
+
# copy of this object before you can use it as a source object for the
|
746
|
+
# copy operation. For more information, see .
|
719
747
|
#
|
720
748
|
# Access Permissions
|
721
749
|
#
|
@@ -740,31 +768,31 @@ module Aws::S3
|
|
740
768
|
#
|
741
769
|
# : To encrypt the target object, you must provide the appropriate
|
742
770
|
# encryption-related request headers. The one you use depends on
|
743
|
-
# whether you want to use AWS
|
771
|
+
# whether you want to use AWS managed encryption keys or provide your
|
744
772
|
# own encryption key.
|
745
773
|
#
|
746
774
|
# * To encrypt the target object using server-side encryption with an
|
747
|
-
# AWS
|
775
|
+
# AWS managed encryption key, provide the following request headers,
|
748
776
|
# as appropriate.
|
749
777
|
#
|
750
|
-
# * x-amz-server-side-encryption
|
778
|
+
# * `x-amz-server-side-encryption`
|
751
779
|
#
|
752
|
-
# * x-amz-server-side-encryption-aws-kms-key-id
|
780
|
+
# * `x-amz-server-side-encryption-aws-kms-key-id`
|
753
781
|
#
|
754
|
-
# * x-amz-server-side-encryption-context
|
782
|
+
# * `x-amz-server-side-encryption-context`
|
755
783
|
#
|
756
|
-
# <note markdown="1"> If you specify x-amz-server-side-encryption:aws:kms
|
757
|
-
# provide x-amz-server-side- encryption-aws-kms-key-id
|
758
|
-
# uses the AWS managed customer master key (CMK) in KMS to
|
759
|
-
# the data.
|
784
|
+
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms` but don't
|
785
|
+
# provide `x-amz-server-side- encryption-aws-kms-key-id`, Amazon S3
|
786
|
+
# uses the AWS managed customer master key (CMK) in AWS KMS to
|
787
|
+
# protect the data.
|
760
788
|
#
|
761
789
|
# </note>
|
762
790
|
#
|
763
791
|
# All GET and PUT requests for an object protected by AWS KMS fail
|
764
792
|
# if you don't make them with SSL or by using SigV4.
|
765
793
|
#
|
766
|
-
# For more information
|
767
|
-
#
|
794
|
+
# For more information about server-side encryption with CMKs stored
|
795
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
768
796
|
# Encryption with CMKs stored in KMS][10].
|
769
797
|
#
|
770
798
|
# * To encrypt the target object using server-side encryption with an
|
@@ -786,8 +814,8 @@ module Aws::S3
|
|
786
814
|
#
|
787
815
|
# * x-amz-copy-source-server-side-encryption-customer-key-MD5
|
788
816
|
#
|
789
|
-
# For more information
|
790
|
-
#
|
817
|
+
# For more information about server-side encryption with CMKs stored
|
818
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
791
819
|
# Encryption with CMKs stored in Amazon KMS][10].
|
792
820
|
#
|
793
821
|
# Access-Control-List (ACL)-Specific Request Headers
|
@@ -796,13 +824,13 @@ module Aws::S3
|
|
796
824
|
# this operation. By default, all objects are private. Only the owner
|
797
825
|
# has full access control. When adding a new object, you can grant
|
798
826
|
# permissions to individual AWS accounts or to predefined groups
|
799
|
-
# defined by Amazon S3. These permissions are then added to the
|
800
|
-
#
|
827
|
+
# defined by Amazon S3. These permissions are then added to the access
|
828
|
+
# control list (ACL) on the object. For more information, see [Using
|
801
829
|
# ACLs][2]. With this operation, you can grant access permissions
|
802
830
|
# using one of the following two methods:
|
803
831
|
#
|
804
|
-
# * Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of
|
805
|
-
# predefined ACLs, known as canned ACLs
|
832
|
+
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
833
|
+
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
806
834
|
# predefined set of grantees and permissions. For more information,
|
807
835
|
# see [Canned ACL][8].
|
808
836
|
#
|
@@ -811,7 +839,7 @@ module Aws::S3
|
|
811
839
|
# headers. Each header maps to specific permissions that Amazon S3
|
812
840
|
# supports in an ACL. For more information, see [Access Control List
|
813
841
|
# (ACL) Overview][9]. In the header, you specify a list of grantees
|
814
|
-
# who get the specific permission. To grant permissions explicitly
|
842
|
+
# who get the specific permission. To grant permissions explicitly,
|
815
843
|
# use:
|
816
844
|
#
|
817
845
|
# * x-amz-grant-read
|
@@ -827,22 +855,22 @@ module Aws::S3
|
|
827
855
|
# You specify each grantee as a type=value pair, where the type is
|
828
856
|
# one of the following:
|
829
857
|
#
|
830
|
-
# * emailAddress – if the value specified is the email address of
|
831
|
-
# AWS account
|
858
|
+
# * `emailAddress` – if the value specified is the email address of
|
859
|
+
# an AWS account
|
832
860
|
#
|
833
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
861
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
834
862
|
# account
|
835
863
|
#
|
836
|
-
# * uri – if you are granting permissions to a predefined group
|
864
|
+
# * `uri` – if you are granting permissions to a predefined group
|
837
865
|
#
|
838
|
-
# For example, the following x-amz-grant-read header grants the
|
839
|
-
# accounts identified by email addresses permissions to read
|
840
|
-
# data and its metadata:
|
866
|
+
# For example, the following `x-amz-grant-read` header grants the
|
867
|
+
# AWS accounts identified by email addresses permissions to read
|
868
|
+
# object data and its metadata:
|
841
869
|
#
|
842
870
|
# `x-amz-grant-read: emailAddress="xyz@amazon.com",
|
843
871
|
# emailAddress="abc@amazon.com" `
|
844
872
|
#
|
845
|
-
# The following
|
873
|
+
# The following operations are related to `CopyObject`\:
|
846
874
|
#
|
847
875
|
# * PutObject
|
848
876
|
#
|
@@ -936,8 +964,8 @@ module Aws::S3
|
|
936
964
|
# or replaced with tag-set provided in the request.
|
937
965
|
#
|
938
966
|
# @option params [String] :server_side_encryption
|
939
|
-
# The
|
940
|
-
# S3 (
|
967
|
+
# The server-side encryption algorithm used when storing this object in
|
968
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
941
969
|
#
|
942
970
|
# @option params [String] :storage_class
|
943
971
|
# The type of storage to use for the object. Defaults to 'STANDARD'.
|
@@ -948,27 +976,32 @@ module Aws::S3
|
|
948
976
|
# Amazon S3 stores the value of this header in the object metadata.
|
949
977
|
#
|
950
978
|
# @option params [String] :sse_customer_algorithm
|
951
|
-
# Specifies the algorithm to use to when encrypting the object (
|
952
|
-
# AES256).
|
979
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
980
|
+
# example, AES256).
|
953
981
|
#
|
954
982
|
# @option params [String] :sse_customer_key
|
955
983
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
956
984
|
# encrypting data. This value is used to store the object and then it is
|
957
|
-
# discarded; Amazon does not store the encryption key. The key must
|
958
|
-
# appropriate for use with the algorithm specified in the
|
959
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
985
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
986
|
+
# be appropriate for use with the algorithm specified in the
|
987
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
960
988
|
#
|
961
989
|
# @option params [String] :sse_customer_key_md5
|
962
990
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
963
991
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
964
|
-
# ensure the encryption key was transmitted without error.
|
992
|
+
# ensure that the encryption key was transmitted without error.
|
965
993
|
#
|
966
994
|
# @option params [String] :ssekms_key_id
|
967
995
|
# Specifies the AWS KMS key ID to use for object encryption. All GET and
|
968
996
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
969
|
-
# via SSL or using SigV4.
|
970
|
-
# officially supported AWS SDKs and CLI
|
971
|
-
#
|
997
|
+
# via SSL or using SigV4. For information about configuring using any of
|
998
|
+
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
999
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1000
|
+
# Developer Guide*.
|
1001
|
+
#
|
1002
|
+
#
|
1003
|
+
#
|
1004
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
972
1005
|
#
|
973
1006
|
# @option params [String] :ssekms_encryption_context
|
974
1007
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -976,8 +1009,8 @@ module Aws::S3
|
|
976
1009
|
# with the encryption context key-value pairs.
|
977
1010
|
#
|
978
1011
|
# @option params [String] :copy_source_sse_customer_algorithm
|
979
|
-
# Specifies the algorithm to use when decrypting the source object
|
980
|
-
#
|
1012
|
+
# Specifies the algorithm to use when decrypting the source object (for
|
1013
|
+
# example, AES256).
|
981
1014
|
#
|
982
1015
|
# @option params [String] :copy_source_sse_customer_key
|
983
1016
|
# Specifies the customer-provided encryption key for Amazon S3 to use to
|
@@ -987,19 +1020,23 @@ module Aws::S3
|
|
987
1020
|
# @option params [String] :copy_source_sse_customer_key_md5
|
988
1021
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
989
1022
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
990
|
-
# ensure the encryption key was transmitted without error.
|
1023
|
+
# ensure that the encryption key was transmitted without error.
|
991
1024
|
#
|
992
1025
|
# @option params [String] :request_payer
|
993
1026
|
# Confirms that the requester knows that she or he will be charged for
|
994
1027
|
# the request. Bucket owners need not specify this parameter in their
|
995
|
-
# requests.
|
996
|
-
# buckets
|
997
|
-
#
|
1028
|
+
# requests. For information about downloading objects from Requester
|
1029
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1030
|
+
# in the *Amazon S3 Developer Guide*.
|
1031
|
+
#
|
1032
|
+
#
|
1033
|
+
#
|
1034
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
998
1035
|
#
|
999
1036
|
# @option params [String] :tagging
|
1000
1037
|
# The tag-set for the object destination object this value must be used
|
1001
|
-
# in conjunction with the TaggingDirective
|
1002
|
-
# as URL Query parameters
|
1038
|
+
# in conjunction with the `TaggingDirective`. The tag-set must be
|
1039
|
+
# encoded as URL Query parameters.
|
1003
1040
|
#
|
1004
1041
|
# @option params [String] :object_lock_mode
|
1005
1042
|
# The Object Lock mode that you want to apply to the copied object.
|
@@ -1118,22 +1155,22 @@ module Aws::S3
|
|
1118
1155
|
# Not every string is an acceptable bucket name. For information on
|
1119
1156
|
# bucket naming restrictions, see [Working with Amazon S3 Buckets][1].
|
1120
1157
|
#
|
1121
|
-
# By default, the bucket is created in the US East (N. Virginia)
|
1122
|
-
# You can optionally specify a
|
1123
|
-
# choose a
|
1158
|
+
# By default, the bucket is created in the US East (N. Virginia) Region.
|
1159
|
+
# You can optionally specify a Region in the request body. You might
|
1160
|
+
# choose a Region to optimize latency, minimize costs, or address
|
1124
1161
|
# regulatory requirements. For example, if you reside in Europe, you
|
1125
1162
|
# will probably find it advantageous to create buckets in the EU
|
1126
|
-
# (Ireland)
|
1163
|
+
# (Ireland) Region. For more information, see [How to Select a Region
|
1127
1164
|
# for Your Buckets][2].
|
1128
1165
|
#
|
1129
|
-
# <note markdown="1"> If you send your create bucket request to the s3.amazonaws.com
|
1130
|
-
# endpoint, the request
|
1166
|
+
# <note markdown="1"> If you send your create bucket request to the `s3.amazonaws.com`
|
1167
|
+
# endpoint, the request goes to the us-east-1 Region. Accordingly, the
|
1131
1168
|
# signature calculations in Signature Version 4 must use us-east-1 as
|
1132
|
-
#
|
1133
|
-
# another
|
1134
|
-
# bucket in a
|
1135
|
-
#
|
1136
|
-
#
|
1169
|
+
# the Region, even if the location constraint in the request specifies
|
1170
|
+
# another Region where the bucket is to be created. If you create a
|
1171
|
+
# bucket in a Region other than US East (N. Virginia), your application
|
1172
|
+
# must be able to handle 307 redirect. For more information, see
|
1173
|
+
# [Virtual Hosting of Buckets][3].
|
1137
1174
|
#
|
1138
1175
|
# </note>
|
1139
1176
|
#
|
@@ -1143,28 +1180,29 @@ module Aws::S3
|
|
1143
1180
|
# permissions using the request headers.
|
1144
1181
|
#
|
1145
1182
|
# * Specify a canned ACL using the `x-amz-acl` request header. Amazon S3
|
1146
|
-
# supports a set of predefined ACLs, known as canned ACLs
|
1147
|
-
# ACL has a predefined set of grantees and permissions. For
|
1148
|
-
# information, see [Canned ACL][4].
|
1183
|
+
# supports a set of predefined ACLs, known as *canned ACLs*. Each
|
1184
|
+
# canned ACL has a predefined set of grantees and permissions. For
|
1185
|
+
# more information, see [Canned ACL][4].
|
1149
1186
|
#
|
1150
1187
|
# * Specify access permissions explicitly using the `x-amz-grant-read`,
|
1151
1188
|
# `x-amz-grant-write`, `x-amz-grant-read-acp`,
|
1152
|
-
# `x-amz-grant-write-acp`, `x-amz-grant-full-control` headers.
|
1153
|
-
# headers map to the set of permissions Amazon S3 supports in an
|
1154
|
-
# For more information, see [Access Control List (ACL)
|
1189
|
+
# `x-amz-grant-write-acp`, and `x-amz-grant-full-control` headers.
|
1190
|
+
# These headers map to the set of permissions Amazon S3 supports in an
|
1191
|
+
# ACL. For more information, see [Access Control List (ACL)
|
1192
|
+
# Overview][5].
|
1155
1193
|
#
|
1156
1194
|
# You specify each grantee as a type=value pair, where the type is one
|
1157
1195
|
# of the following:
|
1158
1196
|
#
|
1159
|
-
# * emailAddress – if the value specified is the email address of an
|
1197
|
+
# * `emailAddress` – if the value specified is the email address of an
|
1160
1198
|
# AWS account
|
1161
1199
|
#
|
1162
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
1200
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
1163
1201
|
# account
|
1164
1202
|
#
|
1165
|
-
# * uri – if you are granting permissions to a predefined group
|
1203
|
+
# * `uri` – if you are granting permissions to a predefined group
|
1166
1204
|
#
|
1167
|
-
# For example, the following x-amz-grant-read header grants the AWS
|
1205
|
+
# For example, the following `x-amz-grant-read` header grants the AWS
|
1168
1206
|
# accounts identified by email addresses permissions to read object
|
1169
1207
|
# data and its metadata:
|
1170
1208
|
#
|
@@ -1225,33 +1263,33 @@ module Aws::S3
|
|
1225
1263
|
# * {Types::CreateBucketOutput#location #location} => String
|
1226
1264
|
#
|
1227
1265
|
#
|
1228
|
-
# @example Example: To create a bucket
|
1266
|
+
# @example Example: To create a bucket
|
1229
1267
|
#
|
1230
|
-
# # The following example creates a bucket.
|
1268
|
+
# # The following example creates a bucket.
|
1231
1269
|
#
|
1232
1270
|
# resp = client.create_bucket({
|
1233
1271
|
# bucket: "examplebucket",
|
1234
|
-
# create_bucket_configuration: {
|
1235
|
-
# location_constraint: "eu-west-1",
|
1236
|
-
# },
|
1237
1272
|
# })
|
1238
1273
|
#
|
1239
1274
|
# resp.to_h outputs the following:
|
1240
1275
|
# {
|
1241
|
-
# location: "
|
1276
|
+
# location: "/examplebucket",
|
1242
1277
|
# }
|
1243
1278
|
#
|
1244
|
-
# @example Example: To create a bucket
|
1279
|
+
# @example Example: To create a bucket in a specific region
|
1245
1280
|
#
|
1246
|
-
# # The following example creates a bucket.
|
1281
|
+
# # The following example creates a bucket. The request specifies an AWS region where to create the bucket.
|
1247
1282
|
#
|
1248
1283
|
# resp = client.create_bucket({
|
1249
1284
|
# bucket: "examplebucket",
|
1285
|
+
# create_bucket_configuration: {
|
1286
|
+
# location_constraint: "eu-west-1",
|
1287
|
+
# },
|
1250
1288
|
# })
|
1251
1289
|
#
|
1252
1290
|
# resp.to_h outputs the following:
|
1253
1291
|
# {
|
1254
|
-
# location: "/
|
1292
|
+
# location: "http://examplebucket.s3.amazonaws.com/",
|
1255
1293
|
# }
|
1256
1294
|
#
|
1257
1295
|
# @example Request syntax with placeholder values
|
@@ -1369,13 +1407,13 @@ module Aws::S3
|
|
1369
1407
|
# server-side encryption. Server-side encryption is for data
|
1370
1408
|
# encryption at rest. Amazon S3 encrypts your data as it writes it to
|
1371
1409
|
# disks in its data centers and decrypts it when you access it. The
|
1372
|
-
# option you use depends on whether you want to use AWS
|
1410
|
+
# option you use depends on whether you want to use AWS managed
|
1373
1411
|
# encryption keys or provide your own encryption key.
|
1374
1412
|
#
|
1375
1413
|
# * Use encryption keys managed by Amazon S3 or customer master keys
|
1376
|
-
# (CMKs) stored in
|
1377
|
-
# AWS to manage the keys used to encrypt data, specify the
|
1378
|
-
# headers in the request.
|
1414
|
+
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
|
1415
|
+
# want AWS to manage the keys used to encrypt data, specify the
|
1416
|
+
# following headers in the request.
|
1379
1417
|
#
|
1380
1418
|
# * x-amz-server-side-encryption
|
1381
1419
|
#
|
@@ -1383,8 +1421,8 @@ module Aws::S3
|
|
1383
1421
|
#
|
1384
1422
|
# * x-amz-server-side-encryption-context
|
1385
1423
|
#
|
1386
|
-
# <note markdown="1"> If you specify x-amz-server-side-encryption:aws:kms
|
1387
|
-
# provide x-amz-server-side- encryption-aws-kms-key-id
|
1424
|
+
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
1425
|
+
# provide `x-amz-server-side- encryption-aws-kms-key-id`, Amazon S3
|
1388
1426
|
# uses the AWS managed CMK in AWS KMS to protect the data.
|
1389
1427
|
#
|
1390
1428
|
# </note>
|
@@ -1392,8 +1430,8 @@ module Aws::S3
|
|
1392
1430
|
# All GET and PUT requests for an object protected by AWS KMS fail
|
1393
1431
|
# if you don't make them with SSL or by using SigV4.
|
1394
1432
|
#
|
1395
|
-
# For more information
|
1396
|
-
#
|
1433
|
+
# For more information about server-side encryption with CMKs stored
|
1434
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1397
1435
|
# Encryption with CMKs stored in AWS KMS][8].
|
1398
1436
|
#
|
1399
1437
|
# * Use customer-provided encryption keys – If you want to manage your
|
@@ -1406,8 +1444,8 @@ module Aws::S3
|
|
1406
1444
|
#
|
1407
1445
|
# * x-amz-server-side-encryption-customer-key-MD5
|
1408
1446
|
#
|
1409
|
-
# For more information
|
1410
|
-
# AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1447
|
+
# For more information about server-side encryption with CMKs stored
|
1448
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
1411
1449
|
# Encryption with CMKs stored in AWS KMS][8].
|
1412
1450
|
#
|
1413
1451
|
# Access-Control-List (ACL)-Specific Request Headers
|
@@ -1416,13 +1454,13 @@ module Aws::S3
|
|
1416
1454
|
# this operation. By default, all objects are private. Only the owner
|
1417
1455
|
# has full access control. When adding a new object, you can grant
|
1418
1456
|
# permissions to individual AWS accounts or to predefined groups
|
1419
|
-
# defined by Amazon S3. These permissions are then added to the
|
1420
|
-
#
|
1457
|
+
# defined by Amazon S3. These permissions are then added to the access
|
1458
|
+
# control list (ACL) on the object. For more information, see [Using
|
1421
1459
|
# ACLs][9]. With this operation, you can grant access permissions
|
1422
1460
|
# using one of the following two methods:
|
1423
1461
|
#
|
1424
|
-
# * Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of
|
1425
|
-
# predefined ACLs, known as canned ACLs
|
1462
|
+
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
1463
|
+
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
1426
1464
|
# predefined set of grantees and permissions. For more information,
|
1427
1465
|
# see [Canned ACL][6].
|
1428
1466
|
#
|
@@ -1431,7 +1469,7 @@ module Aws::S3
|
|
1431
1469
|
# headers. Each header maps to specific permissions that Amazon S3
|
1432
1470
|
# supports in an ACL. For more information, see [Access Control List
|
1433
1471
|
# (ACL) Overview][7]. In the header, you specify a list of grantees
|
1434
|
-
# who get the specific permission. To grant permissions explicitly
|
1472
|
+
# who get the specific permission. To grant permissions explicitly,
|
1435
1473
|
# use:
|
1436
1474
|
#
|
1437
1475
|
# * x-amz-grant-read
|
@@ -1447,17 +1485,17 @@ module Aws::S3
|
|
1447
1485
|
# You specify each grantee as a type=value pair, where the type is
|
1448
1486
|
# one of the following:
|
1449
1487
|
#
|
1450
|
-
# * emailAddress – if the value specified is the email address of
|
1451
|
-
# AWS account
|
1488
|
+
# * `emailAddress` – if the value specified is the email address of
|
1489
|
+
# an AWS account
|
1452
1490
|
#
|
1453
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
1491
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
1454
1492
|
# account
|
1455
1493
|
#
|
1456
|
-
# * uri – if you are granting permissions to a predefined group
|
1494
|
+
# * `uri` – if you are granting permissions to a predefined group
|
1457
1495
|
#
|
1458
|
-
# For example, the following x-amz-grant-read header grants the
|
1459
|
-
# accounts identified by email addresses permissions to read
|
1460
|
-
# data and its metadata:
|
1496
|
+
# For example, the following `x-amz-grant-read` header grants the
|
1497
|
+
# AWS accounts identified by email addresses permissions to read
|
1498
|
+
# object data and its metadata:
|
1461
1499
|
#
|
1462
1500
|
# `x-amz-grant-read: emailAddress="xyz@amazon.com",
|
1463
1501
|
# emailAddress="abc@amazon.com" `
|
@@ -1532,8 +1570,8 @@ module Aws::S3
|
|
1532
1570
|
# A map of metadata to store with the object in S3.
|
1533
1571
|
#
|
1534
1572
|
# @option params [String] :server_side_encryption
|
1535
|
-
# The
|
1536
|
-
# S3 (
|
1573
|
+
# The server-side encryption algorithm used when storing this object in
|
1574
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
1537
1575
|
#
|
1538
1576
|
# @option params [String] :storage_class
|
1539
1577
|
# The type of storage to use for the object. Defaults to 'STANDARD'.
|
@@ -1544,27 +1582,32 @@ module Aws::S3
|
|
1544
1582
|
# Amazon S3 stores the value of this header in the object metadata.
|
1545
1583
|
#
|
1546
1584
|
# @option params [String] :sse_customer_algorithm
|
1547
|
-
# Specifies the algorithm to use to when encrypting the object (
|
1548
|
-
# AES256).
|
1585
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
1586
|
+
# example, AES256).
|
1549
1587
|
#
|
1550
1588
|
# @option params [String] :sse_customer_key
|
1551
1589
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
1552
1590
|
# encrypting data. This value is used to store the object and then it is
|
1553
|
-
# discarded; Amazon does not store the encryption key. The key must
|
1554
|
-
# appropriate for use with the algorithm specified in the
|
1555
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
1591
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
1592
|
+
# be appropriate for use with the algorithm specified in the
|
1593
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
1556
1594
|
#
|
1557
1595
|
# @option params [String] :sse_customer_key_md5
|
1558
1596
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
1559
1597
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
1560
|
-
# ensure the encryption key was transmitted without error.
|
1598
|
+
# ensure that the encryption key was transmitted without error.
|
1561
1599
|
#
|
1562
1600
|
# @option params [String] :ssekms_key_id
|
1563
1601
|
# Specifies the AWS KMS key ID to use for object encryption. All GET and
|
1564
1602
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
1565
|
-
# via SSL or using SigV4.
|
1566
|
-
# officially supported AWS SDKs and CLI
|
1567
|
-
#
|
1603
|
+
# via SSL or using SigV4. For information about configuring using any of
|
1604
|
+
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
1605
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
1606
|
+
# Developer Guide*.
|
1607
|
+
#
|
1608
|
+
#
|
1609
|
+
#
|
1610
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
1568
1611
|
#
|
1569
1612
|
# @option params [String] :ssekms_encryption_context
|
1570
1613
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -1574,13 +1617,17 @@ module Aws::S3
|
|
1574
1617
|
# @option params [String] :request_payer
|
1575
1618
|
# Confirms that the requester knows that she or he will be charged for
|
1576
1619
|
# the request. Bucket owners need not specify this parameter in their
|
1577
|
-
# requests.
|
1578
|
-
# buckets
|
1579
|
-
#
|
1620
|
+
# requests. For information about downloading objects from Requester
|
1621
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1622
|
+
# in the *Amazon S3 Developer Guide*.
|
1623
|
+
#
|
1624
|
+
#
|
1625
|
+
#
|
1626
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
1580
1627
|
#
|
1581
1628
|
# @option params [String] :tagging
|
1582
1629
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
1583
|
-
# parameters
|
1630
|
+
# parameters.
|
1584
1631
|
#
|
1585
1632
|
# @option params [String] :object_lock_mode
|
1586
1633
|
# Specifies the Object Lock mode that you want to apply to the uploaded
|
@@ -1682,7 +1729,7 @@ module Aws::S3
|
|
1682
1729
|
end
|
1683
1730
|
|
1684
1731
|
# Deletes the bucket. All objects (including all object versions and
|
1685
|
-
#
|
1732
|
+
# delete markers) in the bucket must be deleted before the bucket itself
|
1686
1733
|
# can be deleted.
|
1687
1734
|
#
|
1688
1735
|
# **Related Resources**
|
@@ -1723,13 +1770,13 @@ module Aws::S3
|
|
1723
1770
|
# analytics configuration ID).
|
1724
1771
|
#
|
1725
1772
|
# To use this operation, you must have permissions to perform the
|
1726
|
-
# s3:PutAnalyticsConfiguration action. The bucket owner has this
|
1773
|
+
# `s3:PutAnalyticsConfiguration` action. The bucket owner has this
|
1727
1774
|
# permission by default. The bucket owner can grant this permission to
|
1728
1775
|
# others. For more information about permissions, see [Permissions
|
1729
1776
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
1730
1777
|
# Permissions to Your Amazon S3 Resources][2].
|
1731
1778
|
#
|
1732
|
-
# For information about Amazon S3 analytics feature, see [Amazon S3
|
1779
|
+
# For information about the Amazon S3 analytics feature, see [Amazon S3
|
1733
1780
|
# Analytics – Storage Class Analysis][3].
|
1734
1781
|
#
|
1735
1782
|
# The following operations are related to
|
@@ -1776,9 +1823,8 @@ module Aws::S3
|
|
1776
1823
|
# `s3:PutBucketCORS` action. The bucket owner has this permission by
|
1777
1824
|
# default and can grant this permission to others.
|
1778
1825
|
#
|
1779
|
-
# For information
|
1780
|
-
#
|
1781
|
-
# Guide*.
|
1826
|
+
# For information about `cors`, see [Enabling Cross-Origin Resource
|
1827
|
+
# Sharing][1] in the *Amazon Simple Storage Service Developer Guide*.
|
1782
1828
|
#
|
1783
1829
|
# **Related Resources:**
|
1784
1830
|
#
|
@@ -1877,7 +1923,7 @@ module Aws::S3
|
|
1877
1923
|
# For information about the Amazon S3 inventory feature, see [Amazon S3
|
1878
1924
|
# Inventory][3].
|
1879
1925
|
#
|
1880
|
-
#
|
1926
|
+
# Operations related to `DeleteBucketInventoryConfiguration` include:
|
1881
1927
|
#
|
1882
1928
|
# * GetBucketInventoryConfiguration
|
1883
1929
|
#
|
@@ -1987,7 +2033,7 @@ module Aws::S3
|
|
1987
2033
|
# [Monitoring Metrics with Amazon CloudWatch][3].
|
1988
2034
|
#
|
1989
2035
|
# The following operations are related to
|
1990
|
-
# `DeleteBucketMetricsConfiguration
|
2036
|
+
# `DeleteBucketMetricsConfiguration`\:
|
1991
2037
|
#
|
1992
2038
|
# * GetBucketMetricsConfiguration
|
1993
2039
|
#
|
@@ -2027,16 +2073,16 @@ module Aws::S3
|
|
2027
2073
|
req.send_request(options)
|
2028
2074
|
end
|
2029
2075
|
|
2030
|
-
# This implementation of the DELETE operation uses the
|
2031
|
-
# to delete the policy of a specified bucket. If you are
|
2032
|
-
# identity other than the root user of the AWS account that
|
2033
|
-
# bucket, the calling identity must have the
|
2034
|
-
# permissions on the specified bucket and belong to
|
2035
|
-
#
|
2076
|
+
# This implementation of the DELETE operation uses the policy
|
2077
|
+
# subresource to delete the policy of a specified bucket. If you are
|
2078
|
+
# using an identity other than the root user of the AWS account that
|
2079
|
+
# owns the bucket, the calling identity must have the
|
2080
|
+
# `DeleteBucketPolicy` permissions on the specified bucket and belong to
|
2081
|
+
# the bucket owner's account to use this operation.
|
2036
2082
|
#
|
2037
2083
|
# If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns
|
2038
2084
|
# a `403 Access Denied` error. If you have the correct permissions, but
|
2039
|
-
# you're
|
2085
|
+
# you're not using an identity that belongs to the bucket owner's
|
2040
2086
|
# account, Amazon S3 returns a `405 Method Not Allowed` error.
|
2041
2087
|
#
|
2042
2088
|
# As a security precaution, the root user of the AWS account that owns a
|
@@ -2100,7 +2146,7 @@ module Aws::S3
|
|
2100
2146
|
# https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
|
2101
2147
|
# the *Amazon S3 Developer Guide*.
|
2102
2148
|
#
|
2103
|
-
# The following operations are related to `DeleteBucketReplication
|
2149
|
+
# The following operations are related to `DeleteBucketReplication`\:
|
2104
2150
|
#
|
2105
2151
|
# * PutBucketReplication
|
2106
2152
|
#
|
@@ -2146,7 +2192,7 @@ module Aws::S3
|
|
2146
2192
|
# `s3:PutBucketTagging` action. By default, the bucket owner has this
|
2147
2193
|
# permission and can grant this permission to others.
|
2148
2194
|
#
|
2149
|
-
# The following operations are related to `DeleteBucketTagging
|
2195
|
+
# The following operations are related to `DeleteBucketTagging`\:
|
2150
2196
|
#
|
2151
2197
|
# * GetBucketTagging
|
2152
2198
|
#
|
@@ -2197,7 +2243,7 @@ module Aws::S3
|
|
2197
2243
|
# For more information about hosting websites, see [Hosting Websites on
|
2198
2244
|
# Amazon S3][1].
|
2199
2245
|
#
|
2200
|
-
# The following operations are related to `DeleteBucketWebsite
|
2246
|
+
# The following operations are related to `DeleteBucketWebsite`\:
|
2201
2247
|
#
|
2202
2248
|
# * GetBucketWebsite
|
2203
2249
|
#
|
@@ -2244,13 +2290,13 @@ module Aws::S3
|
|
2244
2290
|
# To remove a specific version, you must be the bucket owner and you
|
2245
2291
|
# must use the version Id subresource. Using this subresource
|
2246
2292
|
# permanently deletes the version. If the object deleted is a delete
|
2247
|
-
# marker, Amazon S3 sets the response header, x-amz-delete-marker
|
2293
|
+
# marker, Amazon S3 sets the response header, `x-amz-delete-marker`, to
|
2248
2294
|
# true.
|
2249
2295
|
#
|
2250
2296
|
# If the object you want to delete is in a bucket where the bucket
|
2251
|
-
# versioning
|
2252
|
-
# x-amz-mfa request header in the DELETE versionId request. Requests
|
2253
|
-
# that include x-amz-mfa must use HTTPS.
|
2297
|
+
# versioning configuration is MFA Delete enabled, you must include the
|
2298
|
+
# `x-amz-mfa` request header in the DELETE `versionId` request. Requests
|
2299
|
+
# that include `x-amz-mfa` must use HTTPS.
|
2254
2300
|
#
|
2255
2301
|
# For more information about MFA Delete, see [Using MFA Delete][1]. To
|
2256
2302
|
# see sample requests that use versioning, see [Sample Request][2].
|
@@ -2258,11 +2304,11 @@ module Aws::S3
|
|
2258
2304
|
# You can delete objects by explicitly calling the DELETE Object API or
|
2259
2305
|
# configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to
|
2260
2306
|
# remove them for you. If you want to block users or accounts from
|
2261
|
-
# removing or deleting objects from your bucket you must deny them the
|
2262
|
-
# s3:DeleteObject
|
2263
|
-
# s3:PutLifeCycleConfiguration actions.
|
2307
|
+
# removing or deleting objects from your bucket, you must deny them the
|
2308
|
+
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
|
2309
|
+
# `s3:PutLifeCycleConfiguration` actions.
|
2264
2310
|
#
|
2265
|
-
# The following operation is related to `DeleteObject
|
2311
|
+
# The following operation is related to `DeleteObject`\:
|
2266
2312
|
#
|
2267
2313
|
# * PutObject
|
2268
2314
|
#
|
@@ -2276,14 +2322,26 @@ module Aws::S3
|
|
2276
2322
|
# @option params [required, String] :bucket
|
2277
2323
|
# The bucket name of the bucket containing the object.
|
2278
2324
|
#
|
2325
|
+
# When using this API with an access point, you must direct requests to
|
2326
|
+
# the access point hostname. The access point hostname takes the form
|
2327
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2328
|
+
# When using this operation using an access point through the AWS SDKs,
|
2329
|
+
# you provide the access point ARN in place of the bucket name. For more
|
2330
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
2331
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
2332
|
+
#
|
2333
|
+
#
|
2334
|
+
#
|
2335
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2336
|
+
#
|
2279
2337
|
# @option params [required, String] :key
|
2280
2338
|
# Key name of the object to delete.
|
2281
2339
|
#
|
2282
2340
|
# @option params [String] :mfa
|
2283
2341
|
# The concatenation of the authentication device's serial number, a
|
2284
2342
|
# space, and the value that is displayed on your authentication device.
|
2285
|
-
# Required to permanently delete a
|
2286
|
-
# configured with MFA
|
2343
|
+
# Required to permanently delete a versioned object if versioning is
|
2344
|
+
# configured with MFA delete enabled.
|
2287
2345
|
#
|
2288
2346
|
# @option params [String] :version_id
|
2289
2347
|
# VersionId used to reference a specific version of the object.
|
@@ -2291,9 +2349,13 @@ module Aws::S3
|
|
2291
2349
|
# @option params [String] :request_payer
|
2292
2350
|
# Confirms that the requester knows that she or he will be charged for
|
2293
2351
|
# the request. Bucket owners need not specify this parameter in their
|
2294
|
-
# requests.
|
2295
|
-
# buckets
|
2296
|
-
#
|
2352
|
+
# requests. For information about downloading objects from Requester
|
2353
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2354
|
+
# in the *Amazon S3 Developer Guide*.
|
2355
|
+
#
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
2297
2359
|
#
|
2298
2360
|
# @option params [Boolean] :bypass_governance_retention
|
2299
2361
|
# Indicates whether S3 Object Lock should bypass Governance-mode
|
@@ -2358,14 +2420,14 @@ module Aws::S3
|
|
2358
2420
|
# information about managing object tags, see [ Object Tagging][1].
|
2359
2421
|
#
|
2360
2422
|
# To use this operation, you must have permission to perform the
|
2361
|
-
# s3:DeleteObjectTagging action.
|
2423
|
+
# `s3:DeleteObjectTagging` action.
|
2362
2424
|
#
|
2363
|
-
# To delete tags of a specific object version, add the versionId query
|
2425
|
+
# To delete tags of a specific object version, add the `versionId` query
|
2364
2426
|
# parameter in the request. You will need permission for the
|
2365
|
-
# s3:DeleteObjectVersionTagging action.
|
2427
|
+
# `s3:DeleteObjectVersionTagging` action.
|
2366
2428
|
#
|
2367
2429
|
# The following operations are related to
|
2368
|
-
# `DeleteBucketMetricsConfiguration
|
2430
|
+
# `DeleteBucketMetricsConfiguration`\:
|
2369
2431
|
#
|
2370
2432
|
# * PutObjectTagging
|
2371
2433
|
#
|
@@ -2376,7 +2438,19 @@ module Aws::S3
|
|
2376
2438
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete
|
2377
2439
|
#
|
2378
2440
|
# @option params [required, String] :bucket
|
2379
|
-
# The bucket containing the objects from which to remove the tags.
|
2441
|
+
# The bucket name containing the objects from which to remove the tags.
|
2442
|
+
#
|
2443
|
+
# When using this API with an access point, you must direct requests to
|
2444
|
+
# the access point hostname. The access point hostname takes the form
|
2445
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2446
|
+
# When using this operation using an access point through the AWS SDKs,
|
2447
|
+
# you provide the access point ARN in place of the bucket name. For more
|
2448
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
2449
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
2450
|
+
#
|
2451
|
+
#
|
2452
|
+
#
|
2453
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2380
2454
|
#
|
2381
2455
|
# @option params [required, String] :key
|
2382
2456
|
# Name of the tag.
|
@@ -2389,35 +2463,35 @@ module Aws::S3
|
|
2389
2463
|
# * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String
|
2390
2464
|
#
|
2391
2465
|
#
|
2392
|
-
# @example Example: To remove tag set from an object
|
2466
|
+
# @example Example: To remove tag set from an object version
|
2393
2467
|
#
|
2394
|
-
# # The following example removes tag set associated with the specified object.
|
2395
|
-
# #
|
2468
|
+
# # The following example removes tag set associated with the specified object version. The request specifies both the
|
2469
|
+
# # object key and object version.
|
2396
2470
|
#
|
2397
2471
|
# resp = client.delete_object_tagging({
|
2398
2472
|
# bucket: "examplebucket",
|
2399
2473
|
# key: "HappyFace.jpg",
|
2474
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2400
2475
|
# })
|
2401
2476
|
#
|
2402
2477
|
# resp.to_h outputs the following:
|
2403
2478
|
# {
|
2404
|
-
# version_id: "
|
2479
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2405
2480
|
# }
|
2406
2481
|
#
|
2407
|
-
# @example Example: To remove tag set from an object
|
2482
|
+
# @example Example: To remove tag set from an object
|
2408
2483
|
#
|
2409
|
-
# # The following example removes tag set associated with the specified object
|
2410
|
-
# #
|
2484
|
+
# # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the
|
2485
|
+
# # operation removes tag set from the latest object version.
|
2411
2486
|
#
|
2412
2487
|
# resp = client.delete_object_tagging({
|
2413
2488
|
# bucket: "examplebucket",
|
2414
2489
|
# key: "HappyFace.jpg",
|
2415
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
2416
2490
|
# })
|
2417
2491
|
#
|
2418
2492
|
# resp.to_h outputs the following:
|
2419
2493
|
# {
|
2420
|
-
# version_id: "
|
2494
|
+
# version_id: "null",
|
2421
2495
|
# }
|
2422
2496
|
#
|
2423
2497
|
# @example Request syntax with placeholder values
|
@@ -2451,10 +2525,10 @@ module Aws::S3
|
|
2451
2525
|
# version IDs if you want to delete a specific version of the object
|
2452
2526
|
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
2453
2527
|
# delete operation and returns the result of that delete, success, or
|
2454
|
-
# failure, in the response. Note that
|
2528
|
+
# failure, in the response. Note that if the object specified in the
|
2455
2529
|
# request is not found, Amazon S3 returns the result as deleted.
|
2456
2530
|
#
|
2457
|
-
# The operation supports two modes for the response
|
2531
|
+
# The operation supports two modes for the response: verbose and quiet.
|
2458
2532
|
# By default, the operation uses verbose mode in which the response
|
2459
2533
|
# includes the result of deletion of each key in your request. In quiet
|
2460
2534
|
# mode the response includes only keys where the delete operation
|
@@ -2464,16 +2538,16 @@ module Aws::S3
|
|
2464
2538
|
# When performing this operation on an MFA Delete enabled bucket, that
|
2465
2539
|
# attempts to delete any versioned objects, you must include an MFA
|
2466
2540
|
# token. If you do not provide one, the entire request will fail, even
|
2467
|
-
# if there are non
|
2468
|
-
#
|
2541
|
+
# if there are non-versioned objects you are trying to delete. If you
|
2542
|
+
# provide an invalid token, whether there are versioned keys in the
|
2469
2543
|
# request or not, the entire Multi-Object Delete request will fail. For
|
2470
2544
|
# information about MFA Delete, see [ MFA Delete][1].
|
2471
2545
|
#
|
2472
2546
|
# Finally, the Content-MD5 header is required for all Multi-Object
|
2473
2547
|
# Delete requests. Amazon S3 uses the header value to ensure that your
|
2474
|
-
# request body has not
|
2548
|
+
# request body has not been altered in transit.
|
2475
2549
|
#
|
2476
|
-
# The following operations are related to `DeleteObjects
|
2550
|
+
# The following operations are related to `DeleteObjects`\:
|
2477
2551
|
#
|
2478
2552
|
# * CreateMultipartUpload
|
2479
2553
|
#
|
@@ -2492,6 +2566,18 @@ module Aws::S3
|
|
2492
2566
|
# @option params [required, String] :bucket
|
2493
2567
|
# The bucket name containing the objects to delete.
|
2494
2568
|
#
|
2569
|
+
# When using this API with an access point, you must direct requests to
|
2570
|
+
# the access point hostname. The access point hostname takes the form
|
2571
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2572
|
+
# When using this operation using an access point through the AWS SDKs,
|
2573
|
+
# you provide the access point ARN in place of the bucket name. For more
|
2574
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
2575
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
2576
|
+
#
|
2577
|
+
#
|
2578
|
+
#
|
2579
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
2580
|
+
#
|
2495
2581
|
# @option params [required, Types::Delete] :delete
|
2496
2582
|
# Container for the request.
|
2497
2583
|
#
|
@@ -2499,14 +2585,18 @@ module Aws::S3
|
|
2499
2585
|
# The concatenation of the authentication device's serial number, a
|
2500
2586
|
# space, and the value that is displayed on your authentication device.
|
2501
2587
|
# Required to permanently delete a versioned object if versioning is
|
2502
|
-
# configured with MFA
|
2588
|
+
# configured with MFA delete enabled.
|
2503
2589
|
#
|
2504
2590
|
# @option params [String] :request_payer
|
2505
2591
|
# Confirms that the requester knows that she or he will be charged for
|
2506
2592
|
# the request. Bucket owners need not specify this parameter in their
|
2507
|
-
# requests.
|
2508
|
-
# buckets
|
2509
|
-
#
|
2593
|
+
# requests. For information about downloading objects from Requester
|
2594
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
2595
|
+
# in the *Amazon S3 Developer Guide*.
|
2596
|
+
#
|
2597
|
+
#
|
2598
|
+
#
|
2599
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
2510
2600
|
#
|
2511
2601
|
# @option params [Boolean] :bypass_governance_retention
|
2512
2602
|
# Specifies whether you want to delete this object even if it has a
|
@@ -2520,22 +2610,20 @@ module Aws::S3
|
|
2520
2610
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
2521
2611
|
#
|
2522
2612
|
#
|
2523
|
-
# @example Example: To delete multiple
|
2613
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
2524
2614
|
#
|
2525
|
-
# # The following example deletes objects from a bucket. The
|
2526
|
-
# #
|
2615
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
2616
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
2527
2617
|
#
|
2528
2618
|
# resp = client.delete_objects({
|
2529
2619
|
# bucket: "examplebucket",
|
2530
2620
|
# delete: {
|
2531
2621
|
# objects: [
|
2532
2622
|
# {
|
2533
|
-
# key: "
|
2534
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2623
|
+
# key: "objectkey1",
|
2535
2624
|
# },
|
2536
2625
|
# {
|
2537
|
-
# key: "
|
2538
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2626
|
+
# key: "objectkey2",
|
2539
2627
|
# },
|
2540
2628
|
# ],
|
2541
2629
|
# quiet: false,
|
@@ -2546,30 +2634,34 @@ module Aws::S3
|
|
2546
2634
|
# {
|
2547
2635
|
# deleted: [
|
2548
2636
|
# {
|
2549
|
-
#
|
2550
|
-
#
|
2637
|
+
# delete_marker: true,
|
2638
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
2639
|
+
# key: "objectkey1",
|
2551
2640
|
# },
|
2552
2641
|
# {
|
2553
|
-
#
|
2554
|
-
#
|
2642
|
+
# delete_marker: true,
|
2643
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
2644
|
+
# key: "objectkey2",
|
2555
2645
|
# },
|
2556
2646
|
# ],
|
2557
2647
|
# }
|
2558
2648
|
#
|
2559
|
-
# @example Example: To delete multiple
|
2649
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
2560
2650
|
#
|
2561
|
-
# # The following example deletes objects from a bucket. The
|
2562
|
-
# #
|
2651
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
2652
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
2563
2653
|
#
|
2564
2654
|
# resp = client.delete_objects({
|
2565
2655
|
# bucket: "examplebucket",
|
2566
2656
|
# delete: {
|
2567
2657
|
# objects: [
|
2568
2658
|
# {
|
2569
|
-
# key: "
|
2659
|
+
# key: "HappyFace.jpg",
|
2660
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2570
2661
|
# },
|
2571
2662
|
# {
|
2572
|
-
# key: "
|
2663
|
+
# key: "HappyFace.jpg",
|
2664
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2573
2665
|
# },
|
2574
2666
|
# ],
|
2575
2667
|
# quiet: false,
|
@@ -2580,14 +2672,12 @@ module Aws::S3
|
|
2580
2672
|
# {
|
2581
2673
|
# deleted: [
|
2582
2674
|
# {
|
2583
|
-
#
|
2584
|
-
#
|
2585
|
-
# key: "objectkey1",
|
2675
|
+
# key: "HappyFace.jpg",
|
2676
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2586
2677
|
# },
|
2587
2678
|
# {
|
2588
|
-
#
|
2589
|
-
#
|
2590
|
-
# key: "objectkey2",
|
2679
|
+
# key: "HappyFace.jpg",
|
2680
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2591
2681
|
# },
|
2592
2682
|
# ],
|
2593
2683
|
# }
|
@@ -2633,9 +2723,9 @@ module Aws::S3
|
|
2633
2723
|
req.send_request(options)
|
2634
2724
|
end
|
2635
2725
|
|
2636
|
-
# Removes the PublicAccessBlock configuration for an Amazon S3 bucket.
|
2637
|
-
#
|
2638
|
-
# s3:PutBucketPublicAccessBlock permission. For more information about
|
2726
|
+
# Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket.
|
2727
|
+
# To use this operation, you must have the
|
2728
|
+
# `s3:PutBucketPublicAccessBlock` permission. For more information about
|
2639
2729
|
# permissions, see [Permissions Related to Bucket Subresource
|
2640
2730
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
2641
2731
|
# Resources][2].
|
@@ -2689,8 +2779,8 @@ module Aws::S3
|
|
2689
2779
|
# permission by default. The bucket owner can grant this permission to
|
2690
2780
|
# others. For more information about permissions, see [Permissions
|
2691
2781
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
2692
|
-
# Permissions to your Amazon S3 Resources][2] in the Amazon Simple
|
2693
|
-
# Storage Service Developer Guide
|
2782
|
+
# Permissions to your Amazon S3 Resources][2] in the *Amazon Simple
|
2783
|
+
# Storage Service Developer Guide*.
|
2694
2784
|
#
|
2695
2785
|
# You set the Transfer Acceleration state of an existing bucket to
|
2696
2786
|
# `Enabled` or `Suspended` by using the PutBucketAccelerateConfiguration
|
@@ -2698,9 +2788,9 @@ module Aws::S3
|
|
2698
2788
|
#
|
2699
2789
|
# A GET `accelerate` request does not return a state value for a bucket
|
2700
2790
|
# that has no transfer acceleration state. A bucket has no Transfer
|
2701
|
-
# Acceleration state
|
2791
|
+
# Acceleration state if a state has never been set on the bucket.
|
2702
2792
|
#
|
2703
|
-
# For more information
|
2793
|
+
# For more information about transfer acceleration, see [Transfer
|
2704
2794
|
# Acceleration][3] in the Amazon Simple Storage Service Developer Guide.
|
2705
2795
|
#
|
2706
2796
|
# **Related Resources**
|
@@ -2866,8 +2956,8 @@ module Aws::S3
|
|
2866
2956
|
# s3:GetBucketCORS action. By default, the bucket owner has this
|
2867
2957
|
# permission and can grant it to others.
|
2868
2958
|
#
|
2869
|
-
#
|
2870
|
-
# Sharing][1]
|
2959
|
+
# For more information about cors, see [ Enabling Cross-Origin Resource
|
2960
|
+
# Sharing][1].
|
2871
2961
|
#
|
2872
2962
|
# The following operations are related to `GetBucketCors`\:
|
2873
2963
|
#
|
@@ -3065,7 +3155,7 @@ module Aws::S3
|
|
3065
3155
|
|
3066
3156
|
# For an updated version of this API, see
|
3067
3157
|
# GetBucketLifecycleConfiguration. If you configured a bucket lifecycle
|
3068
|
-
# using the `filter` element, you should the updated version of this
|
3158
|
+
# using the `filter` element, you should see the updated version of this
|
3069
3159
|
# topic. This topic is provided for backward compatibility.
|
3070
3160
|
#
|
3071
3161
|
# Returns the lifecycle configuration information set on the bucket. For
|
@@ -3104,7 +3194,7 @@ module Aws::S3
|
|
3104
3194
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3105
3195
|
#
|
3106
3196
|
# @option params [required, String] :bucket
|
3107
|
-
# The name of the bucket for which to
|
3197
|
+
# The name of the bucket for which to get the lifecycle information.
|
3108
3198
|
#
|
3109
3199
|
# @return [Types::GetBucketLifecycleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3110
3200
|
#
|
@@ -3213,7 +3303,7 @@ module Aws::S3
|
|
3213
3303
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
3214
3304
|
#
|
3215
3305
|
# @option params [required, String] :bucket
|
3216
|
-
# The name of the bucket for which to
|
3306
|
+
# The name of the bucket for which to get the lifecycle information.
|
3217
3307
|
#
|
3218
3308
|
# @return [Types::GetBucketLifecycleConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3219
3309
|
#
|
@@ -3286,7 +3376,7 @@ module Aws::S3
|
|
3286
3376
|
req.send_request(options)
|
3287
3377
|
end
|
3288
3378
|
|
3289
|
-
# Returns the
|
3379
|
+
# Returns the Region the bucket resides in. You set the bucket's Region
|
3290
3380
|
# using the `LocationConstraint` request parameter in a `CreateBucket`
|
3291
3381
|
# request. For more information, see CreateBucket.
|
3292
3382
|
#
|
@@ -3759,7 +3849,8 @@ module Aws::S3
|
|
3759
3849
|
#
|
3760
3850
|
# </note>
|
3761
3851
|
#
|
3762
|
-
# For information about replication configuration, see [Replication][1]
|
3852
|
+
# For information about replication configuration, see [Replication][1]
|
3853
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
3763
3854
|
#
|
3764
3855
|
# This operation requires permissions for the
|
3765
3856
|
# `s3:GetReplicationConfiguration` action. For more information about
|
@@ -3769,15 +3860,8 @@ module Aws::S3
|
|
3769
3860
|
# you must also include the `DeleteMarkerReplication` and `Priority`
|
3770
3861
|
# elements. The response also returns those elements.
|
3771
3862
|
#
|
3772
|
-
# `GetBucketReplication`
|
3773
|
-
#
|
3774
|
-
# * Error code: `NoSuchReplicationConfiguration`
|
3775
|
-
#
|
3776
|
-
# * Description: There is no replication configuration with that name.
|
3777
|
-
#
|
3778
|
-
# * HTTP Status Code: 404 Not Found
|
3779
|
-
#
|
3780
|
-
# * SOAP Fault Code Prefix: Client
|
3863
|
+
# For information about `GetBucketReplication` errors, see
|
3864
|
+
# ReplicationErrorCodeList
|
3781
3865
|
#
|
3782
3866
|
# The following operations are related to `GetBucketReplication`\:
|
3783
3867
|
#
|
@@ -3998,9 +4082,9 @@ module Aws::S3
|
|
3998
4082
|
# owner.
|
3999
4083
|
#
|
4000
4084
|
# This implementation also returns the MFA Delete status of the
|
4001
|
-
# versioning state
|
4002
|
-
#
|
4003
|
-
#
|
4085
|
+
# versioning state. If the MFA Delete status is `enabled`, the bucket
|
4086
|
+
# owner must use an authentication device to change the versioning state
|
4087
|
+
# of the bucket.
|
4004
4088
|
#
|
4005
4089
|
# The following operations are related to `GetBucketVersioning`\:
|
4006
4090
|
#
|
@@ -4064,7 +4148,7 @@ module Aws::S3
|
|
4064
4148
|
# the website configuration by writing a bucket policy granting them the
|
4065
4149
|
# `S3:GetBucketWebsite` permission.
|
4066
4150
|
#
|
4067
|
-
# The following operations are related to `DeleteBucketWebsite
|
4151
|
+
# The following operations are related to `DeleteBucketWebsite`\:
|
4068
4152
|
#
|
4069
4153
|
# * DeleteBucketWebsite
|
4070
4154
|
#
|
@@ -4149,7 +4233,7 @@ module Aws::S3
|
|
4149
4233
|
# `photos/2006/February/sample.jpg`, specify the resource as
|
4150
4234
|
# `/photos/2006/February/sample.jpg`. For a path-style request example,
|
4151
4235
|
# if you have the object `photos/2006/February/sample.jpg` in the bucket
|
4152
|
-
# named examplebucket
|
4236
|
+
# named `examplebucket`, specify the resource as
|
4153
4237
|
# `/examplebucket/photos/2006/February/sample.jpg`. For more information
|
4154
4238
|
# about request types, see [HTTP Host Header Bucket Specification][1].
|
4155
4239
|
#
|
@@ -4288,6 +4372,18 @@ module Aws::S3
|
|
4288
4372
|
# @option params [required, String] :bucket
|
4289
4373
|
# The bucket name containing the object.
|
4290
4374
|
#
|
4375
|
+
# When using this API with an access point, you must direct requests to
|
4376
|
+
# the access point hostname. The access point hostname takes the form
|
4377
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4378
|
+
# When using this operation using an access point through the AWS SDKs,
|
4379
|
+
# you provide the access point ARN in place of the bucket name. For more
|
4380
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
4381
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
4382
|
+
#
|
4383
|
+
#
|
4384
|
+
#
|
4385
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4386
|
+
#
|
4291
4387
|
# @option params [String] :if_match
|
4292
4388
|
# Return the object only if its entity tag (ETag) is the same as the one
|
4293
4389
|
# specified, otherwise return a 412 (precondition failed).
|
@@ -4309,52 +4405,56 @@ module Aws::S3
|
|
4309
4405
|
#
|
4310
4406
|
# @option params [String] :range
|
4311
4407
|
# Downloads the specified range bytes of an object. For more information
|
4312
|
-
# about the HTTP Range header,
|
4313
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
4408
|
+
# about the HTTP Range header, see
|
4409
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
4314
4410
|
#
|
4315
4411
|
# @option params [String] :response_cache_control
|
4316
|
-
# Sets the Cache-Control header of the response.
|
4412
|
+
# Sets the `Cache-Control` header of the response.
|
4317
4413
|
#
|
4318
4414
|
# @option params [String] :response_content_disposition
|
4319
|
-
# Sets the Content-Disposition header of the response
|
4415
|
+
# Sets the `Content-Disposition` header of the response
|
4320
4416
|
#
|
4321
4417
|
# @option params [String] :response_content_encoding
|
4322
|
-
# Sets the Content-Encoding header of the response.
|
4418
|
+
# Sets the `Content-Encoding` header of the response.
|
4323
4419
|
#
|
4324
4420
|
# @option params [String] :response_content_language
|
4325
|
-
# Sets the Content-Language header of the response.
|
4421
|
+
# Sets the `Content-Language` header of the response.
|
4326
4422
|
#
|
4327
4423
|
# @option params [String] :response_content_type
|
4328
|
-
# Sets the Content-Type header of the response.
|
4424
|
+
# Sets the `Content-Type` header of the response.
|
4329
4425
|
#
|
4330
4426
|
# @option params [Time,DateTime,Date,Integer,String] :response_expires
|
4331
|
-
# Sets the Expires header of the response.
|
4427
|
+
# Sets the `Expires` header of the response.
|
4332
4428
|
#
|
4333
4429
|
# @option params [String] :version_id
|
4334
4430
|
# VersionId used to reference a specific version of the object.
|
4335
4431
|
#
|
4336
4432
|
# @option params [String] :sse_customer_algorithm
|
4337
|
-
# Specifies the algorithm to use to when encrypting the object (
|
4338
|
-
# AES256).
|
4433
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
4434
|
+
# example, AES256).
|
4339
4435
|
#
|
4340
4436
|
# @option params [String] :sse_customer_key
|
4341
4437
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
4342
4438
|
# encrypting data. This value is used to store the object and then it is
|
4343
|
-
# discarded; Amazon does not store the encryption key. The key must
|
4344
|
-
# appropriate for use with the algorithm specified in the
|
4345
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
4439
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
4440
|
+
# be appropriate for use with the algorithm specified in the
|
4441
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
4346
4442
|
#
|
4347
4443
|
# @option params [String] :sse_customer_key_md5
|
4348
4444
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
4349
4445
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
4350
|
-
# ensure the encryption key was transmitted without error.
|
4446
|
+
# ensure that the encryption key was transmitted without error.
|
4351
4447
|
#
|
4352
4448
|
# @option params [String] :request_payer
|
4353
4449
|
# Confirms that the requester knows that she or he will be charged for
|
4354
4450
|
# the request. Bucket owners need not specify this parameter in their
|
4355
|
-
# requests.
|
4356
|
-
# buckets
|
4357
|
-
#
|
4451
|
+
# requests. For information about downloading objects from Requester
|
4452
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4453
|
+
# in the *Amazon S3 Developer Guide*.
|
4454
|
+
#
|
4455
|
+
#
|
4456
|
+
#
|
4457
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4358
4458
|
#
|
4359
4459
|
# @option params [Integer] :part_number
|
4360
4460
|
# Part number of the object being read. This is a positive integer
|
@@ -4558,7 +4658,20 @@ module Aws::S3
|
|
4558
4658
|
# * PutObject
|
4559
4659
|
#
|
4560
4660
|
# @option params [required, String] :bucket
|
4561
|
-
# The bucket name
|
4661
|
+
# The bucket name that contains the object for which to get the ACL
|
4662
|
+
# information.
|
4663
|
+
#
|
4664
|
+
# When using this API with an access point, you must direct requests to
|
4665
|
+
# the access point hostname. The access point hostname takes the form
|
4666
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4667
|
+
# When using this operation using an access point through the AWS SDKs,
|
4668
|
+
# you provide the access point ARN in place of the bucket name. For more
|
4669
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
4670
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
4671
|
+
#
|
4672
|
+
#
|
4673
|
+
#
|
4674
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4562
4675
|
#
|
4563
4676
|
# @option params [required, String] :key
|
4564
4677
|
# The key of the object for which to get the ACL information.
|
@@ -4569,9 +4682,13 @@ module Aws::S3
|
|
4569
4682
|
# @option params [String] :request_payer
|
4570
4683
|
# Confirms that the requester knows that she or he will be charged for
|
4571
4684
|
# the request. Bucket owners need not specify this parameter in their
|
4572
|
-
# requests.
|
4573
|
-
# buckets
|
4574
|
-
#
|
4685
|
+
# requests. For information about downloading objects from Requester
|
4686
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4687
|
+
# in the *Amazon S3 Developer Guide*.
|
4688
|
+
#
|
4689
|
+
#
|
4690
|
+
#
|
4691
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4575
4692
|
#
|
4576
4693
|
# @return [Types::GetObjectAclOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4577
4694
|
#
|
@@ -4670,8 +4787,20 @@ module Aws::S3
|
|
4670
4787
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
4671
4788
|
#
|
4672
4789
|
# @option params [required, String] :bucket
|
4673
|
-
# The bucket containing the object whose Legal Hold status you want
|
4674
|
-
# retrieve.
|
4790
|
+
# The bucket name containing the object whose Legal Hold status you want
|
4791
|
+
# to retrieve.
|
4792
|
+
#
|
4793
|
+
# When using this API with an access point, you must direct requests to
|
4794
|
+
# the access point hostname. The access point hostname takes the form
|
4795
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4796
|
+
# When using this operation using an access point through the AWS SDKs,
|
4797
|
+
# you provide the access point ARN in place of the bucket name. For more
|
4798
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
4799
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
4800
|
+
#
|
4801
|
+
#
|
4802
|
+
#
|
4803
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4675
4804
|
#
|
4676
4805
|
# @option params [required, String] :key
|
4677
4806
|
# The key name for the object whose Legal Hold status you want to
|
@@ -4684,9 +4813,13 @@ module Aws::S3
|
|
4684
4813
|
# @option params [String] :request_payer
|
4685
4814
|
# Confirms that the requester knows that she or he will be charged for
|
4686
4815
|
# the request. Bucket owners need not specify this parameter in their
|
4687
|
-
# requests.
|
4688
|
-
# buckets
|
4689
|
-
#
|
4816
|
+
# requests. For information about downloading objects from Requester
|
4817
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4818
|
+
# in the *Amazon S3 Developer Guide*.
|
4819
|
+
#
|
4820
|
+
#
|
4821
|
+
#
|
4822
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4690
4823
|
#
|
4691
4824
|
# @return [Types::GetObjectLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4692
4825
|
#
|
@@ -4760,8 +4893,20 @@ module Aws::S3
|
|
4760
4893
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
4761
4894
|
#
|
4762
4895
|
# @option params [required, String] :bucket
|
4763
|
-
# The bucket containing the object whose retention settings you
|
4764
|
-
# retrieve.
|
4896
|
+
# The bucket name containing the object whose retention settings you
|
4897
|
+
# want to retrieve.
|
4898
|
+
#
|
4899
|
+
# When using this API with an access point, you must direct requests to
|
4900
|
+
# the access point hostname. The access point hostname takes the form
|
4901
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4902
|
+
# When using this operation using an access point through the AWS SDKs,
|
4903
|
+
# you provide the access point ARN in place of the bucket name. For more
|
4904
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
4905
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
4906
|
+
#
|
4907
|
+
#
|
4908
|
+
#
|
4909
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4765
4910
|
#
|
4766
4911
|
# @option params [required, String] :key
|
4767
4912
|
# The key name for the object whose retention settings you want to
|
@@ -4774,9 +4919,13 @@ module Aws::S3
|
|
4774
4919
|
# @option params [String] :request_payer
|
4775
4920
|
# Confirms that the requester knows that she or he will be charged for
|
4776
4921
|
# the request. Bucket owners need not specify this parameter in their
|
4777
|
-
# requests.
|
4778
|
-
# buckets
|
4779
|
-
#
|
4922
|
+
# requests. For information about downloading objects from Requester
|
4923
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
4924
|
+
# in the *Amazon S3 Developer Guide*.
|
4925
|
+
#
|
4926
|
+
#
|
4927
|
+
#
|
4928
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4780
4929
|
#
|
4781
4930
|
# @return [Types::GetObjectRetentionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4782
4931
|
#
|
@@ -4835,6 +4984,18 @@ module Aws::S3
|
|
4835
4984
|
# The bucket name containing the object for which to get the tagging
|
4836
4985
|
# information.
|
4837
4986
|
#
|
4987
|
+
# When using this API with an access point, you must direct requests to
|
4988
|
+
# the access point hostname. The access point hostname takes the form
|
4989
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
4990
|
+
# When using this operation using an access point through the AWS SDKs,
|
4991
|
+
# you provide the access point ARN in place of the bucket name. For more
|
4992
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
4993
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
4994
|
+
#
|
4995
|
+
#
|
4996
|
+
#
|
4997
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
4998
|
+
#
|
4838
4999
|
# @option params [required, String] :key
|
4839
5000
|
# Object key for which to get the tagging information.
|
4840
5001
|
#
|
@@ -4951,9 +5112,13 @@ module Aws::S3
|
|
4951
5112
|
# @option params [String] :request_payer
|
4952
5113
|
# Confirms that the requester knows that she or he will be charged for
|
4953
5114
|
# the request. Bucket owners need not specify this parameter in their
|
4954
|
-
# requests.
|
4955
|
-
# buckets
|
4956
|
-
#
|
5115
|
+
# requests. For information about downloading objects from Requester
|
5116
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5117
|
+
# in the *Amazon S3 Developer Guide*.
|
5118
|
+
#
|
5119
|
+
#
|
5120
|
+
#
|
5121
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
4957
5122
|
#
|
4958
5123
|
# @return [Types::GetObjectTorrentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4959
5124
|
#
|
@@ -4997,7 +5162,7 @@ module Aws::S3
|
|
4997
5162
|
end
|
4998
5163
|
|
4999
5164
|
# Retrieves the `PublicAccessBlock` configuration for an Amazon S3
|
5000
|
-
# bucket.
|
5165
|
+
# bucket. To use this operation, you must have the
|
5001
5166
|
# `s3:GetBucketPublicAccessBlock` permission. For more information about
|
5002
5167
|
# Amazon S3 permissions, see [Specifying Permissions in a Policy][1].
|
5003
5168
|
#
|
@@ -5170,10 +5335,10 @@ module Aws::S3
|
|
5170
5335
|
# on whether you also have the s3:ListBucket permission.
|
5171
5336
|
#
|
5172
5337
|
# * If you have the `s3:ListBucket` permission on the bucket, Amazon S3
|
5173
|
-
#
|
5338
|
+
# returns an HTTP status code 404 ("no such key") error.
|
5174
5339
|
#
|
5175
|
-
# * If you don’t have the `s3:ListBucket` permission, Amazon S3
|
5176
|
-
#
|
5340
|
+
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
|
5341
|
+
# an HTTP status code 403 ("access denied") error.
|
5177
5342
|
#
|
5178
5343
|
# The following operation is related to `HeadObject`\:
|
5179
5344
|
#
|
@@ -5212,34 +5377,38 @@ module Aws::S3
|
|
5212
5377
|
#
|
5213
5378
|
# @option params [String] :range
|
5214
5379
|
# Downloads the specified range bytes of an object. For more information
|
5215
|
-
# about the HTTP Range header,
|
5216
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
5380
|
+
# about the HTTP Range header, see
|
5381
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
5217
5382
|
#
|
5218
5383
|
# @option params [String] :version_id
|
5219
5384
|
# VersionId used to reference a specific version of the object.
|
5220
5385
|
#
|
5221
5386
|
# @option params [String] :sse_customer_algorithm
|
5222
|
-
# Specifies the algorithm to use to when encrypting the object (
|
5223
|
-
# AES256).
|
5387
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
5388
|
+
# example, AES256).
|
5224
5389
|
#
|
5225
5390
|
# @option params [String] :sse_customer_key
|
5226
5391
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
5227
5392
|
# encrypting data. This value is used to store the object and then it is
|
5228
|
-
# discarded; Amazon does not store the encryption key. The key must
|
5229
|
-
# appropriate for use with the algorithm specified in the
|
5230
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
5393
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
5394
|
+
# be appropriate for use with the algorithm specified in the
|
5395
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
5231
5396
|
#
|
5232
5397
|
# @option params [String] :sse_customer_key_md5
|
5233
5398
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
5234
5399
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
5235
|
-
# ensure the encryption key was transmitted without error.
|
5400
|
+
# ensure that the encryption key was transmitted without error.
|
5236
5401
|
#
|
5237
5402
|
# @option params [String] :request_payer
|
5238
5403
|
# Confirms that the requester knows that she or he will be charged for
|
5239
5404
|
# the request. Bucket owners need not specify this parameter in their
|
5240
|
-
# requests.
|
5241
|
-
# buckets
|
5242
|
-
#
|
5405
|
+
# requests. For information about downloading objects from Requester
|
5406
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
5407
|
+
# in the *Amazon S3 Developer Guide*.
|
5408
|
+
#
|
5409
|
+
#
|
5410
|
+
#
|
5411
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
5243
5412
|
#
|
5244
5413
|
# @option params [Integer] :part_number
|
5245
5414
|
# Part number of the object being read. This is a positive integer
|
@@ -5730,6 +5899,18 @@ module Aws::S3
|
|
5730
5899
|
# @option params [required, String] :bucket
|
5731
5900
|
# Name of the bucket to which the multipart upload was initiated.
|
5732
5901
|
#
|
5902
|
+
# When using this API with an access point, you must direct requests to
|
5903
|
+
# the access point hostname. The access point hostname takes the form
|
5904
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5905
|
+
# When using this operation using an access point through the AWS SDKs,
|
5906
|
+
# you provide the access point ARN in place of the bucket name. For more
|
5907
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
5908
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
5909
|
+
#
|
5910
|
+
#
|
5911
|
+
#
|
5912
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
5913
|
+
#
|
5733
5914
|
# @option params [String] :delimiter
|
5734
5915
|
# Character you use to group keys.
|
5735
5916
|
#
|
@@ -5778,7 +5959,7 @@ module Aws::S3
|
|
5778
5959
|
# upload-id-marker parameter is ignored. Otherwise, any multipart
|
5779
5960
|
# uploads for a key equal to the key-marker might be included in the
|
5780
5961
|
# list only if they have an upload ID lexicographically greater than the
|
5781
|
-
# specified upload-id-marker
|
5962
|
+
# specified `upload-id-marker`.
|
5782
5963
|
#
|
5783
5964
|
# @return [Types::ListMultipartUploadsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5784
5965
|
#
|
@@ -5959,7 +6140,19 @@ module Aws::S3
|
|
5959
6140
|
# * DeleteObject
|
5960
6141
|
#
|
5961
6142
|
# @option params [required, String] :bucket
|
5962
|
-
# The name
|
6143
|
+
# The bucket name that contains the objects.
|
6144
|
+
#
|
6145
|
+
# When using this API with an access point, you must direct requests to
|
6146
|
+
# the access point hostname. The access point hostname takes the form
|
6147
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6148
|
+
# When using this operation using an access point through the AWS SDKs,
|
6149
|
+
# you provide the access point ARN in place of the bucket name. For more
|
6150
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
6151
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
6152
|
+
#
|
6153
|
+
#
|
6154
|
+
#
|
6155
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
5963
6156
|
#
|
5964
6157
|
# @option params [String] :delimiter
|
5965
6158
|
# A delimiter is a character that you specify to group keys. All keys
|
@@ -6112,7 +6305,7 @@ module Aws::S3
|
|
6112
6305
|
req.send_request(options)
|
6113
6306
|
end
|
6114
6307
|
|
6115
|
-
# Returns some or all (up to
|
6308
|
+
# Returns some or all (up to 1,000) of the objects in a bucket. You can
|
6116
6309
|
# use the request parameters as selection criteria to return a subset of
|
6117
6310
|
# the objects in a bucket. A 200 OK response can contain valid or
|
6118
6311
|
# invalid XML. Be sure to design your application to parse the contents
|
@@ -6263,7 +6456,7 @@ module Aws::S3
|
|
6263
6456
|
# invalid XML. Make sure to design your application to parse the
|
6264
6457
|
# contents of the response and handle it appropriately.
|
6265
6458
|
#
|
6266
|
-
# To use
|
6459
|
+
# To use this operation, you must have READ access to the bucket.
|
6267
6460
|
#
|
6268
6461
|
# To use this operation in an AWS Identity and Access Management (IAM)
|
6269
6462
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
@@ -6293,7 +6486,19 @@ module Aws::S3
|
|
6293
6486
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
6294
6487
|
#
|
6295
6488
|
# @option params [required, String] :bucket
|
6296
|
-
#
|
6489
|
+
# Bucket name to list.
|
6490
|
+
#
|
6491
|
+
# When using this API with an access point, you must direct requests to
|
6492
|
+
# the access point hostname. The access point hostname takes the form
|
6493
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6494
|
+
# When using this operation using an access point through the AWS SDKs,
|
6495
|
+
# you provide the access point ARN in place of the bucket name. For more
|
6496
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
6497
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
6498
|
+
#
|
6499
|
+
#
|
6500
|
+
#
|
6501
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6297
6502
|
#
|
6298
6503
|
# @option params [String] :delimiter
|
6299
6504
|
# A delimiter is a character you use to group keys.
|
@@ -6316,7 +6521,7 @@ module Aws::S3
|
|
6316
6521
|
# @option params [Boolean] :fetch_owner
|
6317
6522
|
# The owner field is not present in listV2 by default, if you want to
|
6318
6523
|
# return owner field with each key in the result then set the fetch
|
6319
|
-
# owner field to true
|
6524
|
+
# owner field to true.
|
6320
6525
|
#
|
6321
6526
|
# @option params [String] :start_after
|
6322
6527
|
# StartAfter is where you want Amazon S3 to start listing from. Amazon
|
@@ -6463,7 +6668,19 @@ module Aws::S3
|
|
6463
6668
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html
|
6464
6669
|
#
|
6465
6670
|
# @option params [required, String] :bucket
|
6466
|
-
# Name of the bucket to which the parts are being uploaded
|
6671
|
+
# Name of the bucket to which the parts are being uploaded.
|
6672
|
+
#
|
6673
|
+
# When using this API with an access point, you must direct requests to
|
6674
|
+
# the access point hostname. The access point hostname takes the form
|
6675
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6676
|
+
# When using this operation using an access point through the AWS SDKs,
|
6677
|
+
# you provide the access point ARN in place of the bucket name. For more
|
6678
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
6679
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
6680
|
+
#
|
6681
|
+
#
|
6682
|
+
#
|
6683
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
6467
6684
|
#
|
6468
6685
|
# @option params [required, String] :key
|
6469
6686
|
# Object key for which the multipart upload was initiated.
|
@@ -6482,9 +6699,13 @@ module Aws::S3
|
|
6482
6699
|
# @option params [String] :request_payer
|
6483
6700
|
# Confirms that the requester knows that she or he will be charged for
|
6484
6701
|
# the request. Bucket owners need not specify this parameter in their
|
6485
|
-
# requests.
|
6486
|
-
# buckets
|
6487
|
-
#
|
6702
|
+
# requests. For information about downloading objects from Requester
|
6703
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
6704
|
+
# in the *Amazon S3 Developer Guide*.
|
6705
|
+
#
|
6706
|
+
#
|
6707
|
+
#
|
6708
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
6488
6709
|
#
|
6489
6710
|
# @return [Types::ListPartsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6490
6711
|
#
|
@@ -6656,7 +6877,7 @@ module Aws::S3
|
|
6656
6877
|
|
6657
6878
|
# Sets the permissions on an existing bucket using access control lists
|
6658
6879
|
# (ACL). For more information, see [Using ACLs][1]. To set the ACL of a
|
6659
|
-
# bucket, you must have
|
6880
|
+
# bucket, you must have `WRITE_ACP` permission.
|
6660
6881
|
#
|
6661
6882
|
# You can use one of the following two ways to set a bucket's
|
6662
6883
|
# permissions:
|
@@ -6680,18 +6901,18 @@ module Aws::S3
|
|
6680
6901
|
# You can set access permissions using one of the following methods:
|
6681
6902
|
#
|
6682
6903
|
# * Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
|
6683
|
-
# supports a set of predefined ACLs, known as canned ACLs
|
6684
|
-
# ACL has a predefined set of grantees and permissions. Specify
|
6685
|
-
# canned ACL name as the value of x-amz-acl
|
6686
|
-
# you cannot use other access control
|
6904
|
+
# supports a set of predefined ACLs, known as *canned ACLs*. Each
|
6905
|
+
# canned ACL has a predefined set of grantees and permissions. Specify
|
6906
|
+
# the canned ACL name as the value of `x-amz-acl`. If you use this
|
6907
|
+
# header, you cannot use other access control-specific headers in your
|
6687
6908
|
# request. For more information, see [Canned ACL][2].
|
6688
6909
|
#
|
6689
6910
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
6690
6911
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
6691
|
-
# `x-amz-grant-full-control` headers. When using these headers you
|
6692
|
-
# specify explicit access permissions and grantees (AWS accounts or
|
6912
|
+
# `x-amz-grant-full-control` headers. When using these headers, you
|
6913
|
+
# specify explicit access permissions and grantees (AWS accounts or
|
6693
6914
|
# Amazon S3 groups) who will receive the permission. If you use these
|
6694
|
-
# ACL
|
6915
|
+
# ACL-specific headers, you cannot use the `x-amz-acl` header to set a
|
6695
6916
|
# canned ACL. These parameters map to the set of permissions that
|
6696
6917
|
# Amazon S3 supports in an ACL. For more information, see [Access
|
6697
6918
|
# Control List (ACL) Overview][3].
|
@@ -6699,15 +6920,15 @@ module Aws::S3
|
|
6699
6920
|
# You specify each grantee as a type=value pair, where the type is one
|
6700
6921
|
# of the following:
|
6701
6922
|
#
|
6702
|
-
# * emailAddress – if the value specified is the email address of an
|
6923
|
+
# * `emailAddress` – if the value specified is the email address of an
|
6703
6924
|
# AWS account
|
6704
6925
|
#
|
6705
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
6926
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
6706
6927
|
# account
|
6707
6928
|
#
|
6708
|
-
# * uri – if you are granting permissions to a predefined group
|
6929
|
+
# * `uri` – if you are granting permissions to a predefined group
|
6709
6930
|
#
|
6710
|
-
# For example, the following x-amz-grant-write header grants create,
|
6931
|
+
# For example, the following `x-amz-grant-write` header grants create,
|
6711
6932
|
# overwrite, and delete objects permission to LogDelivery group
|
6712
6933
|
# predefined by Amazon S3 and two AWS accounts identified by their
|
6713
6934
|
# email addresses.
|
@@ -6855,13 +7076,13 @@ module Aws::S3
|
|
6855
7076
|
# configurations per bucket.
|
6856
7077
|
#
|
6857
7078
|
# You can choose to have storage class analysis export analysis reports
|
6858
|
-
# to a comma-separated values (CSV) flat file
|
7079
|
+
# sent to a comma-separated values (CSV) flat file. See the `DataExport`
|
6859
7080
|
# request element. Reports are updated daily and are based on the object
|
6860
|
-
# filters you configure. When selecting data export you specify a
|
6861
|
-
# destination bucket and optional destination prefix where the file
|
6862
|
-
# written. You can export the data to a destination bucket in a
|
7081
|
+
# filters that you configure. When selecting data export, you specify a
|
7082
|
+
# destination bucket and an optional destination prefix where the file
|
7083
|
+
# is written. You can export the data to a destination bucket in a
|
6863
7084
|
# different account. However, the destination bucket must be in the same
|
6864
|
-
#
|
7085
|
+
# Region as the bucket that you are making the PUT analytics
|
6865
7086
|
# configuration to. For more information, see [Amazon S3 Analytics –
|
6866
7087
|
# Storage Class Analysis][1].
|
6867
7088
|
#
|
@@ -6999,7 +7220,7 @@ module Aws::S3
|
|
6999
7220
|
#
|
7000
7221
|
# * The request's `Origin` header must match `AllowedOrigin` elements.
|
7001
7222
|
#
|
7002
|
-
# * The request method (for example, GET, PUT, HEAD and so on) or the
|
7223
|
+
# * The request method (for example, GET, PUT, HEAD, and so on) or the
|
7003
7224
|
# `Access-Control-Request-Method` header in case of a pre-flight
|
7004
7225
|
# `OPTIONS` request must be one of the `AllowedMethod` elements.
|
7005
7226
|
#
|
@@ -7028,8 +7249,8 @@ module Aws::S3
|
|
7028
7249
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
7029
7250
|
# Describes the cross-origin access configuration for objects in an
|
7030
7251
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
7031
|
-
# Resource Sharing][1] in the Amazon Simple Storage Service Developer
|
7032
|
-
# Guide
|
7252
|
+
# Resource Sharing][1] in the *Amazon Simple Storage Service Developer
|
7253
|
+
# Guide*.
|
7033
7254
|
#
|
7034
7255
|
#
|
7035
7256
|
#
|
@@ -7122,12 +7343,7 @@ module Aws::S3
|
|
7122
7343
|
#
|
7123
7344
|
# This implementation of the `PUT` operation sets default encryption for
|
7124
7345
|
# a buckets using server-side encryption with Amazon S3-managed keys
|
7125
|
-
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS) bucket.
|
7126
|
-
# information about the Amazon S3 default encryption feature, see As a
|
7127
|
-
# security precaution, the root user of the AWS account that owns a
|
7128
|
-
# bucket can always use this operation, even if the policy explicitly
|
7129
|
-
# denies the root user the ability to perform this action. in the
|
7130
|
-
# *Amazon Simple Storage Service Developer Guide*.
|
7346
|
+
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS) bucket.
|
7131
7347
|
#
|
7132
7348
|
# This operation requires AWS Signature Version 4. For more information,
|
7133
7349
|
# see [ Authenticating Requests (AWS Signature Version
|
@@ -7622,8 +7838,8 @@ module Aws::S3
|
|
7622
7838
|
# logging status of a bucket, you must be the bucket owner.
|
7623
7839
|
#
|
7624
7840
|
# The bucket owner is automatically granted FULL\_CONTROL to all logs.
|
7625
|
-
# You use the Grantee request element to grant access to other people.
|
7626
|
-
# The Permissions request element specifies the kind of access the
|
7841
|
+
# You use the `Grantee` request element to grant access to other people.
|
7842
|
+
# The `Permissions` request element specifies the kind of access the
|
7627
7843
|
# grantee has to the logs.
|
7628
7844
|
#
|
7629
7845
|
# **Grantee Values**
|
@@ -7758,7 +7974,7 @@ module Aws::S3
|
|
7758
7974
|
# they are erased.
|
7759
7975
|
#
|
7760
7976
|
# To use this operation, you must have permissions to perform the
|
7761
|
-
# s3:PutMetricsConfiguration action. The bucket owner has this
|
7977
|
+
# `s3:PutMetricsConfiguration` action. The bucket owner has this
|
7762
7978
|
# permission by default. The bucket owner can grant this permission to
|
7763
7979
|
# others. For more information about permissions, see [Permissions
|
7764
7980
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
@@ -7780,7 +7996,7 @@ module Aws::S3
|
|
7780
7996
|
#
|
7781
7997
|
# * Error code: `TooManyConfigurations`
|
7782
7998
|
#
|
7783
|
-
# * Description:You are attempting to create a new configuration but
|
7999
|
+
# * Description: You are attempting to create a new configuration but
|
7784
8000
|
# have already reached the 1,000-configuration limit.
|
7785
8001
|
#
|
7786
8002
|
# * HTTP Status Code: HTTP 400 Bad Request
|
@@ -7938,11 +8154,11 @@ module Aws::S3
|
|
7938
8154
|
#
|
7939
8155
|
# If the configuration in the request body includes only one
|
7940
8156
|
# `TopicConfiguration` specifying only the
|
7941
|
-
#
|
7942
|
-
# include the
|
7943
|
-
# ID of the test notification sent to topic.
|
8157
|
+
# `s3:ReducedRedundancyLostObject` event type, the response will also
|
8158
|
+
# include the `x-amz-sns-test-message-id` header containing the message
|
8159
|
+
# ID of the test notification sent to the topic.
|
7944
8160
|
#
|
7945
|
-
# The following
|
8161
|
+
# The following operation is related to
|
7946
8162
|
# `PutBucketNotificationConfiguration`\:
|
7947
8163
|
#
|
7948
8164
|
# * GetBucketNotificationConfiguration
|
@@ -8169,29 +8385,8 @@ module Aws::S3
|
|
8169
8385
|
# about replication configuration, see [Replicating Objects Created with
|
8170
8386
|
# SSE Using CMKs stored in AWS KMS][6].
|
8171
8387
|
#
|
8172
|
-
# `PutBucketReplication`
|
8173
|
-
#
|
8174
|
-
# * Error code: `InvalidRequest`
|
8175
|
-
#
|
8176
|
-
# * Description: If the <Owner> in
|
8177
|
-
# <AccessControlTranslation> has a value, the <Account>
|
8178
|
-
# element must be specified.
|
8179
|
-
#
|
8180
|
-
# * HTTP 400
|
8181
|
-
#
|
8182
|
-
# * Error code: `InvalidArgument`
|
8183
|
-
#
|
8184
|
-
# * Description: The <Account> element is empty. It must contain
|
8185
|
-
# a valid account ID.
|
8186
|
-
#
|
8187
|
-
# * HTTP 400
|
8188
|
-
#
|
8189
|
-
# * Error code: `InvalidArgument`
|
8190
|
-
#
|
8191
|
-
# * Description: The AWS account specified in the <Account>
|
8192
|
-
# element must match the destination bucket owner.
|
8193
|
-
#
|
8194
|
-
# * HTTP 400
|
8388
|
+
# For information on `PutBucketReplication` errors, see
|
8389
|
+
# ReplicationErrorCodeList
|
8195
8390
|
#
|
8196
8391
|
# The following operations are related to `PutBucketReplication`\:
|
8197
8392
|
#
|
@@ -8476,7 +8671,7 @@ module Aws::S3
|
|
8476
8671
|
# [1]: http://www.ietf.org/rfc/rfc1864.txt
|
8477
8672
|
#
|
8478
8673
|
# @option params [required, Types::Tagging] :tagging
|
8479
|
-
# Container for the TagSet and Tag elements.
|
8674
|
+
# Container for the `TagSet` and `Tag` elements.
|
8480
8675
|
#
|
8481
8676
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
8482
8677
|
#
|
@@ -8542,7 +8737,7 @@ module Aws::S3
|
|
8542
8737
|
#
|
8543
8738
|
# If the bucket owner enables MFA Delete in the bucket versioning
|
8544
8739
|
# configuration, the bucket owner must include the `x-amz-mfa request`
|
8545
|
-
# header and the Status and the `MfaDelete` request elements in a
|
8740
|
+
# header and the `Status` and the `MfaDelete` request elements in a
|
8546
8741
|
# request to set the versioning state of the bucket.
|
8547
8742
|
#
|
8548
8743
|
# If you have an object expiration lifecycle policy in your
|
@@ -8639,13 +8834,13 @@ module Aws::S3
|
|
8639
8834
|
# Because all requests are sent to another website, you don't need to
|
8640
8835
|
# provide index document name for the bucket.
|
8641
8836
|
#
|
8642
|
-
# * WebsiteConfiguration
|
8837
|
+
# * `WebsiteConfiguration`
|
8643
8838
|
#
|
8644
|
-
# * RedirectAllRequestsTo
|
8839
|
+
# * `RedirectAllRequestsTo`
|
8645
8840
|
#
|
8646
|
-
# * HostName
|
8841
|
+
# * `HostName`
|
8647
8842
|
#
|
8648
|
-
# * Protocol
|
8843
|
+
# * `Protocol`
|
8649
8844
|
#
|
8650
8845
|
# If you want granular control over redirects, you can use the following
|
8651
8846
|
# elements to add routing rules that describe conditions for redirecting
|
@@ -8653,37 +8848,37 @@ module Aws::S3
|
|
8653
8848
|
# the website configuration must provide an index document for the
|
8654
8849
|
# bucket, because some requests might not be redirected.
|
8655
8850
|
#
|
8656
|
-
# * WebsiteConfiguration
|
8851
|
+
# * `WebsiteConfiguration`
|
8657
8852
|
#
|
8658
|
-
# * IndexDocument
|
8853
|
+
# * `IndexDocument`
|
8659
8854
|
#
|
8660
|
-
# * Suffix
|
8855
|
+
# * `Suffix`
|
8661
8856
|
#
|
8662
|
-
# * ErrorDocument
|
8857
|
+
# * `ErrorDocument`
|
8663
8858
|
#
|
8664
|
-
# * Key
|
8859
|
+
# * `Key`
|
8665
8860
|
#
|
8666
|
-
# * RoutingRules
|
8861
|
+
# * `RoutingRules`
|
8667
8862
|
#
|
8668
|
-
# * RoutingRule
|
8863
|
+
# * `RoutingRule`
|
8669
8864
|
#
|
8670
|
-
# * Condition
|
8865
|
+
# * `Condition`
|
8671
8866
|
#
|
8672
|
-
# * HttpErrorCodeReturnedEquals
|
8867
|
+
# * `HttpErrorCodeReturnedEquals`
|
8673
8868
|
#
|
8674
|
-
# * KeyPrefixEquals
|
8869
|
+
# * `KeyPrefixEquals`
|
8675
8870
|
#
|
8676
|
-
# * Redirect
|
8871
|
+
# * `Redirect`
|
8677
8872
|
#
|
8678
|
-
# * Protocol
|
8873
|
+
# * `Protocol`
|
8679
8874
|
#
|
8680
|
-
# * HostName
|
8875
|
+
# * `HostName`
|
8681
8876
|
#
|
8682
|
-
# * ReplaceKeyPrefixWith
|
8877
|
+
# * `ReplaceKeyPrefixWith`
|
8683
8878
|
#
|
8684
|
-
# * ReplaceKeyWith
|
8879
|
+
# * `ReplaceKeyWith`
|
8685
8880
|
#
|
8686
|
-
# * HttpRedirectCode
|
8881
|
+
# * `HttpRedirectCode`
|
8687
8882
|
#
|
8688
8883
|
#
|
8689
8884
|
#
|
@@ -8799,7 +8994,7 @@ module Aws::S3
|
|
8799
8994
|
# You can optionally request server-side encryption. With server-side
|
8800
8995
|
# encryption, Amazon S3 encrypts your data as it writes it to disks in
|
8801
8996
|
# its data centers and decrypts the data when you access it. You have
|
8802
|
-
# the option to provide your own encryption key or use AWS
|
8997
|
+
# the option to provide your own encryption key or use AWS managed
|
8803
8998
|
# encryption keys. For more information, see [Using Server-Side
|
8804
8999
|
# Encryption][2].
|
8805
9000
|
#
|
@@ -8827,13 +9022,13 @@ module Aws::S3
|
|
8827
9022
|
# server-side encryption. Server-side encryption is for data
|
8828
9023
|
# encryption at rest. Amazon S3 encrypts your data as it writes it to
|
8829
9024
|
# disks in its data centers and decrypts it when you access it. The
|
8830
|
-
# option you use depends on whether you want to use AWS
|
9025
|
+
# option you use depends on whether you want to use AWS managed
|
8831
9026
|
# encryption keys or provide your own encryption key.
|
8832
9027
|
#
|
8833
|
-
# * Use encryption keys managed Amazon S3 or customer master keys
|
8834
|
-
# (CMKs) stored in AWS Key Management Service (KMS) – If you
|
8835
|
-
# AWS to manage the keys used to encrypt data, specify the
|
8836
|
-
# headers in the request.
|
9028
|
+
# * Use encryption keys managed by Amazon S3 or customer master keys
|
9029
|
+
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
|
9030
|
+
# want AWS to manage the keys used to encrypt data, specify the
|
9031
|
+
# following headers in the request.
|
8837
9032
|
#
|
8838
9033
|
# * x-amz-server-side-encryption
|
8839
9034
|
#
|
@@ -8841,8 +9036,8 @@ module Aws::S3
|
|
8841
9036
|
#
|
8842
9037
|
# * x-amz-server-side-encryption-context
|
8843
9038
|
#
|
8844
|
-
# <note markdown="1"> If you specify x-amz-server-side-encryption:aws:kms
|
8845
|
-
# provide x-amz-server-side- encryption-aws-kms-key-id
|
9039
|
+
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
9040
|
+
# provide `x-amz-server-side- encryption-aws-kms-key-id`, Amazon S3
|
8846
9041
|
# uses the AWS managed CMK in AWS KMS to protect the data.
|
8847
9042
|
#
|
8848
9043
|
# </note>
|
@@ -8850,8 +9045,8 @@ module Aws::S3
|
|
8850
9045
|
# All GET and PUT requests for an object protected by AWS KMS fail
|
8851
9046
|
# if you don't make them with SSL or by using SigV4.
|
8852
9047
|
#
|
8853
|
-
# For more information
|
8854
|
-
# AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9048
|
+
# For more information about server-side encryption with CMKs stored
|
9049
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
8855
9050
|
# Encryption with CMKs stored in AWS][5].
|
8856
9051
|
#
|
8857
9052
|
# * Use customer-provided encryption keys – If you want to manage your
|
@@ -8864,9 +9059,9 @@ module Aws::S3
|
|
8864
9059
|
#
|
8865
9060
|
# * x-amz-server-side-encryption-customer-key-MD5
|
8866
9061
|
#
|
8867
|
-
# For more information
|
8868
|
-
# KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
8869
|
-
# with CMKs stored in AWS KMS][5].
|
9062
|
+
# For more information about server-side encryption with CMKs stored
|
9063
|
+
# in KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9064
|
+
# Encryption with CMKs stored in AWS KMS][5].
|
8870
9065
|
#
|
8871
9066
|
# Access-Control-List (ACL)-Specific Request Headers
|
8872
9067
|
#
|
@@ -8879,7 +9074,7 @@ module Aws::S3
|
|
8879
9074
|
# ACLs][6]. With this operation, you can grant access permissions
|
8880
9075
|
# using one of the following two methods:
|
8881
9076
|
#
|
8882
|
-
# * Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of
|
9077
|
+
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
8883
9078
|
# predefined ACLs, known as canned ACLs. Each canned ACL has a
|
8884
9079
|
# predefined set of grantees and permissions. For more information,
|
8885
9080
|
# see [Canned ACL][3].
|
@@ -8905,8 +9100,8 @@ module Aws::S3
|
|
8905
9100
|
# You specify each grantee as a type=value pair, where the type is
|
8906
9101
|
# one of the following:
|
8907
9102
|
#
|
8908
|
-
# * emailAddress – if the value specified is the email address of
|
8909
|
-
# AWS account
|
9103
|
+
# * `emailAddress` – if the value specified is the email address of
|
9104
|
+
# an AWS account
|
8910
9105
|
#
|
8911
9106
|
# Using email addresses to specify a grantee is only supported in
|
8912
9107
|
# the following AWS Regions:
|
@@ -8927,18 +9122,18 @@ module Aws::S3
|
|
8927
9122
|
#
|
8928
9123
|
# * South America (São Paulo)
|
8929
9124
|
#
|
8930
|
-
# For a list of all the Amazon S3 supported
|
9125
|
+
# For a list of all the Amazon S3 supported Regions and
|
8931
9126
|
# endpoints,
|
8932
9127
|
# see [Regions and Endpoints][7] in the AWS General Reference
|
8933
9128
|
#
|
8934
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
9129
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
8935
9130
|
# account
|
8936
9131
|
#
|
8937
|
-
# * uri – if you are granting permissions to a predefined group
|
9132
|
+
# * `uri` – if you are granting permissions to a predefined group
|
8938
9133
|
#
|
8939
|
-
# For example, the following x-amz-grant-read header grants the
|
8940
|
-
# accounts identified by email addresses permissions to read
|
8941
|
-
# data and its metadata:
|
9134
|
+
# For example, the following `x-amz-grant-read` header grants the
|
9135
|
+
# AWS accounts identified by email addresses permissions to read
|
9136
|
+
# object data and its metadata:
|
8942
9137
|
#
|
8943
9138
|
# `x-amz-grant-read: emailAddress="xyz@amazon.com",
|
8944
9139
|
# emailAddress="abc@amazon.com" `
|
@@ -8953,9 +9148,9 @@ module Aws::S3
|
|
8953
9148
|
# encryption keys or provide your own encryption key.
|
8954
9149
|
#
|
8955
9150
|
# * Use encryption keys managed by Amazon S3 or customer master keys
|
8956
|
-
# (CMKs) stored in AWS Key Management Service (KMS) – If you
|
8957
|
-
# AWS to manage the keys used to encrypt data, specify the
|
8958
|
-
# headers in the request.
|
9151
|
+
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
|
9152
|
+
# want AWS to manage the keys used to encrypt data, specify the
|
9153
|
+
# following headers in the request.
|
8959
9154
|
#
|
8960
9155
|
# * x-amz-server-side-encryption
|
8961
9156
|
#
|
@@ -8963,8 +9158,8 @@ module Aws::S3
|
|
8963
9158
|
#
|
8964
9159
|
# * x-amz-server-side-encryption-context
|
8965
9160
|
#
|
8966
|
-
# <note markdown="1"> If you specify x-amz-server-side-encryption:aws:kms
|
8967
|
-
# provide x-amz-server-side- encryption-aws-kms-key-id
|
9161
|
+
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
9162
|
+
# provide `x-amz-server-side- encryption-aws-kms-key-id`, Amazon S3
|
8968
9163
|
# uses the default AWS KMS CMK to protect the data.
|
8969
9164
|
#
|
8970
9165
|
# </note>
|
@@ -8972,8 +9167,8 @@ module Aws::S3
|
|
8972
9167
|
# All GET and PUT requests for an object protected by AWS KMS fail
|
8973
9168
|
# if you don't make them with SSL or by using SigV4.
|
8974
9169
|
#
|
8975
|
-
# For more information
|
8976
|
-
# AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9170
|
+
# For more information about server-side encryption with CMKs stored
|
9171
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
8977
9172
|
# Encryption with CMKs stored in AWS KMS][5].
|
8978
9173
|
#
|
8979
9174
|
# * Use customer-provided encryption keys – If you want to manage your
|
@@ -8991,8 +9186,8 @@ module Aws::S3
|
|
8991
9186
|
#
|
8992
9187
|
# * x-amz-server-side-encryption-customer-key-MD5
|
8993
9188
|
#
|
8994
|
-
# For more information
|
8995
|
-
# AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9189
|
+
# For more information about server-side encryption with CMKs stored
|
9190
|
+
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
8996
9191
|
# Encryption with CMKs stored in AWS KMS][5].
|
8997
9192
|
#
|
8998
9193
|
# **Storage Class Options**
|
@@ -9044,7 +9239,19 @@ module Aws::S3
|
|
9044
9239
|
# Object data.
|
9045
9240
|
#
|
9046
9241
|
# @option params [required, String] :bucket
|
9047
|
-
#
|
9242
|
+
# Bucket name to which the PUT operation was initiated.
|
9243
|
+
#
|
9244
|
+
# When using this API with an access point, you must direct requests to
|
9245
|
+
# the access point hostname. The access point hostname takes the form
|
9246
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9247
|
+
# When using this operation using an access point through the AWS SDKs,
|
9248
|
+
# you provide the access point ARN in place of the bucket name. For more
|
9249
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
9250
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
9251
|
+
#
|
9252
|
+
#
|
9253
|
+
#
|
9254
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9048
9255
|
#
|
9049
9256
|
# @option params [String] :cache_control
|
9050
9257
|
# Can be used to specify caching behavior along the request/reply chain.
|
@@ -9137,8 +9344,8 @@ module Aws::S3
|
|
9137
9344
|
# A map of metadata to store with the object in S3.
|
9138
9345
|
#
|
9139
9346
|
# @option params [String] :server_side_encryption
|
9140
|
-
# The
|
9141
|
-
# S3 (
|
9347
|
+
# The server-side encryption algorithm used when storing this object in
|
9348
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
9142
9349
|
#
|
9143
9350
|
# @option params [String] :storage_class
|
9144
9351
|
# If you don't specify, Standard is the default storage class. Amazon
|
@@ -9148,7 +9355,7 @@ module Aws::S3
|
|
9148
9355
|
# If the bucket is configured as a website, redirects requests for this
|
9149
9356
|
# object to another object in the same bucket or to an external URL.
|
9150
9357
|
# Amazon S3 stores the value of this header in the object metadata. For
|
9151
|
-
# information about object metadata, see .
|
9358
|
+
# information about object metadata, see [Object Key and Metadata][1].
|
9152
9359
|
#
|
9153
9360
|
# In the following example, the request header sets the redirect to an
|
9154
9361
|
# object (anotherPage.html) in the same bucket:
|
@@ -9161,41 +9368,42 @@ module Aws::S3
|
|
9161
9368
|
# `x-amz-website-redirect-location: http://www.example.com/`
|
9162
9369
|
#
|
9163
9370
|
# For more information about website hosting in Amazon S3, see [Hosting
|
9164
|
-
# Websites on Amazon S3][
|
9165
|
-
# Redirects][
|
9371
|
+
# Websites on Amazon S3][2] and [How to Configure Website Page
|
9372
|
+
# Redirects][3].
|
9166
9373
|
#
|
9167
9374
|
#
|
9168
9375
|
#
|
9169
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
9170
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
9376
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
|
9377
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
9378
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
9171
9379
|
#
|
9172
9380
|
# @option params [String] :sse_customer_algorithm
|
9173
|
-
# Specifies the algorithm to use to when encrypting the object (
|
9174
|
-
# AES256).
|
9381
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
9382
|
+
# example, AES256).
|
9175
9383
|
#
|
9176
9384
|
# @option params [String] :sse_customer_key
|
9177
9385
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
9178
9386
|
# encrypting data. This value is used to store the object and then it is
|
9179
|
-
# discarded; Amazon does not store the encryption key. The key must
|
9180
|
-
# appropriate for use with the algorithm specified in the
|
9181
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
9387
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
9388
|
+
# be appropriate for use with the algorithm specified in the
|
9389
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
9182
9390
|
#
|
9183
9391
|
# @option params [String] :sse_customer_key_md5
|
9184
9392
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
9185
9393
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
9186
|
-
# ensure the encryption key was transmitted without error.
|
9394
|
+
# ensure that the encryption key was transmitted without error.
|
9187
9395
|
#
|
9188
9396
|
# @option params [String] :ssekms_key_id
|
9189
|
-
# If
|
9190
|
-
# aws:kms
|
9397
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
9398
|
+
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
9191
9399
|
# Service (AWS KMS) customer master key (CMK) that was used for the
|
9192
9400
|
# object.
|
9193
9401
|
#
|
9194
|
-
# If the value of x-amz-server-side-encryption is aws:kms
|
9195
|
-
# specifies the ID of the AWS KMS CMK that will be used for the
|
9196
|
-
# If you specify x-amz-server-side-encryption:aws:kms
|
9197
|
-
# provide x-amz-server-side-encryption-aws-kms-key-id
|
9198
|
-
# the AWS managed CMK in AWS to protect the data.
|
9402
|
+
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
9403
|
+
# header specifies the ID of the AWS KMS CMK that will be used for the
|
9404
|
+
# object. If you specify `x-amz-server-side-encryption:aws:kms`, but do
|
9405
|
+
# not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
9406
|
+
# uses the AWS managed CMK in AWS to protect the data.
|
9199
9407
|
#
|
9200
9408
|
# @option params [String] :ssekms_encryption_context
|
9201
9409
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -9205,9 +9413,13 @@ module Aws::S3
|
|
9205
9413
|
# @option params [String] :request_payer
|
9206
9414
|
# Confirms that the requester knows that she or he will be charged for
|
9207
9415
|
# the request. Bucket owners need not specify this parameter in their
|
9208
|
-
# requests.
|
9209
|
-
# buckets
|
9210
|
-
#
|
9416
|
+
# requests. For information about downloading objects from Requester
|
9417
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9418
|
+
# in the *Amazon S3 Developer Guide*.
|
9419
|
+
#
|
9420
|
+
#
|
9421
|
+
#
|
9422
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9211
9423
|
#
|
9212
9424
|
# @option params [String] :tagging
|
9213
9425
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
@@ -9240,20 +9452,24 @@ module Aws::S3
|
|
9240
9452
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
9241
9453
|
#
|
9242
9454
|
#
|
9243
|
-
# @example Example: To
|
9455
|
+
# @example Example: To upload an object (specify optional headers)
|
9244
9456
|
#
|
9245
|
-
# # The following example
|
9457
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
9458
|
+
# # storage class and use server-side encryption.
|
9246
9459
|
#
|
9247
9460
|
# resp = client.put_object({
|
9248
|
-
# body: "
|
9461
|
+
# body: "HappyFace.jpg",
|
9249
9462
|
# bucket: "examplebucket",
|
9250
|
-
# key: "
|
9463
|
+
# key: "HappyFace.jpg",
|
9464
|
+
# server_side_encryption: "AES256",
|
9465
|
+
# storage_class: "STANDARD_IA",
|
9251
9466
|
# })
|
9252
9467
|
#
|
9253
9468
|
# resp.to_h outputs the following:
|
9254
9469
|
# {
|
9255
9470
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9256
|
-
#
|
9471
|
+
# server_side_encryption: "AES256",
|
9472
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9257
9473
|
# }
|
9258
9474
|
#
|
9259
9475
|
# @example Example: To upload an object and specify optional tags
|
@@ -9274,24 +9490,41 @@ module Aws::S3
|
|
9274
9490
|
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
9275
9491
|
# }
|
9276
9492
|
#
|
9277
|
-
# @example Example: To upload
|
9493
|
+
# @example Example: To upload object and specify user-defined metadata
|
9278
9494
|
#
|
9279
|
-
# # The following example
|
9280
|
-
# #
|
9495
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
9496
|
+
# # enabled, S3 returns version ID in response.
|
9281
9497
|
#
|
9282
9498
|
# resp = client.put_object({
|
9283
9499
|
# body: "filetoupload",
|
9284
9500
|
# bucket: "examplebucket",
|
9285
9501
|
# key: "exampleobject",
|
9286
|
-
#
|
9287
|
-
#
|
9502
|
+
# metadata: {
|
9503
|
+
# "metadata1" => "value1",
|
9504
|
+
# "metadata2" => "value2",
|
9505
|
+
# },
|
9288
9506
|
# })
|
9289
9507
|
#
|
9290
9508
|
# resp.to_h outputs the following:
|
9291
9509
|
# {
|
9292
9510
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9293
|
-
#
|
9294
|
-
#
|
9511
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
9512
|
+
# }
|
9513
|
+
#
|
9514
|
+
# @example Example: To create an object.
|
9515
|
+
#
|
9516
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
9517
|
+
#
|
9518
|
+
# resp = client.put_object({
|
9519
|
+
# body: "filetoupload",
|
9520
|
+
# bucket: "examplebucket",
|
9521
|
+
# key: "objectkey",
|
9522
|
+
# })
|
9523
|
+
#
|
9524
|
+
# resp.to_h outputs the following:
|
9525
|
+
# {
|
9526
|
+
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9527
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
9295
9528
|
# }
|
9296
9529
|
#
|
9297
9530
|
# @example Example: To upload an object
|
@@ -9329,45 +9562,24 @@ module Aws::S3
|
|
9329
9562
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
9330
9563
|
# }
|
9331
9564
|
#
|
9332
|
-
# @example Example: To upload an object
|
9333
|
-
#
|
9334
|
-
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
9335
|
-
# # storage class and use server-side encryption.
|
9336
|
-
#
|
9337
|
-
# resp = client.put_object({
|
9338
|
-
# body: "HappyFace.jpg",
|
9339
|
-
# bucket: "examplebucket",
|
9340
|
-
# key: "HappyFace.jpg",
|
9341
|
-
# server_side_encryption: "AES256",
|
9342
|
-
# storage_class: "STANDARD_IA",
|
9343
|
-
# })
|
9344
|
-
#
|
9345
|
-
# resp.to_h outputs the following:
|
9346
|
-
# {
|
9347
|
-
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9348
|
-
# server_side_encryption: "AES256",
|
9349
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9350
|
-
# }
|
9351
|
-
#
|
9352
|
-
# @example Example: To upload object and specify user-defined metadata
|
9565
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
9353
9566
|
#
|
9354
|
-
# # The following example
|
9355
|
-
# # enabled, S3 returns version ID in response.
|
9567
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
9568
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
9356
9569
|
#
|
9357
9570
|
# resp = client.put_object({
|
9358
9571
|
# body: "filetoupload",
|
9359
9572
|
# bucket: "examplebucket",
|
9360
9573
|
# key: "exampleobject",
|
9361
|
-
#
|
9362
|
-
#
|
9363
|
-
# "metadata2" => "value2",
|
9364
|
-
# },
|
9574
|
+
# server_side_encryption: "AES256",
|
9575
|
+
# tagging: "key1=value1&key2=value2",
|
9365
9576
|
# })
|
9366
9577
|
#
|
9367
9578
|
# resp.to_h outputs the following:
|
9368
9579
|
# {
|
9369
9580
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9370
|
-
#
|
9581
|
+
# server_side_encryption: "AES256",
|
9582
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9371
9583
|
# }
|
9372
9584
|
#
|
9373
9585
|
# @example Streaming a file from disk
|
@@ -9434,14 +9646,14 @@ module Aws::S3
|
|
9434
9646
|
req.send_request(options)
|
9435
9647
|
end
|
9436
9648
|
|
9437
|
-
#
|
9649
|
+
# Uses the `acl` subresource to set the access control list (ACL)
|
9438
9650
|
# permissions for an object that already exists in a bucket. You must
|
9439
|
-
# have
|
9651
|
+
# have `WRITE_ACP` permission to set the ACL of an object.
|
9440
9652
|
#
|
9441
|
-
# Depending on your application needs, you
|
9653
|
+
# Depending on your application needs, you can choose to set the ACL on
|
9442
9654
|
# an object using either the request body or the headers. For example,
|
9443
9655
|
# if you have an existing application that updates a bucket ACL using
|
9444
|
-
# the request body,
|
9656
|
+
# the request body, you can continue to use that approach.
|
9445
9657
|
#
|
9446
9658
|
# **Access Permissions**
|
9447
9659
|
#
|
@@ -9450,16 +9662,16 @@ module Aws::S3
|
|
9450
9662
|
# * Specify a canned ACL with the `x-amz-acl` request header. Amazon S3
|
9451
9663
|
# supports a set of predefined ACLs, known as canned ACLs. Each canned
|
9452
9664
|
# ACL has a predefined set of grantees and permissions. Specify the
|
9453
|
-
# canned ACL name as the value of x-amz-
|
9454
|
-
# you cannot use other access control
|
9665
|
+
# canned ACL name as the value of `x-amz-ac`l. If you use this header,
|
9666
|
+
# you cannot use other access control-specific headers in your
|
9455
9667
|
# request. For more information, see [Canned ACL][1].
|
9456
9668
|
#
|
9457
9669
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
9458
9670
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
9459
|
-
# `x-amz-grant-full-control` headers. When using these headers you
|
9460
|
-
# specify explicit access permissions and grantees (AWS accounts or
|
9671
|
+
# `x-amz-grant-full-control` headers. When using these headers, you
|
9672
|
+
# specify explicit access permissions and grantees (AWS accounts or
|
9461
9673
|
# Amazon S3 groups) who will receive the permission. If you use these
|
9462
|
-
# ACL
|
9674
|
+
# ACL-specific headers, you cannot use `x-amz-acl` header to set a
|
9463
9675
|
# canned ACL. These parameters map to the set of permissions that
|
9464
9676
|
# Amazon S3 supports in an ACL. For more information, see [Access
|
9465
9677
|
# Control List (ACL) Overview][2].
|
@@ -9467,15 +9679,15 @@ module Aws::S3
|
|
9467
9679
|
# You specify each grantee as a type=value pair, where the type is one
|
9468
9680
|
# of the following:
|
9469
9681
|
#
|
9470
|
-
# * emailAddress – if the value specified is the email address of an
|
9682
|
+
# * `emailAddress` – if the value specified is the email address of an
|
9471
9683
|
# AWS account
|
9472
9684
|
#
|
9473
|
-
# * id – if the value specified is the canonical user ID of an AWS
|
9685
|
+
# * `id` – if the value specified is the canonical user ID of an AWS
|
9474
9686
|
# account
|
9475
9687
|
#
|
9476
|
-
# * uri – if you are granting permissions to a predefined group
|
9688
|
+
# * `uri` – if you are granting permissions to a predefined group
|
9477
9689
|
#
|
9478
|
-
# For example, the following x-amz-grant-read header grants list
|
9690
|
+
# For example, the following `x-amz-grant-read` header grants list
|
9479
9691
|
# objects permission to the two AWS accounts identified by their email
|
9480
9692
|
# addresses.
|
9481
9693
|
#
|
@@ -9504,7 +9716,7 @@ module Aws::S3
|
|
9504
9716
|
# xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
9505
9717
|
# </Grantee>`
|
9506
9718
|
#
|
9507
|
-
# DisplayName is optional and ignored in the request
|
9719
|
+
# DisplayName is optional and ignored in the request.
|
9508
9720
|
#
|
9509
9721
|
# * By URI:
|
9510
9722
|
#
|
@@ -9530,7 +9742,7 @@ module Aws::S3
|
|
9530
9742
|
#
|
9531
9743
|
# @option params [String] :acl
|
9532
9744
|
# The canned ACL to apply to the object. For more information, see
|
9533
|
-
# [Canned ACL][1]
|
9745
|
+
# [Canned ACL][1].
|
9534
9746
|
#
|
9535
9747
|
#
|
9536
9748
|
#
|
@@ -9541,7 +9753,20 @@ module Aws::S3
|
|
9541
9753
|
# grantee.
|
9542
9754
|
#
|
9543
9755
|
# @option params [required, String] :bucket
|
9544
|
-
# The name
|
9756
|
+
# The bucket name that contains the object to which you want to attach
|
9757
|
+
# the ACL.
|
9758
|
+
#
|
9759
|
+
# When using this API with an access point, you must direct requests to
|
9760
|
+
# the access point hostname. The access point hostname takes the form
|
9761
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9762
|
+
# When using this operation using an access point through the AWS SDKs,
|
9763
|
+
# you provide the access point ARN in place of the bucket name. For more
|
9764
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
9765
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
9766
|
+
#
|
9767
|
+
#
|
9768
|
+
#
|
9769
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9545
9770
|
#
|
9546
9771
|
# @option params [String] :content_md5
|
9547
9772
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -9576,9 +9801,13 @@ module Aws::S3
|
|
9576
9801
|
# @option params [String] :request_payer
|
9577
9802
|
# Confirms that the requester knows that she or he will be charged for
|
9578
9803
|
# the request. Bucket owners need not specify this parameter in their
|
9579
|
-
# requests.
|
9580
|
-
# buckets
|
9581
|
-
#
|
9804
|
+
# requests. For information about downloading objects from Requester
|
9805
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9806
|
+
# in the *Amazon S3 Developer Guide*.
|
9807
|
+
#
|
9808
|
+
#
|
9809
|
+
#
|
9810
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9582
9811
|
#
|
9583
9812
|
# @option params [String] :version_id
|
9584
9813
|
# VersionId used to reference a specific version of the object.
|
@@ -9666,8 +9895,20 @@ module Aws::S3
|
|
9666
9895
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
9667
9896
|
#
|
9668
9897
|
# @option params [required, String] :bucket
|
9669
|
-
# The bucket containing the object that you want to place a Legal
|
9670
|
-
# on.
|
9898
|
+
# The bucket name containing the object that you want to place a Legal
|
9899
|
+
# Hold on.
|
9900
|
+
#
|
9901
|
+
# When using this API with an access point, you must direct requests to
|
9902
|
+
# the access point hostname. The access point hostname takes the form
|
9903
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
9904
|
+
# When using this operation using an access point through the AWS SDKs,
|
9905
|
+
# you provide the access point ARN in place of the bucket name. For more
|
9906
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
9907
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
9908
|
+
#
|
9909
|
+
#
|
9910
|
+
#
|
9911
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9671
9912
|
#
|
9672
9913
|
# @option params [required, String] :key
|
9673
9914
|
# The key name for the object that you want to place a Legal Hold on.
|
@@ -9679,9 +9920,13 @@ module Aws::S3
|
|
9679
9920
|
# @option params [String] :request_payer
|
9680
9921
|
# Confirms that the requester knows that she or he will be charged for
|
9681
9922
|
# the request. Bucket owners need not specify this parameter in their
|
9682
|
-
# requests.
|
9683
|
-
# buckets
|
9684
|
-
#
|
9923
|
+
# requests. For information about downloading objects from Requester
|
9924
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9925
|
+
# in the *Amazon S3 Developer Guide*.
|
9926
|
+
#
|
9927
|
+
#
|
9928
|
+
#
|
9929
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9685
9930
|
#
|
9686
9931
|
# @option params [String] :version_id
|
9687
9932
|
# The version ID of the object that you want to place a Legal Hold on.
|
@@ -9749,9 +9994,13 @@ module Aws::S3
|
|
9749
9994
|
# @option params [String] :request_payer
|
9750
9995
|
# Confirms that the requester knows that she or he will be charged for
|
9751
9996
|
# the request. Bucket owners need not specify this parameter in their
|
9752
|
-
# requests.
|
9753
|
-
# buckets
|
9754
|
-
#
|
9997
|
+
# requests. For information about downloading objects from Requester
|
9998
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
9999
|
+
# in the *Amazon S3 Developer Guide*.
|
10000
|
+
#
|
10001
|
+
#
|
10002
|
+
#
|
10003
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9755
10004
|
#
|
9756
10005
|
# @option params [String] :token
|
9757
10006
|
# A token to allow Object Lock to be enabled for an existing bucket.
|
@@ -9808,9 +10057,21 @@ module Aws::S3
|
|
9808
10057
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
|
9809
10058
|
#
|
9810
10059
|
# @option params [required, String] :bucket
|
9811
|
-
# The bucket that contains the object you want to apply this Object
|
10060
|
+
# The bucket name that contains the object you want to apply this Object
|
9812
10061
|
# Retention configuration to.
|
9813
10062
|
#
|
10063
|
+
# When using this API with an access point, you must direct requests to
|
10064
|
+
# the access point hostname. The access point hostname takes the form
|
10065
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10066
|
+
# When using this operation using an access point through the AWS SDKs,
|
10067
|
+
# you provide the access point ARN in place of the bucket name. For more
|
10068
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
10069
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10070
|
+
#
|
10071
|
+
#
|
10072
|
+
#
|
10073
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10074
|
+
#
|
9814
10075
|
# @option params [required, String] :key
|
9815
10076
|
# The key name for the object that you want to apply this Object
|
9816
10077
|
# Retention configuration to.
|
@@ -9821,9 +10082,13 @@ module Aws::S3
|
|
9821
10082
|
# @option params [String] :request_payer
|
9822
10083
|
# Confirms that the requester knows that she or he will be charged for
|
9823
10084
|
# the request. Bucket owners need not specify this parameter in their
|
9824
|
-
# requests.
|
9825
|
-
# buckets
|
9826
|
-
#
|
10085
|
+
# requests. For information about downloading objects from Requester
|
10086
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
10087
|
+
# in the *Amazon S3 Developer Guide*.
|
10088
|
+
#
|
10089
|
+
#
|
10090
|
+
#
|
10091
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
9827
10092
|
#
|
9828
10093
|
# @option params [String] :version_id
|
9829
10094
|
# The version ID for the object that you want to apply this Object
|
@@ -9927,7 +10192,19 @@ module Aws::S3
|
|
9927
10192
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html
|
9928
10193
|
#
|
9929
10194
|
# @option params [required, String] :bucket
|
9930
|
-
# The bucket containing the object.
|
10195
|
+
# The bucket name containing the object.
|
10196
|
+
#
|
10197
|
+
# When using this API with an access point, you must direct requests to
|
10198
|
+
# the access point hostname. The access point hostname takes the form
|
10199
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10200
|
+
# When using this operation using an access point through the AWS SDKs,
|
10201
|
+
# you provide the access point ARN in place of the bucket name. For more
|
10202
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
10203
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10204
|
+
#
|
10205
|
+
#
|
10206
|
+
#
|
10207
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
9931
10208
|
#
|
9932
10209
|
# @option params [required, String] :key
|
9933
10210
|
# Name of the tag.
|
@@ -9939,7 +10216,7 @@ module Aws::S3
|
|
9939
10216
|
# The MD5 hash for the request body.
|
9940
10217
|
#
|
9941
10218
|
# @option params [required, Types::Tagging] :tagging
|
9942
|
-
# Container for the TagSet and Tag elements
|
10219
|
+
# Container for the `TagSet` and `Tag` elements
|
9943
10220
|
#
|
9944
10221
|
# @return [Types::PutObjectTaggingOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9945
10222
|
#
|
@@ -10003,14 +10280,14 @@ module Aws::S3
|
|
10003
10280
|
end
|
10004
10281
|
|
10005
10282
|
# Creates or modifies the `PublicAccessBlock` configuration for an
|
10006
|
-
# Amazon S3 bucket.
|
10283
|
+
# Amazon S3 bucket. To use this operation, you must have the
|
10007
10284
|
# `s3:PutBucketPublicAccessBlock` permission. For more information about
|
10008
10285
|
# Amazon S3 permissions, see [Specifying Permissions in a Policy][1].
|
10009
10286
|
#
|
10010
|
-
# When Amazon S3 evaluates the PublicAccessBlock configuration for a
|
10011
|
-
# bucket or an object, it checks the PublicAccessBlock configuration
|
10012
|
-
# both the bucket (or the bucket that contains the object) and the
|
10013
|
-
# bucket owner's account. If the PublicAccessBlock configurations are
|
10287
|
+
# When Amazon S3 evaluates the `PublicAccessBlock` configuration for a
|
10288
|
+
# bucket or an object, it checks the `PublicAccessBlock` configuration
|
10289
|
+
# for both the bucket (or the bucket that contains the object) and the
|
10290
|
+
# bucket owner's account. If the `PublicAccessBlock` configurations are
|
10014
10291
|
# different between the bucket and the account, Amazon S3 uses the most
|
10015
10292
|
# restrictive combination of the bucket-level and account-level
|
10016
10293
|
# settings.
|
@@ -10213,7 +10490,7 @@ module Aws::S3
|
|
10213
10490
|
# storage class and typically complete within 12 hours from the
|
10214
10491
|
# DEEP\_ARCHIVE storage class.
|
10215
10492
|
#
|
10216
|
-
# * <b> <code>Bulk</code> </b> - Bulk retrievals are Amazon Glacier’s
|
10493
|
+
# * <b> <code>Bulk</code> </b> - Bulk retrievals are Amazon S3 Glacier’s
|
10217
10494
|
# lowest-cost retrieval option, enabling you to retrieve large
|
10218
10495
|
# amounts, even petabytes, of data inexpensively in a day. Bulk
|
10219
10496
|
# retrievals typically complete within 5-12 hours from the GLACIER
|
@@ -10318,7 +10595,19 @@ module Aws::S3
|
|
10318
10595
|
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
10319
10596
|
#
|
10320
10597
|
# @option params [required, String] :bucket
|
10321
|
-
# The bucket name.
|
10598
|
+
# The bucket name or containing the object to restore.
|
10599
|
+
#
|
10600
|
+
# When using this API with an access point, you must direct requests to
|
10601
|
+
# the access point hostname. The access point hostname takes the form
|
10602
|
+
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10603
|
+
# When using this operation using an access point through the AWS SDKs,
|
10604
|
+
# you provide the access point ARN in place of the bucket name. For more
|
10605
|
+
# information about access point ARNs, see [Using Access Points][1] in
|
10606
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10607
|
+
#
|
10608
|
+
#
|
10609
|
+
#
|
10610
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html
|
10322
10611
|
#
|
10323
10612
|
# @option params [required, String] :key
|
10324
10613
|
# Object key for which the operation was initiated.
|
@@ -10332,9 +10621,13 @@ module Aws::S3
|
|
10332
10621
|
# @option params [String] :request_payer
|
10333
10622
|
# Confirms that the requester knows that she or he will be charged for
|
10334
10623
|
# the request. Bucket owners need not specify this parameter in their
|
10335
|
-
# requests.
|
10336
|
-
# buckets
|
10337
|
-
#
|
10624
|
+
# requests. For information about downloading objects from Requester
|
10625
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
10626
|
+
# in the *Amazon S3 Developer Guide*.
|
10627
|
+
#
|
10628
|
+
#
|
10629
|
+
#
|
10630
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
10338
10631
|
#
|
10339
10632
|
# @return [Types::RestoreObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10340
10633
|
#
|
@@ -10584,7 +10877,7 @@ module Aws::S3
|
|
10584
10877
|
#
|
10585
10878
|
# @option params [String] :sse_customer_algorithm
|
10586
10879
|
# The SSE Algorithm used to encrypt the object. For more information,
|
10587
|
-
# see [
|
10880
|
+
# see [Server-Side Encryption (Using Customer-Provided Encryption
|
10588
10881
|
# Keys][1].
|
10589
10882
|
#
|
10590
10883
|
#
|
@@ -10592,7 +10885,7 @@ module Aws::S3
|
|
10592
10885
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
10593
10886
|
#
|
10594
10887
|
# @option params [String] :sse_customer_key
|
10595
|
-
# The SSE Customer Key. For more information, see [
|
10888
|
+
# The SSE Customer Key. For more information, see [Server-Side
|
10596
10889
|
# Encryption (Using Customer-Provided Encryption Keys][1].
|
10597
10890
|
#
|
10598
10891
|
#
|
@@ -10600,7 +10893,7 @@ module Aws::S3
|
|
10600
10893
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
|
10601
10894
|
#
|
10602
10895
|
# @option params [String] :sse_customer_key_md5
|
10603
|
-
# The SSE Customer Key MD5. For more information, see [
|
10896
|
+
# The SSE Customer Key MD5. For more information, see [Server-Side
|
10604
10897
|
# Encryption (Using Customer-Provided Encryption Keys][1].
|
10605
10898
|
#
|
10606
10899
|
#
|
@@ -10611,7 +10904,7 @@ module Aws::S3
|
|
10611
10904
|
# The expression that is used to query the object.
|
10612
10905
|
#
|
10613
10906
|
# @option params [required, String] :expression_type
|
10614
|
-
# The type of the provided expression (for example
|
10907
|
+
# The type of the provided expression (for example, SQL).
|
10615
10908
|
#
|
10616
10909
|
# @option params [Types::RequestProgress] :request_progress
|
10617
10910
|
# Specifies if periodic request progress information should be enabled.
|
@@ -10909,7 +11202,7 @@ module Aws::S3
|
|
10909
11202
|
# You can optionally request server-side encryption where Amazon S3
|
10910
11203
|
# encrypts your data as it writes it to disks in its data centers and
|
10911
11204
|
# decrypts it for you when you access it. You have the option of
|
10912
|
-
# providing your own encryption key, or you can use the AWS
|
11205
|
+
# providing your own encryption key, or you can use the AWS managed
|
10913
11206
|
# encryption keys. If you choose to provide your own encryption key, the
|
10914
11207
|
# request headers you provide in the request must match the headers you
|
10915
11208
|
# used in the request to initiate the upload by using
|
@@ -10919,7 +11212,7 @@ module Aws::S3
|
|
10919
11212
|
# Server-side encryption is supported by the S3 Multipart Upload
|
10920
11213
|
# actions. Unless you are using a customer-provided encryption key, you
|
10921
11214
|
# don't need to specify the encryption parameters in each UploadPart
|
10922
|
-
# request. Instead, you only need to specify the server
|
11215
|
+
# request. Instead, you only need to specify the server-side encryption
|
10923
11216
|
# parameters in the initial Initiate Multipart request. For more
|
10924
11217
|
# information, see CreateMultipartUpload.
|
10925
11218
|
#
|
@@ -10978,7 +11271,7 @@ module Aws::S3
|
|
10978
11271
|
#
|
10979
11272
|
# @option params [String] :content_md5
|
10980
11273
|
# The base64-encoded 128-bit MD5 digest of the part data. This parameter
|
10981
|
-
# is auto-populated when using the command from the CLI. This
|
11274
|
+
# is auto-populated when using the command from the CLI. This parameter
|
10982
11275
|
# is required if object lock parameters are specified.
|
10983
11276
|
#
|
10984
11277
|
# @option params [required, String] :key
|
@@ -10993,29 +11286,33 @@ module Aws::S3
|
|
10993
11286
|
# uploaded.
|
10994
11287
|
#
|
10995
11288
|
# @option params [String] :sse_customer_algorithm
|
10996
|
-
# Specifies the algorithm to use to when encrypting the object (
|
10997
|
-
# AES256).
|
11289
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
11290
|
+
# example, AES256).
|
10998
11291
|
#
|
10999
11292
|
# @option params [String] :sse_customer_key
|
11000
11293
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
11001
11294
|
# encrypting data. This value is used to store the object and then it is
|
11002
|
-
# discarded; Amazon does not store the encryption key. The key must
|
11003
|
-
# appropriate for use with the algorithm specified in the
|
11004
|
-
# x-amz-server-side-encryption-customer-algorithm header
|
11005
|
-
# the same encryption key specified in the initiate multipart upload
|
11295
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
11296
|
+
# be appropriate for use with the algorithm specified in the
|
11297
|
+
# `x-amz-server-side-encryption-customer-algorithm header`. This must
|
11298
|
+
# be the same encryption key specified in the initiate multipart upload
|
11006
11299
|
# request.
|
11007
11300
|
#
|
11008
11301
|
# @option params [String] :sse_customer_key_md5
|
11009
11302
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
11010
11303
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
11011
|
-
# ensure the encryption key was transmitted without error.
|
11304
|
+
# ensure that the encryption key was transmitted without error.
|
11012
11305
|
#
|
11013
11306
|
# @option params [String] :request_payer
|
11014
11307
|
# Confirms that the requester knows that she or he will be charged for
|
11015
11308
|
# the request. Bucket owners need not specify this parameter in their
|
11016
|
-
# requests.
|
11017
|
-
# buckets
|
11018
|
-
#
|
11309
|
+
# requests. For information about downloading objects from Requester
|
11310
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11311
|
+
# in the *Amazon S3 Developer Guide*.
|
11312
|
+
#
|
11313
|
+
#
|
11314
|
+
#
|
11315
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
11019
11316
|
#
|
11020
11317
|
# @return [Types::UploadPartOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11021
11318
|
#
|
@@ -11098,19 +11395,19 @@ module Aws::S3
|
|
11098
11395
|
# identifier, the upload ID, that you must include in your upload part
|
11099
11396
|
# request.
|
11100
11397
|
#
|
11101
|
-
#
|
11102
|
-
# following
|
11398
|
+
# For more information about using the `UploadPartCopy` operation, see
|
11399
|
+
# the following:
|
11103
11400
|
#
|
11104
|
-
# * For conceptual information
|
11401
|
+
# * For conceptual information about multipart uploads, see [Uploading
|
11105
11402
|
# Objects Using Multipart Upload][2] in the *Amazon Simple Storage
|
11106
11403
|
# Service Developer Guide*.
|
11107
11404
|
#
|
11108
|
-
# * For information
|
11109
|
-
# API,
|
11110
|
-
# Simple Storage Service Developer Guide*.
|
11405
|
+
# * For information about permissions required to use the multipart
|
11406
|
+
# upload API, see [Multipart Upload API and Permissions][3] in the
|
11407
|
+
# *Amazon Simple Storage Service Developer Guide*.
|
11111
11408
|
#
|
11112
11409
|
# * For information about copying objects using a single atomic
|
11113
|
-
# operation vs. the multipart upload,
|
11410
|
+
# operation vs. the multipart upload, see [Operations on Objects][4]
|
11114
11411
|
# in the *Amazon Simple Storage Service Developer Guide*.
|
11115
11412
|
#
|
11116
11413
|
# * For information about using server-side encryption with
|
@@ -11118,9 +11415,9 @@ module Aws::S3
|
|
11118
11415
|
# see CopyObject and UploadPart.
|
11119
11416
|
#
|
11120
11417
|
# Note the following additional considerations about the request headers
|
11121
|
-
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match
|
11122
|
-
# `x-amz-copy-source-if-unmodified-since
|
11123
|
-
# `x-amz-copy-source-if-modified-since
|
11418
|
+
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`,
|
11419
|
+
# `x-amz-copy-source-if-unmodified-since`, and
|
11420
|
+
# `x-amz-copy-source-if-modified-since`\:
|
11124
11421
|
#
|
11125
11422
|
#
|
11126
11423
|
#
|
@@ -11133,7 +11430,7 @@ module Aws::S3
|
|
11133
11430
|
# `x-amz-copy-source-if-unmodified-since` condition evaluates to
|
11134
11431
|
# `false`;
|
11135
11432
|
#
|
11136
|
-
#
|
11433
|
+
# Amazon S3 returns `200 OK` and copies the data.
|
11137
11434
|
#
|
11138
11435
|
# * **Consideration 2** - If both of the
|
11139
11436
|
# `x-amz-copy-source-if-none-match` and
|
@@ -11145,7 +11442,7 @@ module Aws::S3
|
|
11145
11442
|
#
|
11146
11443
|
# `x-amz-copy-source-if-modified-since` condition evaluates to `true`;
|
11147
11444
|
#
|
11148
|
-
#
|
11445
|
+
# Amazon S3 returns `412 Precondition Failed` response code.
|
11149
11446
|
#
|
11150
11447
|
# **Versioning**
|
11151
11448
|
#
|
@@ -11232,7 +11529,7 @@ module Aws::S3
|
|
11232
11529
|
# The range of bytes to copy from the source object. The range value
|
11233
11530
|
# must use the form bytes=first-last, where the first and last are the
|
11234
11531
|
# zero-based byte offsets to copy. For example, bytes=0-9 indicates that
|
11235
|
-
# you want to copy the first
|
11532
|
+
# you want to copy the first 10 bytes of the source. You can copy a
|
11236
11533
|
# range only if the source object is greater than 5 MB.
|
11237
11534
|
#
|
11238
11535
|
# @option params [required, String] :key
|
@@ -11246,26 +11543,26 @@ module Aws::S3
|
|
11246
11543
|
# Upload ID identifying the multipart upload whose part is being copied.
|
11247
11544
|
#
|
11248
11545
|
# @option params [String] :sse_customer_algorithm
|
11249
|
-
# Specifies the algorithm to use to when encrypting the object (
|
11250
|
-
# AES256).
|
11546
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
11547
|
+
# example, AES256).
|
11251
11548
|
#
|
11252
11549
|
# @option params [String] :sse_customer_key
|
11253
11550
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
11254
11551
|
# encrypting data. This value is used to store the object and then it is
|
11255
|
-
# discarded; Amazon does not store the encryption key. The key must
|
11256
|
-
# appropriate for use with the algorithm specified in the
|
11257
|
-
# x-amz-server-side-encryption-customer-algorithm header. This must
|
11258
|
-
# the same encryption key specified in the initiate multipart upload
|
11552
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
11553
|
+
# be appropriate for use with the algorithm specified in the
|
11554
|
+
# `x-amz-server-side-encryption-customer-algorithm` header. This must
|
11555
|
+
# be the same encryption key specified in the initiate multipart upload
|
11259
11556
|
# request.
|
11260
11557
|
#
|
11261
11558
|
# @option params [String] :sse_customer_key_md5
|
11262
11559
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
11263
11560
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
11264
|
-
# ensure the encryption key was transmitted without error.
|
11561
|
+
# ensure that the encryption key was transmitted without error.
|
11265
11562
|
#
|
11266
11563
|
# @option params [String] :copy_source_sse_customer_algorithm
|
11267
|
-
# Specifies the algorithm to use when decrypting the source object
|
11268
|
-
#
|
11564
|
+
# Specifies the algorithm to use when decrypting the source object (for
|
11565
|
+
# example, AES256).
|
11269
11566
|
#
|
11270
11567
|
# @option params [String] :copy_source_sse_customer_key
|
11271
11568
|
# Specifies the customer-provided encryption key for Amazon S3 to use to
|
@@ -11275,14 +11572,18 @@ module Aws::S3
|
|
11275
11572
|
# @option params [String] :copy_source_sse_customer_key_md5
|
11276
11573
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
11277
11574
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
11278
|
-
# ensure the encryption key was transmitted without error.
|
11575
|
+
# ensure that the encryption key was transmitted without error.
|
11279
11576
|
#
|
11280
11577
|
# @option params [String] :request_payer
|
11281
11578
|
# Confirms that the requester knows that she or he will be charged for
|
11282
11579
|
# the request. Bucket owners need not specify this parameter in their
|
11283
|
-
# requests.
|
11284
|
-
# buckets
|
11285
|
-
#
|
11580
|
+
# requests. For information about downloading objects from Requester
|
11581
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
11582
|
+
# in the *Amazon S3 Developer Guide*.
|
11583
|
+
#
|
11584
|
+
#
|
11585
|
+
#
|
11586
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
11286
11587
|
#
|
11287
11588
|
# @return [Types::UploadPartCopyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11288
11589
|
#
|
@@ -11392,7 +11693,7 @@ module Aws::S3
|
|
11392
11693
|
params: params,
|
11393
11694
|
config: config)
|
11394
11695
|
context[:gem_name] = 'aws-sdk-s3'
|
11395
|
-
context[:gem_version] = '1.
|
11696
|
+
context[:gem_version] = '1.58.0'
|
11396
11697
|
Seahorse::Client::Request.new(handlers, context)
|
11397
11698
|
end
|
11398
11699
|
|