@aws-sdk/client-kms 3.131.0 → 3.132.0

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

@@ -319,6 +319,7 @@ export declare class CustomKeyStoreNotFoundException extends __BaseException {
 export declare enum ConnectionErrorCodeType {
     CLUSTER_NOT_FOUND = "CLUSTER_NOT_FOUND",
     INSUFFICIENT_CLOUDHSM_HSMS = "INSUFFICIENT_CLOUDHSM_HSMS",
+    INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET = "INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET",
     INTERNAL_ERROR = "INTERNAL_ERROR",
     INVALID_CREDENTIALS = "INVALID_CREDENTIALS",
     NETWORK_ERRORS = "NETWORK_ERRORS",
@@ -410,12 +411,12 @@ export interface CreateCustomKeyStoreRequest {
      *       CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,
      *       use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
      */
-    CloudHsmClusterId: string | undefined;
+    CloudHsmClusterId?: string;
     /**
      * <p>Enter the content of the trust anchor certificate for the cluster. This is the content of
      *       the <code>customerCA.crt</code> file that you created when you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html">initialized the cluster</a>.</p>
      */
-    TrustAnchorCertificate: string | undefined;
+    TrustAnchorCertificate?: string;
     /**
      * <p>Enter the password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
      *                <code>kmsuser</code> crypto user
@@ -425,7 +426,7 @@ export interface CreateCustomKeyStoreRequest {
      *          <p>This parameter tells KMS the <code>kmsuser</code> account password; it does not change
      *       the password in the CloudHSM cluster.</p>
      */
-    KeyStorePassword: string | undefined;
+    KeyStorePassword?: string;
 }
 export declare namespace CreateCustomKeyStoreRequest {
     /**
@@ -691,6 +692,7 @@ export declare enum CustomerMasterKeySpec {
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
     RSA_4096 = "RSA_4096",
+    SM2 = "SM2",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum KeySpec {
@@ -705,6 +707,7 @@ export declare enum KeySpec {
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
     RSA_4096 = "RSA_4096",
+    SM2 = "SM2",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum KeyUsageType {
@@ -765,23 +768,20 @@ export interface CreateKeyRequest {
      *             </li>
      *          </ul>
      *
-     *          <p>A key policy document must conform to the following rules.</p>
+     *          <p>A key policy document can include only the following characters:</p>
      *          <ul>
      *             <li>
-     *                <p>Up to 32 kilobytes (32768 bytes)</p>
+     *                <p>Printable ASCII characters from the space character (<code>\u0020</code>) through the end of the ASCII character range.</p>
      *             </li>
      *             <li>
-     *                <p>Must be UTF-8 encoded</p>
+     *                <p>Printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\u00FF</code>).</p>
      *             </li>
      *             <li>
-     *                <p>The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.</p>
-     *             </li>
-     *             <li>
-     *                <p>The <code>Sid</code> element in a key policy statement can include spaces. (Spaces are
-     *             prohibited in the <code>Sid</code> element of an IAM policy document.)</p>
+     *                <p>The tab (<code>\u0009</code>), line feed (<code>\u000A</code>), and carriage return (<code>\u000D</code>) special characters</p>
      *             </li>
      *          </ul>
-     *          <p>For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
+     *          <p>For information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key policies in KMS</a> in the
+     *       <i>Key Management Service Developer Guide</i>. For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
      *                <i>Identity and Access Management User Guide</i>
      *             </i>.</p>
      */
@@ -815,6 +815,10 @@ export interface CreateKeyRequest {
      *                <p>For asymmetric KMS keys with ECC key material, specify
      *           <code>SIGN_VERIFY</code>.</p>
      *             </li>
+     *             <li>
+     *                <p>For asymmetric KMS keys with SM2 key material (China Regions only), specify <code>ENCRYPT_DECRYPT</code> or
+     *           <code>SIGN_VERIFY</code>.</p>
+     *             </li>
      *          </ul>
      */
     KeyUsage?: KeyUsageType | string;
@@ -829,8 +833,8 @@ export interface CreateKeyRequest {
     CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
     /**
      * <p>Specifies the type of KMS key to create. The default value,
-     *       <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit symmetric key for encryption
-     *       and decryption. For help choosing a key spec for your KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose">Choosing a KMS key type</a> in the <i>
+     *       <code>SYMMETRIC_DEFAULT</code>, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions,
+     *       where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose">Choosing a KMS key type</a> in the <i>
      *                <i>Key Management Service Developer Guide</i>
      *             </i>.</p>
      *          <p>The <code>KeySpec</code> determines whether the KMS key contains a symmetric key or an
@@ -853,7 +857,8 @@ export interface CreateKeyRequest {
      *                <ul>
      *                   <li>
      *                      <p>
-     *                         <code>SYMMETRIC_DEFAULT</code> (AES-256-GCM)</p>
+     *                         <code>SYMMETRIC_DEFAULT</code>
+     *                      </p>
      *                   </li>
      *                </ul>
      *             </li>
@@ -929,6 +934,16 @@ export interface CreateKeyRequest {
      *                   </li>
      *                </ul>
      *             </li>
+     *             <li>
+     *                <p>SM2 key pairs (China Regions only)</p>
+     *                <ul>
+     *                   <li>
+     *                      <p>
+     *                         <code>SM2</code>
+     *                      </p>
+     *                   </li>
+     *                </ul>
+     *             </li>
      *          </ul>
      */
     KeySpec?: KeySpec | string;
@@ -956,7 +971,7 @@ export interface CreateKeyRequest {
      *       cannot create any other type of KMS key in a custom key store.</p>
      *          <p>To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
      *          <p>The response includes the custom key store ID and the ID of the CloudHSM cluster.</p>
-     *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
+     *          <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store feature</a> feature in KMS, which
      * combines the convenience and extensive integration of KMS with the isolation and control of a
      * single-tenant key store.</p>
      */
@@ -1018,6 +1033,7 @@ export declare namespace CreateKeyRequest {
 export declare enum EncryptionAlgorithmSpec {
     RSAES_OAEP_SHA_1 = "RSAES_OAEP_SHA_1",
     RSAES_OAEP_SHA_256 = "RSAES_OAEP_SHA_256",
+    SM2PKE = "SM2PKE",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum ExpirationModelType {
@@ -1105,7 +1121,8 @@ export declare enum SigningAlgorithmSpec {
     RSASSA_PKCS1_V1_5_SHA_512 = "RSASSA_PKCS1_V1_5_SHA_512",
     RSASSA_PSS_SHA_256 = "RSASSA_PSS_SHA_256",
     RSASSA_PSS_SHA_384 = "RSASSA_PSS_SHA_384",
-    RSASSA_PSS_SHA_512 = "RSASSA_PSS_SHA_512"
+    RSASSA_PSS_SHA_512 = "RSASSA_PSS_SHA_512",
+    SM2DSA = "SM2DSA"
 }
 /**
  * <p>Contains metadata about a KMS key.</p>
@@ -1469,7 +1486,8 @@ export declare enum DataKeyPairSpec {
     ECC_SECG_P256K1 = "ECC_SECG_P256K1",
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
-    RSA_4096 = "RSA_4096"
+    RSA_4096 = "RSA_4096",
+    SM2 = "SM2"
 }
 export declare enum DataKeySpec {
     AES_128 = "AES_128",
@@ -2171,7 +2189,7 @@ export interface GenerateDataKeyPairRequest {
     KeyId: string | undefined;
     /**
      * <p>Determines the type of data key pair that is generated. </p>
-     *          <p>The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.</p>
+     *          <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.</p>
      */
     KeyPairSpec: DataKeyPairSpec | string | undefined;
     /**
@@ -2256,7 +2274,7 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
     KeyId: string | undefined;
     /**
      * <p>Determines the type of data key pair that is generated.</p>
-     *          <p>The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.</p>
+     *          <p>The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions. RSA and ECC asymmetric key pairs are also available in China Regions.</p>
      */
     KeyPairSpec: DataKeyPairSpec | string | undefined;
     /**
@@ -2432,7 +2450,7 @@ export declare namespace GenerateMacResponse {
 }
 export interface GenerateRandomRequest {
     /**
-     * <p>The length of the byte string.</p>
+     * <p>The length of the random byte string. This parameter is required.</p>
      */
     NumberOfBytes?: number;
     /**
@@ -3296,22 +3314,22 @@ export interface PutKeyPolicyRequest {
      *             </li>
      *          </ul>
      *
-     *          <p>A key policy document must conform to the following rules.</p>
+     *          <p>A key policy document can include only the following characters:</p>
      *          <ul>
      *             <li>
-     *                <p>Up to 32 kilobytes (32768 bytes)</p>
-     *             </li>
-     *             <li>
-     *                <p>Must be UTF-8 encoded</p>
+     *                <p>Printable ASCII characters from the space character (<code>\u0020</code>) through the end of the ASCII character range.</p>
      *             </li>
      *             <li>
-     *                <p>The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.</p>
+     *                <p>Printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\u00FF</code>).</p>
      *             </li>
      *             <li>
-     *                <p>The <code>Sid</code> element in a key policy statement can include spaces. (Spaces are
-     *             prohibited in the <code>Sid</code> element of an IAM policy document.)</p>
+     *                <p>The tab (<code>\u0009</code>), line feed (<code>\u000A</code>), and carriage return (<code>\u000D</code>) special characters</p>
      *             </li>
      *          </ul>
+     *          <p>For information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key policies in KMS</a> in the
+     *       <i>Key Management Service Developer Guide</i>. For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
+     *                <i>Identity and Access Management User Guide</i>
+     *             </i>.</p>
      */
     Policy: string | undefined;
     /**
@@ -3550,22 +3568,22 @@ export interface ReplicateKeyRequest {
      *          </ul>
      *
      *
-     *          <p>A key policy document must conform to the following rules.</p>
+     *          <p>A key policy document can include only the following characters:</p>
      *          <ul>
      *             <li>
-     *                <p>Up to 32 kilobytes (32768 bytes)</p>
-     *             </li>
-     *             <li>
-     *                <p>Must be UTF-8 encoded</p>
+     *                <p>Printable ASCII characters from the space character (<code>\u0020</code>) through the end of the ASCII character range.</p>
      *             </li>
      *             <li>
-     *                <p>The only Unicode characters that are permitted in a key policy document are the horizontal tab (U+0009), linefeed (U+000A), carriage return (U+000D), and characters in the range U+0020 to U+00FF.</p>
+     *                <p>Printable characters in the Basic Latin and Latin-1 Supplement character set (through <code>\u00FF</code>).</p>
      *             </li>
      *             <li>
-     *                <p>The <code>Sid</code> element in a key policy statement can include spaces. (Spaces are
-     *             prohibited in the <code>Sid</code> element of an IAM policy document.)</p>
+     *                <p>The tab (<code>\u0009</code>), line feed (<code>\u000A</code>), and carriage return (<code>\u000D</code>) special characters</p>
      *             </li>
      *          </ul>
+     *          <p>For information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key policies in KMS</a> in the
+     *       <i>Key Management Service Developer Guide</i>. For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
+     *                <i>Identity and Access Management User Guide</i>
+     *             </i>.</p>
      */
     Policy?: string;
     /**
@@ -3935,7 +3953,7 @@ export interface UpdateAliasRequest {
     /**
      * <p>Identifies the alias that is changing its KMS key. This value must begin with
      *         <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You
-     *       cannot use UpdateAlias to change the alias name.</p>
+     *       cannot use <code>UpdateAlias</code> to change the alias name.</p>
      */
     AliasName: string | undefined;
     /**

package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput } from "../commands/DescribeCustomKeyStoresCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateDescribeCustomKeyStores(config: KMSPaginationConfiguration, input: DescribeCustomKeyStoresCommandInput, ...additionalArguments: any): Paginator<DescribeCustomKeyStoresCommandOutput>;

package/dist-types/pagination/ListResourceTagsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListResourceTagsCommandInput, ListResourceTagsCommandOutput } from "../commands/ListResourceTagsCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateListResourceTags(config: KMSPaginationConfiguration, input: ListResourceTagsCommandInput, ...additionalArguments: any): Paginator<ListResourceTagsCommandOutput>;

package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput } from "../commands/ListRetirableGrantsCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateListRetirableGrants(config: KMSPaginationConfiguration, input: ListRetirableGrantsCommandInput, ...additionalArguments: any): Paginator<ListRetirableGrantsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -1,5 +1,8 @@
+export * from "./DescribeCustomKeyStoresPaginator";
 export * from "./Interfaces";
 export * from "./ListAliasesPaginator";
 export * from "./ListGrantsPaginator";
 export * from "./ListKeyPoliciesPaginator";
 export * from "./ListKeysPaginator";
+export * from "./ListResourceTagsPaginator";
+export * from "./ListRetirableGrantsPaginator";

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

@@ -146,6 +146,7 @@ export declare class CustomKeyStoreNotFoundException extends __BaseException {
 export declare enum ConnectionErrorCodeType {
     CLUSTER_NOT_FOUND = "CLUSTER_NOT_FOUND",
     INSUFFICIENT_CLOUDHSM_HSMS = "INSUFFICIENT_CLOUDHSM_HSMS",
+    INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET = "INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET",
     INTERNAL_ERROR = "INTERNAL_ERROR",
     INVALID_CREDENTIALS = "INVALID_CREDENTIALS",
     NETWORK_ERRORS = "NETWORK_ERRORS",
@@ -189,11 +190,11 @@ export interface CreateCustomKeyStoreRequest {
     
     CustomKeyStoreName: string | undefined;
     
-    CloudHsmClusterId: string | undefined;
+    CloudHsmClusterId?: string;
     
-    TrustAnchorCertificate: string | undefined;
+    TrustAnchorCertificate?: string;
     
-    KeyStorePassword: string | undefined;
+    KeyStorePassword?: string;
 }
 export declare namespace CreateCustomKeyStoreRequest {
     
@@ -306,6 +307,7 @@ export declare enum CustomerMasterKeySpec {
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
     RSA_4096 = "RSA_4096",
+    SM2 = "SM2",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum KeySpec {
@@ -320,6 +322,7 @@ export declare enum KeySpec {
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
     RSA_4096 = "RSA_4096",
+    SM2 = "SM2",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum KeyUsageType {
@@ -372,6 +375,7 @@ export declare namespace CreateKeyRequest {
 export declare enum EncryptionAlgorithmSpec {
     RSAES_OAEP_SHA_1 = "RSAES_OAEP_SHA_1",
     RSAES_OAEP_SHA_256 = "RSAES_OAEP_SHA_256",
+    SM2PKE = "SM2PKE",
     SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
 }
 export declare enum ExpirationModelType {
@@ -435,7 +439,8 @@ export declare enum SigningAlgorithmSpec {
     RSASSA_PKCS1_V1_5_SHA_512 = "RSASSA_PKCS1_V1_5_SHA_512",
     RSASSA_PSS_SHA_256 = "RSASSA_PSS_SHA_256",
     RSASSA_PSS_SHA_384 = "RSASSA_PSS_SHA_384",
-    RSASSA_PSS_SHA_512 = "RSASSA_PSS_SHA_512"
+    RSASSA_PSS_SHA_512 = "RSASSA_PSS_SHA_512",
+    SM2DSA = "SM2DSA"
 }
 
 export interface KeyMetadata {
@@ -554,7 +559,8 @@ export declare enum DataKeyPairSpec {
     ECC_SECG_P256K1 = "ECC_SECG_P256K1",
     RSA_2048 = "RSA_2048",
     RSA_3072 = "RSA_3072",
-    RSA_4096 = "RSA_4096"
+    RSA_4096 = "RSA_4096",
+    SM2 = "SM2"
 }
 export declare enum DataKeySpec {
     AES_128 = "AES_128",

package/dist-types/ts3.4/pagination/DescribeCustomKeyStoresPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { DescribeCustomKeyStoresCommandInput, DescribeCustomKeyStoresCommandOutput } from "../commands/DescribeCustomKeyStoresCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateDescribeCustomKeyStores(config: KMSPaginationConfiguration, input: DescribeCustomKeyStoresCommandInput, ...additionalArguments: any): Paginator<DescribeCustomKeyStoresCommandOutput>;

package/dist-types/ts3.4/pagination/ListResourceTagsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListResourceTagsCommandInput, ListResourceTagsCommandOutput } from "../commands/ListResourceTagsCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateListResourceTags(config: KMSPaginationConfiguration, input: ListResourceTagsCommandInput, ...additionalArguments: any): Paginator<ListResourceTagsCommandOutput>;

package/dist-types/ts3.4/pagination/ListRetirableGrantsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListRetirableGrantsCommandInput, ListRetirableGrantsCommandOutput } from "../commands/ListRetirableGrantsCommand";
+import { KMSPaginationConfiguration } from "./Interfaces";
+export declare function paginateListRetirableGrants(config: KMSPaginationConfiguration, input: ListRetirableGrantsCommandInput, ...additionalArguments: any): Paginator<ListRetirableGrantsCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -1,5 +1,8 @@
+export * from "./DescribeCustomKeyStoresPaginator";
 export * from "./Interfaces";
 export * from "./ListAliasesPaginator";
 export * from "./ListGrantsPaginator";
 export * from "./ListKeyPoliciesPaginator";
 export * from "./ListKeysPaginator";
+export * from "./ListResourceTagsPaginator";
+export * from "./ListRetirableGrantsPaginator";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-kms",
   "description": "AWS SDK for JavaScript Kms Client for Node.js, Browser and React Native",
-  "version": "3.131.0",
+  "version": "3.132.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",