B2BI / Paginator / ListTransformers

ListTransformers

class B2BI.Paginator.ListTransformers

paginator = client.get_paginator('list_transformers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from B2BI.Client.list_transformers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'transformers': [
        {
            'transformerId': '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),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    '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. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.

      • transformerId (string) –

        Returns the system-assigned unique identifier for the transformer.

      • name (string) –

        Returns the descriptive name for the transformer.

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

  • NextToken (string) –

    A token to resume pagination.