B2BI / Client / start_transformer_job

start_transformer_job#

B2BI.Client.start_transformer_job(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.start_transformer_job(
    inputFile={
        'bucketName': 'string',
        'key': 'string'
    },
    outputLocation={
        'bucketName': 'string',
        'key': 'string'
    },
    transformerId='string',
    clientToken='string'
)
Parameters:
  • inputFile (dict) –

    [REQUIRED]

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

    • bucketName (string) –

      Specifies the name of the Amazon S3 bucket.

    • key (string) –

      Specifies the Amazon S3 key for the file location.

  • outputLocation (dict) –

    [REQUIRED]

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

    • bucketName (string) –

      Specifies the name of the Amazon S3 bucket.

    • key (string) –

      Specifies the Amazon S3 key for the file location.

  • transformerId (string) –

    [REQUIRED]

    Specifies the system-assigned unique identifier for the transformer.

  • clientToken (string) –

    Reserved for future use.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'transformerJobId': 'string'
}

Response Structure

  • (dict) –

    • transformerJobId (string) –

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

Exceptions

  • B2BI.Client.exceptions.AccessDeniedException

  • B2BI.Client.exceptions.ValidationException

  • B2BI.Client.exceptions.ThrottlingException

  • B2BI.Client.exceptions.ResourceNotFoundException

  • B2BI.Client.exceptions.InternalServerException