@aws-sdk/client-s3 3.325.0 → 3.327.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 +8 -2
- package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +41 -14
- package/dist-types/commands/CopyObjectCommand.d.ts +194 -144
- package/dist-types/commands/CreateBucketCommand.d.ts +134 -118
- package/dist-types/commands/CreateMultipartUploadCommand.d.ts +91 -48
- package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketCommand.d.ts +5 -3
- package/dist-types/commands/DeleteBucketCorsCommand.d.ts +7 -5
- package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +12 -8
- package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +5 -2
- package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +5 -2
- package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +9 -5
- package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +6 -2
- package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +10 -3
- package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +8 -3
- 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 +19 -11
- package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +8 -4
- package/dist-types/commands/DeleteObjectsCommand.d.ts +57 -36
- package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +6 -2
- package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +12 -7
- package/dist-types/commands/GetBucketAclCommand.d.ts +35 -10
- package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +43 -7
- package/dist-types/commands/GetBucketCorsCommand.d.ts +28 -0
- package/dist-types/commands/GetBucketEncryptionCommand.d.ts +23 -7
- package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +32 -2
- package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +35 -2
- package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +62 -4
- package/dist-types/commands/GetBucketLocationCommand.d.ts +16 -2
- package/dist-types/commands/GetBucketLoggingCommand.d.ts +22 -1
- package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +31 -6
- package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +70 -2
- package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +16 -3
- package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -3
- package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +9 -1
- package/dist-types/commands/GetBucketReplicationCommand.d.ts +69 -0
- package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +8 -1
- 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 +32 -3
- package/dist-types/commands/GetObjectAclCommand.d.ts +27 -7
- package/dist-types/commands/GetObjectAttributesCommand.d.ts +77 -45
- package/dist-types/commands/GetObjectCommand.d.ts +159 -112
- package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +8 -0
- package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +16 -2
- package/dist-types/commands/GetObjectRetentionCommand.d.ts +11 -1
- package/dist-types/commands/GetObjectTaggingCommand.d.ts +17 -5
- package/dist-types/commands/GetObjectTorrentCommand.d.ts +8 -1
- package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +12 -1
- package/dist-types/commands/HeadBucketCommand.d.ts +23 -9
- package/dist-types/commands/HeadObjectCommand.d.ts +77 -33
- package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +46 -4
- package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +37 -2
- package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +43 -5
- package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +37 -7
- package/dist-types/commands/ListBucketsCommand.d.ts +18 -32
- package/dist-types/commands/ListMultipartUploadsCommand.d.ts +39 -2
- package/dist-types/commands/ListObjectVersionsCommand.d.ts +53 -6
- package/dist-types/commands/ListObjectsCommand.d.ts +34 -0
- package/dist-types/commands/ListObjectsV2Command.d.ts +47 -12
- package/dist-types/commands/ListPartsCommand.d.ts +40 -4
- package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +8 -3
- package/dist-types/commands/PutBucketAclCommand.d.ts +118 -111
- package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +11 -10
- package/dist-types/commands/PutBucketCorsCommand.d.ts +7 -5
- package/dist-types/commands/PutBucketEncryptionCommand.d.ts +21 -17
- package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +35 -59
- package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +54 -65
- package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +68 -62
- package/dist-types/commands/PutBucketLoggingCommand.d.ts +49 -39
- package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +8 -4
- package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +13 -12
- package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +8 -2
- package/dist-types/commands/PutBucketPolicyCommand.d.ts +12 -4
- package/dist-types/commands/PutBucketReplicationCommand.d.ts +35 -28
- package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +5 -1
- package/dist-types/commands/PutBucketTaggingCommand.d.ts +16 -12
- package/dist-types/commands/PutBucketVersioningCommand.d.ts +11 -9
- package/dist-types/commands/PutBucketWebsiteCommand.d.ts +4 -0
- package/dist-types/commands/PutObjectAclCommand.d.ts +129 -119
- package/dist-types/commands/PutObjectCommand.d.ts +94 -84
- package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +6 -0
- package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +13 -8
- package/dist-types/commands/PutObjectRetentionCommand.d.ts +9 -4
- package/dist-types/commands/PutObjectTaggingCommand.d.ts +13 -9
- package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +6 -4
- package/dist-types/commands/RestoreObjectCommand.d.ts +182 -199
- package/dist-types/commands/SelectObjectContentCommand.d.ts +109 -90
- package/dist-types/commands/UploadPartCommand.d.ts +42 -22
- package/dist-types/commands/UploadPartCopyCommand.d.ts +85 -63
- package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +36 -21
- package/dist-types/models/models_0.d.ts +468 -382
- package/dist-types/models/models_1.d.ts +82 -80
- package/package.json +9 -9
|
@@ -23,11 +23,9 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
* <p>To use this operation, you must have permission to perform the
|
|
24
24
|
* <code>s3:PutBucketCORS</code> action. The bucket owner has this permission by default
|
|
25
25
|
* and can grant this permission to others. </p>
|
|
26
|
-
* <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling
|
|
27
|
-
*
|
|
28
|
-
* <p
|
|
29
|
-
* <b>Related Resources:</b>
|
|
30
|
-
* </p>
|
|
26
|
+
* <p>For information about <code>cors</code>, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html">Enabling Cross-Origin Resource Sharing</a> in
|
|
27
|
+
* the <i>Amazon S3 User Guide</i>.</p>
|
|
28
|
+
* <p>The following operations are related to <code>DeleteBucketCors</code>:</p>
|
|
31
29
|
* <ul>
|
|
32
30
|
* <li>
|
|
33
31
|
* <p>
|
|
@@ -52,6 +50,8 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
52
50
|
* };
|
|
53
51
|
* const command = new DeleteBucketCorsCommand(input);
|
|
54
52
|
* const response = await client.send(command);
|
|
53
|
+
* // {};
|
|
54
|
+
*
|
|
55
55
|
* ```
|
|
56
56
|
*
|
|
57
57
|
* @param DeleteBucketCorsCommandInput - {@link DeleteBucketCorsCommandInput}
|
|
@@ -60,6 +60,8 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
|
|
|
60
60
|
* @see {@link DeleteBucketCorsCommandOutput} for command's `response` shape.
|
|
61
61
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
62
62
|
*
|
|
63
|
+
* @throws {@link S3ServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
63
65
|
*
|
|
64
66
|
* @example To delete cors configuration on a bucket.
|
|
65
67
|
* ```javascript
|
|
@@ -19,17 +19,17 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>This implementation of the DELETE action
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>This implementation of the DELETE action resets the default encryption for the
|
|
23
|
+
* bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the
|
|
24
|
+
* bucket default encryption feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html">Amazon S3 Bucket Default Encryption</a>
|
|
25
|
+
* in the <i>Amazon S3 User Guide</i>.</p>
|
|
25
26
|
* <p>To use this operation, you must have permissions to perform the
|
|
26
27
|
* <code>s3:PutEncryptionConfiguration</code> action. The bucket owner has this permission
|
|
27
28
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
28
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* </p>
|
|
29
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
30
|
+
* Access Permissions to your Amazon S3 Resources</a> in the
|
|
31
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
32
|
+
* <p>The following operations are related to <code>DeleteBucketEncryption</code>:</p>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
35
35
|
* <p>
|
|
@@ -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> {
|
|
@@ -23,8 +23,7 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
|
|
|
23
23
|
* <p>The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.</p>
|
|
24
24
|
* <p>The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.</p>
|
|
25
25
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access">Storage class for automatically optimizing frequently and infrequently accessed objects</a>.</p>
|
|
26
|
-
* <p>Operations related to
|
|
27
|
-
* <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p>
|
|
26
|
+
* <p>Operations related to <code>DeleteBucketIntelligentTieringConfiguration</code> include: </p>
|
|
28
27
|
* <ul>
|
|
29
28
|
* <li>
|
|
30
29
|
* <p>
|
|
@@ -54,6 +53,8 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
|
|
|
54
53
|
* };
|
|
55
54
|
* const command = new DeleteBucketIntelligentTieringConfigurationCommand(input);
|
|
56
55
|
* const response = await client.send(command);
|
|
56
|
+
* // {};
|
|
57
|
+
*
|
|
57
58
|
* ```
|
|
58
59
|
*
|
|
59
60
|
* @param DeleteBucketIntelligentTieringConfigurationCommandInput - {@link DeleteBucketIntelligentTieringConfigurationCommandInput}
|
|
@@ -62,6 +63,8 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
|
|
|
62
63
|
* @see {@link DeleteBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
|
|
63
64
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
64
65
|
*
|
|
66
|
+
* @throws {@link S3ServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
65
68
|
*
|
|
66
69
|
*/
|
|
67
70
|
export declare class DeleteBucketIntelligentTieringConfigurationCommand extends $Command<DeleteBucketIntelligentTieringConfigurationCommandInput, DeleteBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
|
|
@@ -24,8 +24,8 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
|
|
|
24
24
|
* <p>To use this operation, you must have permissions to perform the
|
|
25
25
|
* <code>s3:PutInventoryConfiguration</code> action. The bucket owner has this permission
|
|
26
26
|
* by default. The bucket owner can grant this permission to others. For more information
|
|
27
|
-
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
28
|
-
* Resources</a>.</p>
|
|
27
|
+
* about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
28
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
29
29
|
* <p>For information about the Amazon S3 inventory feature, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html">Amazon S3 Inventory</a>.</p>
|
|
30
30
|
* <p>Operations related to <code>DeleteBucketInventoryConfiguration</code> include: </p>
|
|
31
31
|
* <ul>
|
|
@@ -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> {
|
|
@@ -28,8 +28,7 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
|
|
|
28
28
|
* permission and the bucket owner can grant this permission to others.</p>
|
|
29
29
|
* <p>There is usually some time lag before lifecycle configuration deletion is fully
|
|
30
30
|
* propagated to all the Amazon S3 systems.</p>
|
|
31
|
-
* <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to
|
|
32
|
-
* Describe Lifecycle Actions</a>.</p>
|
|
31
|
+
* <p>For more information about the object expiration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions">Elements to Describe Lifecycle Actions</a>.</p>
|
|
33
32
|
* <p>Related actions include:</p>
|
|
34
33
|
* <ul>
|
|
35
34
|
* <li>
|
|
@@ -55,6 +54,8 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
|
|
|
55
54
|
* };
|
|
56
55
|
* const command = new DeleteBucketLifecycleCommand(input);
|
|
57
56
|
* const response = await client.send(command);
|
|
57
|
+
* // {};
|
|
58
|
+
*
|
|
58
59
|
* ```
|
|
59
60
|
*
|
|
60
61
|
* @param DeleteBucketLifecycleCommandInput - {@link DeleteBucketLifecycleCommandInput}
|
|
@@ -63,6 +64,8 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
|
|
|
63
64
|
* @see {@link DeleteBucketLifecycleCommandOutput} for command's `response` shape.
|
|
64
65
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
66
|
*
|
|
67
|
+
* @throws {@link S3ServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
69
|
*
|
|
67
70
|
* @example To delete lifecycle configuration on a bucket.
|
|
68
71
|
* ```javascript
|
|
@@ -25,9 +25,10 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
|
|
|
25
25
|
* <p> To use this operation, you must have permissions to perform the
|
|
26
26
|
* <code>s3:PutMetricsConfiguration</code> action. The bucket owner has this permission by
|
|
27
27
|
* default. The bucket owner can grant this permission to others. For more information about
|
|
28
|
-
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
29
|
-
* Resources</a>.</p>
|
|
30
|
-
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with
|
|
28
|
+
* permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
29
|
+
* Access Permissions to Your Amazon S3 Resources</a>.</p>
|
|
30
|
+
* <p>For information about CloudWatch request metrics for Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with
|
|
31
|
+
* Amazon CloudWatch</a>. </p>
|
|
31
32
|
* <p>The following operations are related to
|
|
32
33
|
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
33
34
|
* <ul>
|
|
@@ -48,8 +49,7 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
|
|
|
48
49
|
* </li>
|
|
49
50
|
* <li>
|
|
50
51
|
* <p>
|
|
51
|
-
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon
|
|
52
|
-
* CloudWatch</a>
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html">Monitoring Metrics with Amazon CloudWatch</a>
|
|
53
53
|
* </p>
|
|
54
54
|
* </li>
|
|
55
55
|
* </ul>
|
|
@@ -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> {
|
|
@@ -21,8 +21,8 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Removes <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you
|
|
23
23
|
* must have the <code>s3:PutBucketOwnershipControls</code> permission. For more information
|
|
24
|
-
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying
|
|
25
|
-
*
|
|
24
|
+
* about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a
|
|
25
|
+
* Policy</a>.</p>
|
|
26
26
|
* <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html">Using Object Ownership</a>. </p>
|
|
27
27
|
* <p>The following operations are related to
|
|
28
28
|
* <code>DeleteBucketOwnershipControls</code>:</p>
|
|
@@ -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> {
|
|
@@ -29,9 +29,12 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not
|
|
30
30
|
* Allowed</code> error. </p>
|
|
31
31
|
* <important>
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
32
|
+
* <p>To ensure that bucket owners don't inadvertently lock themselves out of their own
|
|
33
|
+
* buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
|
|
34
|
+
* <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and
|
|
35
|
+
* <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly
|
|
36
|
+
* denies the root principal's access. Bucket owner root principals can only be blocked from performing
|
|
37
|
+
* these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
|
|
35
38
|
* </important>
|
|
36
39
|
* <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
|
|
37
40
|
* UserPolicies</a>. </p>
|
|
@@ -61,6 +64,8 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
61
64
|
* };
|
|
62
65
|
* const command = new DeleteBucketPolicyCommand(input);
|
|
63
66
|
* const response = await client.send(command);
|
|
67
|
+
* // {};
|
|
68
|
+
*
|
|
64
69
|
* ```
|
|
65
70
|
*
|
|
66
71
|
* @param DeleteBucketPolicyCommandInput - {@link DeleteBucketPolicyCommandInput}
|
|
@@ -69,6 +74,8 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
|
|
|
69
74
|
* @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape.
|
|
70
75
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
71
76
|
*
|
|
77
|
+
* @throws {@link S3ServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
72
79
|
*
|
|
73
80
|
* @example To delete bucket policy
|
|
74
81
|
* ```javascript
|
|
@@ -23,13 +23,14 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
* <p>To use this operation, you must have permissions to perform the
|
|
24
24
|
* <code>s3:PutReplicationConfiguration</code> action. The bucket owner has these
|
|
25
25
|
* permissions by default and can grant it to others. For more information about permissions,
|
|
26
|
-
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
27
|
-
* Resources</a>. </p>
|
|
26
|
+
* see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources">Permissions Related to Bucket Subresource Operations</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing
|
|
27
|
+
* Access Permissions to Your Amazon S3 Resources</a>. </p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>It can take a while for the deletion of a replication configuration to fully
|
|
30
30
|
* propagate.</p>
|
|
31
31
|
* </note>
|
|
32
|
-
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
32
|
+
* <p> For information about replication configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html">Replication</a> in the
|
|
33
|
+
* <i>Amazon S3 User Guide</i>.</p>
|
|
33
34
|
* <p>The following operations are related to <code>DeleteBucketReplication</code>:</p>
|
|
34
35
|
* <ul>
|
|
35
36
|
* <li>
|
|
@@ -55,6 +56,8 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
55
56
|
* };
|
|
56
57
|
* const command = new DeleteBucketReplicationCommand(input);
|
|
57
58
|
* const response = await client.send(command);
|
|
59
|
+
* // {};
|
|
60
|
+
*
|
|
58
61
|
* ```
|
|
59
62
|
*
|
|
60
63
|
* @param DeleteBucketReplicationCommandInput - {@link DeleteBucketReplicationCommandInput}
|
|
@@ -63,6 +66,8 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
|
|
|
63
66
|
* @see {@link DeleteBucketReplicationCommandOutput} for command's `response` shape.
|
|
64
67
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
65
68
|
*
|
|
69
|
+
* @throws {@link S3ServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
66
71
|
*
|
|
67
72
|
* @example To delete bucket replication configuration
|
|
68
73
|
* ```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
|
|
@@ -22,21 +22,21 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
|
|
|
22
22
|
* <p>Removes the null version (if there is one) of an object and inserts a delete marker,
|
|
23
23
|
* which becomes the latest version of the object. If there isn't a null version, Amazon S3 does
|
|
24
24
|
* not remove any objects but will still respond that the command was successful.</p>
|
|
25
|
-
* <p>To remove a specific version, you must
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* <code>x-amz-delete-marker</code>, to true. </p>
|
|
25
|
+
* <p>To remove a specific version, you must use the version Id subresource. Using this
|
|
26
|
+
* subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3
|
|
27
|
+
* sets the response header, <code>x-amz-delete-marker</code>, to true. </p>
|
|
29
28
|
* <p>If the object you want to delete is in a bucket where the bucket versioning
|
|
30
29
|
* configuration is MFA Delete enabled, you must include the <code>x-amz-mfa</code> request
|
|
31
30
|
* header in the DELETE <code>versionId</code> request. Requests that include
|
|
32
31
|
* <code>x-amz-mfa</code> must use HTTPS. </p>
|
|
33
|
-
* <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
32
|
+
* <p> For more information about MFA Delete, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html">Using MFA Delete</a>. To see sample
|
|
33
|
+
* requests that use versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete">Sample
|
|
34
|
+
* Request</a>. </p>
|
|
35
|
+
* <p>You can delete objects by explicitly calling DELETE Object or configure its lifecycle
|
|
36
|
+
* (<a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>) to enable Amazon S3 to remove them for you. If you want to block
|
|
37
|
+
* users or accounts from removing or deleting objects from your bucket, you must deny them
|
|
38
|
+
* the <code>s3:DeleteObject</code>, <code>s3:DeleteObjectVersion</code>, and
|
|
39
|
+
* <code>s3:PutLifeCycleConfiguration</code> actions. </p>
|
|
40
40
|
* <p>The following action is related to <code>DeleteObject</code>:</p>
|
|
41
41
|
* <ul>
|
|
42
42
|
* <li>
|
|
@@ -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,6 +76,8 @@ 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
82
|
* @example To delete an object (from a non-versioned bucket)
|
|
75
83
|
* ```javascript
|
|
@@ -20,15 +20,13 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Removes the entire tag set from the specified object. For more information about
|
|
23
|
-
* managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object
|
|
24
|
-
* Tagging</a>.</p>
|
|
23
|
+
* managing object tags, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html"> Object Tagging</a>.</p>
|
|
25
24
|
* <p>To use this operation, you must have permission to perform the
|
|
26
25
|
* <code>s3:DeleteObjectTagging</code> action.</p>
|
|
27
26
|
* <p>To delete tags of a specific object version, add the <code>versionId</code> query
|
|
28
27
|
* parameter in the request. You will need permission for the
|
|
29
28
|
* <code>s3:DeleteObjectVersionTagging</code> action.</p>
|
|
30
|
-
* <p>The following operations are related to
|
|
31
|
-
* <code>DeleteBucketMetricsConfiguration</code>:</p>
|
|
29
|
+
* <p>The following operations are related to <code>DeleteObjectTagging</code>:</p>
|
|
32
30
|
* <ul>
|
|
33
31
|
* <li>
|
|
34
32
|
* <p>
|
|
@@ -55,6 +53,10 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
|
|
|
55
53
|
* };
|
|
56
54
|
* const command = new DeleteObjectTaggingCommand(input);
|
|
57
55
|
* const response = await client.send(command);
|
|
56
|
+
* // { // DeleteObjectTaggingOutput
|
|
57
|
+
* // VersionId: "STRING_VALUE",
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
58
60
|
* ```
|
|
59
61
|
*
|
|
60
62
|
* @param DeleteObjectTaggingCommandInput - {@link DeleteObjectTaggingCommandInput}
|
|
@@ -63,6 +65,8 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
|
|
|
63
65
|
* @see {@link DeleteObjectTaggingCommandOutput} 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 remove tag set from an object version
|
|
68
72
|
* ```javascript
|
|
@@ -20,28 +20,27 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>This action enables you to delete multiple objects from a bucket using a single HTTP
|
|
23
|
-
* request. If you know the object keys that you want to delete, then this action provides
|
|
24
|
-
*
|
|
23
|
+
* request. If you know the object keys that you want to delete, then this action provides a
|
|
24
|
+
* suitable alternative to sending individual delete requests, reducing per-request
|
|
25
25
|
* overhead.</p>
|
|
26
26
|
* <p>The request contains a list of up to 1000 keys that you want to delete. In the XML, you
|
|
27
27
|
* provide the object key names, and optionally, version IDs if you want to delete a specific
|
|
28
28
|
* version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a
|
|
29
|
-
* delete action and returns the result of that delete, success, or failure, in the
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* delete action and returns the result of that delete, success, or failure, in the response.
|
|
30
|
+
* Note that if the object specified in the request is not found, Amazon S3 returns the result as
|
|
31
|
+
* deleted.</p>
|
|
32
32
|
* <p> The action supports two modes for the response: verbose and quiet. By default, the
|
|
33
|
-
* action uses verbose mode in which the response includes the result of deletion of each
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete
|
|
38
|
-
*
|
|
33
|
+
* action uses verbose mode in which the response includes the result of deletion of each key
|
|
34
|
+
* in your request. In quiet mode the response includes only keys where the delete action
|
|
35
|
+
* encountered an error. For a successful deletion, the action does not return any information
|
|
36
|
+
* about the delete in the response body.</p>
|
|
37
|
+
* <p>When performing this action on an MFA Delete enabled bucket, that attempts to delete any
|
|
38
|
+
* versioned objects, you must include an MFA token. If you do not provide one, the entire
|
|
39
39
|
* request will fail, even if there are non-versioned objects you are trying to delete. If you
|
|
40
40
|
* provide an invalid token, whether there are versioned keys in the request or not, the
|
|
41
41
|
* 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
|
|
42
|
-
*
|
|
43
|
-
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon
|
|
44
|
-
* S3 uses the header value to ensure that your request body has not been altered in
|
|
42
|
+
* Delete</a>.</p>
|
|
43
|
+
* <p>Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in
|
|
45
44
|
* transit.</p>
|
|
46
45
|
* <p>The following operations are related to <code>DeleteObjects</code>:</p>
|
|
47
46
|
* <ul>
|
|
@@ -96,6 +95,26 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
96
95
|
* };
|
|
97
96
|
* const command = new DeleteObjectsCommand(input);
|
|
98
97
|
* const response = await client.send(command);
|
|
98
|
+
* // { // DeleteObjectsOutput
|
|
99
|
+
* // Deleted: [ // DeletedObjects
|
|
100
|
+
* // { // DeletedObject
|
|
101
|
+
* // Key: "STRING_VALUE",
|
|
102
|
+
* // VersionId: "STRING_VALUE",
|
|
103
|
+
* // DeleteMarker: true || false,
|
|
104
|
+
* // DeleteMarkerVersionId: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // RequestCharged: "requester",
|
|
108
|
+
* // Errors: [ // Errors
|
|
109
|
+
* // { // Error
|
|
110
|
+
* // Key: "STRING_VALUE",
|
|
111
|
+
* // VersionId: "STRING_VALUE",
|
|
112
|
+
* // Code: "STRING_VALUE",
|
|
113
|
+
* // Message: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // };
|
|
117
|
+
*
|
|
99
118
|
* ```
|
|
100
119
|
*
|
|
101
120
|
* @param DeleteObjectsCommandInput - {@link DeleteObjectsCommandInput}
|
|
@@ -104,19 +123,23 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
104
123
|
* @see {@link DeleteObjectsCommandOutput} for command's `response` shape.
|
|
105
124
|
* @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
|
|
106
125
|
*
|
|
126
|
+
* @throws {@link S3ServiceException}
|
|
127
|
+
* <p>Base exception class for all service exceptions from S3 service.</p>
|
|
107
128
|
*
|
|
108
|
-
* @example To delete multiple
|
|
129
|
+
* @example To delete multiple object versions from a versioned bucket
|
|
109
130
|
* ```javascript
|
|
110
|
-
* // The following example deletes objects from a bucket. The
|
|
131
|
+
* // The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.
|
|
111
132
|
* const input = {
|
|
112
133
|
* "Bucket": "examplebucket",
|
|
113
134
|
* "Delete": {
|
|
114
135
|
* "Objects": [
|
|
115
136
|
* {
|
|
116
|
-
* "Key": "
|
|
137
|
+
* "Key": "HappyFace.jpg",
|
|
138
|
+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
117
139
|
* },
|
|
118
140
|
* {
|
|
119
|
-
* "Key": "
|
|
141
|
+
* "Key": "HappyFace.jpg",
|
|
142
|
+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
120
143
|
* }
|
|
121
144
|
* ],
|
|
122
145
|
* "Quiet": false
|
|
@@ -128,35 +151,31 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
128
151
|
* {
|
|
129
152
|
* "Deleted": [
|
|
130
153
|
* {
|
|
131
|
-
* "
|
|
132
|
-
* "
|
|
133
|
-
* "Key": "objectkey1"
|
|
154
|
+
* "Key": "HappyFace.jpg",
|
|
155
|
+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
134
156
|
* },
|
|
135
157
|
* {
|
|
136
|
-
* "
|
|
137
|
-
* "
|
|
138
|
-
* "Key": "objectkey2"
|
|
158
|
+
* "Key": "HappyFace.jpg",
|
|
159
|
+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
139
160
|
* }
|
|
140
161
|
* ]
|
|
141
162
|
* }
|
|
142
163
|
* *\/
|
|
143
|
-
* // example id: to-delete-multiple-
|
|
164
|
+
* // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
|
|
144
165
|
* ```
|
|
145
166
|
*
|
|
146
|
-
* @example To delete multiple
|
|
167
|
+
* @example To delete multiple objects from a versioned bucket
|
|
147
168
|
* ```javascript
|
|
148
|
-
* // The following example deletes objects from a bucket. The request
|
|
169
|
+
* // The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
|
|
149
170
|
* const input = {
|
|
150
171
|
* "Bucket": "examplebucket",
|
|
151
172
|
* "Delete": {
|
|
152
173
|
* "Objects": [
|
|
153
174
|
* {
|
|
154
|
-
* "Key": "
|
|
155
|
-
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
|
|
175
|
+
* "Key": "objectkey1"
|
|
156
176
|
* },
|
|
157
177
|
* {
|
|
158
|
-
* "Key": "
|
|
159
|
-
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
|
|
178
|
+
* "Key": "objectkey2"
|
|
160
179
|
* }
|
|
161
180
|
* ],
|
|
162
181
|
* "Quiet": false
|
|
@@ -168,17 +187,19 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
|
|
|
168
187
|
* {
|
|
169
188
|
* "Deleted": [
|
|
170
189
|
* {
|
|
171
|
-
* "
|
|
172
|
-
* "
|
|
190
|
+
* "DeleteMarker": "true",
|
|
191
|
+
* "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
|
|
192
|
+
* "Key": "objectkey1"
|
|
173
193
|
* },
|
|
174
194
|
* {
|
|
175
|
-
* "
|
|
176
|
-
* "
|
|
195
|
+
* "DeleteMarker": "true",
|
|
196
|
+
* "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
|
|
197
|
+
* "Key": "objectkey2"
|
|
177
198
|
* }
|
|
178
199
|
* ]
|
|
179
200
|
* }
|
|
180
201
|
* *\/
|
|
181
|
-
* // example id: to-delete-multiple-
|
|
202
|
+
* // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
|
|
182
203
|
* ```
|
|
183
204
|
*
|
|
184
205
|
*/
|