@aws-sdk/client-s3 3.703.0 → 3.709.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 (52) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +330 -102
  3. package/dist-es/S3.js +6 -0
  4. package/dist-es/commands/CreateBucketMetadataTableConfigurationCommand.js +32 -0
  5. package/dist-es/commands/DeleteBucketMetadataTableConfigurationCommand.js +26 -0
  6. package/dist-es/commands/GetBucketMetadataTableConfigurationCommand.js +28 -0
  7. package/dist-es/commands/PutBucketEncryptionCommand.js +1 -1
  8. package/dist-es/commands/PutBucketInventoryConfigurationCommand.js +1 -1
  9. package/dist-es/commands/index.js +3 -0
  10. package/dist-es/models/models_0.js +0 -12
  11. package/dist-es/models/models_1.js +13 -0
  12. package/dist-es/protocols/Aws_restXml.js +157 -0
  13. package/dist-types/S3.d.ts +21 -0
  14. package/dist-types/S3Client.d.ts +5 -2
  15. package/dist-types/commands/CreateBucketCommand.d.ts +13 -13
  16. package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +134 -0
  17. package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +95 -0
  18. package/dist-types/commands/DeleteObjectCommand.d.ts +10 -10
  19. package/dist-types/commands/DeleteObjectsCommand.d.ts +22 -22
  20. package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +111 -0
  21. package/dist-types/commands/GetObjectCommand.d.ts +19 -19
  22. package/dist-types/commands/GetObjectTaggingCommand.d.ts +19 -19
  23. package/dist-types/commands/PutBucketCorsCommand.d.ts +1 -1
  24. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +1 -1
  25. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  26. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  27. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  28. package/dist-types/commands/PutBucketLoggingCommand.d.ts +1 -1
  29. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  30. package/dist-types/commands/PutObjectCommand.d.ts +40 -40
  31. package/dist-types/commands/UploadPartCopyCommand.d.ts +13 -13
  32. package/dist-types/commands/index.d.ts +3 -0
  33. package/dist-types/models/models_0.d.ts +377 -352
  34. package/dist-types/models/models_1.d.ts +352 -1
  35. package/dist-types/protocols/Aws_restXml.d.ts +27 -0
  36. package/dist-types/ts3.4/S3.d.ts +69 -0
  37. package/dist-types/ts3.4/S3Client.d.ts +18 -0
  38. package/dist-types/ts3.4/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +47 -0
  39. package/dist-types/ts3.4/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +47 -0
  40. package/dist-types/ts3.4/commands/GetBucketMetadataTableConfigurationCommand.d.ts +51 -0
  41. package/dist-types/ts3.4/commands/PutBucketCorsCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/PutBucketEncryptionCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/PutBucketLifecycleConfigurationCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/PutBucketLoggingCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  49. package/dist-types/ts3.4/models/models_0.d.ts +47 -66
  50. package/dist-types/ts3.4/models/models_1.d.ts +74 -0
  51. package/dist-types/ts3.4/protocols/Aws_restXml.d.ts +36 -0
  52. package/package.json +52 -52
@@ -96,13 +96,12 @@ declare const GetObjectTaggingCommand_base: {
96
96
  * <p>Base exception class for all service exceptions from S3 service.</p>
97
97
  *
98
98
  * @public
99
- * @example To retrieve tag set of a specific object version
99
+ * @example To retrieve tag set of an object
100
100
  * ```javascript
101
- * // The following example retrieves tag set of an object. The request specifies object version.
101
+ * // The following example retrieves tag set of an object.
102
102
  * const input = {
103
103
  * "Bucket": "examplebucket",
104
- * "Key": "exampleobject",
105
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
104
+ * "Key": "HappyFace.jpg"
106
105
  * };
107
106
  * const command = new GetObjectTaggingCommand(input);
108
107
  * const response = await client.send(command);
@@ -110,22 +109,27 @@ declare const GetObjectTaggingCommand_base: {
110
109
  * {
111
110
  * "TagSet": [
112
111
  * {
113
- * "Key": "Key1",
114
- * "Value": "Value1"
112
+ * "Key": "Key4",
113
+ * "Value": "Value4"
114
+ * },
115
+ * {
116
+ * "Key": "Key3",
117
+ * "Value": "Value3"
115
118
  * }
116
119
  * ],
117
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
120
+ * "VersionId": "null"
118
121
  * }
119
122
  * *\/
120
- * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
123
+ * // example id: to-retrieve-tag-set-of-an-object-1481833847896
121
124
  * ```
122
125
  *
123
- * @example To retrieve tag set of an object
126
+ * @example To retrieve tag set of a specific object version
124
127
  * ```javascript
125
- * // The following example retrieves tag set of an object.
128
+ * // The following example retrieves tag set of an object. The request specifies object version.
126
129
  * const input = {
127
130
  * "Bucket": "examplebucket",
128
- * "Key": "HappyFace.jpg"
131
+ * "Key": "exampleobject",
132
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
129
133
  * };
130
134
  * const command = new GetObjectTaggingCommand(input);
131
135
  * const response = await client.send(command);
@@ -133,18 +137,14 @@ declare const GetObjectTaggingCommand_base: {
133
137
  * {
134
138
  * "TagSet": [
135
139
  * {
136
- * "Key": "Key4",
137
- * "Value": "Value4"
138
- * },
139
- * {
140
- * "Key": "Key3",
141
- * "Value": "Value3"
140
+ * "Key": "Key1",
141
+ * "Value": "Value1"
142
142
  * }
143
143
  * ],
144
- * "VersionId": "null"
144
+ * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
145
145
  * }
146
146
  * *\/
147
- * // example id: to-retrieve-tag-set-of-an-object-1481833847896
147
+ * // example id: to-retrieve-tag-set-of-a-specific-object-version-1483400283663
148
148
  * ```
149
149
  *
150
150
  */
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketCorsRequest } from "../models/models_0";
3
+ import { PutBucketCorsRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketEncryptionRequest } from "../models/models_0";
3
+ import { PutBucketEncryptionRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketIntelligentTieringConfigurationRequest } from "../models/models_0";
3
+ import { PutBucketIntelligentTieringConfigurationRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketInventoryConfigurationRequest } from "../models/models_0";
3
+ import { PutBucketInventoryConfigurationRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketLifecycleConfigurationOutput, PutBucketLifecycleConfigurationRequest } from "../models/models_0";
3
+ import { PutBucketLifecycleConfigurationOutput, PutBucketLifecycleConfigurationRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketLoggingRequest } from "../models/models_0";
3
+ import { PutBucketLoggingRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -1,6 +1,6 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
- import { PutBucketMetricsConfigurationRequest } from "../models/models_0";
3
+ import { PutBucketMetricsConfigurationRequest } from "../models/models_1";
4
4
  import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
5
5
  /**
6
6
  * @public
@@ -288,15 +288,15 @@ declare const PutObjectCommand_base: {
288
288
  * <p>Base exception class for all service exceptions from S3 service.</p>
289
289
  *
290
290
  * @public
291
- * @example To upload an object and specify server-side encryption and object tags
291
+ * @example To upload an object (specify optional headers)
292
292
  * ```javascript
293
- * // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
293
+ * // The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
294
294
  * const input = {
295
- * "Body": "filetoupload",
295
+ * "Body": "HappyFace.jpg",
296
296
  * "Bucket": "examplebucket",
297
- * "Key": "exampleobject",
297
+ * "Key": "HappyFace.jpg",
298
298
  * "ServerSideEncryption": "AES256",
299
- * "Tagging": "key1=value1&key2=value2"
299
+ * "StorageClass": "STANDARD_IA"
300
300
  * };
301
301
  * const command = new PutObjectCommand(input);
302
302
  * const response = await client.send(command);
@@ -304,38 +304,20 @@ declare const PutObjectCommand_base: {
304
304
  * {
305
305
  * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
306
306
  * "ServerSideEncryption": "AES256",
307
- * "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
308
- * }
309
- * *\/
310
- * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
311
- * ```
312
- *
313
- * @example To upload an object
314
- * ```javascript
315
- * // The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
316
- * const input = {
317
- * "Body": "HappyFace.jpg",
318
- * "Bucket": "examplebucket",
319
- * "Key": "HappyFace.jpg"
320
- * };
321
- * const command = new PutObjectCommand(input);
322
- * const response = await client.send(command);
323
- * /* response ==
324
- * {
325
- * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
326
- * "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
307
+ * "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
327
308
  * }
328
309
  * *\/
329
- * // example id: to-upload-an-object-1481760101010
310
+ * // example id: to-upload-an-object-(specify-optional-headers)
330
311
  * ```
331
312
  *
332
- * @example To upload an object and specify optional tags
313
+ * @example To upload an object and specify server-side encryption and object tags
333
314
  * ```javascript
334
- * // The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
315
+ * // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
335
316
  * const input = {
336
- * "Body": "c:\\HappyFace.jpg",
317
+ * "Body": "filetoupload",
337
318
  * "Bucket": "examplebucket",
338
- * "Key": "HappyFace.jpg",
319
+ * "Key": "exampleobject",
320
+ * "ServerSideEncryption": "AES256",
339
321
  * "Tagging": "key1=value1&key2=value2"
340
322
  * };
341
323
  * const command = new PutObjectCommand(input);
@@ -343,10 +325,11 @@ declare const PutObjectCommand_base: {
343
325
  * /* response ==
344
326
  * {
345
327
  * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
346
- * "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
328
+ * "ServerSideEncryption": "AES256",
329
+ * "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
347
330
  * }
348
331
  * *\/
349
- * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
332
+ * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
350
333
  * ```
351
334
  *
352
335
  * @example To upload object and specify user-defined metadata
@@ -392,26 +375,43 @@ declare const PutObjectCommand_base: {
392
375
  * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
393
376
  * ```
394
377
  *
395
- * @example To upload an object (specify optional headers)
378
+ * @example To upload an object and specify optional tags
396
379
  * ```javascript
397
- * // The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
380
+ * // The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
398
381
  * const input = {
399
- * "Body": "HappyFace.jpg",
382
+ * "Body": "c:\\HappyFace.jpg",
400
383
  * "Bucket": "examplebucket",
401
384
  * "Key": "HappyFace.jpg",
402
- * "ServerSideEncryption": "AES256",
403
- * "StorageClass": "STANDARD_IA"
385
+ * "Tagging": "key1=value1&key2=value2"
404
386
  * };
405
387
  * const command = new PutObjectCommand(input);
406
388
  * const response = await client.send(command);
407
389
  * /* response ==
408
390
  * {
409
391
  * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
410
- * "ServerSideEncryption": "AES256",
411
- * "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
392
+ * "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
412
393
  * }
413
394
  * *\/
414
- * // example id: to-upload-an-object-(specify-optional-headers)
395
+ * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
396
+ * ```
397
+ *
398
+ * @example To upload an object
399
+ * ```javascript
400
+ * // The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
401
+ * const input = {
402
+ * "Body": "HappyFace.jpg",
403
+ * "Bucket": "examplebucket",
404
+ * "Key": "HappyFace.jpg"
405
+ * };
406
+ * const command = new PutObjectCommand(input);
407
+ * const response = await client.send(command);
408
+ * /* response ==
409
+ * {
410
+ * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
411
+ * "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
412
+ * }
413
+ * *\/
414
+ * // example id: to-upload-an-object-1481760101010
415
415
  * ```
416
416
  *
417
417
  * @example To create an object.
@@ -312,14 +312,15 @@ declare const UploadPartCopyCommand_base: {
312
312
  * <p>Base exception class for all service exceptions from S3 service.</p>
313
313
  *
314
314
  * @public
315
- * @example To upload a part by copying data from an existing object as data source
315
+ * @example To upload a part by copying byte range from an existing object as data source
316
316
  * ```javascript
317
- * // The following example uploads a part of a multipart upload by copying data from an existing object as data source.
317
+ * // The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.
318
318
  * const input = {
319
319
  * "Bucket": "examplebucket",
320
320
  * "CopySource": "/bucketname/sourceobjectkey",
321
+ * "CopySourceRange": "bytes=1-100000",
321
322
  * "Key": "examplelargeobject",
322
- * "PartNumber": "1",
323
+ * "PartNumber": "2",
323
324
  * "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
324
325
  * };
325
326
  * const command = new UploadPartCopyCommand(input);
@@ -327,23 +328,22 @@ declare const UploadPartCopyCommand_base: {
327
328
  * /* response ==
328
329
  * {
329
330
  * "CopyPartResult": {
330
- * "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
331
- * "LastModified": "2016-12-29T21:24:43.000Z"
331
+ * "ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
332
+ * "LastModified": "2016-12-29T21:44:28.000Z"
332
333
  * }
333
334
  * }
334
335
  * *\/
335
- * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348
336
+ * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594
336
337
  * ```
337
338
  *
338
- * @example To upload a part by copying byte range from an existing object as data source
339
+ * @example To upload a part by copying data from an existing object as data source
339
340
  * ```javascript
340
- * // The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.
341
+ * // The following example uploads a part of a multipart upload by copying data from an existing object as data source.
341
342
  * const input = {
342
343
  * "Bucket": "examplebucket",
343
344
  * "CopySource": "/bucketname/sourceobjectkey",
344
- * "CopySourceRange": "bytes=1-100000",
345
345
  * "Key": "examplelargeobject",
346
- * "PartNumber": "2",
346
+ * "PartNumber": "1",
347
347
  * "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--"
348
348
  * };
349
349
  * const command = new UploadPartCopyCommand(input);
@@ -351,12 +351,12 @@ declare const UploadPartCopyCommand_base: {
351
351
  * /* response ==
352
352
  * {
353
353
  * "CopyPartResult": {
354
- * "ETag": "\"65d16d19e65a7508a51f043180edcc36\"",
355
- * "LastModified": "2016-12-29T21:44:28.000Z"
354
+ * "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"",
355
+ * "LastModified": "2016-12-29T21:24:43.000Z"
356
356
  * }
357
357
  * }
358
358
  * *\/
359
- * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594
359
+ * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348
360
360
  * ```
361
361
  *
362
362
  */
@@ -2,6 +2,7 @@ export * from "./AbortMultipartUploadCommand";
2
2
  export * from "./CompleteMultipartUploadCommand";
3
3
  export * from "./CopyObjectCommand";
4
4
  export * from "./CreateBucketCommand";
5
+ export * from "./CreateBucketMetadataTableConfigurationCommand";
5
6
  export * from "./CreateMultipartUploadCommand";
6
7
  export * from "./CreateSessionCommand";
7
8
  export * from "./DeleteBucketAnalyticsConfigurationCommand";
@@ -11,6 +12,7 @@ export * from "./DeleteBucketEncryptionCommand";
11
12
  export * from "./DeleteBucketIntelligentTieringConfigurationCommand";
12
13
  export * from "./DeleteBucketInventoryConfigurationCommand";
13
14
  export * from "./DeleteBucketLifecycleCommand";
15
+ export * from "./DeleteBucketMetadataTableConfigurationCommand";
14
16
  export * from "./DeleteBucketMetricsConfigurationCommand";
15
17
  export * from "./DeleteBucketOwnershipControlsCommand";
16
18
  export * from "./DeleteBucketPolicyCommand";
@@ -31,6 +33,7 @@ export * from "./GetBucketInventoryConfigurationCommand";
31
33
  export * from "./GetBucketLifecycleConfigurationCommand";
32
34
  export * from "./GetBucketLocationCommand";
33
35
  export * from "./GetBucketLoggingCommand";
36
+ export * from "./GetBucketMetadataTableConfigurationCommand";
34
37
  export * from "./GetBucketMetricsConfigurationCommand";
35
38
  export * from "./GetBucketNotificationConfigurationCommand";
36
39
  export * from "./GetBucketOwnershipControlsCommand";