chore(client-s3): example docgen diff

Author: kuhe

clients/client-s3/src/commands/AbortMultipartUploadCommand.ts

@@ -151,20 +151,23 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To abort a multipart upload
  * ```javascript
  * // The following example aborts a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "bigobject",
- *   "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ *   Bucket: "examplebucket",
+ *   Key: "bigobject",
+ *   UploadId: "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
  * };
  * const command = new AbortMultipartUploadCommand(input);
- * await client.send(command);
- * // example id: to-abort-a-multipart-upload-1481853354987
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export class AbortMultipartUploadCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts

@@ -275,40 +275,40 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To complete multipart upload
  * ```javascript
  * // The following example completes a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "bigobject",
- *   "MultipartUpload": {
- *     "Parts": [
+ *   Bucket: "examplebucket",
+ *   Key: "bigobject",
+ *   MultipartUpload: {
+ *     Parts: [
  *       {
- *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
- *         "PartNumber": "1"
+ *         ETag: `"d8c2eafd90c266e19ab9dcacc479f8af"`,
+ *         PartNumber: 1
  *       },
  *       {
- *         "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"",
- *         "PartNumber": "2"
+ *         ETag: `"d8c2eafd90c266e19ab9dcacc479f8af"`,
+ *         PartNumber: 2
  *       }
  *     ]
  *   },
- *   "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
+ *   UploadId: "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--"
  * };
  * const command = new CompleteMultipartUploadCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Bucket": "acexamplebucket",
- *   "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"",
- *   "Key": "bigobject",
- *   "Location": "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
+ *   Bucket: "acexamplebucket",
+ *   ETag: `"4d9031c7644d8081c2829f4ea23c55f7-2"`,
+ *   Key: "bigobject",
+ *   Location: "https://examplebucket.s3.<Region>.amazonaws.com/bigobject"
  * }
  * *\/
- * // example id: to-complete-multipart-upload-1481851590483
  * ```
  *
+ * @public
  */
 export class CompleteMultipartUploadCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/CopyObjectCommand.ts

@@ -330,28 +330,28 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To copy an object
  * ```javascript
  * // The following example copies an object from one bucket to another.
  * const input = {
- *   "Bucket": "destinationbucket",
- *   "CopySource": "/sourcebucket/HappyFacejpg",
- *   "Key": "HappyFaceCopyjpg"
+ *   Bucket: "destinationbucket",
+ *   CopySource: "/sourcebucket/HappyFacejpg",
+ *   Key: "HappyFaceCopyjpg"
  * };
  * const command = new CopyObjectCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CopyObjectResult": {
- *     "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"",
- *     "LastModified": "2016-12-15T17:38:53.000Z"
+ *   CopyObjectResult: {
+ *     ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
+ *     LastModified: "2016-12-15T17:38:53.000Z"
  *   }
  * }
  * *\/
- * // example id: to-copy-an-object-1481823186878
  * ```
  *
+ * @public
  */
 export class CopyObjectCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/CreateBucketCommand.ts

@@ -234,42 +234,41 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
- * @example To create a bucket
+ *
+ * @example To create a bucket in a specific region
  * ```javascript
- * // The following example creates a bucket.
+ * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket",
+ *   CreateBucketConfiguration: {
+ *     LocationConstraint: "eu-west-1"
+ *   }
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Location": "/examplebucket"
+ *   Location: "http://examplebucket.<Region>.s3.amazonaws.com/"
  * }
  * *\/
- * // example id: to-create-a-bucket--1472851826060
  * ```
  *
- * @example To create a bucket in a specific region
+ * @example To create a bucket
  * ```javascript
- * // The following example creates a bucket. The request specifies an AWS region where to create the bucket.
+ * // The following example creates a bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "CreateBucketConfiguration": {
- *     "LocationConstraint": "eu-west-1"
- *   }
+ *   Bucket: "examplebucket"
  * };
  * const command = new CreateBucketCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Location": "http://examplebucket.<Region>.s3.amazonaws.com/"
+ *   Location: "/examplebucket"
  * }
  * *\/
- * // example id: to-create-a-bucket-in-a-specific-region-1483399072992
  * ```
  *
+ * @public
  */
 export class CreateBucketCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/CreateBucketMetadataTableConfigurationCommand.ts

@@ -123,6 +123,7 @@ export interface CreateBucketMetadataTableConfigurationCommandOutput extends __M
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class CreateBucketMetadataTableConfigurationCommand extends $Command

clients/client-s3/src/commands/CreateMultipartUploadCommand.ts

@@ -373,26 +373,26 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To initiate a multipart upload
  * ```javascript
  * // The following example initiates a multipart upload.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "largeobject"
+ *   Bucket: "examplebucket",
+ *   Key: "largeobject"
  * };
  * const command = new CreateMultipartUploadCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Bucket": "examplebucket",
- *   "Key": "largeobject",
- *   "UploadId": "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
+ *   Bucket: "examplebucket",
+ *   Key: "largeobject",
+ *   UploadId: "ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--"
  * }
  * *\/
- * // example id: to-initiate-a-multipart-upload-1481836794513
  * ```
  *
+ * @public
  */
 export class CreateMultipartUploadCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/CreateSessionCommand.ts

@@ -186,6 +186,7 @@ export interface CreateSessionCommandOutput extends CreateSessionOutput, __Metad
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class CreateSessionCommand extends $Command

clients/client-s3/src/commands/DeleteBucketAnalyticsConfigurationCommand.ts

@@ -88,6 +88,7 @@ export interface DeleteBucketAnalyticsConfigurationCommandOutput extends __Metad
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketAnalyticsConfigurationCommand extends $Command

clients/client-s3/src/commands/DeleteBucketCommand.ts

@@ -111,18 +111,21 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {}
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete a bucket
  * ```javascript
  * // The following example deletes the specified bucket.
  * const input = {
- *   "Bucket": "forrandall2"
+ *   Bucket: "forrandall2"
  * };
  * const command = new DeleteBucketCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-bucket-1473108514262
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export class DeleteBucketCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/DeleteBucketCorsCommand.ts

@@ -77,18 +77,21 @@ export interface DeleteBucketCorsCommandOutput extends __MetadataBearer {}
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete cors configuration on a bucket.
  * ```javascript
  * // The following example deletes CORS configuration on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketCorsCommand(input);
- * await client.send(command);
- * // example id: to-delete-cors-configuration-on-a-bucket-1483042856112
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export class DeleteBucketCorsCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts

@@ -114,6 +114,7 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {}
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketEncryptionCommand extends $Command

clients/client-s3/src/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts

@@ -82,6 +82,7 @@ export interface DeleteBucketIntelligentTieringConfigurationCommandOutput extend
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketIntelligentTieringConfigurationCommand extends $Command

clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts

@@ -86,6 +86,7 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketInventoryConfigurationCommand extends $Command

clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts

@@ -123,18 +123,21 @@ export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {}
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete lifecycle configuration on a bucket.
  * ```javascript
  * // The following example deletes lifecycle configuration on a bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketLifecycleCommand(input);
- * await client.send(command);
- * // example id: to-delete-lifecycle-configuration-on-a-bucket-1483043310583
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export class DeleteBucketLifecycleCommand extends $Command
   .classBuilder<

clients/client-s3/src/commands/DeleteBucketMetadataTableConfigurationCommand.ts

@@ -83,6 +83,7 @@ export interface DeleteBucketMetadataTableConfigurationCommandOutput extends __M
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketMetadataTableConfigurationCommand extends $Command

clients/client-s3/src/commands/DeleteBucketMetricsConfigurationCommand.ts

@@ -94,6 +94,7 @@ export interface DeleteBucketMetricsConfigurationCommandOutput extends __Metadat
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketMetricsConfigurationCommand extends $Command

clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts

@@ -78,6 +78,7 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
+ *
  * @public
  */
 export class DeleteBucketOwnershipControlsCommand extends $Command

clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts

@@ -120,18 +120,21 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {}
  * @throws {@link S3ServiceException}
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
- * @public
+ *
  * @example To delete bucket policy
  * ```javascript
  * // The following example deletes bucket policy on the specified bucket.
  * const input = {
- *   "Bucket": "examplebucket"
+ *   Bucket: "examplebucket"
  * };
  * const command = new DeleteBucketPolicyCommand(input);
- * await client.send(command);
- * // example id: to-delete-bucket-policy-1483043406577
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export class DeleteBucketPolicyCommand extends $Command
   .classBuilder<