Amazon QLDB Session Update: Documentation updates for Amazon QLDB Session

Author: AWS

.changes/next-release/feature-AmazonQLDBSession-dcc08bf.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon QLDB Session",
+    "description": "Documentation updates for Amazon QLDB Session"
+}

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

@@ -29,7 +29,7 @@
         {"shape":"RateExceededException"},
         {"shape":"LimitExceededException"}
       ],
-      "documentation":"<p>Sends a command to an Amazon QLDB ledger.</p>"
+      "documentation":"<p>Sends a command to an Amazon QLDB ledger.</p> <note> <p>Instead of interacting directly with this API, we recommend that you use the Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.</p> <ul> <li> <p>If you are working with an AWS SDK, use the QLDB Driver. The driver provides a high-level abstraction layer above this <code>qldbsession</code> data plane and manages <code>SendCommand</code> API calls for you. For information and a list of supported programming languages, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html\">Getting started with the driver</a> in the <i>Amazon QLDB Developer Guide</i>.</p> </li> <li> <p>If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB Shell. The shell is a command line interface that uses the QLDB Driver to interact with a ledger. For information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html\">Accessing Amazon QLDB using the QLDB Shell</a>.</p> </li> </ul> </note>"
     }
   },
   "shapes":{
@@ -64,7 +64,7 @@
       "members":{
         "TransactionId":{
           "shape":"TransactionId",
-          "documentation":"<p>Specifies the transaction id of the transaction to commit.</p>"
+          "documentation":"<p>Specifies the transaction ID of the transaction to commit.</p>"
         },
         "CommitDigest":{
           "shape":"CommitDigest",
@@ -78,7 +78,7 @@
       "members":{
         "TransactionId":{
           "shape":"TransactionId",
-          "documentation":"<p>The transaction id of the committed transaction.</p>"
+          "documentation":"<p>The transaction ID of the committed transaction.</p>"
         },
         "CommitDigest":{
           "shape":"CommitDigest",
@@ -110,7 +110,7 @@
       "members":{
         "TransactionId":{
           "shape":"TransactionId",
-          "documentation":"<p>Specifies the transaction id of the request.</p>"
+          "documentation":"<p>Specifies the transaction ID of the request.</p>"
         },
         "Statement":{
           "shape":"Statement",
@@ -142,7 +142,7 @@
       "members":{
         "TransactionId":{
           "shape":"TransactionId",
-          "documentation":"<p>Specifies the transaction id of the page to be fetched.</p>"
+          "documentation":"<p>Specifies the transaction ID of the page to be fetched.</p>"
         },
         "NextPageToken":{
           "shape":"PageToken",
@@ -167,7 +167,7 @@
         "Message":{"shape":"ErrorMessage"},
         "Code":{"shape":"ErrorCode"}
       },
-      "documentation":"<p>Returned if the session doesn't exist anymore because it timed-out or expired.</p>",
+      "documentation":"<p>Returned if the session doesn't exist anymore because it timed out or expired.</p>",
       "exception":true
     },
     "IonBinary":{
@@ -199,7 +199,7 @@
       "members":{
         "Message":{"shape":"ErrorMessage"}
       },
-      "documentation":"<p>Returned when a transaction cannot be written to the journal due to a failure in the verification phase of Optimistic Concurrency Control.</p>",
+      "documentation":"<p>Returned when a transaction cannot be written to the journal due to a failure in the verification phase of <i>optimistic concurrency control</i> (OCC).</p>",
       "exception":true
     },
     "Page":{
@@ -315,7 +315,7 @@
           "documentation":"<p>The name of the ledger to start a new session against.</p>"
         }
       },
-      "documentation":"<p>Specifies a request to start a a new session.</p>"
+      "documentation":"<p>Specifies a request to start a new session.</p>"
     },
     "StartSessionResult":{
       "type":"structure",
@@ -338,7 +338,7 @@
       "members":{
         "TransactionId":{
           "shape":"TransactionId",
-          "documentation":"<p>The transaction id of the started transaction.</p>"
+          "documentation":"<p>The transaction ID of the started transaction.</p>"
         }
       },
       "documentation":"<p>Contains the details of the started transaction.</p>"
@@ -363,19 +363,19 @@
       "members":{
         "IonBinary":{
           "shape":"IonBinary",
-          "documentation":"<p>An Amazon Ion binary value contained in a <code>ValueHolder</code> structure. </p>"
+          "documentation":"<p>An Amazon Ion binary value contained in a <code>ValueHolder</code> structure.</p>"
         },
         "IonText":{
           "shape":"IonText",
-          "documentation":"<p>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure. </p>"
+          "documentation":"<p>An Amazon Ion plaintext value contained in a <code>ValueHolder</code> structure.</p>"
         }
       },
-      "documentation":"<p>A structure that can contains values in multiple encoding formats.</p>"
+      "documentation":"<p>A structure that can contain an Amazon Ion value in multiple encoding formats.</p>"
     },
     "ValueHolders":{
       "type":"list",
       "member":{"shape":"ValueHolder"}
     }
   },
-  "documentation":"<p>The transactional data APIs for Amazon QLDB</p>"
+  "documentation":"<p>The transactional data APIs for Amazon QLDB</p> <note> <p>Instead of interacting directly with this API, we recommend that you use the Amazon QLDB Driver or the QLDB Shell to execute data transactions on a ledger.</p> <ul> <li> <p>If you are working with an AWS SDK, use the QLDB Driver. The driver provides a high-level abstraction layer above this <code>qldbsession</code> data plane and manages <code>SendCommand</code> API calls for you. For information and a list of supported programming languages, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html\">Getting started with the driver</a> in the <i>Amazon QLDB Developer Guide</i>.</p> </li> <li> <p>If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB Shell. The shell is a command line interface that uses the QLDB Driver to interact with a ledger. For information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html\">Accessing Amazon QLDB using the QLDB Shell</a>.</p> </li> </ul> </note>"
 }