@aws-sdk/client-s3 3.414.0 → 3.417.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +6 -6
- package/dist-types/commands/CopyObjectCommand.d.ts +90 -76
- package/dist-types/commands/CreateBucketCommand.d.ts +63 -37
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +14 -12
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +3 -2
- package/dist-types/commands/DeleteObjectsCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +5 -4
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +15 -12
- package/dist-types/commands/GetObjectCommand.d.ts +44 -37
- package/dist-types/commands/HeadBucketCommand.d.ts +3 -3
- package/dist-types/commands/HeadObjectCommand.d.ts +11 -11
- package/dist-types/commands/PutBucketAclCommand.d.ts +41 -35
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -8
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +5 -4
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +18 -18
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +29 -25
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +12 -10
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +5 -4
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +23 -17
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +18 -35
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +6 -6
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +1 -0
- package/dist-types/commands/PutObjectAclCommand.d.ts +39 -36
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +21 -58
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -1
- package/dist-types/commands/RestoreObjectCommand.d.ts +93 -91
- package/dist-types/commands/SelectObjectContentCommand.d.ts +46 -40
- package/dist-types/commands/UploadPartCopyCommand.d.ts +16 -14
- package/dist-types/models/models_0.d.ts +173 -110
- package/dist-types/models/models_1.d.ts +25 -13
- package/package.json +1 -1
|
@@ -26,12 +26,12 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
|
|
|
26
26
|
* <p>Completes a multipart upload by assembling previously uploaded parts.</p>
|
|
27
27
|
* <p>You first initiate the multipart upload and then upload all parts using the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>
|
|
28
28
|
* operation. After successfully uploading all relevant parts of an upload, you call this
|
|
29
|
-
* action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
29
|
+
* action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts
|
|
30
|
+
* in ascending order by part number to create a new object. In the Complete Multipart Upload
|
|
31
|
+
* request, you must provide the parts list. You must ensure that the parts list is complete.
|
|
32
|
+
* This action concatenates the parts that you provide in the list. For each part in the list,
|
|
33
|
+
* you must provide the part number and the <code>ETag</code> value, returned after that part
|
|
34
|
+
* was uploaded.</p>
|
|
35
35
|
* <p>Processing of a Complete Multipart Upload request could take several minutes to
|
|
36
36
|
* complete. After Amazon S3 begins processing the request, it sends an HTTP response header that
|
|
37
37
|
* specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white
|
|
@@ -67,29 +67,31 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
67
67
|
* <dl>
|
|
68
68
|
* <dt>Metadata</dt>
|
|
69
69
|
* <dd>
|
|
70
|
-
* <p>When copying an object, you can preserve all metadata (the default) or specify
|
|
71
|
-
* However, the access control list (ACL) is not preserved and is set
|
|
72
|
-
*
|
|
73
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
70
|
+
* <p>When copying an object, you can preserve all metadata (the default) or specify
|
|
71
|
+
* new metadata. However, the access control list (ACL) is not preserved and is set
|
|
72
|
+
* to private for the user making the request. To override the default ACL setting,
|
|
73
|
+
* specify a new ACL when generating a copy request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using
|
|
74
|
+
* ACLs</a>. </p>
|
|
75
|
+
* <p>To specify whether you want the object metadata copied from the source object
|
|
76
|
+
* or replaced with metadata provided in the request, you can optionally add the
|
|
77
|
+
* <code>x-amz-metadata-directive</code> header. When you grant permissions, you
|
|
78
|
+
* can use the <code>s3:x-amz-metadata-directive</code> condition key to enforce
|
|
79
|
+
* certain metadata behavior when objects are uploaded. For more information, see
|
|
80
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html">Specifying Conditions in a
|
|
81
|
+
* Policy</a> in the <i>Amazon S3 User Guide</i>. For a complete list
|
|
82
|
+
* of Amazon S3-specific condition keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, Resources, and Condition
|
|
83
|
+
* Keys for Amazon S3</a>.</p>
|
|
82
84
|
* <note>
|
|
83
85
|
* <p>
|
|
84
|
-
* <code>x-amz-website-redirect-location</code> is unique to each object and
|
|
85
|
-
*
|
|
86
|
+
* <code>x-amz-website-redirect-location</code> is unique to each object and
|
|
87
|
+
* must be specified in the request headers to copy the value.</p>
|
|
86
88
|
* </note>
|
|
87
89
|
* </dd>
|
|
88
90
|
* <dt>x-amz-copy-source-if Headers</dt>
|
|
89
91
|
* <dd>
|
|
90
|
-
* <p>To only copy an object under certain conditions, such as whether the
|
|
91
|
-
*
|
|
92
|
-
* following request parameters:</p>
|
|
92
|
+
* <p>To only copy an object under certain conditions, such as whether the
|
|
93
|
+
* <code>Etag</code> matches or whether the object was modified before or after a
|
|
94
|
+
* specified date, use the following request parameters:</p>
|
|
93
95
|
* <ul>
|
|
94
96
|
* <li>
|
|
95
97
|
* <p>
|
|
@@ -113,12 +115,14 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
113
115
|
* </li>
|
|
114
116
|
* </ul>
|
|
115
117
|
* <p> If both the <code>x-amz-copy-source-if-match</code> and
|
|
116
|
-
*
|
|
117
|
-
* and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the
|
|
118
|
+
* <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the
|
|
119
|
+
* request and evaluate as follows, Amazon S3 returns <code>200 OK</code> and copies the
|
|
120
|
+
* data:</p>
|
|
118
121
|
* <ul>
|
|
119
122
|
* <li>
|
|
120
123
|
* <p>
|
|
121
|
-
* <code>x-amz-copy-source-if-match</code> condition evaluates to
|
|
124
|
+
* <code>x-amz-copy-source-if-match</code> condition evaluates to
|
|
125
|
+
* true</p>
|
|
122
126
|
* </li>
|
|
123
127
|
* <li>
|
|
124
128
|
* <p>
|
|
@@ -127,13 +131,14 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
127
131
|
* </li>
|
|
128
132
|
* </ul>
|
|
129
133
|
* <p>If both the <code>x-amz-copy-source-if-none-match</code> and
|
|
130
|
-
*
|
|
131
|
-
* evaluate as follows, Amazon S3 returns the <code>412 Precondition
|
|
132
|
-
*
|
|
134
|
+
* <code>x-amz-copy-source-if-modified-since</code> headers are present in the
|
|
135
|
+
* request and evaluate as follows, Amazon S3 returns the <code>412 Precondition
|
|
136
|
+
* Failed</code> response code:</p>
|
|
133
137
|
* <ul>
|
|
134
138
|
* <li>
|
|
135
139
|
* <p>
|
|
136
|
-
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
140
|
+
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
|
|
141
|
+
* false</p>
|
|
137
142
|
* </li>
|
|
138
143
|
* <li>
|
|
139
144
|
* <p>
|
|
@@ -143,13 +148,13 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
143
148
|
* </ul>
|
|
144
149
|
* <note>
|
|
145
150
|
* <p>All headers with the <code>x-amz-</code> prefix, including
|
|
146
|
-
*
|
|
151
|
+
* <code>x-amz-copy-source</code>, must be signed.</p>
|
|
147
152
|
* </note>
|
|
148
153
|
* </dd>
|
|
149
154
|
* <dt>Server-side encryption</dt>
|
|
150
155
|
* <dd>
|
|
151
|
-
* <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket.
|
|
152
|
-
* copying an object, if you don't specify encryption information in your copy
|
|
156
|
+
* <p>Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket.
|
|
157
|
+
* When copying an object, if you don't specify encryption information in your copy
|
|
153
158
|
* request, the encryption setting of the target object is set to the default
|
|
154
159
|
* encryption configuration of the destination bucket. By default, all buckets have a
|
|
155
160
|
* base level of encryption configuration that uses server-side encryption with Amazon S3
|
|
@@ -159,71 +164,80 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
159
164
|
* server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses
|
|
160
165
|
* the corresponding KMS key, or a customer-provided key to encrypt the target
|
|
161
166
|
* object copy.</p>
|
|
162
|
-
* <p>When you perform a <code>CopyObject</code> operation, if you want to use a
|
|
163
|
-
* of encryption setting for the target object, you can use other
|
|
164
|
-
* encryption-related headers to encrypt the target object with a
|
|
165
|
-
* key, or a customer-provided key. With server-side
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
*
|
|
172
|
-
*
|
|
167
|
+
* <p>When you perform a <code>CopyObject</code> operation, if you want to use a
|
|
168
|
+
* different type of encryption setting for the target object, you can use other
|
|
169
|
+
* appropriate encryption-related headers to encrypt the target object with a
|
|
170
|
+
* KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side
|
|
171
|
+
* encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
|
|
172
|
+
* centers and decrypts the data when you access it. If the encryption setting in
|
|
173
|
+
* your request is different from the default encryption configuration of the
|
|
174
|
+
* destination bucket, the encryption setting in your request takes precedence. If
|
|
175
|
+
* the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the
|
|
176
|
+
* necessary encryption information in your request so that Amazon S3 can decrypt the
|
|
177
|
+
* object for copying. For more information about server-side encryption, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Using
|
|
178
|
+
* Server-Side Encryption</a>.</p>
|
|
173
179
|
* <p>If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the
|
|
174
180
|
* object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the
|
|
175
181
|
* <i>Amazon S3 User Guide</i>.</p>
|
|
176
182
|
* </dd>
|
|
177
|
-
* <dt>Access Control List (ACL)-Specific Request
|
|
178
|
-
* Headers</dt>
|
|
183
|
+
* <dt>Access Control List (ACL)-Specific Request Headers</dt>
|
|
179
184
|
* <dd>
|
|
180
|
-
* <p>When copying an object, you can optionally use headers to grant ACL-based
|
|
181
|
-
* By default, all objects are private. Only the owner has full access
|
|
182
|
-
* new object, you can grant permissions to individual
|
|
183
|
-
* that are defined by Amazon S3. These permissions
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
*
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
185
|
+
* <p>When copying an object, you can optionally use headers to grant ACL-based
|
|
186
|
+
* permissions. By default, all objects are private. Only the owner has full access
|
|
187
|
+
* control. When adding a new object, you can grant permissions to individual
|
|
188
|
+
* Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions
|
|
189
|
+
* are then added to the ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control
|
|
190
|
+
* List (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST
|
|
191
|
+
* API</a>. </p>
|
|
192
|
+
* <p>If the bucket that you're copying objects to uses the bucket owner enforced
|
|
193
|
+
* setting for S3 Object Ownership, ACLs are disabled and no longer affect
|
|
194
|
+
* permissions. Buckets that use this setting only accept <code>PUT</code> requests
|
|
195
|
+
* that don't specify an ACL or <code>PUT</code> requests that specify bucket owner
|
|
196
|
+
* full control ACLs, such as the <code>bucket-owner-full-control</code> canned ACL
|
|
197
|
+
* or an equivalent form of this ACL expressed in the XML format.</p>
|
|
198
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling
|
|
199
|
+
* ownership of objects and disabling ACLs</a> in the
|
|
200
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
193
201
|
* <note>
|
|
194
|
-
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership,
|
|
195
|
-
* objects written to the bucket by any account will be owned by the bucket
|
|
202
|
+
* <p>If your bucket uses the bucket owner enforced setting for Object Ownership,
|
|
203
|
+
* all objects written to the bucket by any account will be owned by the bucket
|
|
204
|
+
* owner.</p>
|
|
196
205
|
* </note>
|
|
197
206
|
* </dd>
|
|
198
207
|
* <dt>Checksums</dt>
|
|
199
208
|
* <dd>
|
|
200
|
-
* <p>When copying an object, if it has a checksum, that checksum will be copied to
|
|
201
|
-
* object by default. When you copy the object over, you can optionally
|
|
202
|
-
* checksum algorithm to use with the
|
|
209
|
+
* <p>When copying an object, if it has a checksum, that checksum will be copied to
|
|
210
|
+
* the new object by default. When you copy the object over, you can optionally
|
|
211
|
+
* specify a different checksum algorithm to use with the
|
|
212
|
+
* <code>x-amz-checksum-algorithm</code> header.</p>
|
|
203
213
|
* </dd>
|
|
204
214
|
* <dt>Storage Class Options</dt>
|
|
205
215
|
* <dd>
|
|
206
|
-
* <p>You can use the <code>CopyObject</code> action to change the storage class of
|
|
207
|
-
* that is already stored in Amazon S3 by using the <code>StorageClass</code>
|
|
208
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in
|
|
209
|
-
* <i>Amazon S3 User Guide</i>.</p>
|
|
210
|
-
* <p>If the source object's storage class is GLACIER
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
216
|
+
* <p>You can use the <code>CopyObject</code> action to change the storage class of
|
|
217
|
+
* an object that is already stored in Amazon S3 by using the <code>StorageClass</code>
|
|
218
|
+
* parameter. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in
|
|
219
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
220
|
+
* <p>If the source object's storage class is GLACIER or
|
|
221
|
+
* DEEP_ARCHIVE, or the object's storage class is
|
|
222
|
+
* INTELLIGENT_TIERING and it's <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/intelligent-tiering-overview.html#intel-tiering-tier-definition"> S3 Intelligent-Tiering access tier</a> is
|
|
223
|
+
* Archive Access or Deep Archive Access, you must restore a copy of this object
|
|
224
|
+
* before you can use it as a source object for the copy operation. For more
|
|
225
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html">RestoreObject</a>. For
|
|
226
|
+
* more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html">Copying
|
|
227
|
+
* Objects</a>.</p>
|
|
215
228
|
* </dd>
|
|
216
229
|
* <dt>Versioning</dt>
|
|
217
230
|
* <dd>
|
|
218
|
-
* <p>By default, <code>x-amz-copy-source</code> header identifies the current
|
|
219
|
-
* to copy. If the current version is a delete marker, Amazon S3
|
|
220
|
-
* deleted. To copy a different version, use the
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* object
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
231
|
+
* <p>By default, <code>x-amz-copy-source</code> header identifies the current
|
|
232
|
+
* version of an object to copy. If the current version is a delete marker, Amazon S3
|
|
233
|
+
* behaves as if the object was deleted. To copy a different version, use the
|
|
234
|
+
* <code>versionId</code> subresource.</p>
|
|
235
|
+
* <p>If you enable versioning on the target bucket, Amazon S3 generates a unique version
|
|
236
|
+
* ID for the object being copied. This version ID is different from the version ID
|
|
237
|
+
* of the source object. Amazon S3 returns the version ID of the copied object in the
|
|
238
|
+
* <code>x-amz-version-id</code> response header in the response.</p>
|
|
239
|
+
* <p>If you do not enable versioning or suspend it on the target bucket, the version
|
|
240
|
+
* ID that Amazon S3 generates is always null.</p>
|
|
227
241
|
* </dd>
|
|
228
242
|
* </dl>
|
|
229
243
|
* <p>The following operations are related to <code>CopyObject</code>:</p>
|
|
@@ -31,69 +31,95 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
|
|
|
31
31
|
* rules</a>.</p>
|
|
32
32
|
* <p>If you want to create an Amazon S3 on Outposts bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html">Create Bucket</a>. </p>
|
|
33
33
|
* <p>By default, the bucket is created in the US East (N. Virginia) Region. You can
|
|
34
|
-
* optionally specify a Region in the request body.
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
34
|
+
* optionally specify a Region in the request body. To constrain the bucket creation to a
|
|
35
|
+
* specific Region, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucketConfiguration.html">
|
|
36
|
+
* <code>LocationConstraint</code>
|
|
37
|
+
* </a> condition key. You might choose a Region to
|
|
38
|
+
* optimize latency, minimize costs, or address regulatory requirements. For example, if you
|
|
39
|
+
* reside in Europe, you will probably find it advantageous to create buckets in the Europe
|
|
40
|
+
* (Ireland) Region. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro">Accessing a
|
|
38
41
|
* bucket</a>.</p>
|
|
39
42
|
* <note>
|
|
40
43
|
* <p>If you send your create bucket request to the <code>s3.amazonaws.com</code> endpoint,
|
|
41
|
-
* the request goes to the <code>us-east-1</code> Region. Accordingly, the signature
|
|
42
|
-
* Signature Version 4 must use <code>us-east-1</code> as the Region, even
|
|
43
|
-
* the request specifies another Region where the bucket is
|
|
44
|
-
* bucket in a Region other than US East (N. Virginia), your
|
|
45
|
-
* handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
|
|
46
|
-
*
|
|
44
|
+
* the request goes to the <code>us-east-1</code> Region. Accordingly, the signature
|
|
45
|
+
* calculations in Signature Version 4 must use <code>us-east-1</code> as the Region, even
|
|
46
|
+
* if the location constraint in the request specifies another Region where the bucket is
|
|
47
|
+
* to be created. If you create a bucket in a Region other than US East (N. Virginia), your
|
|
48
|
+
* application must be able to handle 307 redirect. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html">Virtual hosting of
|
|
49
|
+
* buckets</a>.</p>
|
|
47
50
|
* </note>
|
|
48
51
|
* <dl>
|
|
49
52
|
* <dt>Permissions</dt>
|
|
50
53
|
* <dd>
|
|
51
|
-
* <p>In addition to <code>s3:CreateBucket</code>, the following permissions are
|
|
52
|
-
* your <code>CreateBucket</code> request includes specific
|
|
54
|
+
* <p>In addition to <code>s3:CreateBucket</code>, the following permissions are
|
|
55
|
+
* required when your <code>CreateBucket</code> request includes specific
|
|
56
|
+
* headers:</p>
|
|
53
57
|
* <ul>
|
|
54
58
|
* <li>
|
|
55
59
|
* <p>
|
|
56
|
-
* <b>Access control lists (ACLs)</b> - If your
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
60
|
+
* <b>Access control lists (ACLs)</b> - If your
|
|
61
|
+
* <code>CreateBucket</code> request specifies access control list (ACL)
|
|
62
|
+
* permissions and the ACL is public-read, public-read-write,
|
|
63
|
+
* authenticated-read, or if you specify access permissions explicitly through
|
|
64
|
+
* any other ACL, both <code>s3:CreateBucket</code> and
|
|
65
|
+
* <code>s3:PutBucketAcl</code> permissions are needed. If the ACL for the
|
|
66
|
+
* <code>CreateBucket</code> request is private or if the request doesn't
|
|
67
|
+
* specify any ACLs, only <code>s3:CreateBucket</code> permission is needed.
|
|
68
|
+
* </p>
|
|
62
69
|
* </li>
|
|
63
70
|
* <li>
|
|
64
71
|
* <p>
|
|
65
|
-
* <b>Object Lock</b> - If
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
72
|
+
* <b>Object Lock</b> - If
|
|
73
|
+
* <code>ObjectLockEnabledForBucket</code> is set to true in your
|
|
74
|
+
* <code>CreateBucket</code> request,
|
|
75
|
+
* <code>s3:PutBucketObjectLockConfiguration</code> and
|
|
76
|
+
* <code>s3:PutBucketVersioning</code> permissions are required.</p>
|
|
69
77
|
* </li>
|
|
70
78
|
* <li>
|
|
71
79
|
* <p>
|
|
72
|
-
* <b>S3 Object Ownership</b> - If your
|
|
73
|
-
*
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
*
|
|
77
|
-
*
|
|
80
|
+
* <b>S3 Object Ownership</b> - If your
|
|
81
|
+
* <code>CreateBucket</code> request includes the
|
|
82
|
+
* <code>x-amz-object-ownership</code> header, then the
|
|
83
|
+
* <code>s3:PutBucketOwnershipControls</code> permission is required. By
|
|
84
|
+
* default, <code>ObjectOwnership</code> is set to
|
|
85
|
+
* <code>BucketOWnerEnforced</code> and ACLs are disabled. We recommend
|
|
86
|
+
* keeping ACLs disabled, except in uncommon use cases where you must control
|
|
87
|
+
* access for each object individually. If you want to change the
|
|
88
|
+
* <code>ObjectOwnership</code> setting, you can use the
|
|
89
|
+
* <code>x-amz-object-ownership</code> header in your
|
|
90
|
+
* <code>CreateBucket</code> request to set the <code>ObjectOwnership</code>
|
|
91
|
+
* setting of your choice. For more information about S3 Object Ownership, see
|
|
92
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling
|
|
93
|
+
* object ownership </a> in the
|
|
94
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
78
95
|
* </li>
|
|
79
96
|
* <li>
|
|
80
97
|
* <p>
|
|
81
|
-
* <b>S3 Block Public Access</b> - If your
|
|
98
|
+
* <b>S3 Block Public Access</b> - If your
|
|
99
|
+
* specific use case requires granting public access to your S3 resources, you
|
|
100
|
+
* can disable Block Public Access. You can create a new bucket with Block
|
|
101
|
+
* Public Access enabled, then separately call the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html">
|
|
82
102
|
* <code>DeletePublicAccessBlock</code>
|
|
83
103
|
* </a> API. To use this operation, you must have the
|
|
84
|
-
*
|
|
85
|
-
* Public Access settings are enabled for new buckets. To avoid
|
|
86
|
-
* your resources, we recommend keeping the S3 Block
|
|
87
|
-
*
|
|
104
|
+
* <code>s3:PutBucketPublicAccessBlock</code> permission. By default, all
|
|
105
|
+
* Block Public Access settings are enabled for new buckets. To avoid
|
|
106
|
+
* inadvertent exposure of your resources, we recommend keeping the S3 Block
|
|
107
|
+
* Public Access settings enabled. For more information about S3 Block Public
|
|
108
|
+
* Access, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Blocking
|
|
109
|
+
* public access to your Amazon S3 storage </a> in the
|
|
110
|
+
* <i>Amazon S3 User Guide</i>. </p>
|
|
88
111
|
* </li>
|
|
89
112
|
* </ul>
|
|
90
113
|
* </dd>
|
|
91
114
|
* </dl>
|
|
92
115
|
* <important>
|
|
93
|
-
* <p> If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
116
|
+
* <p> If your <code>CreateBucket</code> request sets <code>BucketOwnerEnforced</code> for
|
|
117
|
+
* Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external
|
|
118
|
+
* Amazon Web Services account, your request fails with a <code>400</code> error and returns the
|
|
119
|
+
* <code>InvalidBucketAcLWithObjectOwnership</code> error code. For more information,
|
|
120
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html">Setting Object
|
|
121
|
+
* Ownership on an existing bucket </a> in the <i>Amazon S3 User Guide</i>.
|
|
122
|
+
* </p>
|
|
97
123
|
* </important>
|
|
98
124
|
* <p>The following operations are related to <code>CreateBucket</code>:</p>
|
|
99
125
|
* <ul>
|
|
@@ -32,7 +32,8 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
|
|
|
32
32
|
* <p>If you have configured a lifecycle rule to abort incomplete multipart uploads, the
|
|
33
33
|
* upload must complete within the number of days specified in the bucket lifecycle
|
|
34
34
|
* configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort
|
|
35
|
-
* action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
35
|
+
* action and Amazon S3 aborts the multipart upload. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle
|
|
36
|
+
* Configuration</a>.</p>
|
|
36
37
|
* <p>For information about the permissions required to use the multipart upload API, see
|
|
37
38
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart
|
|
38
39
|
* Upload and Permissions</a>.</p>
|
|
@@ -107,19 +108,19 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
|
|
|
107
108
|
* </dd>
|
|
108
109
|
* <dt>Server-Side- Encryption-Specific Request Headers</dt>
|
|
109
110
|
* <dd>
|
|
110
|
-
* <p>Amazon S3 encrypts data
|
|
111
|
-
*
|
|
112
|
-
* your data as it writes it to disks in its data centers and decrypts it
|
|
113
|
-
* access it. You can request that Amazon S3 encrypts
|
|
114
|
-
*
|
|
111
|
+
* <p>Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key
|
|
112
|
+
* (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3
|
|
113
|
+
* encrypts your data as it writes it to disks in its data centers and decrypts it
|
|
114
|
+
* when you access it. You can request that Amazon S3 encrypts data at rest by using
|
|
115
|
+
* server-side encryption with other key options. The option you use depends on
|
|
115
116
|
* whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys
|
|
116
117
|
* (SSE-C).</p>
|
|
117
118
|
* <ul>
|
|
118
119
|
* <li>
|
|
119
120
|
* <p>Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key
|
|
120
|
-
*
|
|
121
|
-
* want Amazon Web Services to manage the keys used to encrypt data, specify the
|
|
122
|
-
* headers in the request.</p>
|
|
121
|
+
* (<code>aws/s3</code>) and KMS customer managed keys stored in Key Management Service (KMS) –
|
|
122
|
+
* If you want Amazon Web Services to manage the keys used to encrypt data, specify the
|
|
123
|
+
* following headers in the request.</p>
|
|
123
124
|
* <ul>
|
|
124
125
|
* <li>
|
|
125
126
|
* <p>
|
|
@@ -144,9 +145,10 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
|
|
|
144
145
|
* protect the data.</p>
|
|
145
146
|
* </note>
|
|
146
147
|
* <important>
|
|
147
|
-
* <p>All <code>GET</code> and <code>PUT</code> requests for an object
|
|
148
|
-
* by KMS fail if you don't make them by using Secure Sockets
|
|
149
|
-
* Transport Layer Security (TLS), or Signature Version
|
|
148
|
+
* <p>All <code>GET</code> and <code>PUT</code> requests for an object
|
|
149
|
+
* protected by KMS fail if you don't make them by using Secure Sockets
|
|
150
|
+
* Layer (SSL), Transport Layer Security (TLS), or Signature Version
|
|
151
|
+
* 4.</p>
|
|
150
152
|
* </important>
|
|
151
153
|
* <p>For more information about server-side encryption with KMS keys
|
|
152
154
|
* (SSE-KMS), see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html">Protecting Data
|
|
@@ -23,9 +23,9 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>This implementation of the DELETE action resets the default encryption for the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>This implementation of the DELETE action resets the default encryption for the bucket as
|
|
27
|
+
* server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket
|
|
28
|
+
* default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
|
|
29
29
|
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
30
30
|
* <p>To use this operation, you must have permissions to perform the
|
|
31
31
|
* <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
@@ -37,8 +37,9 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
37
37
|
* buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
38
38
|
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
39
39
|
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
|
|
40
|
-
* denies the root principal's access. Bucket owner root principals can only be blocked
|
|
41
|
-
* these API actions by VPC endpoint policies and Amazon Web Services Organizations
|
|
40
|
+
* denies the root principal's access. Bucket owner root principals can only be blocked
|
|
41
|
+
* from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
|
|
42
|
+
* policies.</p>
|
|
42
43
|
* </important>
|
|
43
44
|
* <p>For more information about bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and
|
|
44
45
|
* UserPolicies</a>. </p>
|
|
@@ -44,7 +44,8 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
44
44
|
* provide an invalid token, whether there are versioned keys in the request or not, the
|
|
45
45
|
* entire Multi-Object Delete request will fail. For information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete"> MFA
|
|
46
46
|
* Delete</a>.</p>
|
|
47
|
-
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3
|
|
47
|
+
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3
|
|
48
|
+
* uses the header value to ensure that your request body has not been altered in
|
|
48
49
|
* transit.</p>
|
|
49
50
|
* <p>The following operations are related to <code>DeleteObjects</code>:</p>
|
|
50
51
|
* <ul>
|
|
@@ -40,7 +40,8 @@ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucket
|
|
|
40
40
|
* has never been set on the bucket. </p>
|
|
41
41
|
* <p>For more information about transfer acceleration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html">Transfer Acceleration</a> in
|
|
42
42
|
* the Amazon S3 User Guide.</p>
|
|
43
|
-
* <p>The following operations are related to
|
|
43
|
+
* <p>The following operations are related to
|
|
44
|
+
* <code>GetBucketAccelerateConfiguration</code>:</p>
|
|
44
45
|
* <ul>
|
|
45
46
|
* <li>
|
|
46
47
|
* <p>
|
|
@@ -33,7 +33,8 @@ export interface GetBucketAnalyticsConfigurationCommandOutput extends GetBucketA
|
|
|
33
33
|
* <i>Amazon S3 User Guide</i>. </p>
|
|
34
34
|
* <p>For information about Amazon S3 analytics feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html">Amazon S3 Analytics – Storage Class
|
|
35
35
|
* Analysis</a> in the <i>Amazon S3 User Guide</i>.</p>
|
|
36
|
-
* <p>The following operations are related to
|
|
36
|
+
* <p>The following operations are related to
|
|
37
|
+
* <code>GetBucketAnalyticsConfiguration</code>:</p>
|
|
37
38
|
* <ul>
|
|
38
39
|
* <li>
|
|
39
40
|
* <p>
|
|
@@ -34,10 +34,11 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
|
|
|
34
34
|
* <important>
|
|
35
35
|
* <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
|
|
36
36
|
* buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* denies the root principal's access. Bucket owner root principals can only be blocked
|
|
40
|
-
* these API actions by VPC endpoint policies and Amazon Web Services Organizations
|
|
37
|
+
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
38
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
|
|
39
|
+
* denies the root principal's access. Bucket owner root principals can only be blocked
|
|
40
|
+
* from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
|
|
41
|
+
* policies.</p>
|
|
41
42
|
* </important>
|
|
42
43
|
* <p>To use this API operation against an access point, provide the alias of the access point in place of the bucket name.</p>
|
|
43
44
|
* <p>To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name.
|
|
@@ -107,22 +107,25 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
|
|
|
107
107
|
* <dl>
|
|
108
108
|
* <dt>Permissions</dt>
|
|
109
109
|
* <dd>
|
|
110
|
-
* <p>The permissions that you need to use this operation depend on whether the
|
|
111
|
-
* versioned. If the bucket is versioned, you need both the
|
|
112
|
-
*
|
|
113
|
-
* bucket is not versioned, you need the
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
110
|
+
* <p>The permissions that you need to use this operation depend on whether the
|
|
111
|
+
* bucket is versioned. If the bucket is versioned, you need both the
|
|
112
|
+
* <code>s3:GetObjectVersion</code> and <code>s3:GetObjectVersionAttributes</code>
|
|
113
|
+
* permissions for this operation. If the bucket is not versioned, you need the
|
|
114
|
+
* <code>s3:GetObject</code> and <code>s3:GetObjectAttributes</code> permissions.
|
|
115
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in
|
|
116
|
+
* a Policy</a> in the <i>Amazon S3 User Guide</i>. If the object
|
|
117
|
+
* that you request does not exist, the error Amazon S3 returns depends on whether you
|
|
118
|
+
* also have the <code>s3:ListBucket</code> permission.</p>
|
|
118
119
|
* <ul>
|
|
119
120
|
* <li>
|
|
120
|
-
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
|
|
121
|
-
* an HTTP status code <code>404 Not Found</code> ("no such key")
|
|
121
|
+
* <p>If you have the <code>s3:ListBucket</code> permission on the bucket, Amazon S3
|
|
122
|
+
* returns an HTTP status code <code>404 Not Found</code> ("no such key")
|
|
123
|
+
* error.</p>
|
|
122
124
|
* </li>
|
|
123
125
|
* <li>
|
|
124
|
-
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns
|
|
125
|
-
* status code <code>403 Forbidden</code> ("access denied")
|
|
126
|
+
* <p>If you don't have the <code>s3:ListBucket</code> permission, Amazon S3 returns
|
|
127
|
+
* an HTTP status code <code>403 Forbidden</code> ("access denied")
|
|
128
|
+
* error.</p>
|
|
126
129
|
* </li>
|
|
127
130
|
* </ul>
|
|
128
131
|
* </dd>
|