Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430193167.6 KB

Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

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

Headers

X-Amz-Target'B2BI.UpdateTransformer' required

Request body

transformerIdstring required

Specifies the system-assigned unique identifier for the transformer.

namestring

Specify a new name for the transformer, if you want to update it.

status'active' | 'inactive'

Specifies the transformer's status. You can update the state of the transformer from <code>inactive</code> to <code>active</code>.

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.

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.

modifiedAtstring date-time required

Returns a timestamp for last time the transformer was modified.

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.