Skip to content

Commit 0e11f36

Browse files
committed
chore: discard example trashing
1 parent 62decea commit 0e11f36

File tree

9 files changed

+170
-229
lines changed

9 files changed

+170
-229
lines changed

clients/client-b2bi/src/commands/CreateTransformerCommand.ts

Lines changed: 18 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -204,29 +204,17 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
204204
* ```javascript
205205
* //
206206
* const input = {
207-
* "name": "transformX12",
207+
* "name": "transformJSON",
208208
* "clientToken": "foo",
209-
* "inputConversion": {
210-
* "formatOptions": {
211-
* "x12": {
212-
* "version": "VERSION_4010",
213-
* "transactionSet": "X12_110"
214-
* }
215-
* },
216-
* "fromFormat": "X12"
217-
* },
218-
* "mapping": {
219-
* "template": "{}",
220-
* "templateLanguage": "JSONATA"
221-
* },
222-
* "sampleDocuments": {
223-
* "bucketName": "test-bucket",
224-
* "keys": [
225-
* {
226-
* "input": "sampleDoc.txt"
227-
* }
228-
* ]
209+
* "ediType": {
210+
* "x12Details": {
211+
* "version": "VERSION_4010",
212+
* "transactionSet": "X12_110"
213+
* }
229214
* },
215+
* "fileFormat": "JSON",
216+
* "mappingTemplate": "{}",
217+
* "sampleDocument": "s3://test-bucket/sampleDoc.txt",
230218
* "tags": [
231219
* {
232220
* "Key": "sampleKey",
@@ -238,29 +226,17 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
238226
* const response = await client.send(command);
239227
* /* response ==
240228
* {
241-
* "name": "transformX12",
229+
* "name": "transformJSON",
242230
* "createdAt": "2023-11-01T21:51:05.504Z",
243-
* "inputConversion": {
244-
* "formatOptions": {
245-
* "x12": {
246-
* "version": "VERSION_4010",
247-
* "transactionSet": "X12_110"
248-
* }
249-
* },
250-
* "fromFormat": "X12"
251-
* },
252-
* "mapping": {
253-
* "template": "{}",
254-
* "templateLanguage": "JSONATA"
255-
* },
256-
* "sampleDocuments": {
257-
* "bucketName": "test-bucket",
258-
* "keys": [
259-
* {
260-
* "input": "sampleDoc.txt"
261-
* }
262-
* ]
231+
* "ediType": {
232+
* "x12Details": {
233+
* "version": "VERSION_4010",
234+
* "transactionSet": "X12_110"
235+
* }
263236
* },
237+
* "fileFormat": "JSON",
238+
* "mappingTemplate": "$",
239+
* "sampleDocument": "s3://test-bucket/sampleDoc.txt",
264240
* "status": "inactive",
265241
* "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
266242
* "transformerId": "tr-974c129999f84d8c9"

clients/client-b2bi/src/commands/GetTransformerCommand.ts

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -127,29 +127,18 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M
127127
* const response = await client.send(command);
128128
* /* response ==
129129
* {
130-
* "name": "transformX12",
130+
* "name": "transformJSON",
131131
* "createdAt": "2023-11-01T21:51:05.504Z",
132-
* "inputConversion": {
133-
* "formatOptions": {
134-
* "x12": {
135-
* "version": "VERSION_4010",
136-
* "transactionSet": "X12_110"
137-
* }
138-
* },
139-
* "fromFormat": "X12"
140-
* },
141-
* "mapping": {
142-
* "template": "{}",
143-
* "templateLanguage": "JSONATA"
144-
* },
145-
* "sampleDocuments": {
146-
* "bucketName": "test-bucket",
147-
* "keys": [
148-
* {
149-
* "input": "sampleDoc.txt"
150-
* }
151-
* ]
132+
* "ediType": {
133+
* "x12Details": {
134+
* "version": "VERSION_4010",
135+
* "transactionSet": "X12_110"
136+
* }
152137
* },
138+
* "fileFormat": "JSON",
139+
* "mappingTemplate": "$",
140+
* "modifiedAt": "2023-11-01T21:51:05.504Z",
141+
* "sampleDocument": "s3://test-bucket/sampleDoc.txt",
153142
* "status": "inactive",
154143
* "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
155144
* "transformerId": "tr-974c129999f84d8c9"

clients/client-b2bi/src/commands/UpdateTransformerCommand.ts

Lines changed: 20 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -169,61 +169,37 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons
169169
* ```javascript
170170
* //
171171
* const input = {
172-
* "name": "transformX12",
173-
* "inputConversion": {
174-
* "formatOptions": {
175-
* "x12": {
176-
* "version": "VERSION_4010",
177-
* "transactionSet": "X12_110"
178-
* }
179-
* },
180-
* "fromFormat": "X12"
181-
* },
182-
* "mapping": {
183-
* "template": "{}",
184-
* "templateLanguage": "JSONATA"
185-
* },
186-
* "sampleDocuments": {
187-
* "bucketName": "test-bucket",
188-
* "keys": [
189-
* {
190-
* "input": "sampleDoc.txt"
191-
* }
192-
* ]
172+
* "name": "transformJSON",
173+
* "ediType": {
174+
* "x12Details": {
175+
* "version": "VERSION_4010",
176+
* "transactionSet": "X12_110"
177+
* }
193178
* },
179+
* "fileFormat": "JSON",
180+
* "mappingTemplate": "{}",
181+
* "sampleDocument": "s3://test-bucket/sampleDoc.txt",
194182
* "status": "inactive",
195183
* "transformerId": "tr-974c129999f84d8c9"
196184
* };
197185
* const command = new UpdateTransformerCommand(input);
198186
* const response = await client.send(command);
199187
* /* response ==
200188
* {
201-
* "name": "transformX12",
189+
* "name": "transformJSON",
202190
* "createdAt": "2023-11-01T21:51:05.504Z",
203-
* "inputConversion": {
204-
* "formatOptions": {
205-
* "x12": {
206-
* "version": "VERSION_4010",
207-
* "transactionSet": "X12_110"
208-
* }
209-
* },
210-
* "fromFormat": "X12"
211-
* },
212-
* "mapping": {
213-
* "template": "{}",
214-
* "templateLanguage": "JSONATA"
215-
* },
216-
* "modifiedAt": "2023-11-02T22:31:05.504Z",
217-
* "sampleDocuments": {
218-
* "bucketName": "test-bucket",
219-
* "keys": [
220-
* {
221-
* "input": "sampleDoc.txt"
222-
* }
223-
* ]
191+
* "ediType": {
192+
* "x12Details": {
193+
* "version": "VERSION_4010",
194+
* "transactionSet": "X12_110"
195+
* }
224196
* },
197+
* "fileFormat": "JSON",
198+
* "mappingTemplate": "$",
199+
* "modifiedAt": "2023-11-01T21:51:05.504Z",
200+
* "sampleDocument": "s3://test-bucket/sampleDoc.txt",
225201
* "status": "inactive",
226-
* "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-974c129999f84d8c9",
202+
* "transformerArn": "arn:aws:b2bi:us-west-2:607686414464:transformer/tr-974c129999f84d8c9",
227203
* "transformerId": "tr-974c129999f84d8c9"
228204
* }
229205
* *\/

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -163,28 +163,28 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
163163
* <p>Base exception class for all service exceptions from S3 service.</p>
164164
*
165165
* @public
166-
* @example To delete an object
166+
* @example To delete an object (from a non-versioned bucket)
167167
* ```javascript
168-
* // The following example deletes an object from an S3 bucket.
168+
* // The following example deletes an object from a non-versioned bucket.
169169
* const input = {
170-
* "Bucket": "examplebucket",
171-
* "Key": "objectkey.jpg"
170+
* "Bucket": "ExampleBucket",
171+
* "Key": "HappyFace.jpg"
172172
* };
173173
* const command = new DeleteObjectCommand(input);
174174
* await client.send(command);
175-
* // example id: to-delete-an-object-1472850136595
175+
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
176176
* ```
177177
*
178-
* @example To delete an object (from a non-versioned bucket)
178+
* @example To delete an object
179179
* ```javascript
180-
* // The following example deletes an object from a non-versioned bucket.
180+
* // The following example deletes an object from an S3 bucket.
181181
* const input = {
182-
* "Bucket": "ExampleBucket",
183-
* "Key": "HappyFace.jpg"
182+
* "Bucket": "examplebucket",
183+
* "Key": "objectkey.jpg"
184184
* };
185185
* const command = new DeleteObjectCommand(input);
186186
* await client.send(command);
187-
* // example id: to-delete-an-object-from-a-non-versioned-bucket-1481588533089
187+
* // example id: to-delete-an-object-1472850136595
188188
* ```
189189
*
190190
*/

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -213,18 +213,20 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
213213
* <p>Base exception class for all service exceptions from S3 service.</p>
214214
*
215215
* @public
216-
* @example To delete multiple objects from a versioned bucket
216+
* @example To delete multiple object versions from a versioned bucket
217217
* ```javascript
218-
* // 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.
218+
* // 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.
219219
* const input = {
220220
* "Bucket": "examplebucket",
221221
* "Delete": {
222222
* "Objects": [
223223
* {
224-
* "Key": "objectkey1"
224+
* "Key": "HappyFace.jpg",
225+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
225226
* },
226227
* {
227-
* "Key": "objectkey2"
228+
* "Key": "HappyFace.jpg",
229+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
228230
* }
229231
* ],
230232
* "Quiet": false
@@ -236,35 +238,31 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
236238
* {
237239
* "Deleted": [
238240
* {
239-
* "DeleteMarker": "true",
240-
* "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
241-
* "Key": "objectkey1"
241+
* "Key": "HappyFace.jpg",
242+
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
242243
* },
243244
* {
244-
* "DeleteMarker": "true",
245-
* "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
246-
* "Key": "objectkey2"
245+
* "Key": "HappyFace.jpg",
246+
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
247247
* }
248248
* ]
249249
* }
250250
* *\/
251-
* // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
251+
* // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
252252
* ```
253253
*
254-
* @example To delete multiple object versions from a versioned bucket
254+
* @example To delete multiple objects from a versioned bucket
255255
* ```javascript
256-
* // 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.
256+
* // 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.
257257
* const input = {
258258
* "Bucket": "examplebucket",
259259
* "Delete": {
260260
* "Objects": [
261261
* {
262-
* "Key": "HappyFace.jpg",
263-
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
262+
* "Key": "objectkey1"
264263
* },
265264
* {
266-
* "Key": "HappyFace.jpg",
267-
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
265+
* "Key": "objectkey2"
268266
* }
269267
* ],
270268
* "Quiet": false
@@ -276,17 +274,19 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad
276274
* {
277275
* "Deleted": [
278276
* {
279-
* "Key": "HappyFace.jpg",
280-
* "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd"
277+
* "DeleteMarker": "true",
278+
* "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F",
279+
* "Key": "objectkey1"
281280
* },
282281
* {
283-
* "Key": "HappyFace.jpg",
284-
* "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b"
282+
* "DeleteMarker": "true",
283+
* "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt",
284+
* "Key": "objectkey2"
285285
* }
286286
* ]
287287
* }
288288
* *\/
289-
* // example id: to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737
289+
* // example id: to-delete-multiple-objects-from-a-versioned-bucket-1483146248805
290290
* ```
291291
*
292292
*/

0 commit comments

Comments
 (0)