View Source AWS.B2bi (aws-elixir v1.0.0)
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.
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.
Creates a transformer.
Deletes the specified capability.
Deletes the specified partnership.
Deletes the specified profile.
Deletes the specified transformer.
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 B2BI Data Interchange.
Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN).
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.
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.
Creates a transformer.
A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.
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 describes how to process the incoming EDI documents and extract the necessary information to the output file.
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 describes how to process the incoming EDI documents and extract the necessary information to the output 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 describes how to process the incoming EDI documents and extract the necessary information to the output file.
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.
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.
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 describes how to process the incoming EDI documents and extract the necessary information to the output file.