@aws-sdk/client-s3 3.325.0 → 3.326.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/AbortMultipartUploadCommand.d.ts +6 -0
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +19 -0
- package/dist-types/commands/CopyObjectCommand.d.ts +23 -0
- package/dist-types/commands/CreateBucketCommand.d.ts +6 -0
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +18 -0
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +4 -0
- package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/DeleteObjectCommand.d.ts +18 -10
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +17 -11
- package/dist-types/commands/DeleteObjectsCommand.d.ts +22 -0
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +4 -0
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/GetBucketAclCommand.d.ts +21 -0
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +37 -0
- package/dist-types/commands/GetBucketCorsCommand.d.ts +23 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +16 -0
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +31 -0
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +33 -0
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +58 -0
- package/dist-types/commands/GetBucketLocationCommand.d.ts +6 -0
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +21 -0
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +26 -0
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +63 -0
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +12 -0
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +6 -0
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +8 -0
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +6 -0
- package/dist-types/commands/GetBucketTaggingCommand.d.ts +11 -0
- package/dist-types/commands/GetBucketVersioningCommand.d.ts +7 -0
- package/dist-types/commands/GetBucketWebsiteCommand.d.ts +30 -0
- package/dist-types/commands/GetObjectAclCommand.d.ts +22 -0
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +35 -0
- package/dist-types/commands/GetObjectCommand.d.ts +43 -0
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +15 -0
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +9 -0
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +12 -0
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +7 -0
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +11 -0
- package/dist-types/commands/HeadBucketCommand.d.ts +4 -0
- package/dist-types/commands/HeadObjectCommand.d.ts +41 -0
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +42 -0
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +36 -0
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +38 -0
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +31 -0
- package/dist-types/commands/ListBucketsCommand.d.ts +15 -31
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +37 -0
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +50 -0
- package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
- package/dist-types/commands/ListObjectsV2Command.d.ts +38 -2
- package/dist-types/commands/ListPartsCommand.d.ts +37 -0
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketAclCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketCorsCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +4 -0
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/PutObjectAclCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectCommand.d.ts +68 -49
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +6 -0
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +4 -0
- package/dist-types/commands/RestoreObjectCommand.d.ts +7 -0
- package/dist-types/commands/SelectObjectContentCommand.d.ts +26 -0
- package/dist-types/commands/UploadPartCommand.d.ts +16 -0
- package/dist-types/commands/UploadPartCopyCommand.d.ts +33 -13
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +4 -0
- package/package.json +5 -5
|
@@ -73,6 +73,10 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
|
|
|
73
73
|
* };
|
|
74
74
|
* const command = new AbortMultipartUploadCommand(input);
|
|
75
75
|
* const response = await client.send(command);
|
|
76
|
+
* // { // AbortMultipartUploadOutput
|
|
77
|
+
* // RequestCharged: "requester",
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
76
80
|
* ```
|
|
77
81
|
*
|
|
78
82
|
* @param AbortMultipartUploadCommandInput - {@link AbortMultipartUploadCommandInput}
|
|
@@ -84,6 +88,8 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
|
|
|
84
88
|
* @throws {@link NoSuchUpload} (client fault)
|
|
85
89
|
* <p>The specified multipart upload does not exist.</p>
|
|
86
90
|
*
|
|
91
|
+
* @throws {@link S3ServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
87
93
|
*
|
|
88
94
|
* @example To abort a multipart upload
|
|
89
95
|
* ```javascript
|
|
@@ -164,6 +164,23 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
|
|
|
164
164
|
* };
|
|
165
165
|
* const command = new CompleteMultipartUploadCommand(input);
|
|
166
166
|
* const response = await client.send(command);
|
|
167
|
+
* // { // CompleteMultipartUploadOutput
|
|
168
|
+
* // Location: "STRING_VALUE",
|
|
169
|
+
* // Bucket: "STRING_VALUE",
|
|
170
|
+
* // Key: "STRING_VALUE",
|
|
171
|
+
* // Expiration: "STRING_VALUE",
|
|
172
|
+
* // ETag: "STRING_VALUE",
|
|
173
|
+
* // ChecksumCRC32: "STRING_VALUE",
|
|
174
|
+
* // ChecksumCRC32C: "STRING_VALUE",
|
|
175
|
+
* // ChecksumSHA1: "STRING_VALUE",
|
|
176
|
+
* // ChecksumSHA256: "STRING_VALUE",
|
|
177
|
+
* // ServerSideEncryption: "AES256" || "aws:kms",
|
|
178
|
+
* // VersionId: "STRING_VALUE",
|
|
179
|
+
* // SSEKMSKeyId: "STRING_VALUE",
|
|
180
|
+
* // BucketKeyEnabled: true || false,
|
|
181
|
+
* // RequestCharged: "requester",
|
|
182
|
+
* // };
|
|
183
|
+
*
|
|
167
184
|
* ```
|
|
168
185
|
*
|
|
169
186
|
* @param CompleteMultipartUploadCommandInput - {@link CompleteMultipartUploadCommandInput}
|
|
@@ -172,6 +189,8 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
|
|
|
172
189
|
* @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape.
|
|
173
190
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
174
191
|
*
|
|
192
|
+
* @throws {@link S3ServiceException}
|
|
193
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
175
194
|
*
|
|
176
195
|
* @example To complete multipart upload
|
|
177
196
|
* ```javascript
|
|
@@ -256,6 +256,27 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
256
256
|
* };
|
|
257
257
|
* const command = new CopyObjectCommand(input);
|
|
258
258
|
* const response = await client.send(command);
|
|
259
|
+
* // { // CopyObjectOutput
|
|
260
|
+
* // CopyObjectResult: { // CopyObjectResult
|
|
261
|
+
* // ETag: "STRING_VALUE",
|
|
262
|
+
* // LastModified: new Date("TIMESTAMP"),
|
|
263
|
+
* // ChecksumCRC32: "STRING_VALUE",
|
|
264
|
+
* // ChecksumCRC32C: "STRING_VALUE",
|
|
265
|
+
* // ChecksumSHA1: "STRING_VALUE",
|
|
266
|
+
* // ChecksumSHA256: "STRING_VALUE",
|
|
267
|
+
* // },
|
|
268
|
+
* // Expiration: "STRING_VALUE",
|
|
269
|
+
* // CopySourceVersionId: "STRING_VALUE",
|
|
270
|
+
* // VersionId: "STRING_VALUE",
|
|
271
|
+
* // ServerSideEncryption: "AES256" || "aws:kms",
|
|
272
|
+
* // SSECustomerAlgorithm: "STRING_VALUE",
|
|
273
|
+
* // SSECustomerKeyMD5: "STRING_VALUE",
|
|
274
|
+
* // SSEKMSKeyId: "STRING_VALUE",
|
|
275
|
+
* // SSEKMSEncryptionContext: "STRING_VALUE",
|
|
276
|
+
* // BucketKeyEnabled: true || false,
|
|
277
|
+
* // RequestCharged: "requester",
|
|
278
|
+
* // };
|
|
279
|
+
*
|
|
259
280
|
* ```
|
|
260
281
|
*
|
|
261
282
|
* @param CopyObjectCommandInput - {@link CopyObjectCommandInput}
|
|
@@ -268,6 +289,8 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
|
|
|
268
289
|
* <p>The source object of the COPY action is not in the active tier and is only stored in
|
|
269
290
|
* Amazon S3 Glacier.</p>
|
|
270
291
|
*
|
|
292
|
+
* @throws {@link S3ServiceException}
|
|
293
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
271
294
|
*
|
|
272
295
|
* @example To copy an object
|
|
273
296
|
* ```javascript
|
|
@@ -187,6 +187,10 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
|
|
|
187
187
|
* };
|
|
188
188
|
* const command = new CreateBucketCommand(input);
|
|
189
189
|
* const response = await client.send(command);
|
|
190
|
+
* // { // CreateBucketOutput
|
|
191
|
+
* // Location: "STRING_VALUE",
|
|
192
|
+
* // };
|
|
193
|
+
*
|
|
190
194
|
* ```
|
|
191
195
|
*
|
|
192
196
|
* @param CreateBucketCommandInput - {@link CreateBucketCommandInput}
|
|
@@ -205,6 +209,8 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
|
|
|
205
209
|
* re-create an existing bucket that you already own in the North Virginia Region, Amazon S3
|
|
206
210
|
* returns 200 OK and resets the bucket access control lists (ACLs).</p>
|
|
207
211
|
*
|
|
212
|
+
* @throws {@link S3ServiceException}
|
|
213
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
208
214
|
*
|
|
209
215
|
* @example To create a bucket in a specific region
|
|
210
216
|
* ```javascript
|
|
@@ -329,6 +329,22 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
|
|
|
329
329
|
* };
|
|
330
330
|
* const command = new CreateMultipartUploadCommand(input);
|
|
331
331
|
* const response = await client.send(command);
|
|
332
|
+
* // { // CreateMultipartUploadOutput
|
|
333
|
+
* // AbortDate: new Date("TIMESTAMP"),
|
|
334
|
+
* // AbortRuleId: "STRING_VALUE",
|
|
335
|
+
* // Bucket: "STRING_VALUE",
|
|
336
|
+
* // Key: "STRING_VALUE",
|
|
337
|
+
* // UploadId: "STRING_VALUE",
|
|
338
|
+
* // ServerSideEncryption: "AES256" || "aws:kms",
|
|
339
|
+
* // SSECustomerAlgorithm: "STRING_VALUE",
|
|
340
|
+
* // SSECustomerKeyMD5: "STRING_VALUE",
|
|
341
|
+
* // SSEKMSKeyId: "STRING_VALUE",
|
|
342
|
+
* // SSEKMSEncryptionContext: "STRING_VALUE",
|
|
343
|
+
* // BucketKeyEnabled: true || false,
|
|
344
|
+
* // RequestCharged: "requester",
|
|
345
|
+
* // ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256",
|
|
346
|
+
* // };
|
|
347
|
+
*
|
|
332
348
|
* ```
|
|
333
349
|
*
|
|
334
350
|
* @param CreateMultipartUploadCommandInput - {@link CreateMultipartUploadCommandInput}
|
|
@@ -337,6 +353,8 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
|
|
|
337
353
|
* @see {@link CreateMultipartUploadCommandOutput} for command's `response` shape.
|
|
338
354
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
339
355
|
*
|
|
356
|
+
* @throws {@link S3ServiceException}
|
|
357
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
340
358
|
*
|
|
341
359
|
* @example To initiate a multipart upload
|
|
342
360
|
* ```javascript
|
|
@@ -60,6 +60,8 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad
|
|
|
60
60
|
* };
|
|
61
61
|
* const command = new DeleteBucketAnalyticsConfigurationCommand(input);
|
|
62
62
|
* const response = await client.send(command);
|
|
63
|
+
* // {};
|
|
64
|
+
*
|
|
63
65
|
* ```
|
|
64
66
|
*
|
|
65
67
|
* @param DeleteBucketAnalyticsConfigurationCommandInput - {@link DeleteBucketAnalyticsConfigurationCommandInput}
|
|
@@ -68,6 +70,8 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad
|
|
|
68
70
|
* @see {@link DeleteBucketAnalyticsConfigurationCommandOutput} for command's `response` shape.
|
|
69
71
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
70
72
|
*
|
|
73
|
+
* @throws {@link S3ServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
71
75
|
*
|
|
72
76
|
*/
|
|
73
77
|
export declare class DeleteBucketAnalyticsConfigurationCommand extends $Command<DeleteBucketAnalyticsConfigurationCommandInput, DeleteBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -48,6 +48,8 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new DeleteBucketCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
51
53
|
* ```
|
|
52
54
|
*
|
|
53
55
|
* @param DeleteBucketCommandInput - {@link DeleteBucketCommandInput}
|
|
@@ -56,6 +58,8 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
|
|
|
56
58
|
* @see {@link DeleteBucketCommandOutput} for command's `response` shape.
|
|
57
59
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
58
60
|
*
|
|
61
|
+
* @throws {@link S3ServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
59
63
|
*
|
|
60
64
|
* @example To delete a bucket
|
|
61
65
|
* ```javascript
|
|
@@ -52,6 +52,8 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
52
52
|
* };
|
|
53
53
|
* const command = new DeleteBucketCorsCommand(input);
|
|
54
54
|
* const response = await client.send(command);
|
|
55
|
+
* // {};
|
|
56
|
+
*
|
|
55
57
|
* ```
|
|
56
58
|
*
|
|
57
59
|
* @param DeleteBucketCorsCommandInput - {@link DeleteBucketCorsCommandInput}
|
|
@@ -60,6 +62,8 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
60
62
|
* @see {@link DeleteBucketCorsCommandOutput} for command's `response` shape.
|
|
61
63
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
62
64
|
*
|
|
65
|
+
* @throws {@link S3ServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
63
67
|
*
|
|
64
68
|
* @example To delete cors configuration on a bucket.
|
|
65
69
|
* ```javascript
|
|
@@ -54,6 +54,8 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
54
54
|
* };
|
|
55
55
|
* const command = new DeleteBucketEncryptionCommand(input);
|
|
56
56
|
* const response = await client.send(command);
|
|
57
|
+
* // {};
|
|
58
|
+
*
|
|
57
59
|
* ```
|
|
58
60
|
*
|
|
59
61
|
* @param DeleteBucketEncryptionCommandInput - {@link DeleteBucketEncryptionCommandInput}
|
|
@@ -62,6 +64,8 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
62
64
|
* @see {@link DeleteBucketEncryptionCommandOutput} for command's `response` shape.
|
|
63
65
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
64
66
|
*
|
|
67
|
+
* @throws {@link S3ServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
65
69
|
*
|
|
66
70
|
*/
|
|
67
71
|
export declare class DeleteBucketEncryptionCommand extends $Command<DeleteBucketEncryptionCommandInput, DeleteBucketEncryptionCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -54,6 +54,8 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
|
|
|
54
54
|
* };
|
|
55
55
|
* const command = new DeleteBucketIntelligentTieringConfigurationCommand(input);
|
|
56
56
|
* const response = await client.send(command);
|
|
57
|
+
* // {};
|
|
58
|
+
*
|
|
57
59
|
* ```
|
|
58
60
|
*
|
|
59
61
|
* @param DeleteBucketIntelligentTieringConfigurationCommandInput - {@link DeleteBucketIntelligentTieringConfigurationCommandInput}
|
|
@@ -62,6 +64,8 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
|
|
|
62
64
|
* @see {@link DeleteBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
|
|
63
65
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
64
66
|
*
|
|
67
|
+
* @throws {@link S3ServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
65
69
|
*
|
|
66
70
|
*/
|
|
67
71
|
export declare class DeleteBucketIntelligentTieringConfigurationCommand extends $Command<DeleteBucketIntelligentTieringConfigurationCommandInput, DeleteBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -58,6 +58,8 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
|
|
|
58
58
|
* };
|
|
59
59
|
* const command = new DeleteBucketInventoryConfigurationCommand(input);
|
|
60
60
|
* const response = await client.send(command);
|
|
61
|
+
* // {};
|
|
62
|
+
*
|
|
61
63
|
* ```
|
|
62
64
|
*
|
|
63
65
|
* @param DeleteBucketInventoryConfigurationCommandInput - {@link DeleteBucketInventoryConfigurationCommandInput}
|
|
@@ -66,6 +68,8 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
|
|
|
66
68
|
* @see {@link DeleteBucketInventoryConfigurationCommandOutput} for command's `response` shape.
|
|
67
69
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
68
70
|
*
|
|
71
|
+
* @throws {@link S3ServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
69
73
|
*
|
|
70
74
|
*/
|
|
71
75
|
export declare class DeleteBucketInventoryConfigurationCommand extends $Command<DeleteBucketInventoryConfigurationCommandInput, DeleteBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -55,6 +55,8 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new DeleteBucketLifecycleCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // {};
|
|
59
|
+
*
|
|
58
60
|
* ```
|
|
59
61
|
*
|
|
60
62
|
* @param DeleteBucketLifecycleCommandInput - {@link DeleteBucketLifecycleCommandInput}
|
|
@@ -63,6 +65,8 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
|
|
|
63
65
|
* @see {@link DeleteBucketLifecycleCommandOutput} for command's `response` shape.
|
|
64
66
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
67
|
*
|
|
68
|
+
* @throws {@link S3ServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
70
|
*
|
|
67
71
|
* @example To delete lifecycle configuration on a bucket.
|
|
68
72
|
* ```javascript
|
|
@@ -66,6 +66,8 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
|
|
|
66
66
|
* };
|
|
67
67
|
* const command = new DeleteBucketMetricsConfigurationCommand(input);
|
|
68
68
|
* const response = await client.send(command);
|
|
69
|
+
* // {};
|
|
70
|
+
*
|
|
69
71
|
* ```
|
|
70
72
|
*
|
|
71
73
|
* @param DeleteBucketMetricsConfigurationCommandInput - {@link DeleteBucketMetricsConfigurationCommandInput}
|
|
@@ -74,6 +76,8 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
|
|
|
74
76
|
* @see {@link DeleteBucketMetricsConfigurationCommandOutput} for command's `response` shape.
|
|
75
77
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
76
78
|
*
|
|
79
|
+
* @throws {@link S3ServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
77
81
|
*
|
|
78
82
|
*/
|
|
79
83
|
export declare class DeleteBucketMetricsConfigurationCommand extends $Command<DeleteBucketMetricsConfigurationCommandInput, DeleteBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -50,6 +50,8 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
|
|
|
50
50
|
* };
|
|
51
51
|
* const command = new DeleteBucketOwnershipControlsCommand(input);
|
|
52
52
|
* const response = await client.send(command);
|
|
53
|
+
* // {};
|
|
54
|
+
*
|
|
53
55
|
* ```
|
|
54
56
|
*
|
|
55
57
|
* @param DeleteBucketOwnershipControlsCommandInput - {@link DeleteBucketOwnershipControlsCommandInput}
|
|
@@ -58,6 +60,8 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
|
|
|
58
60
|
* @see {@link DeleteBucketOwnershipControlsCommandOutput} for command's `response` shape.
|
|
59
61
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
60
62
|
*
|
|
63
|
+
* @throws {@link S3ServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
61
65
|
*
|
|
62
66
|
*/
|
|
63
67
|
export declare class DeleteBucketOwnershipControlsCommand extends $Command<DeleteBucketOwnershipControlsCommandInput, DeleteBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -61,6 +61,8 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
61
61
|
* };
|
|
62
62
|
* const command = new DeleteBucketPolicyCommand(input);
|
|
63
63
|
* const response = await client.send(command);
|
|
64
|
+
* // {};
|
|
65
|
+
*
|
|
64
66
|
* ```
|
|
65
67
|
*
|
|
66
68
|
* @param DeleteBucketPolicyCommandInput - {@link DeleteBucketPolicyCommandInput}
|
|
@@ -69,6 +71,8 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
69
71
|
* @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape.
|
|
70
72
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
71
73
|
*
|
|
74
|
+
* @throws {@link S3ServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
72
76
|
*
|
|
73
77
|
* @example To delete bucket policy
|
|
74
78
|
* ```javascript
|
|
@@ -55,6 +55,8 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new DeleteBucketReplicationCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // {};
|
|
59
|
+
*
|
|
58
60
|
* ```
|
|
59
61
|
*
|
|
60
62
|
* @param DeleteBucketReplicationCommandInput - {@link DeleteBucketReplicationCommandInput}
|
|
@@ -63,6 +65,8 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
63
65
|
* @see {@link DeleteBucketReplicationCommandOutput} for command's `response` shape.
|
|
64
66
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
67
|
*
|
|
68
|
+
* @throws {@link S3ServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
70
|
*
|
|
67
71
|
* @example To delete bucket replication configuration
|
|
68
72
|
* ```javascript
|
|
@@ -48,6 +48,8 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new DeleteBucketTaggingCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // {};
|
|
52
|
+
*
|
|
51
53
|
* ```
|
|
52
54
|
*
|
|
53
55
|
* @param DeleteBucketTaggingCommandInput - {@link DeleteBucketTaggingCommandInput}
|
|
@@ -56,6 +58,8 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
|
|
|
56
58
|
* @see {@link DeleteBucketTaggingCommandOutput} for command's `response` shape.
|
|
57
59
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
58
60
|
*
|
|
61
|
+
* @throws {@link S3ServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
59
63
|
*
|
|
60
64
|
* @example To delete bucket tags
|
|
61
65
|
* ```javascript
|
|
@@ -55,6 +55,8 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new DeleteBucketWebsiteCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // {};
|
|
59
|
+
*
|
|
58
60
|
* ```
|
|
59
61
|
*
|
|
60
62
|
* @param DeleteBucketWebsiteCommandInput - {@link DeleteBucketWebsiteCommandInput}
|
|
@@ -63,6 +65,8 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {
|
|
|
63
65
|
* @see {@link DeleteBucketWebsiteCommandOutput} for command's `response` shape.
|
|
64
66
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
67
|
*
|
|
68
|
+
* @throws {@link S3ServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
70
|
*
|
|
67
71
|
* @example To delete bucket website configuration
|
|
68
72
|
* ```javascript
|
|
@@ -62,6 +62,12 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
|
|
|
62
62
|
* };
|
|
63
63
|
* const command = new DeleteObjectCommand(input);
|
|
64
64
|
* const response = await client.send(command);
|
|
65
|
+
* // { // DeleteObjectOutput
|
|
66
|
+
* // DeleteMarker: true || false,
|
|
67
|
+
* // VersionId: "STRING_VALUE",
|
|
68
|
+
* // RequestCharged: "requester",
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
65
71
|
* ```
|
|
66
72
|
*
|
|
67
73
|
* @param DeleteObjectCommandInput - {@link DeleteObjectCommandInput}
|
|
@@ -70,29 +76,31 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
|
|
|
70
76
|
* @see {@link DeleteObjectCommandOutput} for command's `response` shape.
|
|
71
77
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
72
78
|
*
|
|
79
|
+
* @throws {@link S3ServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
73
81
|
*
|
|
74
|
-
* @example To delete an object
|
|
82
|
+
* @example To delete an object
|
|
75
83
|
* ```javascript
|
|
76
|
-
* // The following example deletes an object from
|
|
84
|
+
* // The following example deletes an object from an S3 bucket.
|
|
77
85
|
* const input = {
|
|
78
|
-
* "Bucket": "
|
|
79
|
-
* "Key": "
|
|
86
|
+
* "Bucket": "examplebucket",
|
|
87
|
+
* "Key": "objectkey.jpg"
|
|
80
88
|
* };
|
|
81
89
|
* const command = new DeleteObjectCommand(input);
|
|
82
90
|
* await client.send(command);
|
|
83
|
-
* // example id: to-delete-an-object-
|
|
91
|
+
* // example id: to-delete-an-object-1472850136595
|
|
84
92
|
* ```
|
|
85
93
|
*
|
|
86
|
-
* @example To delete an object
|
|
94
|
+
* @example To delete an object (from a non-versioned bucket)
|
|
87
95
|
* ```javascript
|
|
88
|
-
* // The following example deletes an object from
|
|
96
|
+
* // The following example deletes an object from a non-versioned bucket.
|
|
89
97
|
* const input = {
|
|
90
|
-
* "Bucket": "
|
|
91
|
-
* "Key": "
|
|
98
|
+
* "Bucket": "ExampleBucket",
|
|
99
|
+
* "Key": "HappyFace.jpg"
|
|
92
100
|
* };
|
|
93
101
|
* const command = new DeleteObjectCommand(input);
|
|
94
102
|
* await client.send(command);
|
|
95
|
-
* // example id: to-delete-an-object-
|
|
103
|
+
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
|
|
96
104
|
* ```
|
|
97
105
|
*
|
|
98
106
|
*/
|
|
@@ -55,6 +55,10 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new DeleteObjectTaggingCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // DeleteObjectTaggingOutput
|
|
59
|
+
* // VersionId: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
58
62
|
* ```
|
|
59
63
|
*
|
|
60
64
|
* @param DeleteObjectTaggingCommandInput - {@link DeleteObjectTaggingCommandInput}
|
|
@@ -63,40 +67,42 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
|
|
|
63
67
|
* @see {@link DeleteObjectTaggingCommandOutput} for command's `response` shape.
|
|
64
68
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
69
|
*
|
|
70
|
+
* @throws {@link S3ServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
72
|
*
|
|
67
|
-
* @example To remove tag set from an object
|
|
73
|
+
* @example To remove tag set from an object
|
|
68
74
|
* ```javascript
|
|
69
|
-
* // The following example removes tag set associated with the specified object
|
|
75
|
+
* // The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
|
|
70
76
|
* const input = {
|
|
71
77
|
* "Bucket": "examplebucket",
|
|
72
|
-
* "Key": "HappyFace.jpg"
|
|
73
|
-
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
78
|
+
* "Key": "HappyFace.jpg"
|
|
74
79
|
* };
|
|
75
80
|
* const command = new DeleteObjectTaggingCommand(input);
|
|
76
81
|
* const response = await client.send(command);
|
|
77
82
|
* /* response ==
|
|
78
83
|
* {
|
|
79
|
-
* "VersionId": "
|
|
84
|
+
* "VersionId": "null"
|
|
80
85
|
* }
|
|
81
86
|
* *\/
|
|
82
|
-
* // example id: to-remove-tag-set-from-an-object-
|
|
87
|
+
* // example id: to-remove-tag-set-from-an-object-1483145342862
|
|
83
88
|
* ```
|
|
84
89
|
*
|
|
85
|
-
* @example To remove tag set from an object
|
|
90
|
+
* @example To remove tag set from an object version
|
|
86
91
|
* ```javascript
|
|
87
|
-
* // The following example removes tag set associated with the specified object.
|
|
92
|
+
* // The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
|
|
88
93
|
* const input = {
|
|
89
94
|
* "Bucket": "examplebucket",
|
|
90
|
-
* "Key": "HappyFace.jpg"
|
|
95
|
+
* "Key": "HappyFace.jpg",
|
|
96
|
+
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
91
97
|
* };
|
|
92
98
|
* const command = new DeleteObjectTaggingCommand(input);
|
|
93
99
|
* const response = await client.send(command);
|
|
94
100
|
* /* response ==
|
|
95
101
|
* {
|
|
96
|
-
* "VersionId": "
|
|
102
|
+
* "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
|
|
97
103
|
* }
|
|
98
104
|
* *\/
|
|
99
|
-
* // example id: to-remove-tag-set-from-an-object-
|
|
105
|
+
* // example id: to-remove-tag-set-from-an-object-version-1483145285913
|
|
100
106
|
* ```
|
|
101
107
|
*
|
|
102
108
|
*/
|
|
@@ -96,6 +96,26 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
96
96
|
* };
|
|
97
97
|
* const command = new DeleteObjectsCommand(input);
|
|
98
98
|
* const response = await client.send(command);
|
|
99
|
+
* // { // DeleteObjectsOutput
|
|
100
|
+
* // Deleted: [ // DeletedObjects
|
|
101
|
+
* // { // DeletedObject
|
|
102
|
+
* // Key: "STRING_VALUE",
|
|
103
|
+
* // VersionId: "STRING_VALUE",
|
|
104
|
+
* // DeleteMarker: true || false,
|
|
105
|
+
* // DeleteMarkerVersionId: "STRING_VALUE",
|
|
106
|
+
* // },
|
|
107
|
+
* // ],
|
|
108
|
+
* // RequestCharged: "requester",
|
|
109
|
+
* // Errors: [ // Errors
|
|
110
|
+
* // { // Error
|
|
111
|
+
* // Key: "STRING_VALUE",
|
|
112
|
+
* // VersionId: "STRING_VALUE",
|
|
113
|
+
* // Code: "STRING_VALUE",
|
|
114
|
+
* // Message: "STRING_VALUE",
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // };
|
|
118
|
+
*
|
|
99
119
|
* ```
|
|
100
120
|
*
|
|
101
121
|
* @param DeleteObjectsCommandInput - {@link DeleteObjectsCommandInput}
|
|
@@ -104,6 +124,8 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
104
124
|
* @see {@link DeleteObjectsCommandOutput} for command's `response` shape.
|
|
105
125
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
106
126
|
*
|
|
127
|
+
* @throws {@link S3ServiceException}
|
|
128
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
107
129
|
*
|
|
108
130
|
* @example To delete multiple objects from a versioned bucket
|
|
109
131
|
* ```javascript
|
|
@@ -59,6 +59,8 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer {
|
|
|
59
59
|
* };
|
|
60
60
|
* const command = new DeletePublicAccessBlockCommand(input);
|
|
61
61
|
* const response = await client.send(command);
|
|
62
|
+
* // {};
|
|
63
|
+
*
|
|
62
64
|
* ```
|
|
63
65
|
*
|
|
64
66
|
* @param DeletePublicAccessBlockCommandInput - {@link DeletePublicAccessBlockCommandInput}
|
|
@@ -67,6 +69,8 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer {
|
|
|
67
69
|
* @see {@link DeletePublicAccessBlockCommandOutput} for command's `response` shape.
|
|
68
70
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
69
71
|
*
|
|
72
|
+
* @throws {@link S3ServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
70
74
|
*
|
|
71
75
|
*/
|
|
72
76
|
export declare class DeletePublicAccessBlockCommand extends $Command<DeletePublicAccessBlockCommandInput, DeletePublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -57,6 +57,10 @@ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucket
|
|
|
57
57
|
* };
|
|
58
58
|
* const command = new GetBucketAccelerateConfigurationCommand(input);
|
|
59
59
|
* const response = await client.send(command);
|
|
60
|
+
* // { // GetBucketAccelerateConfigurationOutput
|
|
61
|
+
* // Status: "Enabled" || "Suspended",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
60
64
|
* ```
|
|
61
65
|
*
|
|
62
66
|
* @param GetBucketAccelerateConfigurationCommandInput - {@link GetBucketAccelerateConfigurationCommandInput}
|
|
@@ -65,6 +69,8 @@ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucket
|
|
|
65
69
|
* @see {@link GetBucketAccelerateConfigurationCommandOutput} for command's `response` shape.
|
|
66
70
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
67
71
|
*
|
|
72
|
+
* @throws {@link S3ServiceException}
|
|
73
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
68
74
|
*
|
|
69
75
|
*/
|
|
70
76
|
export declare class GetBucketAccelerateConfigurationCommand extends $Command<GetBucketAccelerateConfigurationCommandInput, GetBucketAccelerateConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -53,6 +53,25 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat
|
|
|
53
53
|
* };
|
|
54
54
|
* const command = new GetBucketAclCommand(input);
|
|
55
55
|
* const response = await client.send(command);
|
|
56
|
+
* // { // GetBucketAclOutput
|
|
57
|
+
* // Owner: { // Owner
|
|
58
|
+
* // DisplayName: "STRING_VALUE",
|
|
59
|
+
* // ID: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // Grants: [ // Grants
|
|
62
|
+
* // { // Grant
|
|
63
|
+
* // Grantee: { // Grantee
|
|
64
|
+
* // DisplayName: "STRING_VALUE",
|
|
65
|
+
* // EmailAddress: "STRING_VALUE",
|
|
66
|
+
* // ID: "STRING_VALUE",
|
|
67
|
+
* // URI: "STRING_VALUE",
|
|
68
|
+
* // Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required
|
|
69
|
+
* // },
|
|
70
|
+
* // Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
56
75
|
* ```
|
|
57
76
|
*
|
|
58
77
|
* @param GetBucketAclCommandInput - {@link GetBucketAclCommandInput}
|
|
@@ -61,6 +80,8 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat
|
|
|
61
80
|
* @see {@link GetBucketAclCommandOutput} for command's `response` shape.
|
|
62
81
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
63
82
|
*
|
|
83
|
+
* @throws {@link S3ServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
64
85
|
*
|
|
65
86
|
*/
|
|
66
87
|
export declare class GetBucketAclCommand extends $Command<GetBucketAclCommandInput, GetBucketAclCommandOutput, S3ClientResolvedConfig> {
|