AWS B2B Data Interchange

2025/06/30 - AWS B2B Data Interchange - 9 updated api methods

Changes  Updated APIs to support inbound EDI split capabilities and additional Partnership-level configurations of generated EDI files' contents and format.

CreatePartnership (updated) Link ¶
Changes (both)
{'capabilityOptions': {'inboundEdi': {'x12': {'acknowledgmentOptions': {'functionalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                    '| '
                                                                                                    'GENERATE_ALL_SEGMENTS '
                                                                                                    '| '
                                                                                                    'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                                                                        'technicalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                   '| '
                                                                                                   'GENERATE_ALL_SEGMENTS'}}},
                       'outboundEdi': {'x12': {'common': {'controlNumbers': {'startingFunctionalGroupControlNumber': 'integer',
                                                                             'startingInterchangeControlNumber': 'integer',
                                                                             'startingTransactionSetControlNumber': 'integer'},
                                                          'gs05TimeFormat': 'HHMM '
                                                                            '| '
                                                                            'HHMMSS '
                                                                            '| '
                                                                            'HHMMSSDD'},
                                               'wrapOptions': {'lineLength': 'integer',
                                                               'lineTerminator': 'CRLF '
                                                                                 '| '
                                                                                 'LF '
                                                                                 '| '
                                                                                 'CR',
                                                               'wrapBy': 'SEGMENT '
                                                                         '| '
                                                                         'ONE_LINE '
                                                                         '| '
                                                                         'LINE_LENGTH'}}}}}

Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

client.create_partnership(
    profileId='string',
    name='string',
    email='string',
    phone='string',
    capabilities=[
        'string',
    ],
    capabilityOptions={
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False,
                    'controlNumbers': {
                        'startingInterchangeControlNumber': 123,
                        'startingFunctionalGroupControlNumber': 123,
                        'startingTransactionSetControlNumber': 123
                    },
                    'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                },
                'wrapOptions': {
                    'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                    'lineTerminator': 'CRLF'|'LF'|'CR',
                    'lineLength': 123
                }
            }
        },
        'inboundEdi': {
            'x12': {
                'acknowledgmentOptions': {
                    'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                    'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                }
            }
        }
    },
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type profileId:

string

param profileId:

[REQUIRED]

Specifies the unique, system-generated identifier for the profile connected to this partnership.

type name:

string

param name:

[REQUIRED]

Specifies a descriptive name for the partnership.

type email:

string

param email:

[REQUIRED]

Specifies the email address associated with this trading partner.

type phone:

string

param phone:

Specifies the phone number associated with the partnership.

type capabilities:

list

param capabilities:

[REQUIRED]

Specifies a list of the capabilities associated with this partnership.

  • (string) --

type capabilityOptions:

dict

param capabilityOptions:

Specify the structure that contains the details for the associated capabilities.

  • outboundEdi (dict) --

    A structure that contains the outbound EDI options.

    • x12 (dict) --

      A structure that contains an X12 envelope structure.

      • common (dict) --

        A container for the X12 outbound EDI headers.

        • interchangeControlHeaders (dict) --

          In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

          • senderIdQualifier (string) --

            Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

          • senderId (string) --

            Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

          • receiverIdQualifier (string) --

            Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

          • receiverId (string) --

            Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

          • repetitionSeparator (string) --

            Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

          • acknowledgmentRequestedCode (string) --

            Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

          • usageIndicatorCode (string) --

            Located at position ISA-15 in the header. Specifies how this interchange is being used:

            • T indicates this interchange is for testing.

            • P indicates this interchange is for production.

            • I indicates this interchange is informational.

        • functionalGroupHeaders (dict) --

          The functional group headers for the X12 object.

          • applicationSenderCode (string) --

            A value representing the code used to identify the party transmitting a message, at position GS-02.

          • applicationReceiverCode (string) --

            A value representing the code used to identify the party receiving a message, at position GS-03.

          • responsibleAgencyCode (string) --

            A code that identifies the issuer of the standard, at position GS-07.

        • delimiters (dict) --

          The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

          • componentSeparator (string) --

            The component, or sub-element, separator. The default value is : (colon).

          • dataElementSeparator (string) --

            The data element separator. The default value is * (asterisk).

          • segmentTerminator (string) --

            The segment terminator. The default value is ~ (tilde).

        • validateEdi (boolean) --

          Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

        • controlNumbers (dict) --

          Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

          • startingInterchangeControlNumber (integer) --

            Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

          • startingFunctionalGroupControlNumber (integer) --

            Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

          • startingTransactionSetControlNumber (integer) --

            Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

        • gs05TimeFormat (string) --

          Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

          • HHMM - Hours and minutes

          • HHMMSS - Hours, minutes, and seconds

          • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

          Where:

          • HH - Hours (00-23)

          • MM - Minutes (00-59)

          • SS - Seconds (00-59)

          • DD - Hundredths of seconds (00-99)

      • wrapOptions (dict) --

        Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

        • wrapBy (string) -- [REQUIRED]

          Specifies the method used for wrapping lines in the EDI output. Valid values:

          • SEGMENT: Wraps by segment.

          • ONE_LINE: Indicates that the entire content is on a single line.

          • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

        • lineTerminator (string) --

          Specifies the character sequence used to terminate lines when wrapping. Valid values:

          • CRLF: carriage return and line feed

          • LF: line feed)

          • CR: carriage return

        • lineLength (integer) --

          Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

  • inboundEdi (dict) --

    A structure that contains the inbound EDI options for the capability.

    • x12 (dict) --

      A structure that contains X12-specific options for processing inbound X12 EDI files.

      • acknowledgmentOptions (dict) --

        Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

        • functionalAcknowledgment (string) -- [REQUIRED]

          Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

          If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

        • technicalAcknowledgment (string) -- [REQUIRED]

          Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

type clientToken:

string

param clientToken:

Reserved for future use.

This field is autopopulated if not provided.

type tags:

list

param tags:

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.

rtype:

dict

returns:

Response Syntax

{
    'profileId': 'string',
    'partnershipId': 'string',
    'partnershipArn': 'string',
    'name': 'string',
    'email': 'string',
    'phone': 'string',
    'capabilities': [
        'string',
    ],
    'capabilityOptions': {
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False,
                    'controlNumbers': {
                        'startingInterchangeControlNumber': 123,
                        'startingFunctionalGroupControlNumber': 123,
                        'startingTransactionSetControlNumber': 123
                    },
                    'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                },
                'wrapOptions': {
                    'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                    'lineTerminator': 'CRLF'|'LF'|'CR',
                    'lineLength': 123
                }
            }
        },
        'inboundEdi': {
            'x12': {
                'acknowledgmentOptions': {
                    'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                    'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                }
            }
        }
    },
    'tradingPartnerId': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • profileId (string) --

      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • partnershipId (string) --

      Returns the unique, system-generated identifier for a partnership.

    • partnershipArn (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 a descriptive name for the partnership.

    • email (string) --

      Returns the email address associated with this trading partner.

    • phone (string) --

      Returns the phone number associated with the partnership.

    • capabilities (list) --

      Returns one or more capabilities associated with this partnership.

      • (string) --

    • capabilityOptions (dict) --

      Returns the structure that contains the details for the associated capabilities.

      • outboundEdi (dict) --

        A structure that contains the outbound EDI options.

        • x12 (dict) --

          A structure that contains an X12 envelope structure.

          • common (dict) --

            A container for the X12 outbound EDI headers.

            • interchangeControlHeaders (dict) --

              In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

              • senderIdQualifier (string) --

                Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

              • senderId (string) --

                Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

              • receiverIdQualifier (string) --

                Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

              • receiverId (string) --

                Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

              • repetitionSeparator (string) --

                Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

              • acknowledgmentRequestedCode (string) --

                Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

              • usageIndicatorCode (string) --

                Located at position ISA-15 in the header. Specifies how this interchange is being used:

                • T indicates this interchange is for testing.

                • P indicates this interchange is for production.

                • I indicates this interchange is informational.

            • functionalGroupHeaders (dict) --

              The functional group headers for the X12 object.

              • applicationSenderCode (string) --

                A value representing the code used to identify the party transmitting a message, at position GS-02.

              • applicationReceiverCode (string) --

                A value representing the code used to identify the party receiving a message, at position GS-03.

              • responsibleAgencyCode (string) --

                A code that identifies the issuer of the standard, at position GS-07.

            • delimiters (dict) --

              The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

              • componentSeparator (string) --

                The component, or sub-element, separator. The default value is : (colon).

              • dataElementSeparator (string) --

                The data element separator. The default value is * (asterisk).

              • segmentTerminator (string) --

                The segment terminator. The default value is ~ (tilde).

            • validateEdi (boolean) --

              Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

            • controlNumbers (dict) --

              Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

              • startingInterchangeControlNumber (integer) --

                Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

              • startingFunctionalGroupControlNumber (integer) --

                Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

              • startingTransactionSetControlNumber (integer) --

                Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

            • gs05TimeFormat (string) --

              Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

              • HHMM - Hours and minutes

              • HHMMSS - Hours, minutes, and seconds

              • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

              Where:

              • HH - Hours (00-23)

              • MM - Minutes (00-59)

              • SS - Seconds (00-59)

              • DD - Hundredths of seconds (00-99)

          • wrapOptions (dict) --

            Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

            • wrapBy (string) --

              Specifies the method used for wrapping lines in the EDI output. Valid values:

              • SEGMENT: Wraps by segment.

              • ONE_LINE: Indicates that the entire content is on a single line.

              • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

            • lineTerminator (string) --

              Specifies the character sequence used to terminate lines when wrapping. Valid values:

              • CRLF: carriage return and line feed

              • LF: line feed)

              • CR: carriage return

            • lineLength (integer) --

              Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

      • inboundEdi (dict) --

        A structure that contains the inbound EDI options for the capability.

        • x12 (dict) --

          A structure that contains X12-specific options for processing inbound X12 EDI files.

          • acknowledgmentOptions (dict) --

            Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

            • functionalAcknowledgment (string) --

              Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

              If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

            • technicalAcknowledgment (string) --

              Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

    • tradingPartnerId (string) --

      Returns the unique, system-generated identifier for a trading partner.

    • createdAt (datetime) --

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

CreateTransformer (updated) Link ¶
Changes (both)
{'inputConversion': {'advancedOptions': {'x12': {'splitOptions': {'splitBy': 'NONE '
                                                                             '| '
                                                                             'TRANSACTION'}}}}}

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.

See also: AWS API Documentation

Request Syntax

client.create_transformer(
    name='string',
    clientToken='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    fileFormat='XML'|'JSON'|'NOT_USED',
    mappingTemplate='string',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    sampleDocument='string',
    inputConversion={
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        },
        'advancedOptions': {
            'x12': {
                'splitOptions': {
                    'splitBy': 'NONE'|'TRANSACTION'
                }
            }
        }
    },
    mapping={
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    outputConversion={
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    sampleDocuments={
        'bucketName': 'string',
        'keys': [
            {
                'input': 'string',
                'output': 'string'
            },
        ]
    }
)
type name:

string

param name:

[REQUIRED]

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

type clientToken:

string

param clientToken:

Reserved for future use.

This field is autopopulated if not provided.

type tags:

list

param tags:

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.

type fileFormat:

string

param fileFormat:

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

type mappingTemplate:

string

param mappingTemplate:

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

type ediType:

dict

param ediType:

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.

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

type sampleDocument:

string

param sampleDocument:

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

type inputConversion:

dict

param inputConversion:

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.

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

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

  • advancedOptions (dict) --

    Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

    • x12 (dict) --

      A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

      • splitOptions (dict) --

        Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

        • splitBy (string) -- [REQUIRED]

          Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

type mapping:

dict

param mapping:

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.

type outputConversion:

dict

param outputConversion:

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.

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

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

type sampleDocuments:

dict

param sampleDocuments:

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.

rtype:

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_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    'sampleDocument': 'string',
    'inputConversion': {
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        },
        'advancedOptions': {
            'x12': {
                'splitOptions': {
                    'splitBy': 'NONE'|'TRANSACTION'
                }
            }
        }
    },
    'mapping': {
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    'outputConversion': {
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'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.

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

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

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

      • advancedOptions (dict) --

        Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

        • x12 (dict) --

          A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

          • splitOptions (dict) --

            Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

            • splitBy (string) --

              Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

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

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

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

GetPartnership (updated) Link ¶
Changes (response)
{'capabilityOptions': {'inboundEdi': {'x12': {'acknowledgmentOptions': {'functionalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                    '| '
                                                                                                    'GENERATE_ALL_SEGMENTS '
                                                                                                    '| '
                                                                                                    'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                                                                        'technicalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                   '| '
                                                                                                   'GENERATE_ALL_SEGMENTS'}}},
                       'outboundEdi': {'x12': {'common': {'controlNumbers': {'startingFunctionalGroupControlNumber': 'integer',
                                                                             'startingInterchangeControlNumber': 'integer',
                                                                             'startingTransactionSetControlNumber': 'integer'},
                                                          'gs05TimeFormat': 'HHMM '
                                                                            '| '
                                                                            'HHMMSS '
                                                                            '| '
                                                                            'HHMMSSDD'},
                                               'wrapOptions': {'lineLength': 'integer',
                                                               'lineTerminator': 'CRLF '
                                                                                 '| '
                                                                                 'LF '
                                                                                 '| '
                                                                                 'CR',
                                                               'wrapBy': 'SEGMENT '
                                                                         '| '
                                                                         'ONE_LINE '
                                                                         '| '
                                                                         'LINE_LENGTH'}}}}}

Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

client.get_partnership(
    partnershipId='string'
)
type partnershipId:

string

param partnershipId:

[REQUIRED]

Specifies the unique, system-generated identifier for a partnership.

rtype:

dict

returns:

Response Syntax

{
    'profileId': 'string',
    'partnershipId': 'string',
    'partnershipArn': 'string',
    'name': 'string',
    'email': 'string',
    'phone': 'string',
    'capabilities': [
        'string',
    ],
    'capabilityOptions': {
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False,
                    'controlNumbers': {
                        'startingInterchangeControlNumber': 123,
                        'startingFunctionalGroupControlNumber': 123,
                        'startingTransactionSetControlNumber': 123
                    },
                    'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                },
                'wrapOptions': {
                    'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                    'lineTerminator': 'CRLF'|'LF'|'CR',
                    'lineLength': 123
                }
            }
        },
        'inboundEdi': {
            'x12': {
                'acknowledgmentOptions': {
                    'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                    'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                }
            }
        }
    },
    'tradingPartnerId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • profileId (string) --

      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • partnershipId (string) --

      Returns the unique, system-generated identifier for a partnership.

    • partnershipArn (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 display name of the partnership

    • email (string) --

      Returns the email address associated with this trading partner.

    • phone (string) --

      Returns the phone number associated with the partnership.

    • capabilities (list) --

      Returns one or more capabilities associated with this partnership.

      • (string) --

    • capabilityOptions (dict) --

      Contains the details for an Outbound EDI capability.

      • outboundEdi (dict) --

        A structure that contains the outbound EDI options.

        • x12 (dict) --

          A structure that contains an X12 envelope structure.

          • common (dict) --

            A container for the X12 outbound EDI headers.

            • interchangeControlHeaders (dict) --

              In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

              • senderIdQualifier (string) --

                Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

              • senderId (string) --

                Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

              • receiverIdQualifier (string) --

                Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

              • receiverId (string) --

                Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

              • repetitionSeparator (string) --

                Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

              • acknowledgmentRequestedCode (string) --

                Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

              • usageIndicatorCode (string) --

                Located at position ISA-15 in the header. Specifies how this interchange is being used:

                • T indicates this interchange is for testing.

                • P indicates this interchange is for production.

                • I indicates this interchange is informational.

            • functionalGroupHeaders (dict) --

              The functional group headers for the X12 object.

              • applicationSenderCode (string) --

                A value representing the code used to identify the party transmitting a message, at position GS-02.

              • applicationReceiverCode (string) --

                A value representing the code used to identify the party receiving a message, at position GS-03.

              • responsibleAgencyCode (string) --

                A code that identifies the issuer of the standard, at position GS-07.

            • delimiters (dict) --

              The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

              • componentSeparator (string) --

                The component, or sub-element, separator. The default value is : (colon).

              • dataElementSeparator (string) --

                The data element separator. The default value is * (asterisk).

              • segmentTerminator (string) --

                The segment terminator. The default value is ~ (tilde).

            • validateEdi (boolean) --

              Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

            • controlNumbers (dict) --

              Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

              • startingInterchangeControlNumber (integer) --

                Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

              • startingFunctionalGroupControlNumber (integer) --

                Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

              • startingTransactionSetControlNumber (integer) --

                Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

            • gs05TimeFormat (string) --

              Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

              • HHMM - Hours and minutes

              • HHMMSS - Hours, minutes, and seconds

              • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

              Where:

              • HH - Hours (00-23)

              • MM - Minutes (00-59)

              • SS - Seconds (00-59)

              • DD - Hundredths of seconds (00-99)

          • wrapOptions (dict) --

            Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

            • wrapBy (string) --

              Specifies the method used for wrapping lines in the EDI output. Valid values:

              • SEGMENT: Wraps by segment.

              • ONE_LINE: Indicates that the entire content is on a single line.

              • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

            • lineTerminator (string) --

              Specifies the character sequence used to terminate lines when wrapping. Valid values:

              • CRLF: carriage return and line feed

              • LF: line feed)

              • CR: carriage return

            • lineLength (integer) --

              Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

      • inboundEdi (dict) --

        A structure that contains the inbound EDI options for the capability.

        • x12 (dict) --

          A structure that contains X12-specific options for processing inbound X12 EDI files.

          • acknowledgmentOptions (dict) --

            Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

            • functionalAcknowledgment (string) --

              Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

              If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

            • technicalAcknowledgment (string) --

              Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

    • tradingPartnerId (string) --

      Returns the unique identifier for the partner for this partnership.

    • createdAt (datetime) --

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

    • modifiedAt (datetime) --

      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

GetTransformer (updated) Link ¶
Changes (response)
{'inputConversion': {'advancedOptions': {'x12': {'splitOptions': {'splitBy': 'NONE '
                                                                             '| '
                                                                             'TRANSACTION'}}}}}

Retrieves the details for the transformer specified by the transformer ID. 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

client.get_transformer(
    transformerId='string'
)
type transformerId:

string

param transformerId:

[REQUIRED]

Specifies the system-assigned unique identifier for the transformer.

rtype:

dict

returns:

Response Syntax

{
    'transformerId': 'string',
    'transformerArn': '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_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    'sampleDocument': 'string',
    'inputConversion': {
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        },
        'advancedOptions': {
            'x12': {
                'splitOptions': {
                    'splitBy': 'NONE'|'TRANSACTION'
                }
            }
        }
    },
    'mapping': {
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    'outputConversion': {
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'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.

    • modifiedAt (datetime) --

      Returns a timestamp for last time the transformer was modified.

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

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

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

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

      • advancedOptions (dict) --

        Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

        • x12 (dict) --

          A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

          • splitOptions (dict) --

            Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

            • splitBy (string) --

              Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

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

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

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

ListPartnerships (updated) Link ¶
Changes (response)
{'partnerships': {'capabilityOptions': {'inboundEdi': {'x12': {'acknowledgmentOptions': {'functionalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                                     '| '
                                                                                                                     'GENERATE_ALL_SEGMENTS '
                                                                                                                     '| '
                                                                                                                     'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                                                                                         'technicalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                                    '| '
                                                                                                                    'GENERATE_ALL_SEGMENTS'}}},
                                        'outboundEdi': {'x12': {'common': {'controlNumbers': {'startingFunctionalGroupControlNumber': 'integer',
                                                                                              'startingInterchangeControlNumber': 'integer',
                                                                                              'startingTransactionSetControlNumber': 'integer'},
                                                                           'gs05TimeFormat': 'HHMM '
                                                                                             '| '
                                                                                             'HHMMSS '
                                                                                             '| '
                                                                                             'HHMMSSDD'},
                                                                'wrapOptions': {'lineLength': 'integer',
                                                                                'lineTerminator': 'CRLF '
                                                                                                  '| '
                                                                                                  'LF '
                                                                                                  '| '
                                                                                                  'CR',
                                                                                'wrapBy': 'SEGMENT '
                                                                                          '| '
                                                                                          'ONE_LINE '
                                                                                          '| '
                                                                                          'LINE_LENGTH'}}}}}}

Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

client.list_partnerships(
    profileId='string',
    nextToken='string',
    maxResults=123
)
type profileId:

string

param profileId:

Specifies the unique, system-generated identifier for the profile connected to this partnership.

type nextToken:

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

Specifies the maximum number of capabilities to return.

rtype:

dict

returns:

Response Syntax

{
    'partnerships': [
        {
            'profileId': 'string',
            'partnershipId': 'string',
            'name': 'string',
            'capabilities': [
                'string',
            ],
            'capabilityOptions': {
                'outboundEdi': {
                    'x12': {
                        'common': {
                            'interchangeControlHeaders': {
                                'senderIdQualifier': 'string',
                                'senderId': 'string',
                                'receiverIdQualifier': 'string',
                                'receiverId': 'string',
                                'repetitionSeparator': 'string',
                                'acknowledgmentRequestedCode': 'string',
                                'usageIndicatorCode': 'string'
                            },
                            'functionalGroupHeaders': {
                                'applicationSenderCode': 'string',
                                'applicationReceiverCode': 'string',
                                'responsibleAgencyCode': 'string'
                            },
                            'delimiters': {
                                'componentSeparator': 'string',
                                'dataElementSeparator': 'string',
                                'segmentTerminator': 'string'
                            },
                            'validateEdi': True|False,
                            'controlNumbers': {
                                'startingInterchangeControlNumber': 123,
                                'startingFunctionalGroupControlNumber': 123,
                                'startingTransactionSetControlNumber': 123
                            },
                            'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                        },
                        'wrapOptions': {
                            'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                            'lineTerminator': 'CRLF'|'LF'|'CR',
                            'lineLength': 123
                        }
                    }
                },
                'inboundEdi': {
                    'x12': {
                        'acknowledgmentOptions': {
                            'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                            'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                        }
                    }
                }
            },
            'tradingPartnerId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • partnerships (list) --

      Specifies a list of your partnerships.

      • (dict) --

        A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

        • profileId (string) --

          Returns the unique, system-generated identifier for the profile connected to this partnership.

        • partnershipId (string) --

          Returns the unique, system-generated identifier for a partnership.

        • name (string) --

          Returns the name of the partnership.

        • capabilities (list) --

          Returns one or more capabilities associated with this partnership.

          • (string) --

        • capabilityOptions (dict) --

          Contains the details for an Outbound EDI capability.

          • outboundEdi (dict) --

            A structure that contains the outbound EDI options.

            • x12 (dict) --

              A structure that contains an X12 envelope structure.

              • common (dict) --

                A container for the X12 outbound EDI headers.

                • interchangeControlHeaders (dict) --

                  In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

                  • senderIdQualifier (string) --

                    Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

                  • senderId (string) --

                    Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

                  • receiverIdQualifier (string) --

                    Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

                  • receiverId (string) --

                    Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

                  • repetitionSeparator (string) --

                    Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

                  • acknowledgmentRequestedCode (string) --

                    Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

                  • usageIndicatorCode (string) --

                    Located at position ISA-15 in the header. Specifies how this interchange is being used:

                    • T indicates this interchange is for testing.

                    • P indicates this interchange is for production.

                    • I indicates this interchange is informational.

                • functionalGroupHeaders (dict) --

                  The functional group headers for the X12 object.

                  • applicationSenderCode (string) --

                    A value representing the code used to identify the party transmitting a message, at position GS-02.

                  • applicationReceiverCode (string) --

                    A value representing the code used to identify the party receiving a message, at position GS-03.

                  • responsibleAgencyCode (string) --

                    A code that identifies the issuer of the standard, at position GS-07.

                • delimiters (dict) --

                  The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

                  • componentSeparator (string) --

                    The component, or sub-element, separator. The default value is : (colon).

                  • dataElementSeparator (string) --

                    The data element separator. The default value is * (asterisk).

                  • segmentTerminator (string) --

                    The segment terminator. The default value is ~ (tilde).

                • validateEdi (boolean) --

                  Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

                • controlNumbers (dict) --

                  Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

                  • startingInterchangeControlNumber (integer) --

                    Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

                  • startingFunctionalGroupControlNumber (integer) --

                    Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

                  • startingTransactionSetControlNumber (integer) --

                    Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

                • gs05TimeFormat (string) --

                  Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

                  • HHMM - Hours and minutes

                  • HHMMSS - Hours, minutes, and seconds

                  • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

                  Where:

                  • HH - Hours (00-23)

                  • MM - Minutes (00-59)

                  • SS - Seconds (00-59)

                  • DD - Hundredths of seconds (00-99)

              • wrapOptions (dict) --

                Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

                • wrapBy (string) --

                  Specifies the method used for wrapping lines in the EDI output. Valid values:

                  • SEGMENT: Wraps by segment.

                  • ONE_LINE: Indicates that the entire content is on a single line.

                  • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

                • lineTerminator (string) --

                  Specifies the character sequence used to terminate lines when wrapping. Valid values:

                  • CRLF: carriage return and line feed

                  • LF: line feed)

                  • CR: carriage return

                • lineLength (integer) --

                  Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

          • inboundEdi (dict) --

            A structure that contains the inbound EDI options for the capability.

            • x12 (dict) --

              A structure that contains X12-specific options for processing inbound X12 EDI files.

              • acknowledgmentOptions (dict) --

                Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

                • functionalAcknowledgment (string) --

                  Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

                  If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

                • technicalAcknowledgment (string) --

                  Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

        • tradingPartnerId (string) --

          Returns the unique, system-generated identifier for a trading partner.

        • createdAt (datetime) --

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

        • modifiedAt (datetime) --

          Returns a timestamp that identifies the most recent date and time that the partnership was modified.

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

ListTransformers (updated) Link ¶
Changes (response)
{'transformers': {'inputConversion': {'advancedOptions': {'x12': {'splitOptions': {'splitBy': 'NONE '
                                                                                              '| '
                                                                                              'TRANSACTION'}}}}}}

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

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

string

param nextToken:

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.

type maxResults:

integer

param maxResults:

Specifies the number of items to return for the API response.

rtype:

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_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
                }
            },
            'sampleDocument': 'string',
            'inputConversion': {
                'fromFormat': 'X12',
                'formatOptions': {
                    'x12': {
                        'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
                    }
                },
                'advancedOptions': {
                    'x12': {
                        'splitOptions': {
                            'splitBy': 'NONE'|'TRANSACTION'
                        }
                    }
                }
            },
            'mapping': {
                'templateLanguage': 'XSLT'|'JSONATA',
                'template': 'string'
            },
            'outputConversion': {
                'toFormat': 'X12',
                'formatOptions': {
                    'x12': {
                        'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'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.

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

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

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

          • advancedOptions (dict) --

            Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

            • x12 (dict) --

              A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

              • splitOptions (dict) --

                Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

                • splitBy (string) --

                  Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

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

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

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

TestParsing (updated) Link ¶
Changes (request, response)
Request
{'advancedOptions': {'x12': {'splitOptions': {'splitBy': 'NONE | '
                                                         'TRANSACTION'}}}}
Response
{'parsedSplitFileContents': ['string']}

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

See also: AWS API Documentation

Request Syntax

client.test_parsing(
    inputFile={
        'bucketName': 'string',
        'key': 'string'
    },
    fileFormat='XML'|'JSON'|'NOT_USED',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    advancedOptions={
        'x12': {
            'splitOptions': {
                'splitBy': 'NONE'|'TRANSACTION'
            }
        }
    }
)
type inputFile:

dict

param inputFile:

[REQUIRED]

Specifies an S3Location object, which contains the Amazon S3 bucket and prefix for the location of the input file.

  • bucketName (string) --

    Specifies the name of the Amazon S3 bucket.

  • key (string) --

    Specifies the Amazon S3 key for the file location.

type fileFormat:

string

param fileFormat:

[REQUIRED]

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

type ediType:

dict

param ediType:

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

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

type advancedOptions:

dict

param advancedOptions:

Specifies advanced options for parsing the input EDI file. These options allow for more granular control over the parsing process, including split options for X12 files.

  • x12 (dict) --

    A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

    • splitOptions (dict) --

      Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

      • splitBy (string) -- [REQUIRED]

        Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

rtype:

dict

returns:

Response Syntax

{
    'parsedFileContent': 'string',
    'parsedSplitFileContents': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • parsedFileContent (string) --

      Returns the contents of the input file being tested, parsed according to the specified EDI (electronic data interchange) type.

    • parsedSplitFileContents (list) --

      Returns an array of parsed file contents when the input file is split according to the specified split options. Each element in the array represents a separate split file's parsed content.

      • (string) --

UpdatePartnership (updated) Link ¶
Changes (both)
{'capabilityOptions': {'inboundEdi': {'x12': {'acknowledgmentOptions': {'functionalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                    '| '
                                                                                                    'GENERATE_ALL_SEGMENTS '
                                                                                                    '| '
                                                                                                    'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                                                                        'technicalAcknowledgment': 'DO_NOT_GENERATE '
                                                                                                   '| '
                                                                                                   'GENERATE_ALL_SEGMENTS'}}},
                       'outboundEdi': {'x12': {'common': {'controlNumbers': {'startingFunctionalGroupControlNumber': 'integer',
                                                                             'startingInterchangeControlNumber': 'integer',
                                                                             'startingTransactionSetControlNumber': 'integer'},
                                                          'gs05TimeFormat': 'HHMM '
                                                                            '| '
                                                                            'HHMMSS '
                                                                            '| '
                                                                            'HHMMSSDD'},
                                               'wrapOptions': {'lineLength': 'integer',
                                                               'lineTerminator': 'CRLF '
                                                                                 '| '
                                                                                 'LF '
                                                                                 '| '
                                                                                 'CR',
                                                               'wrapBy': 'SEGMENT '
                                                                         '| '
                                                                         'ONE_LINE '
                                                                         '| '
                                                                         'LINE_LENGTH'}}}}}

Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.

See also: AWS API Documentation

Request Syntax

client.update_partnership(
    partnershipId='string',
    name='string',
    capabilities=[
        'string',
    ],
    capabilityOptions={
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False,
                    'controlNumbers': {
                        'startingInterchangeControlNumber': 123,
                        'startingFunctionalGroupControlNumber': 123,
                        'startingTransactionSetControlNumber': 123
                    },
                    'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                },
                'wrapOptions': {
                    'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                    'lineTerminator': 'CRLF'|'LF'|'CR',
                    'lineLength': 123
                }
            }
        },
        'inboundEdi': {
            'x12': {
                'acknowledgmentOptions': {
                    'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                    'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                }
            }
        }
    }
)
type partnershipId:

string

param partnershipId:

[REQUIRED]

Specifies the unique, system-generated identifier for a partnership.

type name:

string

param name:

The name of the partnership, used to identify it.

type capabilities:

list

param capabilities:

List of the capabilities associated with this partnership.

  • (string) --

type capabilityOptions:

dict

param capabilityOptions:

To update, specify the structure that contains the details for the associated capabilities.

  • outboundEdi (dict) --

    A structure that contains the outbound EDI options.

    • x12 (dict) --

      A structure that contains an X12 envelope structure.

      • common (dict) --

        A container for the X12 outbound EDI headers.

        • interchangeControlHeaders (dict) --

          In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

          • senderIdQualifier (string) --

            Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

          • senderId (string) --

            Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

          • receiverIdQualifier (string) --

            Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

          • receiverId (string) --

            Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

          • repetitionSeparator (string) --

            Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

          • acknowledgmentRequestedCode (string) --

            Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

          • usageIndicatorCode (string) --

            Located at position ISA-15 in the header. Specifies how this interchange is being used:

            • T indicates this interchange is for testing.

            • P indicates this interchange is for production.

            • I indicates this interchange is informational.

        • functionalGroupHeaders (dict) --

          The functional group headers for the X12 object.

          • applicationSenderCode (string) --

            A value representing the code used to identify the party transmitting a message, at position GS-02.

          • applicationReceiverCode (string) --

            A value representing the code used to identify the party receiving a message, at position GS-03.

          • responsibleAgencyCode (string) --

            A code that identifies the issuer of the standard, at position GS-07.

        • delimiters (dict) --

          The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

          • componentSeparator (string) --

            The component, or sub-element, separator. The default value is : (colon).

          • dataElementSeparator (string) --

            The data element separator. The default value is * (asterisk).

          • segmentTerminator (string) --

            The segment terminator. The default value is ~ (tilde).

        • validateEdi (boolean) --

          Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

        • controlNumbers (dict) --

          Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

          • startingInterchangeControlNumber (integer) --

            Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

          • startingFunctionalGroupControlNumber (integer) --

            Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

          • startingTransactionSetControlNumber (integer) --

            Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

        • gs05TimeFormat (string) --

          Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

          • HHMM - Hours and minutes

          • HHMMSS - Hours, minutes, and seconds

          • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

          Where:

          • HH - Hours (00-23)

          • MM - Minutes (00-59)

          • SS - Seconds (00-59)

          • DD - Hundredths of seconds (00-99)

      • wrapOptions (dict) --

        Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

        • wrapBy (string) -- [REQUIRED]

          Specifies the method used for wrapping lines in the EDI output. Valid values:

          • SEGMENT: Wraps by segment.

          • ONE_LINE: Indicates that the entire content is on a single line.

          • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

        • lineTerminator (string) --

          Specifies the character sequence used to terminate lines when wrapping. Valid values:

          • CRLF: carriage return and line feed

          • LF: line feed)

          • CR: carriage return

        • lineLength (integer) --

          Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

  • inboundEdi (dict) --

    A structure that contains the inbound EDI options for the capability.

    • x12 (dict) --

      A structure that contains X12-specific options for processing inbound X12 EDI files.

      • acknowledgmentOptions (dict) --

        Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

        • functionalAcknowledgment (string) -- [REQUIRED]

          Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

          If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

        • technicalAcknowledgment (string) -- [REQUIRED]

          Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

rtype:

dict

returns:

Response Syntax

{
    'profileId': 'string',
    'partnershipId': 'string',
    'partnershipArn': 'string',
    'name': 'string',
    'email': 'string',
    'phone': 'string',
    'capabilities': [
        'string',
    ],
    'capabilityOptions': {
        'outboundEdi': {
            'x12': {
                'common': {
                    'interchangeControlHeaders': {
                        'senderIdQualifier': 'string',
                        'senderId': 'string',
                        'receiverIdQualifier': 'string',
                        'receiverId': 'string',
                        'repetitionSeparator': 'string',
                        'acknowledgmentRequestedCode': 'string',
                        'usageIndicatorCode': 'string'
                    },
                    'functionalGroupHeaders': {
                        'applicationSenderCode': 'string',
                        'applicationReceiverCode': 'string',
                        'responsibleAgencyCode': 'string'
                    },
                    'delimiters': {
                        'componentSeparator': 'string',
                        'dataElementSeparator': 'string',
                        'segmentTerminator': 'string'
                    },
                    'validateEdi': True|False,
                    'controlNumbers': {
                        'startingInterchangeControlNumber': 123,
                        'startingFunctionalGroupControlNumber': 123,
                        'startingTransactionSetControlNumber': 123
                    },
                    'gs05TimeFormat': 'HHMM'|'HHMMSS'|'HHMMSSDD'
                },
                'wrapOptions': {
                    'wrapBy': 'SEGMENT'|'ONE_LINE'|'LINE_LENGTH',
                    'lineTerminator': 'CRLF'|'LF'|'CR',
                    'lineLength': 123
                }
            }
        },
        'inboundEdi': {
            'x12': {
                'acknowledgmentOptions': {
                    'functionalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'|'GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP',
                    'technicalAcknowledgment': 'DO_NOT_GENERATE'|'GENERATE_ALL_SEGMENTS'
                }
            }
        }
    },
    'tradingPartnerId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • profileId (string) --

      Returns the unique, system-generated identifier for the profile connected to this partnership.

    • partnershipId (string) --

      Returns the unique, system-generated identifier for a partnership.

    • partnershipArn (string) --

      Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.

    • name (string) --

      The name of the partnership, used to identify it.

    • email (string) --

      Returns the email address associated with this trading partner.

    • phone (string) --

      Returns the phone number associated with the partnership.

    • capabilities (list) --

      Returns one or more capabilities associated with this partnership.

      • (string) --

    • capabilityOptions (dict) --

      Returns the structure that contains the details for the associated capabilities.

      • outboundEdi (dict) --

        A structure that contains the outbound EDI options.

        • x12 (dict) --

          A structure that contains an X12 envelope structure.

          • common (dict) --

            A container for the X12 outbound EDI headers.

            • interchangeControlHeaders (dict) --

              In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.

              • senderIdQualifier (string) --

                Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.

              • senderId (string) --

                Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.

              • receiverIdQualifier (string) --

                Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.

              • receiverId (string) --

                Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.

              • repetitionSeparator (string) --

                Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.

              • acknowledgmentRequestedCode (string) --

                Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.

              • usageIndicatorCode (string) --

                Located at position ISA-15 in the header. Specifies how this interchange is being used:

                • T indicates this interchange is for testing.

                • P indicates this interchange is for production.

                • I indicates this interchange is informational.

            • functionalGroupHeaders (dict) --

              The functional group headers for the X12 object.

              • applicationSenderCode (string) --

                A value representing the code used to identify the party transmitting a message, at position GS-02.

              • applicationReceiverCode (string) --

                A value representing the code used to identify the party receiving a message, at position GS-03.

              • responsibleAgencyCode (string) --

                A code that identifies the issuer of the standard, at position GS-07.

            • delimiters (dict) --

              The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.

              • componentSeparator (string) --

                The component, or sub-element, separator. The default value is : (colon).

              • dataElementSeparator (string) --

                The data element separator. The default value is * (asterisk).

              • segmentTerminator (string) --

                The segment terminator. The default value is ~ (tilde).

            • validateEdi (boolean) --

              Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.

            • controlNumbers (dict) --

              Specifies control number configuration for outbound X12 EDI headers. These settings determine the starting values for interchange, functional group, and transaction set control numbers.

              • startingInterchangeControlNumber (integer) --

                Specifies the starting interchange control number (ISA13) to use for X12 EDI generation. This number is incremented for each new interchange. For the ISA (interchange) envelope, Amazon Web Services B2B Data Interchange generates an interchange control number that is unique for the ISA05 and ISA06 (sender) & ISA07 and ISA08 (receiver) combination.

              • startingFunctionalGroupControlNumber (integer) --

                Specifies the starting functional group control number (GS06) to use for X12 EDI generation. This number is incremented for each new functional group. For the GS (functional group) envelope, Amazon Web Services B2B Data Interchange generates a functional group control number that is unique to the sender ID, receiver ID, and functional identifier code combination.

              • startingTransactionSetControlNumber (integer) --

                Specifies the starting transaction set control number (ST02) to use for X12 EDI generation. This number is incremented for each new transaction set.

            • gs05TimeFormat (string) --

              Specifies the time format in the GS05 element (time) of the functional group header. The following formats use 24-hour clock time:

              • HHMM - Hours and minutes

              • HHMMSS - Hours, minutes, and seconds

              • HHMMSSDD - Hours, minutes, seconds, and decimal seconds

              Where:

              • HH - Hours (00-23)

              • MM - Minutes (00-59)

              • SS - Seconds (00-59)

              • DD - Hundredths of seconds (00-99)

          • wrapOptions (dict) --

            Contains options for wrapping (line folding) in X12 EDI files. Wrapping controls how long lines are handled in the EDI output.

            • wrapBy (string) --

              Specifies the method used for wrapping lines in the EDI output. Valid values:

              • SEGMENT: Wraps by segment.

              • ONE_LINE: Indicates that the entire content is on a single line.

              • LINE_LENGTH: Wraps by character count, as specified by lineLength value.

            • lineTerminator (string) --

              Specifies the character sequence used to terminate lines when wrapping. Valid values:

              • CRLF: carriage return and line feed

              • LF: line feed)

              • CR: carriage return

            • lineLength (integer) --

              Specifies the maximum length of a line before wrapping occurs. This value is used when wrapBy is set to LINE_LENGTH.

      • inboundEdi (dict) --

        A structure that contains the inbound EDI options for the capability.

        • x12 (dict) --

          A structure that contains X12-specific options for processing inbound X12 EDI files.

          • acknowledgmentOptions (dict) --

            Specifies acknowledgment options for inbound X12 EDI files. These options control how functional and technical acknowledgments are handled.

            • functionalAcknowledgment (string) --

              Specifies whether functional acknowledgments (997/999) should be generated for incoming X12 transactions. Valid values are DO_NOT_GENERATE, GENERATE_ALL_SEGMENTS and GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP.

              If you choose GENERATE_WITHOUT_TRANSACTION_SET_RESPONSE_LOOP, Amazon Web Services B2B Data Interchange skips the AK2_Loop when generating an acknowledgment document.

            • technicalAcknowledgment (string) --

              Specifies whether technical acknowledgments (TA1) should be generated for incoming X12 interchanges. Valid values are DO_NOT_GENERATE and GENERATE_ALL_SEGMENTS and.

    • tradingPartnerId (string) --

      Returns the unique, system-generated identifier for a trading partner.

    • createdAt (datetime) --

      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

    • modifiedAt (datetime) --

      Returns a timestamp that identifies the most recent date and time that the partnership was modified.

UpdateTransformer (updated) Link ¶
Changes (both)
{'inputConversion': {'advancedOptions': {'x12': {'splitOptions': {'splitBy': 'NONE '
                                                                             '| '
                                                                             'TRANSACTION'}}}}}

Updates the specified parameters for a transformer. 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

client.update_transformer(
    transformerId='string',
    name='string',
    status='active'|'inactive',
    fileFormat='XML'|'JSON'|'NOT_USED',
    mappingTemplate='string',
    ediType={
        'x12Details': {
            'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    sampleDocument='string',
    inputConversion={
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        },
        'advancedOptions': {
            'x12': {
                'splitOptions': {
                    'splitBy': 'NONE'|'TRANSACTION'
                }
            }
        }
    },
    mapping={
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    outputConversion={
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        }
    },
    sampleDocuments={
        'bucketName': 'string',
        'keys': [
            {
                'input': 'string',
                'output': 'string'
            },
        ]
    }
)
type transformerId:

string

param transformerId:

[REQUIRED]

Specifies the system-assigned unique identifier for the transformer.

type name:

string

param name:

Specify a new name for the transformer, if you want to update it.

type status:

string

param status:

Specifies the transformer's status. You can update the state of the transformer from inactive to active.

type fileFormat:

string

param fileFormat:

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

type mappingTemplate:

string

param mappingTemplate:

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

type ediType:

dict

param ediType:

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.

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

type sampleDocument:

string

param sampleDocument:

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

type inputConversion:

dict

param inputConversion:

To update, 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.

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

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

  • advancedOptions (dict) --

    Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

    • x12 (dict) --

      A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

      • splitOptions (dict) --

        Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

        • splitBy (string) -- [REQUIRED]

          Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

type mapping:

dict

param mapping:

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.

type outputConversion:

dict

param outputConversion:

To update, specify 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.

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

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

type sampleDocuments:

dict

param sampleDocuments:

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.

rtype:

dict

returns:

Response Syntax

{
    'transformerId': 'string',
    'transformerArn': '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_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
        }
    },
    'sampleDocument': 'string',
    'inputConversion': {
        'fromFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'VERSION_5010'|'VERSION_5010_HIPAA'
            }
        },
        'advancedOptions': {
            'x12': {
                'splitOptions': {
                    'splitBy': 'NONE'|'TRANSACTION'
                }
            }
        }
    },
    'mapping': {
        'templateLanguage': 'XSLT'|'JSONATA',
        'template': 'string'
    },
    'outputConversion': {
        'toFormat': 'X12',
        'formatOptions': {
            'x12': {
                'transactionSet': 'X12_100'|'X12_101'|'X12_102'|'X12_103'|'X12_104'|'X12_105'|'X12_106'|'X12_107'|'X12_108'|'X12_109'|'X12_110'|'X12_111'|'X12_112'|'X12_113'|'X12_120'|'X12_121'|'X12_124'|'X12_125'|'X12_126'|'X12_127'|'X12_128'|'X12_129'|'X12_130'|'X12_131'|'X12_132'|'X12_133'|'X12_135'|'X12_138'|'X12_139'|'X12_140'|'X12_141'|'X12_142'|'X12_143'|'X12_144'|'X12_146'|'X12_147'|'X12_148'|'X12_149'|'X12_150'|'X12_151'|'X12_152'|'X12_153'|'X12_154'|'X12_155'|'X12_157'|'X12_158'|'X12_159'|'X12_160'|'X12_161'|'X12_163'|'X12_170'|'X12_175'|'X12_176'|'X12_179'|'X12_180'|'X12_185'|'X12_186'|'X12_187'|'X12_188'|'X12_189'|'X12_190'|'X12_191'|'X12_194'|'X12_195'|'X12_196'|'X12_197'|'X12_198'|'X12_199'|'X12_200'|'X12_201'|'X12_202'|'X12_203'|'X12_204'|'X12_205'|'X12_206'|'X12_210'|'X12_211'|'X12_212'|'X12_213'|'X12_214'|'X12_215'|'X12_216'|'X12_217'|'X12_218'|'X12_219'|'X12_220'|'X12_222'|'X12_223'|'X12_224'|'X12_225'|'X12_227'|'X12_228'|'X12_240'|'X12_242'|'X12_244'|'X12_245'|'X12_248'|'X12_249'|'X12_250'|'X12_251'|'X12_252'|'X12_255'|'X12_256'|'X12_259'|'X12_260'|'X12_261'|'X12_262'|'X12_263'|'X12_264'|'X12_265'|'X12_266'|'X12_267'|'X12_268'|'X12_269'|'X12_270'|'X12_271'|'X12_272'|'X12_273'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_280'|'X12_283'|'X12_284'|'X12_285'|'X12_286'|'X12_288'|'X12_290'|'X12_300'|'X12_301'|'X12_303'|'X12_304'|'X12_309'|'X12_310'|'X12_311'|'X12_312'|'X12_313'|'X12_315'|'X12_317'|'X12_319'|'X12_322'|'X12_323'|'X12_324'|'X12_325'|'X12_326'|'X12_350'|'X12_352'|'X12_353'|'X12_354'|'X12_355'|'X12_356'|'X12_357'|'X12_358'|'X12_361'|'X12_362'|'X12_404'|'X12_410'|'X12_412'|'X12_414'|'X12_417'|'X12_418'|'X12_419'|'X12_420'|'X12_421'|'X12_422'|'X12_423'|'X12_424'|'X12_425'|'X12_426'|'X12_429'|'X12_431'|'X12_432'|'X12_433'|'X12_434'|'X12_435'|'X12_436'|'X12_437'|'X12_440'|'X12_451'|'X12_452'|'X12_453'|'X12_455'|'X12_456'|'X12_460'|'X12_463'|'X12_466'|'X12_468'|'X12_470'|'X12_475'|'X12_485'|'X12_486'|'X12_490'|'X12_492'|'X12_494'|'X12_500'|'X12_501'|'X12_503'|'X12_504'|'X12_511'|'X12_517'|'X12_521'|'X12_527'|'X12_536'|'X12_540'|'X12_561'|'X12_567'|'X12_568'|'X12_601'|'X12_602'|'X12_620'|'X12_625'|'X12_650'|'X12_715'|'X12_753'|'X12_754'|'X12_805'|'X12_806'|'X12_810'|'X12_811'|'X12_812'|'X12_813'|'X12_814'|'X12_815'|'X12_816'|'X12_818'|'X12_819'|'X12_820'|'X12_821'|'X12_822'|'X12_823'|'X12_824'|'X12_826'|'X12_827'|'X12_828'|'X12_829'|'X12_830'|'X12_831'|'X12_832'|'X12_833'|'X12_834'|'X12_835'|'X12_836'|'X12_837'|'X12_838'|'X12_839'|'X12_840'|'X12_841'|'X12_842'|'X12_843'|'X12_844'|'X12_845'|'X12_846'|'X12_847'|'X12_848'|'X12_849'|'X12_850'|'X12_851'|'X12_852'|'X12_853'|'X12_854'|'X12_855'|'X12_856'|'X12_857'|'X12_858'|'X12_859'|'X12_860'|'X12_861'|'X12_862'|'X12_863'|'X12_864'|'X12_865'|'X12_866'|'X12_867'|'X12_868'|'X12_869'|'X12_870'|'X12_871'|'X12_872'|'X12_873'|'X12_874'|'X12_875'|'X12_876'|'X12_877'|'X12_878'|'X12_879'|'X12_880'|'X12_881'|'X12_882'|'X12_883'|'X12_884'|'X12_885'|'X12_886'|'X12_887'|'X12_888'|'X12_889'|'X12_891'|'X12_893'|'X12_894'|'X12_895'|'X12_896'|'X12_920'|'X12_924'|'X12_925'|'X12_926'|'X12_928'|'X12_940'|'X12_943'|'X12_944'|'X12_945'|'X12_947'|'X12_980'|'X12_990'|'X12_993'|'X12_996'|'X12_997'|'X12_998'|'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_4050'|'VERSION_4060'|'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.

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

    • modifiedAt (datetime) --

      Returns a timestamp for last time the transformer was modified.

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

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

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

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

      • advancedOptions (dict) --

        Specifies advanced options for the input conversion process. These options provide additional control over how EDI files are processed during transformation.

        • x12 (dict) --

          A structure that contains X12-specific advanced options, such as split options for processing X12 EDI files.

          • splitOptions (dict) --

            Specifies options for splitting X12 EDI files. These options control how large X12 files are divided into smaller, more manageable units.

            • splitBy (string) --

              Specifies the method used to split X12 EDI files. Valid values include TRANSACTION (split by individual transaction sets), or NONE (no splitting).

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

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

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