AWS.B2bi — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.B2bi

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Note: 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.

Sending a Request Using B2bi

var b2bi = new AWS.B2bi();
b2bi.createCapability(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the B2bi object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var b2bi = new AWS.B2bi({apiVersion: '2022-06-23'});

You can also set the API version globally in AWS.config.apiVersions using the b2bi service identifier:

AWS.config.apiVersions = {
  b2bi: '2022-06-23',
  // other service API versions
};

var b2bi = new AWS.B2bi();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.B2bi(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createCapability(params = {}, callback) ⇒ AWS.Request

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.

createPartnership(params = {}, callback) ⇒ AWS.Request

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.

createProfile(params = {}, callback) ⇒ AWS.Request

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.

createTransformer(params = {}, callback) ⇒ AWS.Request

Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

deleteCapability(params = {}, callback) ⇒ AWS.Request

Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

deletePartnership(params = {}, callback) ⇒ AWS.Request

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.

deleteProfile(params = {}, callback) ⇒ AWS.Request

Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.

deleteTransformer(params = {}, callback) ⇒ AWS.Request

Deletes the specified transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

getCapability(params = {}, callback) ⇒ AWS.Request

Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.

getPartnership(params = {}, callback) ⇒ AWS.Request

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.

getProfile(params = {}, callback) ⇒ AWS.Request

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.

getTransformer(params = {}, callback) ⇒ AWS.Request

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.

getTransformerJob(params = {}, callback) ⇒ AWS.Request

Returns the details of the transformer run, based on the Transformer job ID.

listCapabilities(params = {}, callback) ⇒ AWS.Request

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.

listPartnerships(params = {}, callback) ⇒ AWS.Request

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.

listProfiles(params = {}, callback) ⇒ AWS.Request

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.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

listTransformers(params = {}, callback) ⇒ AWS.Request

Lists the available transformers. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.

startTransformerJob(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

testMapping(params = {}, callback) ⇒ AWS.Request

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.

testParsing(params = {}, callback) ⇒ AWS.Request

Parses the input EDI (electronic data interchange) file. The input file has a file size limit of 250 KB.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

updateCapability(params = {}, callback) ⇒ AWS.Request

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.

updatePartnership(params = {}, callback) ⇒ AWS.Request

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.

updateProfile(params = {}, callback) ⇒ AWS.Request

Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.

updateTransformer(params = {}, callback) ⇒ AWS.Request

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.