docs(client-b2bi): Documentation updates for AWS B2B Data Interchange

Author: awstools

clients/client-b2bi/src/commands/CreateCapabilityCommand.ts

@@ -37,7 +37,7 @@ export interface CreateCapabilityCommandOutput extends CreateCapabilityResponse,
 
 /**
  * @public
- * <p>Instantiates a capability based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/CreatePartnershipCommand.ts

@@ -42,7 +42,8 @@ export interface CreatePartnershipCommandOutput extends CreatePartnershipRespons
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/CreateProfileCommand.ts

@@ -42,7 +42,8 @@ export interface CreateProfileCommandOutput extends CreateProfileResponse, __Met
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/CreateTransformerCommand.ts

@@ -37,7 +37,9 @@ export interface CreateTransformerCommandOutput extends CreateTransformerRespons
 
 /**
  * @public
- * <p>Creates a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * <p>Creates a transformer. A transformer
+ *    describes how to process the incoming EDI documents and extract the necessary
+ *    information to the output file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/DeleteCapabilityCommand.ts

@@ -37,7 +37,7 @@ export interface DeleteCapabilityCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Deletes the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
+ * <p>Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/DeletePartnershipCommand.ts

@@ -37,7 +37,8 @@ export interface DeletePartnershipCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/DeleteProfileCommand.ts

@@ -37,7 +37,8 @@ export interface DeleteProfileCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Deletes the specified profile. Profiles contain basic information about you and your business.</p>
+ * <p>Deletes the specified profile. A profile is the mechanism used to create the concept of
+ *    a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/DeleteTransformerCommand.ts

@@ -37,7 +37,9 @@ export interface DeleteTransformerCommandOutput extends __MetadataBearer {}
 
 /**
  * @public
- * <p>Deletes the specified transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * <p>Deletes the specified transformer. A transformer
+ *    describes how to process the incoming EDI documents and extract the necessary
+ *    information to the output file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/GetCapabilityCommand.ts

@@ -37,7 +37,7 @@ export interface GetCapabilityCommandOutput extends GetCapabilityResponse, __Met
 
 /**
  * @public
- * <p>Retrieves the details for the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
+ * <p>Retrieves the details for the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/GetPartnershipCommand.ts

@@ -41,7 +41,8 @@ export interface GetPartnershipCommandOutput extends GetPartnershipResponse, __M
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/GetProfileCommand.ts

@@ -37,7 +37,8 @@ export interface GetProfileCommandOutput extends GetProfileResponse, __MetadataB
 
 /**
  * @public
- * <p>Retrieves the details for the profile specified by the profile ID. Profiles contain basic information about you and your business.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/GetTransformerCommand.ts

@@ -37,7 +37,9 @@ export interface GetTransformerCommandOutput extends GetTransformerResponse, __M
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/ListCapabilitiesCommand.ts

@@ -37,7 +37,7 @@ export interface ListCapabilitiesCommandOutput extends ListCapabilitiesResponse,
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/ListPartnershipsCommand.ts

@@ -37,7 +37,8 @@ export interface ListPartnershipsCommandOutput extends ListPartnershipsResponse,
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/ListProfilesCommand.ts

@@ -37,7 +37,8 @@ export interface ListProfilesCommandOutput extends ListProfilesResponse, __Metad
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/ListTransformersCommand.ts

@@ -37,7 +37,9 @@ export interface ListTransformersCommandOutput extends ListTransformersResponse,
 
 /**
  * @public
- * <p>Lists the available transformers. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * <p>Lists the available transformers. A transformer
+ *    describes how to process the incoming EDI documents and extract the necessary
+ *    information to the output file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/StartTransformerJobCommand.ts

@@ -38,6 +38,8 @@ export interface StartTransformerJobCommandOutput extends StartTransformerJobRes
 /**
  * @public
  * <p>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.</p>
+ *          <p>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 <code>StartTransformerJob</code> API to process your files.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/TestMappingCommand.ts

@@ -37,7 +37,7 @@ export interface TestMappingCommandOutput extends TestMappingResponse, __Metadat
 
 /**
  * @public
- * <p>Maps the input file according to the provided template file.</p>
+ * <p>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 <code>inputFileContent</code> parameter.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/UpdateCapabilityCommand.ts

@@ -38,7 +38,7 @@ export interface UpdateCapabilityCommandOutput extends UpdateCapabilityResponse,
 /**
  * @public
  * <p>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.</p>
+ *       A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/UpdatePartnershipCommand.ts

@@ -41,7 +41,8 @@ export interface UpdatePartnershipCommandOutput extends UpdatePartnershipRespons
 
 /**
  * @public
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/UpdateProfileCommand.ts

@@ -42,7 +42,8 @@ export interface UpdateProfileCommandOutput extends UpdateProfileResponse, __Met
 
 /**
  * @public
- * <p>Updates the specified parameters for a profile. Profiles contain basic information about you and your business.</p>
+ * <p>Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of
+ *    a private network.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/commands/UpdateTransformerCommand.ts

@@ -37,7 +37,9 @@ export interface UpdateTransformerCommandOutput extends UpdateTransformerRespons
 
 /**
  * @public
- * <p>Updates the specified parameters for a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-b2bi/src/models/models_0.ts

@@ -117,6 +117,9 @@ export type X12Version = (typeof X12Version)[keyof typeof X12Version];
 /**
  * @public
  * <p>A structure that contains the X12 transaction set and version. The X12 structure is used when the system transforms an EDI (electronic data interchange) file.</p>
+ *          <note>
+ *             <p>If an EDI input file contains more than one transaction, each transaction must have the same transaction set and version, for example 214/4010. If not, the transformer cannot parse the file.</p>
+ *          </note>
  */
 export interface X12Details {
   /**
@@ -202,7 +205,7 @@ export interface EdiConfiguration {
 
 /**
  * @public
- * <p>A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
+ * <p>A capability object. Currently, only EDI (electronic data interchange) capabilities are supported. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  */
 export type CapabilityConfiguration = CapabilityConfiguration.EdiMember | CapabilityConfiguration.$UnknownMember;
 
@@ -600,7 +603,7 @@ export interface ListCapabilitiesRequest {
 
 /**
  * @public
- * <p>Returns the capability summary details. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>
+ * <p>Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>
  */
 export interface CapabilitySummary {
   /**
@@ -1034,7 +1037,8 @@ export interface ListPartnershipsRequest {
 
 /**
  * @public
- * <p>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.</p>
+ * <p>A structure that contains the details for a partnership. A partnership represents the connection between you and your trading partner. It ties
+ *    together a profile and one or more trading capabilities.</p>
  */
 export interface PartnershipSummary {
   /**
@@ -1413,7 +1417,8 @@ export interface ListProfilesRequest {
 
 /**
  * @public
- * <p>Contains the details for a profile. Profiles contain basic information about you and your business.</p>
+ * <p>Contains the details for a profile. A profile is the mechanism used to create the concept of
+ *    a private network.</p>
  */
 export interface ProfileSummary {
   /**
@@ -1654,7 +1659,7 @@ export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
 export interface TestMappingRequest {
   /**
    * @public
-   * <p>Specify the EDI (electronic data interchange) file that is used as input for the transform.</p>
+   * <p>Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.</p>
    */
   inputFileContent: string | undefined;
 
@@ -1951,7 +1956,9 @@ export interface ListTransformersRequest {
 
 /**
  * @public
- * <p>Contains the details for a transformer object. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>
+ * <p>Contains the details for a transformer object. A transformer
+ *    describes how to process the incoming EDI documents and extract the necessary
+ *    information to the output file.</p>
  */
 export interface TransformerSummary {
   /**