B2BI / Client / create_transformer

create_transformer

B2BI.Client.create_transformer(**kwargs)

Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:

• Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.

• Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.

Note

The following fields are provided for backwards compatibility only: fileFormat, mappingTemplate, ediType, and sampleDocument.

• Use the mapping data type in place of mappingTemplate and fileFormat

• Use the sampleDocuments data type in place of sampleDocument

• Use either the inputConversion or outputConversion in place of ediType

See also: AWS API Documentation

Request Syntax

response = client.create_transformer(
    name='string',
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    fileFormat='XML'|'JSON'|'NOT_USED',
    mappingTemplate='string',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
            'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    sampleDocument='string',
    inputConversion={
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
                'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    mapping={
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    outputConversion={
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
                'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    sampleDocuments={
        'bucketName': 'string',
        'keys': [
            {
                'input': 'string',
                'output': 'string'
            },
        ]
    }
)

Parameters:

• name (string) –

  [REQUIRED]

  Specifies the name of the transformer, used to identify it.

• 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.

• fileFormat (string) – Specifies that the currently supported file formats for EDI transformations are JSON and XML.

• mappingTemplate (string) –

  Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

  Note

  This parameter is available for backwards compatibility. Use the Mapping data type instead.

• ediType (dict) –

  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.

• sampleDocument (string) – Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.

• inputConversion (dict) –

  Specify the InputConversion object, which contains the format options for the inbound transformation.

  • fromFormat (string) – [REQUIRED]

    The format for the transformer input: currently on X12 is supported.

  • formatOptions (dict) –

    A structure that contains the formatting options for an inbound transformer.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: x12.

    • x12 (dict) –

      A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

      Note

      If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

      • 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.

• mapping (dict) –

  Specify the structure that contains the mapping template and its language (either XSLT or JSONATA).

  • templateLanguage (string) – [REQUIRED]

    The transformation language for the template, either XSLT or JSONATA.

  • template (string) –

    A string that represents the mapping template, in the transformation language specified in templateLanguage.

• outputConversion (dict) –

  A structure that contains the OutputConversion object, which contains the format options for the outbound transformation.

  • toFormat (string) – [REQUIRED]

    The format for the output from an outbound transformer: only X12 is currently supported.

  • formatOptions (dict) –

    A structure that contains the X12 transaction set and version for the transformer output.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: x12.

    • x12 (dict) –

      A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

      Note

      If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

      • 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.

• sampleDocuments (dict) –

  Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

  • bucketName (string) – [REQUIRED]

    Contains the Amazon S3 bucket that is used to hold your sample documents.

  • keys (list) – [REQUIRED]

    Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

    • (dict) –

      An array of the Amazon S3 keys used to identify the location for your sample documents.

      • input (string) –

        An array of keys for your input sample documents.

      • output (string) –

        An array of keys for your output sample documents.

Return type:

dict

Returns:

Response Syntax

{
    'transformerId': 'string',
    'transformerArn': 'string',
    'name': 'string',
    'status': 'active'|'inactive',
    'createdAt': datetime(2015, 1, 1),
    'fileFormat': 'XML'|'JSON'|'NOT_USED',
    'mappingTemplate': 'string',
    'ediType': {
        'x12Details': {
            'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
            'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    'sampleDocument': 'string',
    'inputConversion': {
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
                'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    'mapping': {
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    'outputConversion': {
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
                'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    'sampleDocuments': {
        'bucketName': 'string',
        'keys': [
            {
                'input': 'string',
                'output': 'string'
            },
        ]
    }
}

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.

  • 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.

  • createdAt (datetime) –

    Returns a timestamp for creation date and time of the transformer.

  • fileFormat (string) –

    Returns that the currently supported file formats for EDI transformations are JSON and XML.

  • mappingTemplate (string) –

    Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.

  • 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.

  • sampleDocument (string) –

    Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.

  • inputConversion (dict) –

    Returns the InputConversion object, which contains the format options for the inbound transformation.

    • fromFormat (string) –

      The format for the transformer input: currently on X12 is supported.

    • formatOptions (dict) –

      A structure that contains the formatting options for an inbound transformer.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: x12. 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'}
      

      • x12 (dict) –

        A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

        Note

        If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

        • 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.

  • mapping (dict) –

    Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).

    • templateLanguage (string) –

      The transformation language for the template, either XSLT or JSONATA.

    • template (string) –

      A string that represents the mapping template, in the transformation language specified in templateLanguage.

  • outputConversion (dict) –

    Returns the OutputConversion object, which contains the format options for the outbound transformation.

    • toFormat (string) –

      The format for the output from an outbound transformer: only X12 is currently supported.

    • formatOptions (dict) –

      A structure that contains the X12 transaction set and version for the transformer output.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: x12. 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'}
      

      • x12 (dict) –

        A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.

        Note

        If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.

        • 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.

  • sampleDocuments (dict) –

    Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.

    • bucketName (string) –

      Contains the Amazon S3 bucket that is used to hold your sample documents.

    • keys (list) –

      Contains an array of the Amazon S3 keys used to identify the location for your sample documents.

      • (dict) –

        An array of the Amazon S3 keys used to identify the location for your sample documents.

        • input (string) –

          An array of keys for your input sample documents.

        • output (string) –

          An array of keys for your output sample documents.

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