Retrieves the details for the transformer specified by the transformer ID. 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.
Request Syntax
{
"transformerId": "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.
- transformerId
-
Specifies 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
Response Syntax
{
"createdAt": "string",
"ediType": { ... },
"fileFormat": "string",
"inputConversion": {
"formatOptions": { ... },
"fromFormat": "string"
},
"mapping": {
"template": "string",
"templateLanguage": "string"
},
"mappingTemplate": "string",
"modifiedAt": "string",
"name": "string",
"outputConversion": {
"formatOptions": { ... },
"toFormat": "string"
},
"sampleDocument": "string",
"sampleDocuments": {
"bucketName": "string",
"keys": [
{
"input": "string",
"output": "string"
}
]
},
"status": "string",
"transformerArn": "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.
- createdAt
-
Returns a timestamp for creation date and time of the transformer.
Type: Timestamp
- ediType
-
This parameter 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.
- fileFormat
-
This parameter has been deprecated.
Returns that the currently supported file formats for EDI transformations are
JSONandXML.Type: String
Valid Values:
XML | JSON | NOT_USED - inputConversion
-
Returns the
InputConversionobject, which contains the format options for the inbound transformation.Type: InputConversion object
- mapping
-
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
Type: Mapping object
- mappingTemplate
-
This parameter 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.
- modifiedAt
-
Returns a timestamp for last time the transformer was modified.
Type: Timestamp
- name
-
Returns the name of the transformer, used to identify it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 254.
Pattern:
[a-zA-Z0-9_-]{1,512} - outputConversion
-
Returns the
OutputConversionobject, which contains the format options for the outbound transformation.Type: OutputConversion object
- sampleDocument
-
This parameter 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.
- 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
- 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 | inactive - transformerArn
-
Returns an Amazon Resource Name (ARN) for a specific AWS resource, such as a capability, partnership, profile, or transformer.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- 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_-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
This exception is thrown when an error occurs in the AWS B2B Data Interchange service.
HTTP Status Code: 500
- ResourceNotFoundException
-
Occurs when the requested resource does not exist, or cannot be found. In some cases, the resource exists in a region other than the region specified in the API call.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to throttling: the data speed and rendering may be limited depending on various parameters and conditions.
HTTP Status Code: 400
- ValidationException
-
Occurs when a B2BI object cannot be validated against a request from another object.
HTTP Status Code: 400
Examples
Example
The following example retrieves details for the specified transformer.
Sample Request
{
"transformerId": "tr-1234abcd5678efghj"
}Sample Response
{
"createdAt": "2023-11-01T21:51:05.504Z",
"ediType": {
"x12Details": {
"transactionSet": "X12_110",
"version": "VERSION_4010"
}
},
"fileFormat": "JSON",
"mapping": {
"templateLanguage": "JSONATA",
"template": "$"
},
"modifiedAt": "2023-11-01T21:51:05.504Z",
"name": "transformJSON",
"sampleDocument": "s3://amzn-s3-demo-bucket/sampleDoc.txt",
"status": "inactive",
"transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-1234abcd5678efghj",
"transformerId": "tr-1234abcd5678efghj"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
