Amazon Elastic Block Store Update: Documentation updates for EBS direct APIs.

Author: AWS

.changes/next-release/feature-AmazonElasticBlockStore-71037a9.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon Elastic Block Store",
+    "description": "Documentation updates for EBS direct APIs."
+}

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

@@ -96,11 +96,11 @@
         },
         "FirstBlockToken":{
           "shape":"BlockToken",
-          "documentation":"<p>The block token for the block index of the <code>first snapshot ID</code> specified in the <code>list changed blocks</code> operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.</p>"
+          "documentation":"<p>The block token for the block index of the <code>FirstSnapshotId</code> specified in the <code>ListChangedBlocks</code> operation. This value is absent if the first snapshot does not have the changed block that is on the second snapshot.</p>"
         },
         "SecondBlockToken":{
           "shape":"BlockToken",
-          "documentation":"<p>The block token for the block index of the <code>second snapshot ID</code> specified in the <code>list changed blocks</code> operation.</p>"
+          "documentation":"<p>The block token for the block index of the <code>SecondSnapshotId</code> specified in the <code>ListChangedBlocks</code> operation.</p>"
         }
       },
       "documentation":"<p>A block of data in an Amazon Elastic Block Store snapshot that is different from another snapshot of the same volume/snapshot lineage.</p>",
@@ -140,13 +140,13 @@
         },
         "BlockIndex":{
           "shape":"BlockIndex",
-          "documentation":"<p>The block index of the block from which to get data.</p> <p>Obtain the <code>block index</code> by running the <code>list changed blocks</code> or <code>list snapshot blocks</code> operations.</p>",
+          "documentation":"<p>The block index of the block from which to get data.</p> <p>Obtain the <code>BlockIndex</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
           "location":"uri",
           "locationName":"blockIndex"
         },
         "BlockToken":{
           "shape":"BlockToken",
-          "documentation":"<p>The block token of the block from which to get data.</p> <p>Obtain the <code>block token</code> by running the <code>list changed blocks</code> or <code>list snapshot blocks</code> operations.</p>",
+          "documentation":"<p>The block token of the block from which to get data.</p> <p>Obtain the <code>BlockToken</code> by running the <code>ListChangedBlocks</code> or <code>ListSnapshotBlocks</code> operations.</p>",
           "location":"querystring",
           "locationName":"blockToken"
         }
@@ -167,7 +167,7 @@
         },
         "Checksum":{
           "shape":"Checksum",
-          "documentation":"<p>The checksum generated for the block.</p>",
+          "documentation":"<p>The checksum generated for the block, which is Base64 encoded.</p>",
           "location":"header",
           "locationName":"x-amz-Checksum"
         },
@@ -186,13 +186,13 @@
       "members":{
         "FirstSnapshotId":{
           "shape":"SnapshotId",
-          "documentation":"<p>The ID of the first snapshot to use for the comparison.</p>",
+          "documentation":"<p>The ID of the first snapshot to use for the comparison.</p> <important> <p>The <code>FirstSnapshotID</code> parameter must be specified with a <code>SecondSnapshotId</code> parameter; otherwise, an error occurs.</p> </important>",
           "location":"querystring",
           "locationName":"firstSnapshotId"
         },
         "SecondSnapshotId":{
           "shape":"SnapshotId",
-          "documentation":"<p>The ID of the second snapshot to use for the comparison.</p>",
+          "documentation":"<p>The ID of the second snapshot to use for the comparison.</p> <important> <p>The <code>SecondSnapshotId</code> parameter must be specified with a <code>FirstSnapshotID</code> parameter; otherwise, an error occurs.</p> </important>",
           "location":"uri",
           "locationName":"secondSnapshotId"
         },
@@ -225,7 +225,7 @@
         },
         "ExpiryTime":{
           "shape":"TimeStamp",
-          "documentation":"<p>The time when the <code>block token</code> expires.</p>"
+          "documentation":"<p>The time when the <code>BlockToken</code> expires.</p>"
         },
         "VolumeSize":{
           "shape":"VolumeSize",
@@ -280,7 +280,7 @@
         },
         "ExpiryTime":{
           "shape":"TimeStamp",
-          "documentation":"<p>The time when the <code>block token</code> expires.</p>"
+          "documentation":"<p>The time when the <code>BlockToken</code> expires.</p>"
         },
         "VolumeSize":{
           "shape":"VolumeSize",
@@ -347,5 +347,5 @@
     },
     "VolumeSize":{"type":"long"}
   },
-  "documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs makes it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots, and then use EC2 instances to compare the differences.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a>. For more information about how to use the EBS direct APIs, see the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshots.html\">EBS direct APIs User Guide</a>. To view the currently supported AWS Regions and endpoints for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#ebs_region\">AWS Service Endpoints</a> in the <i>AWS General Reference</i>.</p>"
+  "documentation":"<p>You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.</p> <p>This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-accessing-snapshot.html\">Accessing the Contents of an EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/ebs-service.html\">Amazon Elastic Block Store Endpoints and Quotas</a> in the <i>AWS General Reference</i>.</p>"
 }