@aws-sdk/client-kms 3.288.0 → 3.290.0

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

@@ -43,6 +43,75 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
  * @see {@link GenerateRandomCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link CustomKeyStoreInvalidStateException} (client fault)
+ *  <p>The request was rejected because of the <code>ConnectionState</code> of the custom key
+ *       store. To get the <code>ConnectionState</code> of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
+ *          <p>This exception is thrown under the following conditions:</p>
+ *          <ul>
+ *             <li>
+ *                <p>You requested the <a>ConnectCustomKeyStore</a> operation on a custom key
+ *           store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or
+ *             <code>FAILED</code>. This operation is valid for all other <code>ConnectionState</code>
+ *           values. To reconnect a custom key store in a <code>FAILED</code> state, disconnect it
+ *             (<a>DisconnectCustomKeyStore</a>), then connect it
+ *             (<code>ConnectCustomKeyStore</code>).</p>
+ *             </li>
+ *             <li>
+ *                <p>You requested the <a>CreateKey</a> operation in a custom key store that is
+ *           not connected. This operations is valid only when the custom key store
+ *             <code>ConnectionState</code> is <code>CONNECTED</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>You requested the <a>DisconnectCustomKeyStore</a> operation on a custom key
+ *           store with a <code>ConnectionState</code> of <code>DISCONNECTING</code> or
+ *             <code>DISCONNECTED</code>. This operation is valid for all other
+ *             <code>ConnectionState</code> values.</p>
+ *             </li>
+ *             <li>
+ *                <p>You requested the <a>UpdateCustomKeyStore</a> or <a>DeleteCustomKeyStore</a> operation on a custom key store that is not
+ *           disconnected. This operation is valid only when the custom key store
+ *             <code>ConnectionState</code> is <code>DISCONNECTED</code>.</p>
+ *             </li>
+ *             <li>
+ *                <p>You requested the <a>GenerateRandom</a> operation in an CloudHSM key store
+ *           that is not connected. This operation is valid only when the CloudHSM key store
+ *             <code>ConnectionState</code> is <code>CONNECTED</code>. </p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link CustomKeyStoreNotFoundException} (client fault)
+ *  <p>The request was rejected because KMS cannot find a custom key store with the specified
+ *       key store name or ID.</p>
+ *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The request was rejected because a specified parameter is not supported or a specified
+ *       resource is not valid for this operation.</p>
+ *
+ *
+ * @example To generate random data
+ * ```javascript
+ * // The following example generates 32 bytes of random data.
+ * const input = {
+ *   "NumberOfBytes": 32
+ * };
+ * const command = new GenerateRandomCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Plaintext": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-generate-random-data-1479163645600
+ * ```
+ *
  */
 export declare class GenerateRandomCommand extends $Command<GenerateRandomCommandInput, GenerateRandomCommandOutput, KMSClientResolvedConfig> {
     readonly input: GenerateRandomCommandInput;

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

@@ -36,6 +36,58 @@ export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __Metad
  * @see {@link GetKeyPolicyCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ *
+ * @example To retrieve a key policy
+ * ```javascript
+ * // The following example retrieves the key policy for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "PolicyName": "default"
+ * };
+ * const command = new GetKeyPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Policy": "{\n  \"Version\" : \"2012-10-17\",\n  \"Id\" : \"key-default-1\",\n  \"Statement\" : [ {\n    \"Sid\" : \"Enable IAM User Permissions\",\n    \"Effect\" : \"Allow\",\n    \"Principal\" : {\n      \"AWS\" : \"arn:aws:iam::111122223333:root\"\n    },\n    \"Action\" : \"kms:*\",\n    \"Resource\" : \"*\"\n  } ]\n}"
+ * }
+ * *\/
+ * // example id: to-retrieve-a-key-policy-1479170128325
+ * ```
+ *
  */
 export declare class GetKeyPolicyCommand extends $Command<GetKeyPolicyCommandInput, GetKeyPolicyCommandOutput, KMSClientResolvedConfig> {
     readonly input: GetKeyPolicyCommandInput;

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

@@ -81,6 +81,61 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
  * @see {@link GetKeyRotationStatusCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The request was rejected because a specified parameter is not supported or a specified
+ *       resource is not valid for this operation.</p>
+ *
+ *
+ * @example To retrieve the rotation status for a KMS key
+ * ```javascript
+ * // The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new GetKeyRotationStatusCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "KeyRotationEnabled": true
+ * }
+ * *\/
+ * // example id: to-retrieve-the-rotation-status-for-a-cmk-1479172287408
+ * ```
+ *
  */
 export declare class GetKeyRotationStatusCommand extends $Command<GetKeyRotationStatusCommandInput, GetKeyRotationStatusCommandOutput, KMSClientResolvedConfig> {
     readonly input: GetKeyRotationStatusCommandInput;

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

@@ -62,6 +62,66 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
  * @see {@link GetParametersForImportCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The request was rejected because a specified parameter is not supported or a specified
+ *       resource is not valid for this operation.</p>
+ *
+ *
+ * @example To retrieve the public key and import token for a KMS key
+ * ```javascript
+ * // The following example retrieves the public key and import token for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "WrappingAlgorithm": "RSAES_OAEP_SHA_1",
+ *   "WrappingKeySpec": "RSA_2048"
+ * };
+ * const command = new GetParametersForImportCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "ParametersValidTo": "2016-12-01T14:52:17-08:00",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-retrieve-the-public-key-and-import-token-for-a-cmk-1480626483211
+ * ```
+ *
  */
 export declare class GetParametersForImportCommand extends $Command<GetParametersForImportCommandInput, GetParametersForImportCommandOutput, KMSClientResolvedConfig> {
     readonly input: GetParametersForImportCommandInput;

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

@@ -77,6 +77,99 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
  * @see {@link GetPublicKeyCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link DisabledException} (client fault)
+ *  <p>The request was rejected because the specified KMS key is not enabled.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link InvalidGrantTokenException} (client fault)
+ *  <p>The request was rejected because the specified grant token is not valid.</p>
+ *
+ * @throws {@link InvalidKeyUsageException} (client fault)
+ *  <p>The request was rejected for one of the following reasons: </p>
+ *          <ul>
+ *             <li>
+ *                <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
+ *           operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>The encryption algorithm or signing algorithm specified for the operation is
+ *           incompatible with the type of key material in the KMS key <code>(KeySpec</code>).</p>
+ *             </li>
+ *          </ul>
+ *          <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
+ *         <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying
+ *       messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
+ *       verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
+ *         <code>GENERATE_VERIFY_MAC</code>. To find the <code>KeyUsage</code> of a KMS key, use the
+ *         <a>DescribeKey</a> operation.</p>
+ *          <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
+ *         <a>DescribeKey</a> operation.</p>
+ *
+ * @throws {@link KeyUnavailableException} (server fault)
+ *  <p>The request was rejected because the specified KMS key was not available. You can retry
+ *       the request.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The request was rejected because a specified parameter is not supported or a specified
+ *       resource is not valid for this operation.</p>
+ *
+ *
+ * @example To download the public key of an asymmetric KMS key
+ * ```javascript
+ * // This example gets the public key of an asymmetric RSA KMS key used for encryption and decryption. The operation returns the key spec, key usage, and encryption or signing algorithms to help you use the public key correctly outside of AWS KMS.
+ * const input = {
+ *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321"
+ * };
+ * const command = new GetPublicKeyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomerMasterKeySpec": "RSA_4096",
+ *   "EncryptionAlgorithms": [
+ *     "RSAES_OAEP_SHA_1",
+ *     "RSAES_OAEP_SHA_256"
+ *   ],
+ *   "KeyId": "arn:aws:kms:us-west-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
+ *   "KeyUsage": "ENCRYPT_DECRYPT",
+ *   "PublicKey": "<binary data>"
+ * }
+ * *\/
+ * // example id: to-download-the-public-key-of-an-asymmetric-kms-key-1628621691873
+ * ```
+ *
  */
 export declare class GetPublicKeyCommand extends $Command<GetPublicKeyCommandInput, GetPublicKeyCommandOutput, KMSClientResolvedConfig> {
     readonly input: GetPublicKeyCommandInput;

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

@@ -92,6 +92,79 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
  * @see {@link ImportKeyMaterialCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link ExpiredImportTokenException} (client fault)
+ *  <p>The request was rejected because the specified import token is expired. Use <a>GetParametersForImport</a> to get a new import token and public key, use the new
+ *       public key to encrypt the key material, and then try the request again.</p>
+ *
+ * @throws {@link IncorrectKeyMaterialException} (client fault)
+ *  <p>The request was rejected because the key material in the request is, expired, invalid, or
+ *       is not the same key material that was previously imported into this KMS key.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link InvalidCiphertextException} (client fault)
+ *  <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request
+ *       was rejected because the specified ciphertext, or additional authenticated data incorporated
+ *       into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
+ *       invalid.</p>
+ *          <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
+ *       KMS could not decrypt the encrypted (wrapped) key material. </p>
+ *
+ * @throws {@link InvalidImportTokenException} (client fault)
+ *  <p>The request was rejected because the provided import token is invalid or is associated
+ *       with a different KMS key.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ * @throws {@link UnsupportedOperationException} (client fault)
+ *  <p>The request was rejected because a specified parameter is not supported or a specified
+ *       resource is not valid for this operation.</p>
+ *
+ *
+ * @example To import key material into a KMS key
+ * ```javascript
+ * // The following example imports key material into the specified KMS key.
+ * const input = {
+ *   "EncryptedKeyMaterial": "<binary data>",
+ *   "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE",
+ *   "ImportToken": "<binary data>",
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new ImportKeyMaterialCommand(input);
+ * await client.send(command);
+ * // example id: to-import-key-material-into-a-cmk-1480630551969
+ * ```
+ *
  */
 export declare class ImportKeyMaterialCommand extends $Command<ImportKeyMaterialCommandInput, ImportKeyMaterialCommandOutput, KMSClientResolvedConfig> {
     readonly input: ImportKeyMaterialCommandInput;

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

@@ -69,6 +69,83 @@ export interface ListAliasesCommandOutput extends ListAliasesResponse, __Metadat
  * @see {@link ListAliasesCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link InvalidMarkerException} (client fault)
+ *  <p>The request was rejected because the marker that specifies where pagination should next
+ *       begin is not valid.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ *
+ * @example To list aliases
+ * ```javascript
+ * // The following example lists aliases.
+ * const input = undefined;
+ * const command = new ListAliasesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Aliases": [
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/acm",
+ *       "AliasName": "alias/aws/acm",
+ *       "TargetKeyId": "da03f6f7-d279-427a-9cae-de48d07e5b66"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs",
+ *       "AliasName": "alias/aws/ebs",
+ *       "TargetKeyId": "25a217e7-7170-4b8c-8bf6-045ea5f70e5b"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/rds",
+ *       "AliasName": "alias/aws/rds",
+ *       "TargetKeyId": "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift",
+ *       "AliasName": "alias/aws/redshift",
+ *       "TargetKeyId": "08f7a25a-69e2-4fb5-8f10-393db27326fa"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/s3",
+ *       "AliasName": "alias/aws/s3",
+ *       "TargetKeyId": "d2b0f1a3-580d-4f79-b836-bc983be8cfa5"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example1",
+ *       "AliasName": "alias/example1",
+ *       "TargetKeyId": "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example2",
+ *       "AliasName": "alias/example2",
+ *       "TargetKeyId": "f32fef59-2cc2-445b-8573-2d73328acbee"
+ *     },
+ *     {
+ *       "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example3",
+ *       "AliasName": "alias/example3",
+ *       "TargetKeyId": "1374ef38-d34e-4d5f-b2c9-4e0daee38855"
+ *     }
+ *   ],
+ *   "Truncated": false
+ * }
+ * *\/
+ * // example id: to-list-aliases-1480729693349
+ * ```
+ *
  */
 export declare class ListAliasesCommand extends $Command<ListAliasesCommandInput, ListAliasesCommandOutput, KMSClientResolvedConfig> {
     readonly input: ListAliasesCommandInput;

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

@@ -73,6 +73,117 @@ export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataB
  * @see {@link ListGrantsCommandOutput} for command's `response` shape.
  * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
  *
+ * @throws {@link DependencyTimeoutException} (server fault)
+ *  <p>The system timed out while trying to fulfill the request. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link InvalidArnException} (client fault)
+ *  <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
+ *       valid.</p>
+ *
+ * @throws {@link InvalidGrantIdException} (client fault)
+ *  <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
+ *
+ * @throws {@link InvalidMarkerException} (client fault)
+ *  <p>The request was rejected because the marker that specifies where pagination should next
+ *       begin is not valid.</p>
+ *
+ * @throws {@link KMSInternalException} (server fault)
+ *  <p>The request was rejected because an internal exception occurred. The request can be
+ *       retried.</p>
+ *
+ * @throws {@link KMSInvalidStateException} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for this
+ *       request.</p>
+ *          <p>This exceptions means one of the following:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The key state of the KMS key is not compatible with the operation. </p>
+ *                <p>To find the key state, use the <a>DescribeKey</a> operation. For more
+ *           information about which key states are compatible with each KMS operation, see
+ *           <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>
+ *                      <i>Key Management Service Developer Guide</i>
+ *                   </i>.</p>
+ *             </li>
+ *             <li>
+ *                <p>For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be
+ *       found.</p>
+ *
+ *
+ * @example To list grants for a KMS key
+ * ```javascript
+ * // The following example lists grants for the specified KMS key.
+ * const input = {
+ *   "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
+ * };
+ * const command = new ListGrantsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Grants": [
+ *     {
+ *       "CreationDate": "2016-10-25T14:37:41-07:00",
+ *       "GrantId": "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172",
+ *       "GranteePrincipal": "acm.us-east-2.amazonaws.com",
+ *       "IssuingAccount": "arn:aws:iam::111122223333:root",
+ *       "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "Operations": [
+ *         "Encrypt",
+ *         "ReEncryptFrom",
+ *         "ReEncryptTo"
+ *       ],
+ *       "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
+ *     },
+ *     {
+ *       "CreationDate": "2016-10-25T14:37:41-07:00",
+ *       "GrantId": "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200",
+ *       "GranteePrincipal": "acm.us-east-2.amazonaws.com",
+ *       "IssuingAccount": "arn:aws:iam::111122223333:root",
+ *       "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "Operations": [
+ *         "ReEncryptFrom",
+ *         "ReEncryptTo"
+ *       ],
+ *       "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
+ *     },
+ *     {
+ *       "CreationDate": "2016-10-25T14:37:41-07:00",
+ *       "GrantId": "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f",
+ *       "GranteePrincipal": "acm.us-east-2.amazonaws.com",
+ *       "IssuingAccount": "arn:aws:iam::111122223333:root",
+ *       "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "Operations": [
+ *         "Encrypt",
+ *         "ReEncryptFrom",
+ *         "ReEncryptTo"
+ *       ],
+ *       "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
+ *     },
+ *     {
+ *       "CreationDate": "2016-10-25T14:37:41-07:00",
+ *       "GrantId": "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c",
+ *       "GranteePrincipal": "acm.us-east-2.amazonaws.com",
+ *       "IssuingAccount": "arn:aws:iam::111122223333:root",
+ *       "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
+ *       "Operations": [
+ *         "Encrypt",
+ *         "ReEncryptFrom",
+ *         "ReEncryptTo"
+ *       ],
+ *       "RetiringPrincipal": "acm.us-east-2.amazonaws.com"
+ *     }
+ *   ],
+ *   "Truncated": true
+ * }
+ * *\/
+ * // example id: to-list-grants-for-a-cmk-1481067365389
+ * ```
+ *
  */
 export declare class ListGrantsCommand extends $Command<ListGrantsCommandInput, ListGrantsCommandOutput, KMSClientResolvedConfig> {
     readonly input: ListGrantsCommandInput;