B2BI / Client / get_transformer_job

get_transformer_job

B2BI.Client.get_transformer_job(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_transformer_job(
    transformerJobId='string',
    transformerId='string'
)
Parameters:

  • transformerJobId (string) –

    [REQUIRED]

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

  • transformerId (string) –

    [REQUIRED]

    Specifies the system-assigned unique identifier for the transformer.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'running'|'succeeded'|'failed',
    'outputFiles': [
        {
            'bucketName': 'string',
            'key': 'string'
        },
    ],
    'message': 'string'
}

Response Structure

  • (dict) –

    • status (string) –

      Returns the current state of the transformer job, either running, succeeded, or failed.

    • outputFiles (list) –

      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.

      • (dict) –

        Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key.

        • bucketName (string) –

          Specifies the name of the Amazon S3 bucket.

        • key (string) –

          Specifies the Amazon S3 key for the file location.

    • message (string) –

      Returns an optional error message, which gets populated when the job is not run successfully.

Exceptions