View Source AWS.B2bi (aws-elixir v1.0.4)
This is the Amazon Web Services B2B Data Interchange API Reference.
It provides descriptions, API request parameters, and the XML response for each of the B2BI API actions.
B2BI enables automated exchange of EDI (electronic data interchange) based business-critical transactions at cloud scale, with elasticity and pay-as-you-go pricing. Businesses use EDI documents to exchange transactional data with trading partners, such as suppliers and end customers, using standardized formats such as X12.
Rather than actually running a command, you can use the
--generate-cli-skeleton parameter with any API call to generate and display
a parameter template. You can then use the generated template to customize and
use as input
on a later command. For details, see Generate and use a parameter skeleton file.
Link to this section Summary
Functions
Instantiates a capability based on the specified parameters.
Creates a partnership between a customer and a trading partner, based on the supplied parameters.
Creates a customer profile.
Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
Creates a transformer.
Deletes the specified capability.
Deletes the specified partnership.
Deletes the specified profile.
Deletes the specified transformer.
Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.
Retrieves the details for the specified capability.
Retrieves the details for a partnership, based on the partner and profile IDs specified.
Retrieves the details for the profile specified by the profile ID.
Retrieves the details for the transformer specified by the transformer ID.
Returns the details of the transformer run, based on the Transformer job ID.
Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
Lists the profiles associated with your Amazon Web Services account for your current or specified region.
Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify.
Lists the available transformers.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
This operation mimics the latter half of a typical Outbound EDI request.
Maps the input file according to the provided template file.
Parses the input EDI (electronic data interchange) file.
Detaches a key-value pair from the specified resource, as identified by its Amazon Resource Name (ARN).
Updates some of the parameters for a capability, based on the specified parameters.
Updates some of the parameters for a partnership between a customer and trading partner.
Updates the specified parameters for a profile.
Updates the specified parameters for a transformer.
Link to this section Functions
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.
Creates a partnership between a customer and a trading partner, based on the supplied parameters.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Creates a customer profile.
You can have up to five customer profiles, each representing a distinct private network. A profile is the mechanism used to create the concept of a private network.
Amazon Web Services B2B Data Interchange uses a mapping template in JSONata or XSLT format to transform a customer input file into a JSON or XML file that can be converted to EDI.
If you provide a sample EDI file with the same structure as the EDI files that you wish to generate, then the service can generate a mapping template. The starter template contains placeholder values which you can replace with JSONata or XSLT expressions to take data from your input file and insert it into the JSON or XML file that is used to generate the EDI.
If you do not provide a sample EDI file, then the service can generate a mapping
template based on the EDI settings in the templateDetails parameter.
Currently, we only support generating a template that can generate the input to produce an Outbound X12 EDI file.
Creates a transformer.
Amazon Web Services B2B Data Interchange currently supports two scenarios:
*
Inbound EDI: the Amazon Web Services customer receives an EDI file from their trading partner. Amazon Web Services B2B Data Interchange converts this EDI file into a JSON or XML file with a service-defined structure. A mapping template provided by the customer, in JSONata or XSLT format, is optionally applied to this file to produce a JSON or XML file with the structure the customer requires.
*
Outbound EDI: the Amazon Web Services customer has a JSON or XML file containing data that they wish to use in an EDI file. A mapping template, provided by the customer (in either JSONata or XSLT format) is applied to this file to generate a JSON or XML file in the service-defined structure. This file is then converted to an EDI file.
The following fields are provided for backwards compatibility only:
fileFormat,
mappingTemplate, ediType, and sampleDocument.
Use the mapping data type in place of mappingTemplate and fileFormat
Use the sampleDocuments data type in place of sampleDocument
Use either the inputConversion or outputConversion in place of ediType
Deletes the specified capability.
A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Deletes the specified partnership.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Deletes the specified profile.
A profile is the mechanism used to create the concept of a private network.
Deletes the specified transformer.
A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
Takes sample input and output documents and uses Amazon Bedrock to generate a mapping automatically.
Depending on the accuracy and other factors, you can then edit the mapping for your needs.
Before you can use the AI-assisted feature for Amazon Web Services B2B Data Interchange you must enable models in Amazon Bedrock. For details, see AI-assisted template mapping prerequisites in the Amazon Web Services B2B Data Interchange User guide.
Retrieves the details for the specified capability.
A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Retrieves the details for a partnership, based on the partner and profile IDs specified.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Retrieves the details for the profile specified by the profile ID.
A profile is the mechanism used to create the concept of a private network.
Retrieves the details for the transformer specified by the transformer ID.
A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
Returns the details of the transformer run, based on the Transformer job ID.
Lists the capabilities associated with your Amazon Web Services account for your current or specified region.
A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.
Lists the partnerships associated with your Amazon Web Services account for your current or specified region.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Lists the profiles associated with your Amazon Web Services account for your current or specified region.
A profile is the mechanism used to create the concept of a private network.
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.
Lists the available transformers.
A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.
Runs a job, using a transformer, to parse input EDI (electronic data interchange) file into the output structures used by Amazon Web Services B2B Data Interchange.
If you only want to transform EDI (electronic data interchange) documents, you
don't need to create profiles, partnerships or capabilities. Just
create and configure a transformer, and then run the StartTransformerJob API
to process your files.
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.
This operation mimics the latter half of a typical Outbound EDI request.
It takes an input JSON/XML in the B2Bi shape as input, converts it to an X12 EDI string, and return that string.
Maps the input file according to the provided template file.
The API call downloads the file contents from the Amazon S3 location, and passes
the contents in as a string, to the inputFileContent parameter.
Parses the input EDI (electronic data interchange) file.
The input file has a file size limit of 250 KB.
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.
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.
Updates some of the parameters for a partnership between a customer and trading partner.
A partnership represents the connection between you and your trading partner. It ties together a profile and one or more trading capabilities.
Updates the specified parameters for a profile.
A profile is the mechanism used to create the concept of a private network.
Updates the specified parameters for a transformer.
A transformer can take an EDI file as input and transform it into a JSON-or XML-formatted document. Alternatively, a transformer can take a JSON-or XML-formatted document as input and transform it into an EDI file.