@aws-sdk/client-s3 3.400.0 → 3.405.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.
@@ -155,39 +155,39 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
155
155
  * @throws {@link S3ServiceException}
156
156
  * <p>Base exception class for all service exceptions from S3 service.</p>
157
157
  *
158
- * @example To create a bucket in a specific region
158
+ * @example To create a bucket
159
159
  * ```javascript
160
- * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
160
+ * // The following example creates a bucket.
161
161
  * const input = {
162
- * "Bucket": "examplebucket",
163
- * "CreateBucketConfiguration": {
164
- * "LocationConstraint": "eu-west-1"
165
- * }
162
+ * "Bucket": "examplebucket"
166
163
  * };
167
164
  * const command = new CreateBucketCommand(input);
168
165
  * const response = await client.send(command);
169
166
  * /* response ==
170
167
  * {
171
- * "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
168
+ * "Location": "/examplebucket"
172
169
  * }
173
170
  * *\/
174
- * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
171
+ * // example id: to-create-a-bucket--1472851826060
175
172
  * ```
176
173
  *
177
- * @example To create a bucket
174
+ * @example To create a bucket in a specific region
178
175
  * ```javascript
179
- * // The following example creates a bucket.
176
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
180
177
  * const input = {
181
- * "Bucket": "examplebucket"
178
+ * "Bucket": "examplebucket",
179
+ * "CreateBucketConfiguration": {
180
+ * "LocationConstraint": "eu-west-1"
181
+ * }
182
182
  * };
183
183
  * const command = new CreateBucketCommand(input);
184
184
  * const response = await client.send(command);
185
185
  * /* response ==
186
186
  * {
187
- * "Location": "/examplebucket"
187
+ * "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
188
188
  * }
189
189
  * *\/
190
- * // example id: to-create-a-bucket--1472851826060
190
+ * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
191
191
  * ```
192
192
  *
193
193
  */
@@ -280,53 +280,53 @@ export interface GetObjectCommandOutput extends Omit<GetObjectOutput, "Body">, _
280
280
  * @throws {@link S3ServiceException}
281
281
  * <p>Base exception class for all service exceptions from S3 service.</p>
282
282
  *
283
- * @example To retrieve a byte range of an object
283
+ * @example To retrieve an object
284
284
  * ```javascript
285
- * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
285
+ * // The following example retrieves an object for an S3 bucket.
286
286
  * const input = {
287
287
  * "Bucket": "examplebucket",
288
- * "Key": "SampleFile.txt",
289
- * "Range": "bytes=0-9"
288
+ * "Key": "HappyFace.jpg"
290
289
  * };
291
290
  * const command = new GetObjectCommand(input);
292
291
  * const response = await client.send(command);
293
292
  * /* response ==
294
293
  * {
295
294
  * "AcceptRanges": "bytes",
296
- * "ContentLength": "10",
297
- * "ContentRange": "bytes 0-9/43",
298
- * "ContentType": "text/plain",
299
- * "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
300
- * "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
295
+ * "ContentLength": "3191",
296
+ * "ContentType": "image/jpeg",
297
+ * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
298
+ * "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
301
299
  * "Metadata": {},
300
+ * "TagCount": 2,
302
301
  * "VersionId": "null"
303
302
  * }
304
303
  * *\/
305
- * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
304
+ * // example id: to-retrieve-an-object-1481827837012
306
305
  * ```
307
306
  *
308
- * @example To retrieve an object
307
+ * @example To retrieve a byte range of an object
309
308
  * ```javascript
310
- * // The following example retrieves an object for an S3 bucket.
309
+ * // The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
311
310
  * const input = {
312
311
  * "Bucket": "examplebucket",
313
- * "Key": "HappyFace.jpg"
312
+ * "Key": "SampleFile.txt",
313
+ * "Range": "bytes=0-9"
314
314
  * };
315
315
  * const command = new GetObjectCommand(input);
316
316
  * const response = await client.send(command);
317
317
  * /* response ==
318
318
  * {
319
319
  * "AcceptRanges": "bytes",
320
- * "ContentLength": "3191",
321
- * "ContentType": "image/jpeg",
322
- * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
323
- * "LastModified": "Thu, 15 Dec 2016 01:19:41 GMT",
320
+ * "ContentLength": "10",
321
+ * "ContentRange": "bytes 0-9/43",
322
+ * "ContentType": "text/plain",
323
+ * "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"",
324
+ * "LastModified": "Thu, 09 Oct 2014 22:57:28 GMT",
324
325
  * "Metadata": {},
325
- * "TagCount": 2,
326
326
  * "VersionId": "null"
327
327
  * }
328
328
  * *\/
329
- * // example id: to-retrieve-an-object-1481827837012
329
+ * // example id: to-retrieve-a-byte-range-of-an-object--1481832674603
330
330
  * ```
331
331
  *
332
332
  */
@@ -214,46 +214,24 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
214
214
  * // example id: to-upload-an-object-(specify-optional-headers)
215
215
  * ```
216
216
  *
217
- * @example To create an object.
218
- * ```javascript
219
- * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
220
- * const input = {
221
- * "Body": "filetoupload",
222
- * "Bucket": "examplebucket",
223
- * "Key": "objectkey"
224
- * };
225
- * const command = new PutObjectCommand(input);
226
- * const response = await client.send(command);
227
- * /* response ==
228
- * {
229
- * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
230
- * "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
231
- * }
232
- * *\/
233
- * // example id: to-create-an-object-1483147613675
234
- * ```
235
- *
236
- * @example To upload object and specify user-defined metadata
217
+ * @example To upload an object and specify optional tags
237
218
  * ```javascript
238
- * // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
219
+ * // 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.
239
220
  * const input = {
240
- * "Body": "filetoupload",
221
+ * "Body": "c:\\HappyFace.jpg",
241
222
  * "Bucket": "examplebucket",
242
- * "Key": "exampleobject",
243
- * "Metadata": {
244
- * "metadata1": "value1",
245
- * "metadata2": "value2"
246
- * }
223
+ * "Key": "HappyFace.jpg",
224
+ * "Tagging": "key1=value1&key2=value2"
247
225
  * };
248
226
  * const command = new PutObjectCommand(input);
249
227
  * const response = await client.send(command);
250
228
  * /* response ==
251
229
  * {
252
230
  * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
253
- * "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
231
+ * "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
254
232
  * }
255
233
  * *\/
256
- * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
234
+ * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
257
235
  * ```
258
236
  *
259
237
  * @example To upload an object and specify server-side encryption and object tags
@@ -278,24 +256,23 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
278
256
  * // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
279
257
  * ```
280
258
  *
281
- * @example To upload an object and specify optional tags
259
+ * @example To create an object.
282
260
  * ```javascript
283
- * // 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.
261
+ * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
284
262
  * const input = {
285
- * "Body": "c:\\HappyFace.jpg",
263
+ * "Body": "filetoupload",
286
264
  * "Bucket": "examplebucket",
287
- * "Key": "HappyFace.jpg",
288
- * "Tagging": "key1=value1&key2=value2"
265
+ * "Key": "objectkey"
289
266
  * };
290
267
  * const command = new PutObjectCommand(input);
291
268
  * const response = await client.send(command);
292
269
  * /* response ==
293
270
  * {
294
271
  * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
295
- * "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
272
+ * "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
296
273
  * }
297
274
  * *\/
298
- * // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
275
+ * // example id: to-create-an-object-1483147613675
299
276
  * ```
300
277
  *
301
278
  * @example To upload an object
@@ -337,6 +314,29 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
337
314
  * // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
338
315
  * ```
339
316
  *
317
+ * @example To upload object and specify user-defined metadata
318
+ * ```javascript
319
+ * // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
320
+ * const input = {
321
+ * "Body": "filetoupload",
322
+ * "Bucket": "examplebucket",
323
+ * "Key": "exampleobject",
324
+ * "Metadata": {
325
+ * "metadata1": "value1",
326
+ * "metadata2": "value2"
327
+ * }
328
+ * };
329
+ * const command = new PutObjectCommand(input);
330
+ * const response = await client.send(command);
331
+ * /* response ==
332
+ * {
333
+ * "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
334
+ * "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
335
+ * }
336
+ * *\/
337
+ * // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
338
+ * ```
339
+ *
340
340
  */
341
341
  export declare class PutObjectCommand extends $Command<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig> {
342
342
  readonly input: PutObjectCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-s3",
3
3
  "description": "AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native",
4
- "version": "3.400.0",
4
+ "version": "3.405.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -25,9 +25,9 @@
25
25
  "@aws-crypto/sha1-browser": "3.0.0",
26
26
  "@aws-crypto/sha256-browser": "3.0.0",
27
27
  "@aws-crypto/sha256-js": "3.0.0",
28
- "@aws-sdk/client-sts": "3.398.0",
29
- "@aws-sdk/credential-provider-node": "3.398.0",
30
- "@aws-sdk/middleware-bucket-endpoint": "3.398.0",
28
+ "@aws-sdk/client-sts": "3.405.0",
29
+ "@aws-sdk/credential-provider-node": "3.405.0",
30
+ "@aws-sdk/middleware-bucket-endpoint": "3.405.0",
31
31
  "@aws-sdk/middleware-expect-continue": "3.398.0",
32
32
  "@aws-sdk/middleware-flexible-checksums": "3.400.0",
33
33
  "@aws-sdk/middleware-host-header": "3.398.0",
@@ -42,7 +42,7 @@
42
42
  "@aws-sdk/types": "3.398.0",
43
43
  "@aws-sdk/util-endpoints": "3.398.0",
44
44
  "@aws-sdk/util-user-agent-browser": "3.398.0",
45
- "@aws-sdk/util-user-agent-node": "3.398.0",
45
+ "@aws-sdk/util-user-agent-node": "3.405.0",
46
46
  "@aws-sdk/xml-builder": "3.310.0",
47
47
  "@smithy/config-resolver": "^2.0.5",
48
48
  "@smithy/eventstream-serde-browser": "^2.0.5",
@@ -59,7 +59,7 @@
59
59
  "@smithy/middleware-retry": "^2.0.5",
60
60
  "@smithy/middleware-serde": "^2.0.5",
61
61
  "@smithy/middleware-stack": "^2.0.0",
62
- "@smithy/node-config-provider": "^2.0.5",
62
+ "@smithy/node-config-provider": "^2.0.6",
63
63
  "@smithy/node-http-handler": "^2.0.5",
64
64
  "@smithy/protocol-http": "^2.0.5",
65
65
  "@smithy/smithy-client": "^2.0.5",
@@ -68,8 +68,8 @@
68
68
  "@smithy/util-base64": "^2.0.0",
69
69
  "@smithy/util-body-length-browser": "^2.0.0",
70
70
  "@smithy/util-body-length-node": "^2.1.0",
71
- "@smithy/util-defaults-mode-browser": "^2.0.5",
72
- "@smithy/util-defaults-mode-node": "^2.0.5",
71
+ "@smithy/util-defaults-mode-browser": "^2.0.6",
72
+ "@smithy/util-defaults-mode-node": "^2.0.6",
73
73
  "@smithy/util-retry": "^2.0.0",
74
74
  "@smithy/util-stream": "^2.0.5",
75
75
  "@smithy/util-utf8": "^2.0.0",