GetTransformerJob
Returns the details of the transformer run, based on the Transformer job ID.
Request Syntax
{
"transformerId": "string",
"transformerJobId": "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
- transformerJobId
-
Specifies the unique, system-generated identifier for a transformer run.
Type: String
Length Constraints: Fixed length of 25.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Response Syntax
{
"message": "string",
"outputFiles": [
{
"bucketName": "string",
"key": "string"
}
],
"status": "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.
- message
-
Returns an optional error message, which gets populated when the job is not run successfully.
Type: String
- outputFiles
-
Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.
Type: Array of S3Location objects
- status
-
Returns the current state of the transformer job, either
running,succeeded, orfailed.Type: String
Valid Values:
running | succeeded | failed
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 run, which was successful.
Sample Request
{
"transformerId": "tr-1234abcd5678efghj",
"transformerJobId": "tj-zzzz9999yyyy8888xxxx77"
}Sample Response
{
"status": "succeeded",
"outputFiles": [
{
"bucketName": "edi-test",
"key": "output/sample-214.edi.2023-11-01T10:44:03.353Z.json"
}
],
"message": "Transformed, writing output"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
