chore: discard example trashing

aws · Oct 4, 2024 · 0e11f36 · 0e11f36
1 parent 62decea
commit 0e11f36
Show file tree

Hide file tree

Showing 9 changed files with 170 additions and 229 deletions.
diff --git a/clients/client-b2bi/src/commands/CreateTransformerCommand.ts b/clients/client-b2bi/src/commands/CreateTransformerCommand.ts
@@ -204,29 +204,17 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
  * ```javascript
  * //
  * const input = {
- *   "name": "transformX12",
+ *   "name": "transformJSON",
  *   "clientToken": "foo",
- *   "inputConversion": {
- *     "formatOptions": {
- *       "x12": {
- *         "version": "VERSION_4010",
- *         "transactionSet": "X12_110"
- *       }
- *     },
- *     "fromFormat": "X12"
- *   },
- *   "mapping": {
- *     "template": "{}",
- *     "templateLanguage": "JSONATA"
- *   },
- *   "sampleDocuments": {
- *     "bucketName": "test-bucket",
- *     "keys": [
- *       {
- *         "input": "sampleDoc.txt"
- *       }
- *     ]
+ *   "ediType": {
+ *     "x12Details": {
+ *       "version": "VERSION_4010",
+ *       "transactionSet": "X12_110"
+ *     }
  *   },
+ *   "fileFormat": "JSON",
+ *   "mappingTemplate": "{}",
+ *   "sampleDocument": "s3://test-bucket/sampleDoc.txt",
  *   "tags": [
  *     {
  *       "Key": "sampleKey",
@@ -238,29 +226,17 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "name": "transformX12",
+ *   "name": "transformJSON",
  *   "createdAt": "2023-11-01T21:51:05.504Z",
- *   "inputConversion": {
- *     "formatOptions": {
- *       "x12": {
- *         "version": "VERSION_4010",
- *         "transactionSet": "X12_110"
- *       }
- *     },
- *     "fromFormat": "X12"
- *   },
- *   "mapping": {
- *     "template": "{}",
- *     "templateLanguage": "JSONATA"
- *   },
- *   "sampleDocuments": {
- *     "bucketName": "test-bucket",
- *     "keys": [
- *       {
- *         "input": "sampleDoc.txt"
- *       }
- *     ]
+ *   "ediType": {
+ *     "x12Details": {
+ *       "version": "VERSION_4010",
+ *       "transactionSet": "X12_110"
+ *     }
  *   },
+ *   "fileFormat": "JSON",
+ *   "mappingTemplate": "$",
+ *   "sampleDocument": "s3://test-bucket/sampleDoc.txt",
  *   "status": "inactive",
  *   "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
  *   "transformerId": "tr-974c129999f84d8c9"

diff --git a/clients/client-b2bi/src/commands/GetTransformerCommand.ts b/clients/client-b2bi/src/commands/GetTransformerCommand.ts
@@ -127,29 +127,18 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "name": "transformX12",
+ *   "name": "transformJSON",
  *   "createdAt": "2023-11-01T21:51:05.504Z",
- *   "inputConversion": {
- *     "formatOptions": {
- *       "x12": {
- *         "version": "VERSION_4010",
- *         "transactionSet": "X12_110"
- *       }
- *     },
- *     "fromFormat": "X12"
- *   },
- *   "mapping": {
- *     "template": "{}",
- *     "templateLanguage": "JSONATA"
- *   },
- *   "sampleDocuments": {
- *     "bucketName": "test-bucket",
- *     "keys": [
- *       {
- *         "input": "sampleDoc.txt"
- *       }
- *     ]
+ *   "ediType": {
+ *     "x12Details": {
+ *       "version": "VERSION_4010",
+ *       "transactionSet": "X12_110"
+ *     }
  *   },
+ *   "fileFormat": "JSON",
+ *   "mappingTemplate": "$",
+ *   "modifiedAt": "2023-11-01T21:51:05.504Z",
+ *   "sampleDocument": "s3://test-bucket/sampleDoc.txt",
  *   "status": "inactive",
  *   "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
  *   "transformerId": "tr-974c129999f84d8c9"

diff --git a/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts b/clients/client-b2bi/src/commands/UpdateTransformerCommand.ts
@@ -169,61 +169,37 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons
  * ```javascript
  * //
  * const input = {
- *   "name": "transformX12",
- *   "inputConversion": {
- *     "formatOptions": {
- *       "x12": {
- *         "version": "VERSION_4010",
- *         "transactionSet": "X12_110"
- *       }
- *     },
- *     "fromFormat": "X12"
- *   },
- *   "mapping": {
- *     "template": "{}",
- *     "templateLanguage": "JSONATA"
- *   },
- *   "sampleDocuments": {
- *     "bucketName": "test-bucket",
- *     "keys": [
- *       {
- *         "input": "sampleDoc.txt"
- *       }
- *     ]
+ *   "name": "transformJSON",
+ *   "ediType": {
+ *     "x12Details": {
+ *       "version": "VERSION_4010",
+ *       "transactionSet": "X12_110"
+ *     }
  *   },
+ *   "fileFormat": "JSON",
+ *   "mappingTemplate": "{}",
+ *   "sampleDocument": "s3://test-bucket/sampleDoc.txt",
  *   "status": "inactive",
  *   "transformerId": "tr-974c129999f84d8c9"
  * };
  * const command = new UpdateTransformerCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "name": "transformX12",
+ *   "name": "transformJSON",
  *   "createdAt": "2023-11-01T21:51:05.504Z",
- *   "inputConversion": {
- *     "formatOptions": {
- *       "x12": {
- *         "version": "VERSION_4010",
- *         "transactionSet": "X12_110"
- *       }
- *     },
- *     "fromFormat": "X12"
- *   },
- *   "mapping": {
- *     "template": "{}",
- *     "templateLanguage": "JSONATA"
- *   },
- *   "modifiedAt": "2023-11-02T22:31:05.504Z",
- *   "sampleDocuments": {
- *     "bucketName": "test-bucket",
- *     "keys": [
- *       {
- *         "input": "sampleDoc.txt"
- *       }
- *     ]
+ *   "ediType": {
+ *     "x12Details": {
+ *       "version": "VERSION_4010",
+ *       "transactionSet": "X12_110"
+ *     }
  *   },
+ *   "fileFormat": "JSON",
+ *   "mappingTemplate": "$",
+ *   "modifiedAt": "2023-11-01T21:51:05.504Z",
+ *   "sampleDocument": "s3://test-bucket/sampleDoc.txt",
  *   "status": "inactive",
- *   "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
+ *   "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9",
  *   "transformerId": "tr-974c129999f84d8c9"
  * }
  * *\/

diff --git a/clients/client-s3/src/commands/DeleteObjectCommand.ts b/clients/client-s3/src/commands/DeleteObjectCommand.ts
@@ -163,28 +163,28 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @example To delete an object
+ * @example To delete an object (from a non-versioned bucket)
  * ```javascript
- * // The following example deletes an object from an S3 bucket.
+ * // The following example deletes an object from a non-versioned bucket.
  * const input = {
- *   "Bucket": "examplebucket",
- *   "Key": "objectkey.jpg"
+ *   "Bucket": "ExampleBucket",
+ *   "Key": "HappyFace.jpg"
  * };
  * const command = new DeleteObjectCommand(input);
  * await client.send(command);
- * // example id: to-delete-an-object-1472850136595
+ * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
  * ```
  *
- * @example To delete an object (from a non-versioned bucket)
+ * @example To delete an object
  * ```javascript
- * // The following example deletes an object from a non-versioned bucket.
+ * // The following example deletes an object from an S3 bucket.
  * const input = {
- *   "Bucket": "ExampleBucket",
- *   "Key": "HappyFace.jpg"
+ *   "Bucket": "examplebucket",
+ *   "Key": "objectkey.jpg"
  * };
  * const command = new DeleteObjectCommand(input);
  * await client.send(command);
- * // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
+ * // example id: to-delete-an-object-1472850136595
  * ```
  *
  */

diff --git a/clients/client-s3/src/commands/DeleteObjectsCommand.ts b/clients/client-s3/src/commands/DeleteObjectsCommand.ts
@@ -213,18 +213,20 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * <p>Base exception class for all service exceptions from S3 service.</p>
  *
  * @public
- * @example To delete multiple objects from a versioned bucket
+ * @example To delete multiple object versions from a versioned bucket
  * ```javascript
- * // 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.
+ * // 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.
  * const input = {
  *   "Bucket": "examplebucket",
  *   "Delete": {
  *     "Objects": [
  *       {
- *         "Key": "objectkey1"
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
  *       },
  *       {
- *         "Key": "objectkey2"
+ *         "Key": "HappyFace.jpg",
+ *         "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
  *       }
  *     ],
  *     "Quiet": false
@@ -236,35 +238,31 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * {
  *   "Deleted": [
  *     {
- *       "DeleteMarker": "true",
- *       "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
- *       "Key": "objectkey1"
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
  *     },
  *     {
- *       "DeleteMarker": "true",
- *       "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
- *       "Key": "objectkey2"
+ *       "Key": "HappyFace.jpg",
+ *       "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
+ * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
  * ```
  *
- * @example To delete multiple object versions from a versioned bucket
+ * @example To delete multiple objects from a versioned bucket
  * ```javascript
- * // 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.
+ * // 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.
  * const input = {
  *   "Bucket": "examplebucket",
  *   "Delete": {
  *     "Objects": [
  *       {
- *         "Key": "HappyFace.jpg",
- *         "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *         "Key": "objectkey1"
  *       },
  *       {
- *         "Key": "HappyFace.jpg",
- *         "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *         "Key": "objectkey2"
  *       }
  *     ],
  *     "Quiet": false
@@ -276,17 +274,19 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
  * {
  *   "Deleted": [
  *     {
- *       "Key": "HappyFace.jpg",
- *       "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
+ *       "Key": "objectkey1"
  *     },
  *     {
- *       "Key": "HappyFace.jpg",
- *       "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
+ *       "DeleteMarker": "true",
+ *       "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
+ *       "Key": "objectkey2"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
+ * // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
  * ```
  *
  */