

# GetTransformerJob
<a name="API_GetTransformerJob"></a>

Returns the details of the transformer run, based on the Transformer job ID.

**Note**  
If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run `GetTransformerJob` and supply a `transformerId` and `transformerJobId` for a job that was started more than 30 days previously, you receive a 404 response.

## Request Syntax
<a name="API_GetTransformerJob_RequestSyntax"></a>

```
{
   "transformerId": "string",
   "transformerJobId": "string"
}
```

## Request Parameters
<a name="API_GetTransformerJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [transformerId](#API_GetTransformerJob_RequestSyntax) **   <a name="b2bi-GetTransformerJob-request-transformerId"></a>
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](#API_GetTransformerJob_RequestSyntax) **   <a name="b2bi-GetTransformerJob-request-transformerJobId"></a>
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
<a name="API_GetTransformerJob_ResponseSyntax"></a>

```
{
   "message": "string",
   "outputFiles": [ 
      { 
         "bucketName": "string",
         "key": "string"
      }
   ],
   "status": "string"
}
```

## Response Elements
<a name="API_GetTransformerJob_ResponseElements"></a>

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](#API_GetTransformerJob_ResponseSyntax) **   <a name="b2bi-GetTransformerJob-response-message"></a>
Returns an optional error message, which gets populated when the job is not run successfully.  
Type: String

 ** [outputFiles](#API_GetTransformerJob_ResponseSyntax) **   <a name="b2bi-GetTransformerJob-response-outputFiles"></a>
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](API_S3Location.md) objects

 ** [status](#API_GetTransformerJob_ResponseSyntax) **   <a name="b2bi-GetTransformerJob-response-status"></a>
Returns the current state of the transformer job, either `running`, `succeeded`, or `failed`.  
Type: String  
Valid Values: `running | succeeded | failed` 

## Errors
<a name="API_GetTransformerJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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.    
 ** retryAfterSeconds **   
The server attempts to retry a failed command.
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.    
 ** retryAfterSeconds **   
The server attempts to retry a command that was throttled.
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
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
<a name="API_GetTransformerJob_Examples"></a>

### Example
<a name="API_GetTransformerJob_Example_1"></a>

The following example retrieves details for the specified transformer run, which was successful.

#### Sample Request
<a name="API_GetTransformerJob_Example_1_Request"></a>

```
{
            "transformerId": "tr-1234abcd5678efghj",
            "transformerJobId": "tj-zzzz9999yyyy8888xxxx77"
        }
```

#### Sample Response
<a name="API_GetTransformerJob_Example_1_Response"></a>

```
{
    "status": "succeeded",
    "outputFiles": [
        {
            "bucketName": "edi-test",
            "key": "output/sample-214.edi.2023-11-01T10:44:03.353Z.json"
        }
    ],
    "message": "Transformed, writing output"
}
```

## See Also
<a name="API_GetTransformerJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/b2bi-2022-06-23/GetTransformerJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/b2bi-2022-06-23/GetTransformerJob) 