@aws-sdk/client-s3 3.288.0 → 3.290.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.
Files changed (94) hide show
  1. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +17 -0
  2. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +34 -0
  3. package/dist-types/commands/CopyObjectCommand.d.ts +26 -0
  4. package/dist-types/commands/CreateBucketCommand.d.ts +46 -0
  5. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +20 -0
  6. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -0
  7. package/dist-types/commands/DeleteBucketCommand.d.ts +12 -0
  8. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +12 -0
  9. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +1 -0
  10. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  11. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -0
  12. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +12 -0
  13. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -0
  14. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -0
  15. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +12 -0
  16. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +12 -0
  17. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +12 -0
  18. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +12 -0
  19. package/dist-types/commands/DeleteObjectCommand.d.ts +25 -0
  20. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +36 -0
  21. package/dist-types/commands/DeleteObjectsCommand.d.ts +77 -0
  22. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -0
  23. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -0
  24. package/dist-types/commands/GetBucketAclCommand.d.ts +1 -0
  25. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -0
  26. package/dist-types/commands/GetBucketCorsCommand.d.ts +30 -0
  27. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +1 -0
  28. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  29. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -0
  30. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +29 -0
  31. package/dist-types/commands/GetBucketLocationCommand.d.ts +17 -0
  32. package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -0
  33. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -0
  34. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -0
  35. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -0
  36. package/dist-types/commands/GetBucketPolicyCommand.d.ts +17 -0
  37. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -0
  38. package/dist-types/commands/GetBucketReplicationCommand.d.ts +29 -0
  39. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +17 -0
  40. package/dist-types/commands/GetBucketTaggingCommand.d.ts +26 -0
  41. package/dist-types/commands/GetBucketVersioningCommand.d.ts +18 -0
  42. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +22 -0
  43. package/dist-types/commands/GetObjectAclCommand.d.ts +58 -0
  44. package/dist-types/commands/GetObjectAttributesCommand.d.ts +4 -0
  45. package/dist-types/commands/GetObjectCommand.d.ts +56 -0
  46. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -0
  47. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -0
  48. package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -0
  49. package/dist-types/commands/GetObjectTaggingCommand.d.ts +52 -0
  50. package/dist-types/commands/GetObjectTorrentCommand.d.ts +13 -0
  51. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -0
  52. package/dist-types/commands/HeadBucketCommand.d.ts +15 -0
  53. package/dist-types/commands/HeadObjectCommand.d.ts +27 -0
  54. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -0
  55. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -0
  56. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -0
  57. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -0
  58. package/dist-types/commands/ListBucketsCommand.d.ts +32 -0
  59. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +101 -0
  60. package/dist-types/commands/ListObjectVersionsCommand.d.ts +45 -0
  61. package/dist-types/commands/ListObjectsCommand.d.ts +45 -0
  62. package/dist-types/commands/ListObjectsV2Command.d.ts +42 -0
  63. package/dist-types/commands/ListPartsCommand.d.ts +41 -0
  64. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -0
  65. package/dist-types/commands/PutBucketAclCommand.d.ts +14 -0
  66. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -0
  67. package/dist-types/commands/PutBucketCorsCommand.d.ts +46 -0
  68. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +1 -0
  69. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  70. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -0
  71. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +32 -0
  72. package/dist-types/commands/PutBucketLoggingCommand.d.ts +27 -0
  73. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -0
  74. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +22 -0
  75. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -0
  76. package/dist-types/commands/PutBucketPolicyCommand.d.ts +13 -0
  77. package/dist-types/commands/PutBucketReplicationCommand.d.ts +25 -0
  78. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +15 -0
  79. package/dist-types/commands/PutBucketTaggingCommand.d.ts +24 -0
  80. package/dist-types/commands/PutBucketVersioningCommand.d.ts +16 -0
  81. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +21 -0
  82. package/dist-types/commands/PutObjectAclCommand.d.ts +19 -0
  83. package/dist-types/commands/PutObjectCommand.d.ts +146 -0
  84. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -0
  85. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +1 -0
  86. package/dist-types/commands/PutObjectRetentionCommand.d.ts +1 -0
  87. package/dist-types/commands/PutObjectTaggingCommand.d.ts +30 -0
  88. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -0
  89. package/dist-types/commands/RestoreObjectCommand.d.ts +22 -0
  90. package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -0
  91. package/dist-types/commands/UploadPartCommand.d.ts +21 -0
  92. package/dist-types/commands/UploadPartCopyCommand.d.ts +48 -0
  93. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -0
  94. package/package.json +45 -45
@@ -67,6 +67,23 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
67
67
  * @see {@link AbortMultipartUploadCommandOutput} for command's `response` shape.
68
68
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
69
69
  *
70
+ * @throws {@link NoSuchUpload} (client fault)
71
+ * <p>The specified multipart upload does not exist.</p>
72
+ *
73
+ *
74
+ * @example To abort a multipart upload
75
+ * ```javascript
76
+ * // The following example aborts a multipart upload.
77
+ * const input = {
78
+ * "Bucket": "examplebucket",
79
+ * "Key": "bigobject",
80
+ * "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
81
+ * };
82
+ * const command = new AbortMultipartUploadCommand(input);
83
+ * await client.send(command);
84
+ * // example id: to-abort-a-multipart-upload-1481853354987
85
+ * ```
86
+ *
70
87
  */
71
88
  export declare class AbortMultipartUploadCommand extends $Command<AbortMultipartUploadCommandInput, AbortMultipartUploadCommandOutput, S3ClientResolvedConfig> {
72
89
  readonly input: AbortMultipartUploadCommandInput;
@@ -139,6 +139,40 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
139
139
  * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape.
140
140
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
141
141
  *
142
+ *
143
+ * @example To complete multipart upload
144
+ * ```javascript
145
+ * // The following example completes a multipart upload.
146
+ * const input = {
147
+ * "Bucket": "examplebucket",
148
+ * "Key": "bigobject",
149
+ * "MultipartUpload": {
150
+ * "Parts": [
151
+ * {
152
+ * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
153
+ * "PartNumber": "1"
154
+ * },
155
+ * {
156
+ * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
157
+ * "PartNumber": "2"
158
+ * }
159
+ * ]
160
+ * },
161
+ * "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
162
+ * };
163
+ * const command = new CompleteMultipartUploadCommand(input);
164
+ * const response = await client.send(command);
165
+ * /* response ==
166
+ * {
167
+ * "Bucket": "acexamplebucket",
168
+ * "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
169
+ * "Key": "bigobject",
170
+ * "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
171
+ * }
172
+ * *\/
173
+ * // example id: to-complete-multipart-upload-1481851590483
174
+ * ```
175
+ *
142
176
  */
143
177
  export declare class CompleteMultipartUploadCommand extends $Command<CompleteMultipartUploadCommandInput, CompleteMultipartUploadCommandOutput, S3ClientResolvedConfig> {
144
178
  readonly input: CompleteMultipartUploadCommandInput;
@@ -212,6 +212,32 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
212
212
  * @see {@link CopyObjectCommandOutput} for command's `response` shape.
213
213
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
214
214
  *
215
+ * @throws {@link ObjectNotInActiveTierError} (client fault)
216
+ * <p>The source object of the COPY action is not in the active tier and is only stored in
217
+ * Amazon S3 Glacier.</p>
218
+ *
219
+ *
220
+ * @example To copy an object
221
+ * ```javascript
222
+ * // The following example copies an object from one bucket to another.
223
+ * const input = {
224
+ * "Bucket": "destinationbucket",
225
+ * "CopySource": "/sourcebucket/HappyFacejpg",
226
+ * "Key": "HappyFaceCopyjpg"
227
+ * };
228
+ * const command = new CopyObjectCommand(input);
229
+ * const response = await client.send(command);
230
+ * /* response ==
231
+ * {
232
+ * "CopyObjectResult": {
233
+ * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
234
+ * "LastModified": "2016-12-15T17:38:53.000Z"
235
+ * }
236
+ * }
237
+ * *\/
238
+ * // example id: to-copy-an-object-1481823186878
239
+ * ```
240
+ *
215
241
  */
216
242
  export declare class CopyObjectCommand extends $Command<CopyObjectCommandInput, CopyObjectCommandOutput, S3ClientResolvedConfig> {
217
243
  readonly input: CopyObjectCommandInput;
@@ -174,6 +174,52 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
174
174
  * @see {@link CreateBucketCommandOutput} for command's `response` shape.
175
175
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
176
176
  *
177
+ * @throws {@link BucketAlreadyExists} (client fault)
178
+ * <p>The requested bucket name is not available. The bucket namespace is shared by all users
179
+ * of the system. Select a different name and try again.</p>
180
+ *
181
+ * @throws {@link BucketAlreadyOwnedByYou} (client fault)
182
+ * <p>The bucket you tried to create already exists, and you own it. Amazon S3 returns this error
183
+ * in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you
184
+ * re-create an existing bucket that you already own in the North Virginia Region, Amazon S3
185
+ * returns 200 OK and resets the bucket access control lists (ACLs).</p>
186
+ *
187
+ *
188
+ * @example To create a bucket in a specific region
189
+ * ```javascript
190
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
191
+ * const input = {
192
+ * "Bucket": "examplebucket",
193
+ * "CreateBucketConfiguration": {
194
+ * "LocationConstraint": "eu-west-1"
195
+ * }
196
+ * };
197
+ * const command = new CreateBucketCommand(input);
198
+ * const response = await client.send(command);
199
+ * /* response ==
200
+ * {
201
+ * "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
202
+ * }
203
+ * *\/
204
+ * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
205
+ * ```
206
+ *
207
+ * @example To create a bucket
208
+ * ```javascript
209
+ * // The following example creates a bucket.
210
+ * const input = {
211
+ * "Bucket": "examplebucket"
212
+ * };
213
+ * const command = new CreateBucketCommand(input);
214
+ * const response = await client.send(command);
215
+ * /* response ==
216
+ * {
217
+ * "Location": "/examplebucket"
218
+ * }
219
+ * *\/
220
+ * // example id: to-create-a-bucket--1472851826060
221
+ * ```
222
+ *
177
223
  */
178
224
  export declare class CreateBucketCommand extends $Command<CreateBucketCommandInput, CreateBucketCommandOutput, S3ClientResolvedConfig> {
179
225
  readonly input: CreateBucketCommandInput;
@@ -296,6 +296,26 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
296
296
  * @see {@link CreateMultipartUploadCommandOutput} for command's `response` shape.
297
297
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
298
298
  *
299
+ *
300
+ * @example To initiate a multipart upload
301
+ * ```javascript
302
+ * // The following example initiates a multipart upload.
303
+ * const input = {
304
+ * "Bucket": "examplebucket",
305
+ * "Key": "largeobject"
306
+ * };
307
+ * const command = new CreateMultipartUploadCommand(input);
308
+ * const response = await client.send(command);
309
+ * /* response ==
310
+ * {
311
+ * "Bucket": "examplebucket",
312
+ * "Key": "largeobject",
313
+ * "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
314
+ * }
315
+ * *\/
316
+ * // example id: to-initiate-a-multipart-upload-1481836794513
317
+ * ```
318
+ *
299
319
  */
300
320
  export declare class CreateMultipartUploadCommand extends $Command<CreateMultipartUploadCommandInput, CreateMultipartUploadCommandOutput, S3ClientResolvedConfig> {
301
321
  readonly input: CreateMultipartUploadCommandInput;
@@ -56,6 +56,7 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad
56
56
  * @see {@link DeleteBucketAnalyticsConfigurationCommandOutput} for command's `response` shape.
57
57
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
58
58
  *
59
+ *
59
60
  */
60
61
  export declare class DeleteBucketAnalyticsConfigurationCommand extends $Command<DeleteBucketAnalyticsConfigurationCommandInput, DeleteBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig> {
61
62
  readonly input: DeleteBucketAnalyticsConfigurationCommandInput;
@@ -45,6 +45,18 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {
45
45
  * @see {@link DeleteBucketCommandOutput} for command's `response` shape.
46
46
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
47
47
  *
48
+ *
49
+ * @example To delete a bucket
50
+ * ```javascript
51
+ * // The following example deletes the specified bucket.
52
+ * const input = {
53
+ * "Bucket": "forrandall2"
54
+ * };
55
+ * const command = new DeleteBucketCommand(input);
56
+ * await client.send(command);
57
+ * // example id: to-delete-a-bucket-1473108514262
58
+ * ```
59
+ *
48
60
  */
49
61
  export declare class DeleteBucketCommand extends $Command<DeleteBucketCommandInput, DeleteBucketCommandOutput, S3ClientResolvedConfig> {
50
62
  readonly input: DeleteBucketCommandInput;
@@ -49,6 +49,18 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {
49
49
  * @see {@link DeleteBucketCorsCommandOutput} for command's `response` shape.
50
50
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
51
51
  *
52
+ *
53
+ * @example To delete cors configuration on a bucket.
54
+ * ```javascript
55
+ * // The following example deletes CORS configuration on a bucket.
56
+ * const input = {
57
+ * "Bucket": "examplebucket"
58
+ * };
59
+ * const command = new DeleteBucketCorsCommand(input);
60
+ * await client.send(command);
61
+ * // example id: to-delete-cors-configuration-on-a-bucket-1483042856112
62
+ * ```
63
+ *
52
64
  */
53
65
  export declare class DeleteBucketCorsCommand extends $Command<DeleteBucketCorsCommandInput, DeleteBucketCorsCommandOutput, S3ClientResolvedConfig> {
54
66
  readonly input: DeleteBucketCorsCommandInput;
@@ -51,6 +51,7 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {
51
51
  * @see {@link DeleteBucketEncryptionCommandOutput} for command's `response` shape.
52
52
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
53
53
  *
54
+ *
54
55
  */
55
56
  export declare class DeleteBucketEncryptionCommand extends $Command<DeleteBucketEncryptionCommandInput, DeleteBucketEncryptionCommandOutput, S3ClientResolvedConfig> {
56
57
  readonly input: DeleteBucketEncryptionCommandInput;
@@ -51,6 +51,7 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
51
51
  * @see {@link DeleteBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
52
52
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
53
53
  *
54
+ *
54
55
  */
55
56
  export declare class DeleteBucketIntelligentTieringConfigurationCommand extends $Command<DeleteBucketIntelligentTieringConfigurationCommandInput, DeleteBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
56
57
  readonly input: DeleteBucketIntelligentTieringConfigurationCommandInput;
@@ -54,6 +54,7 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
54
54
  * @see {@link DeleteBucketInventoryConfigurationCommandOutput} for command's `response` shape.
55
55
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
56
56
  *
57
+ *
57
58
  */
58
59
  export declare class DeleteBucketInventoryConfigurationCommand extends $Command<DeleteBucketInventoryConfigurationCommandInput, DeleteBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
59
60
  readonly input: DeleteBucketInventoryConfigurationCommandInput;
@@ -52,6 +52,18 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {
52
52
  * @see {@link DeleteBucketLifecycleCommandOutput} for command's `response` shape.
53
53
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
54
54
  *
55
+ *
56
+ * @example To delete lifecycle configuration on a bucket.
57
+ * ```javascript
58
+ * // The following example deletes lifecycle configuration on a bucket.
59
+ * const input = {
60
+ * "Bucket": "examplebucket"
61
+ * };
62
+ * const command = new DeleteBucketLifecycleCommand(input);
63
+ * await client.send(command);
64
+ * // example id: to-delete-lifecycle-configuration-on-a-bucket-1483043310583
65
+ * ```
66
+ *
55
67
  */
56
68
  export declare class DeleteBucketLifecycleCommand extends $Command<DeleteBucketLifecycleCommandInput, DeleteBucketLifecycleCommandOutput, S3ClientResolvedConfig> {
57
69
  readonly input: DeleteBucketLifecycleCommandInput;
@@ -62,6 +62,7 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
62
62
  * @see {@link DeleteBucketMetricsConfigurationCommandOutput} for command's `response` shape.
63
63
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
64
64
  *
65
+ *
65
66
  */
66
67
  export declare class DeleteBucketMetricsConfigurationCommand extends $Command<DeleteBucketMetricsConfigurationCommandInput, DeleteBucketMetricsConfigurationCommandOutput, S3ClientResolvedConfig> {
67
68
  readonly input: DeleteBucketMetricsConfigurationCommandInput;
@@ -47,6 +47,7 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
47
47
  * @see {@link DeleteBucketOwnershipControlsCommandOutput} for command's `response` shape.
48
48
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
49
49
  *
50
+ *
50
51
  */
51
52
  export declare class DeleteBucketOwnershipControlsCommand extends $Command<DeleteBucketOwnershipControlsCommandInput, DeleteBucketOwnershipControlsCommandOutput, S3ClientResolvedConfig> {
52
53
  readonly input: DeleteBucketOwnershipControlsCommandInput;
@@ -58,6 +58,18 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {
58
58
  * @see {@link DeleteBucketPolicyCommandOutput} for command's `response` shape.
59
59
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
60
60
  *
61
+ *
62
+ * @example To delete bucket policy
63
+ * ```javascript
64
+ * // The following example deletes bucket policy on the specified bucket.
65
+ * const input = {
66
+ * "Bucket": "examplebucket"
67
+ * };
68
+ * const command = new DeleteBucketPolicyCommand(input);
69
+ * await client.send(command);
70
+ * // example id: to-delete-bucket-policy-1483043406577
71
+ * ```
72
+ *
61
73
  */
62
74
  export declare class DeleteBucketPolicyCommand extends $Command<DeleteBucketPolicyCommandInput, DeleteBucketPolicyCommandOutput, S3ClientResolvedConfig> {
63
75
  readonly input: DeleteBucketPolicyCommandInput;
@@ -52,6 +52,18 @@ export interface DeleteBucketReplicationCommandOutput extends __MetadataBearer {
52
52
  * @see {@link DeleteBucketReplicationCommandOutput} for command's `response` shape.
53
53
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
54
54
  *
55
+ *
56
+ * @example To delete bucket replication configuration
57
+ * ```javascript
58
+ * // The following example deletes replication configuration set on bucket.
59
+ * const input = {
60
+ * "Bucket": "example"
61
+ * };
62
+ * const command = new DeleteBucketReplicationCommand(input);
63
+ * await client.send(command);
64
+ * // example id: to-delete-bucket-replication-configuration-1483043684668
65
+ * ```
66
+ *
55
67
  */
56
68
  export declare class DeleteBucketReplicationCommand extends $Command<DeleteBucketReplicationCommandInput, DeleteBucketReplicationCommandOutput, S3ClientResolvedConfig> {
57
69
  readonly input: DeleteBucketReplicationCommandInput;
@@ -45,6 +45,18 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {
45
45
  * @see {@link DeleteBucketTaggingCommandOutput} for command's `response` shape.
46
46
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
47
47
  *
48
+ *
49
+ * @example To delete bucket tags
50
+ * ```javascript
51
+ * // The following example deletes bucket tags.
52
+ * const input = {
53
+ * "Bucket": "examplebucket"
54
+ * };
55
+ * const command = new DeleteBucketTaggingCommand(input);
56
+ * await client.send(command);
57
+ * // example id: to-delete-bucket-tags-1483043846509
58
+ * ```
59
+ *
48
60
  */
49
61
  export declare class DeleteBucketTaggingCommand extends $Command<DeleteBucketTaggingCommandInput, DeleteBucketTaggingCommandOutput, S3ClientResolvedConfig> {
50
62
  readonly input: DeleteBucketTaggingCommandInput;
@@ -52,6 +52,18 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {
52
52
  * @see {@link DeleteBucketWebsiteCommandOutput} for command's `response` shape.
53
53
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
54
54
  *
55
+ *
56
+ * @example To delete bucket website configuration
57
+ * ```javascript
58
+ * // The following example deletes bucket website configuration.
59
+ * const input = {
60
+ * "Bucket": "examplebucket"
61
+ * };
62
+ * const command = new DeleteBucketWebsiteCommand(input);
63
+ * await client.send(command);
64
+ * // example id: to-delete-bucket-website-configuration-1483043937825
65
+ * ```
66
+ *
55
67
  */
56
68
  export declare class DeleteBucketWebsiteCommand extends $Command<DeleteBucketWebsiteCommandInput, DeleteBucketWebsiteCommandOutput, S3ClientResolvedConfig> {
57
69
  readonly input: DeleteBucketWebsiteCommandInput;
@@ -54,6 +54,31 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
54
54
  * @see {@link DeleteObjectCommandOutput} for command's `response` shape.
55
55
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
56
56
  *
57
+ *
58
+ * @example To delete an object (from a non-versioned bucket)
59
+ * ```javascript
60
+ * // The following example deletes an object from a non-versioned bucket.
61
+ * const input = {
62
+ * "Bucket": "ExampleBucket",
63
+ * "Key": "HappyFace.jpg"
64
+ * };
65
+ * const command = new DeleteObjectCommand(input);
66
+ * await client.send(command);
67
+ * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
68
+ * ```
69
+ *
70
+ * @example To delete an object
71
+ * ```javascript
72
+ * // The following example deletes an object from an S3 bucket.
73
+ * const input = {
74
+ * "Bucket": "examplebucket",
75
+ * "Key": "objectkey.jpg"
76
+ * };
77
+ * const command = new DeleteObjectCommand(input);
78
+ * await client.send(command);
79
+ * // example id: to-delete-an-object-1472850136595
80
+ * ```
81
+ *
57
82
  */
58
83
  export declare class DeleteObjectCommand extends $Command<DeleteObjectCommandInput, DeleteObjectCommandOutput, S3ClientResolvedConfig> {
59
84
  readonly input: DeleteObjectCommandInput;
@@ -50,6 +50,42 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
50
50
  * @see {@link DeleteObjectTaggingCommandOutput} for command's `response` shape.
51
51
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
52
52
  *
53
+ *
54
+ * @example To remove tag set from an object
55
+ * ```javascript
56
+ * // 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.
57
+ * const input = {
58
+ * "Bucket": "examplebucket",
59
+ * "Key": "HappyFace.jpg"
60
+ * };
61
+ * const command = new DeleteObjectTaggingCommand(input);
62
+ * const response = await client.send(command);
63
+ * /* response ==
64
+ * {
65
+ * "VersionId": "null"
66
+ * }
67
+ * *\/
68
+ * // example id: to-remove-tag-set-from-an-object-1483145342862
69
+ * ```
70
+ *
71
+ * @example To remove tag set from an object version
72
+ * ```javascript
73
+ * // The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
74
+ * const input = {
75
+ * "Bucket": "examplebucket",
76
+ * "Key": "HappyFace.jpg",
77
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
78
+ * };
79
+ * const command = new DeleteObjectTaggingCommand(input);
80
+ * const response = await client.send(command);
81
+ * /* response ==
82
+ * {
83
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
84
+ * }
85
+ * *\/
86
+ * // example id: to-remove-tag-set-from-an-object-version-1483145285913
87
+ * ```
88
+ *
53
89
  */
54
90
  export declare class DeleteObjectTaggingCommand extends $Command<DeleteObjectTaggingCommandInput, DeleteObjectTaggingCommandOutput, S3ClientResolvedConfig> {
55
91
  readonly input: DeleteObjectTaggingCommandInput;
@@ -80,6 +80,83 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
80
80
  * @see {@link DeleteObjectsCommandOutput} for command's `response` shape.
81
81
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
82
82
  *
83
+ *
84
+ * @example To delete multiple objects from a versioned bucket
85
+ * ```javascript
86
+ * // 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.
87
+ * const input = {
88
+ * "Bucket": "examplebucket",
89
+ * "Delete": {
90
+ * "Objects": [
91
+ * {
92
+ * "Key": "objectkey1"
93
+ * },
94
+ * {
95
+ * "Key": "objectkey2"
96
+ * }
97
+ * ],
98
+ * "Quiet": false
99
+ * }
100
+ * };
101
+ * const command = new DeleteObjectsCommand(input);
102
+ * const response = await client.send(command);
103
+ * /* response ==
104
+ * {
105
+ * "Deleted": [
106
+ * {
107
+ * "DeleteMarker": "true",
108
+ * "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
109
+ * "Key": "objectkey1"
110
+ * },
111
+ * {
112
+ * "DeleteMarker": "true",
113
+ * "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
114
+ * "Key": "objectkey2"
115
+ * }
116
+ * ]
117
+ * }
118
+ * *\/
119
+ * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
120
+ * ```
121
+ *
122
+ * @example To delete multiple object versions from a versioned bucket
123
+ * ```javascript
124
+ * // 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.
125
+ * const input = {
126
+ * "Bucket": "examplebucket",
127
+ * "Delete": {
128
+ * "Objects": [
129
+ * {
130
+ * "Key": "HappyFace.jpg",
131
+ * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
132
+ * },
133
+ * {
134
+ * "Key": "HappyFace.jpg",
135
+ * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
136
+ * }
137
+ * ],
138
+ * "Quiet": false
139
+ * }
140
+ * };
141
+ * const command = new DeleteObjectsCommand(input);
142
+ * const response = await client.send(command);
143
+ * /* response ==
144
+ * {
145
+ * "Deleted": [
146
+ * {
147
+ * "Key": "HappyFace.jpg",
148
+ * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
149
+ * },
150
+ * {
151
+ * "Key": "HappyFace.jpg",
152
+ * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
153
+ * }
154
+ * ]
155
+ * }
156
+ * *\/
157
+ * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
158
+ * ```
159
+ *
83
160
  */
84
161
  export declare class DeleteObjectsCommand extends $Command<DeleteObjectsCommandInput, DeleteObjectsCommandOutput, S3ClientResolvedConfig> {
85
162
  readonly input: DeleteObjectsCommandInput;
@@ -56,6 +56,7 @@ export interface DeletePublicAccessBlockCommandOutput extends __MetadataBearer {
56
56
  * @see {@link DeletePublicAccessBlockCommandOutput} for command's `response` shape.
57
57
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
58
58
  *
59
+ *
59
60
  */
60
61
  export declare class DeletePublicAccessBlockCommand extends $Command<DeletePublicAccessBlockCommandInput, DeletePublicAccessBlockCommandOutput, S3ClientResolvedConfig> {
61
62
  readonly input: DeletePublicAccessBlockCommandInput;
@@ -54,6 +54,7 @@ export interface GetBucketAccelerateConfigurationCommandOutput extends GetBucket
54
54
  * @see {@link GetBucketAccelerateConfigurationCommandOutput} for command's `response` shape.
55
55
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
56
56
  *
57
+ *
57
58
  */
58
59
  export declare class GetBucketAccelerateConfigurationCommand extends $Command<GetBucketAccelerateConfigurationCommandInput, GetBucketAccelerateConfigurationCommandOutput, S3ClientResolvedConfig> {
59
60
  readonly input: GetBucketAccelerateConfigurationCommandInput;
@@ -50,6 +50,7 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat
50
50
  * @see {@link GetBucketAclCommandOutput} for command's `response` shape.
51
51
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
52
52
  *
53
+ *
53
54
  */
54
55
  export declare class GetBucketAclCommand extends $Command<GetBucketAclCommandInput, GetBucketAclCommandOutput, S3ClientResolvedConfig> {
55
56
  readonly input: GetBucketAclCommandInput;
@@ -57,6 +57,7 @@ export interface GetBucketAnalyticsConfigurationCommandOutput extends GetBucketA
57
57
  * @see {@link GetBucketAnalyticsConfigurationCommandOutput} for command's `response` shape.
58
58
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
59
59
  *
60
+ *
60
61
  */
61
62
  export declare class GetBucketAnalyticsConfigurationCommand extends $Command<GetBucketAnalyticsConfigurationCommandInput, GetBucketAnalyticsConfigurationCommandOutput, S3ClientResolvedConfig> {
62
63
  readonly input: GetBucketAnalyticsConfigurationCommandInput;
@@ -48,6 +48,36 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad
48
48
  * @see {@link GetBucketCorsCommandOutput} for command's `response` shape.
49
49
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
50
50
  *
51
+ *
52
+ * @example To get cors configuration set on a bucket
53
+ * ```javascript
54
+ * // The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
55
+ * const input = {
56
+ * "Bucket": "examplebucket"
57
+ * };
58
+ * const command = new GetBucketCorsCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "CORSRules": [
63
+ * {
64
+ * "AllowedHeaders": [
65
+ * "Authorization"
66
+ * ],
67
+ * "AllowedMethods": [
68
+ * "GET"
69
+ * ],
70
+ * "AllowedOrigins": [
71
+ * "*"
72
+ * ],
73
+ * "MaxAgeSeconds": 3000
74
+ * }
75
+ * ]
76
+ * }
77
+ * *\/
78
+ * // example id: to-get-cors-configuration-set-on-a-bucket-1481596855475
79
+ * ```
80
+ *
51
81
  */
52
82
  export declare class GetBucketCorsCommand extends $Command<GetBucketCorsCommandInput, GetBucketCorsCommandOutput, S3ClientResolvedConfig> {
53
83
  readonly input: GetBucketCorsCommandInput;
@@ -50,6 +50,7 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut
50
50
  * @see {@link GetBucketEncryptionCommandOutput} for command's `response` shape.
51
51
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
52
52
  *
53
+ *
53
54
  */
54
55
  export declare class GetBucketEncryptionCommand extends $Command<GetBucketEncryptionCommandInput, GetBucketEncryptionCommandOutput, S3ClientResolvedConfig> {
55
56
  readonly input: GetBucketEncryptionCommandInput;
@@ -51,6 +51,7 @@ export interface GetBucketIntelligentTieringConfigurationCommandOutput extends G
51
51
  * @see {@link GetBucketIntelligentTieringConfigurationCommandOutput} for command's `response` shape.
52
52
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
53
53
  *
54
+ *
54
55
  */
55
56
  export declare class GetBucketIntelligentTieringConfigurationCommand extends $Command<GetBucketIntelligentTieringConfigurationCommandInput, GetBucketIntelligentTieringConfigurationCommandOutput, S3ClientResolvedConfig> {
56
57
  readonly input: GetBucketIntelligentTieringConfigurationCommandInput;
@@ -55,6 +55,7 @@ export interface GetBucketInventoryConfigurationCommandOutput extends GetBucketI
55
55
  * @see {@link GetBucketInventoryConfigurationCommandOutput} for command's `response` shape.
56
56
  * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape.
57
57
  *
58
+ *
58
59
  */
59
60
  export declare class GetBucketInventoryConfigurationCommand extends $Command<GetBucketInventoryConfigurationCommandInput, GetBucketInventoryConfigurationCommandOutput, S3ClientResolvedConfig> {
60
61
  readonly input: GetBucketInventoryConfigurationCommandInput;