@aws-sdk/client-s3 3.775.0 → 3.779.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 (103) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-es/endpoint/ruleset.js +3 -3
  3. package/dist-types/commands/AbortMultipartUploadCommand.d.ts +9 -6
  4. package/dist-types/commands/CompleteMultipartUploadCommand.d.ts +16 -16
  5. package/dist-types/commands/CopyObjectCommand.d.ts +9 -9
  6. package/dist-types/commands/CreateBucketCommand.d.ts +15 -16
  7. package/dist-types/commands/CreateBucketMetadataTableConfigurationCommand.d.ts +1 -0
  8. package/dist-types/commands/CreateMultipartUploadCommand.d.ts +8 -8
  9. package/dist-types/commands/CreateSessionCommand.d.ts +1 -0
  10. package/dist-types/commands/DeleteBucketAnalyticsConfigurationCommand.d.ts +1 -0
  11. package/dist-types/commands/DeleteBucketCommand.d.ts +7 -4
  12. package/dist-types/commands/DeleteBucketCorsCommand.d.ts +7 -4
  13. package/dist-types/commands/DeleteBucketEncryptionCommand.d.ts +1 -0
  14. package/dist-types/commands/DeleteBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  15. package/dist-types/commands/DeleteBucketInventoryConfigurationCommand.d.ts +1 -0
  16. package/dist-types/commands/DeleteBucketLifecycleCommand.d.ts +7 -4
  17. package/dist-types/commands/DeleteBucketMetadataTableConfigurationCommand.d.ts +1 -0
  18. package/dist-types/commands/DeleteBucketMetricsConfigurationCommand.d.ts +1 -0
  19. package/dist-types/commands/DeleteBucketOwnershipControlsCommand.d.ts +1 -0
  20. package/dist-types/commands/DeleteBucketPolicyCommand.d.ts +7 -4
  21. package/dist-types/commands/DeleteBucketReplicationCommand.d.ts +7 -4
  22. package/dist-types/commands/DeleteBucketTaggingCommand.d.ts +7 -4
  23. package/dist-types/commands/DeleteBucketWebsiteCommand.d.ts +7 -4
  24. package/dist-types/commands/DeleteObjectCommand.d.ts +18 -13
  25. package/dist-types/commands/DeleteObjectTaggingCommand.d.ts +11 -12
  26. package/dist-types/commands/DeleteObjectsCommand.d.ts +30 -31
  27. package/dist-types/commands/DeletePublicAccessBlockCommand.d.ts +1 -0
  28. package/dist-types/commands/GetBucketAccelerateConfigurationCommand.d.ts +1 -0
  29. package/dist-types/commands/GetBucketAclCommand.d.ts +1 -0
  30. package/dist-types/commands/GetBucketAnalyticsConfigurationCommand.d.ts +1 -0
  31. package/dist-types/commands/GetBucketCorsCommand.d.ts +9 -9
  32. package/dist-types/commands/GetBucketEncryptionCommand.d.ts +1 -0
  33. package/dist-types/commands/GetBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  34. package/dist-types/commands/GetBucketInventoryConfigurationCommand.d.ts +1 -0
  35. package/dist-types/commands/GetBucketLifecycleConfigurationCommand.d.ts +11 -11
  36. package/dist-types/commands/GetBucketLocationCommand.d.ts +5 -5
  37. package/dist-types/commands/GetBucketLoggingCommand.d.ts +1 -0
  38. package/dist-types/commands/GetBucketMetadataTableConfigurationCommand.d.ts +1 -0
  39. package/dist-types/commands/GetBucketMetricsConfigurationCommand.d.ts +1 -0
  40. package/dist-types/commands/GetBucketNotificationConfigurationCommand.d.ts +1 -0
  41. package/dist-types/commands/GetBucketOwnershipControlsCommand.d.ts +1 -0
  42. package/dist-types/commands/GetBucketPolicyCommand.d.ts +5 -5
  43. package/dist-types/commands/GetBucketPolicyStatusCommand.d.ts +1 -0
  44. package/dist-types/commands/GetBucketReplicationCommand.d.ts +12 -12
  45. package/dist-types/commands/GetBucketRequestPaymentCommand.d.ts +5 -5
  46. package/dist-types/commands/GetBucketTaggingCommand.d.ts +9 -9
  47. package/dist-types/commands/GetBucketVersioningCommand.d.ts +6 -6
  48. package/dist-types/commands/GetBucketWebsiteCommand.d.ts +8 -8
  49. package/dist-types/commands/GetObjectAclCommand.d.ts +29 -29
  50. package/dist-types/commands/GetObjectAttributesCommand.d.ts +1 -0
  51. package/dist-types/commands/GetObjectCommand.d.ts +45 -31
  52. package/dist-types/commands/GetObjectLegalHoldCommand.d.ts +1 -0
  53. package/dist-types/commands/GetObjectLockConfigurationCommand.d.ts +1 -0
  54. package/dist-types/commands/GetObjectRetentionCommand.d.ts +1 -0
  55. package/dist-types/commands/GetObjectTaggingCommand.d.ts +19 -20
  56. package/dist-types/commands/GetObjectTorrentCommand.d.ts +18 -5
  57. package/dist-types/commands/GetPublicAccessBlockCommand.d.ts +1 -0
  58. package/dist-types/commands/HeadBucketCommand.d.ts +7 -4
  59. package/dist-types/commands/HeadObjectCommand.d.ts +12 -12
  60. package/dist-types/commands/ListBucketAnalyticsConfigurationsCommand.d.ts +1 -0
  61. package/dist-types/commands/ListBucketIntelligentTieringConfigurationsCommand.d.ts +1 -0
  62. package/dist-types/commands/ListBucketInventoryConfigurationsCommand.d.ts +1 -0
  63. package/dist-types/commands/ListBucketMetricsConfigurationsCommand.d.ts +1 -0
  64. package/dist-types/commands/ListBucketsCommand.d.ts +14 -14
  65. package/dist-types/commands/ListDirectoryBucketsCommand.d.ts +1 -0
  66. package/dist-types/commands/ListMultipartUploadsCommand.d.ts +62 -63
  67. package/dist-types/commands/ListObjectVersionsCommand.d.ts +26 -26
  68. package/dist-types/commands/ListObjectsCommand.d.ts +23 -23
  69. package/dist-types/commands/ListObjectsV2Command.d.ts +22 -22
  70. package/dist-types/commands/ListPartsCommand.d.ts +22 -22
  71. package/dist-types/commands/PutBucketAccelerateConfigurationCommand.d.ts +1 -0
  72. package/dist-types/commands/PutBucketAclCommand.d.ts +9 -6
  73. package/dist-types/commands/PutBucketAnalyticsConfigurationCommand.d.ts +1 -0
  74. package/dist-types/commands/PutBucketCorsCommand.d.ts +19 -16
  75. package/dist-types/commands/PutBucketEncryptionCommand.d.ts +1 -0
  76. package/dist-types/commands/PutBucketIntelligentTieringConfigurationCommand.d.ts +1 -0
  77. package/dist-types/commands/PutBucketInventoryConfigurationCommand.d.ts +1 -0
  78. package/dist-types/commands/PutBucketLifecycleConfigurationCommand.d.ts +18 -15
  79. package/dist-types/commands/PutBucketLoggingCommand.d.ts +16 -13
  80. package/dist-types/commands/PutBucketMetricsConfigurationCommand.d.ts +1 -0
  81. package/dist-types/commands/PutBucketNotificationConfigurationCommand.d.ts +11 -8
  82. package/dist-types/commands/PutBucketOwnershipControlsCommand.d.ts +1 -0
  83. package/dist-types/commands/PutBucketPolicyCommand.d.ts +8 -5
  84. package/dist-types/commands/PutBucketReplicationCommand.d.ts +15 -12
  85. package/dist-types/commands/PutBucketRequestPaymentCommand.d.ts +9 -6
  86. package/dist-types/commands/PutBucketTaggingCommand.d.ts +13 -10
  87. package/dist-types/commands/PutBucketVersioningCommand.d.ts +10 -7
  88. package/dist-types/commands/PutBucketWebsiteCommand.d.ts +13 -10
  89. package/dist-types/commands/PutObjectAclCommand.d.ts +11 -8
  90. package/dist-types/commands/PutObjectCommand.d.ts +68 -74
  91. package/dist-types/commands/PutObjectLegalHoldCommand.d.ts +1 -0
  92. package/dist-types/commands/PutObjectLockConfigurationCommand.d.ts +1 -0
  93. package/dist-types/commands/PutObjectRetentionCommand.d.ts +1 -0
  94. package/dist-types/commands/PutObjectTaggingCommand.d.ts +12 -12
  95. package/dist-types/commands/PutPublicAccessBlockCommand.d.ts +1 -0
  96. package/dist-types/commands/RestoreObjectCommand.d.ts +17 -16
  97. package/dist-types/commands/SelectObjectContentCommand.d.ts +1 -0
  98. package/dist-types/commands/UploadPartCommand.d.ts +9 -9
  99. package/dist-types/commands/UploadPartCopyCommand.d.ts +21 -22
  100. package/dist-types/commands/WriteGetObjectResponseCommand.d.ts +1 -0
  101. package/dist-types/models/models_0.d.ts +47 -48
  102. package/dist-types/models/models_1.d.ts +13 -14
  103. package/package.json +2 -2
@@ -113,6 +113,7 @@ declare const DeleteBucketEncryptionCommand_base: {
113
113
  * @throws {@link S3ServiceException}
114
114
  * <p>Base exception class for all service exceptions from S3 service.</p>
115
115
  *
116
+ *
116
117
  * @public
117
118
  */
118
119
  export declare class DeleteBucketEncryptionCommand extends DeleteBucketEncryptionCommand_base {
@@ -77,6 +77,7 @@ declare const DeleteBucketIntelligentTieringConfigurationCommand_base: {
77
77
  * @throws {@link S3ServiceException}
78
78
  * <p>Base exception class for all service exceptions from S3 service.</p>
79
79
  *
80
+ *
80
81
  * @public
81
82
  */
82
83
  export declare class DeleteBucketIntelligentTieringConfigurationCommand extends DeleteBucketIntelligentTieringConfigurationCommand_base {
@@ -82,6 +82,7 @@ declare const DeleteBucketInventoryConfigurationCommand_base: {
82
82
  * @throws {@link S3ServiceException}
83
83
  * <p>Base exception class for all service exceptions from S3 service.</p>
84
84
  *
85
+ *
85
86
  * @public
86
87
  */
87
88
  export declare class DeleteBucketInventoryConfigurationCommand extends DeleteBucketInventoryConfigurationCommand_base {
@@ -122,18 +122,21 @@ declare const DeleteBucketLifecycleCommand_base: {
122
122
  * @throws {@link S3ServiceException}
123
123
  * <p>Base exception class for all service exceptions from S3 service.</p>
124
124
  *
125
- * @public
125
+ *
126
126
  * @example To delete lifecycle configuration on a bucket.
127
127
  * ```javascript
128
128
  * // The following example deletes lifecycle configuration on a bucket.
129
129
  * const input = {
130
- * "Bucket": "examplebucket"
130
+ * Bucket: "examplebucket"
131
131
  * };
132
132
  * const command = new DeleteBucketLifecycleCommand(input);
133
- * await client.send(command);
134
- * // example id: to-delete-lifecycle-configuration-on-a-bucket-1483043310583
133
+ * const response = await client.send(command);
134
+ * /* response is
135
+ * { /* metadata only *\/ }
136
+ * *\/
135
137
  * ```
136
138
  *
139
+ * @public
137
140
  */
138
141
  export declare class DeleteBucketLifecycleCommand extends DeleteBucketLifecycleCommand_base {
139
142
  /** @internal type navigation helper, not in runtime. */
@@ -78,6 +78,7 @@ declare const DeleteBucketMetadataTableConfigurationCommand_base: {
78
78
  * @throws {@link S3ServiceException}
79
79
  * <p>Base exception class for all service exceptions from S3 service.</p>
80
80
  *
81
+ *
81
82
  * @public
82
83
  */
83
84
  export declare class DeleteBucketMetadataTableConfigurationCommand extends DeleteBucketMetadataTableConfigurationCommand_base {
@@ -90,6 +90,7 @@ declare const DeleteBucketMetricsConfigurationCommand_base: {
90
90
  * @throws {@link S3ServiceException}
91
91
  * <p>Base exception class for all service exceptions from S3 service.</p>
92
92
  *
93
+ *
93
94
  * @public
94
95
  */
95
96
  export declare class DeleteBucketMetricsConfigurationCommand extends DeleteBucketMetricsConfigurationCommand_base {
@@ -74,6 +74,7 @@ declare const DeleteBucketOwnershipControlsCommand_base: {
74
74
  * @throws {@link S3ServiceException}
75
75
  * <p>Base exception class for all service exceptions from S3 service.</p>
76
76
  *
77
+ *
77
78
  * @public
78
79
  */
79
80
  export declare class DeleteBucketOwnershipControlsCommand extends DeleteBucketOwnershipControlsCommand_base {
@@ -119,18 +119,21 @@ declare const DeleteBucketPolicyCommand_base: {
119
119
  * @throws {@link S3ServiceException}
120
120
  * <p>Base exception class for all service exceptions from S3 service.</p>
121
121
  *
122
- * @public
122
+ *
123
123
  * @example To delete bucket policy
124
124
  * ```javascript
125
125
  * // The following example deletes bucket policy on the specified bucket.
126
126
  * const input = {
127
- * "Bucket": "examplebucket"
127
+ * Bucket: "examplebucket"
128
128
  * };
129
129
  * const command = new DeleteBucketPolicyCommand(input);
130
- * await client.send(command);
131
- * // example id: to-delete-bucket-policy-1483043406577
130
+ * const response = await client.send(command);
131
+ * /* response is
132
+ * { /* metadata only *\/ }
133
+ * *\/
132
134
  * ```
133
135
  *
136
+ * @public
134
137
  */
135
138
  export declare class DeleteBucketPolicyCommand extends DeleteBucketPolicyCommand_base {
136
139
  /** @internal type navigation helper, not in runtime. */
@@ -80,18 +80,21 @@ declare const DeleteBucketReplicationCommand_base: {
80
80
  * @throws {@link S3ServiceException}
81
81
  * <p>Base exception class for all service exceptions from S3 service.</p>
82
82
  *
83
- * @public
83
+ *
84
84
  * @example To delete bucket replication configuration
85
85
  * ```javascript
86
86
  * // The following example deletes replication configuration set on bucket.
87
87
  * const input = {
88
- * "Bucket": "example"
88
+ * Bucket: "example"
89
89
  * };
90
90
  * const command = new DeleteBucketReplicationCommand(input);
91
- * await client.send(command);
92
- * // example id: to-delete-bucket-replication-configuration-1483043684668
91
+ * const response = await client.send(command);
92
+ * /* response is
93
+ * { /* metadata only *\/ }
94
+ * *\/
93
95
  * ```
94
96
  *
97
+ * @public
95
98
  */
96
99
  export declare class DeleteBucketReplicationCommand extends DeleteBucketReplicationCommand_base {
97
100
  /** @internal type navigation helper, not in runtime. */
@@ -72,18 +72,21 @@ declare const DeleteBucketTaggingCommand_base: {
72
72
  * @throws {@link S3ServiceException}
73
73
  * <p>Base exception class for all service exceptions from S3 service.</p>
74
74
  *
75
- * @public
75
+ *
76
76
  * @example To delete bucket tags
77
77
  * ```javascript
78
78
  * // The following example deletes bucket tags.
79
79
  * const input = {
80
- * "Bucket": "examplebucket"
80
+ * Bucket: "examplebucket"
81
81
  * };
82
82
  * const command = new DeleteBucketTaggingCommand(input);
83
- * await client.send(command);
84
- * // example id: to-delete-bucket-tags-1483043846509
83
+ * const response = await client.send(command);
84
+ * /* response is
85
+ * { /* metadata only *\/ }
86
+ * *\/
85
87
  * ```
86
88
  *
89
+ * @public
87
90
  */
88
91
  export declare class DeleteBucketTaggingCommand extends DeleteBucketTaggingCommand_base {
89
92
  /** @internal type navigation helper, not in runtime. */
@@ -79,18 +79,21 @@ declare const DeleteBucketWebsiteCommand_base: {
79
79
  * @throws {@link S3ServiceException}
80
80
  * <p>Base exception class for all service exceptions from S3 service.</p>
81
81
  *
82
- * @public
82
+ *
83
83
  * @example To delete bucket website configuration
84
84
  * ```javascript
85
85
  * // The following example deletes bucket website configuration.
86
86
  * const input = {
87
- * "Bucket": "examplebucket"
87
+ * Bucket: "examplebucket"
88
88
  * };
89
89
  * const command = new DeleteBucketWebsiteCommand(input);
90
- * await client.send(command);
91
- * // example id: to-delete-bucket-website-configuration-1483043937825
90
+ * const response = await client.send(command);
91
+ * /* response is
92
+ * { /* metadata only *\/ }
93
+ * *\/
92
94
  * ```
93
95
  *
96
+ * @public
94
97
  */
95
98
  export declare class DeleteBucketWebsiteCommand extends DeleteBucketWebsiteCommand_base {
96
99
  /** @internal type navigation helper, not in runtime. */
@@ -164,31 +164,36 @@ declare const DeleteObjectCommand_base: {
164
164
  * @throws {@link S3ServiceException}
165
165
  * <p>Base exception class for all service exceptions from S3 service.</p>
166
166
  *
167
- * @public
168
- * @example To delete an object
167
+ *
168
+ * @example To delete an object (from a non-versioned bucket)
169
169
  * ```javascript
170
- * // The following example deletes an object from an S3 bucket.
170
+ * // The following example deletes an object from a non-versioned bucket.
171
171
  * const input = {
172
- * "Bucket": "examplebucket",
173
- * "Key": "objectkey.jpg"
172
+ * Bucket: "ExampleBucket",
173
+ * Key: "HappyFace.jpg"
174
174
  * };
175
175
  * const command = new DeleteObjectCommand(input);
176
- * await client.send(command);
177
- * // example id: to-delete-an-object-1472850136595
176
+ * const response = await client.send(command);
177
+ * /* response is
178
+ * { /* metadata only *\/ }
179
+ * *\/
178
180
  * ```
179
181
  *
180
- * @example To delete an object (from a non-versioned bucket)
182
+ * @example To delete an object
181
183
  * ```javascript
182
- * // The following example deletes an object from a non-versioned bucket.
184
+ * // The following example deletes an object from an S3 bucket.
183
185
  * const input = {
184
- * "Bucket": "ExampleBucket",
185
- * "Key": "HappyFace.jpg"
186
+ * Bucket: "examplebucket",
187
+ * Key: "objectkey.jpg"
186
188
  * };
187
189
  * const command = new DeleteObjectCommand(input);
188
- * await client.send(command);
189
- * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
190
+ * const response = await client.send(command);
191
+ * /* response is
192
+ * { /* empty *\/ }
193
+ * *\/
190
194
  * ```
191
195
  *
196
+ * @public
192
197
  */
193
198
  export declare class DeleteObjectCommand extends DeleteObjectCommand_base {
194
199
  /** @internal type navigation helper, not in runtime. */
@@ -79,42 +79,41 @@ declare const DeleteObjectTaggingCommand_base: {
79
79
  * @throws {@link S3ServiceException}
80
80
  * <p>Base exception class for all service exceptions from S3 service.</p>
81
81
  *
82
- * @public
82
+ *
83
83
  * @example To remove tag set from an object
84
84
  * ```javascript
85
85
  * // 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.
86
86
  * const input = {
87
- * "Bucket": "examplebucket",
88
- * "Key": "HappyFace.jpg"
87
+ * Bucket: "examplebucket",
88
+ * Key: "HappyFace.jpg"
89
89
  * };
90
90
  * const command = new DeleteObjectTaggingCommand(input);
91
91
  * const response = await client.send(command);
92
- * /* response ==
92
+ * /* response is
93
93
  * {
94
- * "VersionId": "null"
94
+ * VersionId: "null"
95
95
  * }
96
96
  * *\/
97
- * // example id: to-remove-tag-set-from-an-object-1483145342862
98
97
  * ```
99
98
  *
100
99
  * @example To remove tag set from an object version
101
100
  * ```javascript
102
101
  * // The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.
103
102
  * const input = {
104
- * "Bucket": "examplebucket",
105
- * "Key": "HappyFace.jpg",
106
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
103
+ * Bucket: "examplebucket",
104
+ * Key: "HappyFace.jpg",
105
+ * VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
107
106
  * };
108
107
  * const command = new DeleteObjectTaggingCommand(input);
109
108
  * const response = await client.send(command);
110
- * /* response ==
109
+ * /* response is
111
110
  * {
112
- * "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
111
+ * VersionId: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI"
113
112
  * }
114
113
  * *\/
115
- * // example id: to-remove-tag-set-from-an-object-version-1483145285913
116
114
  * ```
117
115
  *
116
+ * @public
118
117
  */
119
118
  export declare class DeleteObjectTaggingCommand extends DeleteObjectTaggingCommand_base {
120
119
  /** @internal type navigation helper, not in runtime. */
@@ -223,83 +223,82 @@ declare const DeleteObjectsCommand_base: {
223
223
  * @throws {@link S3ServiceException}
224
224
  * <p>Base exception class for all service exceptions from S3 service.</p>
225
225
  *
226
- * @public
226
+ *
227
227
  * @example To delete multiple object versions from a versioned bucket
228
228
  * ```javascript
229
229
  * // 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.
230
230
  * const input = {
231
- * "Bucket": "examplebucket",
232
- * "Delete": {
233
- * "Objects": [
231
+ * Bucket: "examplebucket",
232
+ * Delete: {
233
+ * Objects: [
234
234
  * {
235
- * "Key": "HappyFace.jpg",
236
- * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
235
+ * Key: "HappyFace.jpg",
236
+ * VersionId: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
237
237
  * },
238
238
  * {
239
- * "Key": "HappyFace.jpg",
240
- * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
239
+ * Key: "HappyFace.jpg",
240
+ * VersionId: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
241
241
  * }
242
242
  * ],
243
- * "Quiet": false
243
+ * Quiet: false
244
244
  * }
245
245
  * };
246
246
  * const command = new DeleteObjectsCommand(input);
247
247
  * const response = await client.send(command);
248
- * /* response ==
248
+ * /* response is
249
249
  * {
250
- * "Deleted": [
250
+ * Deleted: [
251
251
  * {
252
- * "Key": "HappyFace.jpg",
253
- * "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
252
+ * Key: "HappyFace.jpg",
253
+ * VersionId: "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
254
254
  * },
255
255
  * {
256
- * "Key": "HappyFace.jpg",
257
- * "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
256
+ * Key: "HappyFace.jpg",
257
+ * VersionId: "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
258
258
  * }
259
259
  * ]
260
260
  * }
261
261
  * *\/
262
- * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
263
262
  * ```
264
263
  *
265
264
  * @example To delete multiple objects from a versioned bucket
266
265
  * ```javascript
267
266
  * // 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.
268
267
  * const input = {
269
- * "Bucket": "examplebucket",
270
- * "Delete": {
271
- * "Objects": [
268
+ * Bucket: "examplebucket",
269
+ * Delete: {
270
+ * Objects: [
272
271
  * {
273
- * "Key": "objectkey1"
272
+ * Key: "objectkey1"
274
273
  * },
275
274
  * {
276
- * "Key": "objectkey2"
275
+ * Key: "objectkey2"
277
276
  * }
278
277
  * ],
279
- * "Quiet": false
278
+ * Quiet: false
280
279
  * }
281
280
  * };
282
281
  * const command = new DeleteObjectsCommand(input);
283
282
  * const response = await client.send(command);
284
- * /* response ==
283
+ * /* response is
285
284
  * {
286
- * "Deleted": [
285
+ * Deleted: [
287
286
  * {
288
- * "DeleteMarker": "true",
289
- * "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
290
- * "Key": "objectkey1"
287
+ * DeleteMarker: true,
288
+ * DeleteMarkerVersionId: "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
289
+ * Key: "objectkey1"
291
290
  * },
292
291
  * {
293
- * "DeleteMarker": "true",
294
- * "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
295
- * "Key": "objectkey2"
292
+ * DeleteMarker: true,
293
+ * DeleteMarkerVersionId: "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
294
+ * Key: "objectkey2"
296
295
  * }
297
296
  * ]
298
297
  * }
299
298
  * *\/
300
- * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
301
299
  * ```
302
300
  *
301
+ * @public
303
302
  */
304
303
  export declare class DeleteObjectsCommand extends DeleteObjectsCommand_base {
305
304
  /** @internal type navigation helper, not in runtime. */
@@ -83,6 +83,7 @@ declare const DeletePublicAccessBlockCommand_base: {
83
83
  * @throws {@link S3ServiceException}
84
84
  * <p>Base exception class for all service exceptions from S3 service.</p>
85
85
  *
86
+ *
86
87
  * @public
87
88
  */
88
89
  export declare class DeletePublicAccessBlockCommand extends DeletePublicAccessBlockCommand_base {
@@ -85,6 +85,7 @@ declare const GetBucketAccelerateConfigurationCommand_base: {
85
85
  * @throws {@link S3ServiceException}
86
86
  * <p>Base exception class for all service exceptions from S3 service.</p>
87
87
  *
88
+ *
88
89
  * @public
89
90
  */
90
91
  export declare class GetBucketAccelerateConfigurationCommand extends GetBucketAccelerateConfigurationCommand_base {
@@ -98,6 +98,7 @@ declare const GetBucketAclCommand_base: {
98
98
  * @throws {@link S3ServiceException}
99
99
  * <p>Base exception class for all service exceptions from S3 service.</p>
100
100
  *
101
+ *
101
102
  * @public
102
103
  */
103
104
  export declare class GetBucketAclCommand extends GetBucketAclCommand_base {
@@ -118,6 +118,7 @@ declare const GetBucketAnalyticsConfigurationCommand_base: {
118
118
  * @throws {@link S3ServiceException}
119
119
  * <p>Base exception class for all service exceptions from S3 service.</p>
120
120
  *
121
+ *
121
122
  * @public
122
123
  */
123
124
  export declare class GetBucketAnalyticsConfigurationCommand extends GetBucketAnalyticsConfigurationCommand_base {
@@ -99,36 +99,36 @@ declare const GetBucketCorsCommand_base: {
99
99
  * @throws {@link S3ServiceException}
100
100
  * <p>Base exception class for all service exceptions from S3 service.</p>
101
101
  *
102
- * @public
102
+ *
103
103
  * @example To get cors configuration set on a bucket
104
104
  * ```javascript
105
105
  * // The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
106
106
  * const input = {
107
- * "Bucket": "examplebucket"
107
+ * Bucket: "examplebucket"
108
108
  * };
109
109
  * const command = new GetBucketCorsCommand(input);
110
110
  * const response = await client.send(command);
111
- * /* response ==
111
+ * /* response is
112
112
  * {
113
- * "CORSRules": [
113
+ * CORSRules: [
114
114
  * {
115
- * "AllowedHeaders": [
115
+ * AllowedHeaders: [
116
116
  * "Authorization"
117
117
  * ],
118
- * "AllowedMethods": [
118
+ * AllowedMethods: [
119
119
  * "GET"
120
120
  * ],
121
- * "AllowedOrigins": [
121
+ * AllowedOrigins: [
122
122
  * "*"
123
123
  * ],
124
- * "MaxAgeSeconds": 3000
124
+ * MaxAgeSeconds: 3000
125
125
  * }
126
126
  * ]
127
127
  * }
128
128
  * *\/
129
- * // example id: to-get-cors-configuration-set-on-a-bucket-1481596855475
130
129
  * ```
131
130
  *
131
+ * @public
132
132
  */
133
133
  export declare class GetBucketCorsCommand extends GetBucketCorsCommand_base {
134
134
  /** @internal type navigation helper, not in runtime. */
@@ -126,6 +126,7 @@ declare const GetBucketEncryptionCommand_base: {
126
126
  * @throws {@link S3ServiceException}
127
127
  * <p>Base exception class for all service exceptions from S3 service.</p>
128
128
  *
129
+ *
129
130
  * @public
130
131
  */
131
132
  export declare class GetBucketEncryptionCommand extends GetBucketEncryptionCommand_base {
@@ -104,6 +104,7 @@ declare const GetBucketIntelligentTieringConfigurationCommand_base: {
104
104
  * @throws {@link S3ServiceException}
105
105
  * <p>Base exception class for all service exceptions from S3 service.</p>
106
106
  *
107
+ *
107
108
  * @public
108
109
  */
109
110
  export declare class GetBucketIntelligentTieringConfigurationCommand extends GetBucketIntelligentTieringConfigurationCommand_base {
@@ -112,6 +112,7 @@ declare const GetBucketInventoryConfigurationCommand_base: {
112
112
  * @throws {@link S3ServiceException}
113
113
  * <p>Base exception class for all service exceptions from S3 service.</p>
114
114
  *
115
+ *
115
116
  * @public
116
117
  */
117
118
  export declare class GetBucketInventoryConfigurationCommand extends GetBucketInventoryConfigurationCommand_base {
@@ -209,35 +209,35 @@ declare const GetBucketLifecycleConfigurationCommand_base: {
209
209
  * @throws {@link S3ServiceException}
210
210
  * <p>Base exception class for all service exceptions from S3 service.</p>
211
211
  *
212
- * @public
212
+ *
213
213
  * @example To get lifecycle configuration on a bucket
214
214
  * ```javascript
215
215
  * // The following example retrieves lifecycle configuration on set on a bucket.
216
216
  * const input = {
217
- * "Bucket": "examplebucket"
217
+ * Bucket: "examplebucket"
218
218
  * };
219
219
  * const command = new GetBucketLifecycleConfigurationCommand(input);
220
220
  * const response = await client.send(command);
221
- * /* response ==
221
+ * /* response is
222
222
  * {
223
- * "Rules": [
223
+ * Rules: [
224
224
  * {
225
- * "ID": "Rule for TaxDocs/",
226
- * "Prefix": "TaxDocs",
227
- * "Status": "Enabled",
228
- * "Transitions": [
225
+ * ID: "Rule for TaxDocs/",
226
+ * Prefix: "TaxDocs",
227
+ * Status: "Enabled",
228
+ * Transitions: [
229
229
  * {
230
- * "Days": 365,
231
- * "StorageClass": "STANDARD_IA"
230
+ * Days: 365,
231
+ * StorageClass: "STANDARD_IA"
232
232
  * }
233
233
  * ]
234
234
  * }
235
235
  * ]
236
236
  * }
237
237
  * *\/
238
- * // example id: to-get-lifecycle-configuration-on-a-bucket-1481666063200
239
238
  * ```
240
239
  *
240
+ * @public
241
241
  */
242
242
  export declare class GetBucketLifecycleConfigurationCommand extends GetBucketLifecycleConfigurationCommand_base {
243
243
  /** @internal type navigation helper, not in runtime. */
@@ -83,23 +83,23 @@ declare const GetBucketLocationCommand_base: {
83
83
  * @throws {@link S3ServiceException}
84
84
  * <p>Base exception class for all service exceptions from S3 service.</p>
85
85
  *
86
- * @public
86
+ *
87
87
  * @example To get bucket location
88
88
  * ```javascript
89
89
  * // The following example returns bucket location.
90
90
  * const input = {
91
- * "Bucket": "examplebucket"
91
+ * Bucket: "examplebucket"
92
92
  * };
93
93
  * const command = new GetBucketLocationCommand(input);
94
94
  * const response = await client.send(command);
95
- * /* response ==
95
+ * /* response is
96
96
  * {
97
- * "LocationConstraint": "us-west-2"
97
+ * LocationConstraint: "us-west-2"
98
98
  * }
99
99
  * *\/
100
- * // example id: to-get-bucket-location-1481594573609
101
100
  * ```
102
101
  *
102
+ * @public
103
103
  */
104
104
  export declare class GetBucketLocationCommand extends GetBucketLocationCommand_base {
105
105
  /** @internal type navigation helper, not in runtime. */
@@ -93,6 +93,7 @@ declare const GetBucketLoggingCommand_base: {
93
93
  * @throws {@link S3ServiceException}
94
94
  * <p>Base exception class for all service exceptions from S3 service.</p>
95
95
  *
96
+ *
96
97
  * @public
97
98
  */
98
99
  export declare class GetBucketLoggingCommand extends GetBucketLoggingCommand_base {
@@ -94,6 +94,7 @@ declare const GetBucketMetadataTableConfigurationCommand_base: {
94
94
  * @throws {@link S3ServiceException}
95
95
  * <p>Base exception class for all service exceptions from S3 service.</p>
96
96
  *
97
+ *
97
98
  * @public
98
99
  */
99
100
  export declare class GetBucketMetadataTableConfigurationCommand extends GetBucketMetadataTableConfigurationCommand_base {
@@ -111,6 +111,7 @@ declare const GetBucketMetricsConfigurationCommand_base: {
111
111
  * @throws {@link S3ServiceException}
112
112
  * <p>Base exception class for all service exceptions from S3 service.</p>
113
113
  *
114
+ *
114
115
  * @public
115
116
  */
116
117
  export declare class GetBucketMetricsConfigurationCommand extends GetBucketMetricsConfigurationCommand_base {
@@ -137,6 +137,7 @@ declare const GetBucketNotificationConfigurationCommand_base: {
137
137
  * @throws {@link S3ServiceException}
138
138
  * <p>Base exception class for all service exceptions from S3 service.</p>
139
139
  *
140
+ *
140
141
  * @public
141
142
  */
142
143
  export declare class GetBucketNotificationConfigurationCommand extends GetBucketNotificationConfigurationCommand_base {
@@ -82,6 +82,7 @@ declare const GetBucketOwnershipControlsCommand_base: {
82
82
  * @throws {@link S3ServiceException}
83
83
  * <p>Base exception class for all service exceptions from S3 service.</p>
84
84
  *
85
+ *
85
86
  * @public
86
87
  */
87
88
  export declare class GetBucketOwnershipControlsCommand extends GetBucketOwnershipControlsCommand_base {