2024/03/29 - AWS B2B Data Interchange - 8 updated api methods
Changes Supporting new EDI X12 transaction sets for X12 versions 4010, 4030, and 5010.
{'configuration': {'edi': {'type': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}}}
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': {
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
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. </p>
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 B2BI 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': {
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
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. </p>
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 B2BI 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.
{'ediType': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}
Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
See also: AWS API Documentation
Request Syntax
client.create_transformer(
name='string',
fileFormat='XML'|'JSON',
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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
sampleDocument='string',
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the name of the transformer, used to identify it.
string
[REQUIRED]
Specifies that the currently supported file formats for EDI transformations are JSON and XML.
string
[REQUIRED]
Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
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. </p>
string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
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
{
'transformerId': 'string',
'transformerArn': 'string',
'name': 'string',
'fileFormat': 'XML'|'JSON',
'mappingTemplate': 'string',
'status': 'active'|'inactive',
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1)
}
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.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
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. </p>
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
{'configuration': {'edi': {'type': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}}}
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': {
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
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. </p>
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 B2BI 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.
{'ediType': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}
Retrieves the details for the transformer specified by the transformer ID. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output 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',
'fileFormat': 'XML'|'JSON',
'mappingTemplate': 'string',
'status': 'active'|'inactive',
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
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.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
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. </p>
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.
{'transformers': {'ediType': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}}
Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output 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',
'fileFormat': 'XML'|'JSON',
'mappingTemplate': 'string',
'status': 'active'|'inactive',
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
transformers (list) --
Returns an array of one or more transformer objects.
For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.
(dict) --
Contains the details for a transformer object. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
name (string) --
Returns the descriptive name for the transformer.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
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. </p>
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z.
modifiedAt (datetime) --
Returns a timestamp representing the date and time for the most recent change for the transformer object.
nextToken (string) --
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.
{'ediType': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}
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',
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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
}
)
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. </p>
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': {'type': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}}}
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': {
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
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. </p>
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 B2BI 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': {
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
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. </p>
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 B2BI 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.
{'ediType': {'x12Details': {'transactionSet': {'X12_211',
'X12_259',
'X12_260',
'X12_266',
'X12_269',
'X12_270',
'X12_271',
'X12_274',
'X12_275',
'X12_276',
'X12_277',
'X12_278',
'X12_417',
'X12_421',
'X12_426',
'X12_810',
'X12_832',
'X12_834',
'X12_835',
'X12_837',
'X12_844',
'X12_849',
'X12_865',
'X12_869',
'X12_870',
'X12_945',
'X12_999'}}}}
Updates the specified parameters for a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
See also: AWS API Documentation
Request Syntax
client.update_transformer(
transformerId='string',
name='string',
fileFormat='XML'|'JSON',
mappingTemplate='string',
status='active'|'inactive',
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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
sampleDocument='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 that the currently supported file formats for EDI transformations are JSON and XML.
string
Specifies the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
string
Specifies the transformer's status. You can update the state of the transformer, from active to inactive, or inactive to active.
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. </p>
string
Specifies a sample EDI document that is used by a transformer as a guide for processing the EDI data.
dict
Response Syntax
{
'transformerId': 'string',
'transformerArn': 'string',
'name': 'string',
'fileFormat': 'XML'|'JSON',
'mappingTemplate': 'string',
'status': 'active'|'inactive',
'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',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
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.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML.
mappingTemplate (string) --
Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive. For the transformer to be used in a capability, its status must active.
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
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. </p>
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.