docs(client-qldb): Clarify possible values for KmsKeyArn and Encrypti…

…onDescription.
aws · Feb 23, 2024 · 93fdd39 · 93fdd39
1 parent 9fec71d
commit 93fdd39
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/clients/client-qldb/src/models/models_0.ts b/clients/client-qldb/src/models/models_0.ts
@@ -880,7 +880,7 @@ export interface LedgerEncryptionDescription {
    * @public
    * <p>The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for
    *          encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key
-   *          for encryption.</p>
+   *          for encryption. It will display <code>AWS_OWNED_KMS_KEY</code> when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.</p>
    */
   KmsKeyArn: string | undefined;
 
@@ -975,7 +975,7 @@ export interface DescribeLedgerResponse {
    * @public
    * <p>Information about the encryption of data at rest in the ledger. This includes the
    *          current status, the KMS key, and when the key became inaccessible (in the case of an
-   *          error).</p>
+   *          error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.</p>
    */
   EncryptionDescription?: LedgerEncryptionDescription;
 }

diff --git a/codegen/sdk-codegen/aws-models/qldb.json b/codegen/sdk-codegen/aws-models/qldb.json
@@ -1369,7 +1369,7 @@
         "EncryptionDescription": {
           "target": "com.amazonaws.qldb#LedgerEncryptionDescription",
           "traits": {
-            "smithy.api#documentation": "<p>Information about the encryption of data at rest in the ledger. This includes the\n         current status, the KMS key, and when the key became inaccessible (in the case of an\n         error).</p>"
+            "smithy.api#documentation": "<p>Information about the encryption of data at rest in the ledger. This includes the\n         current status, the KMS key, and when the key became inaccessible (in the case of an\n         error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.</p>"
           }
         }
       },
@@ -1997,7 +1997,7 @@
         "KmsKeyArn": {
           "target": "com.amazonaws.qldb#Arn",
           "traits": {
-            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for\n         encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key\n         for encryption.</p>",
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the customer managed KMS key that the ledger uses for\n         encryption at rest. If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key\n         for encryption. It will display <code>AWS_OWNED_KMS_KEY</code> when updating the ledger's encryption configuration to the Amazon Web Services owned KMS key.</p>",
             "smithy.api#required": {}
           }
         },