@aws-sdk/client-kms 3.774.0 → 3.777.0

package/dist-types/commands/DecryptCommand.d.ts

@@ -247,69 +247,45 @@ declare const DecryptCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To decrypt data with a symmetric encryption KMS key
  * ```javascript
  * // The following example decrypts data that was encrypted with a symmetric encryption KMS key. The KeyId is not required when decrypting with a symmetric encryption key, but it is a best practice.
  * const input = {
- *   "CiphertextBlob": "<binary data>",
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   CiphertextBlob: "<binary data>",
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DecryptCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EncryptionAlgorithm": "SYMMETRIC_DEFAULT",
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *   "Plaintext": "<binary data>"
+ *   EncryptionAlgorithm: "SYMMETRIC_DEFAULT",
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   Plaintext: "<binary data>"
  * }
  * *\/
- * // example id: to-decrypt-data-1
  * ```
  *
  * @example To decrypt data with an asymmetric encryption KMS key
  * ```javascript
  * // The following example decrypts data that was encrypted with an asymmetric encryption KMS key. When the KMS encryption key is asymmetric, you must specify the KMS key ID and the encryption algorithm that was used to encrypt the data.
  * const input = {
- *   "CiphertextBlob": "<binary data>",
- *   "EncryptionAlgorithm": "RSAES_OAEP_SHA_256",
- *   "KeyId": "0987dcba-09fe-87dc-65ba-ab0987654321"
+ *   CiphertextBlob: "<binary data>",
+ *   EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
+ *   KeyId: "0987dcba-09fe-87dc-65ba-ab0987654321"
  * };
  * const command = new DecryptCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EncryptionAlgorithm": "RSAES_OAEP_SHA_256",
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
- *   "Plaintext": "<binary data>"
+ *   EncryptionAlgorithm: "RSAES_OAEP_SHA_256",
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
+ *   Plaintext: "<binary data>"
  * }
  * *\/
- * // example id: to-decrypt-data-2
- * ```
- *
- * @example To decrypt data for a Nitro enclave
- * ```javascript
- * // The following Decrypt example includes the Recipient parameter with a signed attestation document from an AWS Nitro enclave. Instead of returning the decrypted data in plaintext (Plaintext), the operation returns the decrypted data encrypted by the public key from the attestation document (CiphertextForRecipient).
- * const input = {
- *   "CiphertextBlob": "<binary data>",
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *   "Recipient": {
- *     "AttestationDocument": "<attestation document>",
- *     "KeyEncryptionAlgorithm": "RSAES_OAEP_SHA_256"
- *   }
- * };
- * const command = new DecryptCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "CiphertextForRecipient": "<binary data>",
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *   "Plaintext": ""
- * }
- * *\/
- * // example id: to-decrypt-data-for-a-nitro-enclave-2
  * ```
  *
+ * @public
  */
 export declare class DecryptCommand extends DecryptCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteAliasCommand.d.ts

@@ -134,18 +134,21 @@ declare const DeleteAliasCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To delete an alias
  * ```javascript
  * // The following example deletes the specified alias.
  * const input = {
- *   "AliasName": "alias/ExampleAlias"
+ *   AliasName: "alias/ExampleAlias"
  * };
  * const command = new DeleteAliasCommand(input);
- * await client.send(command);
- * // example id: to-delete-an-alias-1478285209338
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteAliasCommand extends DeleteAliasCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts

@@ -163,18 +163,21 @@ declare const DeleteCustomKeyStoreCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To delete a custom key store from AWS KMS
  * ```javascript
  * // This example deletes a custom key store from AWS KMS. This operation does not affect the backing key store, such as a CloudHSM cluster, external key store proxy, or your external key manager. This operation doesn't return any data. To verify that the operation was successful, use the DescribeCustomKeyStores operation.
  * const input = {
- *   "CustomKeyStoreId": "cks-1234567890abcdef0"
+ *   CustomKeyStoreId: "cks-1234567890abcdef0"
  * };
  * const command = new DeleteCustomKeyStoreCommand(input);
- * await client.send(command);
- * // example id: to-delete-a-custom-key-store-from-aws-kms-1628630837145
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteCustomKeyStoreCommand extends DeleteCustomKeyStoreCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts

@@ -122,18 +122,21 @@ declare const DeleteImportedKeyMaterialCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To delete imported key material
  * ```javascript
  * // The following example deletes the imported key material from the specified KMS key.
  * const input = {
- *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DeleteImportedKeyMaterialCommand(input);
- * await client.send(command);
- * // example id: to-delete-imported-key-material-1478561674507
+ * const response = await client.send(command);
+ * /* response is
+ * { /* metadata only *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteImportedKeyMaterialCommand extends DeleteImportedKeyMaterialCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DeriveSharedSecretCommand.d.ts

@@ -218,28 +218,28 @@ declare const DeriveSharedSecretCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To derive a shared secret
  * ```javascript
  * // The following example derives a shared secret using a key agreement algorithm.
  * const input = {
- *   "KeyAgreementAlgorithm": "ECDH",
- *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *   "PublicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvH3Yj0wbkLEpUl95Cv1cJVjsVNSjwGq3tCLnzXfhVwVvmzGN8pYj3U8nKwgouaHbBWNJYjP5VutbbkKS4Kv4GojwZBJyHN17kmxo8yTjRmjR15SKIQ8cqRA2uaERMLnpztIXdZp232PQPbWGxDyXYJ0aJ5EFSag"
+ *   KeyAgreementAlgorithm: "ECDH",
+ *   KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   PublicKey: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvH3Yj0wbkLEpUl95Cv1cJVjsVNSjwGq3tCLnzXfhVwVvmzGN8pYj3U8nKwgouaHbBWNJYjP5VutbbkKS4Kv4GojwZBJyHN17kmxo8yTjRmjR15SKIQ8cqRA2uaERMLnpztIXdZp232PQPbWGxDyXYJ0aJ5EFSag"
  * };
  * const command = new DeriveSharedSecretCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyAgreementAlgorithm": "ECDH",
- *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *   "KeyOrigin": "AWS_KMS",
- *   "SharedSecret": "MEYCIQCKZLWyTk5runarx6XiAkU9gv3lbwPO/pHa+DXFehzdDwIhANwpsIV2g/9SPWLLsF6p/hiSskuIXMTRwqrMdVKWTMHG"
+ *   KeyAgreementAlgorithm: "ECDH",
+ *   KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   KeyOrigin: "AWS_KMS",
+ *   SharedSecret: "MEYCIQCKZLWyTk5runarx6XiAkU9gv3lbwPO/pHa+DXFehzdDwIhANwpsIV2g/9SPWLLsF6p/hiSskuIXMTRwqrMdVKWTMHG"
  * }
  * *\/
- * // example id: to-derive-a-shared-secret-1718381818754
  * ```
  *
+ * @public
  */
 export declare class DeriveSharedSecretCommand extends DeriveSharedSecretCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts

@@ -150,108 +150,21 @@ declare const DescribeCustomKeyStoresCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
+ *
  * @example To get detailed information about custom key stores in the account and Region
  * ```javascript
  * // This example gets detailed information about all AWS KMS custom key stores in an AWS account and Region. To get all key stores, do not enter a custom key store name or ID.
- * const input = {};
- * const command = new DescribeCustomKeyStoresCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "CustomKeyStores": []
- * }
- * *\/
- * // example id: to-get-detailed-information-about-custom-key-stores-in-the-account-and-region-1
- * ```
- *
- * @example To get detailed information about an AWS CloudHSM key store by specifying its friendly name
- * ```javascript
- * // This example gets detailed information about a particular AWS CloudHSM key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID.
- * const input = {
- *   "CustomKeyStoreName": "ExampleKeyStore"
- * };
- * const command = new DescribeCustomKeyStoresCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "CustomKeyStores": [
- *     {
- *       "CloudHsmClusterId": "cluster-234abcdefABC",
- *       "ConnectionState": "CONNECTED",
- *       "CreationDate": "1.499288695918E9",
- *       "CustomKeyStoreId": "cks-1234567890abcdef0",
- *       "CustomKeyStoreName": "ExampleKeyStore",
- *       "CustomKeyStoreType": "AWS_CLOUDHSM",
- *       "TrustAnchorCertificate": "<certificate appears here>"
- *     }
- *   ]
- * }
- * *\/
- * // example id: to-get-detailed-information-about-a-cloudhsm-custom-key-store-by-name-2
- * ```
- *
- * @example To get detailed information about an external key store by specifying its ID
- * ```javascript
- * // This example gets detailed information about an external key store by specifying its ID.  The example external key store proxy uses public endpoint connectivity.
- * const input = {
- *   "CustomKeyStoreId": "cks-9876543210fedcba9"
- * };
+ * const input = { /* empty *\/ };
  * const command = new DescribeCustomKeyStoresCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CustomKeyStores": [
- *     {
- *       "ConnectionState": "CONNECTED",
- *       "CreationDate": "1.599288695918E9",
- *       "CustomKeyStoreId": "cks-9876543210fedcba9",
- *       "CustomKeyStoreName": "ExampleExternalKeyStore",
- *       "CustomKeyStoreType": "EXTERNAL_KEY_STORE",
- *       "XksProxyConfiguration": {
- *         "AccessKeyId": "ABCDE12345670EXAMPLE",
- *         "Connectivity": "PUBLIC_ENDPOINT",
- *         "UriEndpoint": "https://myproxy.xks.example.com",
- *         "UriPath": "/kms/xks/v1"
- *       }
- *     }
- *   ]
+ *   CustomKeyStores:   []
  * }
  * *\/
- * // example id: to-get-detailed-information-about-an-external-key-store--3
- * ```
- *
- * @example To get detailed information about an external key store VPC endpoint connectivity by specifying its friendly name
- * ```javascript
- * // This example gets detailed information about a particular external key store by specifying its friendly name. To limit the output to a particular custom key store, provide either the custom key store name or ID. The proxy URI path for this external key store includes an optional prefix. Also, because this example external key store uses VPC endpoint connectivity, the response includes the associated VPC endpoint service name.
- * const input = {
- *   "CustomKeyStoreName": "VPCExternalKeystore"
- * };
- * const command = new DescribeCustomKeyStoresCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "CustomKeyStores": [
- *     {
- *       "ConnectionState": "CONNECTED",
- *       "CreationDate": "1.643057863.842",
- *       "CustomKeyStoreId": "cks-876543210fedcba98",
- *       "CustomKeyStoreName": "ExampleVPCExternalKeyStore",
- *       "CustomKeyStoreType": "EXTERNAL_KEY_STORE",
- *       "XksProxyConfiguration": {
- *         "AccessKeyId": "ABCDE12345670EXAMPLE",
- *         "Connectivity": "VPC_ENDPOINT_SERVICE",
- *         "UriEndpoint": "https://myproxy-private.xks.example.com",
- *         "UriPath": "/example-prefix/kms/xks/v1",
- *         "VpcEndpointServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-example1"
- *       }
- *     }
- *   ]
- * }
- * *\/
- * // example id: to-get-detailed-information-about-an-external-custom-key-store-by-name-4
  * ```
  *
+ * @public
  */
 export declare class DescribeCustomKeyStoresCommand extends DescribeCustomKeyStoresCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/commands/DescribeKeyCommand.d.ts

@@ -204,65 +204,32 @@ declare const DescribeKeyCommand_base: {
  * @throws {@link KMSServiceException}
  * <p>Base exception class for all service exceptions from KMS service.</p>
  *
- * @public
- * @example To get details about a KMS key
- * ```javascript
- * // The following example gets metadata for a symmetric encryption KMS key.
- * const input = {
- *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
- * };
- * const command = new DescribeKeyCommand(input);
- * const response = await client.send(command);
- * /* response ==
- * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "111122223333",
- *     "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "CreationDate": "2017-07-05T14:04:55-07:00",
- *     "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
- *     "Description": "",
- *     "Enabled": true,
- *     "EncryptionAlgorithms": [
- *       "SYMMETRIC_DEFAULT"
- *     ],
- *     "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeySpec": "SYMMETRIC_DEFAULT",
- *     "KeyState": "Enabled",
- *     "KeyUsage": "ENCRYPT_DECRYPT",
- *     "MultiRegion": false,
- *     "Origin": "AWS_KMS"
- *   }
- * }
- * *\/
- * // example id: get-key-details-1
- * ```
  *
  * @example To get details about an RSA asymmetric KMS key
  * ```javascript
  * // The following example gets metadata for an asymmetric RSA KMS key used for signing and verification.
  * const input = {
- *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DescribeKeyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "111122223333",
- *     "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "CreationDate": 1571767572.317,
- *     "CustomerMasterKeySpec": "RSA_2048",
- *     "Description": "",
- *     "Enabled": false,
- *     "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeySpec": "RSA_2048",
- *     "KeyState": "Disabled",
- *     "KeyUsage": "SIGN_VERIFY",
- *     "MultiRegion": false,
- *     "Origin": "AWS_KMS",
- *     "SigningAlgorithms": [
+ *   KeyMetadata: {
+ *     AWSAccountId: "111122223333",
+ *     Arn: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     CreationDate: 1.571767572317E9,
+ *     CustomerMasterKeySpec: "RSA_2048",
+ *     Description: "",
+ *     Enabled: false,
+ *     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     KeyManager: "CUSTOMER",
+ *     KeySpec: "RSA_2048",
+ *     KeyState: "Disabled",
+ *     KeyUsage: "SIGN_VERIFY",
+ *     MultiRegion: false,
+ *     Origin: "AWS_KMS",
+ *     SigningAlgorithms: [
  *       "RSASSA_PKCS1_V1_5_SHA_256",
  *       "RSASSA_PKCS1_V1_5_SHA_384",
  *       "RSASSA_PKCS1_V1_5_SHA_512",
@@ -273,166 +240,162 @@ declare const DescribeKeyCommand_base: {
  *   }
  * }
  * *\/
- * // example id: to-get-details-about-an-rsa-asymmetric-kms-key-2
  * ```
  *
  * @example To get details about a multi-Region key
  * ```javascript
  * // The following example gets metadata for a multi-Region replica key. This multi-Region key is a symmetric encryption key. DescribeKey returns information about the primary key and all of its replicas.
  * const input = {
- *   "KeyId": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab"
+ *   KeyId: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab"
  * };
  * const command = new DescribeKeyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "111122223333",
- *     "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
- *     "CreationDate": 1586329200.918,
- *     "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
- *     "Description": "",
- *     "Enabled": true,
- *     "EncryptionAlgorithms": [
+ *   KeyMetadata: {
+ *     AWSAccountId: "111122223333",
+ *     Arn: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ *     CreationDate: 1.586329200918E9,
+ *     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT",
+ *     Description: "",
+ *     Enabled: true,
+ *     EncryptionAlgorithms: [
  *       "SYMMETRIC_DEFAULT"
  *     ],
- *     "KeyId": "mrk-1234abcd12ab34cd56ef1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeyState": "Enabled",
- *     "KeyUsage": "ENCRYPT_DECRYPT",
- *     "MultiRegion": true,
- *     "MultiRegionConfiguration": {
- *       "MultiRegionKeyType": "PRIMARY",
- *       "PrimaryKey": {
- *         "Arn": "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
- *         "Region": "us-west-2"
+ *     KeyId: "mrk-1234abcd12ab34cd56ef1234567890ab",
+ *     KeyManager: "CUSTOMER",
+ *     KeyState: "Enabled",
+ *     KeyUsage: "ENCRYPT_DECRYPT",
+ *     MultiRegion: true,
+ *     MultiRegionConfiguration: {
+ *       MultiRegionKeyType: "PRIMARY",
+ *       PrimaryKey: {
+ *         Arn: "arn:aws:kms:us-west-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ *         Region: "us-west-2"
  *       },
- *       "ReplicaKeys": [
+ *       ReplicaKeys: [
  *         {
- *           "Arn": "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
- *           "Region": "eu-west-1"
+ *           Arn: "arn:aws:kms:eu-west-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ *           Region: "eu-west-1"
  *         },
  *         {
- *           "Arn": "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
- *           "Region": "ap-northeast-1"
+ *           Arn: "arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ *           Region: "ap-northeast-1"
  *         },
  *         {
- *           "Arn": "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
- *           "Region": "sa-east-1"
+ *           Arn: "arn:aws:kms:sa-east-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab",
+ *           Region: "sa-east-1"
  *         }
  *       ]
  *     },
- *     "Origin": "AWS_KMS"
+ *     Origin: "AWS_KMS"
  *   }
  * }
  * *\/
- * // example id: to-get-details-about-a-multi-region-key-3
  * ```
  *
  * @example To get details about an HMAC KMS key
  * ```javascript
  * // The following example gets the metadata of an HMAC KMS key.
  * const input = {
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DescribeKeyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "123456789012",
- *     "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "CreationDate": 1566160362.664,
- *     "CustomerMasterKeySpec": "HMAC_256",
- *     "Description": "Development test key",
- *     "Enabled": true,
- *     "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeyState": "Enabled",
- *     "KeyUsage": "GENERATE_VERIFY_MAC",
- *     "MacAlgorithms": [
+ *   KeyMetadata: {
+ *     AWSAccountId: "123456789012",
+ *     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     CreationDate: 1.566160362664E9,
+ *     CustomerMasterKeySpec: "HMAC_256",
+ *     Description: "Development test key",
+ *     Enabled: true,
+ *     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     KeyManager: "CUSTOMER",
+ *     KeyState: "Enabled",
+ *     KeyUsage: "GENERATE_VERIFY_MAC",
+ *     MacAlgorithms: [
  *       "HMAC_SHA_256"
  *     ],
- *     "MultiRegion": false,
- *     "Origin": "AWS_KMS"
+ *     MultiRegion: false,
+ *     Origin: "AWS_KMS"
  *   }
  * }
  * *\/
- * // example id: to-get-details-about-an-hmac-kms-key-4
  * ```
  *
  * @example To get details about a KMS key in an AWS CloudHSM key store
  * ```javascript
  * // The following example gets the metadata of a KMS key in an AWS CloudHSM key store.
  * const input = {
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DescribeKeyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "123456789012",
- *     "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "CloudHsmClusterId": "cluster-234abcdefABC",
- *     "CreationDate": 1646160362.664,
- *     "CustomKeyStoreId": "cks-1234567890abcdef0",
- *     "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
- *     "Description": "CloudHSM key store test key",
- *     "Enabled": true,
- *     "EncryptionAlgorithms": [
+ *   KeyMetadata: {
+ *     AWSAccountId: "123456789012",
+ *     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     CloudHsmClusterId: "cluster-234abcdefABC",
+ *     CreationDate: 1.646160362664E9,
+ *     CustomKeyStoreId: "cks-1234567890abcdef0",
+ *     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT",
+ *     Description: "CloudHSM key store test key",
+ *     Enabled: true,
+ *     EncryptionAlgorithms: [
  *       "SYMMETRIC_DEFAULT"
  *     ],
- *     "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeySpec": "SYMMETRIC_DEFAULT",
- *     "KeyState": "Enabled",
- *     "KeyUsage": "ENCRYPT_DECRYPT",
- *     "MultiRegion": false,
- *     "Origin": "AWS_CLOUDHSM"
+ *     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     KeyManager: "CUSTOMER",
+ *     KeySpec: "SYMMETRIC_DEFAULT",
+ *     KeyState: "Enabled",
+ *     KeyUsage: "ENCRYPT_DECRYPT",
+ *     MultiRegion: false,
+ *     Origin: "AWS_CLOUDHSM"
  *   }
  * }
  * *\/
- * // example id: to-get-details-about-a-kms-key-in-an-AWS-CloudHSM-key-store-5
  * ```
  *
  * @example To get details about a KMS key in an external key store
  * ```javascript
  * // The following example gets the metadata of a KMS key in an external key store.
  * const input = {
- *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
+ *   KeyId: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  * };
  * const command = new DescribeKeyCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "KeyMetadata": {
- *     "AWSAccountId": "123456789012",
- *     "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "CreationDate": 1646160362.664,
- *     "CustomKeyStoreId": "cks-1234567890abcdef0",
- *     "CustomerMasterKeySpec": "SYMMETRIC_DEFAULT",
- *     "Description": "External key store test key",
- *     "Enabled": true,
- *     "EncryptionAlgorithms": [
+ *   KeyMetadata: {
+ *     AWSAccountId: "123456789012",
+ *     Arn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     CreationDate: 1.646160362664E9,
+ *     CustomKeyStoreId: "cks-1234567890abcdef0",
+ *     CustomerMasterKeySpec: "SYMMETRIC_DEFAULT",
+ *     Description: "External key store test key",
+ *     Enabled: true,
+ *     EncryptionAlgorithms: [
  *       "SYMMETRIC_DEFAULT"
  *     ],
- *     "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
- *     "KeyManager": "CUSTOMER",
- *     "KeySpec": "SYMMETRIC_DEFAULT",
- *     "KeyState": "Enabled",
- *     "KeyUsage": "ENCRYPT_DECRYPT",
- *     "MultiRegion": false,
- *     "Origin": "EXTERNAL_KEY_STORE",
- *     "XksKeyConfiguration": {
- *       "Id": "bb8562717f809024"
+ *     KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *     KeyManager: "CUSTOMER",
+ *     KeySpec: "SYMMETRIC_DEFAULT",
+ *     KeyState: "Enabled",
+ *     KeyUsage: "ENCRYPT_DECRYPT",
+ *     MultiRegion: false,
+ *     Origin: "EXTERNAL_KEY_STORE",
+ *     XksKeyConfiguration: {
+ *       Id: "bb8562717f809024"
  *     }
  *   }
  * }
  * *\/
- * // example id: to-get-details-about-a-kms-key-in-an-external-key-store-6
  * ```
  *
+ * @public
  */
 export declare class DescribeKeyCommand extends DescribeKeyCommand_base {
     /** @internal type navigation helper, not in runtime. */