Skip to content

Commit 2b34613

Browse files
kuhekuhe
committed
chore(codegen): sync nested clients
1 parent b406e80 commit 2b34613

File tree

2 files changed

+57
-57
lines changed

2 files changed

+57
-57
lines changed

‎clients/client-s3/src/commands/DeleteObjectCommand.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -167,28 +167,28 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
167167
* <p>Base exception class for all service exceptions from S3 service.</p>
168168
*
169169
* @public
170-
* @example To delete an object (from a non-versioned bucket)
170+
* @example To delete an object
171171
* ```javascript
172-
* // The following example deletes an object from a non-versioned bucket.
172+
* // The following example deletes an object from an S3 bucket.
173173
* const input = {
174-
* "Bucket": "ExampleBucket",
175-
* "Key": "HappyFace.jpg"
174+
* "Bucket": "examplebucket",
175+
* "Key": "objectkey.jpg"
176176
* };
177177
* const command = new DeleteObjectCommand(input);
178178
* await client.send(command);
179-
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
179+
* // example id: to-delete-an-object-1472850136595
180180
* ```
181181
*
182-
* @example To delete an object
182+
* @example To delete an object (from a non-versioned bucket)
183183
* ```javascript
184-
* // The following example deletes an object from an S3 bucket.
184+
* // The following example deletes an object from a non-versioned bucket.
185185
* const input = {
186-
* "Bucket": "examplebucket",
187-
* "Key": "objectkey.jpg"
186+
* "Bucket": "ExampleBucket",
187+
* "Key": "HappyFace.jpg"
188188
* };
189189
* const command = new DeleteObjectCommand(input);
190190
* await client.send(command);
191-
* // example id: to-delete-an-object-1472850136595
191+
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
192192
* ```
193193
*
194194
*/

‎clients/client-s3/src/commands/PutObjectCommand.ts‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -302,149 +302,149 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
302302
* <p>Base exception class for all service exceptions from S3 service.</p>
303303
*
304304
* @public
305-
* @example To upload an object and specify canned ACL.
305+
* @example To create an object.
306306
* ```javascript
307-
* // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
307+
* // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
308308
* const input = {
309-
* "ACL": "authenticated-read",
310309
* "Body": "filetoupload",
311310
* "Bucket": "examplebucket",
312-
* "Key": "exampleobject"
311+
* "Key": "objectkey"
313312
* };
314313
* const command = new PutObjectCommand(input);
315314
* const response = await client.send(command);
316315
* /* response ==
317316
* {
318317
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
319-
* "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
318+
* "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
320319
* }
321320
* *\/
322-
* // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
321+
* // example id: to-create-an-object-1483147613675
323322
* ```
324323
*
325-
* @example To create an object.
324+
* @example To upload an object
326325
* ```javascript
327-
* // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
326+
* // 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.
328327
* const input = {
329-
* "Body": "filetoupload",
328+
* "Body": "HappyFace.jpg",
330329
* "Bucket": "examplebucket",
331-
* "Key": "objectkey"
330+
* "Key": "HappyFace.jpg"
332331
* };
333332
* const command = new PutObjectCommand(input);
334333
* const response = await client.send(command);
335334
* /* response ==
336335
* {
337336
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
338-
* "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ"
337+
* "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
339338
* }
340339
* *\/
341-
* // example id: to-create-an-object-1483147613675
340+
* // example id: to-upload-an-object-1481760101010
342341
* ```
343342
*
344-
* @example To upload an object and specify optional tags
343+
* @example To upload an object and specify server-side encryption and object tags
345344
* ```javascript
346-
* // 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.
345+
* // 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.
347346
* const input = {
348-
* "Body": "c:\\HappyFace.jpg",
347+
* "Body": "filetoupload",
349348
* "Bucket": "examplebucket",
350-
* "Key": "HappyFace.jpg",
349+
* "Key": "exampleobject",
350+
* "ServerSideEncryption": "AES256",
351351
* "Tagging": "key1=value1&key2=value2"
352352
* };
353353
* const command = new PutObjectCommand(input);
354354
* const response = await client.send(command);
355355
* /* response ==
356356
* {
357357
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
358-
* "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
358+
* "ServerSideEncryption": "AES256",
359+
* "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
359360
* }
360361
* *\/
361-
* // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
362+
* // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
362363
* ```
363364
*
364-
* @example To upload an object and specify server-side encryption and object tags
365+
* @example To upload object and specify user-defined metadata
365366
* ```javascript
366-
* // 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.
367+
* // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
367368
* const input = {
368369
* "Body": "filetoupload",
369370
* "Bucket": "examplebucket",
370371
* "Key": "exampleobject",
371-
* "ServerSideEncryption": "AES256",
372-
* "Tagging": "key1=value1&key2=value2"
372+
* "Metadata": {
373+
* "metadata1": "value1",
374+
* "metadata2": "value2"
375+
* }
373376
* };
374377
* const command = new PutObjectCommand(input);
375378
* const response = await client.send(command);
376379
* /* response ==
377380
* {
378381
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
379-
* "ServerSideEncryption": "AES256",
380-
* "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt"
382+
* "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
381383
* }
382384
* *\/
383-
* // example id: to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831
385+
* // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
384386
* ```
385387
*
386-
* @example To upload an object (specify optional headers)
388+
* @example To upload an object and specify optional tags
387389
* ```javascript
388-
* // 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.
390+
* // 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.
389391
* const input = {
390-
* "Body": "HappyFace.jpg",
392+
* "Body": "c:\\HappyFace.jpg",
391393
* "Bucket": "examplebucket",
392394
* "Key": "HappyFace.jpg",
393-
* "ServerSideEncryption": "AES256",
394-
* "StorageClass": "STANDARD_IA"
395+
* "Tagging": "key1=value1&key2=value2"
395396
* };
396397
* const command = new PutObjectCommand(input);
397398
* const response = await client.send(command);
398399
* /* response ==
399400
* {
400401
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
401-
* "ServerSideEncryption": "AES256",
402-
* "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
402+
* "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a"
403403
* }
404404
* *\/
405-
* // example id: to-upload-an-object-(specify-optional-headers)
405+
* // example id: to-upload-an-object-and-specify-optional-tags-1481762310955
406406
* ```
407407
*
408-
* @example To upload an object
408+
* @example To upload an object (specify optional headers)
409409
* ```javascript
410-
* // 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.
410+
* // 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.
411411
* const input = {
412412
* "Body": "HappyFace.jpg",
413413
* "Bucket": "examplebucket",
414-
* "Key": "HappyFace.jpg"
414+
* "Key": "HappyFace.jpg",
415+
* "ServerSideEncryption": "AES256",
416+
* "StorageClass": "STANDARD_IA"
415417
* };
416418
* const command = new PutObjectCommand(input);
417419
* const response = await client.send(command);
418420
* /* response ==
419421
* {
420422
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
421-
* "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk"
423+
* "ServerSideEncryption": "AES256",
424+
* "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp"
422425
* }
423426
* *\/
424-
* // example id: to-upload-an-object-1481760101010
427+
* // example id: to-upload-an-object-(specify-optional-headers)
425428
* ```
426429
*
427-
* @example To upload object and specify user-defined metadata
430+
* @example To upload an object and specify canned ACL.
428431
* ```javascript
429-
* // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
432+
* // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
430433
* const input = {
434+
* "ACL": "authenticated-read",
431435
* "Body": "filetoupload",
432436
* "Bucket": "examplebucket",
433-
* "Key": "exampleobject",
434-
* "Metadata": {
435-
* "metadata1": "value1",
436-
* "metadata2": "value2"
437-
* }
437+
* "Key": "exampleobject"
438438
* };
439439
* const command = new PutObjectCommand(input);
440440
* const response = await client.send(command);
441441
* /* response ==
442442
* {
443443
* "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
444-
* "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0"
444+
* "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr"
445445
* }
446446
* *\/
447-
* // example id: to-upload-object-and-specify-user-defined-metadata-1483396974757
447+
* // example id: to-upload-an-object-and-specify-canned-acl-1483397779571
448448
* ```
449449
*
450450
*/

0 commit comments

Comments
 (0)