aws-sdk-s3 1.63.1 → 1.67.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-s3.rb +1 -1
- data/lib/aws-sdk-s3/bucket.rb +3 -3
- data/lib/aws-sdk-s3/bucket_cors.rb +1 -1
- data/lib/aws-sdk-s3/bucket_website.rb +4 -2
- data/lib/aws-sdk-s3/client.rb +522 -646
- data/lib/aws-sdk-s3/client_api.rb +18 -18
- data/lib/aws-sdk-s3/customizations/bucket.rb +2 -0
- data/lib/aws-sdk-s3/customizations/object.rb +5 -1
- data/lib/aws-sdk-s3/customizations/object_summary.rb +3 -0
- data/lib/aws-sdk-s3/encryption/client.rb +1 -1
- data/lib/aws-sdk-s3/event_streams.rb +5 -0
- data/lib/aws-sdk-s3/multipart_upload.rb +1 -1
- data/lib/aws-sdk-s3/object.rb +14 -4
- data/lib/aws-sdk-s3/object_summary.rb +12 -3
- data/lib/aws-sdk-s3/object_version.rb +15 -1
- data/lib/aws-sdk-s3/plugins/expect_100_continue.rb +1 -4
- data/lib/aws-sdk-s3/plugins/http_200_errors.rb +1 -1
- data/lib/aws-sdk-s3/presigner.rb +0 -3
- data/lib/aws-sdk-s3/resource.rb +1 -1
- data/lib/aws-sdk-s3/types.rb +138 -37
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce69ce99886dbe63d58ff03a4d3209ef7513cf760b0bdf0d8c35f856494654d1
|
4
|
+
data.tar.gz: d6da0c49647d05de59c2d155bd8b5d66de52c0e0540e8ecb4c29cedaff1360cd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 971ef76d70c2ce3732c4cafbcd332f852056447865f0a086a077e8a323d14bc5d45d2285af2780b59491863e8751910862af3906d631caa7ba2ca417c27aaf30
|
7
|
+
data.tar.gz: 2b9c17793ea785f691877554ef96dc47d4823a0dd56b302d159a1893fc8ffaf02843a8fee24860f599386fdbfd9a26035bc92e5c1a75b68151f812a45a089b10
|
data/lib/aws-sdk-s3.rb
CHANGED
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -437,8 +437,8 @@ module Aws::S3
|
|
437
437
|
# The server-side encryption algorithm used when storing this object in
|
438
438
|
# Amazon S3 (for example, AES256, aws:kms).
|
439
439
|
# @option options [String] :storage_class
|
440
|
-
# If you don't specify, Standard is the default storage class.
|
441
|
-
# S3 supports other storage classes.
|
440
|
+
# If you don't specify, S3 Standard is the default storage class.
|
441
|
+
# Amazon S3 supports other storage classes.
|
442
442
|
# @option options [String] :website_redirect_location
|
443
443
|
# If the bucket is configured as a website, redirects requests for this
|
444
444
|
# object to another object in the same bucket or to an external URL.
|
@@ -520,7 +520,7 @@ module Aws::S3
|
|
520
520
|
# @return [Object]
|
521
521
|
def put_object(options = {})
|
522
522
|
options = options.merge(bucket: @name)
|
523
|
-
|
523
|
+
@client.put_object(options)
|
524
524
|
Object.new(
|
525
525
|
bucket_name: @name,
|
526
526
|
key: options[:key],
|
@@ -209,7 +209,7 @@ module Aws::S3
|
|
209
209
|
#
|
210
210
|
#
|
211
211
|
#
|
212
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
212
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
213
213
|
# @option options [String] :content_md5
|
214
214
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
215
215
|
# used as a message integrity check to verify that the request body was
|
@@ -39,13 +39,15 @@ module Aws::S3
|
|
39
39
|
data[:redirect_all_requests_to]
|
40
40
|
end
|
41
41
|
|
42
|
-
# The name of the index document for the website
|
42
|
+
# The name of the index document for the website (for example
|
43
|
+
# `index.html`).
|
43
44
|
# @return [Types::IndexDocument]
|
44
45
|
def index_document
|
45
46
|
data[:index_document]
|
46
47
|
end
|
47
48
|
|
48
|
-
# The name of the error document for
|
49
|
+
# The object key name of the website error document to use for 4XX class
|
50
|
+
# errors.
|
49
51
|
# @return [Types::ErrorDocument]
|
50
52
|
def error_document
|
51
53
|
data[:error_document]
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -137,7 +137,7 @@ module Aws::S3
|
|
137
137
|
# @option options [required, String] :region
|
138
138
|
# The AWS region to connect to. The configured `:region` is
|
139
139
|
# used to determine the service `:endpoint`. When not passed,
|
140
|
-
# a default `:region` is
|
140
|
+
# a default `:region` is searched for in the following locations:
|
141
141
|
#
|
142
142
|
# * `Aws.config[:region]`
|
143
143
|
# * `ENV['AWS_REGION']`
|
@@ -199,7 +199,7 @@ module Aws::S3
|
|
199
199
|
# @option options [String] :endpoint
|
200
200
|
# The client endpoint is normally constructed from the `:region`
|
201
201
|
# option. You should only configure an `:endpoint` when connecting
|
202
|
-
# to test endpoints. This should be
|
202
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
203
203
|
#
|
204
204
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
205
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -214,7 +214,7 @@ module Aws::S3
|
|
214
214
|
# requests fetching endpoints information. Defaults to 60 sec.
|
215
215
|
#
|
216
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
217
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
217
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
218
218
|
#
|
219
219
|
# @option options [Proc] :event_stream_handler
|
220
220
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
@@ -555,8 +555,7 @@ module Aws::S3
|
|
555
555
|
#
|
556
556
|
# * 404 Not Found
|
557
557
|
#
|
558
|
-
# The following operations are related to
|
559
|
-
# `DeleteBucketMetricsConfiguration`\:
|
558
|
+
# The following operations are related to `CompleteMultipartUpload`\:
|
560
559
|
#
|
561
560
|
# * CreateMultipartUpload
|
562
561
|
#
|
@@ -637,7 +636,7 @@ module Aws::S3
|
|
637
636
|
# bucket: "acexamplebucket",
|
638
637
|
# etag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
|
639
638
|
# key: "bigobject",
|
640
|
-
# location: "https://examplebucket.s3
|
639
|
+
# location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject",
|
641
640
|
# }
|
642
641
|
#
|
643
642
|
# @example Request syntax with placeholder values
|
@@ -682,58 +681,19 @@ module Aws::S3
|
|
682
681
|
#
|
683
682
|
# <note markdown="1"> You can store individual objects of up to 5 TB in Amazon S3. You
|
684
683
|
# create a copy of your object up to 5 GB in size in a single atomic
|
685
|
-
# operation using this API. However,
|
686
|
-
#
|
687
|
-
#
|
688
|
-
# API][1].
|
684
|
+
# operation using this API. However, to copy an object greater than 5
|
685
|
+
# GB, you must use the multipart upload Upload Part - Copy API. For more
|
686
|
+
# information, see [Copy Object Using the REST Multipart Upload API][1].
|
689
687
|
#
|
690
688
|
# </note>
|
691
689
|
#
|
692
|
-
# When copying an object, you can preserve all metadata (default) or
|
693
|
-
# specify new metadata. However, the ACL is not preserved and is set to
|
694
|
-
# private for the user making the request. To override the default ACL
|
695
|
-
# setting, specify a new ACL when generating a copy request. For more
|
696
|
-
# information, see [Using ACLs][2].
|
697
|
-
#
|
698
|
-
# Amazon S3 transfer acceleration does not support cross-region copies.
|
699
|
-
# If you request a cross-region copy using a transfer acceleration
|
700
|
-
# endpoint, you get a 400 `Bad Request` error. For more information
|
701
|
-
# about transfer acceleration, see [Transfer Acceleration][3].
|
702
|
-
#
|
703
690
|
# All copy requests must be authenticated. Additionally, you must have
|
704
691
|
# *read* access to the source object and *write* access to the
|
705
692
|
# destination bucket. For more information, see [REST
|
706
|
-
# Authentication][
|
693
|
+
# Authentication][2]. Both the Region that you want to copy the object
|
707
694
|
# from and the Region that you want to copy the object to must be
|
708
695
|
# enabled for your account.
|
709
696
|
#
|
710
|
-
# To only copy an object under certain conditions, such as whether the
|
711
|
-
# `Etag` matches or whether the object was modified before or after a
|
712
|
-
# specified date, use the request parameters
|
713
|
-
# `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`,
|
714
|
-
# `x-amz-copy-source-if-unmodified-since`, or `
|
715
|
-
# x-amz-copy-source-if-modified-since`.
|
716
|
-
#
|
717
|
-
# <note markdown="1"> All headers with the `x-amz-` prefix, including `x-amz-copy-source`,
|
718
|
-
# must be signed.
|
719
|
-
#
|
720
|
-
# </note>
|
721
|
-
#
|
722
|
-
# You can use this operation to change the storage class of an object
|
723
|
-
# that is already stored in Amazon S3 using the `StorageClass`
|
724
|
-
# parameter. For more information, see [Storage Classes][5].
|
725
|
-
#
|
726
|
-
# The source object that you are copying can be encrypted or
|
727
|
-
# unencrypted. If the source object is encrypted, it can be encrypted by
|
728
|
-
# server-side encryption using AWS managed encryption keys or by using a
|
729
|
-
# customer-provided encryption key. When copying an object, you can
|
730
|
-
# request that Amazon S3 encrypt the target object by using either the
|
731
|
-
# AWS managed encryption keys or by using your own encryption key. You
|
732
|
-
# can do this regardless of the form of server-side encryption that was
|
733
|
-
# used to encrypt the source, or even if the source object was not
|
734
|
-
# encrypted. For more information about server-side encryption, see
|
735
|
-
# [Using Server-Side Encryption][6].
|
736
|
-
#
|
737
697
|
# A copy request might return an error when Amazon S3 receives the copy
|
738
698
|
# request or while Amazon S3 is copying the files. If the error occurs
|
739
699
|
# before the copy operation starts, you receive a standard Amazon S3
|
@@ -752,182 +712,123 @@ module Aws::S3
|
|
752
712
|
#
|
753
713
|
# </note>
|
754
714
|
#
|
755
|
-
#
|
756
|
-
#
|
757
|
-
#
|
758
|
-
# `x-amz-copy-source-if-unmodified-since` headers are present in the
|
759
|
-
# request and evaluate as follows, Amazon S3 returns 200 OK and copies
|
760
|
-
# the data:
|
761
|
-
#
|
762
|
-
# * `x-amz-copy-source-if-match` condition evaluates to true
|
763
|
-
#
|
764
|
-
# * `x-amz-copy-source-if-unmodified-since` condition evaluates to
|
765
|
-
# false
|
766
|
-
#
|
767
|
-
# * Consideration 2 – If both of the `x-amz-copy-source-if-none-match`
|
768
|
-
# and `x-amz-copy-source-if-modified-since` headers are present in the
|
769
|
-
# request and evaluate as follows, Amazon S3 returns the `412
|
770
|
-
# Precondition Failed` response code:
|
771
|
-
#
|
772
|
-
# * `x-amz-copy-source-if-none-match` condition evaluates to false
|
773
|
-
#
|
774
|
-
# * `x-amz-copy-source-if-modified-since` condition evaluates to true
|
775
|
-
#
|
776
|
-
# The copy request charge is based on the storage class and Region you
|
777
|
-
# specify for the destination object. For pricing information, see
|
778
|
-
# [Amazon S3 Pricing][7].
|
779
|
-
#
|
780
|
-
# Following are other considerations when using `CopyObject`\:
|
781
|
-
#
|
782
|
-
# Versioning
|
783
|
-
#
|
784
|
-
# : By default, `x-amz-copy-source` identifies the current version of an
|
785
|
-
# object to copy. (If the current version is a delete marker, Amazon
|
786
|
-
# S3 behaves as if the object was deleted.) To copy a different
|
787
|
-
# version, use the `versionId` subresource.
|
788
|
-
#
|
789
|
-
# If you enable versioning on the target bucket, Amazon S3 generates a
|
790
|
-
# unique version ID for the object being copied. This version ID is
|
791
|
-
# different from the version ID of the source object. Amazon S3
|
792
|
-
# returns the version ID of the copied object in the
|
793
|
-
# `x-amz-version-id` response header in the response.
|
715
|
+
# The copy request charge is based on the storage class and Region that
|
716
|
+
# you specify for the destination object. For pricing information, see
|
717
|
+
# [Amazon S3 pricing][3].
|
794
718
|
#
|
795
|
-
#
|
796
|
-
#
|
719
|
+
# Amazon S3 transfer acceleration does not support cross-Region copies.
|
720
|
+
# If you request a cross-Region copy using a transfer acceleration
|
721
|
+
# endpoint, you get a 400 `Bad Request` error. For more information, see
|
722
|
+
# [Transfer Acceleration][4].
|
797
723
|
#
|
798
|
-
#
|
799
|
-
# copy of this object before you can use it as a source object for the
|
800
|
-
# copy operation. For more information, see .
|
801
|
-
#
|
802
|
-
# Access Permissions
|
803
|
-
#
|
804
|
-
# : When copying an object, you can optionally specify the accounts or
|
805
|
-
# groups that should be granted specific permissions on the new
|
806
|
-
# object. There are two ways to grant the permissions using the
|
807
|
-
# request headers:
|
808
|
-
#
|
809
|
-
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
810
|
-
# information, see [Canned ACL][8].
|
811
|
-
#
|
812
|
-
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
813
|
-
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
814
|
-
# `x-amz-grant-full-control` headers. These parameters map to the
|
815
|
-
# set of permissions that Amazon S3 supports in an ACL. For more
|
816
|
-
# information, see [Access Control List (ACL) Overview][9].
|
817
|
-
#
|
818
|
-
# You can use either a canned ACL or specify access permissions
|
819
|
-
# explicitly. You cannot do both.
|
820
|
-
#
|
821
|
-
# Server-Side- Encryption-Specific Request Headers
|
822
|
-
#
|
823
|
-
# : To encrypt the target object, you must provide the appropriate
|
824
|
-
# encryption-related request headers. The one you use depends on
|
825
|
-
# whether you want to use AWS managed encryption keys or provide your
|
826
|
-
# own encryption key.
|
827
|
-
#
|
828
|
-
# * To encrypt the target object using server-side encryption with an
|
829
|
-
# AWS managed encryption key, provide the following request headers,
|
830
|
-
# as appropriate.
|
831
|
-
#
|
832
|
-
# * `x-amz-server-side-encryption`
|
833
|
-
#
|
834
|
-
# * `x-amz-server-side-encryption-aws-kms-key-id`
|
835
|
-
#
|
836
|
-
# * `x-amz-server-side-encryption-context`
|
837
|
-
#
|
838
|
-
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
839
|
-
# provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
840
|
-
# uses the AWS managed CMK in AWS KMS to protect the data. If you
|
841
|
-
# want to use a customer managed AWS KMS CMK, you must provide the
|
842
|
-
# `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
|
843
|
-
# customer managed CMK. Amazon S3 only supports symmetric CMKs and
|
844
|
-
# not asymmetric CMKs. For more information, see [Using Symmetric
|
845
|
-
# and Asymmetric Keys][10] in the *AWS Key Management Service
|
846
|
-
# Developer Guide*.
|
847
|
-
#
|
848
|
-
# </note>
|
849
|
-
#
|
850
|
-
# All GET and PUT requests for an object protected by AWS KMS fail
|
851
|
-
# if you don't make them with SSL or by using SigV4.
|
724
|
+
# **Metadata**
|
852
725
|
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
726
|
+
# When copying an object, you can preserve all metadata (default) or
|
727
|
+
# specify new metadata. However, the ACL is not preserved and is set to
|
728
|
+
# private for the user making the request. To override the default ACL
|
729
|
+
# setting, specify a new ACL when generating a copy request. For more
|
730
|
+
# information, see [Using ACLs][5].
|
856
731
|
#
|
857
|
-
#
|
858
|
-
#
|
732
|
+
# To specify whether you want the object metadata copied from the source
|
733
|
+
# object or replaced with metadata provided in the request, you can
|
734
|
+
# optionally add the `x-amz-metadata-directive` header. When you grant
|
735
|
+
# permissions, you can use the `s3:x-amz-metadata-directive` condition
|
736
|
+
# key to enforce certain metadata behavior when objects are uploaded.
|
737
|
+
# For more information, see [Specifying Conditions in a Policy][6] in
|
738
|
+
# the *Amazon S3 Developer Guide*. For a complete list of Amazon
|
739
|
+
# S3-specific condition keys, see [Actions, Resources, and Condition
|
740
|
+
# Keys for Amazon S3][7].
|
859
741
|
#
|
860
|
-
#
|
742
|
+
# <b> <code>x-amz-copy-source-if</code> Headers</b>
|
861
743
|
#
|
862
|
-
#
|
744
|
+
# To only copy an object under certain conditions, such as whether the
|
745
|
+
# `Etag` matches or whether the object was modified before or after a
|
746
|
+
# specified date, use the following request parameters:
|
863
747
|
#
|
864
|
-
#
|
748
|
+
# * `x-amz-copy-source-if-match`
|
865
749
|
#
|
866
|
-
#
|
867
|
-
# with customer-provided encryption keys, you must use the following
|
868
|
-
# headers.
|
750
|
+
# * `x-amz-copy-source-if-none-match`
|
869
751
|
#
|
870
|
-
#
|
752
|
+
# * `x-amz-copy-source-if-unmodified-since`
|
871
753
|
#
|
872
|
-
#
|
754
|
+
# * `x-amz-copy-source-if-modified-since`
|
873
755
|
#
|
874
|
-
#
|
756
|
+
# If both the `x-amz-copy-source-if-match` and
|
757
|
+
# `x-amz-copy-source-if-unmodified-since` headers are present in the
|
758
|
+
# request and evaluate as follows, Amazon S3 returns `200 OK` and copies
|
759
|
+
# the data:
|
875
760
|
#
|
876
|
-
#
|
877
|
-
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
878
|
-
# Encryption with CMKs stored in Amazon KMS][11].
|
761
|
+
# * `x-amz-copy-source-if-match` condition evaluates to true
|
879
762
|
#
|
880
|
-
#
|
763
|
+
# * `x-amz-copy-source-if-unmodified-since` condition evaluates to false
|
881
764
|
#
|
882
|
-
#
|
883
|
-
#
|
884
|
-
#
|
885
|
-
#
|
886
|
-
# defined by Amazon S3. These permissions are then added to the access
|
887
|
-
# control list (ACL) on the object. For more information, see [Using
|
888
|
-
# ACLs][2]. With this operation, you can grant access permissions
|
889
|
-
# using one of the following two methods:
|
765
|
+
# If both the `x-amz-copy-source-if-none-match` and
|
766
|
+
# `x-amz-copy-source-if-modified-since` headers are present in the
|
767
|
+
# request and evaluate as follows, Amazon S3 returns the `412
|
768
|
+
# Precondition Failed` response code:
|
890
769
|
#
|
891
|
-
#
|
892
|
-
# predefined ACLs, known as *canned ACLs*. Each canned ACL has a
|
893
|
-
# predefined set of grantees and permissions. For more information,
|
894
|
-
# see [Canned ACL][8].
|
770
|
+
# * `x-amz-copy-source-if-none-match` condition evaluates to false
|
895
771
|
#
|
896
|
-
#
|
897
|
-
# permissions to specific AWS accounts or groups, use the following
|
898
|
-
# headers. Each header maps to specific permissions that Amazon S3
|
899
|
-
# supports in an ACL. For more information, see [Access Control List
|
900
|
-
# (ACL) Overview][9]. In the header, you specify a list of grantees
|
901
|
-
# who get the specific permission. To grant permissions explicitly,
|
902
|
-
# use:
|
772
|
+
# * `x-amz-copy-source-if-modified-since` condition evaluates to true
|
903
773
|
#
|
904
|
-
#
|
774
|
+
# <note markdown="1"> All headers with the `x-amz-` prefix, including `x-amz-copy-source`,
|
775
|
+
# must be signed.
|
905
776
|
#
|
906
|
-
#
|
777
|
+
# </note>
|
907
778
|
#
|
908
|
-
#
|
779
|
+
# **Encryption**
|
909
780
|
#
|
910
|
-
#
|
781
|
+
# The source object that you are copying can be encrypted or
|
782
|
+
# unencrypted. The source object can be encrypted with server-side
|
783
|
+
# encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by
|
784
|
+
# using a customer-provided encryption key. With server-side encryption,
|
785
|
+
# Amazon S3 encrypts your data as it writes it to disks in its data
|
786
|
+
# centers and decrypts the data when you access it.
|
787
|
+
#
|
788
|
+
# You can optionally use the appropriate encryption-related headers to
|
789
|
+
# request server-side encryption for the target object. You have the
|
790
|
+
# option to provide your own encryption key or use SSE-S3 or SSE-KMS,
|
791
|
+
# regardless of the form of server-side encryption that was used to
|
792
|
+
# encrypt the source object. You can even request encryption if the
|
793
|
+
# source object was not encrypted. For more information about
|
794
|
+
# server-side encryption, see [Using Server-Side Encryption][8].
|
795
|
+
#
|
796
|
+
# **Access Control List (ACL)-Specific Request Headers**
|
797
|
+
#
|
798
|
+
# When copying an object, you can optionally use headers to grant
|
799
|
+
# ACL-based permissions. By default, all objects are private. Only the
|
800
|
+
# owner has full access control. When adding a new object, you can grant
|
801
|
+
# permissions to individual AWS accounts or to predefined groups defined
|
802
|
+
# by Amazon S3. These permissions are then added to the ACL on the
|
803
|
+
# object. For more information, see [Access Control List (ACL)
|
804
|
+
# Overview][9] and [Managing ACLs Using the REST API][10].
|
911
805
|
#
|
912
|
-
#
|
806
|
+
# **Storage Class Options**
|
913
807
|
#
|
914
|
-
#
|
915
|
-
#
|
808
|
+
# You can use the `CopyObject` operation to change the storage class of
|
809
|
+
# an object that is already stored in Amazon S3 using the `StorageClass`
|
810
|
+
# parameter. For more information, see [Storage Classes][11] in the
|
811
|
+
# *Amazon S3 Service Developer Guide*.
|
916
812
|
#
|
917
|
-
#
|
918
|
-
# an AWS account
|
813
|
+
# **Versioning**
|
919
814
|
#
|
920
|
-
#
|
921
|
-
#
|
815
|
+
# By default, `x-amz-copy-source` identifies the current version of an
|
816
|
+
# object to copy. If the current version is a delete marker, Amazon S3
|
817
|
+
# behaves as if the object was deleted. To copy a different version, use
|
818
|
+
# the `versionId` subresource.
|
922
819
|
#
|
923
|
-
#
|
820
|
+
# If you enable versioning on the target bucket, Amazon S3 generates a
|
821
|
+
# unique version ID for the object being copied. This version ID is
|
822
|
+
# different from the version ID of the source object. Amazon S3 returns
|
823
|
+
# the version ID of the copied object in the `x-amz-version-id` response
|
824
|
+
# header in the response.
|
924
825
|
#
|
925
|
-
#
|
926
|
-
#
|
927
|
-
# object data and its metadata:
|
826
|
+
# If you do not enable versioning or suspend it on the target bucket,
|
827
|
+
# the version ID that Amazon S3 generates is always null.
|
928
828
|
#
|
929
|
-
#
|
930
|
-
#
|
829
|
+
# If the source object's storage class is GLACIER, you must restore a
|
830
|
+
# copy of this object before you can use it as a source object for the
|
831
|
+
# copy operation. For more information, see .
|
931
832
|
#
|
932
833
|
# The following operations are related to `CopyObject`\:
|
933
834
|
#
|
@@ -940,16 +841,16 @@ module Aws::S3
|
|
940
841
|
#
|
941
842
|
#
|
942
843
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
|
943
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
944
|
-
# [3]: https://
|
945
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
946
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
947
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
948
|
-
# [7]: https://aws.amazon.com/
|
949
|
-
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
844
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
845
|
+
# [3]: https://aws.amazon.com/s3/pricing/
|
846
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
847
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
848
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
|
849
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html
|
850
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
950
851
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
951
|
-
# [10]: https://docs.aws.amazon.com/
|
952
|
-
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
852
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
853
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
953
854
|
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
|
954
855
|
#
|
955
856
|
# @option params [String] :acl
|
@@ -1219,7 +1120,7 @@ module Aws::S3
|
|
1219
1120
|
# You can optionally specify a Region in the request body. You might
|
1220
1121
|
# choose a Region to optimize latency, minimize costs, or address
|
1221
1122
|
# regulatory requirements. For example, if you reside in Europe, you
|
1222
|
-
# will probably find it advantageous to create buckets in the
|
1123
|
+
# will probably find it advantageous to create buckets in the Europe
|
1223
1124
|
# (Ireland) Region. For more information, see [How to Select a Region
|
1224
1125
|
# for Your Buckets][2].
|
1225
1126
|
#
|
@@ -1254,20 +1155,43 @@ module Aws::S3
|
|
1254
1155
|
# You specify each grantee as a type=value pair, where the type is one
|
1255
1156
|
# of the following:
|
1256
1157
|
#
|
1257
|
-
# * `emailAddress` – if the value specified is the email address of an
|
1258
|
-
# AWS account
|
1259
|
-
#
|
1260
1158
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
1261
1159
|
# account
|
1262
1160
|
#
|
1263
1161
|
# * `uri` – if you are granting permissions to a predefined group
|
1264
1162
|
#
|
1163
|
+
# * `emailAddress` – if the value specified is the email address of an
|
1164
|
+
# AWS account
|
1165
|
+
#
|
1166
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
1167
|
+
# the following AWS Regions:
|
1168
|
+
#
|
1169
|
+
# * US East (N. Virginia)
|
1170
|
+
#
|
1171
|
+
# * US West (N. California)
|
1172
|
+
#
|
1173
|
+
# * US West (Oregon)
|
1174
|
+
#
|
1175
|
+
# * Asia Pacific (Singapore)
|
1176
|
+
#
|
1177
|
+
# * Asia Pacific (Sydney)
|
1178
|
+
#
|
1179
|
+
# * Asia Pacific (Tokyo)
|
1180
|
+
#
|
1181
|
+
# * Europe (Ireland)
|
1182
|
+
#
|
1183
|
+
# * South America (São Paulo)
|
1184
|
+
#
|
1185
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1186
|
+
# see [Regions and Endpoints][6] in the AWS General Reference.
|
1187
|
+
#
|
1188
|
+
# </note>
|
1189
|
+
#
|
1265
1190
|
# For example, the following `x-amz-grant-read` header grants the AWS
|
1266
|
-
# accounts identified by
|
1267
|
-
#
|
1191
|
+
# accounts identified by account IDs permissions to read object data
|
1192
|
+
# and its metadata:
|
1268
1193
|
#
|
1269
|
-
# `x-amz-grant-read:
|
1270
|
-
# emailAddress="abc@amazon.com" `
|
1194
|
+
# `x-amz-grant-read: id="11112222333", id="444455556666" `
|
1271
1195
|
#
|
1272
1196
|
# <note markdown="1"> You can use either a canned ACL or specify access permissions
|
1273
1197
|
# explicitly. You cannot do both.
|
@@ -1287,6 +1211,7 @@ module Aws::S3
|
|
1287
1211
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
1288
1212
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1289
1213
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1214
|
+
# [6]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1290
1215
|
#
|
1291
1216
|
# @option params [String] :acl
|
1292
1217
|
# The canned ACL to apply to the bucket.
|
@@ -1349,7 +1274,7 @@ module Aws::S3
|
|
1349
1274
|
#
|
1350
1275
|
# resp.to_h outputs the following:
|
1351
1276
|
# {
|
1352
|
-
# location: "http://examplebucket
|
1277
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1353
1278
|
# }
|
1354
1279
|
#
|
1355
1280
|
# @example Request syntax with placeholder values
|
@@ -1545,20 +1470,43 @@ module Aws::S3
|
|
1545
1470
|
# You specify each grantee as a type=value pair, where the type is
|
1546
1471
|
# one of the following:
|
1547
1472
|
#
|
1548
|
-
# * `emailAddress` – if the value specified is the email address of
|
1549
|
-
# an AWS account
|
1550
|
-
#
|
1551
1473
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
1552
1474
|
# account
|
1553
1475
|
#
|
1554
1476
|
# * `uri` – if you are granting permissions to a predefined group
|
1555
1477
|
#
|
1478
|
+
# * `emailAddress` – if the value specified is the email address of
|
1479
|
+
# an AWS account
|
1480
|
+
#
|
1481
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
1482
|
+
# the following AWS Regions:
|
1483
|
+
#
|
1484
|
+
# * US East (N. Virginia)
|
1485
|
+
#
|
1486
|
+
# * US West (N. California)
|
1487
|
+
#
|
1488
|
+
# * US West (Oregon)
|
1489
|
+
#
|
1490
|
+
# * Asia Pacific (Singapore)
|
1491
|
+
#
|
1492
|
+
# * Asia Pacific (Sydney)
|
1493
|
+
#
|
1494
|
+
# * Asia Pacific (Tokyo)
|
1495
|
+
#
|
1496
|
+
# * Europe (Ireland)
|
1497
|
+
#
|
1498
|
+
# * South America (São Paulo)
|
1499
|
+
#
|
1500
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1501
|
+
# see [Regions and Endpoints][10] in the AWS General Reference.
|
1502
|
+
#
|
1503
|
+
# </note>
|
1504
|
+
#
|
1556
1505
|
# For example, the following `x-amz-grant-read` header grants the
|
1557
|
-
# AWS accounts identified by
|
1558
|
-
#
|
1506
|
+
# AWS accounts identified by account IDs permissions to read object
|
1507
|
+
# data and its metadata:
|
1559
1508
|
#
|
1560
|
-
# `x-amz-grant-read:
|
1561
|
-
# emailAddress="abc@amazon.com" `
|
1509
|
+
# `x-amz-grant-read: id="11112222333", id="444455556666" `
|
1562
1510
|
#
|
1563
1511
|
# The following operations are related to `CreateMultipartUpload`\:
|
1564
1512
|
#
|
@@ -1583,6 +1531,7 @@ module Aws::S3
|
|
1583
1531
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1584
1532
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1585
1533
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1534
|
+
# [10]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1586
1535
|
#
|
1587
1536
|
# @option params [String] :acl
|
1588
1537
|
# The canned ACL to apply to the object.
|
@@ -1848,7 +1797,7 @@ module Aws::S3
|
|
1848
1797
|
#
|
1849
1798
|
#
|
1850
1799
|
#
|
1851
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
1800
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1852
1801
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1853
1802
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
1854
1803
|
#
|
@@ -1945,9 +1894,9 @@ module Aws::S3
|
|
1945
1894
|
#
|
1946
1895
|
#
|
1947
1896
|
#
|
1948
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
1949
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
1950
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
1897
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
1898
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1899
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1951
1900
|
#
|
1952
1901
|
# @option params [required, String] :bucket
|
1953
1902
|
# The name of the bucket containing the server-side encryption
|
@@ -2428,15 +2377,6 @@ module Aws::S3
|
|
2428
2377
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2429
2378
|
#
|
2430
2379
|
#
|
2431
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
2432
|
-
#
|
2433
|
-
# # The following example deletes an object from a non-versioned bucket.
|
2434
|
-
#
|
2435
|
-
# resp = client.delete_object({
|
2436
|
-
# bucket: "ExampleBucket",
|
2437
|
-
# key: "HappyFace.jpg",
|
2438
|
-
# })
|
2439
|
-
#
|
2440
2380
|
# @example Example: To delete an object
|
2441
2381
|
#
|
2442
2382
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2450,6 +2390,15 @@ module Aws::S3
|
|
2450
2390
|
# {
|
2451
2391
|
# }
|
2452
2392
|
#
|
2393
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2394
|
+
#
|
2395
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2396
|
+
#
|
2397
|
+
# resp = client.delete_object({
|
2398
|
+
# bucket: "ExampleBucket",
|
2399
|
+
# key: "HappyFace.jpg",
|
2400
|
+
# })
|
2401
|
+
#
|
2453
2402
|
# @example Request syntax with placeholder values
|
2454
2403
|
#
|
2455
2404
|
# resp = client.delete_object({
|
@@ -2670,20 +2619,22 @@ module Aws::S3
|
|
2670
2619
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
2671
2620
|
#
|
2672
2621
|
#
|
2673
|
-
# @example Example: To delete multiple
|
2622
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
2674
2623
|
#
|
2675
|
-
# # The following example deletes objects from a bucket. The
|
2676
|
-
# #
|
2624
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
2625
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
2677
2626
|
#
|
2678
2627
|
# resp = client.delete_objects({
|
2679
2628
|
# bucket: "examplebucket",
|
2680
2629
|
# delete: {
|
2681
2630
|
# objects: [
|
2682
2631
|
# {
|
2683
|
-
# key: "
|
2632
|
+
# key: "HappyFace.jpg",
|
2633
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2684
2634
|
# },
|
2685
2635
|
# {
|
2686
|
-
# key: "
|
2636
|
+
# key: "HappyFace.jpg",
|
2637
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2687
2638
|
# },
|
2688
2639
|
# ],
|
2689
2640
|
# quiet: false,
|
@@ -2694,34 +2645,30 @@ module Aws::S3
|
|
2694
2645
|
# {
|
2695
2646
|
# deleted: [
|
2696
2647
|
# {
|
2697
|
-
#
|
2698
|
-
#
|
2699
|
-
# key: "objectkey1",
|
2648
|
+
# key: "HappyFace.jpg",
|
2649
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2700
2650
|
# },
|
2701
2651
|
# {
|
2702
|
-
#
|
2703
|
-
#
|
2704
|
-
# key: "objectkey2",
|
2652
|
+
# key: "HappyFace.jpg",
|
2653
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2705
2654
|
# },
|
2706
2655
|
# ],
|
2707
2656
|
# }
|
2708
2657
|
#
|
2709
|
-
# @example Example: To delete multiple
|
2658
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
2710
2659
|
#
|
2711
|
-
# # The following example deletes objects from a bucket. The
|
2712
|
-
# #
|
2660
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
2661
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
2713
2662
|
#
|
2714
2663
|
# resp = client.delete_objects({
|
2715
2664
|
# bucket: "examplebucket",
|
2716
2665
|
# delete: {
|
2717
2666
|
# objects: [
|
2718
2667
|
# {
|
2719
|
-
# key: "
|
2720
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2668
|
+
# key: "objectkey1",
|
2721
2669
|
# },
|
2722
2670
|
# {
|
2723
|
-
# key: "
|
2724
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2671
|
+
# key: "objectkey2",
|
2725
2672
|
# },
|
2726
2673
|
# ],
|
2727
2674
|
# quiet: false,
|
@@ -2732,12 +2679,14 @@ module Aws::S3
|
|
2732
2679
|
# {
|
2733
2680
|
# deleted: [
|
2734
2681
|
# {
|
2735
|
-
#
|
2736
|
-
#
|
2682
|
+
# delete_marker: true,
|
2683
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
2684
|
+
# key: "objectkey1",
|
2737
2685
|
# },
|
2738
2686
|
# {
|
2739
|
-
#
|
2740
|
-
#
|
2687
|
+
# delete_marker: true,
|
2688
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
2689
|
+
# key: "objectkey2",
|
2741
2690
|
# },
|
2742
2691
|
# ],
|
2743
2692
|
# }
|
@@ -2790,8 +2739,7 @@ module Aws::S3
|
|
2790
2739
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
2791
2740
|
# Resources][2].
|
2792
2741
|
#
|
2793
|
-
# The following operations are related to
|
2794
|
-
# `DeleteBucketMetricsConfiguration`\:
|
2742
|
+
# The following operations are related to `DeletePublicAccessBlock`\:
|
2795
2743
|
#
|
2796
2744
|
# * [Using Amazon S3 Block Public Access][3]
|
2797
2745
|
#
|
@@ -2861,9 +2809,9 @@ module Aws::S3
|
|
2861
2809
|
#
|
2862
2810
|
#
|
2863
2811
|
#
|
2864
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
2865
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
2866
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
2812
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2813
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2814
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
2867
2815
|
#
|
2868
2816
|
# @option params [required, String] :bucket
|
2869
2817
|
# Name of the bucket for which the accelerate configuration is
|
@@ -3348,7 +3296,7 @@ module Aws::S3
|
|
3348
3296
|
# * SOAP Fault Code Prefix: Client
|
3349
3297
|
#
|
3350
3298
|
# The following operations are related to
|
3351
|
-
# `
|
3299
|
+
# `GetBucketLifecycleConfiguration`\:
|
3352
3300
|
#
|
3353
3301
|
# * GetBucketLifecycle
|
3354
3302
|
#
|
@@ -3605,7 +3553,7 @@ module Aws::S3
|
|
3605
3553
|
# No longer used, see GetBucketNotificationConfiguration.
|
3606
3554
|
#
|
3607
3555
|
# @option params [required, String] :bucket
|
3608
|
-
# Name of the bucket for which to get the notification configuration
|
3556
|
+
# Name of the bucket for which to get the notification configuration.
|
3609
3557
|
#
|
3610
3558
|
# @return [Types::NotificationConfigurationDeprecated] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3611
3559
|
#
|
@@ -3731,7 +3679,7 @@ module Aws::S3
|
|
3731
3679
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
3732
3680
|
#
|
3733
3681
|
# @option params [required, String] :bucket
|
3734
|
-
# Name of the bucket for which to get the notification configuration
|
3682
|
+
# Name of the bucket for which to get the notification configuration.
|
3735
3683
|
#
|
3736
3684
|
# @return [Types::NotificationConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3737
3685
|
#
|
@@ -4466,7 +4414,16 @@ module Aws::S3
|
|
4466
4414
|
# @option params [String] :range
|
4467
4415
|
# Downloads the specified range bytes of an object. For more information
|
4468
4416
|
# about the HTTP Range header, see
|
4469
|
-
# [
|
4417
|
+
# [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].
|
4418
|
+
#
|
4419
|
+
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
4420
|
+
# `GET` request.
|
4421
|
+
#
|
4422
|
+
# </note>
|
4423
|
+
#
|
4424
|
+
#
|
4425
|
+
#
|
4426
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
|
4470
4427
|
#
|
4471
4428
|
# @option params [String] :response_cache_control
|
4472
4429
|
# Sets the `Cache-Control` header of the response.
|
@@ -5446,6 +5403,11 @@ module Aws::S3
|
|
5446
5403
|
# about the HTTP Range header, see
|
5447
5404
|
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
5448
5405
|
#
|
5406
|
+
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
5407
|
+
# `GET` request.
|
5408
|
+
#
|
5409
|
+
# </note>
|
5410
|
+
#
|
5449
5411
|
# @option params [String] :version_id
|
5450
5412
|
# VersionId used to reference a specific version of the object.
|
5451
5413
|
#
|
@@ -6248,12 +6210,12 @@ module Aws::S3
|
|
6248
6210
|
# Specifies the key to start with when listing objects in a bucket.
|
6249
6211
|
#
|
6250
6212
|
# @option params [Integer] :max_keys
|
6251
|
-
# Sets the maximum number of keys returned in the response.
|
6252
|
-
#
|
6253
|
-
# keys
|
6254
|
-
# max-keys was exceeded,
|
6255
|
-
# <isTruncated>true</isTruncated>. To
|
6256
|
-
# keys, see key-marker and version-id-marker.
|
6213
|
+
# Sets the maximum number of keys returned in the response. By default
|
6214
|
+
# the API returns up to 1,000 key names. The response might contain
|
6215
|
+
# fewer keys but will never contain more. If additional keys satisfy the
|
6216
|
+
# search criteria, but were not returned because max-keys was exceeded,
|
6217
|
+
# the response contains <isTruncated>true</isTruncated>. To
|
6218
|
+
# return the additional keys, see key-marker and version-id-marker.
|
6257
6219
|
#
|
6258
6220
|
# @option params [String] :prefix
|
6259
6221
|
# Use this parameter to select only those keys that begin with the
|
@@ -6421,8 +6383,9 @@ module Aws::S3
|
|
6421
6383
|
# Specifies the key to start with when listing objects in a bucket.
|
6422
6384
|
#
|
6423
6385
|
# @option params [Integer] :max_keys
|
6424
|
-
# Sets the maximum number of keys returned in the response.
|
6425
|
-
#
|
6386
|
+
# Sets the maximum number of keys returned in the response. By default
|
6387
|
+
# the API returns up to 1,000 key names. The response might contain
|
6388
|
+
# fewer keys but will never contain more.
|
6426
6389
|
#
|
6427
6390
|
# @option params [String] :prefix
|
6428
6391
|
# Limits the response to keys that begin with the specified prefix.
|
@@ -6585,8 +6548,9 @@ module Aws::S3
|
|
6585
6548
|
# Encoding type used by Amazon S3 to encode object keys in the response.
|
6586
6549
|
#
|
6587
6550
|
# @option params [Integer] :max_keys
|
6588
|
-
# Sets the maximum number of keys returned in the response.
|
6589
|
-
#
|
6551
|
+
# Sets the maximum number of keys returned in the response. By default
|
6552
|
+
# the API returns up to 1,000 key names. The response might contain
|
6553
|
+
# fewer keys but will never contain more.
|
6590
6554
|
#
|
6591
6555
|
# @option params [String] :prefix
|
6592
6556
|
# Limits the response to keys that begin with the specified prefix.
|
@@ -7002,38 +6966,54 @@ module Aws::S3
|
|
7002
6966
|
# You specify each grantee as a type=value pair, where the type is one
|
7003
6967
|
# of the following:
|
7004
6968
|
#
|
7005
|
-
# * `emailAddress` – if the value specified is the email address of an
|
7006
|
-
# AWS account
|
7007
|
-
#
|
7008
6969
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
7009
6970
|
# account
|
7010
6971
|
#
|
7011
6972
|
# * `uri` – if you are granting permissions to a predefined group
|
7012
6973
|
#
|
7013
|
-
#
|
7014
|
-
#
|
7015
|
-
# predefined by Amazon S3 and two AWS accounts identified by their
|
7016
|
-
# email addresses.
|
6974
|
+
# * `emailAddress` – if the value specified is the email address of an
|
6975
|
+
# AWS account
|
7017
6976
|
#
|
7018
|
-
#
|
7019
|
-
#
|
7020
|
-
# emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" `
|
6977
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
6978
|
+
# the following AWS Regions:
|
7021
6979
|
#
|
7022
|
-
#
|
7023
|
-
# explicitly. You cannot do both.
|
6980
|
+
# * US East (N. Virginia)
|
7024
6981
|
#
|
7025
|
-
#
|
6982
|
+
# * US West (N. California)
|
7026
6983
|
#
|
7027
|
-
#
|
7028
|
-
# rights (using request elements) in the following ways:
|
6984
|
+
# * US West (Oregon)
|
7029
6985
|
#
|
7030
|
-
#
|
6986
|
+
# * Asia Pacific (Singapore)
|
7031
6987
|
#
|
7032
|
-
#
|
7033
|
-
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
6988
|
+
# * Asia Pacific (Sydney)
|
7034
6989
|
#
|
7035
|
-
#
|
7036
|
-
#
|
6990
|
+
# * Asia Pacific (Tokyo)
|
6991
|
+
#
|
6992
|
+
# * Europe (Ireland)
|
6993
|
+
#
|
6994
|
+
# * South America (São Paulo)
|
6995
|
+
#
|
6996
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
6997
|
+
# see [Regions and Endpoints][4] in the AWS General Reference.
|
6998
|
+
#
|
6999
|
+
# </note>
|
7000
|
+
#
|
7001
|
+
# For example, the following `x-amz-grant-write` header grants create,
|
7002
|
+
# overwrite, and delete objects permission to LogDelivery group
|
7003
|
+
# predefined by Amazon S3 and two AWS accounts identified by their
|
7004
|
+
# email addresses.
|
7005
|
+
#
|
7006
|
+
# `x-amz-grant-write:
|
7007
|
+
# uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
7008
|
+
# id="111122223333", id="555566667777" `
|
7009
|
+
#
|
7010
|
+
# You can use either a canned ACL or specify access permissions
|
7011
|
+
# explicitly. You cannot do both.
|
7012
|
+
#
|
7013
|
+
# **Grantee Values**
|
7014
|
+
#
|
7015
|
+
# You can specify the person (grantee) to whom you're assigning access
|
7016
|
+
# rights (using request elements) in the following ways:
|
7037
7017
|
#
|
7038
7018
|
# * By the person's ID:
|
7039
7019
|
#
|
@@ -7048,6 +7028,38 @@ module Aws::S3
|
|
7048
7028
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
7049
7029
|
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
|
7050
7030
|
#
|
7031
|
+
# * By Email address:
|
7032
|
+
#
|
7033
|
+
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
7034
|
+
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
7035
|
+
#
|
7036
|
+
# The grantee is resolved to the CanonicalUser and, in a response to a
|
7037
|
+
# GET Object acl request, appears as the CanonicalUser.
|
7038
|
+
#
|
7039
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
|
7040
|
+
# following AWS Regions:
|
7041
|
+
#
|
7042
|
+
# * US East (N. Virginia)
|
7043
|
+
#
|
7044
|
+
# * US West (N. California)
|
7045
|
+
#
|
7046
|
+
# * US West (Oregon)
|
7047
|
+
#
|
7048
|
+
# * Asia Pacific (Singapore)
|
7049
|
+
#
|
7050
|
+
# * Asia Pacific (Sydney)
|
7051
|
+
#
|
7052
|
+
# * Asia Pacific (Tokyo)
|
7053
|
+
#
|
7054
|
+
# * Europe (Ireland)
|
7055
|
+
#
|
7056
|
+
# * South America (São Paulo)
|
7057
|
+
#
|
7058
|
+
# For a list of all the Amazon S3 supported Regions and endpoints, see
|
7059
|
+
# [Regions and Endpoints][4] in the AWS General Reference.
|
7060
|
+
#
|
7061
|
+
# </note>
|
7062
|
+
#
|
7051
7063
|
# **Related Resources**
|
7052
7064
|
#
|
7053
7065
|
# * CreateBucket
|
@@ -7061,6 +7073,7 @@ module Aws::S3
|
|
7061
7073
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
7062
7074
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
7063
7075
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
7076
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
7064
7077
|
#
|
7065
7078
|
# @option params [String] :acl
|
7066
7079
|
# The canned ACL to apply to the bucket.
|
@@ -7336,7 +7349,7 @@ module Aws::S3
|
|
7336
7349
|
#
|
7337
7350
|
#
|
7338
7351
|
#
|
7339
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7352
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
7340
7353
|
#
|
7341
7354
|
# @option params [String] :content_md5
|
7342
7355
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -7425,7 +7438,9 @@ module Aws::S3
|
|
7425
7438
|
#
|
7426
7439
|
# This implementation of the `PUT` operation sets default encryption for
|
7427
7440
|
# a bucket using server-side encryption with Amazon S3-managed keys
|
7428
|
-
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS).
|
7441
|
+
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For
|
7442
|
+
# information about the Amazon S3 default encryption feature, see
|
7443
|
+
# [Amazon S3 Default Bucket Encryption][1].
|
7429
7444
|
#
|
7430
7445
|
# This operation requires AWS Signature Version 4. For more information,
|
7431
7446
|
# see [ Authenticating Requests (AWS Signature Version
|
@@ -7435,8 +7450,8 @@ module Aws::S3
|
|
7435
7450
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
7436
7451
|
# permission by default. The bucket owner can grant this permission to
|
7437
7452
|
# others. For more information about permissions, see [Permissions
|
7438
|
-
# Related to Bucket Subresource Operations][
|
7439
|
-
# Permissions to Your Amazon S3 Resources][
|
7453
|
+
# Related to Bucket Subresource Operations][2] and [Managing Access
|
7454
|
+
# Permissions to Your Amazon S3 Resources][3] in the Amazon Simple
|
7440
7455
|
# Storage Service Developer Guide.
|
7441
7456
|
#
|
7442
7457
|
# **Related Resources**
|
@@ -7447,8 +7462,9 @@ module Aws::S3
|
|
7447
7462
|
#
|
7448
7463
|
#
|
7449
7464
|
#
|
7450
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7451
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
|
7465
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
7466
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7467
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7452
7468
|
#
|
7453
7469
|
# @option params [required, String] :bucket
|
7454
7470
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -7519,7 +7535,7 @@ module Aws::S3
|
|
7519
7535
|
# You must create a bucket policy on the *destination* bucket to grant
|
7520
7536
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
7521
7537
|
# location. For an example policy, see [ Granting Permissions for Amazon
|
7522
|
-
# S3 Inventory and Storage Class Analysis
|
7538
|
+
# S3 Inventory and Storage Class Analysis][2].
|
7523
7539
|
#
|
7524
7540
|
# To use this operation, you must have permissions to perform the
|
7525
7541
|
# `s3:PutInventoryConfiguration` action. The bucket owner has this
|
@@ -7550,7 +7566,7 @@ module Aws::S3
|
|
7550
7566
|
#
|
7551
7567
|
# * *Cause:* You are not the owner of the specified bucket, or you do
|
7552
7568
|
# not have the `s3:PutInventoryConfiguration` bucket permission to
|
7553
|
-
# set the configuration on the bucket
|
7569
|
+
# set the configuration on the bucket.
|
7554
7570
|
#
|
7555
7571
|
# **Related Resources**
|
7556
7572
|
#
|
@@ -7562,10 +7578,10 @@ module Aws::S3
|
|
7562
7578
|
#
|
7563
7579
|
#
|
7564
7580
|
#
|
7565
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7581
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
7566
7582
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9
|
7567
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7568
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7583
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7584
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7569
7585
|
#
|
7570
7586
|
# @option params [required, String] :bucket
|
7571
7587
|
# The name of the bucket where the inventory configuration will be
|
@@ -7678,10 +7694,10 @@ module Aws::S3
|
|
7678
7694
|
#
|
7679
7695
|
#
|
7680
7696
|
#
|
7681
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7682
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7683
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7684
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7697
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
7698
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7699
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
7700
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
7685
7701
|
#
|
7686
7702
|
# @option params [required, String] :bucket
|
7687
7703
|
#
|
@@ -8354,7 +8370,7 @@ module Aws::S3
|
|
8354
8370
|
# permissions on the specified bucket and belong to the bucket owner's
|
8355
8371
|
# account in order to use this operation.
|
8356
8372
|
#
|
8357
|
-
# If you don't have `
|
8373
|
+
# If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a
|
8358
8374
|
# `403 Access Denied` error. If you have the correct permissions, but
|
8359
8375
|
# you're not using an identity that belongs to the bucket owner's
|
8360
8376
|
# account, Amazon S3 returns a `405 Method Not Allowed` error.
|
@@ -8737,8 +8753,8 @@ module Aws::S3
|
|
8737
8753
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
8738
8754
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8739
8755
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
8740
|
-
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2
|
8741
|
-
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2
|
8756
|
+
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
8757
|
+
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
8742
8758
|
#
|
8743
8759
|
# @option params [required, String] :bucket
|
8744
8760
|
# The bucket name.
|
@@ -8962,9 +8978,15 @@ module Aws::S3
|
|
8962
8978
|
#
|
8963
8979
|
# * `HttpRedirectCode`
|
8964
8980
|
#
|
8981
|
+
# Amazon S3 has a limitation of 50 routing rules per website
|
8982
|
+
# configuration. If you require more than 50 routing rules, you can use
|
8983
|
+
# object redirect. For more information, see [Configuring an Object
|
8984
|
+
# Redirect][2] in the *Amazon Simple Storage Service Developer Guide*.
|
8985
|
+
#
|
8965
8986
|
#
|
8966
8987
|
#
|
8967
8988
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
8989
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
8968
8990
|
#
|
8969
8991
|
# @option params [required, String] :bucket
|
8970
8992
|
# The bucket name.
|
@@ -9063,16 +9085,16 @@ module Aws::S3
|
|
9063
9085
|
# putting an object to Amazon S3 and compare the returned ETag to the
|
9064
9086
|
# calculated MD5 value.
|
9065
9087
|
#
|
9066
|
-
# <note markdown="1">
|
9067
|
-
#
|
9068
|
-
#
|
9069
|
-
#
|
9070
|
-
#
|
9071
|
-
# the `100-continue` HTTP status code, see Section 8.2.3 of
|
9072
|
-
# [http://www.ietf.org/rfc/rfc2616.txt][1].
|
9088
|
+
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
9089
|
+
# object with a retention period configured using Amazon S3 Object Lock.
|
9090
|
+
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
9091
|
+
# Object Lock Overview][1] in the *Amazon Simple Storage Service
|
9092
|
+
# Developer Guide*.
|
9073
9093
|
#
|
9074
9094
|
# </note>
|
9075
9095
|
#
|
9096
|
+
# **Server-side Encryption**
|
9097
|
+
#
|
9076
9098
|
# You can optionally request server-side encryption. With server-side
|
9077
9099
|
# encryption, Amazon S3 encrypts your data as it writes it to disks in
|
9078
9100
|
# its data centers and decrypts the data when you access it. You have
|
@@ -9080,229 +9102,35 @@ module Aws::S3
|
|
9080
9102
|
# encryption keys. For more information, see [Using Server-Side
|
9081
9103
|
# Encryption][2].
|
9082
9104
|
#
|
9083
|
-
# Access
|
9084
|
-
#
|
9085
|
-
# : You can optionally specify the accounts or groups that should be
|
9086
|
-
# granted specific permissions on the new object. There are two ways
|
9087
|
-
# to grant the permissions using the request headers:
|
9088
|
-
#
|
9089
|
-
# * Specify a canned ACL with the `x-amz-acl` request header. For more
|
9090
|
-
# information, see [Canned ACL][3].
|
9091
|
-
#
|
9092
|
-
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
9093
|
-
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
9094
|
-
# `x-amz-grant-full-control` headers. These parameters map to the
|
9095
|
-
# set of permissions that Amazon S3 supports in an ACL. For more
|
9096
|
-
# information, see [Access Control List (ACL) Overview][4].
|
9097
|
-
#
|
9098
|
-
# You can use either a canned ACL or specify access permissions
|
9099
|
-
# explicitly. You cannot do both.
|
9100
|
-
#
|
9101
|
-
# Server-Side- Encryption-Specific Request Headers
|
9102
|
-
#
|
9103
|
-
# : You can optionally tell Amazon S3 to encrypt data at rest using
|
9104
|
-
# server-side encryption. Server-side encryption is for data
|
9105
|
-
# encryption at rest. Amazon S3 encrypts your data as it writes it to
|
9106
|
-
# disks in its data centers and decrypts it when you access it. The
|
9107
|
-
# option you use depends on whether you want to use AWS managed
|
9108
|
-
# encryption keys or provide your own encryption key.
|
9109
|
-
#
|
9110
|
-
# * Use encryption keys managed by Amazon S3 or customer master keys
|
9111
|
-
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
|
9112
|
-
# want AWS to manage the keys used to encrypt data, specify the
|
9113
|
-
# following headers in the request.
|
9114
|
-
#
|
9115
|
-
# * x-amz-server-side-encryption
|
9116
|
-
#
|
9117
|
-
# * x-amz-server-side-encryption-aws-kms-key-id
|
9118
|
-
#
|
9119
|
-
# * x-amz-server-side-encryption-context
|
9120
|
-
#
|
9121
|
-
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
9122
|
-
# provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
9123
|
-
# uses the AWS managed CMK in AWS KMS to protect the data. If you
|
9124
|
-
# want to use a customer managed AWS KMS CMK, you must provide the
|
9125
|
-
# `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
|
9126
|
-
# customer managed CMK. Amazon S3 only supports symmetric CMKs and
|
9127
|
-
# not asymmetric CMKs. For more information, see [Using Symmetric
|
9128
|
-
# and Asymmetric Keys][5] in the *AWS Key Management Service
|
9129
|
-
# Developer Guide*.
|
9130
|
-
#
|
9131
|
-
# </note>
|
9132
|
-
#
|
9133
|
-
# All GET and PUT requests for an object protected by AWS KMS fail
|
9134
|
-
# if you don't make them with SSL or by using SigV4.
|
9135
|
-
#
|
9136
|
-
# For more information about server-side encryption with CMKs stored
|
9137
|
-
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9138
|
-
# Encryption with CMKs stored in AWS][6].
|
9139
|
-
#
|
9140
|
-
# * Use customer-provided encryption keys – If you want to manage your
|
9141
|
-
# own encryption keys, provide all the following headers in the
|
9142
|
-
# request.
|
9143
|
-
#
|
9144
|
-
# * x-amz-server-side-encryption-customer-algorithm
|
9145
|
-
#
|
9146
|
-
# * x-amz-server-side-encryption-customer-key
|
9147
|
-
#
|
9148
|
-
# * x-amz-server-side-encryption-customer-key-MD5
|
9149
|
-
#
|
9150
|
-
# For more information about server-side encryption with CMKs stored
|
9151
|
-
# in KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9152
|
-
# Encryption with CMKs stored in AWS][6].
|
9153
|
-
#
|
9154
|
-
# Access-Control-List (ACL)-Specific Request Headers
|
9155
|
-
#
|
9156
|
-
# : You also can use the following access control–related headers with
|
9157
|
-
# this operation. By default, all objects are private. Only the owner
|
9158
|
-
# has full access control. When adding a new object, you can grant
|
9159
|
-
# permissions to individual AWS accounts or to predefined groups
|
9160
|
-
# defined by Amazon S3. These permissions are then added to the Access
|
9161
|
-
# Control List (ACL) on the object. For more information, see [Using
|
9162
|
-
# ACLs][7]. With this operation, you can grant access permissions
|
9163
|
-
# using one of the following two methods:
|
9164
|
-
#
|
9165
|
-
# * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
|
9166
|
-
# predefined ACLs, known as canned ACLs. Each canned ACL has a
|
9167
|
-
# predefined set of grantees and permissions. For more information,
|
9168
|
-
# see [Canned ACL][3].
|
9169
|
-
#
|
9170
|
-
# * Specify access permissions explicitly — To explicitly grant access
|
9171
|
-
# permissions to specific AWS accounts or groups, use the following
|
9172
|
-
# headers. Each header maps to specific permissions that Amazon S3
|
9173
|
-
# supports in an ACL. For more information, see [Access Control List
|
9174
|
-
# (ACL) Overview][4]. In the header, you specify a list of grantees
|
9175
|
-
# who get the specific permission. To grant permissions explicitly
|
9176
|
-
# use:
|
9177
|
-
#
|
9178
|
-
# * x-amz-grant-read
|
9179
|
-
#
|
9180
|
-
# * x-amz-grant-write
|
9181
|
-
#
|
9182
|
-
# * x-amz-grant-read-acp
|
9183
|
-
#
|
9184
|
-
# * x-amz-grant-write-acp
|
9185
|
-
#
|
9186
|
-
# * x-amz-grant-full-control
|
9187
|
-
#
|
9188
|
-
# You specify each grantee as a type=value pair, where the type is
|
9189
|
-
# one of the following:
|
9190
|
-
#
|
9191
|
-
# * `emailAddress` – if the value specified is the email address of
|
9192
|
-
# an AWS account
|
9193
|
-
#
|
9194
|
-
# Using email addresses to specify a grantee is only supported in
|
9195
|
-
# the following AWS Regions:
|
9196
|
-
#
|
9197
|
-
# * US East (N. Virginia)
|
9198
|
-
#
|
9199
|
-
# * US West (N. California)
|
9200
|
-
#
|
9201
|
-
# * US West (Oregon)
|
9202
|
-
#
|
9203
|
-
# * Asia Pacific (Singapore)
|
9204
|
-
#
|
9205
|
-
# * Asia Pacific (Sydney)
|
9206
|
-
#
|
9207
|
-
# * Asia Pacific (Tokyo)
|
9208
|
-
#
|
9209
|
-
# * EU (Ireland)
|
9210
|
-
#
|
9211
|
-
# * South America (São Paulo)
|
9212
|
-
#
|
9213
|
-
# For a list of all the Amazon S3 supported Regions and
|
9214
|
-
# endpoints,
|
9215
|
-
# see [Regions and Endpoints][8] in the AWS General Reference
|
9216
|
-
#
|
9217
|
-
# * `id` – if the value specified is the canonical user ID of an AWS
|
9218
|
-
# account
|
9219
|
-
#
|
9220
|
-
# * `uri` – if you are granting permissions to a predefined group
|
9105
|
+
# **Access Control List (ACL)-Specific Request Headers**
|
9221
9106
|
#
|
9222
|
-
#
|
9223
|
-
#
|
9224
|
-
#
|
9225
|
-
#
|
9226
|
-
#
|
9227
|
-
#
|
9228
|
-
#
|
9229
|
-
# Server-Side- Encryption-Specific Request Headers
|
9230
|
-
#
|
9231
|
-
# : You can optionally tell Amazon S3 to encrypt data at rest using
|
9232
|
-
# server-side encryption. Server-side encryption is for data
|
9233
|
-
# encryption at rest. Amazon S3 encrypts your data as it writes it to
|
9234
|
-
# disks in its data centers and decrypts it when you access it. The
|
9235
|
-
# option you use depends on whether you want to use AWS-managed
|
9236
|
-
# encryption keys or provide your own encryption key.
|
9237
|
-
#
|
9238
|
-
# * Use encryption keys managed by Amazon S3 or customer master keys
|
9239
|
-
# (CMKs) stored in AWS Key Management Service (AWS KMS) – If you
|
9240
|
-
# want AWS to manage the keys used to encrypt data, specify the
|
9241
|
-
# following headers in the request.
|
9242
|
-
#
|
9243
|
-
# * x-amz-server-side-encryption
|
9244
|
-
#
|
9245
|
-
# * x-amz-server-side-encryption-aws-kms-key-id
|
9246
|
-
#
|
9247
|
-
# * x-amz-server-side-encryption-context
|
9248
|
-
#
|
9249
|
-
# <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
|
9250
|
-
# provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
|
9251
|
-
# uses the AWS managed CMK in AWS KMS to protect the data. If you
|
9252
|
-
# want to use a customer managed AWS KMS CMK, you must provide the
|
9253
|
-
# `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
|
9254
|
-
# customer managed CMK. Amazon S3 only supports symmetric CMKs and
|
9255
|
-
# not asymmetric CMKs. For more information, see [Using Symmetric
|
9256
|
-
# and Asymmetric Keys][5] in the *AWS Key Management Service
|
9257
|
-
# Developer Guide*.
|
9258
|
-
#
|
9259
|
-
# </note>
|
9260
|
-
#
|
9261
|
-
# All GET and PUT requests for an object protected by AWS KMS fail
|
9262
|
-
# if you don't make them with SSL or by using SigV4.
|
9263
|
-
#
|
9264
|
-
# For more information about server-side encryption with CMKs stored
|
9265
|
-
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9266
|
-
# Encryption with CMKs stored in AWS KMS][6].
|
9267
|
-
#
|
9268
|
-
# * Use customer-provided encryption keys – If you want to manage your
|
9269
|
-
# own encryption keys, provide all the following headers in the
|
9270
|
-
# request.
|
9271
|
-
#
|
9272
|
-
# <note markdown="1"> If you use this feature, the ETag value that Amazon S3 returns in
|
9273
|
-
# the response is not the MD5 of the object.
|
9274
|
-
#
|
9275
|
-
# </note>
|
9276
|
-
#
|
9277
|
-
# * x-amz-server-side-encryption-customer-algorithm
|
9278
|
-
#
|
9279
|
-
# * x-amz-server-side-encryption-customer-key
|
9280
|
-
#
|
9281
|
-
# * x-amz-server-side-encryption-customer-key-MD5
|
9282
|
-
#
|
9283
|
-
# For more information about server-side encryption with CMKs stored
|
9284
|
-
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
9285
|
-
# Encryption with CMKs stored in AWS KMS][6].
|
9107
|
+
# You can use headers to grant ACL- based permissions. By default, all
|
9108
|
+
# objects are private. Only the owner has full access control. When
|
9109
|
+
# adding a new object, you can grant permissions to individual AWS
|
9110
|
+
# accounts or to predefined groups defined by Amazon S3. These
|
9111
|
+
# permissions are then added to the ACL on the object. For more
|
9112
|
+
# information, see [Access Control List (ACL) Overview][3] and [Managing
|
9113
|
+
# ACLs Using the REST API][4].
|
9286
9114
|
#
|
9287
9115
|
# **Storage Class Options**
|
9288
9116
|
#
|
9289
|
-
# By default, Amazon S3 uses the
|
9290
|
-
# created objects. The
|
9291
|
-
# and high availability.
|
9292
|
-
#
|
9293
|
-
# Classes][
|
9117
|
+
# By default, Amazon S3 uses the STANDARD storage class to store newly
|
9118
|
+
# created objects. The STANDARD storage class provides high durability
|
9119
|
+
# and high availability. Depending on performance needs, you can specify
|
9120
|
+
# a different storage class. For more information, see [Storage
|
9121
|
+
# Classes][5] in the *Amazon S3 Service Developer Guide*.
|
9294
9122
|
#
|
9295
9123
|
# **Versioning**
|
9296
9124
|
#
|
9297
9125
|
# If you enable versioning for a bucket, Amazon S3 automatically
|
9298
9126
|
# generates a unique version ID for the object being stored. Amazon S3
|
9299
|
-
# returns this ID in the response
|
9300
|
-
#
|
9301
|
-
#
|
9302
|
-
#
|
9303
|
-
#
|
9304
|
-
#
|
9305
|
-
#
|
9127
|
+
# returns this ID in the response. When you enable versioning for a
|
9128
|
+
# bucket, if Amazon S3 receives multiple write requests for the same
|
9129
|
+
# object simultaneously, it stores all of the objects.
|
9130
|
+
#
|
9131
|
+
# For more information about versioning, see [Adding Objects to
|
9132
|
+
# Versioning Enabled Buckets][6]. For information about returning the
|
9133
|
+
# versioning state of a bucket, see GetBucketVersioning.
|
9306
9134
|
#
|
9307
9135
|
# **Related Resources**
|
9308
9136
|
#
|
@@ -9312,15 +9140,12 @@ module Aws::S3
|
|
9312
9140
|
#
|
9313
9141
|
#
|
9314
9142
|
#
|
9315
|
-
# [1]:
|
9143
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
|
9316
9144
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html
|
9317
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9318
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-
|
9319
|
-
# [5]: https://docs.aws.amazon.com/
|
9320
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
9321
|
-
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
9322
|
-
# [8]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
9323
|
-
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
9145
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9146
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
9147
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
9148
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
|
9324
9149
|
#
|
9325
9150
|
# @option params [String] :acl
|
9326
9151
|
# The canned ACL to apply to the object. For more information, see
|
@@ -9443,8 +9268,8 @@ module Aws::S3
|
|
9443
9268
|
# Amazon S3 (for example, AES256, aws:kms).
|
9444
9269
|
#
|
9445
9270
|
# @option params [String] :storage_class
|
9446
|
-
# If you don't specify, Standard is the default storage class.
|
9447
|
-
# S3 supports other storage classes.
|
9271
|
+
# If you don't specify, S3 Standard is the default storage class.
|
9272
|
+
# Amazon S3 supports other storage classes.
|
9448
9273
|
#
|
9449
9274
|
# @option params [String] :website_redirect_location
|
9450
9275
|
# If the bucket is configured as a website, redirects requests for this
|
@@ -9548,96 +9373,99 @@ module Aws::S3
|
|
9548
9373
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
9549
9374
|
#
|
9550
9375
|
#
|
9551
|
-
# @example Example: To upload an object
|
9376
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
9552
9377
|
#
|
9553
|
-
# # The following example uploads
|
9554
|
-
# #
|
9378
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
9379
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
9555
9380
|
#
|
9556
9381
|
# resp = client.put_object({
|
9557
|
-
# body: "
|
9382
|
+
# body: "filetoupload",
|
9558
9383
|
# bucket: "examplebucket",
|
9559
|
-
# key: "
|
9384
|
+
# key: "exampleobject",
|
9560
9385
|
# server_side_encryption: "AES256",
|
9561
|
-
#
|
9386
|
+
# tagging: "key1=value1&key2=value2",
|
9562
9387
|
# })
|
9563
9388
|
#
|
9564
9389
|
# resp.to_h outputs the following:
|
9565
9390
|
# {
|
9566
9391
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9567
9392
|
# server_side_encryption: "AES256",
|
9568
|
-
# version_id: "
|
9393
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9569
9394
|
# }
|
9570
9395
|
#
|
9571
|
-
# @example Example: To
|
9396
|
+
# @example Example: To create an object.
|
9572
9397
|
#
|
9573
|
-
# # The following example
|
9574
|
-
# # S3 returns version ID of the newly created object.
|
9398
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
9575
9399
|
#
|
9576
9400
|
# resp = client.put_object({
|
9577
|
-
# body: "
|
9401
|
+
# body: "filetoupload",
|
9578
9402
|
# bucket: "examplebucket",
|
9579
|
-
# key: "
|
9580
|
-
# tagging: "key1=value1&key2=value2",
|
9403
|
+
# key: "objectkey",
|
9581
9404
|
# })
|
9582
9405
|
#
|
9583
9406
|
# resp.to_h outputs the following:
|
9584
9407
|
# {
|
9585
9408
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9586
|
-
# version_id: "
|
9409
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
9587
9410
|
# }
|
9588
9411
|
#
|
9589
|
-
# @example Example: To upload object and specify
|
9412
|
+
# @example Example: To upload an object and specify optional tags
|
9590
9413
|
#
|
9591
|
-
# # The following example
|
9592
|
-
# #
|
9414
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
9415
|
+
# # S3 returns version ID of the newly created object.
|
9593
9416
|
#
|
9594
9417
|
# resp = client.put_object({
|
9595
|
-
# body: "
|
9418
|
+
# body: "c:\\HappyFace.jpg",
|
9596
9419
|
# bucket: "examplebucket",
|
9597
|
-
# key: "
|
9598
|
-
#
|
9599
|
-
# "metadata1" => "value1",
|
9600
|
-
# "metadata2" => "value2",
|
9601
|
-
# },
|
9420
|
+
# key: "HappyFace.jpg",
|
9421
|
+
# tagging: "key1=value1&key2=value2",
|
9602
9422
|
# })
|
9603
9423
|
#
|
9604
9424
|
# resp.to_h outputs the following:
|
9605
9425
|
# {
|
9606
9426
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9607
|
-
# version_id: "
|
9427
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
9608
9428
|
# }
|
9609
9429
|
#
|
9610
|
-
# @example Example: To
|
9430
|
+
# @example Example: To upload an object (specify optional headers)
|
9611
9431
|
#
|
9612
|
-
# # The following example
|
9432
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
9433
|
+
# # storage class and use server-side encryption.
|
9613
9434
|
#
|
9614
9435
|
# resp = client.put_object({
|
9615
|
-
# body: "
|
9436
|
+
# body: "HappyFace.jpg",
|
9616
9437
|
# bucket: "examplebucket",
|
9617
|
-
# key: "
|
9438
|
+
# key: "HappyFace.jpg",
|
9439
|
+
# server_side_encryption: "AES256",
|
9440
|
+
# storage_class: "STANDARD_IA",
|
9618
9441
|
# })
|
9619
9442
|
#
|
9620
9443
|
# resp.to_h outputs the following:
|
9621
9444
|
# {
|
9622
9445
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9623
|
-
#
|
9446
|
+
# server_side_encryption: "AES256",
|
9447
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9624
9448
|
# }
|
9625
9449
|
#
|
9626
|
-
# @example Example: To upload
|
9450
|
+
# @example Example: To upload object and specify user-defined metadata
|
9627
9451
|
#
|
9628
|
-
# # The following example
|
9629
|
-
# #
|
9452
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
9453
|
+
# # enabled, S3 returns version ID in response.
|
9630
9454
|
#
|
9631
9455
|
# resp = client.put_object({
|
9632
|
-
# body: "
|
9456
|
+
# body: "filetoupload",
|
9633
9457
|
# bucket: "examplebucket",
|
9634
|
-
# key: "
|
9458
|
+
# key: "exampleobject",
|
9459
|
+
# metadata: {
|
9460
|
+
# "metadata1" => "value1",
|
9461
|
+
# "metadata2" => "value2",
|
9462
|
+
# },
|
9635
9463
|
# })
|
9636
9464
|
#
|
9637
9465
|
# resp.to_h outputs the following:
|
9638
9466
|
# {
|
9639
9467
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9640
|
-
# version_id: "
|
9468
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
9641
9469
|
# }
|
9642
9470
|
#
|
9643
9471
|
# @example Example: To upload an object and specify canned ACL.
|
@@ -9658,24 +9486,21 @@ module Aws::S3
|
|
9658
9486
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
9659
9487
|
# }
|
9660
9488
|
#
|
9661
|
-
# @example Example: To upload an object
|
9489
|
+
# @example Example: To upload an object
|
9662
9490
|
#
|
9663
|
-
# # The following example uploads
|
9664
|
-
# #
|
9491
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
9492
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
9665
9493
|
#
|
9666
9494
|
# resp = client.put_object({
|
9667
|
-
# body: "
|
9495
|
+
# body: "HappyFace.jpg",
|
9668
9496
|
# bucket: "examplebucket",
|
9669
|
-
# key: "
|
9670
|
-
# server_side_encryption: "AES256",
|
9671
|
-
# tagging: "key1=value1&key2=value2",
|
9497
|
+
# key: "HappyFace.jpg",
|
9672
9498
|
# })
|
9673
9499
|
#
|
9674
9500
|
# resp.to_h outputs the following:
|
9675
9501
|
# {
|
9676
9502
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9677
|
-
#
|
9678
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9503
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
9679
9504
|
# }
|
9680
9505
|
#
|
9681
9506
|
# @example Streaming a file from disk
|
@@ -9749,7 +9574,9 @@ module Aws::S3
|
|
9749
9574
|
# Depending on your application needs, you can choose to set the ACL on
|
9750
9575
|
# an object using either the request body or the headers. For example,
|
9751
9576
|
# if you have an existing application that updates a bucket ACL using
|
9752
|
-
# the request body, you can continue to use that approach.
|
9577
|
+
# the request body, you can continue to use that approach. For more
|
9578
|
+
# information, see [Access Control List (ACL) Overview][1] in the
|
9579
|
+
# *Amazon S3 Developer Guide*.
|
9753
9580
|
#
|
9754
9581
|
# **Access Permissions**
|
9755
9582
|
#
|
@@ -9760,7 +9587,7 @@ module Aws::S3
|
|
9760
9587
|
# ACL has a predefined set of grantees and permissions. Specify the
|
9761
9588
|
# canned ACL name as the value of `x-amz-ac`l. If you use this header,
|
9762
9589
|
# you cannot use other access control-specific headers in your
|
9763
|
-
# request. For more information, see [Canned ACL][
|
9590
|
+
# request. For more information, see [Canned ACL][2].
|
9764
9591
|
#
|
9765
9592
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
9766
9593
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
@@ -9770,19 +9597,43 @@ module Aws::S3
|
|
9770
9597
|
# ACL-specific headers, you cannot use `x-amz-acl` header to set a
|
9771
9598
|
# canned ACL. These parameters map to the set of permissions that
|
9772
9599
|
# Amazon S3 supports in an ACL. For more information, see [Access
|
9773
|
-
# Control List (ACL) Overview][
|
9600
|
+
# Control List (ACL) Overview][1].
|
9774
9601
|
#
|
9775
9602
|
# You specify each grantee as a type=value pair, where the type is one
|
9776
9603
|
# of the following:
|
9777
9604
|
#
|
9778
|
-
# * `emailAddress` – if the value specified is the email address of an
|
9779
|
-
# AWS account
|
9780
|
-
#
|
9781
9605
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
9782
9606
|
# account
|
9783
9607
|
#
|
9784
9608
|
# * `uri` – if you are granting permissions to a predefined group
|
9785
9609
|
#
|
9610
|
+
# * `emailAddress` – if the value specified is the email address of an
|
9611
|
+
# AWS account
|
9612
|
+
#
|
9613
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
9614
|
+
# the following AWS Regions:
|
9615
|
+
#
|
9616
|
+
# * US East (N. Virginia)
|
9617
|
+
#
|
9618
|
+
# * US West (N. California)
|
9619
|
+
#
|
9620
|
+
# * US West (Oregon)
|
9621
|
+
#
|
9622
|
+
# * Asia Pacific (Singapore)
|
9623
|
+
#
|
9624
|
+
# * Asia Pacific (Sydney)
|
9625
|
+
#
|
9626
|
+
# * Asia Pacific (Tokyo)
|
9627
|
+
#
|
9628
|
+
# * Europe (Ireland)
|
9629
|
+
#
|
9630
|
+
# * South America (São Paulo)
|
9631
|
+
#
|
9632
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
9633
|
+
# see [Regions and Endpoints][3] in the AWS General Reference.
|
9634
|
+
#
|
9635
|
+
# </note>
|
9636
|
+
#
|
9786
9637
|
# For example, the following `x-amz-grant-read` header grants list
|
9787
9638
|
# objects permission to the two AWS accounts identified by their email
|
9788
9639
|
# addresses.
|
@@ -9798,14 +9649,6 @@ module Aws::S3
|
|
9798
9649
|
# You can specify the person (grantee) to whom you're assigning access
|
9799
9650
|
# rights (using request elements) in the following ways:
|
9800
9651
|
#
|
9801
|
-
# * By Email address:
|
9802
|
-
#
|
9803
|
-
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9804
|
-
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
9805
|
-
#
|
9806
|
-
# The grantee is resolved to the CanonicalUser and, in a response to a
|
9807
|
-
# GET Object acl request, appears as the CanonicalUser.
|
9808
|
-
#
|
9809
9652
|
# * By the person's ID:
|
9810
9653
|
#
|
9811
9654
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
@@ -9819,6 +9662,38 @@ module Aws::S3
|
|
9819
9662
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9820
9663
|
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
|
9821
9664
|
#
|
9665
|
+
# * By Email address:
|
9666
|
+
#
|
9667
|
+
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9668
|
+
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
9669
|
+
#
|
9670
|
+
# The grantee is resolved to the CanonicalUser and, in a response to a
|
9671
|
+
# GET Object acl request, appears as the CanonicalUser.
|
9672
|
+
#
|
9673
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
|
9674
|
+
# following AWS Regions:
|
9675
|
+
#
|
9676
|
+
# * US East (N. Virginia)
|
9677
|
+
#
|
9678
|
+
# * US West (N. California)
|
9679
|
+
#
|
9680
|
+
# * US West (Oregon)
|
9681
|
+
#
|
9682
|
+
# * Asia Pacific (Singapore)
|
9683
|
+
#
|
9684
|
+
# * Asia Pacific (Sydney)
|
9685
|
+
#
|
9686
|
+
# * Asia Pacific (Tokyo)
|
9687
|
+
#
|
9688
|
+
# * Europe (Ireland)
|
9689
|
+
#
|
9690
|
+
# * South America (São Paulo)
|
9691
|
+
#
|
9692
|
+
# For a list of all the Amazon S3 supported Regions and endpoints, see
|
9693
|
+
# [Regions and Endpoints][3] in the AWS General Reference.
|
9694
|
+
#
|
9695
|
+
# </note>
|
9696
|
+
#
|
9822
9697
|
# **Versioning**
|
9823
9698
|
#
|
9824
9699
|
# The ACL of an object is set at the object version level. By default,
|
@@ -9833,8 +9708,9 @@ module Aws::S3
|
|
9833
9708
|
#
|
9834
9709
|
#
|
9835
9710
|
#
|
9836
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9837
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9711
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9712
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
9713
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
9838
9714
|
#
|
9839
9715
|
# @option params [String] :acl
|
9840
9716
|
# The canned ACL to apply to the object. For more information, see
|
@@ -10229,7 +10105,8 @@ module Aws::S3
|
|
10229
10105
|
req.send_request(options)
|
10230
10106
|
end
|
10231
10107
|
|
10232
|
-
# Sets the supplied tag-set to an object that already exists in a
|
10108
|
+
# Sets the supplied tag-set to an object that already exists in a
|
10109
|
+
# bucket.
|
10233
10110
|
#
|
10234
10111
|
# A tag is a key-value pair. You can associate tags with an object by
|
10235
10112
|
# sending a PUT request against the tagging subresource that is
|
@@ -10458,12 +10335,11 @@ module Aws::S3
|
|
10458
10335
|
# * `restore an archive` - Restore an archived object
|
10459
10336
|
#
|
10460
10337
|
# To use this operation, you must have permissions to perform the
|
10461
|
-
# `s3:RestoreObject`
|
10462
|
-
#
|
10463
|
-
#
|
10464
|
-
#
|
10465
|
-
#
|
10466
|
-
# Developer Guide*.
|
10338
|
+
# `s3:RestoreObject` action. The bucket owner has this permission by
|
10339
|
+
# default and can grant this permission to others. For more information
|
10340
|
+
# about permissions, see [Permissions Related to Bucket Subresource
|
10341
|
+
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
10342
|
+
# Resources][2] in the *Amazon Simple Storage Service Developer Guide*.
|
10467
10343
|
#
|
10468
10344
|
# **Querying Archives with Select Requests**
|
10469
10345
|
#
|
@@ -10519,9 +10395,9 @@ module Aws::S3
|
|
10519
10395
|
#
|
10520
10396
|
# `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
|
10521
10397
|
#
|
10522
|
-
# For more information about using SQL with Glacier Select restore,
|
10523
|
-
# [SQL Reference for Amazon S3 Select and Glacier Select][6] in
|
10524
|
-
# *Amazon Simple Storage Service Developer Guide*.
|
10398
|
+
# For more information about using SQL with S3 Glacier Select restore,
|
10399
|
+
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][6] in
|
10400
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10525
10401
|
#
|
10526
10402
|
# When making a select request, you can also do the following:
|
10527
10403
|
#
|
@@ -10578,10 +10454,10 @@ module Aws::S3
|
|
10578
10454
|
# retrievals and provisioned capacity are not available for the
|
10579
10455
|
# DEEP\_ARCHIVE storage class.
|
10580
10456
|
#
|
10581
|
-
# * <b> <code>Standard</code> </b> - Standard retrievals allow you to
|
10457
|
+
# * <b> <code>Standard</code> </b> - S3 Standard retrievals allow you to
|
10582
10458
|
# access any of your archived objects within several hours. This is
|
10583
10459
|
# the default option for the GLACIER and DEEP\_ARCHIVE retrieval
|
10584
|
-
# requests that do not specify the retrieval option. Standard
|
10460
|
+
# requests that do not specify the retrieval option. S3 Standard
|
10585
10461
|
# retrievals typically complete within 3-5 hours from the GLACIER
|
10586
10462
|
# storage class and typically complete within 12 hours from the
|
10587
10463
|
# DEEP\_ARCHIVE storage class.
|
@@ -10659,10 +10535,11 @@ module Aws::S3
|
|
10659
10535
|
#
|
10660
10536
|
# * *Code: GlacierExpeditedRetrievalNotAvailable*
|
10661
10537
|
#
|
10662
|
-
# * *Cause: Glacier expedited retrievals are currently not
|
10663
|
-
# Try again later. (Returned if there is insufficient
|
10664
|
-
# process the Expedited request. This error applies only
|
10665
|
-
# Expedited retrievals and not to Standard or Bulk
|
10538
|
+
# * *Cause: S3 Glacier expedited retrievals are currently not
|
10539
|
+
# available. Try again later. (Returned if there is insufficient
|
10540
|
+
# capacity to process the Expedited request. This error applies only
|
10541
|
+
# to Expedited retrievals and not to S3 Standard or Bulk
|
10542
|
+
# retrievals.)*
|
10666
10543
|
#
|
10667
10544
|
# * *HTTP Status Code: 503*
|
10668
10545
|
#
|
@@ -10674,8 +10551,8 @@ module Aws::S3
|
|
10674
10551
|
#
|
10675
10552
|
# * GetBucketNotificationConfiguration
|
10676
10553
|
#
|
10677
|
-
# * [SQL Reference for Amazon S3 Select and Glacier Select ][6] in
|
10678
|
-
# *Amazon Simple Storage Service Developer Guide*
|
10554
|
+
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][6] in
|
10555
|
+
# the *Amazon Simple Storage Service Developer Guide*
|
10679
10556
|
#
|
10680
10557
|
#
|
10681
10558
|
#
|
@@ -10867,8 +10744,8 @@ module Aws::S3
|
|
10867
10744
|
# Guide*.
|
10868
10745
|
#
|
10869
10746
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
10870
|
-
# Reference for Amazon S3 Select and Glacier Select][2] in the
|
10871
|
-
# Simple Storage Service Developer Guide*.
|
10747
|
+
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
10748
|
+
# *Amazon Simple Storage Service Developer Guide*.
|
10872
10749
|
#
|
10873
10750
|
#
|
10874
10751
|
#
|
@@ -10929,10 +10806,10 @@ module Aws::S3
|
|
10929
10806
|
# The `SelectObjectContent` operation does not support the following
|
10930
10807
|
# `GetObject` functionality. For more information, see GetObject.
|
10931
10808
|
#
|
10932
|
-
# * `Range`\:
|
10933
|
-
# request
|
10934
|
-
# parameters
|
10935
|
-
# to return.
|
10809
|
+
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
10810
|
+
# Select request (see SelectObjectContentRequest$ScanRange in the
|
10811
|
+
# request parameters), you cannot specify the range of bytes of an
|
10812
|
+
# object to return.
|
10936
10813
|
#
|
10937
10814
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
10938
10815
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
@@ -10944,9 +10821,8 @@ module Aws::S3
|
|
10944
10821
|
#
|
10945
10822
|
# **Special Errors**
|
10946
10823
|
#
|
10947
|
-
# For a list of special errors for this operation
|
10948
|
-
#
|
10949
|
-
# ErrorResponses
|
10824
|
+
# For a list of special errors for this operation, see
|
10825
|
+
# SelectObjectContentErrorCodeList
|
10950
10826
|
#
|
10951
10827
|
# **Related Resources**
|
10952
10828
|
#
|
@@ -11692,45 +11568,45 @@ module Aws::S3
|
|
11692
11568
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
11693
11569
|
#
|
11694
11570
|
#
|
11695
|
-
# @example Example: To upload a part by copying
|
11571
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
11696
11572
|
#
|
11697
|
-
# # The following example uploads a part of a multipart upload by copying
|
11698
|
-
# # data source.
|
11573
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
11699
11574
|
#
|
11700
11575
|
# resp = client.upload_part_copy({
|
11701
11576
|
# bucket: "examplebucket",
|
11702
11577
|
# copy_source: "/bucketname/sourceobjectkey",
|
11703
|
-
# copy_source_range: "bytes=1-100000",
|
11704
11578
|
# key: "examplelargeobject",
|
11705
|
-
# part_number:
|
11579
|
+
# part_number: 1,
|
11706
11580
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11707
11581
|
# })
|
11708
11582
|
#
|
11709
11583
|
# resp.to_h outputs the following:
|
11710
11584
|
# {
|
11711
11585
|
# copy_part_result: {
|
11712
|
-
# etag: "\"
|
11713
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11586
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
11587
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
11714
11588
|
# },
|
11715
11589
|
# }
|
11716
11590
|
#
|
11717
|
-
# @example Example: To upload a part by copying
|
11591
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
11718
11592
|
#
|
11719
|
-
# # The following example uploads a part of a multipart upload by copying
|
11593
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
11594
|
+
# # data source.
|
11720
11595
|
#
|
11721
11596
|
# resp = client.upload_part_copy({
|
11722
11597
|
# bucket: "examplebucket",
|
11723
11598
|
# copy_source: "/bucketname/sourceobjectkey",
|
11599
|
+
# copy_source_range: "bytes=1-100000",
|
11724
11600
|
# key: "examplelargeobject",
|
11725
|
-
# part_number:
|
11601
|
+
# part_number: 2,
|
11726
11602
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11727
11603
|
# })
|
11728
11604
|
#
|
11729
11605
|
# resp.to_h outputs the following:
|
11730
11606
|
# {
|
11731
11607
|
# copy_part_result: {
|
11732
|
-
# etag: "\"
|
11733
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11608
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
11609
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
11734
11610
|
# },
|
11735
11611
|
# }
|
11736
11612
|
#
|
@@ -11789,7 +11665,7 @@ module Aws::S3
|
|
11789
11665
|
params: params,
|
11790
11666
|
config: config)
|
11791
11667
|
context[:gem_name] = 'aws-sdk-s3'
|
11792
|
-
context[:gem_version] = '1.
|
11668
|
+
context[:gem_version] = '1.67.1'
|
11793
11669
|
Seahorse::Client::Request.new(handlers, context)
|
11794
11670
|
end
|
11795
11671
|
|