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

StartTransformerJob

Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by AWS B2B Data Interchange.

If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the StartTransformerJob API to process your files.

Note

The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJob and supply its transformerId and transformerJobId to return details of the job.

Request Syntax


{
   "clientToken": "string",
   "inputFile": { 
      "bucketName": "string",
      "key": "string"
   },
   "outputLocation": { 
      "bucketName": "string",
      "key": "string"
   },
   "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.

clientToken

Reserved for future use.

Type: String

Required: No

inputFile

Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.

Type: S3Location object

Required: Yes

outputLocation

Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.

Type: S3Location object

Required: Yes

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


{
   "transformerJobId": "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.

transformerJobId

Returns the unique, system-generated identifier for a transformer run.

Type: String

Length Constraints: Fixed length of 25.

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

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

When you use Transformer APIs, TestConversion, or TestParsing, the service throws a validation exception if a rule is configured incorrectly. For example, a validation exception occurs when:

A rule references an element that doesn't exist in the selected transaction set
An element length rule specifies a minimum length less than 0

Note

If your custom validation rules are configured correctly but the EDI validation fails due to those rules, this is expected behavior and doesn't result in a ValidationException.

For all other API operations, a validation exception occurs when a Trading Partner object can't be validated against a request from another object. This can happen during:

Standard EDI validation
Custom validation rule evaluation, such as when:
- Element lengths don't meet specified constraints
- Code list validations contain invalid codes
- Required elements are missing based on your element requirement rules

HTTP Status Code: 400

Examples

Example

The following example starts the processing for the specified input and output files.

Sample Request


{
    "clientToken": "foo",
    "inputFile": {
        "bucketName": "amzn-s3-demo-bucket",
        "key": "input/inputFile.txt"
    },
    "outputLocation": {
        "bucketName": "amzn-s3-demo-bucket",
        "key": "output/"
    },
    "transformerId": "tr-1234abcd5678efghj"
}

Sample Response


{
    "transformerJobId": "tj-zzzz9999yyyy8888xxxx77"
}