Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateTransformer

Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

Request Syntax


{
   "clientToken": "string",
   "ediType": { ... },
   "fileFormat": "string",
   "mappingTemplate": "string",
   "name": "string",
   "sampleDocument": "string",
   "tags": [ 
      { 
         "Key": "string",
         "Value": "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.

clientToken

Reserved for future use.

Type: String

Required: No

ediType

Specifies 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: Yes

fileFormat

Specifies that the currently supported file formats for EDI transformations are JSON and XML.

Type: String

Valid Values: XML | JSON

Required: Yes

mappingTemplate

Specifies 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: Yes

name

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

Type: String

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

Required: Yes

sampleDocument

Specifies 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

tags

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


{
   "createdAt": "string",
   "ediType": { ... },
   "fileFormat": "string",
   "mappingTemplate": "string",
   "name": "string",
   "sampleDocument": "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

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

Returns that the currently supported file formats for EDI transformations are JSON and XML.

Type: String

Valid Values: XML | JSON

mappingTemplate

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.

name

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

Type: String

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

sampleDocument

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.

status

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

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

ConflictException

A conflict exception is thrown when you attempt to delete a resource (such as a profile or a capability) that is being used by other resources.

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

ServiceQuotaExceededException

Occurs when the calling command attempts to exceed one of the service quotas, for example trying to create a capability when you already have the maximum number of capabilities allowed.

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 creates a profile.

Sample Request


{
    "clientToken": "foo",
    "ediType": {
        "x12Details": {
            "transactionSet": "X12_110",
            "version": "VERSION_4010"
        }
    },
    "fileFormat": "JSON",
    "mappingTemplate": "{}",
    "name": "transformJSON",
    "sampleDocument": "s3://test-bucket/sampleDoc.txt",
    "tags": [
        {
            "Key": "sampleKey",
            "Value": "sampleValue"
        }
    ]
}

Sample Response


{
    "createdAt": "2023-11-01T21:51:05.504Z",
    "ediType": {
        "x12Details": {
            "transactionSet": "X12_110",
            "version": "VERSION_4010"
        }
    },
    "fileFormat": "JSON",
    "mappingTemplate": "$",
    "name": "transformJSON",
    "sampleDocument": "s3://test-bucket/sampleDoc.txt",
    "status": "inactive",
    "transformerArn": "arn:aws:b2bi:us-west-2:123456789012:transformer/tr-1234abcd5678efghj",
    "transformerId": "tr-1234abcd5678efghj"
}