aws-sdk-s3 1.89.0 → 1.90.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +724 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- 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/client.rb +547 -553
- data/lib/aws-sdk-s3/object.rb +6 -6
- data/lib/aws-sdk-s3/object_summary.rb +6 -6
- data/lib/aws-sdk-s3/types.rb +206 -203
- metadata +6 -3
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.90.0
|
data/lib/aws-sdk-s3.rb
CHANGED
data/lib/aws-sdk-s3/bucket.rb
CHANGED
@@ -456,7 +456,7 @@ module Aws::S3
|
|
456
456
|
#
|
457
457
|
# This action is not supported by Amazon S3 on Outposts.
|
458
458
|
# @option options [required, String] :key
|
459
|
-
# Object key for which the PUT
|
459
|
+
# Object key for which the PUT action was initiated.
|
460
460
|
# @option options [Hash<String,String>] :metadata
|
461
461
|
# A map of metadata to store with the object in S3.
|
462
462
|
# @option options [String] :server_side_encryption
|
@@ -533,8 +533,8 @@ module Aws::S3
|
|
533
533
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
534
534
|
# for object encryption with SSE-KMS.
|
535
535
|
#
|
536
|
-
# Specifying this header with a PUT
|
537
|
-
#
|
536
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
537
|
+
# settings for S3 Bucket Key.
|
538
538
|
# @option options [String] :request_payer
|
539
539
|
# Confirms that the requester knows that they will be charged for the
|
540
540
|
# request. Bucket owners need not specify this parameter in their
|
@@ -213,7 +213,7 @@ module Aws::S3
|
|
213
213
|
# @option options [required, Types::CORSConfiguration] :cors_configuration
|
214
214
|
# Describes the cross-origin access configuration for objects in an
|
215
215
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
216
|
-
# Resource Sharing][1] in the *Amazon Simple Storage Service
|
216
|
+
# Resource Sharing][1] in the *Amazon Simple Storage Service User
|
217
217
|
# Guide*.
|
218
218
|
#
|
219
219
|
#
|
data/lib/aws-sdk-s3/client.rb
CHANGED
@@ -408,7 +408,7 @@ module Aws::S3
|
|
408
408
|
|
409
409
|
# @!group API Operations
|
410
410
|
|
411
|
-
# This
|
411
|
+
# This action aborts a multipart upload. After a multipart upload is
|
412
412
|
# aborted, no additional parts can be uploaded using that upload ID. The
|
413
413
|
# storage consumed by any previously uploaded parts will be freed.
|
414
414
|
# However, if any part uploads are currently in progress, those part
|
@@ -417,11 +417,11 @@ module Aws::S3
|
|
417
417
|
# completely free all storage consumed by all parts.
|
418
418
|
#
|
419
419
|
# To verify that all parts have been removed, so you don't get charged
|
420
|
-
# for the part storage, you should call the [ListParts][1]
|
420
|
+
# for the part storage, you should call the [ListParts][1] action and
|
421
421
|
# ensure that the parts list is empty.
|
422
422
|
#
|
423
|
-
# For information about permissions required to use the multipart
|
424
|
-
#
|
423
|
+
# For information about permissions required to use the multipart
|
424
|
+
# upload, see [Multipart Upload and Permissions][2].
|
425
425
|
#
|
426
426
|
# The following operations are related to `AbortMultipartUpload`\:
|
427
427
|
#
|
@@ -447,22 +447,22 @@ module Aws::S3
|
|
447
447
|
# @option params [required, String] :bucket
|
448
448
|
# The bucket name to which the upload was taking place.
|
449
449
|
#
|
450
|
-
# When using this
|
451
|
-
# the access point hostname. The access point hostname takes the form
|
450
|
+
# When using this action with an access point, you must direct requests
|
451
|
+
# to the access point hostname. The access point hostname takes the form
|
452
452
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
453
|
-
# When using this
|
454
|
-
#
|
453
|
+
# When using this action with an access point through the AWS SDKs, you
|
454
|
+
# provide the access point ARN in place of the bucket name. For more
|
455
455
|
# information about access point ARNs, see [Using Access Points][1] in
|
456
456
|
# the *Amazon Simple Storage Service Developer Guide*.
|
457
457
|
#
|
458
|
-
# When using this
|
458
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
459
459
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
460
460
|
# takes the form
|
461
461
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
462
|
-
# When using this
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
462
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
463
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
464
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
465
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
466
466
|
#
|
467
467
|
#
|
468
468
|
#
|
@@ -537,11 +537,11 @@ module Aws::S3
|
|
537
537
|
#
|
538
538
|
# You first initiate the multipart upload and then upload all parts
|
539
539
|
# using the [UploadPart][1] operation. After successfully uploading all
|
540
|
-
# relevant parts of an upload, you call this
|
540
|
+
# relevant parts of an upload, you call this action to complete the
|
541
541
|
# upload. Upon receiving this request, Amazon S3 concatenates all the
|
542
542
|
# parts in ascending order by part number to create a new object. In the
|
543
543
|
# Complete Multipart Upload request, you must provide the parts list.
|
544
|
-
# You must ensure that the parts list is complete. This
|
544
|
+
# You must ensure that the parts list is complete. This action
|
545
545
|
# concatenates the parts that you provide in the list. For each part in
|
546
546
|
# the list, you must provide the part number and the `ETag` value,
|
547
547
|
# returned after that part was uploaded.
|
@@ -563,7 +563,7 @@ module Aws::S3
|
|
563
563
|
# Using Multipart Upload][3].
|
564
564
|
#
|
565
565
|
# For information about permissions required to use the multipart upload
|
566
|
-
# API, see [Multipart Upload
|
566
|
+
# API, see [Multipart Upload and Permissions][4].
|
567
567
|
#
|
568
568
|
# `CompleteMultipartUpload` has the following special errors:
|
569
569
|
#
|
@@ -737,8 +737,8 @@ module Aws::S3
|
|
737
737
|
#
|
738
738
|
# <note markdown="1"> You can store individual objects of up to 5 TB in Amazon S3. You
|
739
739
|
# create a copy of your object up to 5 GB in size in a single atomic
|
740
|
-
#
|
741
|
-
#
|
740
|
+
# action using this API. However, to copy an object greater than 5 GB,
|
741
|
+
# you must use the multipart upload Upload Part - Copy API. For more
|
742
742
|
# information, see [Copy Object Using the REST Multipart Upload API][1].
|
743
743
|
#
|
744
744
|
# </note>
|
@@ -752,12 +752,11 @@ module Aws::S3
|
|
752
752
|
#
|
753
753
|
# A copy request might return an error when Amazon S3 receives the copy
|
754
754
|
# request or while Amazon S3 is copying the files. If the error occurs
|
755
|
-
# before the copy
|
756
|
-
#
|
757
|
-
#
|
758
|
-
#
|
759
|
-
#
|
760
|
-
# appropriately.
|
755
|
+
# before the copy action starts, you receive a standard Amazon S3 error.
|
756
|
+
# If the error occurs during the copy operation, the error response is
|
757
|
+
# embedded in the `200 OK` response. This means that a `200 OK` response
|
758
|
+
# can contain either a success or an error. Design your application to
|
759
|
+
# parse the contents of the response and handle it appropriately.
|
761
760
|
#
|
762
761
|
# If the copy is successful, you receive a response with information
|
763
762
|
# about the copied object.
|
@@ -845,7 +844,7 @@ module Aws::S3
|
|
845
844
|
#
|
846
845
|
# If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
|
847
846
|
# the object. For more information, see [Amazon S3 Bucket Keys][9] in
|
848
|
-
# the *Amazon Simple Storage Service
|
847
|
+
# the *Amazon Simple Storage Service User Guide*.
|
849
848
|
#
|
850
849
|
# **Access Control List (ACL)-Specific Request Headers**
|
851
850
|
#
|
@@ -859,8 +858,8 @@ module Aws::S3
|
|
859
858
|
#
|
860
859
|
# **Storage Class Options**
|
861
860
|
#
|
862
|
-
# You can use the `CopyObject`
|
863
|
-
#
|
861
|
+
# You can use the `CopyObject` action to change the storage class of an
|
862
|
+
# object that is already stored in Amazon S3 using the `StorageClass`
|
864
863
|
# parameter. For more information, see [Storage Classes][12] in the
|
865
864
|
# *Amazon S3 Service Developer Guide*.
|
866
865
|
#
|
@@ -896,7 +895,7 @@ module Aws::S3
|
|
896
895
|
#
|
897
896
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html
|
898
897
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html
|
899
|
-
# [3]:
|
898
|
+
# [3]: http://aws.amazon.com/s3/pricing/
|
900
899
|
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html
|
901
900
|
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html
|
902
901
|
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html
|
@@ -919,22 +918,22 @@ module Aws::S3
|
|
919
918
|
# @option params [required, String] :bucket
|
920
919
|
# The name of the destination bucket.
|
921
920
|
#
|
922
|
-
# When using this
|
923
|
-
# the access point hostname. The access point hostname takes the form
|
921
|
+
# When using this action with an access point, you must direct requests
|
922
|
+
# to the access point hostname. The access point hostname takes the form
|
924
923
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
925
|
-
# When using this
|
926
|
-
#
|
924
|
+
# When using this action with an access point through the AWS SDKs, you
|
925
|
+
# provide the access point ARN in place of the bucket name. For more
|
927
926
|
# information about access point ARNs, see [Using Access Points][1] in
|
928
927
|
# the *Amazon Simple Storage Service Developer Guide*.
|
929
928
|
#
|
930
|
-
# When using this
|
929
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
931
930
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
932
931
|
# takes the form
|
933
932
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
934
|
-
# When using this
|
935
|
-
#
|
936
|
-
#
|
937
|
-
#
|
933
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
934
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
935
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
936
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
938
937
|
#
|
939
938
|
#
|
940
939
|
#
|
@@ -1116,8 +1115,8 @@ module Aws::S3
|
|
1116
1115
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
1117
1116
|
# for object encryption with SSE-KMS.
|
1118
1117
|
#
|
1119
|
-
# Specifying this header with a COPY
|
1120
|
-
#
|
1118
|
+
# Specifying this header with a COPY action doesn’t affect bucket-level
|
1119
|
+
# settings for S3 Bucket Key.
|
1121
1120
|
#
|
1122
1121
|
# @option params [String] :copy_source_sse_customer_algorithm
|
1123
1122
|
# Specifies the algorithm to use when decrypting the source object (for
|
@@ -1476,7 +1475,7 @@ module Aws::S3
|
|
1476
1475
|
req.send_request(options)
|
1477
1476
|
end
|
1478
1477
|
|
1479
|
-
# This
|
1478
|
+
# This action initiates a multipart upload and returns an upload ID.
|
1480
1479
|
# This upload ID is used to associate all of the parts in the specific
|
1481
1480
|
# multipart upload. You specify this upload ID in each of your
|
1482
1481
|
# subsequent upload part requests (see [UploadPart][1]). You also
|
@@ -1489,12 +1488,12 @@ module Aws::S3
|
|
1489
1488
|
# If you have configured a lifecycle rule to abort incomplete multipart
|
1490
1489
|
# uploads, the upload must complete within the number of days specified
|
1491
1490
|
# in the bucket lifecycle configuration. Otherwise, the incomplete
|
1492
|
-
# multipart upload becomes eligible for an abort
|
1491
|
+
# multipart upload becomes eligible for an abort action and Amazon S3
|
1493
1492
|
# aborts the multipart upload. For more information, see [Aborting
|
1494
1493
|
# Incomplete Multipart Uploads Using a Bucket Lifecycle Policy][3].
|
1495
1494
|
#
|
1496
1495
|
# For information about the permissions required to use the multipart
|
1497
|
-
# upload API, see [Multipart Upload
|
1496
|
+
# upload API, see [Multipart Upload and Permissions][4].
|
1498
1497
|
#
|
1499
1498
|
# For request signing, multipart upload is just a series of regular
|
1500
1499
|
# requests. You initiate a multipart upload, send one or more requests
|
@@ -1517,9 +1516,9 @@ module Aws::S3
|
|
1517
1516
|
# your own encryption key, or use AWS Key Management Service (AWS KMS)
|
1518
1517
|
# customer master keys (CMKs) or Amazon S3-managed encryption keys. If
|
1519
1518
|
# you choose to provide your own encryption key, the request headers you
|
1520
|
-
# provide in [UploadPart]
|
1521
|
-
#
|
1522
|
-
#
|
1519
|
+
# provide in [UploadPart][1] and [UploadPartCopy][6] requests must match
|
1520
|
+
# the headers you used in the request to initiate the upload by using
|
1521
|
+
# `CreateMultipartUpload`.
|
1523
1522
|
#
|
1524
1523
|
# To perform a multipart upload with encryption using an AWS KMS CMK,
|
1525
1524
|
# the requester must have permission to the `kms:Encrypt`,
|
@@ -1717,22 +1716,22 @@ module Aws::S3
|
|
1717
1716
|
# @option params [required, String] :bucket
|
1718
1717
|
# The name of the bucket to which to initiate the upload
|
1719
1718
|
#
|
1720
|
-
# When using this
|
1721
|
-
# the access point hostname. The access point hostname takes the form
|
1719
|
+
# When using this action with an access point, you must direct requests
|
1720
|
+
# to the access point hostname. The access point hostname takes the form
|
1722
1721
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
1723
|
-
# When using this
|
1724
|
-
#
|
1722
|
+
# When using this action with an access point through the AWS SDKs, you
|
1723
|
+
# provide the access point ARN in place of the bucket name. For more
|
1725
1724
|
# information about access point ARNs, see [Using Access Points][1] in
|
1726
1725
|
# the *Amazon Simple Storage Service Developer Guide*.
|
1727
1726
|
#
|
1728
|
-
# When using this
|
1727
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
1729
1728
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
1730
1729
|
# takes the form
|
1731
1730
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
1732
|
-
# When using this
|
1733
|
-
#
|
1734
|
-
#
|
1735
|
-
#
|
1731
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
1732
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
1733
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
1734
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
1736
1735
|
#
|
1737
1736
|
#
|
1738
1737
|
#
|
@@ -1833,7 +1832,7 @@ module Aws::S3
|
|
1833
1832
|
#
|
1834
1833
|
#
|
1835
1834
|
#
|
1836
|
-
# [1]: https://docs.aws.amazon.com/
|
1835
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
|
1837
1836
|
#
|
1838
1837
|
# @option params [String] :ssekms_encryption_context
|
1839
1838
|
# Specifies the AWS KMS Encryption Context to use for object encryption.
|
@@ -1846,7 +1845,7 @@ module Aws::S3
|
|
1846
1845
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
1847
1846
|
# for object encryption with SSE-KMS.
|
1848
1847
|
#
|
1849
|
-
# Specifying this header with an object
|
1848
|
+
# Specifying this header with an object action doesn’t affect
|
1850
1849
|
# bucket-level settings for S3 Bucket Key.
|
1851
1850
|
#
|
1852
1851
|
# @option params [String] :request_payer
|
@@ -2091,7 +2090,7 @@ module Aws::S3
|
|
2091
2090
|
# default and can grant this permission to others.
|
2092
2091
|
#
|
2093
2092
|
# For information about `cors`, see [Enabling Cross-Origin Resource
|
2094
|
-
# Sharing][1] in the *Amazon Simple Storage Service
|
2093
|
+
# Sharing][1] in the *Amazon Simple Storage Service User Guide*.
|
2095
2094
|
#
|
2096
2095
|
# **Related Resources:**
|
2097
2096
|
#
|
@@ -2140,10 +2139,10 @@ module Aws::S3
|
|
2140
2139
|
req.send_request(options)
|
2141
2140
|
end
|
2142
2141
|
|
2143
|
-
# This implementation of the DELETE
|
2142
|
+
# This implementation of the DELETE action removes default encryption
|
2144
2143
|
# from the bucket. For information about the Amazon S3 default
|
2145
2144
|
# encryption feature, see [Amazon S3 Default Bucket Encryption][1] in
|
2146
|
-
# the *Amazon Simple Storage Service
|
2145
|
+
# the *Amazon Simple Storage Service User Guide*.
|
2147
2146
|
#
|
2148
2147
|
# To use this operation, you must have permissions to perform the
|
2149
2148
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
@@ -2151,7 +2150,7 @@ module Aws::S3
|
|
2151
2150
|
# others. For more information about permissions, see [Permissions
|
2152
2151
|
# Related to Bucket Subresource Operations][2] and [Managing Access
|
2153
2152
|
# Permissions to your Amazon S3 Resources][3] in the *Amazon Simple
|
2154
|
-
# Storage Service
|
2153
|
+
# Storage Service User Guide*.
|
2155
2154
|
#
|
2156
2155
|
# **Related Resources**
|
2157
2156
|
#
|
@@ -2491,12 +2490,12 @@ module Aws::S3
|
|
2491
2490
|
req.send_request(options)
|
2492
2491
|
end
|
2493
2492
|
|
2494
|
-
# This implementation of the DELETE
|
2495
|
-
#
|
2496
|
-
#
|
2497
|
-
#
|
2498
|
-
#
|
2499
|
-
#
|
2493
|
+
# This implementation of the DELETE action uses the policy subresource
|
2494
|
+
# to delete the policy of a specified bucket. If you are using an
|
2495
|
+
# identity other than the root user of the AWS account that owns the
|
2496
|
+
# bucket, the calling identity must have the `DeleteBucketPolicy`
|
2497
|
+
# permissions on the specified bucket and belong to the bucket owner's
|
2498
|
+
# account to use this operation.
|
2500
2499
|
#
|
2501
2500
|
# If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns
|
2502
2501
|
# a `403 Access Denied` error. If you have the correct permissions, but
|
@@ -2508,19 +2507,19 @@ module Aws::S3
|
|
2508
2507
|
# denies the root user the ability to perform this action.
|
2509
2508
|
#
|
2510
2509
|
# For more information about bucket policies, see [Using Bucket Policies
|
2511
|
-
# and UserPolicies]
|
2512
|
-
# https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
|
2510
|
+
# and UserPolicies][1].
|
2513
2511
|
#
|
2514
2512
|
# The following operations are related to `DeleteBucketPolicy`
|
2515
2513
|
#
|
2516
|
-
# * [CreateBucket][
|
2514
|
+
# * [CreateBucket][2]
|
2517
2515
|
#
|
2518
|
-
# * [DeleteObject][
|
2516
|
+
# * [DeleteObject][3]
|
2519
2517
|
#
|
2520
2518
|
#
|
2521
2519
|
#
|
2522
|
-
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2523
|
-
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2520
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html
|
2521
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
2522
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
|
2524
2523
|
#
|
2525
2524
|
# @option params [required, String] :bucket
|
2526
2525
|
# The bucket name.
|
@@ -2571,22 +2570,22 @@ module Aws::S3
|
|
2571
2570
|
#
|
2572
2571
|
# </note>
|
2573
2572
|
#
|
2574
|
-
# For information about replication configuration, see [Replication]
|
2575
|
-
#
|
2576
|
-
# the *Amazon S3 Developer Guide*.
|
2573
|
+
# For information about replication configuration, see [Replication][3]
|
2574
|
+
# in the *Amazon S3 Developer Guide*.
|
2577
2575
|
#
|
2578
2576
|
# The following operations are related to `DeleteBucketReplication`\:
|
2579
2577
|
#
|
2580
|
-
# * [PutBucketReplication][
|
2578
|
+
# * [PutBucketReplication][4]
|
2581
2579
|
#
|
2582
|
-
# * [GetBucketReplication][
|
2580
|
+
# * [GetBucketReplication][5]
|
2583
2581
|
#
|
2584
2582
|
#
|
2585
2583
|
#
|
2586
2584
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
2587
2585
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
2588
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
2589
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
2586
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html
|
2587
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html
|
2588
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html
|
2590
2589
|
#
|
2591
2590
|
# @option params [required, String] :bucket
|
2592
2591
|
# The bucket name.
|
@@ -2675,18 +2674,18 @@ module Aws::S3
|
|
2675
2674
|
req.send_request(options)
|
2676
2675
|
end
|
2677
2676
|
|
2678
|
-
# This
|
2679
|
-
#
|
2677
|
+
# This action removes the website configuration for a bucket. Amazon S3
|
2678
|
+
# returns a `200 OK` response upon successfully deleting a website
|
2680
2679
|
# configuration on the specified bucket. You will get a `200 OK`
|
2681
2680
|
# response if the website configuration you are trying to delete does
|
2682
2681
|
# not exist on the bucket. Amazon S3 returns a `404` response if the
|
2683
2682
|
# bucket specified in the request does not exist.
|
2684
2683
|
#
|
2685
|
-
# This DELETE
|
2686
|
-
#
|
2687
|
-
#
|
2688
|
-
#
|
2689
|
-
#
|
2684
|
+
# This DELETE action requires the `S3:DeleteBucketWebsite` permission.
|
2685
|
+
# By default, only the bucket owner can delete the website configuration
|
2686
|
+
# attached to a bucket. However, bucket owners can grant other users
|
2687
|
+
# permission to delete the website configuration by writing a bucket
|
2688
|
+
# policy granting them the `S3:DeleteBucketWebsite` permission.
|
2690
2689
|
#
|
2691
2690
|
# For more information about hosting websites, see [Hosting Websites on
|
2692
2691
|
# Amazon S3][1].
|
@@ -2757,14 +2756,14 @@ module Aws::S3
|
|
2757
2756
|
# For more information about MFA Delete, see [Using MFA Delete][1]. To
|
2758
2757
|
# see sample requests that use versioning, see [Sample Request][2].
|
2759
2758
|
#
|
2760
|
-
# You can delete objects by explicitly calling
|
2759
|
+
# You can delete objects by explicitly calling DELETE Object or
|
2761
2760
|
# configure its lifecycle ([PutBucketLifecycle][3]) to enable Amazon S3
|
2762
2761
|
# to remove them for you. If you want to block users or accounts from
|
2763
2762
|
# removing or deleting objects from your bucket, you must deny them the
|
2764
2763
|
# `s3:DeleteObject`, `s3:DeleteObjectVersion`, and
|
2765
2764
|
# `s3:PutLifeCycleConfiguration` actions.
|
2766
2765
|
#
|
2767
|
-
# The following
|
2766
|
+
# The following action is related to `DeleteObject`\:
|
2768
2767
|
#
|
2769
2768
|
# * [PutObject][4]
|
2770
2769
|
#
|
@@ -2780,22 +2779,22 @@ module Aws::S3
|
|
2780
2779
|
# @option params [required, String] :bucket
|
2781
2780
|
# The bucket name of the bucket containing the object.
|
2782
2781
|
#
|
2783
|
-
# When using this
|
2784
|
-
# the access point hostname. The access point hostname takes the form
|
2782
|
+
# When using this action with an access point, you must direct requests
|
2783
|
+
# to the access point hostname. The access point hostname takes the form
|
2785
2784
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2786
|
-
# When using this
|
2787
|
-
#
|
2785
|
+
# When using this action with an access point through the AWS SDKs, you
|
2786
|
+
# provide the access point ARN in place of the bucket name. For more
|
2788
2787
|
# information about access point ARNs, see [Using Access Points][1] in
|
2789
2788
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2790
2789
|
#
|
2791
|
-
# When using this
|
2790
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2792
2791
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2793
2792
|
# takes the form
|
2794
2793
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2795
|
-
# When using this
|
2796
|
-
#
|
2797
|
-
#
|
2798
|
-
#
|
2794
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2795
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2796
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2797
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
2799
2798
|
#
|
2800
2799
|
#
|
2801
2800
|
#
|
@@ -2841,6 +2840,15 @@ module Aws::S3
|
|
2841
2840
|
# * {Types::DeleteObjectOutput#request_charged #request_charged} => String
|
2842
2841
|
#
|
2843
2842
|
#
|
2843
|
+
# @example Example: To delete an object (from a non-versioned bucket)
|
2844
|
+
#
|
2845
|
+
# # The following example deletes an object from a non-versioned bucket.
|
2846
|
+
#
|
2847
|
+
# resp = client.delete_object({
|
2848
|
+
# bucket: "ExampleBucket",
|
2849
|
+
# key: "HappyFace.jpg",
|
2850
|
+
# })
|
2851
|
+
#
|
2844
2852
|
# @example Example: To delete an object
|
2845
2853
|
#
|
2846
2854
|
# # The following example deletes an object from an S3 bucket.
|
@@ -2854,15 +2862,6 @@ module Aws::S3
|
|
2854
2862
|
# {
|
2855
2863
|
# }
|
2856
2864
|
#
|
2857
|
-
# @example Example: To delete an object (from a non-versioned bucket)
|
2858
|
-
#
|
2859
|
-
# # The following example deletes an object from a non-versioned bucket.
|
2860
|
-
#
|
2861
|
-
# resp = client.delete_object({
|
2862
|
-
# bucket: "ExampleBucket",
|
2863
|
-
# key: "HappyFace.jpg",
|
2864
|
-
# })
|
2865
|
-
#
|
2866
2865
|
# @example Request syntax with placeholder values
|
2867
2866
|
#
|
2868
2867
|
# resp = client.delete_object({
|
@@ -2916,22 +2915,22 @@ module Aws::S3
|
|
2916
2915
|
# @option params [required, String] :bucket
|
2917
2916
|
# The bucket name containing the objects from which to remove the tags.
|
2918
2917
|
#
|
2919
|
-
# When using this
|
2920
|
-
# the access point hostname. The access point hostname takes the form
|
2918
|
+
# When using this action with an access point, you must direct requests
|
2919
|
+
# to the access point hostname. The access point hostname takes the form
|
2921
2920
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
2922
|
-
# When using this
|
2923
|
-
#
|
2921
|
+
# When using this action with an access point through the AWS SDKs, you
|
2922
|
+
# provide the access point ARN in place of the bucket name. For more
|
2924
2923
|
# information about access point ARNs, see [Using Access Points][1] in
|
2925
2924
|
# the *Amazon Simple Storage Service Developer Guide*.
|
2926
2925
|
#
|
2927
|
-
# When using this
|
2926
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
2928
2927
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
2929
2928
|
# takes the form
|
2930
2929
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
2931
|
-
# When using this
|
2932
|
-
#
|
2933
|
-
#
|
2934
|
-
#
|
2930
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
2931
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
2932
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
2933
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
2935
2934
|
#
|
2936
2935
|
#
|
2937
2936
|
#
|
@@ -3008,27 +3007,27 @@ module Aws::S3
|
|
3008
3007
|
req.send_request(options)
|
3009
3008
|
end
|
3010
3009
|
|
3011
|
-
# This
|
3012
|
-
#
|
3013
|
-
#
|
3014
|
-
#
|
3010
|
+
# This action enables you to delete multiple objects from a bucket using
|
3011
|
+
# a single HTTP request. If you know the object keys that you want to
|
3012
|
+
# delete, then this action provides a suitable alternative to sending
|
3013
|
+
# individual delete requests, reducing per-request overhead.
|
3015
3014
|
#
|
3016
3015
|
# The request contains a list of up to 1000 keys that you want to
|
3017
3016
|
# delete. In the XML, you provide the object key names, and optionally,
|
3018
3017
|
# version IDs if you want to delete a specific version of the object
|
3019
3018
|
# from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
3020
|
-
# delete
|
3019
|
+
# delete action and returns the result of that delete, success, or
|
3021
3020
|
# failure, in the response. Note that if the object specified in the
|
3022
3021
|
# request is not found, Amazon S3 returns the result as deleted.
|
3023
3022
|
#
|
3024
|
-
# The
|
3025
|
-
#
|
3026
|
-
#
|
3027
|
-
#
|
3028
|
-
#
|
3029
|
-
#
|
3023
|
+
# The action supports two modes for the response: verbose and quiet. By
|
3024
|
+
# default, the action uses verbose mode in which the response includes
|
3025
|
+
# the result of deletion of each key in your request. In quiet mode the
|
3026
|
+
# response includes only keys where the delete action encountered an
|
3027
|
+
# error. For a successful deletion, the action does not return any
|
3028
|
+
# information about the delete in the response body.
|
3030
3029
|
#
|
3031
|
-
# When performing this
|
3030
|
+
# When performing this action on an MFA Delete enabled bucket, that
|
3032
3031
|
# attempts to delete any versioned objects, you must include an MFA
|
3033
3032
|
# token. If you do not provide one, the entire request will fail, even
|
3034
3033
|
# if there are non-versioned objects you are trying to delete. If you
|
@@ -3064,22 +3063,22 @@ module Aws::S3
|
|
3064
3063
|
# @option params [required, String] :bucket
|
3065
3064
|
# The bucket name containing the objects to delete.
|
3066
3065
|
#
|
3067
|
-
# When using this
|
3068
|
-
# the access point hostname. The access point hostname takes the form
|
3066
|
+
# When using this action with an access point, you must direct requests
|
3067
|
+
# to the access point hostname. The access point hostname takes the form
|
3069
3068
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
3070
|
-
# When using this
|
3071
|
-
#
|
3069
|
+
# When using this action with an access point through the AWS SDKs, you
|
3070
|
+
# provide the access point ARN in place of the bucket name. For more
|
3072
3071
|
# information about access point ARNs, see [Using Access Points][1] in
|
3073
3072
|
# the *Amazon Simple Storage Service Developer Guide*.
|
3074
3073
|
#
|
3075
|
-
# When using this
|
3074
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
3076
3075
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
3077
3076
|
# takes the form
|
3078
3077
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
3079
|
-
# When using this
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3078
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
3079
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
3080
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
3081
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
3083
3082
|
#
|
3084
3083
|
#
|
3085
3084
|
#
|
@@ -3123,20 +3122,22 @@ module Aws::S3
|
|
3123
3122
|
# * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error>
|
3124
3123
|
#
|
3125
3124
|
#
|
3126
|
-
# @example Example: To delete multiple
|
3125
|
+
# @example Example: To delete multiple object versions from a versioned bucket
|
3127
3126
|
#
|
3128
|
-
# # The following example deletes objects from a bucket. The
|
3129
|
-
# #
|
3127
|
+
# # The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object
|
3128
|
+
# # versions and returns the key and versions of deleted objects in the response.
|
3130
3129
|
#
|
3131
3130
|
# resp = client.delete_objects({
|
3132
3131
|
# bucket: "examplebucket",
|
3133
3132
|
# delete: {
|
3134
3133
|
# objects: [
|
3135
3134
|
# {
|
3136
|
-
# key: "
|
3135
|
+
# key: "HappyFace.jpg",
|
3136
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3137
3137
|
# },
|
3138
3138
|
# {
|
3139
|
-
# key: "
|
3139
|
+
# key: "HappyFace.jpg",
|
3140
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3140
3141
|
# },
|
3141
3142
|
# ],
|
3142
3143
|
# quiet: false,
|
@@ -3147,34 +3148,30 @@ module Aws::S3
|
|
3147
3148
|
# {
|
3148
3149
|
# deleted: [
|
3149
3150
|
# {
|
3150
|
-
#
|
3151
|
-
#
|
3152
|
-
# key: "objectkey1",
|
3151
|
+
# key: "HappyFace.jpg",
|
3152
|
+
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3153
3153
|
# },
|
3154
3154
|
# {
|
3155
|
-
#
|
3156
|
-
#
|
3157
|
-
# key: "objectkey2",
|
3155
|
+
# key: "HappyFace.jpg",
|
3156
|
+
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3158
3157
|
# },
|
3159
3158
|
# ],
|
3160
3159
|
# }
|
3161
3160
|
#
|
3162
|
-
# @example Example: To delete multiple
|
3161
|
+
# @example Example: To delete multiple objects from a versioned bucket
|
3163
3162
|
#
|
3164
|
-
# # The following example deletes objects from a bucket. The
|
3165
|
-
# #
|
3163
|
+
# # The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the
|
3164
|
+
# # object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
3166
3165
|
#
|
3167
3166
|
# resp = client.delete_objects({
|
3168
3167
|
# bucket: "examplebucket",
|
3169
3168
|
# delete: {
|
3170
3169
|
# objects: [
|
3171
3170
|
# {
|
3172
|
-
# key: "
|
3173
|
-
# version_id: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b",
|
3171
|
+
# key: "objectkey1",
|
3174
3172
|
# },
|
3175
3173
|
# {
|
3176
|
-
# key: "
|
3177
|
-
# version_id: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd",
|
3174
|
+
# key: "objectkey2",
|
3178
3175
|
# },
|
3179
3176
|
# ],
|
3180
3177
|
# quiet: false,
|
@@ -3185,12 +3182,14 @@ module Aws::S3
|
|
3185
3182
|
# {
|
3186
3183
|
# deleted: [
|
3187
3184
|
# {
|
3188
|
-
#
|
3189
|
-
#
|
3185
|
+
# delete_marker: true,
|
3186
|
+
# delete_marker_version_id: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
3187
|
+
# key: "objectkey1",
|
3190
3188
|
# },
|
3191
3189
|
# {
|
3192
|
-
#
|
3193
|
-
#
|
3190
|
+
# delete_marker: true,
|
3191
|
+
# delete_marker_version_id: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
3192
|
+
# key: "objectkey2",
|
3194
3193
|
# },
|
3195
3194
|
# ],
|
3196
3195
|
# }
|
@@ -3290,7 +3289,7 @@ module Aws::S3
|
|
3290
3289
|
req.send_request(options)
|
3291
3290
|
end
|
3292
3291
|
|
3293
|
-
# This implementation of the GET
|
3292
|
+
# This implementation of the GET action uses the `accelerate`
|
3294
3293
|
# subresource to return the Transfer Acceleration state of a bucket,
|
3295
3294
|
# which is either `Enabled` or `Suspended`. Amazon S3 Transfer
|
3296
3295
|
# Acceleration is a bucket-level feature that enables you to perform
|
@@ -3302,7 +3301,7 @@ module Aws::S3
|
|
3302
3301
|
# others. For more information about permissions, see [Permissions
|
3303
3302
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3304
3303
|
# Permissions to your Amazon S3 Resources][2] in the *Amazon Simple
|
3305
|
-
# Storage Service
|
3304
|
+
# Storage Service User Guide*.
|
3306
3305
|
#
|
3307
3306
|
# You set the Transfer Acceleration state of an existing bucket to
|
3308
3307
|
# `Enabled` or `Suspended` by using the
|
@@ -3313,7 +3312,7 @@ module Aws::S3
|
|
3313
3312
|
# Acceleration state if a state has never been set on the bucket.
|
3314
3313
|
#
|
3315
3314
|
# For more information about transfer acceleration, see [Transfer
|
3316
|
-
# Acceleration][4] in the Amazon Simple Storage Service
|
3315
|
+
# Acceleration][4] in the Amazon Simple Storage Service User Guide.
|
3317
3316
|
#
|
3318
3317
|
# **Related Resources**
|
3319
3318
|
#
|
@@ -3361,8 +3360,8 @@ module Aws::S3
|
|
3361
3360
|
req.send_request(options)
|
3362
3361
|
end
|
3363
3362
|
|
3364
|
-
# This implementation of the `GET`
|
3365
|
-
#
|
3363
|
+
# This implementation of the `GET` action uses the `acl` subresource to
|
3364
|
+
# return the access control list (ACL) of a bucket. To use `GET` to
|
3366
3365
|
# return the ACL of the bucket, you must have `READ_ACP` access to the
|
3367
3366
|
# bucket. If `READ_ACP` permission is granted to the anonymous user, you
|
3368
3367
|
# can return the ACL of the bucket without using an authorization
|
@@ -3419,7 +3418,7 @@ module Aws::S3
|
|
3419
3418
|
req.send_request(options)
|
3420
3419
|
end
|
3421
3420
|
|
3422
|
-
# This implementation of the GET
|
3421
|
+
# This implementation of the GET action returns an analytics
|
3423
3422
|
# configuration (identified by the analytics configuration ID) from the
|
3424
3423
|
# bucket.
|
3425
3424
|
#
|
@@ -3429,11 +3428,11 @@ module Aws::S3
|
|
3429
3428
|
# others. For more information about permissions, see [ Permissions
|
3430
3429
|
# Related to Bucket Subresource Operations][1] and [Managing Access
|
3431
3430
|
# Permissions to Your Amazon S3 Resources][2] in the *Amazon Simple
|
3432
|
-
# Storage Service
|
3431
|
+
# Storage Service User Guide*.
|
3433
3432
|
#
|
3434
3433
|
# For information about Amazon S3 analytics feature, see [Amazon S3
|
3435
3434
|
# Analytics – Storage Class Analysis][3] in the *Amazon Simple Storage
|
3436
|
-
# Service
|
3435
|
+
# Service User Guide*.
|
3437
3436
|
#
|
3438
3437
|
# **Related Resources**
|
3439
3438
|
#
|
@@ -3931,7 +3930,7 @@ module Aws::S3
|
|
3931
3930
|
# API. The response describes the new filter element that you can use to
|
3932
3931
|
# specify a filter to select a subset of objects to which the rule
|
3933
3932
|
# applies. If you are using a previous version of the lifecycle
|
3934
|
-
# configuration, it still works. For the earlier
|
3933
|
+
# configuration, it still works. For the earlier action, see
|
3935
3934
|
# [GetBucketLifecycle][1].
|
3936
3935
|
#
|
3937
3936
|
# </note>
|
@@ -4367,8 +4366,8 @@ module Aws::S3
|
|
4367
4366
|
|
4368
4367
|
# Returns the notification configuration of a bucket.
|
4369
4368
|
#
|
4370
|
-
# If notifications are not enabled on the bucket, the
|
4371
|
-
#
|
4369
|
+
# If notifications are not enabled on the bucket, the action returns an
|
4370
|
+
# empty `NotificationConfiguration` element.
|
4372
4371
|
#
|
4373
4372
|
# By default, you must be the bucket owner to read the notification
|
4374
4373
|
# configuration of a bucket. However, the bucket owner can use a bucket
|
@@ -4380,7 +4379,7 @@ module Aws::S3
|
|
4380
4379
|
# Events][1]. For more information about bucket policies, see [Using
|
4381
4380
|
# Bucket Policies][2].
|
4382
4381
|
#
|
4383
|
-
# The following
|
4382
|
+
# The following action is related to `GetBucketNotification`\:
|
4384
4383
|
#
|
4385
4384
|
# * [PutBucketNotification][3]
|
4386
4385
|
#
|
@@ -4521,7 +4520,7 @@ module Aws::S3
|
|
4521
4520
|
# For more information about bucket policies, see [Using Bucket Policies
|
4522
4521
|
# and User Policies][1].
|
4523
4522
|
#
|
4524
|
-
# The following
|
4523
|
+
# The following action is related to `GetBucketPolicy`\:
|
4525
4524
|
#
|
4526
4525
|
# * [GetObject][2]
|
4527
4526
|
#
|
@@ -4648,9 +4647,9 @@ module Aws::S3
|
|
4648
4647
|
# </note>
|
4649
4648
|
#
|
4650
4649
|
# For information about replication configuration, see [Replication][1]
|
4651
|
-
# in the *Amazon Simple Storage Service
|
4650
|
+
# in the *Amazon Simple Storage Service User Guide*.
|
4652
4651
|
#
|
4653
|
-
# This
|
4652
|
+
# This action requires permissions for the
|
4654
4653
|
# `s3:GetReplicationConfiguration` action. For more information about
|
4655
4654
|
# permissions, see [Using Bucket Policies and User Policies][2].
|
4656
4655
|
#
|
@@ -4980,7 +4979,7 @@ module Aws::S3
|
|
4980
4979
|
# configuration. For more information about hosting websites, see
|
4981
4980
|
# [Hosting Websites on Amazon S3][1].
|
4982
4981
|
#
|
4983
|
-
# This GET
|
4982
|
+
# This GET action requires the `S3:GetBucketWebsite` permission. By
|
4984
4983
|
# default, only the bucket owner can read the bucket website
|
4985
4984
|
# configuration. However, bucket owners can allow other users to read
|
4986
4985
|
# the website configuration by writing a bucket policy granting them the
|
@@ -5092,9 +5091,9 @@ module Aws::S3
|
|
5092
5091
|
# Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive
|
5093
5092
|
# or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve
|
5094
5093
|
# the object you must first restore a copy using [RestoreObject][4].
|
5095
|
-
# Otherwise, this
|
5096
|
-
#
|
5097
|
-
#
|
5094
|
+
# Otherwise, this action returns an `InvalidObjectStateError` error. For
|
5095
|
+
# information about restoring archived objects, see [Restoring Archived
|
5096
|
+
# Objects][5].
|
5098
5097
|
#
|
5099
5098
|
# Encryption request headers, like `x-amz-server-side-encryption`,
|
5100
5099
|
# should not be sent for GET requests if your object uses server-side
|
@@ -5138,9 +5137,8 @@ module Aws::S3
|
|
5138
5137
|
#
|
5139
5138
|
# **Versioning**
|
5140
5139
|
#
|
5141
|
-
# By default, the GET
|
5142
|
-
#
|
5143
|
-
# subresource.
|
5140
|
+
# By default, the GET action returns the current version of an object.
|
5141
|
+
# To return a different version, use the `versionId` subresource.
|
5144
5142
|
#
|
5145
5143
|
# <note markdown="1"> If the current version of the object is a delete marker, Amazon S3
|
5146
5144
|
# behaves as if the object was deleted and includes
|
@@ -5225,22 +5223,22 @@ module Aws::S3
|
|
5225
5223
|
# @option params [required, String] :bucket
|
5226
5224
|
# The bucket name containing the object.
|
5227
5225
|
#
|
5228
|
-
# When using this
|
5229
|
-
# the access point hostname. The access point hostname takes the form
|
5226
|
+
# When using this action with an access point, you must direct requests
|
5227
|
+
# to the access point hostname. The access point hostname takes the form
|
5230
5228
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5231
|
-
# When using this
|
5232
|
-
#
|
5229
|
+
# When using this action with an access point through the AWS SDKs, you
|
5230
|
+
# provide the access point ARN in place of the bucket name. For more
|
5233
5231
|
# information about access point ARNs, see [Using Access Points][1] in
|
5234
5232
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5235
5233
|
#
|
5236
|
-
# When using this
|
5234
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5237
5235
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5238
5236
|
# takes the form
|
5239
5237
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5240
|
-
# When using this
|
5241
|
-
#
|
5242
|
-
#
|
5243
|
-
#
|
5238
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5239
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5240
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5241
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
5244
5242
|
#
|
5245
5243
|
#
|
5246
5244
|
#
|
@@ -5551,11 +5549,11 @@ module Aws::S3
|
|
5551
5549
|
# The bucket name that contains the object for which to get the ACL
|
5552
5550
|
# information.
|
5553
5551
|
#
|
5554
|
-
# When using this
|
5555
|
-
# the access point hostname. The access point hostname takes the form
|
5552
|
+
# When using this action with an access point, you must direct requests
|
5553
|
+
# to the access point hostname. The access point hostname takes the form
|
5556
5554
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5557
|
-
# When using this
|
5558
|
-
#
|
5555
|
+
# When using this action with an access point through the AWS SDKs, you
|
5556
|
+
# provide the access point ARN in place of the bucket name. For more
|
5559
5557
|
# information about access point ARNs, see [Using Access Points][1] in
|
5560
5558
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5561
5559
|
#
|
@@ -5688,11 +5686,11 @@ module Aws::S3
|
|
5688
5686
|
# The bucket name containing the object whose Legal Hold status you want
|
5689
5687
|
# to retrieve.
|
5690
5688
|
#
|
5691
|
-
# When using this
|
5692
|
-
# the access point hostname. The access point hostname takes the form
|
5689
|
+
# When using this action with an access point, you must direct requests
|
5690
|
+
# to the access point hostname. The access point hostname takes the form
|
5693
5691
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5694
|
-
# When using this
|
5695
|
-
#
|
5692
|
+
# When using this action with an access point through the AWS SDKs, you
|
5693
|
+
# provide the access point ARN in place of the bucket name. For more
|
5696
5694
|
# information about access point ARNs, see [Using Access Points][1] in
|
5697
5695
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5698
5696
|
#
|
@@ -5763,11 +5761,11 @@ module Aws::S3
|
|
5763
5761
|
# @option params [required, String] :bucket
|
5764
5762
|
# The bucket whose Object Lock configuration you want to retrieve.
|
5765
5763
|
#
|
5766
|
-
# When using this
|
5767
|
-
# the access point hostname. The access point hostname takes the form
|
5764
|
+
# When using this action with an access point, you must direct requests
|
5765
|
+
# to the access point hostname. The access point hostname takes the form
|
5768
5766
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5769
|
-
# When using this
|
5770
|
-
#
|
5767
|
+
# When using this action with an access point through the AWS SDKs, you
|
5768
|
+
# provide the access point ARN in place of the bucket name. For more
|
5771
5769
|
# information about access point ARNs, see [Using Access Points][1] in
|
5772
5770
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5773
5771
|
#
|
@@ -5820,11 +5818,11 @@ module Aws::S3
|
|
5820
5818
|
# The bucket name containing the object whose retention settings you
|
5821
5819
|
# want to retrieve.
|
5822
5820
|
#
|
5823
|
-
# When using this
|
5824
|
-
# the access point hostname. The access point hostname takes the form
|
5821
|
+
# When using this action with an access point, you must direct requests
|
5822
|
+
# to the access point hostname. The access point hostname takes the form
|
5825
5823
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5826
|
-
# When using this
|
5827
|
-
#
|
5824
|
+
# When using this action with an access point through the AWS SDKs, you
|
5825
|
+
# provide the access point ARN in place of the bucket name. For more
|
5828
5826
|
# information about access point ARNs, see [Using Access Points][1] in
|
5829
5827
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5830
5828
|
#
|
@@ -5888,7 +5886,7 @@ module Aws::S3
|
|
5888
5886
|
# tagging subresource associated with the object.
|
5889
5887
|
#
|
5890
5888
|
# To use this operation, you must have permission to perform the
|
5891
|
-
# `s3:GetObjectTagging` action. By default, the GET
|
5889
|
+
# `s3:GetObjectTagging` action. By default, the GET action returns
|
5892
5890
|
# information about current version of an object. For a versioned
|
5893
5891
|
# bucket, you can have multiple versions of an object in your bucket. To
|
5894
5892
|
# retrieve tags of any other version, use the versionId query parameter.
|
@@ -5900,7 +5898,7 @@ module Aws::S3
|
|
5900
5898
|
# For information about the Amazon S3 object tagging feature, see
|
5901
5899
|
# [Object Tagging][1].
|
5902
5900
|
#
|
5903
|
-
# The following
|
5901
|
+
# The following action is related to `GetObjectTagging`\:
|
5904
5902
|
#
|
5905
5903
|
# * [PutObjectTagging][2]
|
5906
5904
|
#
|
@@ -5916,22 +5914,22 @@ module Aws::S3
|
|
5916
5914
|
# The bucket name containing the object for which to get the tagging
|
5917
5915
|
# information.
|
5918
5916
|
#
|
5919
|
-
# When using this
|
5920
|
-
# the access point hostname. The access point hostname takes the form
|
5917
|
+
# When using this action with an access point, you must direct requests
|
5918
|
+
# to the access point hostname. The access point hostname takes the form
|
5921
5919
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
5922
|
-
# When using this
|
5923
|
-
#
|
5920
|
+
# When using this action with an access point through the AWS SDKs, you
|
5921
|
+
# provide the access point ARN in place of the bucket name. For more
|
5924
5922
|
# information about access point ARNs, see [Using Access Points][1] in
|
5925
5923
|
# the *Amazon Simple Storage Service Developer Guide*.
|
5926
5924
|
#
|
5927
|
-
# When using this
|
5925
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
5928
5926
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
5929
5927
|
# takes the form
|
5930
5928
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
5931
|
-
# When using this
|
5932
|
-
#
|
5933
|
-
#
|
5934
|
-
#
|
5929
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
5930
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
5931
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
5932
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
5935
5933
|
#
|
5936
5934
|
#
|
5937
5935
|
#
|
@@ -5966,49 +5964,49 @@ module Aws::S3
|
|
5966
5964
|
# * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag>
|
5967
5965
|
#
|
5968
5966
|
#
|
5969
|
-
# @example Example: To retrieve tag set of
|
5967
|
+
# @example Example: To retrieve tag set of an object
|
5970
5968
|
#
|
5971
|
-
# # The following example retrieves tag set of an object.
|
5969
|
+
# # The following example retrieves tag set of an object.
|
5972
5970
|
#
|
5973
5971
|
# resp = client.get_object_tagging({
|
5974
5972
|
# bucket: "examplebucket",
|
5975
|
-
# key: "
|
5976
|
-
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5973
|
+
# key: "HappyFace.jpg",
|
5977
5974
|
# })
|
5978
5975
|
#
|
5979
5976
|
# resp.to_h outputs the following:
|
5980
5977
|
# {
|
5981
5978
|
# tag_set: [
|
5982
5979
|
# {
|
5983
|
-
# key: "
|
5984
|
-
# value: "
|
5980
|
+
# key: "Key4",
|
5981
|
+
# value: "Value4",
|
5982
|
+
# },
|
5983
|
+
# {
|
5984
|
+
# key: "Key3",
|
5985
|
+
# value: "Value3",
|
5985
5986
|
# },
|
5986
5987
|
# ],
|
5987
|
-
# version_id: "
|
5988
|
+
# version_id: "null",
|
5988
5989
|
# }
|
5989
5990
|
#
|
5990
|
-
# @example Example: To retrieve tag set of
|
5991
|
+
# @example Example: To retrieve tag set of a specific object version
|
5991
5992
|
#
|
5992
|
-
# # The following example retrieves tag set of an object.
|
5993
|
+
# # The following example retrieves tag set of an object. The request specifies object version.
|
5993
5994
|
#
|
5994
5995
|
# resp = client.get_object_tagging({
|
5995
5996
|
# bucket: "examplebucket",
|
5996
|
-
# key: "
|
5997
|
+
# key: "exampleobject",
|
5998
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
5997
5999
|
# })
|
5998
6000
|
#
|
5999
6001
|
# resp.to_h outputs the following:
|
6000
6002
|
# {
|
6001
6003
|
# tag_set: [
|
6002
6004
|
# {
|
6003
|
-
# key: "
|
6004
|
-
# value: "
|
6005
|
-
# },
|
6006
|
-
# {
|
6007
|
-
# key: "Key3",
|
6008
|
-
# value: "Value3",
|
6005
|
+
# key: "Key1",
|
6006
|
+
# value: "Value1",
|
6009
6007
|
# },
|
6010
6008
|
# ],
|
6011
|
-
# version_id: "
|
6009
|
+
# version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI",
|
6012
6010
|
# }
|
6013
6011
|
#
|
6014
6012
|
# @example Request syntax with placeholder values
|
@@ -6051,7 +6049,7 @@ module Aws::S3
|
|
6051
6049
|
#
|
6052
6050
|
# This action is not supported by Amazon S3 on Outposts.
|
6053
6051
|
#
|
6054
|
-
# The following
|
6052
|
+
# The following action is related to `GetObjectTorrent`\:
|
6055
6053
|
#
|
6056
6054
|
# * [GetObject][2]
|
6057
6055
|
#
|
@@ -6201,9 +6199,9 @@ module Aws::S3
|
|
6201
6199
|
req.send_request(options)
|
6202
6200
|
end
|
6203
6201
|
|
6204
|
-
# This
|
6205
|
-
# permission to access it. The
|
6206
|
-
#
|
6202
|
+
# This action is useful to determine if a bucket exists and you have
|
6203
|
+
# permission to access it. The action returns a `200 OK` if the bucket
|
6204
|
+
# exists and you have permission to access it.
|
6207
6205
|
#
|
6208
6206
|
# If the bucket does not exist or you do not have permission to access
|
6209
6207
|
# it, the `HEAD` request returns a generic `404 Not Found` or `403
|
@@ -6225,22 +6223,22 @@ module Aws::S3
|
|
6225
6223
|
# @option params [required, String] :bucket
|
6226
6224
|
# The bucket name.
|
6227
6225
|
#
|
6228
|
-
# When using this
|
6229
|
-
# the access point hostname. The access point hostname takes the form
|
6226
|
+
# When using this action with an access point, you must direct requests
|
6227
|
+
# to the access point hostname. The access point hostname takes the form
|
6230
6228
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6231
|
-
# When using this
|
6232
|
-
#
|
6229
|
+
# When using this action with an access point through the AWS SDKs, you
|
6230
|
+
# provide the access point ARN in place of the bucket name. For more
|
6233
6231
|
# information about access point ARNs, see [Using Access Points][1] in
|
6234
6232
|
# the *Amazon Simple Storage Service Developer Guide*.
|
6235
6233
|
#
|
6236
|
-
# When using this
|
6234
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6237
6235
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6238
6236
|
# takes the form
|
6239
6237
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6240
|
-
# When using this
|
6241
|
-
#
|
6242
|
-
#
|
6243
|
-
#
|
6238
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6239
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6240
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6241
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
6244
6242
|
#
|
6245
6243
|
#
|
6246
6244
|
#
|
@@ -6285,17 +6283,17 @@ module Aws::S3
|
|
6285
6283
|
req.send_request(options)
|
6286
6284
|
end
|
6287
6285
|
|
6288
|
-
# The HEAD
|
6289
|
-
# the object itself. This
|
6290
|
-
#
|
6291
|
-
#
|
6292
|
-
#
|
6293
|
-
# A `HEAD` request has the same options as a `GET`
|
6294
|
-
#
|
6295
|
-
#
|
6296
|
-
#
|
6297
|
-
#
|
6298
|
-
#
|
6286
|
+
# The HEAD action retrieves metadata from an object without returning
|
6287
|
+
# the object itself. This action is useful if you're only interested in
|
6288
|
+
# an object's metadata. To use HEAD, you must have READ access to the
|
6289
|
+
# object.
|
6290
|
+
#
|
6291
|
+
# A `HEAD` request has the same options as a `GET` action on an object.
|
6292
|
+
# The response is identical to the `GET` response except that there is
|
6293
|
+
# no response body. Because of this, if the `HEAD` request generates an
|
6294
|
+
# error, it returns a generic `404 Not Found` or `403 Forbidden` code.
|
6295
|
+
# It is not possible to retrieve the exact exception beyond these error
|
6296
|
+
# codes.
|
6299
6297
|
#
|
6300
6298
|
# If you encrypt an object by using server-side encryption with
|
6301
6299
|
# customer-provided encryption keys (SSE-C) when you store the object in
|
@@ -6361,7 +6359,7 @@ module Aws::S3
|
|
6361
6359
|
# * If you don’t have the `s3:ListBucket` permission, Amazon S3 returns
|
6362
6360
|
# an HTTP status code 403 ("access denied") error.
|
6363
6361
|
#
|
6364
|
-
# The following
|
6362
|
+
# The following action is related to `HeadObject`\:
|
6365
6363
|
#
|
6366
6364
|
# * [GetObject][5]
|
6367
6365
|
#
|
@@ -6378,22 +6376,22 @@ module Aws::S3
|
|
6378
6376
|
# @option params [required, String] :bucket
|
6379
6377
|
# The name of the bucket containing the object.
|
6380
6378
|
#
|
6381
|
-
# When using this
|
6382
|
-
# the access point hostname. The access point hostname takes the form
|
6379
|
+
# When using this action with an access point, you must direct requests
|
6380
|
+
# to the access point hostname. The access point hostname takes the form
|
6383
6381
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
6384
|
-
# When using this
|
6385
|
-
#
|
6382
|
+
# When using this action with an access point through the AWS SDKs, you
|
6383
|
+
# provide the access point ARN in place of the bucket name. For more
|
6386
6384
|
# information about access point ARNs, see [Using Access Points][1] in
|
6387
6385
|
# the *Amazon Simple Storage Service Developer Guide*.
|
6388
6386
|
#
|
6389
|
-
# When using this
|
6387
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
6390
6388
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
6391
6389
|
# takes the form
|
6392
6390
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
6393
|
-
# When using this
|
6394
|
-
#
|
6395
|
-
#
|
6396
|
-
#
|
6391
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
6392
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
6393
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
6394
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
6397
6395
|
#
|
6398
6396
|
#
|
6399
6397
|
#
|
@@ -6602,15 +6600,14 @@ module Aws::S3
|
|
6602
6600
|
# Lists the analytics configurations for the bucket. You can have up to
|
6603
6601
|
# 1,000 analytics configurations per bucket.
|
6604
6602
|
#
|
6605
|
-
# This
|
6606
|
-
#
|
6607
|
-
#
|
6608
|
-
#
|
6609
|
-
#
|
6610
|
-
#
|
6611
|
-
#
|
6612
|
-
#
|
6613
|
-
# next page.
|
6603
|
+
# This action supports list pagination and does not return more than 100
|
6604
|
+
# configurations at a time. You should always check the `IsTruncated`
|
6605
|
+
# element in the response. If there are no more configurations to list,
|
6606
|
+
# `IsTruncated` is set to false. If there are more configurations to
|
6607
|
+
# list, `IsTruncated` is set to true, and there will be a value in
|
6608
|
+
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
6609
|
+
# continue the pagination of the list by passing the value in
|
6610
|
+
# continuation-token in the request to `GET` the next page.
|
6614
6611
|
#
|
6615
6612
|
# To use this operation, you must have permissions to perform the
|
6616
6613
|
# `s3:GetAnalyticsConfiguration` action. The bucket owner has this
|
@@ -6787,9 +6784,9 @@ module Aws::S3
|
|
6787
6784
|
# Returns a list of inventory configurations for the bucket. You can
|
6788
6785
|
# have up to 1,000 analytics configurations per bucket.
|
6789
6786
|
#
|
6790
|
-
# This
|
6791
|
-
#
|
6792
|
-
#
|
6787
|
+
# This action supports list pagination and does not return more than 100
|
6788
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6789
|
+
# the response. If there are no more configurations to list,
|
6793
6790
|
# `IsTruncated` is set to false. If there are more configurations to
|
6794
6791
|
# list, `IsTruncated` is set to true, and there is a value in
|
6795
6792
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -6887,9 +6884,9 @@ module Aws::S3
|
|
6887
6884
|
# not provide information on daily storage metrics. You can have up to
|
6888
6885
|
# 1,000 configurations per bucket.
|
6889
6886
|
#
|
6890
|
-
# This
|
6891
|
-
#
|
6892
|
-
#
|
6887
|
+
# This action supports list pagination and does not return more than 100
|
6888
|
+
# configurations at a time. Always check the `IsTruncated` element in
|
6889
|
+
# the response. If there are no more configurations to list,
|
6893
6890
|
# `IsTruncated` is set to false. If there are more configurations to
|
6894
6891
|
# list, `IsTruncated` is set to true, and there is a value in
|
6895
6892
|
# `NextContinuationToken`. You use the `NextContinuationToken` value to
|
@@ -7035,20 +7032,19 @@ module Aws::S3
|
|
7035
7032
|
req.send_request(options)
|
7036
7033
|
end
|
7037
7034
|
|
7038
|
-
# This
|
7035
|
+
# This action lists in-progress multipart uploads. An in-progress
|
7039
7036
|
# multipart upload is a multipart upload that has been initiated using
|
7040
7037
|
# the Initiate Multipart Upload request, but has not yet been completed
|
7041
7038
|
# or aborted.
|
7042
7039
|
#
|
7043
|
-
# This
|
7044
|
-
#
|
7045
|
-
#
|
7046
|
-
#
|
7047
|
-
#
|
7048
|
-
#
|
7049
|
-
#
|
7050
|
-
#
|
7051
|
-
# parameters.
|
7040
|
+
# This action returns at most 1,000 multipart uploads in the response.
|
7041
|
+
# 1,000 multipart uploads is the maximum number of uploads a response
|
7042
|
+
# can include, which is also the default value. You can further limit
|
7043
|
+
# the number of uploads in a response by specifying the `max-uploads`
|
7044
|
+
# parameter in the response. If additional multipart uploads satisfy the
|
7045
|
+
# list criteria, the response will contain an `IsTruncated` element with
|
7046
|
+
# the value true. To list the additional multipart uploads, use the
|
7047
|
+
# `key-marker` and `upload-id-marker` request parameters.
|
7052
7048
|
#
|
7053
7049
|
# In the response, the uploads are sorted by key. If your application
|
7054
7050
|
# has initiated more than one multipart upload using the same object
|
@@ -7060,7 +7056,7 @@ module Aws::S3
|
|
7060
7056
|
# Using Multipart Upload][1].
|
7061
7057
|
#
|
7062
7058
|
# For information on permissions required to use the multipart upload
|
7063
|
-
# API, see [Multipart Upload
|
7059
|
+
# API, see [Multipart Upload and Permissions][2].
|
7064
7060
|
#
|
7065
7061
|
# The following operations are related to `ListMultipartUploads`\:
|
7066
7062
|
#
|
@@ -7087,22 +7083,22 @@ module Aws::S3
|
|
7087
7083
|
# @option params [required, String] :bucket
|
7088
7084
|
# The name of the bucket to which the multipart upload was initiated.
|
7089
7085
|
#
|
7090
|
-
# When using this
|
7091
|
-
# the access point hostname. The access point hostname takes the form
|
7086
|
+
# When using this action with an access point, you must direct requests
|
7087
|
+
# to the access point hostname. The access point hostname takes the form
|
7092
7088
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7093
|
-
# When using this
|
7094
|
-
#
|
7089
|
+
# When using this action with an access point through the AWS SDKs, you
|
7090
|
+
# provide the access point ARN in place of the bucket name. For more
|
7095
7091
|
# information about access point ARNs, see [Using Access Points][1] in
|
7096
7092
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7097
7093
|
#
|
7098
|
-
# When using this
|
7094
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7099
7095
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7100
7096
|
# takes the form
|
7101
7097
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7102
|
-
# When using this
|
7103
|
-
#
|
7104
|
-
#
|
7105
|
-
#
|
7098
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7099
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7100
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7101
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7106
7102
|
#
|
7107
7103
|
#
|
7108
7104
|
#
|
@@ -7182,97 +7178,97 @@ module Aws::S3
|
|
7182
7178
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
7183
7179
|
#
|
7184
7180
|
#
|
7185
|
-
# @example Example:
|
7181
|
+
# @example Example: To list in-progress multipart uploads on a bucket
|
7186
7182
|
#
|
7187
|
-
# # The following example
|
7188
|
-
# # setup of multipart uploads.
|
7183
|
+
# # The following example lists in-progress multipart uploads on a specific bucket.
|
7189
7184
|
#
|
7190
7185
|
# resp = client.list_multipart_uploads({
|
7191
7186
|
# bucket: "examplebucket",
|
7192
|
-
# key_marker: "nextkeyfrompreviousresponse",
|
7193
|
-
# max_uploads: 2,
|
7194
|
-
# upload_id_marker: "valuefrompreviousresponse",
|
7195
7187
|
# })
|
7196
7188
|
#
|
7197
7189
|
# resp.to_h outputs the following:
|
7198
7190
|
# {
|
7199
|
-
# bucket: "acl1",
|
7200
|
-
# is_truncated: true,
|
7201
|
-
# key_marker: "",
|
7202
|
-
# max_uploads: 2,
|
7203
|
-
# next_key_marker: "someobjectkey",
|
7204
|
-
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7205
|
-
# upload_id_marker: "",
|
7206
7191
|
# uploads: [
|
7207
7192
|
# {
|
7208
7193
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7209
7194
|
# initiator: {
|
7210
|
-
# display_name: "
|
7195
|
+
# display_name: "display-name",
|
7211
7196
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7212
7197
|
# },
|
7213
7198
|
# key: "JavaFile",
|
7214
7199
|
# owner: {
|
7215
|
-
# display_name: "
|
7216
|
-
# id: "
|
7200
|
+
# display_name: "display-name",
|
7201
|
+
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7217
7202
|
# },
|
7218
7203
|
# storage_class: "STANDARD",
|
7219
|
-
# upload_id: "
|
7204
|
+
# upload_id: "examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7220
7205
|
# },
|
7221
7206
|
# {
|
7222
7207
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7223
7208
|
# initiator: {
|
7224
|
-
# display_name: "
|
7209
|
+
# display_name: "display-name",
|
7225
7210
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7226
7211
|
# },
|
7227
7212
|
# key: "JavaFile",
|
7228
7213
|
# owner: {
|
7229
|
-
# display_name: "
|
7214
|
+
# display_name: "display-name",
|
7230
7215
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7231
7216
|
# },
|
7232
7217
|
# storage_class: "STANDARD",
|
7233
|
-
# upload_id: "
|
7218
|
+
# upload_id: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7234
7219
|
# },
|
7235
7220
|
# ],
|
7236
7221
|
# }
|
7237
7222
|
#
|
7238
|
-
# @example Example:
|
7223
|
+
# @example Example: List next set of multipart uploads when previous result is truncated
|
7239
7224
|
#
|
7240
|
-
# # The following example
|
7225
|
+
# # The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next
|
7226
|
+
# # setup of multipart uploads.
|
7241
7227
|
#
|
7242
7228
|
# resp = client.list_multipart_uploads({
|
7243
7229
|
# bucket: "examplebucket",
|
7230
|
+
# key_marker: "nextkeyfrompreviousresponse",
|
7231
|
+
# max_uploads: 2,
|
7232
|
+
# upload_id_marker: "valuefrompreviousresponse",
|
7244
7233
|
# })
|
7245
7234
|
#
|
7246
7235
|
# resp.to_h outputs the following:
|
7247
7236
|
# {
|
7237
|
+
# bucket: "acl1",
|
7238
|
+
# is_truncated: true,
|
7239
|
+
# key_marker: "",
|
7240
|
+
# max_uploads: 2,
|
7241
|
+
# next_key_marker: "someobjectkey",
|
7242
|
+
# next_upload_id_marker: "examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7243
|
+
# upload_id_marker: "",
|
7248
7244
|
# uploads: [
|
7249
7245
|
# {
|
7250
7246
|
# initiated: Time.parse("2014-05-01T05:40:58.000Z"),
|
7251
7247
|
# initiator: {
|
7252
|
-
# display_name: "display-name",
|
7248
|
+
# display_name: "ownder-display-name",
|
7253
7249
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7254
7250
|
# },
|
7255
7251
|
# key: "JavaFile",
|
7256
7252
|
# owner: {
|
7257
|
-
# display_name: "
|
7258
|
-
# id: "
|
7253
|
+
# display_name: "mohanataws",
|
7254
|
+
# id: "852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7259
7255
|
# },
|
7260
7256
|
# storage_class: "STANDARD",
|
7261
|
-
# upload_id: "
|
7257
|
+
# upload_id: "gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--",
|
7262
7258
|
# },
|
7263
7259
|
# {
|
7264
7260
|
# initiated: Time.parse("2014-05-01T05:41:27.000Z"),
|
7265
7261
|
# initiator: {
|
7266
|
-
# display_name: "display-name",
|
7262
|
+
# display_name: "ownder-display-name",
|
7267
7263
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7268
7264
|
# },
|
7269
7265
|
# key: "JavaFile",
|
7270
7266
|
# owner: {
|
7271
|
-
# display_name: "display-name",
|
7267
|
+
# display_name: "ownder-display-name",
|
7272
7268
|
# id: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc",
|
7273
7269
|
# },
|
7274
7270
|
# storage_class: "STANDARD",
|
7275
|
-
# upload_id: "
|
7271
|
+
# upload_id: "b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--",
|
7276
7272
|
# },
|
7277
7273
|
# ],
|
7278
7274
|
# }
|
@@ -7378,7 +7374,7 @@ module Aws::S3
|
|
7378
7374
|
#
|
7379
7375
|
# @option params [Integer] :max_keys
|
7380
7376
|
# Sets the maximum number of keys returned in the response. By default
|
7381
|
-
# the
|
7377
|
+
# the action returns up to 1,000 key names. The response might contain
|
7382
7378
|
# fewer keys but will never contain more. If additional keys satisfy the
|
7383
7379
|
# search criteria, but were not returned because max-keys was exceeded,
|
7384
7380
|
# the response contains <isTruncated>true</isTruncated>. To
|
@@ -7522,7 +7518,7 @@ module Aws::S3
|
|
7522
7518
|
# invalid XML. Be sure to design your application to parse the contents
|
7523
7519
|
# of the response and handle it appropriately.
|
7524
7520
|
#
|
7525
|
-
# This
|
7521
|
+
# This action has been revised. We recommend that you use the newer
|
7526
7522
|
# version, [ListObjectsV2][1], when developing applications. For
|
7527
7523
|
# backward compatibility, Amazon S3 continues to support `ListObjects`.
|
7528
7524
|
#
|
@@ -7549,22 +7545,22 @@ module Aws::S3
|
|
7549
7545
|
# @option params [required, String] :bucket
|
7550
7546
|
# The name of the bucket containing the objects.
|
7551
7547
|
#
|
7552
|
-
# When using this
|
7553
|
-
# the access point hostname. The access point hostname takes the form
|
7548
|
+
# When using this action with an access point, you must direct requests
|
7549
|
+
# to the access point hostname. The access point hostname takes the form
|
7554
7550
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7555
|
-
# When using this
|
7556
|
-
#
|
7551
|
+
# When using this action with an access point through the AWS SDKs, you
|
7552
|
+
# provide the access point ARN in place of the bucket name. For more
|
7557
7553
|
# information about access point ARNs, see [Using Access Points][1] in
|
7558
7554
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7559
7555
|
#
|
7560
|
-
# When using this
|
7556
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7561
7557
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7562
7558
|
# takes the form
|
7563
7559
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7564
|
-
# When using this
|
7565
|
-
#
|
7566
|
-
#
|
7567
|
-
#
|
7560
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7561
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7562
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7563
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7568
7564
|
#
|
7569
7565
|
#
|
7570
7566
|
#
|
@@ -7587,7 +7583,7 @@ module Aws::S3
|
|
7587
7583
|
#
|
7588
7584
|
# @option params [Integer] :max_keys
|
7589
7585
|
# Sets the maximum number of keys returned in the response. By default
|
7590
|
-
# the
|
7586
|
+
# the action returns up to 1,000 key names. The response might contain
|
7591
7587
|
# fewer keys but will never contain more.
|
7592
7588
|
#
|
7593
7589
|
# @option params [String] :prefix
|
@@ -7710,16 +7706,16 @@ module Aws::S3
|
|
7710
7706
|
#
|
7711
7707
|
# To use this operation, you must have READ access to the bucket.
|
7712
7708
|
#
|
7713
|
-
# To use this
|
7709
|
+
# To use this action in an AWS Identity and Access Management (IAM)
|
7714
7710
|
# policy, you must have permissions to perform the `s3:ListBucket`
|
7715
7711
|
# action. The bucket owner has this permission by default and can grant
|
7716
7712
|
# this permission to others. For more information about permissions, see
|
7717
7713
|
# [Permissions Related to Bucket Subresource Operations][1] and
|
7718
7714
|
# [Managing Access Permissions to Your Amazon S3 Resources][2].
|
7719
7715
|
#
|
7720
|
-
# This section describes the latest revision of
|
7721
|
-
# that you use this revised API for application development.
|
7722
|
-
# backward compatibility, Amazon S3 continues to support the prior
|
7716
|
+
# This section describes the latest revision of this action. We
|
7717
|
+
# recommend that you use this revised API for application development.
|
7718
|
+
# For backward compatibility, Amazon S3 continues to support the prior
|
7723
7719
|
# version of this API, [ListObjects][3].
|
7724
7720
|
#
|
7725
7721
|
# To get a list of your buckets, see [ListBuckets][4].
|
@@ -7745,22 +7741,22 @@ module Aws::S3
|
|
7745
7741
|
# @option params [required, String] :bucket
|
7746
7742
|
# Bucket name to list.
|
7747
7743
|
#
|
7748
|
-
# When using this
|
7749
|
-
# the access point hostname. The access point hostname takes the form
|
7744
|
+
# When using this action with an access point, you must direct requests
|
7745
|
+
# to the access point hostname. The access point hostname takes the form
|
7750
7746
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7751
|
-
# When using this
|
7752
|
-
#
|
7747
|
+
# When using this action with an access point through the AWS SDKs, you
|
7748
|
+
# provide the access point ARN in place of the bucket name. For more
|
7753
7749
|
# information about access point ARNs, see [Using Access Points][1] in
|
7754
7750
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7755
7751
|
#
|
7756
|
-
# When using this
|
7752
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7757
7753
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7758
7754
|
# takes the form
|
7759
7755
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7760
|
-
# When using this
|
7761
|
-
#
|
7762
|
-
#
|
7763
|
-
#
|
7756
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7757
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7758
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7759
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7764
7760
|
#
|
7765
7761
|
#
|
7766
7762
|
#
|
@@ -7775,7 +7771,7 @@ module Aws::S3
|
|
7775
7771
|
#
|
7776
7772
|
# @option params [Integer] :max_keys
|
7777
7773
|
# Sets the maximum number of keys returned in the response. By default
|
7778
|
-
# the
|
7774
|
+
# the action returns up to 1,000 key names. The response might contain
|
7779
7775
|
# fewer keys but will never contain more.
|
7780
7776
|
#
|
7781
7777
|
# @option params [String] :prefix
|
@@ -7924,7 +7920,7 @@ module Aws::S3
|
|
7924
7920
|
# Using Multipart Upload][2].
|
7925
7921
|
#
|
7926
7922
|
# For information on permissions required to use the multipart upload
|
7927
|
-
# API, see [Multipart Upload
|
7923
|
+
# API, see [Multipart Upload and Permissions][3].
|
7928
7924
|
#
|
7929
7925
|
# The following operations are related to `ListParts`\:
|
7930
7926
|
#
|
@@ -7951,22 +7947,22 @@ module Aws::S3
|
|
7951
7947
|
# @option params [required, String] :bucket
|
7952
7948
|
# The name of the bucket to which the parts are being uploaded.
|
7953
7949
|
#
|
7954
|
-
# When using this
|
7955
|
-
# the access point hostname. The access point hostname takes the form
|
7950
|
+
# When using this action with an access point, you must direct requests
|
7951
|
+
# to the access point hostname. The access point hostname takes the form
|
7956
7952
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
7957
|
-
# When using this
|
7958
|
-
#
|
7953
|
+
# When using this action with an access point through the AWS SDKs, you
|
7954
|
+
# provide the access point ARN in place of the bucket name. For more
|
7959
7955
|
# information about access point ARNs, see [Using Access Points][1] in
|
7960
7956
|
# the *Amazon Simple Storage Service Developer Guide*.
|
7961
7957
|
#
|
7962
|
-
# When using this
|
7958
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
7963
7959
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
7964
7960
|
# takes the form
|
7965
7961
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
7966
|
-
# When using this
|
7967
|
-
#
|
7968
|
-
#
|
7969
|
-
#
|
7962
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
7963
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
7964
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
7965
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
7970
7966
|
#
|
7971
7967
|
#
|
7972
7968
|
#
|
@@ -8122,8 +8118,8 @@ module Aws::S3
|
|
8122
8118
|
#
|
8123
8119
|
# * Suspended – Disables accelerated data transfers to the bucket.
|
8124
8120
|
#
|
8125
|
-
# The [GetBucketAccelerateConfiguration][3]
|
8126
|
-
#
|
8121
|
+
# The [GetBucketAccelerateConfiguration][3] action returns the transfer
|
8122
|
+
# acceleration state of a bucket.
|
8127
8123
|
#
|
8128
8124
|
# After setting the Transfer Acceleration state of a bucket to Enabled,
|
8129
8125
|
# it might take up to thirty minutes before the data transfer rates to
|
@@ -8608,7 +8604,7 @@ module Aws::S3
|
|
8608
8604
|
# element.
|
8609
8605
|
#
|
8610
8606
|
# For more information about CORS, go to [Enabling Cross-Origin Resource
|
8611
|
-
# Sharing][1] in the *Amazon Simple Storage Service
|
8607
|
+
# Sharing][1] in the *Amazon Simple Storage Service User Guide*.
|
8612
8608
|
#
|
8613
8609
|
# **Related Resources**
|
8614
8610
|
#
|
@@ -8631,7 +8627,7 @@ module Aws::S3
|
|
8631
8627
|
# @option params [required, Types::CORSConfiguration] :cors_configuration
|
8632
8628
|
# Describes the cross-origin access configuration for objects in an
|
8633
8629
|
# Amazon S3 bucket. For more information, see [Enabling Cross-Origin
|
8634
|
-
# Resource Sharing][1] in the *Amazon Simple Storage Service
|
8630
|
+
# Resource Sharing][1] in the *Amazon Simple Storage Service User
|
8635
8631
|
# Guide*.
|
8636
8632
|
#
|
8637
8633
|
#
|
@@ -8729,7 +8725,7 @@ module Aws::S3
|
|
8729
8725
|
req.send_request(options)
|
8730
8726
|
end
|
8731
8727
|
|
8732
|
-
# This
|
8728
|
+
# This action uses the `encryption` subresource to configure default
|
8733
8729
|
# encryption and Amazon S3 Bucket Key for an existing bucket.
|
8734
8730
|
#
|
8735
8731
|
# Default encryption for a bucket can use server-side encryption with
|
@@ -8737,36 +8733,36 @@ module Aws::S3
|
|
8737
8733
|
# (SSE-KMS). If you specify default encryption using SSE-KMS, you can
|
8738
8734
|
# also configure Amazon S3 Bucket Key. For information about default
|
8739
8735
|
# encryption, see [Amazon S3 default bucket encryption][1] in the
|
8740
|
-
# *Amazon Simple Storage Service
|
8741
|
-
#
|
8742
|
-
#
|
8736
|
+
# *Amazon Simple Storage Service User Guide*. For more information about
|
8737
|
+
# S3 Bucket Keys, see [Amazon S3 Bucket Keys][2] in the *Amazon Simple
|
8738
|
+
# Storage Service User Guide*.
|
8743
8739
|
#
|
8744
|
-
# This
|
8745
|
-
# see [ Authenticating Requests (AWS Signature Version
|
8746
|
-
# 4)](sig-v4-authenticating-requests.html).
|
8740
|
+
# This action requires AWS Signature Version 4. For more information,
|
8741
|
+
# see [ Authenticating Requests (AWS Signature Version 4)][3].
|
8747
8742
|
#
|
8748
8743
|
# To use this operation, you must have permissions to perform the
|
8749
8744
|
# `s3:PutEncryptionConfiguration` action. The bucket owner has this
|
8750
8745
|
# permission by default. The bucket owner can grant this permission to
|
8751
8746
|
# others. For more information about permissions, see [Permissions
|
8752
|
-
# Related to Bucket Subresource Operations][
|
8753
|
-
# Permissions to Your Amazon S3 Resources][
|
8754
|
-
# Storage Service
|
8747
|
+
# Related to Bucket Subresource Operations][4] and [Managing Access
|
8748
|
+
# Permissions to Your Amazon S3 Resources][5] in the Amazon Simple
|
8749
|
+
# Storage Service User Guide.
|
8755
8750
|
#
|
8756
8751
|
# **Related Resources**
|
8757
8752
|
#
|
8758
|
-
# * [GetBucketEncryption][
|
8753
|
+
# * [GetBucketEncryption][6]
|
8759
8754
|
#
|
8760
|
-
# * [DeleteBucketEncryption][
|
8755
|
+
# * [DeleteBucketEncryption][7]
|
8761
8756
|
#
|
8762
8757
|
#
|
8763
8758
|
#
|
8764
8759
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html
|
8765
8760
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html
|
8766
|
-
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8767
|
-
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-
|
8768
|
-
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/
|
8769
|
-
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/
|
8761
|
+
# [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
|
8762
|
+
# [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources
|
8763
|
+
# [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html
|
8764
|
+
# [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html
|
8765
|
+
# [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html
|
8770
8766
|
#
|
8771
8767
|
# @option params [required, String] :bucket
|
8772
8768
|
# Specifies default encryption for a bucket using server-side encryption
|
@@ -8945,7 +8941,7 @@ module Aws::S3
|
|
8945
8941
|
req.send_request(options)
|
8946
8942
|
end
|
8947
8943
|
|
8948
|
-
# This implementation of the `PUT`
|
8944
|
+
# This implementation of the `PUT` action adds an inventory
|
8949
8945
|
# configuration (identified by the inventory ID) to the bucket. You can
|
8950
8946
|
# have up to 1,000 inventory configurations per bucket.
|
8951
8947
|
#
|
@@ -8961,8 +8957,8 @@ module Aws::S3
|
|
8961
8957
|
# whether to generate the inventory daily or weekly. You can also
|
8962
8958
|
# configure what object metadata to include and whether to inventory all
|
8963
8959
|
# object versions or only current versions. For more information, see
|
8964
|
-
# [Amazon S3 Inventory][1] in the Amazon Simple Storage Service
|
8965
|
-
#
|
8960
|
+
# [Amazon S3 Inventory][1] in the Amazon Simple Storage Service User
|
8961
|
+
# Guide.
|
8966
8962
|
#
|
8967
8963
|
# You must create a bucket policy on the *destination* bucket to grant
|
8968
8964
|
# permissions to Amazon S3 to write objects to the bucket in the defined
|
@@ -8974,7 +8970,7 @@ module Aws::S3
|
|
8974
8970
|
# permission by default and can grant this permission to others. For
|
8975
8971
|
# more information about permissions, see [Permissions Related to Bucket
|
8976
8972
|
# Subresource Operations][3] and [Managing Access Permissions to Your
|
8977
|
-
# Amazon S3 Resources][4] in the Amazon Simple Storage Service
|
8973
|
+
# Amazon S3 Resources][4] in the Amazon Simple Storage Service User
|
8978
8974
|
# Guide.
|
8979
8975
|
#
|
8980
8976
|
# **Special Errors**
|
@@ -9087,7 +9083,7 @@ module Aws::S3
|
|
9087
9083
|
# Creates a new lifecycle configuration for the bucket or replaces an
|
9088
9084
|
# existing lifecycle configuration. For information about lifecycle
|
9089
9085
|
# configuration, see [Object Lifecycle Management][2] in the *Amazon
|
9090
|
-
# Simple Storage Service
|
9086
|
+
# Simple Storage Service User Guide*.
|
9091
9087
|
#
|
9092
9088
|
# By default, all Amazon S3 resources, including buckets, objects, and
|
9093
9089
|
# related subresources (for example, lifecycle configuration and website
|
@@ -9110,7 +9106,7 @@ module Aws::S3
|
|
9110
9106
|
#
|
9111
9107
|
# For more information about permissions, see [Managing Access
|
9112
9108
|
# Permissions to your Amazon S3 Resources][3] in the *Amazon Simple
|
9113
|
-
# Storage Service
|
9109
|
+
# Storage Service User Guide*.
|
9114
9110
|
#
|
9115
9111
|
# For more examples of transitioning objects to storage classes such as
|
9116
9112
|
# STANDARD\_IA or ONEZONE\_IA, see [Examples of Lifecycle
|
@@ -9128,7 +9124,7 @@ module Aws::S3
|
|
9128
9124
|
# the AWS account that created the bucket—can perform any of the
|
9129
9125
|
# operations. A resource owner can also grant others permission to
|
9130
9126
|
# perform the operation. For more information, see the following
|
9131
|
-
# topics in the Amazon Simple Storage Service
|
9127
|
+
# topics in the Amazon Simple Storage Service User Guide:
|
9132
9128
|
#
|
9133
9129
|
# * [Specifying Permissions in a Policy][8]
|
9134
9130
|
#
|
@@ -9718,8 +9714,8 @@ module Aws::S3
|
|
9718
9714
|
#
|
9719
9715
|
# `</NotificationConfiguration>`
|
9720
9716
|
#
|
9721
|
-
# This
|
9722
|
-
#
|
9717
|
+
# This action replaces the existing notification configuration with the
|
9718
|
+
# configuration you include in the request body.
|
9723
9719
|
#
|
9724
9720
|
# After Amazon S3 receives this request, it first verifies that any
|
9725
9721
|
# Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
|
@@ -9742,8 +9738,8 @@ module Aws::S3
|
|
9742
9738
|
# notification configuration includes SNS topic, SQS queue, and Lambda
|
9743
9739
|
# function configurations. When you send a PUT request with this
|
9744
9740
|
# configuration, Amazon S3 sends test messages to your SNS topic. If the
|
9745
|
-
# message fails, the entire PUT
|
9746
|
-
#
|
9741
|
+
# message fails, the entire PUT action will fail, and Amazon S3 will not
|
9742
|
+
# add the configuration to your bucket.
|
9747
9743
|
#
|
9748
9744
|
# </note>
|
9749
9745
|
#
|
@@ -9755,7 +9751,7 @@ module Aws::S3
|
|
9755
9751
|
# include the `x-amz-sns-test-message-id` header containing the message
|
9756
9752
|
# ID of the test notification sent to the topic.
|
9757
9753
|
#
|
9758
|
-
# The following
|
9754
|
+
# The following action is related to
|
9759
9755
|
# `PutBucketNotificationConfiguration`\:
|
9760
9756
|
#
|
9761
9757
|
# * [GetBucketNotificationConfiguration][2]
|
@@ -10020,8 +10016,8 @@ module Aws::S3
|
|
10020
10016
|
# more information, see [Replication][1] in the *Amazon S3 Developer
|
10021
10017
|
# Guide*.
|
10022
10018
|
#
|
10023
|
-
# <note markdown="1"> To perform this operation, the user or role performing the
|
10024
|
-
#
|
10019
|
+
# <note markdown="1"> To perform this operation, the user or role performing the action must
|
10020
|
+
# have the [iam:PassRole][2] permission.
|
10025
10021
|
#
|
10026
10022
|
# </note>
|
10027
10023
|
#
|
@@ -10343,7 +10339,7 @@ module Aws::S3
|
|
10343
10339
|
#
|
10344
10340
|
# * Error code: `OperationAbortedError `
|
10345
10341
|
#
|
10346
|
-
# * Description: A conflicting conditional
|
10342
|
+
# * Description: A conflicting conditional action is currently in
|
10347
10343
|
# progress against this resource. Please try again.
|
10348
10344
|
#
|
10349
10345
|
# ^
|
@@ -10558,7 +10554,7 @@ module Aws::S3
|
|
10558
10554
|
# such as the file name of the index document and any redirect rules.
|
10559
10555
|
# For more information, see [Hosting Websites on Amazon S3][1].
|
10560
10556
|
#
|
10561
|
-
# This PUT
|
10557
|
+
# This PUT action requires the `S3:PutBucketWebsite` permission. By
|
10562
10558
|
# default, only the bucket owner can configure the website attached to a
|
10563
10559
|
# bucket; however, bucket owners can allow other users to set the
|
10564
10560
|
# website configuration by writing a bucket policy that grants them the
|
@@ -10618,7 +10614,7 @@ module Aws::S3
|
|
10618
10614
|
# Amazon S3 has a limitation of 50 routing rules per website
|
10619
10615
|
# configuration. If you require more than 50 routing rules, you can use
|
10620
10616
|
# object redirect. For more information, see [Configuring an Object
|
10621
|
-
# Redirect][2] in the *Amazon Simple Storage Service
|
10617
|
+
# Redirect][2] in the *Amazon Simple Storage Service User Guide*.
|
10622
10618
|
#
|
10623
10619
|
#
|
10624
10620
|
#
|
@@ -10751,7 +10747,7 @@ module Aws::S3
|
|
10751
10747
|
# If you request server-side encryption using AWS Key Management Service
|
10752
10748
|
# (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
|
10753
10749
|
# more information, see [Amazon S3 Bucket Keys][3] in the *Amazon Simple
|
10754
|
-
# Storage Service
|
10750
|
+
# Storage Service User Guide*.
|
10755
10751
|
#
|
10756
10752
|
# **Access Control List (ACL)-Specific Request Headers**
|
10757
10753
|
#
|
@@ -10817,24 +10813,24 @@ module Aws::S3
|
|
10817
10813
|
# Object data.
|
10818
10814
|
#
|
10819
10815
|
# @option params [required, String] :bucket
|
10820
|
-
# The bucket name to which the PUT
|
10816
|
+
# The bucket name to which the PUT action was initiated.
|
10821
10817
|
#
|
10822
|
-
# When using this
|
10823
|
-
# the access point hostname. The access point hostname takes the form
|
10818
|
+
# When using this action with an access point, you must direct requests
|
10819
|
+
# to the access point hostname. The access point hostname takes the form
|
10824
10820
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
10825
|
-
# When using this
|
10826
|
-
#
|
10821
|
+
# When using this action with an access point through the AWS SDKs, you
|
10822
|
+
# provide the access point ARN in place of the bucket name. For more
|
10827
10823
|
# information about access point ARNs, see [Using Access Points][1] in
|
10828
10824
|
# the *Amazon Simple Storage Service Developer Guide*.
|
10829
10825
|
#
|
10830
|
-
# When using this
|
10826
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
10831
10827
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
10832
10828
|
# takes the form
|
10833
10829
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
10834
|
-
# When using this
|
10835
|
-
#
|
10836
|
-
#
|
10837
|
-
#
|
10830
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
10831
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
10832
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
10833
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
10838
10834
|
#
|
10839
10835
|
#
|
10840
10836
|
#
|
@@ -10934,7 +10930,7 @@ module Aws::S3
|
|
10934
10930
|
# This action is not supported by Amazon S3 on Outposts.
|
10935
10931
|
#
|
10936
10932
|
# @option params [required, String] :key
|
10937
|
-
# Object key for which the PUT
|
10933
|
+
# Object key for which the PUT action was initiated.
|
10938
10934
|
#
|
10939
10935
|
# @option params [Hash<String,String>] :metadata
|
10940
10936
|
# A map of metadata to store with the object in S3.
|
@@ -11021,8 +11017,8 @@ module Aws::S3
|
|
11021
11017
|
# Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key
|
11022
11018
|
# for object encryption with SSE-KMS.
|
11023
11019
|
#
|
11024
|
-
# Specifying this header with a PUT
|
11025
|
-
#
|
11020
|
+
# Specifying this header with a PUT action doesn’t affect bucket-level
|
11021
|
+
# settings for S3 Bucket Key.
|
11026
11022
|
#
|
11027
11023
|
# @option params [String] :request_payer
|
11028
11024
|
# Confirms that the requester knows that they will be charged for the
|
@@ -11072,25 +11068,21 @@ module Aws::S3
|
|
11072
11068
|
# * {Types::PutObjectOutput#request_charged #request_charged} => String
|
11073
11069
|
#
|
11074
11070
|
#
|
11075
|
-
# @example Example: To upload object
|
11071
|
+
# @example Example: To upload an object
|
11076
11072
|
#
|
11077
|
-
# # The following example
|
11078
|
-
# #
|
11073
|
+
# # The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file
|
11074
|
+
# # syntax. S3 returns VersionId of the newly created object.
|
11079
11075
|
#
|
11080
11076
|
# resp = client.put_object({
|
11081
|
-
# body: "
|
11077
|
+
# body: "HappyFace.jpg",
|
11082
11078
|
# bucket: "examplebucket",
|
11083
|
-
# key: "
|
11084
|
-
# metadata: {
|
11085
|
-
# "metadata1" => "value1",
|
11086
|
-
# "metadata2" => "value2",
|
11087
|
-
# },
|
11079
|
+
# key: "HappyFace.jpg",
|
11088
11080
|
# })
|
11089
11081
|
#
|
11090
11082
|
# resp.to_h outputs the following:
|
11091
11083
|
# {
|
11092
11084
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11093
|
-
# version_id: "
|
11085
|
+
# version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk",
|
11094
11086
|
# }
|
11095
11087
|
#
|
11096
11088
|
# @example Example: To upload an object and specify server-side encryption and object tags
|
@@ -11113,21 +11105,24 @@ module Aws::S3
|
|
11113
11105
|
# version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt",
|
11114
11106
|
# }
|
11115
11107
|
#
|
11116
|
-
# @example Example: To upload an object
|
11108
|
+
# @example Example: To upload an object (specify optional headers)
|
11117
11109
|
#
|
11118
|
-
# # The following example uploads an object
|
11119
|
-
# #
|
11110
|
+
# # The following example uploads an object. The request specifies optional request headers to directs S3 to use specific
|
11111
|
+
# # storage class and use server-side encryption.
|
11120
11112
|
#
|
11121
11113
|
# resp = client.put_object({
|
11122
11114
|
# body: "HappyFace.jpg",
|
11123
11115
|
# bucket: "examplebucket",
|
11124
11116
|
# key: "HappyFace.jpg",
|
11117
|
+
# server_side_encryption: "AES256",
|
11118
|
+
# storage_class: "STANDARD_IA",
|
11125
11119
|
# })
|
11126
11120
|
#
|
11127
11121
|
# resp.to_h outputs the following:
|
11128
11122
|
# {
|
11129
11123
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11130
|
-
#
|
11124
|
+
# server_side_encryption: "AES256",
|
11125
|
+
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11131
11126
|
# }
|
11132
11127
|
#
|
11133
11128
|
# @example Example: To create an object.
|
@@ -11182,24 +11177,25 @@ module Aws::S3
|
|
11182
11177
|
# version_id: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a",
|
11183
11178
|
# }
|
11184
11179
|
#
|
11185
|
-
# @example Example: To upload
|
11180
|
+
# @example Example: To upload object and specify user-defined metadata
|
11186
11181
|
#
|
11187
|
-
# # The following example
|
11188
|
-
# #
|
11182
|
+
# # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning
|
11183
|
+
# # enabled, S3 returns version ID in response.
|
11189
11184
|
#
|
11190
11185
|
# resp = client.put_object({
|
11191
|
-
# body: "
|
11186
|
+
# body: "filetoupload",
|
11192
11187
|
# bucket: "examplebucket",
|
11193
|
-
# key: "
|
11194
|
-
#
|
11195
|
-
#
|
11188
|
+
# key: "exampleobject",
|
11189
|
+
# metadata: {
|
11190
|
+
# "metadata1" => "value1",
|
11191
|
+
# "metadata2" => "value2",
|
11192
|
+
# },
|
11196
11193
|
# })
|
11197
11194
|
#
|
11198
11195
|
# resp.to_h outputs the following:
|
11199
11196
|
# {
|
11200
11197
|
# etag: "\"6805f2cfc46c0f04559748bb039d69ae\"",
|
11201
|
-
#
|
11202
|
-
# version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp",
|
11198
|
+
# version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0",
|
11203
11199
|
# }
|
11204
11200
|
#
|
11205
11201
|
# @example Streaming a file from disk
|
@@ -11273,7 +11269,7 @@ module Aws::S3
|
|
11273
11269
|
# permissions for a new or existing object in an S3 bucket. You must
|
11274
11270
|
# have `WRITE_ACP` permission to set the ACL of an object. For more
|
11275
11271
|
# information, see [What permissions can I grant?][1] in the *Amazon
|
11276
|
-
# Simple Storage Service
|
11272
|
+
# Simple Storage Service User Guide*.
|
11277
11273
|
#
|
11278
11274
|
# This action is not supported by Amazon S3 on Outposts.
|
11279
11275
|
#
|
@@ -11437,11 +11433,11 @@ module Aws::S3
|
|
11437
11433
|
# The bucket name that contains the object to which you want to attach
|
11438
11434
|
# the ACL.
|
11439
11435
|
#
|
11440
|
-
# When using this
|
11441
|
-
# the access point hostname. The access point hostname takes the form
|
11436
|
+
# When using this action with an access point, you must direct requests
|
11437
|
+
# to the access point hostname. The access point hostname takes the form
|
11442
11438
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11443
|
-
# When using this
|
11444
|
-
#
|
11439
|
+
# When using this action with an access point through the AWS SDKs, you
|
11440
|
+
# provide the access point ARN in place of the bucket name. For more
|
11445
11441
|
# information about access point ARNs, see [Using Access Points][1] in
|
11446
11442
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11447
11443
|
#
|
@@ -11488,24 +11484,24 @@ module Aws::S3
|
|
11488
11484
|
# This action is not supported by Amazon S3 on Outposts.
|
11489
11485
|
#
|
11490
11486
|
# @option params [required, String] :key
|
11491
|
-
# Key for which the PUT
|
11487
|
+
# Key for which the PUT action was initiated.
|
11492
11488
|
#
|
11493
|
-
# When using this
|
11494
|
-
# the access point hostname. The access point hostname takes the form
|
11489
|
+
# When using this action with an access point, you must direct requests
|
11490
|
+
# to the access point hostname. The access point hostname takes the form
|
11495
11491
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11496
|
-
# When using this
|
11497
|
-
#
|
11492
|
+
# When using this action with an access point through the AWS SDKs, you
|
11493
|
+
# provide the access point ARN in place of the bucket name. For more
|
11498
11494
|
# information about access point ARNs, see [Using Access Points][1] in
|
11499
11495
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11500
11496
|
#
|
11501
|
-
# When using this
|
11497
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11502
11498
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11503
11499
|
# takes the form
|
11504
11500
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11505
|
-
# When using this
|
11506
|
-
#
|
11507
|
-
#
|
11508
|
-
#
|
11501
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11502
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11503
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11504
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
11509
11505
|
#
|
11510
11506
|
#
|
11511
11507
|
#
|
@@ -11620,11 +11616,11 @@ module Aws::S3
|
|
11620
11616
|
# The bucket name containing the object that you want to place a Legal
|
11621
11617
|
# Hold on.
|
11622
11618
|
#
|
11623
|
-
# When using this
|
11624
|
-
# the access point hostname. The access point hostname takes the form
|
11619
|
+
# When using this action with an access point, you must direct requests
|
11620
|
+
# to the access point hostname. The access point hostname takes the form
|
11625
11621
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11626
|
-
# When using this
|
11627
|
-
#
|
11622
|
+
# When using this action with an access point through the AWS SDKs, you
|
11623
|
+
# provide the access point ARN in place of the bucket name. For more
|
11628
11624
|
# information about access point ARNs, see [Using Access Points][1] in
|
11629
11625
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11630
11626
|
#
|
@@ -11802,11 +11798,11 @@ module Aws::S3
|
|
11802
11798
|
# The bucket name that contains the object you want to apply this Object
|
11803
11799
|
# Retention configuration to.
|
11804
11800
|
#
|
11805
|
-
# When using this
|
11806
|
-
# the access point hostname. The access point hostname takes the form
|
11801
|
+
# When using this action with an access point, you must direct requests
|
11802
|
+
# to the access point hostname. The access point hostname takes the form
|
11807
11803
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11808
|
-
# When using this
|
11809
|
-
#
|
11804
|
+
# When using this action with an access point through the AWS SDKs, you
|
11805
|
+
# provide the access point ARN in place of the bucket name. For more
|
11810
11806
|
# information about access point ARNs, see [Using Access Points][1] in
|
11811
11807
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11812
11808
|
#
|
@@ -11837,7 +11833,7 @@ module Aws::S3
|
|
11837
11833
|
# Retention configuration to.
|
11838
11834
|
#
|
11839
11835
|
# @option params [Boolean] :bypass_governance_retention
|
11840
|
-
# Indicates whether this
|
11836
|
+
# Indicates whether this action should bypass Governance-mode
|
11841
11837
|
# restrictions.
|
11842
11838
|
#
|
11843
11839
|
# @option params [String] :content_md5
|
@@ -11920,8 +11916,8 @@ module Aws::S3
|
|
11920
11916
|
#
|
11921
11917
|
# * * <i>Code: OperationAbortedError </i>
|
11922
11918
|
#
|
11923
|
-
# * *Cause: A conflicting conditional
|
11924
|
-
#
|
11919
|
+
# * *Cause: A conflicting conditional action is currently in progress
|
11920
|
+
# against this resource. Please try again.*
|
11925
11921
|
#
|
11926
11922
|
# * * *Code: InternalError*
|
11927
11923
|
#
|
@@ -11944,22 +11940,22 @@ module Aws::S3
|
|
11944
11940
|
# @option params [required, String] :bucket
|
11945
11941
|
# The bucket name containing the object.
|
11946
11942
|
#
|
11947
|
-
# When using this
|
11948
|
-
# the access point hostname. The access point hostname takes the form
|
11943
|
+
# When using this action with an access point, you must direct requests
|
11944
|
+
# to the access point hostname. The access point hostname takes the form
|
11949
11945
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
11950
|
-
# When using this
|
11951
|
-
#
|
11946
|
+
# When using this action with an access point through the AWS SDKs, you
|
11947
|
+
# provide the access point ARN in place of the bucket name. For more
|
11952
11948
|
# information about access point ARNs, see [Using Access Points][1] in
|
11953
11949
|
# the *Amazon Simple Storage Service Developer Guide*.
|
11954
11950
|
#
|
11955
|
-
# When using this
|
11951
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
11956
11952
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
11957
11953
|
# takes the form
|
11958
11954
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
11959
|
-
# When using this
|
11960
|
-
#
|
11961
|
-
#
|
11962
|
-
#
|
11955
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
11956
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
11957
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
11958
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
11963
11959
|
#
|
11964
11960
|
#
|
11965
11961
|
#
|
@@ -12161,7 +12157,7 @@ module Aws::S3
|
|
12161
12157
|
# default and can grant this permission to others. For more information
|
12162
12158
|
# about permissions, see [Permissions Related to Bucket Subresource
|
12163
12159
|
# Operations][1] and [Managing Access Permissions to Your Amazon S3
|
12164
|
-
# Resources][2] in the *Amazon Simple Storage Service
|
12160
|
+
# Resources][2] in the *Amazon Simple Storage Service User Guide*.
|
12165
12161
|
#
|
12166
12162
|
# **Querying Archives with Select Requests**
|
12167
12163
|
#
|
@@ -12171,7 +12167,7 @@ module Aws::S3
|
|
12171
12167
|
# files. You can run queries and custom analytics on your archived data
|
12172
12168
|
# without having to restore your data to a hotter Amazon S3 tier. For an
|
12173
12169
|
# overview about select requests, see [Querying Archived Objects][3] in
|
12174
|
-
# the *Amazon Simple Storage Service
|
12170
|
+
# the *Amazon Simple Storage Service User Guide*.
|
12175
12171
|
#
|
12176
12172
|
# When making a select request, do the following:
|
12177
12173
|
#
|
@@ -12182,7 +12178,7 @@ module Aws::S3
|
|
12182
12178
|
# bucket. You can specify the storage class and encryption for the
|
12183
12179
|
# output objects stored in the bucket. For more information about
|
12184
12180
|
# output, see [Querying Archived Objects][3] in the *Amazon Simple
|
12185
|
-
# Storage Service
|
12181
|
+
# Storage Service User Guide*.
|
12186
12182
|
#
|
12187
12183
|
# For more information about the `S3` structure in the request body,
|
12188
12184
|
# see the following:
|
@@ -12190,10 +12186,10 @@ module Aws::S3
|
|
12190
12186
|
# * [PutObject][4]
|
12191
12187
|
#
|
12192
12188
|
# * [Managing Access with ACLs][5] in the *Amazon Simple Storage
|
12193
|
-
# Service
|
12189
|
+
# Service User Guide*
|
12194
12190
|
#
|
12195
12191
|
# * [Protecting Data Using Server-Side Encryption][6] in the *Amazon
|
12196
|
-
# Simple Storage Service
|
12192
|
+
# Simple Storage Service User Guide*
|
12197
12193
|
#
|
12198
12194
|
# * Define the SQL expression for the `SELECT` type of restoration for
|
12199
12195
|
# your query in the request body's `SelectParameters` structure. You
|
@@ -12219,7 +12215,7 @@ module Aws::S3
|
|
12219
12215
|
#
|
12220
12216
|
# For more information about using SQL with S3 Glacier Select restore,
|
12221
12217
|
# see [SQL Reference for Amazon S3 Select and S3 Glacier Select][7] in
|
12222
|
-
# the *Amazon Simple Storage Service
|
12218
|
+
# the *Amazon Simple Storage Service User Guide*.
|
12223
12219
|
#
|
12224
12220
|
# When making a select request, you can also do the following:
|
12225
12221
|
#
|
@@ -12298,20 +12294,20 @@ module Aws::S3
|
|
12298
12294
|
#
|
12299
12295
|
# For more information about archive retrieval options and provisioned
|
12300
12296
|
# capacity for `Expedited` data access, see [Restoring Archived
|
12301
|
-
# Objects][8] in the *Amazon Simple Storage Service
|
12297
|
+
# Objects][8] in the *Amazon Simple Storage Service User Guide*.
|
12302
12298
|
#
|
12303
12299
|
# You can use Amazon S3 restore speed upgrade to change the restore
|
12304
12300
|
# speed to a faster speed while it is in progress. For more information,
|
12305
12301
|
# see [ Upgrading the speed of an in-progress restore][9] in the *Amazon
|
12306
|
-
# Simple Storage Service
|
12302
|
+
# Simple Storage Service User Guide*.
|
12307
12303
|
#
|
12308
12304
|
# To get the status of object restoration, you can send a `HEAD`
|
12309
12305
|
# request. Operations return the `x-amz-restore` header, which provides
|
12310
12306
|
# information about the restoration status, in the response. You can use
|
12311
12307
|
# Amazon S3 event notifications to notify you when a restore is
|
12312
12308
|
# initiated or completed. For more information, see [Configuring Amazon
|
12313
|
-
# S3 Event Notifications][10] in the *Amazon Simple Storage Service
|
12314
|
-
#
|
12309
|
+
# S3 Event Notifications][10] in the *Amazon Simple Storage Service User
|
12310
|
+
# Guide*.
|
12315
12311
|
#
|
12316
12312
|
# After restoring an archived object, you can update the restoration
|
12317
12313
|
# period by reissuing the request with a new period. Amazon S3 updates
|
@@ -12327,11 +12323,11 @@ module Aws::S3
|
|
12327
12323
|
# days, Amazon S3 deletes the object in 3 days. For more information
|
12328
12324
|
# about lifecycle configuration, see
|
12329
12325
|
# [PutBucketLifecycleConfiguration][11] and [Object Lifecycle
|
12330
|
-
# Management][12] in *Amazon Simple Storage Service
|
12326
|
+
# Management][12] in *Amazon Simple Storage Service User Guide*.
|
12331
12327
|
#
|
12332
12328
|
# **Responses**
|
12333
12329
|
#
|
12334
|
-
# A successful
|
12330
|
+
# A successful action returns either the `200 OK` or `202 Accepted`
|
12335
12331
|
# status code.
|
12336
12332
|
#
|
12337
12333
|
# * If the object is not previously restored, then Amazon S3 returns
|
@@ -12369,7 +12365,7 @@ module Aws::S3
|
|
12369
12365
|
# * [GetBucketNotificationConfiguration][13]
|
12370
12366
|
#
|
12371
12367
|
# * [SQL Reference for Amazon S3 Select and S3 Glacier Select ][7] in
|
12372
|
-
# the *Amazon Simple Storage Service
|
12368
|
+
# the *Amazon Simple Storage Service User Guide*
|
12373
12369
|
#
|
12374
12370
|
#
|
12375
12371
|
#
|
@@ -12390,22 +12386,22 @@ module Aws::S3
|
|
12390
12386
|
# @option params [required, String] :bucket
|
12391
12387
|
# The bucket name containing the object to restore.
|
12392
12388
|
#
|
12393
|
-
# When using this
|
12394
|
-
# the access point hostname. The access point hostname takes the form
|
12389
|
+
# When using this action with an access point, you must direct requests
|
12390
|
+
# to the access point hostname. The access point hostname takes the form
|
12395
12391
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
12396
|
-
# When using this
|
12397
|
-
#
|
12392
|
+
# When using this action with an access point through the AWS SDKs, you
|
12393
|
+
# provide the access point ARN in place of the bucket name. For more
|
12398
12394
|
# information about access point ARNs, see [Using Access Points][1] in
|
12399
12395
|
# the *Amazon Simple Storage Service Developer Guide*.
|
12400
12396
|
#
|
12401
|
-
# When using this
|
12397
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
12402
12398
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
12403
12399
|
# takes the form
|
12404
12400
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
12405
|
-
# When using this
|
12406
|
-
#
|
12407
|
-
#
|
12408
|
-
#
|
12401
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
12402
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
12403
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
12404
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
12409
12405
|
#
|
12410
12406
|
#
|
12411
12407
|
#
|
@@ -12413,7 +12409,7 @@ module Aws::S3
|
|
12413
12409
|
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html
|
12414
12410
|
#
|
12415
12411
|
# @option params [required, String] :key
|
12416
|
-
# Object key for which the
|
12412
|
+
# Object key for which the action was initiated.
|
12417
12413
|
#
|
12418
12414
|
# @option params [String] :version_id
|
12419
12415
|
# VersionId used to reference a specific version of the object.
|
@@ -12567,7 +12563,7 @@ module Aws::S3
|
|
12567
12563
|
req.send_request(options)
|
12568
12564
|
end
|
12569
12565
|
|
12570
|
-
# This
|
12566
|
+
# This action filters the contents of an Amazon S3 object based on a
|
12571
12567
|
# simple structured query language (SQL) statement. In the request,
|
12572
12568
|
# along with the SQL expression, you must also specify a data
|
12573
12569
|
# serialization format (JSON, CSV, or Apache Parquet) of the object.
|
@@ -12578,12 +12574,11 @@ module Aws::S3
|
|
12578
12574
|
# This action is not supported by Amazon S3 on Outposts.
|
12579
12575
|
#
|
12580
12576
|
# For more information about Amazon S3 Select, see [Selecting Content
|
12581
|
-
# from Objects][1] in the *Amazon Simple Storage Service
|
12582
|
-
# Guide*.
|
12577
|
+
# from Objects][1] in the *Amazon Simple Storage Service User Guide*.
|
12583
12578
|
#
|
12584
12579
|
# For more information about using SQL with Amazon S3 Select, see [ SQL
|
12585
12580
|
# Reference for Amazon S3 Select and S3 Glacier Select][2] in the
|
12586
|
-
# *Amazon Simple Storage Service
|
12581
|
+
# *Amazon Simple Storage Service User Guide*.
|
12587
12582
|
#
|
12588
12583
|
#
|
12589
12584
|
#
|
@@ -12592,7 +12587,7 @@ module Aws::S3
|
|
12592
12587
|
# You must have `s3:GetObject` permission for this operation. Amazon S3
|
12593
12588
|
# Select does not support anonymous access. For more information about
|
12594
12589
|
# permissions, see [Specifying Permissions in a Policy][3] in the
|
12595
|
-
# *Amazon Simple Storage Service
|
12590
|
+
# *Amazon Simple Storage Service User Guide*.
|
12596
12591
|
#
|
12597
12592
|
#
|
12598
12593
|
#
|
@@ -12620,7 +12615,7 @@ module Aws::S3
|
|
12620
12615
|
# keys (SSE-C), you must use HTTPS, and you must use the headers that
|
12621
12616
|
# are documented in the [GetObject][4]. For more information about
|
12622
12617
|
# SSE-C, see [Server-Side Encryption (Using Customer-Provided
|
12623
|
-
# Encryption Keys)][5] in the *Amazon Simple Storage Service
|
12618
|
+
# Encryption Keys)][5] in the *Amazon Simple Storage Service User
|
12624
12619
|
# Guide*.
|
12625
12620
|
#
|
12626
12621
|
# For objects that are encrypted with Amazon S3 managed encryption
|
@@ -12629,7 +12624,7 @@ module Aws::S3
|
|
12629
12624
|
# transparently, so you don't need to specify anything. For more
|
12630
12625
|
# information about server-side encryption, including SSE-S3 and
|
12631
12626
|
# SSE-KMS, see [Protecting Data Using Server-Side Encryption][6] in
|
12632
|
-
# the *Amazon Simple Storage Service
|
12627
|
+
# the *Amazon Simple Storage Service User Guide*.
|
12633
12628
|
#
|
12634
12629
|
# **Working with the Response Body**
|
12635
12630
|
#
|
@@ -12642,7 +12637,7 @@ module Aws::S3
|
|
12642
12637
|
#
|
12643
12638
|
# **GetObject Support**
|
12644
12639
|
#
|
12645
|
-
# The `SelectObjectContent`
|
12640
|
+
# The `SelectObjectContent` action does not support the following
|
12646
12641
|
# `GetObject` functionality. For more information, see [GetObject][4].
|
12647
12642
|
#
|
12648
12643
|
# * `Range`\: Although you can specify a scan range for an Amazon S3
|
@@ -12653,7 +12648,7 @@ module Aws::S3
|
|
12653
12648
|
# * GLACIER, DEEP\_ARCHIVE and REDUCED\_REDUNDANCY storage classes: You
|
12654
12649
|
# cannot specify the GLACIER, DEEP\_ARCHIVE, or `REDUCED_REDUNDANCY`
|
12655
12650
|
# storage classes. For more information, about storage classes see
|
12656
|
-
# [Storage Classes][9] in the *Amazon Simple Storage Service
|
12651
|
+
# [Storage Classes][9] in the *Amazon Simple Storage Service User
|
12657
12652
|
# Guide*.
|
12658
12653
|
#
|
12659
12654
|
#
|
@@ -13020,12 +13015,11 @@ module Aws::S3
|
|
13020
13015
|
# parts storage and stops charging you for the parts storage.
|
13021
13016
|
#
|
13022
13017
|
# For more information on multipart uploads, go to [Multipart Upload
|
13023
|
-
# Overview][4] in the <i>Amazon Simple Storage Service
|
13024
|
-
# </i>.
|
13018
|
+
# Overview][4] in the <i>Amazon Simple Storage Service User Guide </i>.
|
13025
13019
|
#
|
13026
13020
|
# For information on the permissions required to use the multipart
|
13027
|
-
# upload API, go to [Multipart Upload
|
13028
|
-
#
|
13021
|
+
# upload API, go to [Multipart Upload and Permissions][5] in the *Amazon
|
13022
|
+
# Simple Storage Service User Guide*.
|
13029
13023
|
#
|
13030
13024
|
# You can optionally request server-side encryption where Amazon S3
|
13031
13025
|
# encrypts your data as it writes it to disks in its data centers and
|
@@ -13035,8 +13029,8 @@ module Aws::S3
|
|
13035
13029
|
# request headers you provide in the request must match the headers you
|
13036
13030
|
# used in the request to initiate the upload by using
|
13037
13031
|
# [CreateMultipartUpload][2]. For more information, go to [Using
|
13038
|
-
# Server-Side Encryption][6] in the *Amazon Simple Storage Service
|
13039
|
-
#
|
13032
|
+
# Server-Side Encryption][6] in the *Amazon Simple Storage Service User
|
13033
|
+
# Guide*.
|
13040
13034
|
#
|
13041
13035
|
# Server-side encryption is supported by the S3 Multipart Upload
|
13042
13036
|
# actions. Unless you are using a customer-provided encryption key, you
|
@@ -13099,22 +13093,22 @@ module Aws::S3
|
|
13099
13093
|
# @option params [required, String] :bucket
|
13100
13094
|
# The name of the bucket to which the multipart upload was initiated.
|
13101
13095
|
#
|
13102
|
-
# When using this
|
13103
|
-
# the access point hostname. The access point hostname takes the form
|
13096
|
+
# When using this action with an access point, you must direct requests
|
13097
|
+
# to the access point hostname. The access point hostname takes the form
|
13104
13098
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13105
|
-
# When using this
|
13106
|
-
#
|
13099
|
+
# When using this action with an access point through the AWS SDKs, you
|
13100
|
+
# provide the access point ARN in place of the bucket name. For more
|
13107
13101
|
# information about access point ARNs, see [Using Access Points][1] in
|
13108
13102
|
# the *Amazon Simple Storage Service Developer Guide*.
|
13109
13103
|
#
|
13110
|
-
# When using this
|
13104
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13111
13105
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13112
13106
|
# takes the form
|
13113
13107
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13114
|
-
# When using this
|
13115
|
-
#
|
13116
|
-
#
|
13117
|
-
#
|
13108
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13109
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13110
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13111
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
13118
13112
|
#
|
13119
13113
|
#
|
13120
13114
|
#
|
@@ -13247,10 +13241,10 @@ module Aws::S3
|
|
13247
13241
|
#
|
13248
13242
|
# The minimum allowable part size for a multipart upload is 5 MB. For
|
13249
13243
|
# more information about multipart upload limits, go to [Quick Facts][1]
|
13250
|
-
# in the *Amazon Simple Storage Service
|
13244
|
+
# in the *Amazon Simple Storage Service User Guide*.
|
13251
13245
|
#
|
13252
13246
|
# <note markdown="1"> Instead of using an existing object as part data, you might use the
|
13253
|
-
# [UploadPart][2]
|
13247
|
+
# [UploadPart][2] action and provide data in your request.
|
13254
13248
|
#
|
13255
13249
|
# </note>
|
13256
13250
|
#
|
@@ -13264,15 +13258,15 @@ module Aws::S3
|
|
13264
13258
|
#
|
13265
13259
|
# * For conceptual information about multipart uploads, see [Uploading
|
13266
13260
|
# Objects Using Multipart Upload][3] in the *Amazon Simple Storage
|
13267
|
-
# Service
|
13261
|
+
# Service User Guide*.
|
13268
13262
|
#
|
13269
13263
|
# * For information about permissions required to use the multipart
|
13270
|
-
# upload API, see [Multipart Upload
|
13271
|
-
#
|
13264
|
+
# upload API, see [Multipart Upload and Permissions][4] in the *Amazon
|
13265
|
+
# Simple Storage Service User Guide*.
|
13272
13266
|
#
|
13273
|
-
# * For information about copying objects using a single atomic
|
13274
|
-
#
|
13275
|
-
#
|
13267
|
+
# * For information about copying objects using a single atomic action
|
13268
|
+
# vs. the multipart upload, see [Operations on Objects][5] in the
|
13269
|
+
# *Amazon Simple Storage Service User Guide*.
|
13276
13270
|
#
|
13277
13271
|
# * For information about using server-side encryption with
|
13278
13272
|
# customer-provided encryption keys with the UploadPartCopy operation,
|
@@ -13374,22 +13368,22 @@ module Aws::S3
|
|
13374
13368
|
# @option params [required, String] :bucket
|
13375
13369
|
# The bucket name.
|
13376
13370
|
#
|
13377
|
-
# When using this
|
13378
|
-
# the access point hostname. The access point hostname takes the form
|
13371
|
+
# When using this action with an access point, you must direct requests
|
13372
|
+
# to the access point hostname. The access point hostname takes the form
|
13379
13373
|
# *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
|
13380
|
-
# When using this
|
13381
|
-
#
|
13374
|
+
# When using this action with an access point through the AWS SDKs, you
|
13375
|
+
# provide the access point ARN in place of the bucket name. For more
|
13382
13376
|
# information about access point ARNs, see [Using Access Points][1] in
|
13383
13377
|
# the *Amazon Simple Storage Service Developer Guide*.
|
13384
13378
|
#
|
13385
|
-
# When using this
|
13379
|
+
# When using this action with Amazon S3 on Outposts, you must direct
|
13386
13380
|
# requests to the S3 on Outposts hostname. The S3 on Outposts hostname
|
13387
13381
|
# takes the form
|
13388
13382
|
# *AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
|
13389
|
-
# When using this
|
13390
|
-
#
|
13391
|
-
#
|
13392
|
-
#
|
13383
|
+
# When using this action using S3 on Outposts through the AWS SDKs, you
|
13384
|
+
# provide the Outposts bucket ARN in place of the bucket name. For more
|
13385
|
+
# information about S3 on Outposts ARNs, see [Using S3 on Outposts][2]
|
13386
|
+
# in the *Amazon Simple Storage Service Developer Guide*.
|
13393
13387
|
#
|
13394
13388
|
#
|
13395
13389
|
#
|
@@ -13538,45 +13532,45 @@ module Aws::S3
|
|
13538
13532
|
# * {Types::UploadPartCopyOutput#request_charged #request_charged} => String
|
13539
13533
|
#
|
13540
13534
|
#
|
13541
|
-
# @example Example: To upload a part by copying
|
13535
|
+
# @example Example: To upload a part by copying byte range from an existing object as data source
|
13542
13536
|
#
|
13543
|
-
# # The following example uploads a part of a multipart upload by copying
|
13537
|
+
# # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as
|
13538
|
+
# # data source.
|
13544
13539
|
#
|
13545
13540
|
# resp = client.upload_part_copy({
|
13546
13541
|
# bucket: "examplebucket",
|
13547
13542
|
# copy_source: "/bucketname/sourceobjectkey",
|
13543
|
+
# copy_source_range: "bytes=1-100000",
|
13548
13544
|
# key: "examplelargeobject",
|
13549
|
-
# part_number:
|
13545
|
+
# part_number: 2,
|
13550
13546
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13551
13547
|
# })
|
13552
13548
|
#
|
13553
13549
|
# resp.to_h outputs the following:
|
13554
13550
|
# {
|
13555
13551
|
# copy_part_result: {
|
13556
|
-
# etag: "\"
|
13557
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13552
|
+
# etag: "\"65d16d19e65a7508a51f043180edcc36\"",
|
13553
|
+
# last_modified: Time.parse("2016-12-29T21:44:28.000Z"),
|
13558
13554
|
# },
|
13559
13555
|
# }
|
13560
13556
|
#
|
13561
|
-
# @example Example: To upload a part by copying
|
13557
|
+
# @example Example: To upload a part by copying data from an existing object as data source
|
13562
13558
|
#
|
13563
|
-
# # The following example uploads a part of a multipart upload by copying
|
13564
|
-
# # data source.
|
13559
|
+
# # The following example uploads a part of a multipart upload by copying data from an existing object as data source.
|
13565
13560
|
#
|
13566
13561
|
# resp = client.upload_part_copy({
|
13567
13562
|
# bucket: "examplebucket",
|
13568
13563
|
# copy_source: "/bucketname/sourceobjectkey",
|
13569
|
-
# copy_source_range: "bytes=1-100000",
|
13570
13564
|
# key: "examplelargeobject",
|
13571
|
-
# part_number:
|
13565
|
+
# part_number: 1,
|
13572
13566
|
# upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--",
|
13573
13567
|
# })
|
13574
13568
|
#
|
13575
13569
|
# resp.to_h outputs the following:
|
13576
13570
|
# {
|
13577
13571
|
# copy_part_result: {
|
13578
|
-
# etag: "\"
|
13579
|
-
# last_modified: Time.parse("2016-12-29T21:
|
13572
|
+
# etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
|
13573
|
+
# last_modified: Time.parse("2016-12-29T21:24:43.000Z"),
|
13580
13574
|
# },
|
13581
13575
|
# }
|
13582
13576
|
#
|
@@ -13638,7 +13632,7 @@ module Aws::S3
|
|
13638
13632
|
params: params,
|
13639
13633
|
config: config)
|
13640
13634
|
context[:gem_name] = 'aws-sdk-s3'
|
13641
|
-
context[:gem_version] = '1.
|
13635
|
+
context[:gem_version] = '1.90.0'
|
13642
13636
|
Seahorse::Client::Request.new(handlers, context)
|
13643
13637
|
end
|
13644
13638
|
|