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
@@ -24,6 +24,7 @@ module Aws::S3
|
|
24
24
|
@object_key = extract_object_key(args, options)
|
25
25
|
@data = options.delete(:data)
|
26
26
|
@client = options.delete(:client) || Client.new(options)
|
27
|
+
@waiter_block_warned = false
|
27
28
|
end
|
28
29
|
|
29
30
|
# @!group Read-Only Attributes
|
@@ -226,7 +227,7 @@ module Aws::S3
|
|
226
227
|
# @param [Hash] options ({})
|
227
228
|
# @option options [String] :acl
|
228
229
|
# The canned ACL to apply to the object. For more information, see
|
229
|
-
# [Canned ACL][1]
|
230
|
+
# [Canned ACL][1].
|
230
231
|
#
|
231
232
|
#
|
232
233
|
#
|
@@ -258,9 +259,13 @@ module Aws::S3
|
|
258
259
|
# @option options [String] :request_payer
|
259
260
|
# Confirms that the requester knows that she or he will be charged for
|
260
261
|
# the request. Bucket owners need not specify this parameter in their
|
261
|
-
# requests.
|
262
|
-
# buckets
|
263
|
-
#
|
262
|
+
# requests. For information about downloading objects from Requester
|
263
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
264
|
+
# in the *Amazon S3 Developer Guide*.
|
265
|
+
#
|
266
|
+
#
|
267
|
+
#
|
268
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
264
269
|
# @option options [String] :version_id
|
265
270
|
# VersionId used to reference a specific version of the object.
|
266
271
|
# @return [Types::PutObjectAclOutput]
|
@@ -24,6 +24,7 @@ module Aws::S3
|
|
24
24
|
@key = extract_key(args, options)
|
25
25
|
@data = options.delete(:data)
|
26
26
|
@client = options.delete(:client) || Client.new(options)
|
27
|
+
@waiter_block_warned = false
|
27
28
|
end
|
28
29
|
|
29
30
|
# @!group Read-Only Attributes
|
@@ -337,8 +338,8 @@ module Aws::S3
|
|
337
338
|
# Specifies whether the object tag-set are copied from the source object
|
338
339
|
# or replaced with tag-set provided in the request.
|
339
340
|
# @option options [String] :server_side_encryption
|
340
|
-
# The
|
341
|
-
# S3 (
|
341
|
+
# The server-side encryption algorithm used when storing this object in
|
342
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
342
343
|
# @option options [String] :storage_class
|
343
344
|
# The type of storage to use for the object. Defaults to 'STANDARD'.
|
344
345
|
# @option options [String] :website_redirect_location
|
@@ -346,31 +347,36 @@ module Aws::S3
|
|
346
347
|
# object to another object in the same bucket or to an external URL.
|
347
348
|
# Amazon S3 stores the value of this header in the object metadata.
|
348
349
|
# @option options [String] :sse_customer_algorithm
|
349
|
-
# Specifies the algorithm to use to when encrypting the object (
|
350
|
-
# AES256).
|
350
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
351
|
+
# example, AES256).
|
351
352
|
# @option options [String] :sse_customer_key
|
352
353
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
353
354
|
# encrypting data. This value is used to store the object and then it is
|
354
|
-
# discarded; Amazon does not store the encryption key. The key must
|
355
|
-
# appropriate for use with the algorithm specified in the
|
356
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
355
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
356
|
+
# be appropriate for use with the algorithm specified in the
|
357
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
357
358
|
# @option options [String] :sse_customer_key_md5
|
358
359
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
359
360
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
360
|
-
# ensure the encryption key was transmitted without error.
|
361
|
+
# ensure that the encryption key was transmitted without error.
|
361
362
|
# @option options [String] :ssekms_key_id
|
362
363
|
# Specifies the AWS KMS key ID to use for object encryption. All GET and
|
363
364
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
364
|
-
# via SSL or using SigV4.
|
365
|
-
# officially supported AWS SDKs and CLI
|
366
|
-
#
|
365
|
+
# via SSL or using SigV4. For information about configuring using any of
|
366
|
+
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
367
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
368
|
+
# Developer Guide*.
|
369
|
+
#
|
370
|
+
#
|
371
|
+
#
|
372
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
367
373
|
# @option options [String] :ssekms_encryption_context
|
368
374
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
369
375
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
370
376
|
# with the encryption context key-value pairs.
|
371
377
|
# @option options [String] :copy_source_sse_customer_algorithm
|
372
|
-
# Specifies the algorithm to use when decrypting the source object
|
373
|
-
#
|
378
|
+
# Specifies the algorithm to use when decrypting the source object (for
|
379
|
+
# example, AES256).
|
374
380
|
# @option options [String] :copy_source_sse_customer_key
|
375
381
|
# Specifies the customer-provided encryption key for Amazon S3 to use to
|
376
382
|
# decrypt the source object. The encryption key provided in this header
|
@@ -378,17 +384,21 @@ module Aws::S3
|
|
378
384
|
# @option options [String] :copy_source_sse_customer_key_md5
|
379
385
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
380
386
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
381
|
-
# ensure the encryption key was transmitted without error.
|
387
|
+
# ensure that the encryption key was transmitted without error.
|
382
388
|
# @option options [String] :request_payer
|
383
389
|
# Confirms that the requester knows that she or he will be charged for
|
384
390
|
# the request. Bucket owners need not specify this parameter in their
|
385
|
-
# requests.
|
386
|
-
# buckets
|
387
|
-
#
|
391
|
+
# requests. For information about downloading objects from Requester
|
392
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
393
|
+
# in the *Amazon S3 Developer Guide*.
|
394
|
+
#
|
395
|
+
#
|
396
|
+
#
|
397
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
388
398
|
# @option options [String] :tagging
|
389
399
|
# The tag-set for the object destination object this value must be used
|
390
|
-
# in conjunction with the TaggingDirective
|
391
|
-
# as URL Query parameters
|
400
|
+
# in conjunction with the `TaggingDirective`. The tag-set must be
|
401
|
+
# encoded as URL Query parameters.
|
392
402
|
# @option options [String] :object_lock_mode
|
393
403
|
# The Object Lock mode that you want to apply to the copied object.
|
394
404
|
# @option options [Time,DateTime,Date,Integer,String] :object_lock_retain_until_date
|
@@ -418,16 +428,20 @@ module Aws::S3
|
|
418
428
|
# @option options [String] :mfa
|
419
429
|
# The concatenation of the authentication device's serial number, a
|
420
430
|
# space, and the value that is displayed on your authentication device.
|
421
|
-
# Required to permanently delete a
|
422
|
-
# configured with MFA
|
431
|
+
# Required to permanently delete a versioned object if versioning is
|
432
|
+
# configured with MFA delete enabled.
|
423
433
|
# @option options [String] :version_id
|
424
434
|
# VersionId used to reference a specific version of the object.
|
425
435
|
# @option options [String] :request_payer
|
426
436
|
# Confirms that the requester knows that she or he will be charged for
|
427
437
|
# the request. Bucket owners need not specify this parameter in their
|
428
|
-
# requests.
|
429
|
-
# buckets
|
430
|
-
#
|
438
|
+
# requests. For information about downloading objects from Requester
|
439
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
440
|
+
# in the *Amazon S3 Developer Guide*.
|
441
|
+
#
|
442
|
+
#
|
443
|
+
#
|
444
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
431
445
|
# @option options [Boolean] :bypass_governance_retention
|
432
446
|
# Indicates whether S3 Object Lock should bypass Governance-mode
|
433
447
|
# restrictions to process this operation.
|
@@ -477,41 +491,45 @@ module Aws::S3
|
|
477
491
|
# time, otherwise return a 412 (precondition failed).
|
478
492
|
# @option options [String] :range
|
479
493
|
# Downloads the specified range bytes of an object. For more information
|
480
|
-
# about the HTTP Range header,
|
481
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
494
|
+
# about the HTTP Range header, see
|
495
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
482
496
|
# @option options [String] :response_cache_control
|
483
|
-
# Sets the Cache-Control header of the response.
|
497
|
+
# Sets the `Cache-Control` header of the response.
|
484
498
|
# @option options [String] :response_content_disposition
|
485
|
-
# Sets the Content-Disposition header of the response
|
499
|
+
# Sets the `Content-Disposition` header of the response
|
486
500
|
# @option options [String] :response_content_encoding
|
487
|
-
# Sets the Content-Encoding header of the response.
|
501
|
+
# Sets the `Content-Encoding` header of the response.
|
488
502
|
# @option options [String] :response_content_language
|
489
|
-
# Sets the Content-Language header of the response.
|
503
|
+
# Sets the `Content-Language` header of the response.
|
490
504
|
# @option options [String] :response_content_type
|
491
|
-
# Sets the Content-Type header of the response.
|
505
|
+
# Sets the `Content-Type` header of the response.
|
492
506
|
# @option options [Time,DateTime,Date,Integer,String] :response_expires
|
493
|
-
# Sets the Expires header of the response.
|
507
|
+
# Sets the `Expires` header of the response.
|
494
508
|
# @option options [String] :version_id
|
495
509
|
# VersionId used to reference a specific version of the object.
|
496
510
|
# @option options [String] :sse_customer_algorithm
|
497
|
-
# Specifies the algorithm to use to when encrypting the object (
|
498
|
-
# AES256).
|
511
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
512
|
+
# example, AES256).
|
499
513
|
# @option options [String] :sse_customer_key
|
500
514
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
501
515
|
# encrypting data. This value is used to store the object and then it is
|
502
|
-
# discarded; Amazon does not store the encryption key. The key must
|
503
|
-
# appropriate for use with the algorithm specified in the
|
504
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
516
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
517
|
+
# be appropriate for use with the algorithm specified in the
|
518
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
505
519
|
# @option options [String] :sse_customer_key_md5
|
506
520
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
507
521
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
508
|
-
# ensure the encryption key was transmitted without error.
|
522
|
+
# ensure that the encryption key was transmitted without error.
|
509
523
|
# @option options [String] :request_payer
|
510
524
|
# Confirms that the requester knows that she or he will be charged for
|
511
525
|
# the request. Bucket owners need not specify this parameter in their
|
512
|
-
# requests.
|
513
|
-
# buckets
|
514
|
-
#
|
526
|
+
# requests. For information about downloading objects from Requester
|
527
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
528
|
+
# in the *Amazon S3 Developer Guide*.
|
529
|
+
#
|
530
|
+
#
|
531
|
+
#
|
532
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
515
533
|
# @option options [Integer] :part_number
|
516
534
|
# Part number of the object being read. This is a positive integer
|
517
535
|
# between 1 and 10,000. Effectively performs a 'ranged' GET request
|
@@ -587,8 +605,8 @@ module Aws::S3
|
|
587
605
|
# @option options [Hash<String,String>] :metadata
|
588
606
|
# A map of metadata to store with the object in S3.
|
589
607
|
# @option options [String] :server_side_encryption
|
590
|
-
# The
|
591
|
-
# S3 (
|
608
|
+
# The server-side encryption algorithm used when storing this object in
|
609
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
592
610
|
# @option options [String] :storage_class
|
593
611
|
# The type of storage to use for the object. Defaults to 'STANDARD'.
|
594
612
|
# @option options [String] :website_redirect_location
|
@@ -596,24 +614,29 @@ module Aws::S3
|
|
596
614
|
# object to another object in the same bucket or to an external URL.
|
597
615
|
# Amazon S3 stores the value of this header in the object metadata.
|
598
616
|
# @option options [String] :sse_customer_algorithm
|
599
|
-
# Specifies the algorithm to use to when encrypting the object (
|
600
|
-
# AES256).
|
617
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
618
|
+
# example, AES256).
|
601
619
|
# @option options [String] :sse_customer_key
|
602
620
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
603
621
|
# encrypting data. This value is used to store the object and then it is
|
604
|
-
# discarded; Amazon does not store the encryption key. The key must
|
605
|
-
# appropriate for use with the algorithm specified in the
|
606
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
622
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
623
|
+
# be appropriate for use with the algorithm specified in the
|
624
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
607
625
|
# @option options [String] :sse_customer_key_md5
|
608
626
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
609
627
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
610
|
-
# ensure the encryption key was transmitted without error.
|
628
|
+
# ensure that the encryption key was transmitted without error.
|
611
629
|
# @option options [String] :ssekms_key_id
|
612
630
|
# Specifies the AWS KMS key ID to use for object encryption. All GET and
|
613
631
|
# PUT requests for an object protected by AWS KMS will fail if not made
|
614
|
-
# via SSL or using SigV4.
|
615
|
-
# officially supported AWS SDKs and CLI
|
616
|
-
#
|
632
|
+
# via SSL or using SigV4. For information about configuring using any of
|
633
|
+
# the officially supported AWS SDKs and AWS CLI, see [Specifying the
|
634
|
+
# Signature Version in Request Authentication][1] in the *Amazon S3
|
635
|
+
# Developer Guide*.
|
636
|
+
#
|
637
|
+
#
|
638
|
+
#
|
639
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
617
640
|
# @option options [String] :ssekms_encryption_context
|
618
641
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
619
642
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -621,12 +644,16 @@ module Aws::S3
|
|
621
644
|
# @option options [String] :request_payer
|
622
645
|
# Confirms that the requester knows that she or he will be charged for
|
623
646
|
# the request. Bucket owners need not specify this parameter in their
|
624
|
-
# requests.
|
625
|
-
# buckets
|
626
|
-
#
|
647
|
+
# requests. For information about downloading objects from Requester
|
648
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
649
|
+
# in the *Amazon S3 Developer Guide*.
|
650
|
+
#
|
651
|
+
#
|
652
|
+
#
|
653
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
627
654
|
# @option options [String] :tagging
|
628
655
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
629
|
-
# parameters
|
656
|
+
# parameters.
|
630
657
|
# @option options [String] :object_lock_mode
|
631
658
|
# Specifies the Object Lock mode that you want to apply to the uploaded
|
632
659
|
# object.
|
@@ -769,8 +796,8 @@ module Aws::S3
|
|
769
796
|
# @option options [Hash<String,String>] :metadata
|
770
797
|
# A map of metadata to store with the object in S3.
|
771
798
|
# @option options [String] :server_side_encryption
|
772
|
-
# The
|
773
|
-
# S3 (
|
799
|
+
# The server-side encryption algorithm used when storing this object in
|
800
|
+
# Amazon S3 (for example, AES256, aws:kms).
|
774
801
|
# @option options [String] :storage_class
|
775
802
|
# If you don't specify, Standard is the default storage class. Amazon
|
776
803
|
# S3 supports other storage classes.
|
@@ -778,7 +805,7 @@ module Aws::S3
|
|
778
805
|
# If the bucket is configured as a website, redirects requests for this
|
779
806
|
# object to another object in the same bucket or to an external URL.
|
780
807
|
# Amazon S3 stores the value of this header in the object metadata. For
|
781
|
-
# information about object metadata, see .
|
808
|
+
# information about object metadata, see [Object Key and Metadata][1].
|
782
809
|
#
|
783
810
|
# In the following example, the request header sets the redirect to an
|
784
811
|
# object (anotherPage.html) in the same bucket:
|
@@ -791,37 +818,38 @@ module Aws::S3
|
|
791
818
|
# `x-amz-website-redirect-location: http://www.example.com/`
|
792
819
|
#
|
793
820
|
# For more information about website hosting in Amazon S3, see [Hosting
|
794
|
-
# Websites on Amazon S3][
|
795
|
-
# Redirects][
|
821
|
+
# Websites on Amazon S3][2] and [How to Configure Website Page
|
822
|
+
# Redirects][3].
|
796
823
|
#
|
797
824
|
#
|
798
825
|
#
|
799
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
800
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
826
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html
|
827
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
828
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
801
829
|
# @option options [String] :sse_customer_algorithm
|
802
|
-
# Specifies the algorithm to use to when encrypting the object (
|
803
|
-
# AES256).
|
830
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
831
|
+
# example, AES256).
|
804
832
|
# @option options [String] :sse_customer_key
|
805
833
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
806
834
|
# encrypting data. This value is used to store the object and then it is
|
807
|
-
# discarded; Amazon does not store the encryption key. The key must
|
808
|
-
# appropriate for use with the algorithm specified in the
|
809
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
835
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
836
|
+
# be appropriate for use with the algorithm specified in the
|
837
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
810
838
|
# @option options [String] :sse_customer_key_md5
|
811
839
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
812
840
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
813
|
-
# ensure the encryption key was transmitted without error.
|
841
|
+
# ensure that the encryption key was transmitted without error.
|
814
842
|
# @option options [String] :ssekms_key_id
|
815
|
-
# If
|
816
|
-
# aws:kms
|
843
|
+
# If `x-amz-server-side-encryption` is present and has the value of
|
844
|
+
# `aws:kms`, this header specifies the ID of the AWS Key Management
|
817
845
|
# Service (AWS KMS) customer master key (CMK) that was used for the
|
818
846
|
# object.
|
819
847
|
#
|
820
|
-
# If the value of x-amz-server-side-encryption is aws:kms
|
821
|
-
# specifies the ID of the AWS KMS CMK that will be used for the
|
822
|
-
# If you specify x-amz-server-side-encryption:aws:kms
|
823
|
-
# provide x-amz-server-side-encryption-aws-kms-key-id
|
824
|
-
# the AWS managed CMK in AWS to protect the data.
|
848
|
+
# If the value of `x-amz-server-side-encryption` is `aws:kms`, this
|
849
|
+
# header specifies the ID of the AWS KMS CMK that will be used for the
|
850
|
+
# object. If you specify `x-amz-server-side-encryption:aws:kms`, but do
|
851
|
+
# not provide` x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
852
|
+
# uses the AWS managed CMK in AWS to protect the data.
|
825
853
|
# @option options [String] :ssekms_encryption_context
|
826
854
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
827
855
|
# The value of this header is a base64-encoded UTF-8 string holding JSON
|
@@ -829,9 +857,13 @@ module Aws::S3
|
|
829
857
|
# @option options [String] :request_payer
|
830
858
|
# Confirms that the requester knows that she or he will be charged for
|
831
859
|
# the request. Bucket owners need not specify this parameter in their
|
832
|
-
# requests.
|
833
|
-
# buckets
|
834
|
-
#
|
860
|
+
# requests. For information about downloading objects from Requester
|
861
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
862
|
+
# in the *Amazon S3 Developer Guide*.
|
863
|
+
#
|
864
|
+
#
|
865
|
+
#
|
866
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
835
867
|
# @option options [String] :tagging
|
836
868
|
# The tag-set for the object. The tag-set must be encoded as URL Query
|
837
869
|
# parameters. (For example, "Key1=Value1")
|
@@ -951,9 +983,13 @@ module Aws::S3
|
|
951
983
|
# @option options [String] :request_payer
|
952
984
|
# Confirms that the requester knows that she or he will be charged for
|
953
985
|
# the request. Bucket owners need not specify this parameter in their
|
954
|
-
# requests.
|
955
|
-
# buckets
|
956
|
-
#
|
986
|
+
# requests. For information about downloading objects from Requester
|
987
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
988
|
+
# in the *Amazon S3 Developer Guide*.
|
989
|
+
#
|
990
|
+
#
|
991
|
+
#
|
992
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
957
993
|
# @return [Types::RestoreObjectOutput]
|
958
994
|
def restore_object(options = {})
|
959
995
|
options = options.merge(
|
@@ -1089,13 +1125,17 @@ module Aws::S3
|
|
1089
1125
|
# The concatenation of the authentication device's serial number, a
|
1090
1126
|
# space, and the value that is displayed on your authentication device.
|
1091
1127
|
# Required to permanently delete a versioned object if versioning is
|
1092
|
-
# configured with MFA
|
1128
|
+
# configured with MFA delete enabled.
|
1093
1129
|
# @option options [String] :request_payer
|
1094
1130
|
# Confirms that the requester knows that she or he will be charged for
|
1095
1131
|
# the request. Bucket owners need not specify this parameter in their
|
1096
|
-
# requests.
|
1097
|
-
# buckets
|
1098
|
-
#
|
1132
|
+
# requests. For information about downloading objects from Requester
|
1133
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
1134
|
+
# in the *Amazon S3 Developer Guide*.
|
1135
|
+
#
|
1136
|
+
#
|
1137
|
+
#
|
1138
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
1099
1139
|
# @option options [Boolean] :bypass_governance_retention
|
1100
1140
|
# Specifies whether you want to delete this object even if it has a
|
1101
1141
|
# Governance-type Object Lock in place. You must have sufficient
|
@@ -27,6 +27,7 @@ module Aws::S3
|
|
27
27
|
@id = extract_id(args, options)
|
28
28
|
@data = options.delete(:data)
|
29
29
|
@client = options.delete(:client) || Client.new(options)
|
30
|
+
@waiter_block_warned = false
|
30
31
|
end
|
31
32
|
|
32
33
|
# @!group Read-Only Attributes
|
@@ -46,7 +47,7 @@ module Aws::S3
|
|
46
47
|
@id
|
47
48
|
end
|
48
49
|
|
49
|
-
# The entity tag is an MD5 hash of that version of the object
|
50
|
+
# The entity tag is an MD5 hash of that version of the object.
|
50
51
|
# @return [String]
|
51
52
|
def etag
|
52
53
|
data[:etag]
|
@@ -89,7 +90,7 @@ module Aws::S3
|
|
89
90
|
data[:last_modified]
|
90
91
|
end
|
91
92
|
|
92
|
-
# Specifies the
|
93
|
+
# Specifies the owner of the object.
|
93
94
|
# @return [Types::Owner]
|
94
95
|
def owner
|
95
96
|
data[:owner]
|
@@ -233,14 +234,18 @@ module Aws::S3
|
|
233
234
|
# @option options [String] :mfa
|
234
235
|
# The concatenation of the authentication device's serial number, a
|
235
236
|
# space, and the value that is displayed on your authentication device.
|
236
|
-
# Required to permanently delete a
|
237
|
-
# configured with MFA
|
237
|
+
# Required to permanently delete a versioned object if versioning is
|
238
|
+
# configured with MFA delete enabled.
|
238
239
|
# @option options [String] :request_payer
|
239
240
|
# Confirms that the requester knows that she or he will be charged for
|
240
241
|
# the request. Bucket owners need not specify this parameter in their
|
241
|
-
# requests.
|
242
|
-
# buckets
|
243
|
-
#
|
242
|
+
# requests. For information about downloading objects from Requester
|
243
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
244
|
+
# in the *Amazon S3 Developer Guide*.
|
245
|
+
#
|
246
|
+
#
|
247
|
+
#
|
248
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
244
249
|
# @option options [Boolean] :bypass_governance_retention
|
245
250
|
# Indicates whether S3 Object Lock should bypass Governance-mode
|
246
251
|
# restrictions to process this operation.
|
@@ -290,39 +295,43 @@ module Aws::S3
|
|
290
295
|
# time, otherwise return a 412 (precondition failed).
|
291
296
|
# @option options [String] :range
|
292
297
|
# Downloads the specified range bytes of an object. For more information
|
293
|
-
# about the HTTP Range header,
|
294
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
298
|
+
# about the HTTP Range header, see
|
299
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
295
300
|
# @option options [String] :response_cache_control
|
296
|
-
# Sets the Cache-Control header of the response.
|
301
|
+
# Sets the `Cache-Control` header of the response.
|
297
302
|
# @option options [String] :response_content_disposition
|
298
|
-
# Sets the Content-Disposition header of the response
|
303
|
+
# Sets the `Content-Disposition` header of the response
|
299
304
|
# @option options [String] :response_content_encoding
|
300
|
-
# Sets the Content-Encoding header of the response.
|
305
|
+
# Sets the `Content-Encoding` header of the response.
|
301
306
|
# @option options [String] :response_content_language
|
302
|
-
# Sets the Content-Language header of the response.
|
307
|
+
# Sets the `Content-Language` header of the response.
|
303
308
|
# @option options [String] :response_content_type
|
304
|
-
# Sets the Content-Type header of the response.
|
309
|
+
# Sets the `Content-Type` header of the response.
|
305
310
|
# @option options [Time,DateTime,Date,Integer,String] :response_expires
|
306
|
-
# Sets the Expires header of the response.
|
311
|
+
# Sets the `Expires` header of the response.
|
307
312
|
# @option options [String] :sse_customer_algorithm
|
308
|
-
# Specifies the algorithm to use to when encrypting the object (
|
309
|
-
# AES256).
|
313
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
314
|
+
# example, AES256).
|
310
315
|
# @option options [String] :sse_customer_key
|
311
316
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
312
317
|
# encrypting data. This value is used to store the object and then it is
|
313
|
-
# discarded; Amazon does not store the encryption key. The key must
|
314
|
-
# appropriate for use with the algorithm specified in the
|
315
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
318
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
319
|
+
# be appropriate for use with the algorithm specified in the
|
320
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
316
321
|
# @option options [String] :sse_customer_key_md5
|
317
322
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
318
323
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
319
|
-
# ensure the encryption key was transmitted without error.
|
324
|
+
# ensure that the encryption key was transmitted without error.
|
320
325
|
# @option options [String] :request_payer
|
321
326
|
# Confirms that the requester knows that she or he will be charged for
|
322
327
|
# the request. Bucket owners need not specify this parameter in their
|
323
|
-
# requests.
|
324
|
-
# buckets
|
325
|
-
#
|
328
|
+
# requests. For information about downloading objects from Requester
|
329
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
330
|
+
# in the *Amazon S3 Developer Guide*.
|
331
|
+
#
|
332
|
+
#
|
333
|
+
#
|
334
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
326
335
|
# @option options [Integer] :part_number
|
327
336
|
# Part number of the object being read. This is a positive integer
|
328
337
|
# between 1 and 10,000. Effectively performs a 'ranged' GET request
|
@@ -368,27 +377,31 @@ module Aws::S3
|
|
368
377
|
# time, otherwise return a 412 (precondition failed).
|
369
378
|
# @option options [String] :range
|
370
379
|
# Downloads the specified range bytes of an object. For more information
|
371
|
-
# about the HTTP Range header,
|
372
|
-
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
|
380
|
+
# about the HTTP Range header, see
|
381
|
+
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
373
382
|
# @option options [String] :sse_customer_algorithm
|
374
|
-
# Specifies the algorithm to use to when encrypting the object (
|
375
|
-
# AES256).
|
383
|
+
# Specifies the algorithm to use to when encrypting the object (for
|
384
|
+
# example, AES256).
|
376
385
|
# @option options [String] :sse_customer_key
|
377
386
|
# Specifies the customer-provided encryption key for Amazon S3 to use in
|
378
387
|
# encrypting data. This value is used to store the object and then it is
|
379
|
-
# discarded; Amazon does not store the encryption key. The key must
|
380
|
-
# appropriate for use with the algorithm specified in the
|
381
|
-
# x-amz-server-side-encryption-customer-algorithm header.
|
388
|
+
# discarded; Amazon S3 does not store the encryption key. The key must
|
389
|
+
# be appropriate for use with the algorithm specified in the
|
390
|
+
# `x-amz-server-side-encryption-customer-algorithm` header.
|
382
391
|
# @option options [String] :sse_customer_key_md5
|
383
392
|
# Specifies the 128-bit MD5 digest of the encryption key according to
|
384
393
|
# RFC 1321. Amazon S3 uses this header for a message integrity check to
|
385
|
-
# ensure the encryption key was transmitted without error.
|
394
|
+
# ensure that the encryption key was transmitted without error.
|
386
395
|
# @option options [String] :request_payer
|
387
396
|
# Confirms that the requester knows that she or he will be charged for
|
388
397
|
# the request. Bucket owners need not specify this parameter in their
|
389
|
-
# requests.
|
390
|
-
# buckets
|
391
|
-
#
|
398
|
+
# requests. For information about downloading objects from Requester
|
399
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
400
|
+
# in the *Amazon S3 Developer Guide*.
|
401
|
+
#
|
402
|
+
#
|
403
|
+
#
|
404
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
392
405
|
# @option options [Integer] :part_number
|
393
406
|
# Part number of the object being read. This is a positive integer
|
394
407
|
# between 1 and 10,000. Effectively performs a 'ranged' HEAD request
|
@@ -478,13 +491,17 @@ module Aws::S3
|
|
478
491
|
# The concatenation of the authentication device's serial number, a
|
479
492
|
# space, and the value that is displayed on your authentication device.
|
480
493
|
# Required to permanently delete a versioned object if versioning is
|
481
|
-
# configured with MFA
|
494
|
+
# configured with MFA delete enabled.
|
482
495
|
# @option options [String] :request_payer
|
483
496
|
# Confirms that the requester knows that she or he will be charged for
|
484
497
|
# the request. Bucket owners need not specify this parameter in their
|
485
|
-
# requests.
|
486
|
-
# buckets
|
487
|
-
#
|
498
|
+
# requests. For information about downloading objects from Requester
|
499
|
+
# Pays buckets, see [Downloading Objects in Requestor Pays Buckets][1]
|
500
|
+
# in the *Amazon S3 Developer Guide*.
|
501
|
+
#
|
502
|
+
#
|
503
|
+
#
|
504
|
+
# [1]: https://docs.aws.amazon.com/http:/docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
|
488
505
|
# @option options [Boolean] :bypass_governance_retention
|
489
506
|
# Specifies whether you want to delete this object even if it has a
|
490
507
|
# Governance-type Object Lock in place. You must have sufficient
|