:doc:`B2BI <../../b2bi>` / Client / start_transformer_job

*********************
start_transformer_job
*********************



.. py:method:: 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 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 <https://docs.aws.amazon.com/b2bi/latest/APIReference/API_GetTransformerJob.html>`__ and supply its ``transformerId`` and ``transformerJobId`` to return details of the job.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/b2bi-2022-06-23/StartTransformerJob>`_  


  **Request Syntax**
  ::

    response = client.start_transformer_job(
        inputFile={
            'bucketName': 'string',
            'key': 'string'
        },
        outputLocation={
            'bucketName': 'string',
            'key': 'string'
        },
        transformerId='string',
        clientToken='string'
    )
    
  :type inputFile: dict
  :param inputFile: **[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.

      

    
  
  :type outputLocation: dict
  :param outputLocation: **[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.

      

    
  
  :type transformerId: string
  :param transformerId: **[REQUIRED]** 

    Specifies the system-assigned unique identifier for the transformer.

    

  
  :type clientToken: string
  :param clientToken: 

    Reserved for future use.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'transformerJobId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **transformerJobId** *(string) --* 

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

        
  
  **Exceptions**
  
  *   :py:class:`B2BI.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`B2BI.Client.exceptions.ConflictException`

  
  *   :py:class:`B2BI.Client.exceptions.ValidationException`

  
  *   :py:class:`B2BI.Client.exceptions.ThrottlingException`

  
  *   :py:class:`B2BI.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`B2BI.Client.exceptions.InternalServerException`

  