B2BI **** Client ====== class B2BI.Client A low-level client representing AWS B2B Data Interchange (B2BI) This is the *Amazon Web Services B2B Data Interchange API Reference*. It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions. B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12. Note: Rather than actually running a command, you can use the "-- generate-cli-skeleton" parameter with any API call to generate and display a parameter template. You can then use the generated template to customize and use as input on a later command. For details, see Generate and use a parameter skeleton file. import boto3 client = boto3.client('b2bi') These are the available methods: * can_paginate * close * create_capability * create_partnership * create_profile * create_starter_mapping_template * create_transformer * delete_capability * delete_partnership * delete_profile * delete_transformer * generate_mapping * get_capability * get_paginator * get_partnership * get_profile * get_transformer * get_transformer_job * get_waiter * list_capabilities * list_partnerships * list_profiles * list_tags_for_resource * list_transformers * start_transformer_job * tag_resource * test_conversion * test_mapping * test_parsing * untag_resource * update_capability * update_partnership * update_profile * update_transformer Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListCapabilities * ListPartnerships * ListProfiles * ListTransformers Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * TransformerJobSucceeded B2BI / Waiter / TransformerJobSucceeded TransformerJobSucceeded *********************** class B2BI.Waiter.TransformerJobSucceeded waiter = client.get_waiter('transformer_job_succeeded') wait(**kwargs) Polls "B2BI.Client.get_transformer_job()" every 10 seconds until a successful state is reached. An error is raised after 12 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( transformerJobId='string', transformerId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **transformerJobId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for a transformer run. * **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 10 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 12 Returns: None B2BI / Paginator / ListPartnerships ListPartnerships **************** class B2BI.Paginator.ListPartnerships paginator = client.get_paginator('list_partnerships') paginate(**kwargs) Creates an iterator that will paginate through responses from "B2BI.Client.list_partnerships()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( profileId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **profileId** (*string*) -- Specifies the unique, system- generated identifier for the profile connected to this partnership. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { '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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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_RESPON SE_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) --* A token to resume pagination. B2BI / Paginator / ListCapabilities ListCapabilities **************** class B2BI.Paginator.ListCapabilities paginator = client.get_paginator('list_capabilities') paginate(**kwargs) Creates an iterator that will paginate through responses from "B2BI.Client.list_capabilities()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'capabilities': [ { 'capabilityId': 'string', 'name': 'string', 'type': 'edi', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **capabilities** *(list) --* Returns one or more capabilities associated with this partnership. * *(dict) --* Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. * **capabilityId** *(string) --* Returns a system-assigned unique identifier for the capability. * **name** *(string) --* The display name of the capability. * **type** *(string) --* Returns the type of the capability. Currently, only "edi" is supported. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the capability. * **modifiedAt** *(datetime) --* Returns a timestamp that identifies the most recent date and time that the capability was modified. * **NextToken** *(string) --* A token to resume pagination. B2BI / Paginator / ListTransformers ListTransformers **************** class B2BI.Paginator.ListTransformers paginator = client.get_paginator('list_transformers') paginate(**kwargs) Creates an iterator that will paginate through responses from "B2BI.Client.list_transformers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'transformers': [ { 'transformerId': 'string', 'name': 'string', '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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** *(string) --* Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** *(dict) --* Returns a structure that contains the format options for the transformation. * **fromFormat** *(string) --* The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** *(dict) --* Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. * **NextToken** *(string) --* A token to resume pagination. B2BI / Paginator / ListProfiles ListProfiles ************ class B2BI.Paginator.ListProfiles paginator = client.get_paginator('list_profiles') paginate(**kwargs) Creates an iterator that will paginate through responses from "B2BI.Client.list_profiles()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'profiles': [ { 'profileId': 'string', 'name': 'string', 'businessName': 'string', 'logging': 'ENABLED'|'DISABLED', 'logGroupName': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **profiles** *(list) --* Returns an array of "ProfileSummary" objects. * *(dict) --* Contains the details for a profile. A profile is the mechanism used to create the concept of a private network. * **profileId** *(string) --* Returns the unique, system-generated identifier for the profile. * **name** *(string) --* Returns the display name for profile. * **businessName** *(string) --* Returns the name for the business associated with this profile. * **logging** *(string) --* Specifies whether or not logging is enabled for this profile. * **logGroupName** *(string) --* Returns the name of the logging group. * **createdAt** *(datetime) --* Returns the timestamp for creation date and time of the profile. * **modifiedAt** *(datetime) --* Returns the timestamp that identifies the most recent date and time that the profile was modified. * **NextToken** *(string) --* A token to resume pagination. B2BI / Client / get_paginator get_paginator ************* B2BI.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. B2BI / Client / start_transformer_job start_transformer_job ********************* B2BI.Client.start_transformer_job(**kwargs) Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange. If you only want to transform EDI (electronic data interchange) documents, you don't need to create profiles, partnerships or capabilities. Just create and configure a transformer, and then run the "StartTransformerJob" API to process your files. Note: The system stores transformer jobs for 30 days. During that period, you can run GetTransformerJob and supply its "transformerId" and "transformerJobId" to return details of the job. See also: AWS API Documentation **Request Syntax** response = client.start_transformer_job( inputFile={ 'bucketName': 'string', 'key': 'string' }, outputLocation={ 'bucketName': 'string', 'key': 'string' }, transformerId='string', clientToken='string' ) Parameters: * **inputFile** (*dict*) -- **[REQUIRED]** Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** (*dict*) -- **[REQUIRED]** Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. * **clientToken** (*string*) -- Reserved for future use. This field is autopopulated if not provided. Return type: dict Returns: **Response Syntax** { 'transformerJobId': 'string' } **Response Structure** * *(dict) --* * **transformerJobId** *(string) --* Returns the unique, system-generated identifier for a transformer run. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / test_conversion test_conversion *************** B2BI.Client.test_conversion(**kwargs) This operation mimics the latter half of a typical Outbound EDI request. It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string. See also: AWS API Documentation **Request Syntax** response = client.test_conversion( source={ 'fileFormat': 'JSON'|'XML', 'inputFile': { 'fileContent': 'string' } }, target={ 'fileFormat': 'X12', 'formatDetails': { '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' } }, 'outputSampleFile': { 'fileLocation': { 'bucketName': 'string', 'key': 'string' } } } ) Parameters: * **source** (*dict*) -- **[REQUIRED]** Specify the source file for an outbound EDI request. * **fileFormat** *(string) --* **[REQUIRED]** The format for the input file: either JSON or XML. * **inputFile** *(dict) --* **[REQUIRED]** File to be converted Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fileContent". * **fileContent** *(string) --* Specify the input contents, as a string, for the source of an outbound transformation. * **target** (*dict*) -- **[REQUIRED]** Specify the format (X12 is the only currently supported format), and other details for the conversion target. * **fileFormat** *(string) --* **[REQUIRED]** Currently, only X12 format is supported. * **formatDetails** *(dict) --* A structure that contains the formatting details for the conversion target. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **outputSampleFile** *(dict) --* Customer uses this to provide a sample on what should file look like after conversion X12 EDI use case around this would be discovering the file syntax Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "fileLocation". * **fileLocation** *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. Return type: dict Returns: **Response Syntax** { 'convertedFileContent': 'string', 'validationMessages': [ 'string', ] } **Response Structure** * *(dict) --* * **convertedFileContent** *(string) --* Returns the converted file content. * **validationMessages** *(list) --* Returns an array of strings, each containing a message that Amazon Web Services B2B Data Interchange generates during the conversion. * *(string) --* **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / can_paginate can_paginate ************ B2BI.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. B2BI / Client / delete_capability delete_capability ***************** B2BI.Client.delete_capability(**kwargs) Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. See also: AWS API Documentation **Request Syntax** response = client.delete_capability( capabilityId='string' ) Parameters: **capabilityId** (*string*) -- **[REQUIRED]** Specifies a system-assigned unique identifier for the capability. Returns: None **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / list_tags_for_resource list_tags_for_resource ********************** B2BI.Client.list_tags_for_resource(**kwargs) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceARN='string' ) Parameters: **ResourceARN** (*string*) -- **[REQUIRED]** Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* Returns 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) --* Specifies the name assigned to the tag that you create. * **Value** *(string) --* Contains one or more values that you assigned to the key name that you create. **Exceptions** * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / untag_resource untag_resource ************** B2BI.Client.untag_resource(**kwargs) Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceARN='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer. * **TagKeys** (*list*) -- **[REQUIRED]** 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. * *(string) --* Returns: None **Exceptions** * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / list_transformers list_transformers ***************** B2BI.Client.list_transformers(**kwargs) Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML- formatted document as input and transform it into an EDI file. See also: AWS API Documentation **Request Syntax** response = client.list_transformers( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- When additional results are obtained from the command, a "NextToken" parameter is returned in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional resources. * **maxResults** (*integer*) -- Specifies the number of items to return for the API response. Return type: dict Returns: **Response Syntax** { 'transformers': [ { 'transformerId': 'string', 'name': 'string', 'status': 'active'|'inactive', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1), 'fileFormat': 'XML'|'JSON'|'NOT_USED', 'mappingTemplate': 'string', 'ediType': { 'x12Details': { 'transactionSet': 'X12_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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** *(string) --* Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** *(dict) --* Returns a structure that contains the format options for the transformation. * **fromFormat** *(string) --* The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** *(dict) --* Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. * **nextToken** *(string) --* When additional results are obtained from the command, a "NextToken" parameter is returned in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional resources. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_profile get_profile *********** B2BI.Client.get_profile(**kwargs) Retrieves the details for the profile specified by the profile ID. A profile is the mechanism used to create the concept of a private network. See also: AWS API Documentation **Request Syntax** response = client.get_profile( profileId='string' ) Parameters: **profileId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for the profile. Return type: dict Returns: **Response Syntax** { 'profileId': 'string', 'profileArn': 'string', 'name': 'string', 'email': 'string', 'phone': 'string', 'businessName': 'string', 'logging': 'ENABLED'|'DISABLED', 'logGroupName': '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. * **profileArn** *(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 profile, used to identify it. * **email** *(string) --* Returns the email address associated with this customer profile. * **phone** *(string) --* Returns the phone number associated with the profile. * **businessName** *(string) --* Returns the name for the business associated with this profile. * **logging** *(string) --* Returns whether or not logging is enabled for this profile. * **logGroupName** *(string) --* Returns the name of the logging group. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the transformer. * **modifiedAt** *(datetime) --* Returns a timestamp for last time the profile was modified. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_waiter get_waiter ********** B2BI.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" B2BI / Client / update_capability update_capability ***************** B2BI.Client.update_capability(**kwargs) Updates some of the parameters for a capability, based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. See also: AWS API Documentation **Request Syntax** response = client.update_capability( capabilityId='string', name='string', configuration={ 'edi': { 'capabilityDirection': 'INBOUND'|'OUTBOUND', 'type': { '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' } }, 'inputLocation': { 'bucketName': 'string', 'key': 'string' }, 'outputLocation': { 'bucketName': 'string', 'key': 'string' }, 'transformerId': 'string' } }, instructionsDocuments=[ { 'bucketName': 'string', 'key': 'string' }, ] ) Parameters: * **capabilityId** (*string*) -- **[REQUIRED]** Specifies a system-assigned unique identifier for the capability. * **name** (*string*) -- Specifies a new name for the capability, to replace the existing name. * **configuration** (*dict*) -- Specifies a structure that contains the details for a capability. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "edi". * **edi** *(dict) --* An EDI (electronic data interchange) configuration object. * **capabilityDirection** *(string) --* Specifies whether this is capability is for inbound or outbound transformations. * **type** *(dict) --* **[REQUIRED]** Returns the type of the capability. Currently, only "edi" is supported. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12Details". * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **inputLocation** *(dict) --* **[REQUIRED]** Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** *(dict) --* **[REQUIRED]** Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** *(string) --* **[REQUIRED]** Returns the system-assigned unique identifier for the transformer. * **instructionsDocuments** (*list*) -- Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. Return type: dict Returns: **Response Syntax** { 'capabilityId': 'string', 'capabilityArn': 'string', 'name': 'string', 'type': 'edi', 'configuration': { 'edi': { 'capabilityDirection': 'INBOUND'|'OUTBOUND', 'type': { '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' } }, 'inputLocation': { 'bucketName': 'string', 'key': 'string' }, 'outputLocation': { 'bucketName': 'string', 'key': 'string' }, 'transformerId': 'string' } }, 'instructionsDocuments': [ { 'bucketName': 'string', 'key': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **capabilityId** *(string) --* Returns a system-assigned unique identifier for the capability. * **capabilityArn** *(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 capability, used to identify it. * **type** *(string) --* Returns the type of the capability. Currently, only "edi" is supported. * **configuration** *(dict) --* Returns a structure that contains the details for a capability. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "edi". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **edi** *(dict) --* An EDI (electronic data interchange) configuration object. * **capabilityDirection** *(string) --* Specifies whether this is capability is for inbound or outbound transformations. * **type** *(dict) --* Returns the type of the capability. Currently, only "edi" is supported. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **inputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** *(string) --* Returns the system-assigned unique identifier for the transformer. * **instructionsDocuments** *(list) --* Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the capability. * **modifiedAt** *(datetime) --* Returns a timestamp for last time the capability was modified. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_transformer_job get_transformer_job ******************* B2BI.Client.get_transformer_job(**kwargs) Returns the details of the transformer run, based on the Transformer job ID. Note: If 30 days have elapsed since your transformer job was started, the system deletes it. So, if you run "GetTransformerJob" and supply a "transformerId" and "transformerJobId" for a job that was started more than 30 days previously, you receive a 404 response. See also: AWS API Documentation **Request Syntax** response = client.get_transformer_job( transformerJobId='string', transformerId='string' ) Parameters: * **transformerJobId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for a transformer run. * **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. Return type: dict Returns: **Response Syntax** { 'status': 'running'|'succeeded'|'failed', 'outputFiles': [ { 'bucketName': 'string', 'key': 'string' }, ], 'message': 'string' } **Response Structure** * *(dict) --* * **status** *(string) --* Returns the current state of the transformer job, either "running", "succeeded", or "failed". * **outputFiles** *(list) --* Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **message** *(string) --* Returns an optional error message, which gets populated when the job is not run successfully. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_transformer get_transformer *************** B2BI.Client.get_transformer(**kwargs) 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** response = client.get_transformer( transformerId='string' ) Parameters: **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. Return type: 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** *(string) --* Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** *(dict) --* Returns the "InputConversion" object, which contains the format options for the inbound transformation. * **fromFormat** *(string) --* The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** *(dict) --* Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / list_profiles list_profiles ************* B2BI.Client.list_profiles(**kwargs) Lists the profiles associated with your Amazon Web Services account for your current or specified region. A profile is the mechanism used to create the concept of a private network. See also: AWS API Documentation **Request Syntax** response = client.list_profiles( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- When additional results are obtained from the command, a "NextToken" parameter is returned in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional resources. * **maxResults** (*integer*) -- Specifies the maximum number of profiles to return. Return type: dict Returns: **Response Syntax** { 'profiles': [ { 'profileId': 'string', 'name': 'string', 'businessName': 'string', 'logging': 'ENABLED'|'DISABLED', 'logGroupName': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **profiles** *(list) --* Returns an array of "ProfileSummary" objects. * *(dict) --* Contains the details for a profile. A profile is the mechanism used to create the concept of a private network. * **profileId** *(string) --* Returns the unique, system-generated identifier for the profile. * **name** *(string) --* Returns the display name for profile. * **businessName** *(string) --* Returns the name for the business associated with this profile. * **logging** *(string) --* Specifies whether or not logging is enabled for this profile. * **logGroupName** *(string) --* Returns the name of the logging group. * **createdAt** *(datetime) --* Returns the timestamp for creation date and time of the profile. * **modifiedAt** *(datetime) --* Returns the timestamp that identifies the most recent date and time that the profile 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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / test_parsing test_parsing ************ B2BI.Client.test_parsing(**kwargs) 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** response = 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' } } } ) Parameters: * **inputFile** (*dict*) -- **[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. * **fileFormat** (*string*) -- **[REQUIRED]** Specifies that the currently supported file formats for EDI transformations are "JSON" and "XML". * **ediType** (*dict*) -- **[REQUIRED]** Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12Details". * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **advancedOptions** (*dict*) -- 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). Return type: 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) --* **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / create_starter_mapping_template create_starter_mapping_template ******************************* B2BI.Client.create_starter_mapping_template(**kwargs) Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI. If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI. If you do not provide a sample EDI file, then the service can generate a mapping template based on the EDI settings in the "templateDetails" parameter. Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file. See also: AWS API Documentation **Request Syntax** response = client.create_starter_mapping_template( outputSampleLocation={ 'bucketName': 'string', 'key': 'string' }, mappingType='JSONATA'|'XSLT', templateDetails={ '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' } } ) Parameters: * **outputSampleLocation** (*dict*) -- Specify the location of the sample EDI file that is used to generate the mapping template. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **mappingType** (*string*) -- **[REQUIRED]** Specify the format for the mapping template: either JSONATA or XSLT. * **templateDetails** (*dict*) -- **[REQUIRED]** Describes the details needed for generating the template. Specify the X12 transaction set and version for which the template is used: currently, we only support X12. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. Return type: dict Returns: **Response Syntax** { 'mappingTemplate': 'string' } **Response Structure** * *(dict) --* * **mappingTemplate** *(string) --* Returns a string that represents the mapping template. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / update_partnership update_partnership ****************** B2BI.Client.update_partnership(**kwargs) 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** response = 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' } } } } ) Parameters: * **partnershipId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for a partnership. * **name** (*string*) -- The name of the partnership, used to identify it. * **capabilities** (*list*) -- List of the capabilities associated with this partnership. * *(string) --* * **capabilityOptions** (*dict*) -- To update, specify the structure that contains the details for the associated capabilities. * **outboundEdi** *(dict) --* A structure that contains the outbound EDI options. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. Return type: 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / test_mapping test_mapping ************ B2BI.Client.test_mapping(**kwargs) Maps the input file according to the provided template file. The API call downloads the file contents from the Amazon S3 location, and passes the contents in as a string, to the "inputFileContent" parameter. See also: AWS API Documentation **Request Syntax** response = client.test_mapping( inputFileContent='string', mappingTemplate='string', fileFormat='XML'|'JSON'|'NOT_USED' ) Parameters: * **inputFileContent** (*string*) -- **[REQUIRED]** Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform. * **mappingTemplate** (*string*) -- **[REQUIRED]** Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT. Note: This parameter is available for backwards compatibility. Use the Mapping data type instead. * **fileFormat** (*string*) -- **[REQUIRED]** Specifies that the currently supported file formats for EDI transformations are "JSON" and "XML". Return type: dict Returns: **Response Syntax** { 'mappedFileContent': 'string' } **Response Structure** * *(dict) --* * **mappedFileContent** *(string) --* Returns a string for the mapping that can be used to identify the mapping. Similar to a fingerprint **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / create_profile create_profile ************** B2BI.Client.create_profile(**kwargs) Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network. See also: AWS API Documentation **Request Syntax** response = client.create_profile( name='string', email='string', phone='string', businessName='string', logging='ENABLED'|'DISABLED', clientToken='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** Specifies the name of the profile. * **email** (*string*) -- Specifies the email address associated with this customer profile. * **phone** (*string*) -- **[REQUIRED]** Specifies the phone number associated with the profile. * **businessName** (*string*) -- **[REQUIRED]** Specifies the name for the business associated with this profile. * **logging** (*string*) -- **[REQUIRED]** Specifies whether or not logging is enabled for this profile. * **clientToken** (*string*) -- Reserved for future use. This field is autopopulated if not provided. * **tags** (*list*) -- Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. * *(dict) --* Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called "Group" and assign the values "Research" and "Accounting" to that group. * **Key** *(string) --* **[REQUIRED]** Specifies the name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name that you create. Return type: dict Returns: **Response Syntax** { 'profileId': 'string', 'profileArn': 'string', 'name': 'string', 'businessName': 'string', 'phone': 'string', 'email': 'string', 'logging': 'ENABLED'|'DISABLED', 'logGroupName': 'string', 'createdAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **profileId** *(string) --* Returns the unique, system-generated identifier for the profile. * **profileArn** *(string) --* Returns an Amazon Resource Name (ARN) for the profile. * **name** *(string) --* Returns the name of the profile, used to identify it. * **businessName** *(string) --* Returns the name for the business associated with this profile. * **phone** *(string) --* Returns the phone number associated with the profile. * **email** *(string) --* Returns the email address associated with this customer profile. * **logging** *(string) --* Returns whether or not logging is turned on for this profile. * **logGroupName** *(string) --* Returns the name of the logging group. * **createdAt** *(datetime) --* Returns a timestamp representing the time the profile was created. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / delete_transformer delete_transformer ****************** B2BI.Client.delete_transformer(**kwargs) Deletes the specified 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** response = client.delete_transformer( transformerId='string' ) Parameters: **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. Returns: None **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / create_capability create_capability ***************** B2BI.Client.create_capability(**kwargs) Instantiates a capability based on the specified parameters. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. See also: AWS API Documentation **Request Syntax** response = client.create_capability( name='string', type='edi', configuration={ 'edi': { 'capabilityDirection': 'INBOUND'|'OUTBOUND', 'type': { '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' } }, 'inputLocation': { 'bucketName': 'string', 'key': 'string' }, 'outputLocation': { 'bucketName': 'string', 'key': 'string' }, 'transformerId': 'string' } }, instructionsDocuments=[ { 'bucketName': 'string', 'key': 'string' }, ], clientToken='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **name** (*string*) -- **[REQUIRED]** Specifies the name of the capability, used to identify it. * **type** (*string*) -- **[REQUIRED]** Specifies the type of the capability. Currently, only "edi" is supported. * **configuration** (*dict*) -- **[REQUIRED]** Specifies a structure that contains the details for a capability. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "edi". * **edi** *(dict) --* An EDI (electronic data interchange) configuration object. * **capabilityDirection** *(string) --* Specifies whether this is capability is for inbound or outbound transformations. * **type** *(dict) --* **[REQUIRED]** Returns the type of the capability. Currently, only "edi" is supported. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12Details". * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **inputLocation** *(dict) --* **[REQUIRED]** Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** *(dict) --* **[REQUIRED]** Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** *(string) --* **[REQUIRED]** Returns the system-assigned unique identifier for the transformer. * **instructionsDocuments** (*list*) -- Specifies one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **clientToken** (*string*) -- Reserved for future use. This field is autopopulated if not provided. * **tags** (*list*) -- Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. * *(dict) --* Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called "Group" and assign the values "Research" and "Accounting" to that group. * **Key** *(string) --* **[REQUIRED]** Specifies the name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name that you create. Return type: dict Returns: **Response Syntax** { 'capabilityId': 'string', 'capabilityArn': 'string', 'name': 'string', 'type': 'edi', 'configuration': { 'edi': { 'capabilityDirection': 'INBOUND'|'OUTBOUND', 'type': { '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' } }, 'inputLocation': { 'bucketName': 'string', 'key': 'string' }, 'outputLocation': { 'bucketName': 'string', 'key': 'string' }, 'transformerId': 'string' } }, 'instructionsDocuments': [ { 'bucketName': 'string', 'key': 'string' }, ], 'createdAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **capabilityId** *(string) --* Returns a system-assigned unique identifier for the capability. * **capabilityArn** *(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 capability used to identify it. * **type** *(string) --* Returns the type of the capability. Currently, only "edi" is supported. * **configuration** *(dict) --* Returns a structure that contains the details for a capability. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "edi". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **edi** *(dict) --* An EDI (electronic data interchange) configuration object. * **capabilityDirection** *(string) --* Specifies whether this is capability is for inbound or outbound transformations. * **type** *(dict) --* Returns the type of the capability. Currently, only "edi" is supported. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **inputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** *(string) --* Returns the system-assigned unique identifier for the transformer. * **instructionsDocuments** *(list) --* Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the capability. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / create_transformer create_transformer ****************** B2BI.Client.create_transformer(**kwargs) Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios: * *Inbound EDI*: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires. * *Outbound EDI*: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file. Note: The following fields are provided for backwards compatibility only: "fileFormat", "mappingTemplate", "ediType", and "sampleDocument". * Use the "mapping" data type in place of "mappingTemplate" and "fileFormat" * Use the "sampleDocuments" data type in place of "sampleDocument" * Use either the "inputConversion" or "outputConversion" in place of "ediType" See also: AWS API Documentation **Request Syntax** response = client.create_transformer( name='string', clientToken='string', tags=[ { 'Key': 'string', 'Value': 'string' }, ], fileFormat='XML'|'JSON'|'NOT_USED', mappingTemplate='string', ediType={ 'x12Details': { 'transactionSet': 'X12_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' }, ] } ) Parameters: * **name** (*string*) -- **[REQUIRED]** Specifies the name of the transformer, used to identify it. * **clientToken** (*string*) -- Reserved for future use. This field is autopopulated if not provided. * **tags** (*list*) -- Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. * *(dict) --* Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called "Group" and assign the values "Research" and "Accounting" to that group. * **Key** *(string) --* **[REQUIRED]** Specifies the name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name that you create. * **fileFormat** (*string*) -- Specifies that the currently supported file formats for EDI transformations are "JSON" and "XML". * **mappingTemplate** (*string*) -- Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT. Note: This parameter is available for backwards compatibility. Use the Mapping data type instead. * **ediType** (*dict*) -- Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12Details". * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** (*string*) -- Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** (*dict*) -- Specify the "InputConversion" object, which contains the format options for the inbound transformation. * **fromFormat** *(string) --* **[REQUIRED]** The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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). * **mapping** (*dict*) -- Specify the structure that contains the mapping template and its language (either XSLT or JSONATA). * **templateLanguage** *(string) --* **[REQUIRED]** The transformation language for the template, either XSLT or JSONATA. * **template** *(string) --* A string that represents the mapping template, in the transformation language specified in "templateLanguage". * **outputConversion** (*dict*) -- A structure that contains the "OutputConversion" object, which contains the format options for the outbound transformation. * **toFormat** *(string) --* **[REQUIRED]** The format for the output from an outbound transformer: only X12 is currently supported. * **formatOptions** *(dict) --* A structure that contains the X12 transaction set and version for the transformer output. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** (*dict*) -- Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* **[REQUIRED]** Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* **[REQUIRED]** Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. Return type: dict Returns: **Response Syntax** { 'transformerId': 'string', 'transformerArn': 'string', 'name': 'string', 'status': 'active'|'inactive', 'createdAt': datetime(2015, 1, 1), 'fileFormat': 'XML'|'JSON'|'NOT_USED', 'mappingTemplate': 'string', 'ediType': { 'x12Details': { 'transactionSet': 'X12_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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** *(string) --* Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** *(dict) --* Returns the "InputConversion" object, which contains the format options for the inbound transformation. * **fromFormat** *(string) --* The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** *(dict) --* Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / close close ***** B2BI.Client.close() Closes underlying endpoint connections. B2BI / Client / list_capabilities list_capabilities ***************** B2BI.Client.list_capabilities(**kwargs) Lists the capabilities associated with your Amazon Web Services account for your current or specified region. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. See also: AWS API Documentation **Request Syntax** response = client.list_capabilities( nextToken='string', maxResults=123 ) Parameters: * **nextToken** (*string*) -- When additional results are obtained from the command, a "NextToken" parameter is returned in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional resources. * **maxResults** (*integer*) -- Specifies the maximum number of capabilities to return. Return type: dict Returns: **Response Syntax** { 'capabilities': [ { 'capabilityId': 'string', 'name': 'string', 'type': 'edi', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' } **Response Structure** * *(dict) --* * **capabilities** *(list) --* Returns one or more capabilities associated with this partnership. * *(dict) --* Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. * **capabilityId** *(string) --* Returns a system-assigned unique identifier for the capability. * **name** *(string) --* The display name of the capability. * **type** *(string) --* Returns the type of the capability. Currently, only "edi" is supported. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the capability. * **modifiedAt** *(datetime) --* Returns a timestamp that identifies the most recent date and time that the capability 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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / generate_mapping generate_mapping **************** B2BI.Client.generate_mapping(**kwargs) Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically. Depending on the accuracy and other factors, you can then edit the mapping for your needs. Note: Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the *Amazon Web Services B2B Data Interchange User guide*. To generate a mapping, perform the following steps: * Start with an X12 EDI document to use as the input. * Call "TestMapping" using your EDI document. * Use the output from the "TestMapping" operation as either input or output for your GenerateMapping call, along with your sample file. See also: AWS API Documentation **Request Syntax** response = client.generate_mapping( inputFileContent='string', outputFileContent='string', mappingType='JSONATA'|'XSLT' ) Parameters: * **inputFileContent** (*string*) -- **[REQUIRED]** Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a starting point for the mapping. * **outputFileContent** (*string*) -- **[REQUIRED]** Provide the contents of a sample X12 EDI file, either in JSON or XML format, to use as a target for the mapping. * **mappingType** (*string*) -- **[REQUIRED]** Specify the mapping type: either "JSONATA" or "XSLT." Return type: dict Returns: **Response Syntax** { 'mappingTemplate': 'string', 'mappingAccuracy': ... } **Response Structure** * *(dict) --* * **mappingTemplate** *(string) --* Returns a mapping template based on your inputs. * **mappingAccuracy** *(float) --* Returns a percentage that estimates the accuracy of the generated mapping. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / delete_profile delete_profile ************** B2BI.Client.delete_profile(**kwargs) Deletes the specified profile. A profile is the mechanism used to create the concept of a private network. See also: AWS API Documentation **Request Syntax** response = client.delete_profile( profileId='string' ) Parameters: **profileId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for the profile. Returns: None **Exceptions** * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / update_profile update_profile ************** B2BI.Client.update_profile(**kwargs) Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network. See also: AWS API Documentation **Request Syntax** response = client.update_profile( profileId='string', name='string', email='string', phone='string', businessName='string' ) Parameters: * **profileId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for the profile. * **name** (*string*) -- The name of the profile, used to identify it. * **email** (*string*) -- Specifies the email address associated with this customer profile. * **phone** (*string*) -- Specifies the phone number associated with the profile. * **businessName** (*string*) -- Specifies the name for the business associated with this profile. Return type: dict Returns: **Response Syntax** { 'profileId': 'string', 'profileArn': 'string', 'name': 'string', 'email': 'string', 'phone': 'string', 'businessName': 'string', 'logging': 'ENABLED'|'DISABLED', 'logGroupName': '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. * **profileArn** *(string) --* Returns an Amazon Resource Name (ARN) for the profile. * **name** *(string) --* Returns the name of the profile. * **email** *(string) --* Returns the email address associated with this customer profile. * **phone** *(string) --* Returns the phone number associated with the profile. * **businessName** *(string) --* Returns the name for the business associated with this profile. * **logging** *(string) --* Specifies whether or not logging is enabled for this profile. * **logGroupName** *(string) --* Returns the name of the logging group. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the profile. * **modifiedAt** *(datetime) --* Returns a timestamp for last time the profile was modified. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / update_transformer update_transformer ****************** B2BI.Client.update_transformer(**kwargs) 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** response = 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' }, ] } ) Parameters: * **transformerId** (*string*) -- **[REQUIRED]** Specifies the system-assigned unique identifier for the transformer. * **name** (*string*) -- Specify a new name for the transformer, if you want to update it. * **status** (*string*) -- Specifies the transformer's status. You can update the state of the transformer from "inactive" to "active". * **fileFormat** (*string*) -- Specifies that the currently supported file formats for EDI transformations are "JSON" and "XML". * **mappingTemplate** (*string*) -- Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT. Note: This parameter is available for backwards compatibility. Use the Mapping data type instead. * **ediType** (*dict*) -- Specifies the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12Details". * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** (*string*) -- Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** (*dict*) -- 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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). * **mapping** (*dict*) -- Specify the structure that contains the mapping template and its language (either XSLT or JSONATA). * **templateLanguage** *(string) --* **[REQUIRED]** The transformation language for the template, either XSLT or JSONATA. * **template** *(string) --* A string that represents the mapping template, in the transformation language specified in "templateLanguage". * **outputConversion** (*dict*) -- 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. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** (*dict*) -- Specify a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* **[REQUIRED]** Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* **[REQUIRED]** Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. Return type: dict Returns: **Response Syntax** { 'transformerId': 'string', 'transformerArn': 'string', 'name': 'string', 'status': 'active'|'inactive', 'createdAt': datetime(2015, 1, 1), '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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocument** *(string) --* Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data. * **inputConversion** *(dict) --* Returns the "InputConversion" object, which contains the format options for the inbound transformation. * **fromFormat** *(string) --* The format for the transformer input: currently on "X12" is supported. * **formatOptions** *(dict) --* A structure that contains the formatting options for an inbound transformer. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file. Note: If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **sampleDocuments** *(dict) --* Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents. * **bucketName** *(string) --* Contains the Amazon S3 bucket that is used to hold your sample documents. * **keys** *(list) --* Contains an array of the Amazon S3 keys used to identify the location for your sample documents. * *(dict) --* An array of the Amazon S3 keys used to identify the location for your sample documents. * **input** *(string) --* An array of keys for your input sample documents. * **output** *(string) --* An array of keys for your output sample documents. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / list_partnerships list_partnerships ***************** B2BI.Client.list_partnerships(**kwargs) 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** response = client.list_partnerships( profileId='string', nextToken='string', maxResults=123 ) Parameters: * **profileId** (*string*) -- Specifies the unique, system- generated identifier for the profile connected to this partnership. * **nextToken** (*string*) -- When additional results are obtained from the command, a "NextToken" parameter is returned in the output. You can then pass the "NextToken" parameter in a subsequent command to continue listing additional resources. * **maxResults** (*integer*) -- Specifies the maximum number of capabilities to return. Return type: 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / delete_partnership delete_partnership ****************** B2BI.Client.delete_partnership(**kwargs) Deletes the specified partnership. 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** response = client.delete_partnership( partnershipId='string' ) Parameters: **partnershipId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for a partnership. Returns: None **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / create_partnership create_partnership ****************** B2BI.Client.create_partnership(**kwargs) 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** response = 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' }, ] ) Parameters: * **profileId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for the profile connected to this partnership. * **name** (*string*) -- **[REQUIRED]** Specifies a descriptive name for the partnership. * **email** (*string*) -- **[REQUIRED]** Specifies the email address associated with this trading partner. * **phone** (*string*) -- Specifies the phone number associated with the partnership. * **capabilities** (*list*) -- **[REQUIRED]** Specifies a list of the capabilities associated with this partnership. * *(string) --* * **capabilityOptions** (*dict*) -- Specify the structure that contains the details for the associated capabilities. * **outboundEdi** *(dict) --* A structure that contains the outbound EDI options. Note: This is a Tagged Union structure. Only one of the following top level keys can be set: "x12". * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. * **clientToken** (*string*) -- Reserved for future use. This field is autopopulated if not provided. * **tags** (*list*) -- Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose. * *(dict) --* Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called "Group" and assign the values "Research" and "Accounting" to that group. * **Key** *(string) --* **[REQUIRED]** Specifies the name assigned to the tag that you create. * **Value** *(string) --* **[REQUIRED]** Contains one or more values that you assigned to the key name that you create. Return type: dict Returns: **Response Syntax** { '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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ConflictException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ServiceQuotaExceededException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / tag_resource tag_resource ************ B2BI.Client.tag_resource(**kwargs) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities. There is no response returned from this call. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceARN='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **ResourceARN** (*string*) -- **[REQUIRED]** Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer. * **Tags** (*list*) -- **[REQUIRED]** 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. Returns: None **Exceptions** * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_capability get_capability ************** B2BI.Client.get_capability(**kwargs) Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs. See also: AWS API Documentation **Request Syntax** response = client.get_capability( capabilityId='string' ) Parameters: **capabilityId** (*string*) -- **[REQUIRED]** Specifies a system-assigned unique identifier for the capability. Return type: dict Returns: **Response Syntax** { 'capabilityId': 'string', 'capabilityArn': 'string', 'name': 'string', 'type': 'edi', 'configuration': { 'edi': { 'capabilityDirection': 'INBOUND'|'OUTBOUND', 'type': { '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' } }, 'inputLocation': { 'bucketName': 'string', 'key': 'string' }, 'outputLocation': { 'bucketName': 'string', 'key': 'string' }, 'transformerId': 'string' } }, 'instructionsDocuments': [ { 'bucketName': 'string', 'key': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **capabilityId** *(string) --* Returns a system-assigned unique identifier for the capability. * **capabilityArn** *(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 capability, used to identify it. * **type** *(string) --* Returns the type of the capability. Currently, only "edi" is supported. * **configuration** *(dict) --* Returns a structure that contains the details for a capability. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "edi". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **edi** *(dict) --* An EDI (electronic data interchange) configuration object. * **capabilityDirection** *(string) --* Specifies whether this is capability is for inbound or outbound transformations. * **type** *(dict) --* Returns the type of the capability. Currently, only "edi" is supported. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12Details". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12Details** *(dict) --* Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents. * **transactionSet** *(string) --* Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee. * **version** *(string) --* Returns the version to use for the specified X12 transaction set. * **inputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the input file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **outputLocation** *(dict) --* Contains the Amazon S3 bucket and prefix for the location of the output file, which is contained in an "S3Location" object. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **transformerId** *(string) --* Returns the system-assigned unique identifier for the transformer. * **instructionsDocuments** *(list) --* Returns one or more locations in Amazon S3, each specifying an EDI document that can be used with this capability. Each item contains the name of the bucket and the key, to identify the document's location. * *(dict) --* Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services B2B Data Interchange. File locations in Amazon S3 are identified using a combination of the bucket and key. * **bucketName** *(string) --* Specifies the name of the Amazon S3 bucket. * **key** *(string) --* Specifies the Amazon S3 key for the file location. * **createdAt** *(datetime) --* Returns a timestamp for creation date and time of the capability. * **modifiedAt** *(datetime) --* Returns a timestamp for last time the capability was modified. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.InternalServerException" B2BI / Client / get_partnership get_partnership *************** B2BI.Client.get_partnership(**kwargs) 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** response = client.get_partnership( partnershipId='string' ) Parameters: **partnershipId** (*string*) -- **[REQUIRED]** Specifies the unique, system-generated identifier for a partnership. Return type: 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. Note: This is a Tagged Union structure. Only one of the following top level keys will be set: "x12". If a client receives an unknown member it will set "SDK_UNKNOWN_MEMBER" as the top level key, which maps to the name or tag of the unknown member. The structure of "SDK_UNKNOWN_MEMBER" is as follows: 'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'} * **x12** *(dict) --* A structure that contains 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. Note: This parameter is only honored for version greater than 401 ( "VERSION_4010" and higher).For versions less than 401, this field is called StandardsId, in which case our service sets the value to "U". * **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. Note: When you specify "ONE_LINE", do not provide either the line length nor the line terminator value. * "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. **Exceptions** * "B2BI.Client.exceptions.AccessDeniedException" * "B2BI.Client.exceptions.ValidationException" * "B2BI.Client.exceptions.ResourceNotFoundException" * "B2BI.Client.exceptions.ThrottlingException" * "B2BI.Client.exceptions.InternalServerException"