aws-sdk-s3 1.64.0 → 1.68.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 +528 -649
- data/lib/aws-sdk-s3/client_api.rb +38 -18
- data/lib/aws-sdk-s3/customizations/bucket.rb +2 -0
- data/lib/aws-sdk-s3/customizations/object.rb +3 -0
- 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/plugins/md5s.rb +21 -24
- 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: bfdbbed3a219f8690462fbca974111e863bbb4b3a3677648cf77dec94af963e9
|
4
|
+
data.tar.gz: 285b62f651038d1bf38e9fc156ec48d78b6aedd21f869455cfdb942aad7d817c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aaed81549dabc75fd9415706924178884c1a9b2d3cc0c8325be4540c28301dd45d6d376ba6fc75bba28f705764af6916b984818d5c2df0d360884db429578b31
|
7
|
+
data.tar.gz: 20bc2cf996bcc241fefe8beba3bb6e30d7f5678e764c23c16a05f00e91c47be098290d85b3fe48a87bdb1edf27b35ab5e632545a210e2c81b801aed682e01641
|
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
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
|
28
29
|
require 'aws-sdk-s3/plugins/iad_regional_endpoint.rb'
|
29
30
|
require 'aws-sdk-s3/plugins/accelerate.rb'
|
@@ -85,6 +86,7 @@ module Aws::S3
|
|
85
86
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
86
87
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
87
88
|
add_plugin(Aws::Plugins::TransferEncoding)
|
89
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
88
90
|
add_plugin(Aws::Plugins::Protocols::RestXml)
|
89
91
|
add_plugin(Aws::S3::Plugins::IADRegionalEndpoint)
|
90
92
|
add_plugin(Aws::S3::Plugins::Accelerate)
|
@@ -179,10 +181,11 @@ module Aws::S3
|
|
179
181
|
# will use the Client Side Monitoring Agent Publisher.
|
180
182
|
#
|
181
183
|
# @option options [Boolean] :compute_checksums (true)
|
182
|
-
# When `true` a MD5 checksum will be computed
|
183
|
-
#
|
184
|
-
#
|
185
|
-
#
|
184
|
+
# When `true` a MD5 checksum will be computed and sent in the Content Md5
|
185
|
+
# header for :put_object and :upload_part. When `false`, MD5 checksums
|
186
|
+
# will not be computed for these operations. Checksums are still computed
|
187
|
+
# for operations requiring them. Checksum errors returned by Amazon S3 are
|
188
|
+
# automatically retried up to `:retry_limit` times.
|
186
189
|
#
|
187
190
|
# @option options [Boolean] :convert_params (true)
|
188
191
|
# When `true`, an attempt is made to coerce request parameters into
|
@@ -199,7 +202,7 @@ module Aws::S3
|
|
199
202
|
# @option options [String] :endpoint
|
200
203
|
# The client endpoint is normally constructed from the `:region`
|
201
204
|
# option. You should only configure an `:endpoint` when connecting
|
202
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
205
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
203
206
|
#
|
204
207
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
205
208
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -214,7 +217,7 @@ module Aws::S3
|
|
214
217
|
# requests fetching endpoints information. Defaults to 60 sec.
|
215
218
|
#
|
216
219
|
# @option options [Boolean] :endpoint_discovery (false)
|
217
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
220
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
218
221
|
#
|
219
222
|
# @option options [Proc] :event_stream_handler
|
220
223
|
# 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 +558,7 @@ module Aws::S3
|
|
555
558
|
#
|
556
559
|
# * 404 Not Found
|
557
560
|
#
|
558
|
-
# The following operations are related to
|
559
|
-
# `DeleteBucketMetricsConfiguration`\:
|
561
|
+
# The following operations are related to `CompleteMultipartUpload`\:
|
560
562
|
#
|
561
563
|
# * CreateMultipartUpload
|
562
564
|
#
|
@@ -637,7 +639,7 @@ module Aws::S3
|
|
637
639
|
# bucket: "acexamplebucket",
|
638
640
|
# etag: "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
|
639
641
|
# key: "bigobject",
|
640
|
-
# location: "https://examplebucket.s3
|
642
|
+
# location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject",
|
641
643
|
# }
|
642
644
|
#
|
643
645
|
# @example Request syntax with placeholder values
|
@@ -682,58 +684,19 @@ module Aws::S3
|
|
682
684
|
#
|
683
685
|
# <note markdown="1"> You can store individual objects of up to 5 TB in Amazon S3. You
|
684
686
|
# 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].
|
687
|
+
# operation using this API. However, to copy an object greater than 5
|
688
|
+
# GB, you must use the multipart upload Upload Part - Copy API. For more
|
689
|
+
# information, see [Copy Object Using the REST Multipart Upload API][1].
|
689
690
|
#
|
690
691
|
# </note>
|
691
692
|
#
|
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
693
|
# All copy requests must be authenticated. Additionally, you must have
|
704
694
|
# *read* access to the source object and *write* access to the
|
705
695
|
# destination bucket. For more information, see [REST
|
706
|
-
# Authentication][
|
696
|
+
# Authentication][2]. Both the Region that you want to copy the object
|
707
697
|
# from and the Region that you want to copy the object to must be
|
708
698
|
# enabled for your account.
|
709
699
|
#
|
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
700
|
# A copy request might return an error when Amazon S3 receives the copy
|
738
701
|
# request or while Amazon S3 is copying the files. If the error occurs
|
739
702
|
# before the copy operation starts, you receive a standard Amazon S3
|
@@ -752,182 +715,123 @@ module Aws::S3
|
|
752
715
|
#
|
753
716
|
# </note>
|
754
717
|
#
|
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.
|
718
|
+
# The copy request charge is based on the storage class and Region that
|
719
|
+
# you specify for the destination object. For pricing information, see
|
720
|
+
# [Amazon S3 pricing][3].
|
794
721
|
#
|
795
|
-
#
|
796
|
-
#
|
722
|
+
# Amazon S3 transfer acceleration does not support cross-Region copies.
|
723
|
+
# If you request a cross-Region copy using a transfer acceleration
|
724
|
+
# endpoint, you get a 400 `Bad Request` error. For more information, see
|
725
|
+
# [Transfer Acceleration][4].
|
797
726
|
#
|
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.
|
727
|
+
# **Metadata**
|
852
728
|
#
|
853
|
-
#
|
854
|
-
#
|
855
|
-
#
|
729
|
+
# When copying an object, you can preserve all metadata (default) or
|
730
|
+
# specify new metadata. However, the ACL is not preserved and is set to
|
731
|
+
# private for the user making the request. To override the default ACL
|
732
|
+
# setting, specify a new ACL when generating a copy request. For more
|
733
|
+
# information, see [Using ACLs][5].
|
856
734
|
#
|
857
|
-
#
|
858
|
-
#
|
735
|
+
# To specify whether you want the object metadata copied from the source
|
736
|
+
# object or replaced with metadata provided in the request, you can
|
737
|
+
# optionally add the `x-amz-metadata-directive` header. When you grant
|
738
|
+
# permissions, you can use the `s3:x-amz-metadata-directive` condition
|
739
|
+
# key to enforce certain metadata behavior when objects are uploaded.
|
740
|
+
# For more information, see [Specifying Conditions in a Policy][6] in
|
741
|
+
# the *Amazon S3 Developer Guide*. For a complete list of Amazon
|
742
|
+
# S3-specific condition keys, see [Actions, Resources, and Condition
|
743
|
+
# Keys for Amazon S3][7].
|
859
744
|
#
|
860
|
-
#
|
745
|
+
# <b> <code>x-amz-copy-source-if</code> Headers</b>
|
861
746
|
#
|
862
|
-
#
|
747
|
+
# To only copy an object under certain conditions, such as whether the
|
748
|
+
# `Etag` matches or whether the object was modified before or after a
|
749
|
+
# specified date, use the following request parameters:
|
863
750
|
#
|
864
|
-
#
|
751
|
+
# * `x-amz-copy-source-if-match`
|
865
752
|
#
|
866
|
-
#
|
867
|
-
# with customer-provided encryption keys, you must use the following
|
868
|
-
# headers.
|
753
|
+
# * `x-amz-copy-source-if-none-match`
|
869
754
|
#
|
870
|
-
#
|
755
|
+
# * `x-amz-copy-source-if-unmodified-since`
|
871
756
|
#
|
872
|
-
#
|
757
|
+
# * `x-amz-copy-source-if-modified-since`
|
873
758
|
#
|
874
|
-
#
|
759
|
+
# If both the `x-amz-copy-source-if-match` and
|
760
|
+
# `x-amz-copy-source-if-unmodified-since` headers are present in the
|
761
|
+
# request and evaluate as follows, Amazon S3 returns `200 OK` and copies
|
762
|
+
# the data:
|
875
763
|
#
|
876
|
-
#
|
877
|
-
# in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
|
878
|
-
# Encryption with CMKs stored in Amazon KMS][11].
|
764
|
+
# * `x-amz-copy-source-if-match` condition evaluates to true
|
879
765
|
#
|
880
|
-
#
|
766
|
+
# * `x-amz-copy-source-if-unmodified-since` condition evaluates to false
|
881
767
|
#
|
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:
|
768
|
+
# If both the `x-amz-copy-source-if-none-match` and
|
769
|
+
# `x-amz-copy-source-if-modified-since` headers are present in the
|
770
|
+
# request and evaluate as follows, Amazon S3 returns the `412
|
771
|
+
# Precondition Failed` response code:
|
890
772
|
#
|
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].
|
773
|
+
# * `x-amz-copy-source-if-none-match` condition evaluates to false
|
895
774
|
#
|
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:
|
775
|
+
# * `x-amz-copy-source-if-modified-since` condition evaluates to true
|
903
776
|
#
|
904
|
-
#
|
777
|
+
# <note markdown="1"> All headers with the `x-amz-` prefix, including `x-amz-copy-source`,
|
778
|
+
# must be signed.
|
905
779
|
#
|
906
|
-
#
|
780
|
+
# </note>
|
907
781
|
#
|
908
|
-
#
|
782
|
+
# **Encryption**
|
909
783
|
#
|
910
|
-
#
|
784
|
+
# The source object that you are copying can be encrypted or
|
785
|
+
# unencrypted. The source object can be encrypted with server-side
|
786
|
+
# encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by
|
787
|
+
# using a customer-provided encryption key. With server-side encryption,
|
788
|
+
# Amazon S3 encrypts your data as it writes it to disks in its data
|
789
|
+
# centers and decrypts the data when you access it.
|
790
|
+
#
|
791
|
+
# You can optionally use the appropriate encryption-related headers to
|
792
|
+
# request server-side encryption for the target object. You have the
|
793
|
+
# option to provide your own encryption key or use SSE-S3 or SSE-KMS,
|
794
|
+
# regardless of the form of server-side encryption that was used to
|
795
|
+
# encrypt the source object. You can even request encryption if the
|
796
|
+
# source object was not encrypted. For more information about
|
797
|
+
# server-side encryption, see [Using Server-Side Encryption][8].
|
798
|
+
#
|
799
|
+
# **Access Control List (ACL)-Specific Request Headers**
|
800
|
+
#
|
801
|
+
# When copying an object, you can optionally use headers to grant
|
802
|
+
# ACL-based permissions. By default, all objects are private. Only the
|
803
|
+
# owner has full access control. When adding a new object, you can grant
|
804
|
+
# permissions to individual AWS accounts or to predefined groups defined
|
805
|
+
# by Amazon S3. These permissions are then added to the ACL on the
|
806
|
+
# object. For more information, see [Access Control List (ACL)
|
807
|
+
# Overview][9] and [Managing ACLs Using the REST API][10].
|
911
808
|
#
|
912
|
-
#
|
809
|
+
# **Storage Class Options**
|
913
810
|
#
|
914
|
-
#
|
915
|
-
#
|
811
|
+
# You can use the `CopyObject` operation to change the storage class of
|
812
|
+
# an object that is already stored in Amazon S3 using the `StorageClass`
|
813
|
+
# parameter. For more information, see [Storage Classes][11] in the
|
814
|
+
# *Amazon S3 Service Developer Guide*.
|
916
815
|
#
|
917
|
-
#
|
918
|
-
# an AWS account
|
816
|
+
# **Versioning**
|
919
817
|
#
|
920
|
-
#
|
921
|
-
#
|
818
|
+
# By default, `x-amz-copy-source` identifies the current version of an
|
819
|
+
# object to copy. If the current version is a delete marker, Amazon S3
|
820
|
+
# behaves as if the object was deleted. To copy a different version, use
|
821
|
+
# the `versionId` subresource.
|
922
822
|
#
|
923
|
-
#
|
823
|
+
# If you enable versioning on the target bucket, Amazon S3 generates a
|
824
|
+
# unique version ID for the object being copied. This version ID is
|
825
|
+
# different from the version ID of the source object. Amazon S3 returns
|
826
|
+
# the version ID of the copied object in the `x-amz-version-id` response
|
827
|
+
# header in the response.
|
924
828
|
#
|
925
|
-
#
|
926
|
-
#
|
927
|
-
# object data and its metadata:
|
829
|
+
# If you do not enable versioning or suspend it on the target bucket,
|
830
|
+
# the version ID that Amazon S3 generates is always null.
|
928
831
|
#
|
929
|
-
#
|
930
|
-
#
|
832
|
+
# If the source object's storage class is GLACIER, you must restore a
|
833
|
+
# copy of this object before you can use it as a source object for the
|
834
|
+
# copy operation. For more information, see .
|
931
835
|
#
|
932
836
|
# The following operations are related to `CopyObject`\:
|
933
837
|
#
|
@@ -940,16 +844,16 @@ module Aws::S3
|
|
940
844
|
#
|
941
845
|
#
|
942
846
|
# [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/
|
847
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
848
|
+
# [3]: https://aws.amazon.com/s3/pricing/
|
849
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
850
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
851
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
|
852
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html
|
853
|
+
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html
|
950
854
|
# [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/
|
855
|
+
# [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
856
|
+
# [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
953
857
|
# [12]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html
|
954
858
|
#
|
955
859
|
# @option params [String] :acl
|
@@ -1219,7 +1123,7 @@ module Aws::S3
|
|
1219
1123
|
# You can optionally specify a Region in the request body. You might
|
1220
1124
|
# choose a Region to optimize latency, minimize costs, or address
|
1221
1125
|
# regulatory requirements. For example, if you reside in Europe, you
|
1222
|
-
# will probably find it advantageous to create buckets in the
|
1126
|
+
# will probably find it advantageous to create buckets in the Europe
|
1223
1127
|
# (Ireland) Region. For more information, see [How to Select a Region
|
1224
1128
|
# for Your Buckets][2].
|
1225
1129
|
#
|
@@ -1254,20 +1158,43 @@ module Aws::S3
|
|
1254
1158
|
# You specify each grantee as a type=value pair, where the type is one
|
1255
1159
|
# of the following:
|
1256
1160
|
#
|
1257
|
-
# * `emailAddress` – if the value specified is the email address of an
|
1258
|
-
# AWS account
|
1259
|
-
#
|
1260
1161
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
1261
1162
|
# account
|
1262
1163
|
#
|
1263
1164
|
# * `uri` – if you are granting permissions to a predefined group
|
1264
1165
|
#
|
1166
|
+
# * `emailAddress` – if the value specified is the email address of an
|
1167
|
+
# AWS account
|
1168
|
+
#
|
1169
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
1170
|
+
# the following AWS Regions:
|
1171
|
+
#
|
1172
|
+
# * US East (N. Virginia)
|
1173
|
+
#
|
1174
|
+
# * US West (N. California)
|
1175
|
+
#
|
1176
|
+
# * US West (Oregon)
|
1177
|
+
#
|
1178
|
+
# * Asia Pacific (Singapore)
|
1179
|
+
#
|
1180
|
+
# * Asia Pacific (Sydney)
|
1181
|
+
#
|
1182
|
+
# * Asia Pacific (Tokyo)
|
1183
|
+
#
|
1184
|
+
# * Europe (Ireland)
|
1185
|
+
#
|
1186
|
+
# * South America (São Paulo)
|
1187
|
+
#
|
1188
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1189
|
+
# see [Regions and Endpoints][6] in the AWS General Reference.
|
1190
|
+
#
|
1191
|
+
# </note>
|
1192
|
+
#
|
1265
1193
|
# For example, the following `x-amz-grant-read` header grants the AWS
|
1266
|
-
# accounts identified by
|
1267
|
-
#
|
1194
|
+
# accounts identified by account IDs permissions to read object data
|
1195
|
+
# and its metadata:
|
1268
1196
|
#
|
1269
|
-
# `x-amz-grant-read:
|
1270
|
-
# emailAddress="abc@amazon.com" `
|
1197
|
+
# `x-amz-grant-read: id="11112222333", id="444455556666" `
|
1271
1198
|
#
|
1272
1199
|
# <note markdown="1"> You can use either a canned ACL or specify access permissions
|
1273
1200
|
# explicitly. You cannot do both.
|
@@ -1287,6 +1214,7 @@ module Aws::S3
|
|
1287
1214
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html
|
1288
1215
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
1289
1216
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1217
|
+
# [6]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1290
1218
|
#
|
1291
1219
|
# @option params [String] :acl
|
1292
1220
|
# The canned ACL to apply to the bucket.
|
@@ -1349,7 +1277,7 @@ module Aws::S3
|
|
1349
1277
|
#
|
1350
1278
|
# resp.to_h outputs the following:
|
1351
1279
|
# {
|
1352
|
-
# location: "http://examplebucket
|
1280
|
+
# location: "http://examplebucket.<Region>.s3.amazonaws.com/",
|
1353
1281
|
# }
|
1354
1282
|
#
|
1355
1283
|
# @example Request syntax with placeholder values
|
@@ -1545,20 +1473,43 @@ module Aws::S3
|
|
1545
1473
|
# You specify each grantee as a type=value pair, where the type is
|
1546
1474
|
# one of the following:
|
1547
1475
|
#
|
1548
|
-
# * `emailAddress` – if the value specified is the email address of
|
1549
|
-
# an AWS account
|
1550
|
-
#
|
1551
1476
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
1552
1477
|
# account
|
1553
1478
|
#
|
1554
1479
|
# * `uri` – if you are granting permissions to a predefined group
|
1555
1480
|
#
|
1481
|
+
# * `emailAddress` – if the value specified is the email address of
|
1482
|
+
# an AWS account
|
1483
|
+
#
|
1484
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
1485
|
+
# the following AWS Regions:
|
1486
|
+
#
|
1487
|
+
# * US East (N. Virginia)
|
1488
|
+
#
|
1489
|
+
# * US West (N. California)
|
1490
|
+
#
|
1491
|
+
# * US West (Oregon)
|
1492
|
+
#
|
1493
|
+
# * Asia Pacific (Singapore)
|
1494
|
+
#
|
1495
|
+
# * Asia Pacific (Sydney)
|
1496
|
+
#
|
1497
|
+
# * Asia Pacific (Tokyo)
|
1498
|
+
#
|
1499
|
+
# * Europe (Ireland)
|
1500
|
+
#
|
1501
|
+
# * South America (São Paulo)
|
1502
|
+
#
|
1503
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
1504
|
+
# see [Regions and Endpoints][10] in the AWS General Reference.
|
1505
|
+
#
|
1506
|
+
# </note>
|
1507
|
+
#
|
1556
1508
|
# For example, the following `x-amz-grant-read` header grants the
|
1557
|
-
# AWS accounts identified by
|
1558
|
-
#
|
1509
|
+
# AWS accounts identified by account IDs permissions to read object
|
1510
|
+
# data and its metadata:
|
1559
1511
|
#
|
1560
|
-
# `x-amz-grant-read:
|
1561
|
-
# emailAddress="abc@amazon.com" `
|
1512
|
+
# `x-amz-grant-read: id="11112222333", id="444455556666" `
|
1562
1513
|
#
|
1563
1514
|
# The following operations are related to `CreateMultipartUpload`\:
|
1564
1515
|
#
|
@@ -1583,6 +1534,7 @@ module Aws::S3
|
|
1583
1534
|
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
1584
1535
|
# [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
1585
1536
|
# [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
1537
|
+
# [10]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
1586
1538
|
#
|
1587
1539
|
# @option params [String] :acl
|
1588
1540
|
# The canned ACL to apply to the object.
|
@@ -1848,7 +1800,7 @@ module Aws::S3
|
|
1848
1800
|
#
|
1849
1801
|
#
|
1850
1802
|
#
|
1851
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
1803
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1852
1804
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1853
1805
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html
|
1854
1806
|
#
|
@@ -1945,9 +1897,9 @@ module Aws::S3
|
|
1945
1897
|
#
|
1946
1898
|
#
|
1947
1899
|
#
|
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
|
1900
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
1901
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
1902
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
1951
1903
|
#
|
1952
1904
|
# @option params [required, String] :bucket
|
1953
1905
|
# The name of the bucket containing the server-side encryption
|
@@ -2428,15 +2380,6 @@ module Aws::S3
|
|
2428
2380
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2429
2381
|
#
|
2430
2382
|
#
|
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
2383
|
# @example Example: To delete an object
|
2441
2384
|
#
|
2442
2385
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2450,6 +2393,15 @@ module Aws::S3
|
|
2450
2393
|
# {
|
2451
2394
|
# }
|
2452
2395
|
#
|
2396
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2397
|
+
#
|
2398
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2399
|
+
#
|
2400
|
+
# resp = client.delete_object({
|
2401
|
+
# bucket: "ExampleBucket",
|
2402
|
+
# key: "HappyFace.jpg",
|
2403
|
+
# })
|
2404
|
+
#
|
2453
2405
|
# @example Request syntax with placeholder values
|
2454
2406
|
#
|
2455
2407
|
# resp = client.delete_object({
|
@@ -2670,20 +2622,22 @@ module Aws::S3
|
|
2670
2622
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
2671
2623
|
#
|
2672
2624
|
#
|
2673
|
-
# @example Example: To delete multiple
|
2625
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
2674
2626
|
#
|
2675
|
-
# # The following example deletes objects from a bucket. The
|
2676
|
-
# #
|
2627
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
2628
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
2677
2629
|
#
|
2678
2630
|
# resp = client.delete_objects({
|
2679
2631
|
# bucket: "examplebucket",
|
2680
2632
|
# delete: {
|
2681
2633
|
# objects: [
|
2682
2634
|
# {
|
2683
|
-
# key: "
|
2635
|
+
# key: "HappyFace.jpg",
|
2636
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2684
2637
|
# },
|
2685
2638
|
# {
|
2686
|
-
# key: "
|
2639
|
+
# key: "HappyFace.jpg",
|
2640
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2687
2641
|
# },
|
2688
2642
|
# ],
|
2689
2643
|
# quiet: false,
|
@@ -2694,34 +2648,30 @@ module Aws::S3
|
|
2694
2648
|
# {
|
2695
2649
|
# deleted: [
|
2696
2650
|
# {
|
2697
|
-
#
|
2698
|
-
#
|
2699
|
-
# key: "objectkey1",
|
2651
|
+
# key: "HappyFace.jpg",
|
2652
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2700
2653
|
# },
|
2701
2654
|
# {
|
2702
|
-
#
|
2703
|
-
#
|
2704
|
-
# key: "objectkey2",
|
2655
|
+
# key: "HappyFace.jpg",
|
2656
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2705
2657
|
# },
|
2706
2658
|
# ],
|
2707
2659
|
# }
|
2708
2660
|
#
|
2709
|
-
# @example Example: To delete multiple
|
2661
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
2710
2662
|
#
|
2711
|
-
# # The following example deletes objects from a bucket. The
|
2712
|
-
# #
|
2663
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
2664
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
2713
2665
|
#
|
2714
2666
|
# resp = client.delete_objects({
|
2715
2667
|
# bucket: "examplebucket",
|
2716
2668
|
# delete: {
|
2717
2669
|
# objects: [
|
2718
2670
|
# {
|
2719
|
-
# key: "
|
2720
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
2671
|
+
# key: "objectkey1",
|
2721
2672
|
# },
|
2722
2673
|
# {
|
2723
|
-
# key: "
|
2724
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
2674
|
+
# key: "objectkey2",
|
2725
2675
|
# },
|
2726
2676
|
# ],
|
2727
2677
|
# quiet: false,
|
@@ -2732,12 +2682,14 @@ module Aws::S3
|
|
2732
2682
|
# {
|
2733
2683
|
# deleted: [
|
2734
2684
|
# {
|
2735
|
-
#
|
2736
|
-
#
|
2685
|
+
# delete_marker: true,
|
2686
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
2687
|
+
# key: "objectkey1",
|
2737
2688
|
# },
|
2738
2689
|
# {
|
2739
|
-
#
|
2740
|
-
#
|
2690
|
+
# delete_marker: true,
|
2691
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
2692
|
+
# key: "objectkey2",
|
2741
2693
|
# },
|
2742
2694
|
# ],
|
2743
2695
|
# }
|
@@ -2790,8 +2742,7 @@ module Aws::S3
|
|
2790
2742
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
2791
2743
|
# Resources][2].
|
2792
2744
|
#
|
2793
|
-
# The following operations are related to
|
2794
|
-
# `DeleteBucketMetricsConfiguration`\:
|
2745
|
+
# The following operations are related to `DeletePublicAccessBlock`\:
|
2795
2746
|
#
|
2796
2747
|
# * [Using Amazon S3 Block Public Access][3]
|
2797
2748
|
#
|
@@ -2861,9 +2812,9 @@ module Aws::S3
|
|
2861
2812
|
#
|
2862
2813
|
#
|
2863
2814
|
#
|
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
|
2815
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2816
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2817
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
2867
2818
|
#
|
2868
2819
|
# @option params [required, String] :bucket
|
2869
2820
|
# Name of the bucket for which the accelerate configuration is
|
@@ -3348,7 +3299,7 @@ module Aws::S3
|
|
3348
3299
|
# * SOAP Fault Code Prefix: Client
|
3349
3300
|
#
|
3350
3301
|
# The following operations are related to
|
3351
|
-
# `
|
3302
|
+
# `GetBucketLifecycleConfiguration`\:
|
3352
3303
|
#
|
3353
3304
|
# * GetBucketLifecycle
|
3354
3305
|
#
|
@@ -3605,7 +3556,7 @@ module Aws::S3
|
|
3605
3556
|
# No longer used, see GetBucketNotificationConfiguration.
|
3606
3557
|
#
|
3607
3558
|
# @option params [required, String] :bucket
|
3608
|
-
# Name of the bucket for which to get the notification configuration
|
3559
|
+
# Name of the bucket for which to get the notification configuration.
|
3609
3560
|
#
|
3610
3561
|
# @return [Types::NotificationConfigurationDeprecated] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3611
3562
|
#
|
@@ -3731,7 +3682,7 @@ module Aws::S3
|
|
3731
3682
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
3732
3683
|
#
|
3733
3684
|
# @option params [required, String] :bucket
|
3734
|
-
# Name of the bucket for which to get the notification configuration
|
3685
|
+
# Name of the bucket for which to get the notification configuration.
|
3735
3686
|
#
|
3736
3687
|
# @return [Types::NotificationConfiguration] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3737
3688
|
#
|
@@ -4466,7 +4417,16 @@ module Aws::S3
|
|
4466
4417
|
# @option params [String] :range
|
4467
4418
|
# Downloads the specified range bytes of an object. For more information
|
4468
4419
|
# about the HTTP Range header, see
|
4469
|
-
# [
|
4420
|
+
# [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].
|
4421
|
+
#
|
4422
|
+
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
4423
|
+
# `GET` request.
|
4424
|
+
#
|
4425
|
+
# </note>
|
4426
|
+
#
|
4427
|
+
#
|
4428
|
+
#
|
4429
|
+
# [1]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
|
4470
4430
|
#
|
4471
4431
|
# @option params [String] :response_cache_control
|
4472
4432
|
# Sets the `Cache-Control` header of the response.
|
@@ -5446,6 +5406,11 @@ module Aws::S3
|
|
5446
5406
|
# about the HTTP Range header, see
|
5447
5407
|
# [http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().
|
5448
5408
|
#
|
5409
|
+
# <note markdown="1"> Amazon S3 doesn't support retrieving multiple ranges of data per
|
5410
|
+
# `GET` request.
|
5411
|
+
#
|
5412
|
+
# </note>
|
5413
|
+
#
|
5449
5414
|
# @option params [String] :version_id
|
5450
5415
|
# VersionId used to reference a specific version of the object.
|
5451
5416
|
#
|
@@ -6248,12 +6213,12 @@ module Aws::S3
|
|
6248
6213
|
# Specifies the key to start with when listing objects in a bucket.
|
6249
6214
|
#
|
6250
6215
|
# @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.
|
6216
|
+
# Sets the maximum number of keys returned in the response. By default
|
6217
|
+
# the API returns up to 1,000 key names. The response might contain
|
6218
|
+
# fewer keys but will never contain more. If additional keys satisfy the
|
6219
|
+
# search criteria, but were not returned because max-keys was exceeded,
|
6220
|
+
# the response contains <isTruncated>true</isTruncated>. To
|
6221
|
+
# return the additional keys, see key-marker and version-id-marker.
|
6257
6222
|
#
|
6258
6223
|
# @option params [String] :prefix
|
6259
6224
|
# Use this parameter to select only those keys that begin with the
|
@@ -6421,8 +6386,9 @@ module Aws::S3
|
|
6421
6386
|
# Specifies the key to start with when listing objects in a bucket.
|
6422
6387
|
#
|
6423
6388
|
# @option params [Integer] :max_keys
|
6424
|
-
# Sets the maximum number of keys returned in the response.
|
6425
|
-
#
|
6389
|
+
# Sets the maximum number of keys returned in the response. By default
|
6390
|
+
# the API returns up to 1,000 key names. The response might contain
|
6391
|
+
# fewer keys but will never contain more.
|
6426
6392
|
#
|
6427
6393
|
# @option params [String] :prefix
|
6428
6394
|
# Limits the response to keys that begin with the specified prefix.
|
@@ -6585,8 +6551,9 @@ module Aws::S3
|
|
6585
6551
|
# Encoding type used by Amazon S3 to encode object keys in the response.
|
6586
6552
|
#
|
6587
6553
|
# @option params [Integer] :max_keys
|
6588
|
-
# Sets the maximum number of keys returned in the response.
|
6589
|
-
#
|
6554
|
+
# Sets the maximum number of keys returned in the response. By default
|
6555
|
+
# the API returns up to 1,000 key names. The response might contain
|
6556
|
+
# fewer keys but will never contain more.
|
6590
6557
|
#
|
6591
6558
|
# @option params [String] :prefix
|
6592
6559
|
# Limits the response to keys that begin with the specified prefix.
|
@@ -7002,38 +6969,54 @@ module Aws::S3
|
|
7002
6969
|
# You specify each grantee as a type=value pair, where the type is one
|
7003
6970
|
# of the following:
|
7004
6971
|
#
|
7005
|
-
# * `emailAddress` – if the value specified is the email address of an
|
7006
|
-
# AWS account
|
7007
|
-
#
|
7008
6972
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
7009
6973
|
# account
|
7010
6974
|
#
|
7011
6975
|
# * `uri` – if you are granting permissions to a predefined group
|
7012
6976
|
#
|
7013
|
-
#
|
7014
|
-
#
|
7015
|
-
# predefined by Amazon S3 and two AWS accounts identified by their
|
7016
|
-
# email addresses.
|
6977
|
+
# * `emailAddress` – if the value specified is the email address of an
|
6978
|
+
# AWS account
|
7017
6979
|
#
|
7018
|
-
#
|
7019
|
-
#
|
7020
|
-
# emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com" `
|
6980
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
6981
|
+
# the following AWS Regions:
|
7021
6982
|
#
|
7022
|
-
#
|
7023
|
-
# explicitly. You cannot do both.
|
6983
|
+
# * US East (N. Virginia)
|
7024
6984
|
#
|
7025
|
-
#
|
6985
|
+
# * US West (N. California)
|
7026
6986
|
#
|
7027
|
-
#
|
7028
|
-
# rights (using request elements) in the following ways:
|
6987
|
+
# * US West (Oregon)
|
7029
6988
|
#
|
7030
|
-
#
|
6989
|
+
# * Asia Pacific (Singapore)
|
7031
6990
|
#
|
7032
|
-
#
|
7033
|
-
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
6991
|
+
# * Asia Pacific (Sydney)
|
7034
6992
|
#
|
7035
|
-
#
|
7036
|
-
#
|
6993
|
+
# * Asia Pacific (Tokyo)
|
6994
|
+
#
|
6995
|
+
# * Europe (Ireland)
|
6996
|
+
#
|
6997
|
+
# * South America (São Paulo)
|
6998
|
+
#
|
6999
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
7000
|
+
# see [Regions and Endpoints][4] in the AWS General Reference.
|
7001
|
+
#
|
7002
|
+
# </note>
|
7003
|
+
#
|
7004
|
+
# For example, the following `x-amz-grant-write` header grants create,
|
7005
|
+
# overwrite, and delete objects permission to LogDelivery group
|
7006
|
+
# predefined by Amazon S3 and two AWS accounts identified by their
|
7007
|
+
# email addresses.
|
7008
|
+
#
|
7009
|
+
# `x-amz-grant-write:
|
7010
|
+
# uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
7011
|
+
# id="111122223333", id="555566667777" `
|
7012
|
+
#
|
7013
|
+
# You can use either a canned ACL or specify access permissions
|
7014
|
+
# explicitly. You cannot do both.
|
7015
|
+
#
|
7016
|
+
# **Grantee Values**
|
7017
|
+
#
|
7018
|
+
# You can specify the person (grantee) to whom you're assigning access
|
7019
|
+
# rights (using request elements) in the following ways:
|
7037
7020
|
#
|
7038
7021
|
# * By the person's ID:
|
7039
7022
|
#
|
@@ -7048,6 +7031,38 @@ module Aws::S3
|
|
7048
7031
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
7049
7032
|
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
|
7050
7033
|
#
|
7034
|
+
# * By Email address:
|
7035
|
+
#
|
7036
|
+
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
7037
|
+
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
7038
|
+
#
|
7039
|
+
# The grantee is resolved to the CanonicalUser and, in a response to a
|
7040
|
+
# GET Object acl request, appears as the CanonicalUser.
|
7041
|
+
#
|
7042
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
|
7043
|
+
# following AWS Regions:
|
7044
|
+
#
|
7045
|
+
# * US East (N. Virginia)
|
7046
|
+
#
|
7047
|
+
# * US West (N. California)
|
7048
|
+
#
|
7049
|
+
# * US West (Oregon)
|
7050
|
+
#
|
7051
|
+
# * Asia Pacific (Singapore)
|
7052
|
+
#
|
7053
|
+
# * Asia Pacific (Sydney)
|
7054
|
+
#
|
7055
|
+
# * Asia Pacific (Tokyo)
|
7056
|
+
#
|
7057
|
+
# * Europe (Ireland)
|
7058
|
+
#
|
7059
|
+
# * South America (São Paulo)
|
7060
|
+
#
|
7061
|
+
# For a list of all the Amazon S3 supported Regions and endpoints, see
|
7062
|
+
# [Regions and Endpoints][4] in the AWS General Reference.
|
7063
|
+
#
|
7064
|
+
# </note>
|
7065
|
+
#
|
7051
7066
|
# **Related Resources**
|
7052
7067
|
#
|
7053
7068
|
# * CreateBucket
|
@@ -7061,6 +7076,7 @@ module Aws::S3
|
|
7061
7076
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
7062
7077
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
7063
7078
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
7079
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
7064
7080
|
#
|
7065
7081
|
# @option params [String] :acl
|
7066
7082
|
# The canned ACL to apply to the bucket.
|
@@ -7336,7 +7352,7 @@ module Aws::S3
|
|
7336
7352
|
#
|
7337
7353
|
#
|
7338
7354
|
#
|
7339
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7355
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html
|
7340
7356
|
#
|
7341
7357
|
# @option params [String] :content_md5
|
7342
7358
|
# The base64-encoded 128-bit MD5 digest of the data. This header must be
|
@@ -7425,7 +7441,9 @@ module Aws::S3
|
|
7425
7441
|
#
|
7426
7442
|
# This implementation of the `PUT` operation sets default encryption for
|
7427
7443
|
# a bucket using server-side encryption with Amazon S3-managed keys
|
7428
|
-
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS).
|
7444
|
+
# SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For
|
7445
|
+
# information about the Amazon S3 default encryption feature, see
|
7446
|
+
# [Amazon S3 Default Bucket Encryption][1].
|
7429
7447
|
#
|
7430
7448
|
# This operation requires AWS Signature Version 4. For more information,
|
7431
7449
|
# see [ Authenticating Requests (AWS Signature Version
|
@@ -7435,8 +7453,8 @@ module Aws::S3
|
|
7435
7453
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
7436
7454
|
# permission by default. The bucket owner can grant this permission to
|
7437
7455
|
# others. For more information about permissions, see [Permissions
|
7438
|
-
# Related to Bucket Subresource Operations][
|
7439
|
-
# Permissions to Your Amazon S3 Resources][
|
7456
|
+
# Related to Bucket Subresource Operations][2] and [Managing Access
|
7457
|
+
# Permissions to Your Amazon S3 Resources][3] in the Amazon Simple
|
7440
7458
|
# Storage Service Developer Guide.
|
7441
7459
|
#
|
7442
7460
|
# **Related Resources**
|
@@ -7447,8 +7465,9 @@ module Aws::S3
|
|
7447
7465
|
#
|
7448
7466
|
#
|
7449
7467
|
#
|
7450
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/
|
7451
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
|
7468
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
7469
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7470
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7452
7471
|
#
|
7453
7472
|
# @option params [required, String] :bucket
|
7454
7473
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -7519,7 +7538,7 @@ module Aws::S3
|
|
7519
7538
|
# You must create a bucket policy on the *destination* bucket to grant
|
7520
7539
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
7521
7540
|
# location. For an example policy, see [ Granting Permissions for Amazon
|
7522
|
-
# S3 Inventory and Storage Class Analysis
|
7541
|
+
# S3 Inventory and Storage Class Analysis][2].
|
7523
7542
|
#
|
7524
7543
|
# To use this operation, you must have permissions to perform the
|
7525
7544
|
# `s3:PutInventoryConfiguration` action. The bucket owner has this
|
@@ -7550,7 +7569,7 @@ module Aws::S3
|
|
7550
7569
|
#
|
7551
7570
|
# * *Cause:* You are not the owner of the specified bucket, or you do
|
7552
7571
|
# not have the `s3:PutInventoryConfiguration` bucket permission to
|
7553
|
-
# set the configuration on the bucket
|
7572
|
+
# set the configuration on the bucket.
|
7554
7573
|
#
|
7555
7574
|
# **Related Resources**
|
7556
7575
|
#
|
@@ -7562,10 +7581,10 @@ module Aws::S3
|
|
7562
7581
|
#
|
7563
7582
|
#
|
7564
7583
|
#
|
7565
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev
|
7584
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html
|
7566
7585
|
# [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
|
7586
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
7587
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7569
7588
|
#
|
7570
7589
|
# @option params [required, String] :bucket
|
7571
7590
|
# The name of the bucket where the inventory configuration will be
|
@@ -7678,10 +7697,10 @@ module Aws::S3
|
|
7678
7697
|
#
|
7679
7698
|
#
|
7680
7699
|
#
|
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
|
7700
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html
|
7701
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
7702
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples
|
7703
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html
|
7685
7704
|
#
|
7686
7705
|
# @option params [required, String] :bucket
|
7687
7706
|
#
|
@@ -8354,7 +8373,7 @@ module Aws::S3
|
|
8354
8373
|
# permissions on the specified bucket and belong to the bucket owner's
|
8355
8374
|
# account in order to use this operation.
|
8356
8375
|
#
|
8357
|
-
# If you don't have `
|
8376
|
+
# If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a
|
8358
8377
|
# `403 Access Denied` error. If you have the correct permissions, but
|
8359
8378
|
# you're not using an identity that belongs to the bucket owner's
|
8360
8379
|
# account, Amazon S3 returns a `405 Method Not Allowed` error.
|
@@ -8737,8 +8756,8 @@ module Aws::S3
|
|
8737
8756
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html
|
8738
8757
|
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8739
8758
|
# [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
|
8759
|
+
# [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html
|
8760
|
+
# [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html
|
8742
8761
|
#
|
8743
8762
|
# @option params [required, String] :bucket
|
8744
8763
|
# The bucket name.
|
@@ -8962,9 +8981,15 @@ module Aws::S3
|
|
8962
8981
|
#
|
8963
8982
|
# * `HttpRedirectCode`
|
8964
8983
|
#
|
8984
|
+
# Amazon S3 has a limitation of 50 routing rules per website
|
8985
|
+
# configuration. If you require more than 50 routing rules, you can use
|
8986
|
+
# object redirect. For more information, see [Configuring an Object
|
8987
|
+
# Redirect][2] in the *Amazon Simple Storage Service Developer Guide*.
|
8988
|
+
#
|
8965
8989
|
#
|
8966
8990
|
#
|
8967
8991
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
8992
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html
|
8968
8993
|
#
|
8969
8994
|
# @option params [required, String] :bucket
|
8970
8995
|
# The bucket name.
|
@@ -9063,16 +9088,16 @@ module Aws::S3
|
|
9063
9088
|
# putting an object to Amazon S3 and compare the returned ETag to the
|
9064
9089
|
# calculated MD5 value.
|
9065
9090
|
#
|
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].
|
9091
|
+
# <note markdown="1"> The `Content-MD5` header is required for any request to upload an
|
9092
|
+
# object with a retention period configured using Amazon S3 Object Lock.
|
9093
|
+
# For more information about Amazon S3 Object Lock, see [Amazon S3
|
9094
|
+
# Object Lock Overview][1] in the *Amazon Simple Storage Service
|
9095
|
+
# Developer Guide*.
|
9073
9096
|
#
|
9074
9097
|
# </note>
|
9075
9098
|
#
|
9099
|
+
# **Server-side Encryption**
|
9100
|
+
#
|
9076
9101
|
# You can optionally request server-side encryption. With server-side
|
9077
9102
|
# encryption, Amazon S3 encrypts your data as it writes it to disks in
|
9078
9103
|
# its data centers and decrypts the data when you access it. You have
|
@@ -9080,229 +9105,35 @@ module Aws::S3
|
|
9080
9105
|
# encryption keys. For more information, see [Using Server-Side
|
9081
9106
|
# Encryption][2].
|
9082
9107
|
#
|
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
|
9108
|
+
# **Access Control List (ACL)-Specific Request Headers**
|
9221
9109
|
#
|
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].
|
9110
|
+
# You can use headers to grant ACL- based permissions. By default, all
|
9111
|
+
# objects are private. Only the owner has full access control. When
|
9112
|
+
# adding a new object, you can grant permissions to individual AWS
|
9113
|
+
# accounts or to predefined groups defined by Amazon S3. These
|
9114
|
+
# permissions are then added to the ACL on the object. For more
|
9115
|
+
# information, see [Access Control List (ACL) Overview][3] and [Managing
|
9116
|
+
# ACLs Using the REST API][4].
|
9286
9117
|
#
|
9287
9118
|
# **Storage Class Options**
|
9288
9119
|
#
|
9289
|
-
# By default, Amazon S3 uses the
|
9290
|
-
# created objects. The
|
9291
|
-
# and high availability.
|
9292
|
-
#
|
9293
|
-
# Classes][
|
9120
|
+
# By default, Amazon S3 uses the STANDARD storage class to store newly
|
9121
|
+
# created objects. The STANDARD storage class provides high durability
|
9122
|
+
# and high availability. Depending on performance needs, you can specify
|
9123
|
+
# a different storage class. For more information, see [Storage
|
9124
|
+
# Classes][5] in the *Amazon S3 Service Developer Guide*.
|
9294
9125
|
#
|
9295
9126
|
# **Versioning**
|
9296
9127
|
#
|
9297
9128
|
# If you enable versioning for a bucket, Amazon S3 automatically
|
9298
9129
|
# 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
|
-
#
|
9130
|
+
# returns this ID in the response. When you enable versioning for a
|
9131
|
+
# bucket, if Amazon S3 receives multiple write requests for the same
|
9132
|
+
# object simultaneously, it stores all of the objects.
|
9133
|
+
#
|
9134
|
+
# For more information about versioning, see [Adding Objects to
|
9135
|
+
# Versioning Enabled Buckets][6]. For information about returning the
|
9136
|
+
# versioning state of a bucket, see GetBucketVersioning.
|
9306
9137
|
#
|
9307
9138
|
# **Related Resources**
|
9308
9139
|
#
|
@@ -9312,15 +9143,12 @@ module Aws::S3
|
|
9312
9143
|
#
|
9313
9144
|
#
|
9314
9145
|
#
|
9315
|
-
# [1]:
|
9146
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html
|
9316
9147
|
# [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
|
9148
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9149
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html
|
9150
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
|
9151
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html
|
9324
9152
|
#
|
9325
9153
|
# @option params [String] :acl
|
9326
9154
|
# The canned ACL to apply to the object. For more information, see
|
@@ -9443,8 +9271,8 @@ module Aws::S3
|
|
9443
9271
|
# Amazon S3 (for example, AES256, aws:kms).
|
9444
9272
|
#
|
9445
9273
|
# @option params [String] :storage_class
|
9446
|
-
# If you don't specify, Standard is the default storage class.
|
9447
|
-
# S3 supports other storage classes.
|
9274
|
+
# If you don't specify, S3 Standard is the default storage class.
|
9275
|
+
# Amazon S3 supports other storage classes.
|
9448
9276
|
#
|
9449
9277
|
# @option params [String] :website_redirect_location
|
9450
9278
|
# If the bucket is configured as a website, redirects requests for this
|
@@ -9548,96 +9376,99 @@ module Aws::S3
|
|
9548
9376
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
9549
9377
|
#
|
9550
9378
|
#
|
9551
|
-
# @example Example: To upload an object
|
9379
|
+
# @example Example: To upload an object and specify server-side encryption and object tags
|
9552
9380
|
#
|
9553
|
-
# # The following example uploads
|
9554
|
-
# #
|
9381
|
+
# # The following example uploads and object. The request specifies the optional server-side encryption option. The request
|
9382
|
+
# # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
|
9555
9383
|
#
|
9556
9384
|
# resp = client.put_object({
|
9557
|
-
# body: "
|
9385
|
+
# body: "filetoupload",
|
9558
9386
|
# bucket: "examplebucket",
|
9559
|
-
# key: "
|
9387
|
+
# key: "exampleobject",
|
9560
9388
|
# server_side_encryption: "AES256",
|
9561
|
-
#
|
9389
|
+
# tagging: "key1=value1&key2=value2",
|
9562
9390
|
# })
|
9563
9391
|
#
|
9564
9392
|
# resp.to_h outputs the following:
|
9565
9393
|
# {
|
9566
9394
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9567
9395
|
# server_side_encryption: "AES256",
|
9568
|
-
# version_id: "
|
9396
|
+
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9569
9397
|
# }
|
9570
9398
|
#
|
9571
|
-
# @example Example: To
|
9399
|
+
# @example Example: To create an object.
|
9572
9400
|
#
|
9573
|
-
# # The following example
|
9574
|
-
# # S3 returns version ID of the newly created object.
|
9401
|
+
# # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
|
9575
9402
|
#
|
9576
9403
|
# resp = client.put_object({
|
9577
|
-
# body: "
|
9404
|
+
# body: "filetoupload",
|
9578
9405
|
# bucket: "examplebucket",
|
9579
|
-
# key: "
|
9580
|
-
# tagging: "key1=value1&key2=value2",
|
9406
|
+
# key: "objectkey",
|
9581
9407
|
# })
|
9582
9408
|
#
|
9583
9409
|
# resp.to_h outputs the following:
|
9584
9410
|
# {
|
9585
9411
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9586
|
-
# version_id: "
|
9412
|
+
# version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ",
|
9587
9413
|
# }
|
9588
9414
|
#
|
9589
|
-
# @example Example: To upload object and specify
|
9415
|
+
# @example Example: To upload an object and specify optional tags
|
9590
9416
|
#
|
9591
|
-
# # The following example
|
9592
|
-
# #
|
9417
|
+
# # The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore
|
9418
|
+
# # S3 returns version ID of the newly created object.
|
9593
9419
|
#
|
9594
9420
|
# resp = client.put_object({
|
9595
|
-
# body: "
|
9421
|
+
# body: "c:\\HappyFace.jpg",
|
9596
9422
|
# bucket: "examplebucket",
|
9597
|
-
# key: "
|
9598
|
-
#
|
9599
|
-
# "metadata1" => "value1",
|
9600
|
-
# "metadata2" => "value2",
|
9601
|
-
# },
|
9423
|
+
# key: "HappyFace.jpg",
|
9424
|
+
# tagging: "key1=value1&key2=value2",
|
9602
9425
|
# })
|
9603
9426
|
#
|
9604
9427
|
# resp.to_h outputs the following:
|
9605
9428
|
# {
|
9606
9429
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9607
|
-
# version_id: "
|
9430
|
+
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
9608
9431
|
# }
|
9609
9432
|
#
|
9610
|
-
# @example Example: To
|
9433
|
+
# @example Example: To upload an object (specify optional headers)
|
9611
9434
|
#
|
9612
|
-
# # The following example
|
9435
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
9436
|
+
# # storage class and use server-side encryption.
|
9613
9437
|
#
|
9614
9438
|
# resp = client.put_object({
|
9615
|
-
# body: "
|
9439
|
+
# body: "HappyFace.jpg",
|
9616
9440
|
# bucket: "examplebucket",
|
9617
|
-
# key: "
|
9441
|
+
# key: "HappyFace.jpg",
|
9442
|
+
# server_side_encryption: "AES256",
|
9443
|
+
# storage_class: "STANDARD_IA",
|
9618
9444
|
# })
|
9619
9445
|
#
|
9620
9446
|
# resp.to_h outputs the following:
|
9621
9447
|
# {
|
9622
9448
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9623
|
-
#
|
9449
|
+
# server_side_encryption: "AES256",
|
9450
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
9624
9451
|
# }
|
9625
9452
|
#
|
9626
|
-
# @example Example: To upload
|
9453
|
+
# @example Example: To upload object and specify user-defined metadata
|
9627
9454
|
#
|
9628
|
-
# # The following example
|
9629
|
-
# #
|
9455
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
9456
|
+
# # enabled, S3 returns version ID in response.
|
9630
9457
|
#
|
9631
9458
|
# resp = client.put_object({
|
9632
|
-
# body: "
|
9459
|
+
# body: "filetoupload",
|
9633
9460
|
# bucket: "examplebucket",
|
9634
|
-
# key: "
|
9461
|
+
# key: "exampleobject",
|
9462
|
+
# metadata: {
|
9463
|
+
# "metadata1" => "value1",
|
9464
|
+
# "metadata2" => "value2",
|
9465
|
+
# },
|
9635
9466
|
# })
|
9636
9467
|
#
|
9637
9468
|
# resp.to_h outputs the following:
|
9638
9469
|
# {
|
9639
9470
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9640
|
-
# version_id: "
|
9471
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
9641
9472
|
# }
|
9642
9473
|
#
|
9643
9474
|
# @example Example: To upload an object and specify canned ACL.
|
@@ -9658,24 +9489,21 @@ module Aws::S3
|
|
9658
9489
|
# version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr",
|
9659
9490
|
# }
|
9660
9491
|
#
|
9661
|
-
# @example Example: To upload an object
|
9492
|
+
# @example Example: To upload an object
|
9662
9493
|
#
|
9663
|
-
# # The following example uploads
|
9664
|
-
# #
|
9494
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
9495
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
9665
9496
|
#
|
9666
9497
|
# resp = client.put_object({
|
9667
|
-
# body: "
|
9498
|
+
# body: "HappyFace.jpg",
|
9668
9499
|
# bucket: "examplebucket",
|
9669
|
-
# key: "
|
9670
|
-
# server_side_encryption: "AES256",
|
9671
|
-
# tagging: "key1=value1&key2=value2",
|
9500
|
+
# key: "HappyFace.jpg",
|
9672
9501
|
# })
|
9673
9502
|
#
|
9674
9503
|
# resp.to_h outputs the following:
|
9675
9504
|
# {
|
9676
9505
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
9677
|
-
#
|
9678
|
-
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
9506
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
9679
9507
|
# }
|
9680
9508
|
#
|
9681
9509
|
# @example Streaming a file from disk
|
@@ -9749,7 +9577,9 @@ module Aws::S3
|
|
9749
9577
|
# Depending on your application needs, you can choose to set the ACL on
|
9750
9578
|
# an object using either the request body or the headers. For example,
|
9751
9579
|
# if you have an existing application that updates a bucket ACL using
|
9752
|
-
# the request body, you can continue to use that approach.
|
9580
|
+
# the request body, you can continue to use that approach. For more
|
9581
|
+
# information, see [Access Control List (ACL) Overview][1] in the
|
9582
|
+
# *Amazon S3 Developer Guide*.
|
9753
9583
|
#
|
9754
9584
|
# **Access Permissions**
|
9755
9585
|
#
|
@@ -9760,7 +9590,7 @@ module Aws::S3
|
|
9760
9590
|
# ACL has a predefined set of grantees and permissions. Specify the
|
9761
9591
|
# canned ACL name as the value of `x-amz-ac`l. If you use this header,
|
9762
9592
|
# you cannot use other access control-specific headers in your
|
9763
|
-
# request. For more information, see [Canned ACL][
|
9593
|
+
# request. For more information, see [Canned ACL][2].
|
9764
9594
|
#
|
9765
9595
|
# * Specify access permissions explicitly with the `x-amz-grant-read`,
|
9766
9596
|
# `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
|
@@ -9770,19 +9600,43 @@ module Aws::S3
|
|
9770
9600
|
# ACL-specific headers, you cannot use `x-amz-acl` header to set a
|
9771
9601
|
# canned ACL. These parameters map to the set of permissions that
|
9772
9602
|
# Amazon S3 supports in an ACL. For more information, see [Access
|
9773
|
-
# Control List (ACL) Overview][
|
9603
|
+
# Control List (ACL) Overview][1].
|
9774
9604
|
#
|
9775
9605
|
# You specify each grantee as a type=value pair, where the type is one
|
9776
9606
|
# of the following:
|
9777
9607
|
#
|
9778
|
-
# * `emailAddress` – if the value specified is the email address of an
|
9779
|
-
# AWS account
|
9780
|
-
#
|
9781
9608
|
# * `id` – if the value specified is the canonical user ID of an AWS
|
9782
9609
|
# account
|
9783
9610
|
#
|
9784
9611
|
# * `uri` – if you are granting permissions to a predefined group
|
9785
9612
|
#
|
9613
|
+
# * `emailAddress` – if the value specified is the email address of an
|
9614
|
+
# AWS account
|
9615
|
+
#
|
9616
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in
|
9617
|
+
# the following AWS Regions:
|
9618
|
+
#
|
9619
|
+
# * US East (N. Virginia)
|
9620
|
+
#
|
9621
|
+
# * US West (N. California)
|
9622
|
+
#
|
9623
|
+
# * US West (Oregon)
|
9624
|
+
#
|
9625
|
+
# * Asia Pacific (Singapore)
|
9626
|
+
#
|
9627
|
+
# * Asia Pacific (Sydney)
|
9628
|
+
#
|
9629
|
+
# * Asia Pacific (Tokyo)
|
9630
|
+
#
|
9631
|
+
# * Europe (Ireland)
|
9632
|
+
#
|
9633
|
+
# * South America (São Paulo)
|
9634
|
+
#
|
9635
|
+
# For a list of all the Amazon S3 supported Regions and endpoints,
|
9636
|
+
# see [Regions and Endpoints][3] in the AWS General Reference.
|
9637
|
+
#
|
9638
|
+
# </note>
|
9639
|
+
#
|
9786
9640
|
# For example, the following `x-amz-grant-read` header grants list
|
9787
9641
|
# objects permission to the two AWS accounts identified by their email
|
9788
9642
|
# addresses.
|
@@ -9798,14 +9652,6 @@ module Aws::S3
|
|
9798
9652
|
# You can specify the person (grantee) to whom you're assigning access
|
9799
9653
|
# rights (using request elements) in the following ways:
|
9800
9654
|
#
|
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
9655
|
# * By the person's ID:
|
9810
9656
|
#
|
9811
9657
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
@@ -9819,6 +9665,38 @@ module Aws::S3
|
|
9819
9665
|
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9820
9666
|
# xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>`
|
9821
9667
|
#
|
9668
|
+
# * By Email address:
|
9669
|
+
#
|
9670
|
+
# `<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
9671
|
+
# xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>`
|
9672
|
+
#
|
9673
|
+
# The grantee is resolved to the CanonicalUser and, in a response to a
|
9674
|
+
# GET Object acl request, appears as the CanonicalUser.
|
9675
|
+
#
|
9676
|
+
# <note markdown="1"> Using email addresses to specify a grantee is only supported in the
|
9677
|
+
# following AWS Regions:
|
9678
|
+
#
|
9679
|
+
# * US East (N. Virginia)
|
9680
|
+
#
|
9681
|
+
# * US West (N. California)
|
9682
|
+
#
|
9683
|
+
# * US West (Oregon)
|
9684
|
+
#
|
9685
|
+
# * Asia Pacific (Singapore)
|
9686
|
+
#
|
9687
|
+
# * Asia Pacific (Sydney)
|
9688
|
+
#
|
9689
|
+
# * Asia Pacific (Tokyo)
|
9690
|
+
#
|
9691
|
+
# * Europe (Ireland)
|
9692
|
+
#
|
9693
|
+
# * South America (São Paulo)
|
9694
|
+
#
|
9695
|
+
# For a list of all the Amazon S3 supported Regions and endpoints, see
|
9696
|
+
# [Regions and Endpoints][3] in the AWS General Reference.
|
9697
|
+
#
|
9698
|
+
# </note>
|
9699
|
+
#
|
9822
9700
|
# **Versioning**
|
9823
9701
|
#
|
9824
9702
|
# The ACL of an object is set at the object version level. By default,
|
@@ -9833,8 +9711,9 @@ module Aws::S3
|
|
9833
9711
|
#
|
9834
9712
|
#
|
9835
9713
|
#
|
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
|
9714
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
|
9715
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL
|
9716
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region
|
9838
9717
|
#
|
9839
9718
|
# @option params [String] :acl
|
9840
9719
|
# The canned ACL to apply to the object. For more information, see
|
@@ -10229,7 +10108,8 @@ module Aws::S3
|
|
10229
10108
|
req.send_request(options)
|
10230
10109
|
end
|
10231
10110
|
|
10232
|
-
# Sets the supplied tag-set to an object that already exists in a
|
10111
|
+
# Sets the supplied tag-set to an object that already exists in a
|
10112
|
+
# bucket.
|
10233
10113
|
#
|
10234
10114
|
# A tag is a key-value pair. You can associate tags with an object by
|
10235
10115
|
# sending a PUT request against the tagging subresource that is
|
@@ -10458,12 +10338,11 @@ module Aws::S3
|
|
10458
10338
|
# * `restore an archive` - Restore an archived object
|
10459
10339
|
#
|
10460
10340
|
# To use this operation, you must have permissions to perform the
|
10461
|
-
# `s3:RestoreObject`
|
10462
|
-
#
|
10463
|
-
#
|
10464
|
-
#
|
10465
|
-
#
|
10466
|
-
# Developer Guide*.
|
10341
|
+
# `s3:RestoreObject` action. The bucket owner has this permission by
|
10342
|
+
# default and can grant this permission to others. For more information
|
10343
|
+
# about permissions, see [Permissions Related to Bucket Subresource
|
10344
|
+
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
10345
|
+
# Resources][2] in the *Amazon Simple Storage Service Developer Guide*.
|
10467
10346
|
#
|
10468
10347
|
# **Querying Archives with Select Requests**
|
10469
10348
|
#
|
@@ -10519,9 +10398,9 @@ module Aws::S3
|
|
10519
10398
|
#
|
10520
10399
|
# `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s`
|
10521
10400
|
#
|
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*.
|
10401
|
+
# For more information about using SQL with S3 Glacier Select restore,
|
10402
|
+
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][6] in
|
10403
|
+
# the *Amazon Simple Storage Service Developer Guide*.
|
10525
10404
|
#
|
10526
10405
|
# When making a select request, you can also do the following:
|
10527
10406
|
#
|
@@ -10578,10 +10457,10 @@ module Aws::S3
|
|
10578
10457
|
# retrievals and provisioned capacity are not available for the
|
10579
10458
|
# DEEP\_ARCHIVE storage class.
|
10580
10459
|
#
|
10581
|
-
# * <b> <code>Standard</code> </b> - Standard retrievals allow you to
|
10460
|
+
# * <b> <code>Standard</code> </b> - S3 Standard retrievals allow you to
|
10582
10461
|
# access any of your archived objects within several hours. This is
|
10583
10462
|
# the default option for the GLACIER and DEEP\_ARCHIVE retrieval
|
10584
|
-
# requests that do not specify the retrieval option. Standard
|
10463
|
+
# requests that do not specify the retrieval option. S3 Standard
|
10585
10464
|
# retrievals typically complete within 3-5 hours from the GLACIER
|
10586
10465
|
# storage class and typically complete within 12 hours from the
|
10587
10466
|
# DEEP\_ARCHIVE storage class.
|
@@ -10659,10 +10538,11 @@ module Aws::S3
|
|
10659
10538
|
#
|
10660
10539
|
# * *Code: GlacierExpeditedRetrievalNotAvailable*
|
10661
10540
|
#
|
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
|
10541
|
+
# * *Cause: S3 Glacier expedited retrievals are currently not
|
10542
|
+
# available. Try again later. (Returned if there is insufficient
|
10543
|
+
# capacity to process the Expedited request. This error applies only
|
10544
|
+
# to Expedited retrievals and not to S3 Standard or Bulk
|
10545
|
+
# retrievals.)*
|
10666
10546
|
#
|
10667
10547
|
# * *HTTP Status Code: 503*
|
10668
10548
|
#
|
@@ -10674,8 +10554,8 @@ module Aws::S3
|
|
10674
10554
|
#
|
10675
10555
|
# * GetBucketNotificationConfiguration
|
10676
10556
|
#
|
10677
|
-
# * [SQL Reference for Amazon S3 Select and Glacier Select ][6] in
|
10678
|
-
# *Amazon Simple Storage Service Developer Guide*
|
10557
|
+
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][6] in
|
10558
|
+
# the *Amazon Simple Storage Service Developer Guide*
|
10679
10559
|
#
|
10680
10560
|
#
|
10681
10561
|
#
|
@@ -10867,8 +10747,8 @@ module Aws::S3
|
|
10867
10747
|
# Guide*.
|
10868
10748
|
#
|
10869
10749
|
# 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*.
|
10750
|
+
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
10751
|
+
# *Amazon Simple Storage Service Developer Guide*.
|
10872
10752
|
#
|
10873
10753
|
#
|
10874
10754
|
#
|
@@ -10929,10 +10809,10 @@ module Aws::S3
|
|
10929
10809
|
# The `SelectObjectContent` operation does not support the following
|
10930
10810
|
# `GetObject` functionality. For more information, see GetObject.
|
10931
10811
|
#
|
10932
|
-
# * `Range`\:
|
10933
|
-
# request
|
10934
|
-
# parameters
|
10935
|
-
# to return.
|
10812
|
+
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
10813
|
+
# Select request (see SelectObjectContentRequest$ScanRange in the
|
10814
|
+
# request parameters), you cannot specify the range of bytes of an
|
10815
|
+
# object to return.
|
10936
10816
|
#
|
10937
10817
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
10938
10818
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
@@ -10944,9 +10824,8 @@ module Aws::S3
|
|
10944
10824
|
#
|
10945
10825
|
# **Special Errors**
|
10946
10826
|
#
|
10947
|
-
# For a list of special errors for this operation
|
10948
|
-
#
|
10949
|
-
# ErrorResponses
|
10827
|
+
# For a list of special errors for this operation, see
|
10828
|
+
# SelectObjectContentErrorCodeList
|
10950
10829
|
#
|
10951
10830
|
# **Related Resources**
|
10952
10831
|
#
|
@@ -11692,45 +11571,45 @@ module Aws::S3
|
|
11692
11571
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
11693
11572
|
#
|
11694
11573
|
#
|
11695
|
-
# @example Example: To upload a part by copying
|
11574
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
11696
11575
|
#
|
11697
|
-
# # The following example uploads a part of a multipart upload by copying
|
11698
|
-
# # data source.
|
11576
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
11699
11577
|
#
|
11700
11578
|
# resp = client.upload_part_copy({
|
11701
11579
|
# bucket: "examplebucket",
|
11702
11580
|
# copy_source: "/bucketname/sourceobjectkey",
|
11703
|
-
# copy_source_range: "bytes=1-100000",
|
11704
11581
|
# key: "examplelargeobject",
|
11705
|
-
# part_number:
|
11582
|
+
# part_number: 1,
|
11706
11583
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11707
11584
|
# })
|
11708
11585
|
#
|
11709
11586
|
# resp.to_h outputs the following:
|
11710
11587
|
# {
|
11711
11588
|
# copy_part_result: {
|
11712
|
-
# etag: "\"
|
11713
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11589
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
11590
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
11714
11591
|
# },
|
11715
11592
|
# }
|
11716
11593
|
#
|
11717
|
-
# @example Example: To upload a part by copying
|
11594
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
11718
11595
|
#
|
11719
|
-
# # The following example uploads a part of a multipart upload by copying
|
11596
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
11597
|
+
# # data source.
|
11720
11598
|
#
|
11721
11599
|
# resp = client.upload_part_copy({
|
11722
11600
|
# bucket: "examplebucket",
|
11723
11601
|
# copy_source: "/bucketname/sourceobjectkey",
|
11602
|
+
# copy_source_range: "bytes=1-100000",
|
11724
11603
|
# key: "examplelargeobject",
|
11725
|
-
# part_number:
|
11604
|
+
# part_number: 2,
|
11726
11605
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
11727
11606
|
# })
|
11728
11607
|
#
|
11729
11608
|
# resp.to_h outputs the following:
|
11730
11609
|
# {
|
11731
11610
|
# copy_part_result: {
|
11732
|
-
# etag: "\"
|
11733
|
-
# last_modified: Time.parse("2016-12-29T21:
|
11611
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
11612
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
11734
11613
|
# },
|
11735
11614
|
# }
|
11736
11615
|
#
|
@@ -11789,7 +11668,7 @@ module Aws::S3
|
|
11789
11668
|
params: params,
|
11790
11669
|
config: config)
|
11791
11670
|
context[:gem_name] = 'aws-sdk-s3'
|
11792
|
-
context[:gem_version] = '1.
|
11671
|
+
context[:gem_version] = '1.68.1'
|
11793
11672
|
Seahorse::Client::Request.new(handlers, context)
|
11794
11673
|
end
|
11795
11674
|
|