ListTransformers - AWS B2B Data Interchange

ListTransformers

Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

Request Syntax

{ "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

maxResults

Specifies the number of items to return for the API response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax

{ "nextToken": "string", "transformers": [ { "createdAt": "string", "ediType": { ... }, "fileFormat": "string", "mappingTemplate": "string", "modifiedAt": "string", "name": "string", "sampleDocument": "string", "status": "string", "transformerId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

transformers

Returns an array of one or more transformer objects.

For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.

Type: Array of TransformerSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

Example

The following example lists the transformers for your account and in your region. Note that in this example, there is only one transformer listed: however, this call would return up to 50 transformers.

Sample Request

{ "maxResults": 50, "nextToken": "foo" }

Sample Response

{ "nextToken": "foo", "transformers": [ { "createdAt": "2023-11-01T21:51:05.504Z", "ediType": { "x12Details": { "transactionSet": "X12_110", "version": "VERSION_4010" } }, "fileFormat": "JSON", "mappingTemplate": "$", "modifiedAt": "2023-11-01T21:51:05.504Z", "name": "transformJSON", "sampleDocument": "s3://test-bucket/sampleDoc.txt", "status": "inactive", "transformerId": "tr-1234abcd5678efghj" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: