2023/11/27 - AWS B2B Data Interchange - 27 new api methods
Changes This is the initial SDK release for AWS B2B Data Interchange.
Instantiates a capability based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: edi.
edi (dict) --
An EDI (electronic data interchange) configuration object.
type (dict) -- [REQUIRED]
Returns the type of the capability. Currently, only edi is supported.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'inputLocation': {
'bucketName': 'string',
'key': 'string'
},
'outputLocation': {
'bucketName': 'string',
'key': 'string'
},
'transformerId': 'string'
}
},
'instructionsDocuments': [
{
'bucketName': 'string',
'key': 'string'
},
],
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
capabilityId (string) --
Returns a system-assigned unique identifier for the capability.
capabilityArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the capability used to identify it.
type (string) --
Returns the type of the capability. Currently, only edi is supported.
configuration (dict) --
Returns a structure that contains the details for a capability.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: edi. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
edi (dict) --
An EDI (electronic data interchange) configuration object.
type (dict) --
Returns the type of the capability. Currently, only edi is supported.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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.
Returns the details of the transformer run, based on the Transformer job ID.
See also: AWS API Documentation
Request Syntax
client.get_transformer_job(
transformerJobId='string',
transformerId='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for a transformer run.
string
[REQUIRED]
Specifies the system-assigned unique identifier for the transformer.
dict
Response Syntax
{
'status': 'running'|'succeeded'|'failed',
'outputFiles': [
{
'bucketName': 'string',
'key': 'string'
},
],
'message': 'string'
}
Response Structure
(dict) --
status (string) --
Returns the current state of the transformer job, either running , succeeded , or failed .
outputFiles (list) --
Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.
(dict) --
Specifies the details for the Amazon S3 file location that is being used with Amazon Web Services 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.
message (string) --
Returns an optional error message, which gets populated when the job is not run successfully.
Retrieves the details for the transformer specified by the transformer ID. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.
Lists the profiles associated with your Amazon Web Services account for your current or specified region. Profiles contain basic information about you and your business.
See also: AWS API Documentation
Request Syntax
client.list_profiles(
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 maximum number of profiles to return.
dict
Response Syntax
{
'profiles': [
{
'profileId': 'string',
'name': 'string',
'businessName': 'string',
'logging': 'ENABLED'|'DISABLED',
'logGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
profiles (list) --
Returns an array of ProfileSummary objects.
(dict) --
Contains the details for a profile. Profiles contain basic information about you and your business.
profileId (string) --
Returns the unique, system-generated identifier for the profile.
name (string) --
Returns the display name for profile.
businessName (string) --
Returns the name for the business associated with this profile.
logging (string) --
Specifies whether or not logging is enabled for this profile.
logGroupName (string) --
Returns the name of the logging group.
createdAt (datetime) --
Returns the timestamp for creation date and time of the profile.
modifiedAt (datetime) --
Returns the timestamp that identifies the most recent date and time that the profile was modified.
nextToken (string) --
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
list
[REQUIRED]
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
(string) --
None
Parses the input EDI (electronic data interchange) file.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
}
)
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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.
Creates a customer profile. You can have up to five customer profiles, each representing a distinct private network. Profiles contain basic information about you and your business.
See also: AWS API Documentation
Request Syntax
client.create_profile(
name='string',
email='string',
phone='string',
businessName='string',
logging='ENABLED'|'DISABLED',
clientToken='string',
tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the name of the profile.
string
Specifies the email address associated with this customer profile.
string
[REQUIRED]
Specifies the phone number associated with the profile.
string
[REQUIRED]
Specifies the name for the business associated with this profile.
string
[REQUIRED]
Specifies whether or not logging is enabled for this profile.
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',
'profileArn': 'string',
'name': 'string',
'businessName': 'string',
'phone': 'string',
'email': 'string',
'logging': 'ENABLED'|'DISABLED',
'logGroupName': 'string',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile.
profileArn (string) --
Returns an Amazon Resource Name (ARN) for the profile.
name (string) --
Returns the name of the profile, used to identify it.
businessName (string) --
Returns the name for the business associated with this profile.
phone (string) --
Returns the phone number associated with the profile.
email (string) --
Returns the email address associated with this customer profile.
logging (string) --
Returns whether or not logging is turned on for this profile.
logGroupName (string) --
Returns the name of the logging group.
createdAt (datetime) --
Returns a timestamp representing the time the profile was created.
Lists the partnerships associated with your Amazon Web Services account for your current or specified region. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
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',
],
'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. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
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) --
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.
Deletes the specified profile. Profiles contain basic information about you and your business.
See also: AWS API Documentation
Request Syntax
client.delete_profile(
profileId='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for the profile.
None
Lists the capabilities associated with your Amazon Web Services account for your current or specified region. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
See also: AWS API Documentation
Request Syntax
client.list_capabilities(
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 maximum number of capabilities to return.
dict
Response Syntax
{
'capabilities': [
{
'capabilityId': 'string',
'name': 'string',
'type': 'edi',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
capabilities (list) --
Returns one or more capabilities associated with this partnership.
(dict) --
Returns the capability summary details. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
capabilityId (string) --
Returns a system-assigned unique identifier for the capability.
name (string) --
The display name of the capability.
type (string) --
Returns the type of the capability. Currently, only edi is supported.
createdAt (datetime) --
Returns a timestamp for creation date and time of the capability.
modifiedAt (datetime) --
Returns a timestamp that identifies the most recent date and time that the capability was modified.
nextToken (string) --
When additional results are obtained from the command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional resources.
Lists the available transformers. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
transformers (list) --
Returns an array of one or more transformer objects.
For each transformer, a TransformerSummary object is returned. The TransformerSummary contains all the details for a specific transformer.
(dict) --
Contains the details for a transformer object. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
transformerId (string) --
Returns the system-assigned unique identifier for the transformer.
name (string) --
Returns the descriptive name for the transformer.
fileFormat (string) --
Returns that the currently supported file formats for EDI transformations are JSON and XML .
mappingTemplate (string) --
Returns the name of the mapping template for the transformer. This template is used to convert the input document into the correct set of objects.
status (string) --
Returns the state of the newly created transformer. The transformer can be either active or inactive . For the transformer to be used in a capability, its status must active .
ediType (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp indicating when the transformer was created. For example, 2023-07-20T19:58:44.624Z .
modifiedAt (datetime) --
Returns a timestamp representing the date and time for the most recent change for the transformer object.
nextToken (string) --
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.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2BI Data Interchange.
See also: AWS API Documentation
Request Syntax
client.start_transformer_job(
inputFile={
'bucketName': 'string',
'key': 'string'
},
outputLocation={
'bucketName': 'string',
'key': 'string'
},
transformerId='string',
clientToken='string'
)
dict
[REQUIRED]
Specifies the location of the input file for the transformation. The location consists of an Amazon S3 bucket and prefix.
bucketName (string) --
Specifies the name of the Amazon S3 bucket.
key (string) --
Specifies the Amazon S3 key for the file location.
dict
[REQUIRED]
Specifies the location of the output file for the transformation. The location consists of an Amazon S3 bucket and prefix.
bucketName (string) --
Specifies the name of the Amazon S3 bucket.
key (string) --
Specifies the Amazon S3 key for the file location.
string
[REQUIRED]
Specifies the system-assigned unique identifier for the transformer.
string
Reserved for future use.
This field is autopopulated if not provided.
dict
Response Syntax
{
'transformerJobId': 'string'
}
Response Structure
(dict) --
transformerJobId (string) --
Returns the unique, system-generated identifier for a transformer run.
Creates a partnership between a customer and a trading partner, based on the supplied parameters. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
See also: AWS API Documentation
Request Syntax
client.create_partnership(
profileId='string',
name='string',
email='string',
phone='string',
capabilities=[
'string',
],
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
Specifies a list of the capabilities associated with this partnership.
(string) --
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',
],
'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) --
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.
Updates the specified parameters for a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
sampleDocument='string'
)
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the transformer was modified.
Deletes the specified partnership. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
See also: AWS API Documentation
Request Syntax
client.delete_partnership(
partnershipId='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for a partnership.
None
Creates a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
sampleDocument='string',
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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'sampleDocument': 'string',
'createdAt': datetime(2015, 1, 1)
}
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.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
sampleDocument (string) --
Returns a sample EDI document that is used by a transformer as a guide for processing the EDI data.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
Retrieves the details for the profile specified by the profile ID. Profiles contain basic information about you and your business.
See also: AWS API Documentation
Request Syntax
client.get_profile(
profileId='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for the profile.
dict
Response Syntax
{
'profileId': 'string',
'profileArn': 'string',
'name': 'string',
'email': 'string',
'phone': 'string',
'businessName': 'string',
'logging': 'ENABLED'|'DISABLED',
'logGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile.
profileArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the profile, used to identify it.
email (string) --
Returns the email address associated with this customer profile.
phone (string) --
Returns the phone number associated with the profile.
businessName (string) --
Returns the name for the business associated with this profile.
logging (string) --
Returns whether or not logging is enabled for this profile.
logGroupName (string) --
Returns the name of the logging group.
createdAt (datetime) --
Returns a timestamp for creation date and time of the transformer.
modifiedAt (datetime) --
Returns a timestamp for last time the profile was modified.
Retrieves the details for the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'inputLocation': {
'bucketName': 'string',
'key': 'string'
},
'outputLocation': {
'bucketName': 'string',
'key': 'string'
},
'transformerId': 'string'
}
},
'instructionsDocuments': [
{
'bucketName': 'string',
'key': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
capabilityId (string) --
Returns a system-assigned unique identifier for the capability.
capabilityArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the capability, used to identify it.
type (string) --
Returns the type of the capability. Currently, only edi is supported.
configuration (dict) --
Returns a structure that contains the details for a capability.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: edi. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
edi (dict) --
An EDI (electronic data interchange) configuration object.
type (dict) --
Returns the type of the capability. Currently, only edi is supported.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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.
Maps the input file according to the provided template file.
See also: AWS API Documentation
Request Syntax
client.test_mapping(
inputFileContent='string',
mappingTemplate='string',
fileFormat='XML'|'JSON'
)
string
[REQUIRED]
Specify the EDI (electronic data interchange) file that is used as input for the transform.
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.
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
Deletes the specified transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.
See also: AWS API Documentation
Request Syntax
client.delete_transformer(
transformerId='string'
)
string
[REQUIRED]
Specifies the system-assigned unique identifier for the transformer.
None
Updates some of the parameters for a partnership between a customer and trading partner. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
See also: AWS API Documentation
Request Syntax
client.update_partnership(
partnershipId='string',
name='string',
capabilities=[
'string',
]
)
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
Response Syntax
{
'profileId': 'string',
'partnershipId': 'string',
'partnershipArn': 'string',
'name': 'string',
'email': 'string',
'phone': 'string',
'capabilities': [
'string',
],
'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) --
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.
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are capability, partnership, profile, transformers and other entities.
There is no response returned from this call.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
list
[REQUIRED]
Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
(dict) --
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
Key (string) -- [REQUIRED]
Specifies the name assigned to the tag that you create.
Value (string) -- [REQUIRED]
Contains one or more values that you assigned to the key name that you create.
None
Deletes the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
See also: AWS API Documentation
Request Syntax
client.delete_capability(
capabilityId='string'
)
string
[REQUIRED]
Specifies a system-assigned unique identifier for the capability.
None
Updates the specified parameters for a profile. Profiles contain basic information about you and your business.
See also: AWS API Documentation
Request Syntax
client.update_profile(
profileId='string',
name='string',
email='string',
phone='string',
businessName='string'
)
string
[REQUIRED]
Specifies the unique, system-generated identifier for the profile.
string
The name of the profile, used to identify it.
string
Specifies the email address associated with this customer profile.
string
Specifies the phone number associated with the profile.
string
Specifies the name for the business associated with this profile.
dict
Response Syntax
{
'profileId': 'string',
'profileArn': 'string',
'name': 'string',
'email': 'string',
'phone': 'string',
'businessName': 'string',
'logging': 'ENABLED'|'DISABLED',
'logGroupName': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
profileId (string) --
Returns the unique, system-generated identifier for the profile.
profileArn (string) --
Returns an Amazon Resource Name (ARN) for the profile.
name (string) --
Returns the name of the profile.
email (string) --
Returns the email address associated with this customer profile.
phone (string) --
Returns the phone number associated with the profile.
businessName (string) --
Returns the name for the business associated with this profile.
logging (string) --
Specifies whether or not logging is enabled for this profile.
logGroupName (string) --
Returns the name of the logging group.
createdAt (datetime) --
Returns a timestamp for creation date and time of the profile.
modifiedAt (datetime) --
Returns a timestamp for last time the profile was modified.
Retrieves the details for a partnership, based on the partner and profile IDs specified. Partnerships link trading partners with your profile and a specific transformer, so that the EDI (electronic data interchange) documents that they upload to Amazon S3 can be processed according to their specifications.
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',
],
'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) --
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.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a capability, partnership, profile, or transformer.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
Returns the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.
(dict) --
Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to capabilities, partnerships, profiles and transformers. A tag key can take more than one value. For example, to group capabilities for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
Key (string) --
Specifies the name assigned to the tag that you create.
Value (string) --
Contains one or more values that you assigned to the key name that you create.
Updates some of the parameters for a capability, based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'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.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: edi.
edi (dict) --
An EDI (electronic data interchange) configuration object.
type (dict) -- [REQUIRED]
Returns the type of the capability. Currently, only edi is supported.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: x12Details.
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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_214'|'X12_215'|'X12_310'|'X12_315'|'X12_322'|'X12_404'|'X12_410'|'X12_820'|'X12_824'|'X12_830'|'X12_846'|'X12_850'|'X12_852'|'X12_855'|'X12_856'|'X12_860'|'X12_861'|'X12_864'|'X12_940'|'X12_990'|'X12_997',
'version': 'VERSION_4010'|'VERSION_4030'|'VERSION_5010'
}
},
'inputLocation': {
'bucketName': 'string',
'key': 'string'
},
'outputLocation': {
'bucketName': 'string',
'key': 'string'
},
'transformerId': 'string'
}
},
'instructionsDocuments': [
{
'bucketName': 'string',
'key': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
capabilityId (string) --
Returns a system-assigned unique identifier for the capability.
capabilityArn (string) --
Returns an Amazon Resource Name (ARN) for a specific Amazon Web Services resource, such as a capability, partnership, profile, or transformer.
name (string) --
Returns the name of the capability, used to identify it.
type (string) --
Returns the type of the capability. Currently, only edi is supported.
configuration (dict) --
Returns a structure that contains the details for a capability.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: edi. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
edi (dict) --
An EDI (electronic data interchange) configuration object.
type (dict) --
Returns the type of the capability. Currently, only edi is supported.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: x12Details. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
x12Details (dict) --
Returns the details for the EDI standard that is being used for the transformer. Currently, only X12 is supported. X12 is a set of standards and corresponding messages that define specific business documents.
transactionSet (string) --
Returns an enumerated type where each value identifies an X12 transaction set. Transaction sets are maintained by the X12 Accredited Standards Committee.
version (string) --
Returns the version to use for the specified X12 transaction set. Supported versions are 4010 , 4030 , and 5010 .
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.