B2BI / Client / create_transformer

create_transformer#

B2BI.Client.create_transformer(**kwargs)#

Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

Request Syntax

response = client.create_transformer(
    name='string',
    fileFormat='XML'|'JSON',
    mappingTemplate='string',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
            'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
        }
    },
    sampleDocument='string',
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

name (string) –
[REQUIRED]

Specifies the name of the transformer, used to identify it.
fileFormat (string) –
[REQUIRED]

Specifies that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) –
[REQUIRED]

Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
ediType (dict) –
[REQUIRED]

Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
- x12Details (dict) –
  
  Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
  - transactionSet (string) –
    
    Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
  - version (string) –
    
    Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.
sampleDocument (string) – Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
clientToken (string) –
Reserved for future use.

This field is autopopulated if not provided.
tags (list) –
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
- (dict) –
  
  Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
  - Key (string) – [REQUIRED]
    
    Specifies the name assigned to the tag that you create.
  - Value (string) – [REQUIRED]
    
    Contains one or more values that you assigned to the key name that you create.

Return type:

dict

Returns:

Response Syntax

{
    'transformerId': 'string',
    'transformerArn': 'string',
    'name': 'string',
    'fileFormat': 'XML'|'JSON',
    'mappingTemplate': 'string',
    'status': 'active'|'inactive',
    'ediType': {
        'x12Details': {
            'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
            'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
        }
    },
    'sampleDocument': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- transformerId (string) –
  
  Returns the system-assigned unique identifier for the transformer.
- transformerArn (string) –
  
  Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
- name (string) –
  
  Returns the name of the transformer, used to identify it.
- fileFormat (string) –
  
  Returns that the currently supported file formats for EDI transformations are JSON and XML.
- mappingTemplate (string) –
  
  Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
- status (string) –
  
  Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
- ediType (dict) –
  
  Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - x12Details (dict) –
    
    Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
    - transactionSet (string) –
      
      Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
    - version (string) –
      
      Returns the version to use for the specified X12 transaction set. Supported versions are 4010, 4030, and 5010.
- sampleDocument (string) –
  
  Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
- createdAt (datetime) –
  
  Returns a timestamp for creation date and time of the transformer.

Exceptions

B2BI.Client.exceptions.ConflictException
B2BI.Client.exceptions.AccessDeniedException
B2BI.Client.exceptions.ValidationException
B2BI.Client.exceptions.ThrottlingException
B2BI.Client.exceptions.ResourceNotFoundException
B2BI.Client.exceptions.ServiceQuotaExceededException
B2BI.Client.exceptions.InternalServerException