AWS B2B Data Interchange Update: Documentation updates for AWS B2B Data Interchange

Author: AWS

.changes/next-release/feature-AWSB2BDataInterchange-ad3de8a.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS B2B Data Interchange",
+    "contributor": "",
+    "description": "Documentation updates for AWS B2B Data Interchange"
+}

services/b2bi/src/main/resources/codegen-resources/service-2.json

@@ -31,7 +31,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Instantiates a capability based on the specified parameters. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "CreatePartnership":{
@@ -51,7 +51,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "CreateProfile":{
@@ -71,7 +71,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "CreateTransformer":{
@@ -91,7 +91,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Creates a transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>",
+      "documentation":"<p>Creates a transformer. A transformer describes how to process the incoming EDI documents and extract the necessary information to the output file.</p>",
       "idempotent":true
     },
     "DeleteCapability":{
@@ -109,7 +109,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Deletes the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>",
+      "documentation":"<p>Deletes the specified capability. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>",
       "idempotent":true
     },
     "DeletePartnership":{
@@ -127,7 +127,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "DeleteProfile":{
@@ -145,7 +145,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Deletes the specified profile. Profiles contain basic information about you and your business.</p>",
+      "documentation":"<p>Deletes the specified profile. A profile is the mechanism used to create the concept of a private network.</p>",
       "idempotent":true
     },
     "DeleteTransformer":{
@@ -163,7 +163,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Deletes the specified transformer. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "GetCapability":{
@@ -181,7 +181,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Retrieves the details for the specified capability. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>"
+      "documentation":"<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>"
     },
     "GetPartnership":{
       "name":"GetPartnership",
@@ -198,7 +198,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "GetProfile":{
       "name":"GetProfile",
@@ -215,7 +215,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Retrieves the details for the profile specified by the profile ID. Profiles contain basic information about you and your business.</p>"
+      "documentation":"<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>"
     },
     "GetTransformer":{
       "name":"GetTransformer",
@@ -232,7 +232,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "GetTransformerJob":{
       "name":"GetTransformerJob",
@@ -259,7 +259,7 @@
       },
       "input":{"shape":"ListCapabilitiesRequest"},
       "output":{"shape":"ListCapabilitiesResponse"},
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "ListPartnerships":{
       "name":"ListPartnerships",
@@ -276,7 +276,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "ListProfiles":{
       "name":"ListProfiles",
@@ -286,7 +286,7 @@
       },
       "input":{"shape":"ListProfilesRequest"},
       "output":{"shape":"ListProfilesResponse"},
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "ListTagsForResource":{
       "name":"ListTagsForResource",
@@ -310,7 +310,7 @@
       },
       "input":{"shape":"ListTransformersRequest"},
       "output":{"shape":"ListTransformersResponse"},
-      "documentation":"<p>Lists the available transformers. Transformers describe how to process the incoming EDI (electronic data interchange) documents, and extract the necessary information.</p>"
+      "documentation":"<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>"
     },
     "StartTransformerJob":{
       "name":"StartTransformerJob",
@@ -327,7 +327,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "TagResource":{
@@ -359,7 +359,7 @@
         {"shape":"ResourceNotFoundException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Maps the input file according to the provided template file.</p>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "TestParsing":{
@@ -411,7 +411,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<p>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.</p>",
       "idempotent":true
     },
     "UpdatePartnership":{
@@ -431,7 +431,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     },
     "UpdateProfile":{
@@ -451,7 +451,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Updates the specified parameters for a profile. Profiles contain basic information about you and your business.</p>",
+      "documentation":"<p>Updates the specified parameters for a profile. A profile is the mechanism used to create the concept of a private network.</p>",
       "idempotent":true
     },
     "UpdateTransformer":{
@@ -471,7 +471,7 @@
         {"shape":"ServiceQuotaExceededException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<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>",
+      "documentation":"<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>",
       "idempotent":true
     }
   },
@@ -508,7 +508,7 @@
           "documentation":"<p>An EDI (electronic data interchange) configuration object.</p>"
         }
       },
-      "documentation":"<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>",
+      "documentation":"<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>",
       "union":true
     },
     "CapabilityId":{
@@ -556,7 +556,7 @@
           "documentation":"<p>Returns a timestamp that identifies the most recent date and time that the capability was modified.</p>"
         }
       },
-      "documentation":"<p>Returns the capability summary details. Capabilities contain the information necessary to process incoming EDI (electronic data interchange) documents.</p>"
+      "documentation":"<p>Returns the capability summary details. A trading capability contains the information required to transform incoming EDI documents into JSON or XML outputs.</p>"
     },
     "CapabilityType":{
       "type":"string",
@@ -1543,7 +1543,7 @@
           "documentation":"<p>Returns a timestamp that identifies the most recent date and time that the partnership was modified.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "Phone":{
       "type":"string",
@@ -1605,7 +1605,7 @@
           "documentation":"<p>Returns the timestamp that identifies the most recent date and time that the profile was modified.</p>"
         }
       },
-      "documentation":"<p>Contains the details for a profile. Profiles contain basic information about you and your business.</p>"
+      "documentation":"<p>Contains the details for a profile. A profile is the mechanism used to create the concept of a private network.</p>"
     },
     "ResourceArn":{
       "type":"string",
@@ -1785,7 +1785,7 @@
       "members":{
         "inputFileContent":{
           "shape":"TestMappingInputFileContent",
-          "documentation":"<p>Specify the EDI (electronic data interchange) file that is used as input for the transform.</p>"
+          "documentation":"<p>Specify the contents of the EDI (electronic data interchange) XML or JSON file that is used as input for the transform.</p>"
         },
         "mappingTemplate":{
           "shape":"MappingTemplate",
@@ -1944,7 +1944,7 @@
           "documentation":"<p>Returns a timestamp representing the date and time for the most recent change for the transformer object.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "UntagResourceRequest":{
       "type":"structure",
@@ -2289,7 +2289,7 @@
           "documentation":"<p>Returns the version to use for the specified X12 transaction set. Supported versions are <code>4010</code>, <code>4030</code>, and <code>5010</code>.</p>"
         }
       },
-      "documentation":"<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>"
+      "documentation":"<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>"
     },
     "X12TransactionSet":{
       "type":"string",