Contains the details for a transformer object. 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.
Contents
- createdAt
-
Returns a timestamp indicating when the transformer was created. For example,
2023-07-20T19:58:44.624Z.Type: Timestamp
Required: Yes
- name
-
Returns the descriptive name for the transformer.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 254.
Pattern:
[a-zA-Z0-9_-]{1,512}Required: Yes
- status
-
Returns the state of the newly created transformer. The transformer can be either
activeorinactive. For the transformer to be used in a capability, its status mustactive.Type: String
Valid Values:
active | inactiveRequired: Yes
- transformerId
-
Returns the system-assigned unique identifier for the transformer.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ediType
-
This member has been deprecated.
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
Type: EdiType object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- fileFormat
-
This member has been deprecated.
Returns that the currently supported file formats for EDI transformations are
JSONandXML.Type: String
Valid Values:
XML | JSON | NOT_USEDRequired: No
- inputConversion
-
Returns a structure that contains the format options for the transformation.
Type: InputConversion object
Required: No
- mapping
-
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
Type: Mapping object
Required: No
- mappingTemplate
-
This member has been deprecated.
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 350000.
Required: No
- modifiedAt
-
Returns a timestamp representing the date and time for the most recent change for the transformer object.
Type: Timestamp
Required: No
- outputConversion
-
Returns the
OutputConversionobject, which contains the format options for the outbound transformation.Type: OutputConversion object
Required: No
- sampleDocument
-
This member has been deprecated.
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- sampleDocuments
-
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
Type: SampleDocuments object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
