Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430193167.6 KB

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:

  • Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.

  • Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.

  • Use the mapping data type in place of mappingTemplate and fileFormat

  • Use the sampleDocuments data type in place of sampleDocument

  • Use either the inputConversion or outputConversion in place of ediType

post/#X-Amz-Target=B2BI.CreateTransformer

Headers

X-Amz-Target'B2BI.CreateTransformer' required

Request body

namestring required

Specifies the name of the transformer, used to identify it.

clientTokenstring

Reserved for future use.

fileFormat'XML' | 'JSON' | 'NOT_USED'

Specifies that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.This is a legacy trait. Please use input-conversion or output-conversion.

mappingTemplatestring
<p>Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.</p> <note> <p>This parameter is available for backwards compatibility. Use the <a href="https://docs.aws.amazon.com/b2bi/latest/APIReference/API_Mapping.html">Mapping</a> data type instead.</p> </note>This is a legacy trait. Please use input-conversion or output-conversion.
sampleDocumentstring

Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.This is a legacy trait. Please use input-conversion or output-conversion.

Response

Success

transformerIdstring required

Returns the system-assigned unique identifier for the transformer.

transformerArnstring required

Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

namestring required

Returns the name of the transformer, used to identify it.

status'active' | 'inactive' required

Returns the state of the newly created transformer. The transformer can be either <code>active</code> or <code>inactive</code>. For the transformer to be used in a capability, its status must <code>active</code>.

createdAtstring date-time required

Returns a timestamp for creation date and time of the transformer.

fileFormat'XML' | 'JSON' | 'NOT_USED'

Returns that the currently supported file formats for EDI transformations are <code>JSON</code> and <code>XML</code>.This is a legacy trait. Please use input-conversion or output-conversion.

mappingTemplatestring

Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.This is a legacy trait. Please use input-conversion or output-conversion.

sampleDocumentstring

Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.This is a legacy trait. Please use input-conversion or output-conversion.