2024/10/02 - AWS B2B Data Interchange - 2 new13 updated api methods
Changes Added and updated APIs to support outbound EDI transformations
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
client.create_starter_mapping_template(
outputSampleLocation={
'bucketName': 'string',
'key': 'string'
},
mappingType='JSONATA'|'XSLT',
templateDetails={
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
)
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.
string
[REQUIRED]
Specify the format for the mapping template: either JSONATA or XSLT.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
dict
Response Syntax
{
'mappingTemplate': 'string'
}
Response Structure
(dict) --
mappingTemplate (string) --
Returns a string that represents the mapping template.
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
client.test_conversion(
source={
'fileFormat': 'JSON'|'XML',
'inputFile': {
'fileContent': 'string'
}
},
target={
'fileFormat': 'X12',
'formatDetails': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'outputSampleFile': {
'fileLocation': {
'bucketName': 'string',
'key': 'string'
}
}
}
)
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
fileContent (string) --
Specify the input contents, as a string, for the source of an outbound transformation.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
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
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.
dict
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) --
{'configuration': {'edi': {'capabilityDirection': 'INBOUND | OUTBOUND'}}}
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
client.create_capability(
name='string',
type='edi',
configuration={
'edi': {
'capabilityDirection': 'INBOUND'|'OUTBOUND',
'type': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'inputLocation': {
'bucketName': 'string',
'key': 'string'
},
'outputLocation': {
'bucketName': 'string',
'key': 'string'
},
'transformerId': 'string'
}
},
instructionsDocuments=[
{
'bucketName': 'string',
'key': 'string'
},
],
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the name of the capability, used to identify it.
string
[REQUIRED]
Specifies the type of the capability. Currently, only edi is supported.
dict
[REQUIRED]
Specifies a structure that contains the details for a capability.
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.
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.
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.
string
Reserved for future use.
This field is autopopulated if not provided.
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.
dict
Response Syntax
{
'capabilityId': 'string',
'capabilityArn': 'string',
'name': 'string',
'type': 'edi',
'configuration': {
'edi': {
'capabilityDirection': 'INBOUND'|'OUTBOUND',
'type': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'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.
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.
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.
{'capabilityOptions': {'outboundEdi': {'x12': {'common': {'delimiters': {'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'},
'functionalGroupHeaders': {'applicationReceiverCode': 'string',
'applicationSenderCode': 'string',
'responsibleAgencyCode': 'string'},
'interchangeControlHeaders': {'acknowledgmentRequestedCode': 'string',
'receiverId': 'string',
'receiverIdQualifier': 'string',
'repetitionSeparator': 'string',
'senderId': 'string',
'senderIdQualifier': 'string',
'usageIndicatorCode': 'string'},
'validateEdi': 'boolean'}}}}}
Creates a partnership between a customer and a trading partner, based on the supplied parameters. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
See also: AWS API Documentation
Request Syntax
client.create_partnership(
profileId='string',
name='string',
email='string',
phone='string',
capabilities=[
'string',
],
capabilityOptions={
'outboundEdi': {
'x12': {
'common': {
'interchangeControlHeaders': {
'senderIdQualifier': 'string',
'senderId': 'string',
'receiverIdQualifier': 'string',
'receiverId': 'string',
'repetitionSeparator': 'string',
'acknowledgmentRequestedCode': 'string',
'usageIndicatorCode': 'string'
},
'functionalGroupHeaders': {
'applicationSenderCode': 'string',
'applicationReceiverCode': 'string',
'responsibleAgencyCode': 'string'
},
'delimiters': {
'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'
},
'validateEdi': True|False
}
}
}
},
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for the profile connected to this partnership.
string
[REQUIRED]
Specifies a descriptive name for the partnership.
string
[REQUIRED]
Specifies the email address associated with this trading partner.
string
Specifies the phone number associated with the partnership.
list
[REQUIRED]
Specifies a list of the capabilities associated with this partnership.
(string) --
dict
Specify the structure that contains the details for the associated capabilities.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
string
Reserved for future use.
This field is autopopulated if not provided.
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.
dict
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
}
}
}
},
'tradingPartnerId': 'string',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile connected to this partnership.
partnershipId (string) --
Returns the unique, system-generated identifier for a partnership.
partnershipArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns a descriptive name for the partnership.
email (string) --
Returns the email address associated with this trading partner.
phone (string) --
Returns the phone number associated with the partnership.
capabilities (list) --
Returns one or more capabilities associated with this partnership.
(string) --
capabilityOptions (dict) --
Returns the structure that contains the details for the associated capabilities.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
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.
{'fileFormat': {'NOT_USED'},
'inputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'fromFormat': 'X12'},
'mapping': {'template': 'string', 'templateLanguage': 'XSLT | JSONATA'},
'outputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'toFormat': 'X12'},
'sampleDocuments': {'bucketName': 'string',
'keys': [{'input': 'string', 'output': 'string'}]}}
Creates a transformer. Amazon Web Services B2B Data Interchange currently supports two scenarios:
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
See also: AWS API Documentation
Request Syntax
client.create_transformer(
name='string',
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
],
fileFormat='XML'|'JSON'|'NOT_USED',
mappingTemplate='string',
ediType={
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
sampleDocument='string',
inputConversion={
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
mapping={
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
outputConversion={
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
sampleDocuments={
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
)
string
[REQUIRED]
Specifies the name of the transformer, used to identify it.
string
Reserved for future use.
This field is autopopulated if not provided.
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.
string
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
string
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
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.
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.
string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
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.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
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.
dict
Response Syntax
{
'transformerId': 'string',
'transformerArn': 'string',
'name': 'string',
'status': 'active'|'inactive',
'createdAt': datetime(2015, 1, 1),
'fileFormat': 'XML'|'JSON'|'NOT_USED',
'mappingTemplate': 'string',
'ediType': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'sampleDocument': 'string',
'inputConversion': {
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'mapping': {
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
'outputConversion': {
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'sampleDocuments': {
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
}
Response Structure
(dict) --
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
transformerArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the transformer, used to identify it.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
inputConversion (dict) --
Returns the InputConversion object, which contains the format options for the inbound transformation.
fromFormat (string) --
The format for the transformer input: currently on X12 is supported.
formatOptions (dict) --
A structure that contains the formatting options for an inbound transformer.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
mapping (dict) --
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
templateLanguage (string) --
The transformation language for the template, either XSLT or JSONATA.
template (string) --
A string that represents the mapping template, in the transformation language specified in templateLanguage.
outputConversion (dict) --
Returns the OutputConversion object, which contains the format options for the outbound transformation.
toFormat (string) --
The format for the output from an outbound transformer: only X12 is currently supported.
formatOptions (dict) --
A structure that contains the X12 transaction set and version for the transformer output.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocuments (dict) --
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
bucketName (string) --
Contains the Amazon S3 bucket that is used to hold your sample documents.
keys (list) --
Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
(dict) --
An array of the Amazon S3 keys used to identify the location for your sample documents.
input (string) --
An array of keys for your input sample documents.
output (string) --
An array of keys for your output sample documents.
{'configuration': {'edi': {'capabilityDirection': 'INBOUND | OUTBOUND'}}}
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
client.get_capability(
capabilityId='string'
)
string
[REQUIRED]
Specifies a system-assigned unique identifier for the capability.
dict
Response Syntax
{
'capabilityId': 'string',
'capabilityArn': 'string',
'name': 'string',
'type': 'edi',
'configuration': {
'edi': {
'capabilityDirection': 'INBOUND'|'OUTBOUND',
'type': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'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.
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.
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.
{'capabilityOptions': {'outboundEdi': {'x12': {'common': {'delimiters': {'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'},
'functionalGroupHeaders': {'applicationReceiverCode': 'string',
'applicationSenderCode': 'string',
'responsibleAgencyCode': 'string'},
'interchangeControlHeaders': {'acknowledgmentRequestedCode': 'string',
'receiverId': 'string',
'receiverIdQualifier': 'string',
'repetitionSeparator': 'string',
'senderId': 'string',
'senderIdQualifier': 'string',
'usageIndicatorCode': 'string'},
'validateEdi': 'boolean'}}}}}
Retrieves the details for a partnership, based on the partner and profile IDs specified. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
See also: AWS API Documentation
Request Syntax
client.get_partnership(
partnershipId='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for a partnership.
dict
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
}
}
}
},
'tradingPartnerId': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile connected to this partnership.
partnershipId (string) --
Returns the unique, system-generated identifier for a partnership.
partnershipArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the display name of the partnership
email (string) --
Returns the email address associated with this trading partner.
phone (string) --
Returns the phone number associated with the partnership.
capabilities (list) --
Returns one or more capabilities associated with this partnership.
(string) --
capabilityOptions (dict) --
Contains the details for an Outbound EDI capability.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
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.
{'fileFormat': {'NOT_USED'},
'inputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'fromFormat': 'X12'},
'mapping': {'template': 'string', 'templateLanguage': 'XSLT | JSONATA'},
'outputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'toFormat': 'X12'},
'sampleDocuments': {'bucketName': 'string',
'keys': [{'input': 'string', 'output': 'string'}]}}
Retrieves the details for the transformer specified by the transformer ID. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
See also: AWS API Documentation
Request Syntax
client.get_transformer(
transformerId='string'
)
string
[REQUIRED]
Specifies the system-assigned unique identifier for the transformer.
dict
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_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'sampleDocument': 'string',
'inputConversion': {
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'mapping': {
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
'outputConversion': {
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'sampleDocuments': {
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
}
Response Structure
(dict) --
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
transformerArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the transformer, used to identify it.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
inputConversion (dict) --
Returns the InputConversion object, which contains the format options for the inbound transformation.
fromFormat (string) --
The format for the transformer input: currently on X12 is supported.
formatOptions (dict) --
A structure that contains the formatting options for an inbound transformer.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
mapping (dict) --
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
templateLanguage (string) --
The transformation language for the template, either XSLT or JSONATA.
template (string) --
A string that represents the mapping template, in the transformation language specified in templateLanguage.
outputConversion (dict) --
Returns the OutputConversion object, which contains the format options for the outbound transformation.
toFormat (string) --
The format for the output from an outbound transformer: only X12 is currently supported.
formatOptions (dict) --
A structure that contains the X12 transaction set and version for the transformer output.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocuments (dict) --
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
bucketName (string) --
Contains the Amazon S3 bucket that is used to hold your sample documents.
keys (list) --
Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
(dict) --
An array of the Amazon S3 keys used to identify the location for your sample documents.
input (string) --
An array of keys for your input sample documents.
output (string) --
An array of keys for your output sample documents.
{'partnerships': {'capabilityOptions': {'outboundEdi': {'x12': {'common': {'delimiters': {'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'},
'functionalGroupHeaders': {'applicationReceiverCode': 'string',
'applicationSenderCode': 'string',
'responsibleAgencyCode': 'string'},
'interchangeControlHeaders': {'acknowledgmentRequestedCode': 'string',
'receiverId': 'string',
'receiverIdQualifier': 'string',
'repetitionSeparator': 'string',
'senderId': 'string',
'senderIdQualifier': 'string',
'usageIndicatorCode': 'string'},
'validateEdi': 'boolean'}}}}}}
Lists the partnerships associated with your Amazon Web Services account for your current or specified region. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
See also: AWS API Documentation
Request Syntax
client.list_partnerships(
profileId='string',
nextToken='string',
maxResults=123
)
string
Specifies the unique, system-generated identifier for the profile connected to this partnership.
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.
integer
Specifies the maximum number of capabilities to return.
dict
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
}
}
}
},
'tradingPartnerId': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
partnerships (list) --
Specifies a list of your partnerships.
(dict) --
A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
profileId (string) --
Returns the unique, system-generated identifier for the profile connected to this partnership.
partnershipId (string) --
Returns the unique, system-generated identifier for a partnership.
name (string) --
Returns the name of the partnership.
capabilities (list) --
Returns one or more capabilities associated with this partnership.
(string) --
capabilityOptions (dict) --
Contains the details for an Outbound EDI capability.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
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.
{'transformers': {'fileFormat': {'NOT_USED'},
'inputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 '
'| '
'X12_180 '
'| '
'X12_204 '
'| '
'X12_210 '
'| '
'X12_211 '
'| '
'X12_214 '
'| '
'X12_215 '
'| '
'X12_259 '
'| '
'X12_260 '
'| '
'X12_266 '
'| '
'X12_269 '
'| '
'X12_270 '
'| '
'X12_271 '
'| '
'X12_274 '
'| '
'X12_275 '
'| '
'X12_276 '
'| '
'X12_277 '
'| '
'X12_278 '
'| '
'X12_310 '
'| '
'X12_315 '
'| '
'X12_322 '
'| '
'X12_404 '
'| '
'X12_410 '
'| '
'X12_417 '
'| '
'X12_421 '
'| '
'X12_426 '
'| '
'X12_810 '
'| '
'X12_820 '
'| '
'X12_824 '
'| '
'X12_830 '
'| '
'X12_832 '
'| '
'X12_834 '
'| '
'X12_835 '
'| '
'X12_837 '
'| '
'X12_844 '
'| '
'X12_846 '
'| '
'X12_849 '
'| '
'X12_850 '
'| '
'X12_852 '
'| '
'X12_855 '
'| '
'X12_856 '
'| '
'X12_860 '
'| '
'X12_861 '
'| '
'X12_864 '
'| '
'X12_865 '
'| '
'X12_869 '
'| '
'X12_870 '
'| '
'X12_940 '
'| '
'X12_945 '
'| '
'X12_990 '
'| '
'X12_997 '
'| '
'X12_999 '
'| '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 '
'| '
'VERSION_4030 '
'| '
'VERSION_5010 '
'| '
'VERSION_5010_HIPAA'}},
'fromFormat': 'X12'},
'mapping': {'template': 'string',
'templateLanguage': 'XSLT | JSONATA'},
'outputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 '
'| '
'X12_180 '
'| '
'X12_204 '
'| '
'X12_210 '
'| '
'X12_211 '
'| '
'X12_214 '
'| '
'X12_215 '
'| '
'X12_259 '
'| '
'X12_260 '
'| '
'X12_266 '
'| '
'X12_269 '
'| '
'X12_270 '
'| '
'X12_271 '
'| '
'X12_274 '
'| '
'X12_275 '
'| '
'X12_276 '
'| '
'X12_277 '
'| '
'X12_278 '
'| '
'X12_310 '
'| '
'X12_315 '
'| '
'X12_322 '
'| '
'X12_404 '
'| '
'X12_410 '
'| '
'X12_417 '
'| '
'X12_421 '
'| '
'X12_426 '
'| '
'X12_810 '
'| '
'X12_820 '
'| '
'X12_824 '
'| '
'X12_830 '
'| '
'X12_832 '
'| '
'X12_834 '
'| '
'X12_835 '
'| '
'X12_837 '
'| '
'X12_844 '
'| '
'X12_846 '
'| '
'X12_849 '
'| '
'X12_850 '
'| '
'X12_852 '
'| '
'X12_855 '
'| '
'X12_856 '
'| '
'X12_860 '
'| '
'X12_861 '
'| '
'X12_864 '
'| '
'X12_865 '
'| '
'X12_869 '
'| '
'X12_870 '
'| '
'X12_940 '
'| '
'X12_945 '
'| '
'X12_990 '
'| '
'X12_997 '
'| '
'X12_999 '
'| '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 '
'| '
'VERSION_4030 '
'| '
'VERSION_5010 '
'| '
'VERSION_5010_HIPAA'}},
'toFormat': 'X12'},
'sampleDocuments': {'bucketName': 'string',
'keys': [{'input': 'string',
'output': 'string'}]}}}
Lists the available transformers. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
See also: AWS API Documentation
Request Syntax
client.list_transformers(
nextToken='string',
maxResults=123
)
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.
integer
Specifies the number of items to return for the API response.
dict
Response Syntax
{
'transformers': [
{
'transformerId': 'string',
'name': 'string',
'status': 'active'|'inactive',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'fileFormat': 'XML'|'JSON'|'NOT_USED',
'mappingTemplate': 'string',
'ediType': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'sampleDocument': 'string',
'inputConversion': {
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'mapping': {
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
'outputConversion': {
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'sampleDocuments': {
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
transformers (list) --
Returns an array of one or more transformer objects.
For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.
(dict) --
Contains the details for a transformer object. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
name (string) --
Returns the descriptive name for the transformer.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
createdAt (datetime) --
Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
modifiedAt (datetime) --
Returns a timestamp representing the date and time for the most recent change for the transformer object.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
inputConversion (dict) --
Returns a structure that contains the format options for the transformation.
fromFormat (string) --
The format for the transformer input: currently on X12 is supported.
formatOptions (dict) --
A structure that contains the formatting options for an inbound transformer.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
mapping (dict) --
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
templateLanguage (string) --
The transformation language for the template, either XSLT or JSONATA.
template (string) --
A string that represents the mapping template, in the transformation language specified in templateLanguage.
outputConversion (dict) --
Returns the OutputConversion object, which contains the format options for the outbound transformation.
toFormat (string) --
The format for the output from an outbound transformer: only X12 is currently supported.
formatOptions (dict) --
A structure that contains the X12 transaction set and version for the transformer output.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocuments (dict) --
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
bucketName (string) --
Contains the Amazon S3 bucket that is used to hold your sample documents.
keys (list) --
Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
(dict) --
An array of the Amazon S3 keys used to identify the location for your sample documents.
input (string) --
An array of keys for your input sample documents.
output (string) --
An array of keys for your output sample documents.
nextToken (string) --
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
{'fileFormat': {'NOT_USED'}}
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
client.test_mapping(
inputFileContent='string',
mappingTemplate='string',
fileFormat='XML'|'JSON'|'NOT_USED'
)
string
[REQUIRED]
Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.
string
[REQUIRED]
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
string
[REQUIRED]
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
dict
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
{'fileFormat': {'NOT_USED'}}
Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.
See also: AWS API Documentation
Request Syntax
client.test_parsing(
inputFile={
'bucketName': 'string',
'key': 'string'
},
fileFormat='XML'|'JSON'|'NOT_USED',
ediType={
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
)
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.
string
[REQUIRED]
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
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.
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.
dict
Response Syntax
{
'parsedFileContent': '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.
{'configuration': {'edi': {'capabilityDirection': 'INBOUND | OUTBOUND'}}}
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
client.update_capability(
capabilityId='string',
name='string',
configuration={
'edi': {
'capabilityDirection': 'INBOUND'|'OUTBOUND',
'type': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'inputLocation': {
'bucketName': 'string',
'key': 'string'
},
'outputLocation': {
'bucketName': 'string',
'key': 'string'
},
'transformerId': 'string'
}
},
instructionsDocuments=[
{
'bucketName': 'string',
'key': 'string'
},
]
)
string
[REQUIRED]
Specifies a system-assigned unique identifier for the capability.
string
Specifies a new name for the capability, to replace the existing name.
dict
Specifies a structure that contains the details for a capability.
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.
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.
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.
dict
Response Syntax
{
'capabilityId': 'string',
'capabilityArn': 'string',
'name': 'string',
'type': 'edi',
'configuration': {
'edi': {
'capabilityDirection': 'INBOUND'|'OUTBOUND',
'type': {
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'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.
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.
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.
{'capabilityOptions': {'outboundEdi': {'x12': {'common': {'delimiters': {'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'},
'functionalGroupHeaders': {'applicationReceiverCode': 'string',
'applicationSenderCode': 'string',
'responsibleAgencyCode': 'string'},
'interchangeControlHeaders': {'acknowledgmentRequestedCode': 'string',
'receiverId': 'string',
'receiverIdQualifier': 'string',
'repetitionSeparator': 'string',
'senderId': 'string',
'senderIdQualifier': 'string',
'usageIndicatorCode': 'string'},
'validateEdi': 'boolean'}}}}}
Updates some of the parameters for a partnership between a customer and trading partner. A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
See also: AWS API Documentation
Request Syntax
client.update_partnership(
partnershipId='string',
name='string',
capabilities=[
'string',
],
capabilityOptions={
'outboundEdi': {
'x12': {
'common': {
'interchangeControlHeaders': {
'senderIdQualifier': 'string',
'senderId': 'string',
'receiverIdQualifier': 'string',
'receiverId': 'string',
'repetitionSeparator': 'string',
'acknowledgmentRequestedCode': 'string',
'usageIndicatorCode': 'string'
},
'functionalGroupHeaders': {
'applicationSenderCode': 'string',
'applicationReceiverCode': 'string',
'responsibleAgencyCode': 'string'
},
'delimiters': {
'componentSeparator': 'string',
'dataElementSeparator': 'string',
'segmentTerminator': 'string'
},
'validateEdi': True|False
}
}
}
}
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for a partnership.
string
The name of the partnership, used to identify it.
list
List of the capabilities associated with this partnership.
(string) --
dict
To update, specify the structure that contains the details for the associated capabilities.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
dict
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
}
}
}
},
'tradingPartnerId': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile connected to this partnership.
partnershipId (string) --
Returns the unique, system-generated identifier for a partnership.
partnershipArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
The name of the partnership, used to identify it.
email (string) --
Returns the email address associated with this trading partner.
phone (string) --
Returns the phone number associated with the partnership.
capabilities (list) --
Returns one or more capabilities associated with this partnership.
(string) --
capabilityOptions (dict) --
Returns the structure that contains the details for the associated capabilities.
outboundEdi (dict) --
A structure that contains the outbound EDI options.
x12 (dict) --
A structure that contains an X12 envelope structure.
common (dict) --
A container for the X12 outbound EDI headers.
interchangeControlHeaders (dict) --
In X12 EDI messages, delimiters are used to mark the end of segments or elements, and are defined in the interchange control header.
senderIdQualifier (string) --
Located at position ISA-05 in the header. Qualifier for the sender ID. Together, the ID and qualifier uniquely identify the sending trading partner.
senderId (string) --
Located at position ISA-06 in the header. This value (along with the senderIdQualifier) identifies the sender of the interchange.
receiverIdQualifier (string) --
Located at position ISA-07 in the header. Qualifier for the receiver ID. Together, the ID and qualifier uniquely identify the receiving trading partner.
receiverId (string) --
Located at position ISA-08 in the header. This value (along with the receiverIdQualifier) identifies the intended recipient of the interchange.
repetitionSeparator (string) --
Located at position ISA-11 in the header. This string makes it easier when you need to group similar adjacent element values together without using extra segments.
acknowledgmentRequestedCode (string) --
Located at position ISA-14 in the header. The value "1" indicates that the sender is requesting an interchange acknowledgment at receipt of the interchange. The value "0" is used otherwise.
usageIndicatorCode (string) --
Located at position ISA-15 in the header. Specifies how this interchange is being used:
T indicates this interchange is for testing.
P indicates this interchange is for production.
I indicates this interchange is informational.
functionalGroupHeaders (dict) --
The functional group headers for the X12 object.
applicationSenderCode (string) --
A value representing the code used to identify the party transmitting a message, at position GS-02.
applicationReceiverCode (string) --
A value representing the code used to identify the party receiving a message, at position GS-03.
responsibleAgencyCode (string) --
A code that identifies the issuer of the standard, at position GS-07.
delimiters (dict) --
The delimiters, for example semicolon ( ;), that separates sections of the headers for the X12 object.
componentSeparator (string) --
The component, or sub-element, separator. The default value is : (colon).
dataElementSeparator (string) --
The data element separator. The default value is * (asterisk).
segmentTerminator (string) --
The segment terminator. The default value is ~ (tilde).
validateEdi (boolean) --
Specifies whether or not to validate the EDI for this X12 object: TRUE or FALSE.
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.
{'fileFormat': {'NOT_USED'},
'inputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'fromFormat': 'X12'},
'mapping': {'template': 'string', 'templateLanguage': 'XSLT | JSONATA'},
'outputConversion': {'formatOptions': {'x12': {'transactionSet': 'X12_110 | '
'X12_180 | '
'X12_204 | '
'X12_210 | '
'X12_211 | '
'X12_214 | '
'X12_215 | '
'X12_259 | '
'X12_260 | '
'X12_266 | '
'X12_269 | '
'X12_270 | '
'X12_271 | '
'X12_274 | '
'X12_275 | '
'X12_276 | '
'X12_277 | '
'X12_278 | '
'X12_310 | '
'X12_315 | '
'X12_322 | '
'X12_404 | '
'X12_410 | '
'X12_417 | '
'X12_421 | '
'X12_426 | '
'X12_810 | '
'X12_820 | '
'X12_824 | '
'X12_830 | '
'X12_832 | '
'X12_834 | '
'X12_835 | '
'X12_837 | '
'X12_844 | '
'X12_846 | '
'X12_849 | '
'X12_850 | '
'X12_852 | '
'X12_855 | '
'X12_856 | '
'X12_860 | '
'X12_861 | '
'X12_864 | '
'X12_865 | '
'X12_869 | '
'X12_870 | '
'X12_940 | '
'X12_945 | '
'X12_990 | '
'X12_997 | '
'X12_999 | '
'X12_270_X279 '
'| '
'X12_271_X279 '
'| '
'X12_275_X210 '
'| '
'X12_275_X211 '
'| '
'X12_276_X212 '
'| '
'X12_277_X212 '
'| '
'X12_277_X214 '
'| '
'X12_277_X364 '
'| '
'X12_278_X217 '
'| '
'X12_820_X218 '
'| '
'X12_820_X306 '
'| '
'X12_824_X186 '
'| '
'X12_834_X220 '
'| '
'X12_834_X307 '
'| '
'X12_834_X318 '
'| '
'X12_835_X221 '
'| '
'X12_837_X222 '
'| '
'X12_837_X223 '
'| '
'X12_837_X224 '
'| '
'X12_837_X291 '
'| '
'X12_837_X292 '
'| '
'X12_837_X298 '
'| '
'X12_999_X231',
'version': 'VERSION_4010 | '
'VERSION_4030 | '
'VERSION_5010 | '
'VERSION_5010_HIPAA'}},
'toFormat': 'X12'},
'sampleDocuments': {'bucketName': 'string',
'keys': [{'input': 'string', 'output': 'string'}]}}
Updates the specified parameters for a transformer. A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
See also: AWS API Documentation
Request Syntax
client.update_transformer(
transformerId='string',
name='string',
status='active'|'inactive',
fileFormat='XML'|'JSON'|'NOT_USED',
mappingTemplate='string',
ediType={
'x12Details': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
sampleDocument='string',
inputConversion={
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
mapping={
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
outputConversion={
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
sampleDocuments={
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
)
string
[REQUIRED]
Specifies the system-assigned unique identifier for the transformer.
string
Specify a new name for the transformer, if you want to update it.
string
Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
string
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
string
Specifies the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
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.
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.
string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
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.
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.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
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.
dict
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_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
},
'sampleDocument': 'string',
'inputConversion': {
'fromFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'mapping': {
'templateLanguage': 'XSLT'|'JSONATA',
'template': 'string'
},
'outputConversion': {
'toFormat': 'X12',
'formatOptions': {
'x12': {
'transactionSet': 'X12_110'|'X12_180'|'X12_204'|'X12_210'|'X12_211'|'X12_214'|'X12_215'|'X12_259'|'X12_260'|'X12_266'|'X12_269'|'X12_270'|'X12_271'|'X12_274'|'X12_275'|'X12_276'|'X12_277'|'X12_278'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_417'|'X12_421'|'X12_426'|'X12_810'|'X12_820'|'X12_824'|'X12_830'|'X12_832'|'X12_834'|'X12_835'|'X12_837'|'X12_844'|'X12_846'|'X12_849'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_865'|'X12_869'|'X12_870'|'X12_940'|'X12_945'|'X12_990'|'X12_997'|'X12_999'|'X12_270_X279'|'X12_271_X279'|'X12_275_X210'|'X12_275_X211'|'X12_276_X212'|'X12_277_X212'|'X12_277_X214'|'X12_277_X364'|'X12_278_X217'|'X12_820_X218'|'X12_820_X306'|'X12_824_X186'|'X12_834_X220'|'X12_834_X307'|'X12_834_X318'|'X12_835_X221'|'X12_837_X222'|'X12_837_X223'|'X12_837_X224'|'X12_837_X291'|'X12_837_X292'|'X12_837_X298'|'X12_999_X231',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'|'VERSION_5010_HIPAA'
}
}
},
'sampleDocuments': {
'bucketName': 'string',
'keys': [
{
'input': 'string',
'output': 'string'
},
]
}
}
Response Structure
(dict) --
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
transformerArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the transformer.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the mapping template for the transformer. This template is used to map the parsed EDI file using JSONata or XSLT.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
inputConversion (dict) --
Returns the InputConversion object, which contains the format options for the inbound transformation.
fromFormat (string) --
The format for the transformer input: currently on X12 is supported.
formatOptions (dict) --
A structure that contains the formatting options for an inbound transformer.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
mapping (dict) --
Returns the structure that contains the mapping template and its language (either XSLT or JSONATA).
templateLanguage (string) --
The transformation language for the template, either XSLT or JSONATA.
template (string) --
A string that represents the mapping template, in the transformation language specified in templateLanguage.
outputConversion (dict) --
Returns the OutputConversion object, which contains the format options for the outbound transformation.
toFormat (string) --
The format for the output from an outbound transformer: only X12 is currently supported.
formatOptions (dict) --
A structure that contains the X12 transaction set and version for the transformer output.
x12 (dict) --
A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set.
sampleDocuments (dict) --
Returns a structure that contains the Amazon S3 bucket and an array of the corresponding keys used to identify the location for your sample documents.
bucketName (string) --
Contains the Amazon S3 bucket that is used to hold your sample documents.
keys (list) --
Contains an array of the Amazon S3 keys used to identify the location for your sample documents.
(dict) --
An array of the Amazon S3 keys used to identify the location for your sample documents.
input (string) --
An array of keys for your input sample documents.
output (string) --
An array of keys for your output sample documents.