@aws-sdk/client-kms 3.50.0 → 3.53.0

package/dist-types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./KMSClient";
 export * from "./commands";
 export * from "./models";
 export * from "./pagination";
+export { KMSServiceException } from "./models/KMSServiceException";

package/dist-types/models/KMSServiceException.d.ts

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from KMS service.
+ */
+export declare class KMSServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,5 @@
-import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { KMSServiceException as __BaseException } from "./KMSServiceException";
 export declare enum AlgorithmSpec {
     RSAES_OAEP_SHA_1 = "RSAES_OAEP_SHA_1",
     RSAES_OAEP_SHA_256 = "RSAES_OAEP_SHA_256",
@@ -41,10 +42,13 @@ export declare namespace AliasListEntry {
  * <p>The request was rejected because it attempted to create a resource that already
  *       exists.</p>
  */
-export interface AlreadyExistsException extends __SmithyException, $MetadataBearer {
-    name: "AlreadyExistsException";
-    $fault: "client";
-    message?: string;
+export declare class AlreadyExistsException extends __BaseException {
+    readonly name: "AlreadyExistsException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
 }
 export interface CancelKeyDeletionRequest {
     /**
@@ -88,28 +92,37 @@ export declare namespace CancelKeyDeletionResponse {
  * <p>The system timed out while trying to fulfill the request. The request can be
  *       retried.</p>
  */
-export interface DependencyTimeoutException extends __SmithyException, $MetadataBearer {
-    name: "DependencyTimeoutException";
-    $fault: "server";
-    message?: string;
+export declare class DependencyTimeoutException extends __BaseException {
+    readonly name: "DependencyTimeoutException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DependencyTimeoutException, __BaseException>);
 }
 /**
  * <p>The request was rejected because a specified ARN, or an ARN in a key policy, is not
  *       valid.</p>
  */
-export interface InvalidArnException extends __SmithyException, $MetadataBearer {
-    name: "InvalidArnException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidArnException extends __BaseException {
+    readonly name: "InvalidArnException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidArnException, __BaseException>);
 }
 /**
  * <p>The request was rejected because an internal exception occurred. The request can be
  *       retried.</p>
  */
-export interface KMSInternalException extends __SmithyException, $MetadataBearer {
-    name: "KMSInternalException";
-    $fault: "server";
-    message?: string;
+export declare class KMSInternalException extends __BaseException {
+    readonly name: "KMSInternalException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KMSInternalException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the state of the specified resource is not valid for this
@@ -119,19 +132,25 @@ export interface KMSInternalException extends __SmithyException, $MetadataBearer
  *                <i>Key Management Service Developer Guide</i>
  *             </i>.</p>
  */
-export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
-    name: "KMSInvalidStateException";
-    $fault: "client";
-    message?: string;
+export declare class KMSInvalidStateException extends __BaseException {
+    readonly name: "KMSInvalidStateException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KMSInvalidStateException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified entity or resource could not be
  *       found.</p>
  */
-export interface NotFoundException extends __SmithyException, $MetadataBearer {
-    name: "NotFoundException";
-    $fault: "client";
-    message?: string;
+export declare class NotFoundException extends __BaseException {
+    readonly name: "NotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified CloudHSM cluster is already associated with a
@@ -140,10 +159,13 @@ export interface NotFoundException extends __SmithyException, $MetadataBearer {
  *          <p>Clusters that share a backup history have the same cluster certificate. To view the
  *       cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
  */
-export interface CloudHsmClusterInUseException extends __SmithyException, $MetadataBearer {
-    name: "CloudHsmClusterInUseException";
-    $fault: "client";
-    message?: string;
+export declare class CloudHsmClusterInUseException extends __BaseException {
+    readonly name: "CloudHsmClusterInUseException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CloudHsmClusterInUseException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the associated CloudHSM cluster did not meet the
@@ -180,29 +202,38 @@ export interface CloudHsmClusterInUseException extends __SmithyException, $Metad
  *                <i>CloudHSM User Guide</i>
  *             </i>. </p>
  */
-export interface CloudHsmClusterInvalidConfigurationException extends __SmithyException, $MetadataBearer {
-    name: "CloudHsmClusterInvalidConfigurationException";
-    $fault: "client";
-    message?: string;
+export declare class CloudHsmClusterInvalidConfigurationException extends __BaseException {
+    readonly name: "CloudHsmClusterInvalidConfigurationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CloudHsmClusterInvalidConfigurationException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the CloudHSM cluster that is associated with the custom key
  *       store is not active. Initialize and activate the cluster and try the command again. For
  *       detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>CloudHSM User Guide</i>.</p>
  */
-export interface CloudHsmClusterNotActiveException extends __SmithyException, $MetadataBearer {
-    name: "CloudHsmClusterNotActiveException";
-    $fault: "client";
-    message?: string;
+export declare class CloudHsmClusterNotActiveException extends __BaseException {
+    readonly name: "CloudHsmClusterNotActiveException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CloudHsmClusterNotActiveException, __BaseException>);
 }
 /**
  * <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
  *       cluster ID. Retry the request with a different cluster ID.</p>
  */
-export interface CloudHsmClusterNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "CloudHsmClusterNotFoundException";
-    $fault: "client";
-    message?: string;
+export declare class CloudHsmClusterNotFoundException extends __BaseException {
+    readonly name: "CloudHsmClusterNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CloudHsmClusterNotFoundException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified CloudHSM cluster has a different cluster
@@ -214,10 +245,13 @@ export interface CloudHsmClusterNotFoundException extends __SmithyException, $Me
  *          <p>Clusters that share a backup history have the same cluster certificate. To view the
  *       cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
  */
-export interface CloudHsmClusterNotRelatedException extends __SmithyException, $MetadataBearer {
-    name: "CloudHsmClusterNotRelatedException";
-    $fault: "client";
-    message?: string;
+export declare class CloudHsmClusterNotRelatedException extends __BaseException {
+    readonly name: "CloudHsmClusterNotRelatedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CloudHsmClusterNotRelatedException, __BaseException>);
 }
 export interface ConnectCustomKeyStoreRequest {
     /**
@@ -263,19 +297,25 @@ export declare namespace ConnectCustomKeyStoreResponse {
  *             </li>
  *          </ul>
  */
-export interface CustomKeyStoreInvalidStateException extends __SmithyException, $MetadataBearer {
-    name: "CustomKeyStoreInvalidStateException";
-    $fault: "client";
-    message?: string;
+export declare class CustomKeyStoreInvalidStateException extends __BaseException {
+    readonly name: "CustomKeyStoreInvalidStateException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CustomKeyStoreInvalidStateException, __BaseException>);
 }
 /**
  * <p>The request was rejected because KMS cannot find a custom key store with the specified
  *       key store name or ID.</p>
  */
-export interface CustomKeyStoreNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "CustomKeyStoreNotFoundException";
-    $fault: "client";
-    message?: string;
+export declare class CustomKeyStoreNotFoundException extends __BaseException {
+    readonly name: "CustomKeyStoreNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CustomKeyStoreNotFoundException, __BaseException>);
 }
 export declare enum ConnectionErrorCodeType {
     CLUSTER_NOT_FOUND = "CLUSTER_NOT_FOUND",
@@ -340,19 +380,25 @@ export declare namespace CreateAliasRequest {
 /**
  * <p>The request was rejected because the specified alias name is not valid.</p>
  */
-export interface InvalidAliasNameException extends __SmithyException, $MetadataBearer {
-    name: "InvalidAliasNameException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidAliasNameException extends __BaseException {
+    readonly name: "InvalidAliasNameException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidAliasNameException, __BaseException>);
 }
 /**
  * <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
  *       <i>Key Management Service Developer Guide</i>.</p>
  */
-export interface LimitExceededException extends __SmithyException, $MetadataBearer {
-    name: "LimitExceededException";
-    $fault: "client";
-    message?: string;
+export declare class LimitExceededException extends __BaseException {
+    readonly name: "LimitExceededException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 export interface CreateCustomKeyStoreRequest {
     /**
@@ -405,10 +451,13 @@ export declare namespace CreateCustomKeyStoreResponse {
  *       to another custom key store in the account. Try again with a custom key store name that is
  *       unique in the account.</p>
  */
-export interface CustomKeyStoreNameInUseException extends __SmithyException, $MetadataBearer {
-    name: "CustomKeyStoreNameInUseException";
-    $fault: "client";
-    message?: string;
+export declare class CustomKeyStoreNameInUseException extends __BaseException {
+    readonly name: "CustomKeyStoreNameInUseException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CustomKeyStoreNameInUseException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the trust anchor certificate in the request is not the
@@ -416,10 +465,13 @@ export interface CustomKeyStoreNameInUseException extends __SmithyException, $Me
  *          <p>When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create the trust anchor certificate and save it in the
  *         <code>customerCA.crt</code> file.</p>
  */
-export interface IncorrectTrustAnchorException extends __SmithyException, $MetadataBearer {
-    name: "IncorrectTrustAnchorException";
-    $fault: "client";
-    message?: string;
+export declare class IncorrectTrustAnchorException extends __BaseException {
+    readonly name: "IncorrectTrustAnchorException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IncorrectTrustAnchorException, __BaseException>);
 }
 /**
  * <p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request
@@ -605,18 +657,24 @@ export declare namespace CreateGrantResponse {
 /**
  * <p>The request was rejected because the specified KMS key is not enabled.</p>
  */
-export interface DisabledException extends __SmithyException, $MetadataBearer {
-    name: "DisabledException";
-    $fault: "client";
-    message?: string;
+export declare class DisabledException extends __BaseException {
+    readonly name: "DisabledException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<DisabledException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified grant token is not valid.</p>
  */
-export interface InvalidGrantTokenException extends __SmithyException, $MetadataBearer {
-    name: "InvalidGrantTokenException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidGrantTokenException extends __BaseException {
+    readonly name: "InvalidGrantTokenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidGrantTokenException, __BaseException>);
 }
 export declare enum CustomerMasterKeySpec {
     ECC_NIST_P256 = "ECC_NIST_P256",
@@ -1174,27 +1232,36 @@ export declare namespace CreateKeyResponse {
  * <p>The request was rejected because the specified policy is not syntactically or semantically
  *       correct.</p>
  */
-export interface MalformedPolicyDocumentException extends __SmithyException, $MetadataBearer {
-    name: "MalformedPolicyDocumentException";
-    $fault: "client";
-    message?: string;
+export declare class MalformedPolicyDocumentException extends __BaseException {
+    readonly name: "MalformedPolicyDocumentException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
 }
 /**
  * <p>The request was rejected because one or more tags are not valid.</p>
  */
-export interface TagException extends __SmithyException, $MetadataBearer {
-    name: "TagException";
-    $fault: "client";
-    message?: string;
+export declare class TagException extends __BaseException {
+    readonly name: "TagException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<TagException, __BaseException>);
 }
 /**
  * <p>The request was rejected because a specified parameter is not supported or a specified
  *       resource is not valid for this operation.</p>
  */
-export interface UnsupportedOperationException extends __SmithyException, $MetadataBearer {
-    name: "UnsupportedOperationException";
-    $fault: "client";
-    message?: string;
+export declare class UnsupportedOperationException extends __BaseException {
+    readonly name: "UnsupportedOperationException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the custom key store contains KMS keys. After verifying
@@ -1202,10 +1269,13 @@ export interface UnsupportedOperationException extends __SmithyException, $Metad
  *       operation to delete the KMS keys. After they are deleted, you can delete the custom key
  *       store.</p>
  */
-export interface CustomKeyStoreHasCMKsException extends __SmithyException, $MetadataBearer {
-    name: "CustomKeyStoreHasCMKsException";
-    $fault: "client";
-    message?: string;
+export declare class CustomKeyStoreHasCMKsException extends __BaseException {
+    readonly name: "CustomKeyStoreHasCMKsException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<CustomKeyStoreHasCMKsException, __BaseException>);
 }
 /**
  * <p>Contains information about each custom key store in the custom key store list.</p>
@@ -1438,10 +1508,13 @@ export declare namespace DecryptResponse {
  *       in a <a>ReEncrypt</a> request must identify the same KMS key that was used to
  *       encrypt the ciphertext.</p>
  */
-export interface IncorrectKeyException extends __SmithyException, $MetadataBearer {
-    name: "IncorrectKeyException";
-    $fault: "client";
-    message?: string;
+export declare class IncorrectKeyException extends __BaseException {
+    readonly name: "IncorrectKeyException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IncorrectKeyException, __BaseException>);
 }
 /**
  * <p>From the <a>Decrypt</a> or <a>ReEncrypt</a> operation, the request
@@ -1451,10 +1524,13 @@ export interface IncorrectKeyException extends __SmithyException, $MetadataBeare
  *          <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
  *       KMS could not decrypt the encrypted (wrapped) key material. </p>
  */
-export interface InvalidCiphertextException extends __SmithyException, $MetadataBearer {
-    name: "InvalidCiphertextException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidCiphertextException extends __BaseException {
+    readonly name: "InvalidCiphertextException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidCiphertextException, __BaseException>);
 }
 /**
  * <p>The request was rejected for one of the following reasons: </p>
@@ -1475,19 +1551,25 @@ export interface InvalidCiphertextException extends __SmithyException, $Metadata
  *          <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
  *         <a>DescribeKey</a> operation.</p>
  */
-export interface InvalidKeyUsageException extends __SmithyException, $MetadataBearer {
-    name: "InvalidKeyUsageException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidKeyUsageException extends __BaseException {
+    readonly name: "InvalidKeyUsageException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidKeyUsageException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified KMS key was not available. You can retry
  *       the request.</p>
  */
-export interface KeyUnavailableException extends __SmithyException, $MetadataBearer {
-    name: "KeyUnavailableException";
-    $fault: "server";
-    message?: string;
+export declare class KeyUnavailableException extends __BaseException {
+    readonly name: "KeyUnavailableException";
+    readonly $fault: "server";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KeyUnavailableException, __BaseException>);
 }
 export interface DeleteAliasRequest {
     /**
@@ -1614,10 +1696,13 @@ export declare namespace DescribeCustomKeyStoresResponse {
  * <p>The request was rejected because the marker that specifies where pagination should next
  *       begin is not valid.</p>
  */
-export interface InvalidMarkerException extends __SmithyException, $MetadataBearer {
-    name: "InvalidMarkerException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidMarkerException extends __BaseException {
+    readonly name: "InvalidMarkerException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidMarkerException, __BaseException>);
 }
 export interface DescribeKeyRequest {
     /**
@@ -1883,10 +1968,13 @@ export declare namespace EncryptResponse {
  * <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>
  */
-export interface ExpiredImportTokenException extends __SmithyException, $MetadataBearer {
-    name: "ExpiredImportTokenException";
-    $fault: "client";
-    message?: string;
+export declare class ExpiredImportTokenException extends __BaseException {
+    readonly name: "ExpiredImportTokenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ExpiredImportTokenException, __BaseException>);
 }
 export interface GenerateDataKeyRequest {
     /**
@@ -2609,27 +2697,36 @@ export declare namespace ImportKeyMaterialResponse {
  * <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>
  */
-export interface IncorrectKeyMaterialException extends __SmithyException, $MetadataBearer {
-    name: "IncorrectKeyMaterialException";
-    $fault: "client";
-    message?: string;
+export declare class IncorrectKeyMaterialException extends __BaseException {
+    readonly name: "IncorrectKeyMaterialException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<IncorrectKeyMaterialException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the provided import token is invalid or is associated
  *       with a different KMS key.</p>
  */
-export interface InvalidImportTokenException extends __SmithyException, $MetadataBearer {
-    name: "InvalidImportTokenException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidImportTokenException extends __BaseException {
+    readonly name: "InvalidImportTokenException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidImportTokenException, __BaseException>);
 }
 /**
  * <p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>
  */
-export interface InvalidGrantIdException extends __SmithyException, $MetadataBearer {
-    name: "InvalidGrantIdException";
-    $fault: "client";
-    message?: string;
+export declare class InvalidGrantIdException extends __BaseException {
+    readonly name: "InvalidGrantIdException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidGrantIdException, __BaseException>);
 }
 /**
  * <p>Contains information about each entry in the key list.</p>
@@ -2655,10 +2752,13 @@ export declare namespace KeyListEntry {
  *       fails when it cannot confirm that signature was produced by signing the specified message with
  *       the specified KMS key and signing algorithm.</p>
  */
-export interface KMSInvalidSignatureException extends __SmithyException, $MetadataBearer {
-    name: "KMSInvalidSignatureException";
-    $fault: "client";
-    message?: string;
+export declare class KMSInvalidSignatureException extends __BaseException {
+    readonly name: "KMSInvalidSignatureException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KMSInvalidSignatureException, __BaseException>);
 }
 export interface ListAliasesRequest {
     /**