B2BI / Client / list_transformers

list_transformers

B2BI.Client.list_transformers(**kwargs)

Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

See also: AWS API Documentation

Request Syntax

response = client.list_transformers(
    nextToken='string',
    maxResults=123
)

Parameters:

• nextToken (string) – When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

• maxResults (integer) – Specifies the number of items to return for the API response.

Return type:

dict

Returns:

Response Syntax

{
    'transformers': [
        {
            'transformerId': 'string',
            'name': 'string',
            'status': 'active'|'inactive',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': 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'
                    },
                ]
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • transformers (list) –

    Returns an array of one or more transformer objects.

    For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.

    • (dict) –

      Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.

      • transformerId (string) –

        Returns the system-assigned unique identifier for the transformer.

      • name (string) –

        Returns the descriptive name for the transformer.

      • 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 indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.

      • modifiedAt (datetime) –

        Returns a timestamp representing the date and time for the most recent change for the transformer object.

      • 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 a structure that contains the format options for the 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.

  • nextToken (string) –

    When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.

Exceptions

• B2BI.Client.exceptions.AccessDeniedException

• B2BI.Client.exceptions.ValidationException

• B2BI.Client.exceptions.ThrottlingException

• B2BI.Client.exceptions.InternalServerException