@aws-sdk/client-kms 3.131.0 → 3.141.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/README.md +1 -1
  3. package/dist-cjs/commands/CancelKeyDeletionCommand.js +2 -2
  4. package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +2 -2
  5. package/dist-cjs/commands/CreateAliasCommand.js +1 -1
  6. package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +2 -2
  7. package/dist-cjs/commands/CreateGrantCommand.js +2 -2
  8. package/dist-cjs/commands/CreateKeyCommand.js +2 -2
  9. package/dist-cjs/commands/DecryptCommand.js +2 -2
  10. package/dist-cjs/commands/DeleteAliasCommand.js +1 -1
  11. package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +2 -2
  12. package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +1 -1
  13. package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +2 -2
  14. package/dist-cjs/commands/DescribeKeyCommand.js +2 -2
  15. package/dist-cjs/commands/DisableKeyCommand.js +1 -1
  16. package/dist-cjs/commands/DisableKeyRotationCommand.js +1 -1
  17. package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +2 -2
  18. package/dist-cjs/commands/EnableKeyCommand.js +1 -1
  19. package/dist-cjs/commands/EnableKeyRotationCommand.js +1 -1
  20. package/dist-cjs/commands/EncryptCommand.js +2 -2
  21. package/dist-cjs/commands/GenerateDataKeyCommand.js +2 -2
  22. package/dist-cjs/commands/GenerateDataKeyPairCommand.js +2 -2
  23. package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +2 -2
  24. package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +2 -2
  25. package/dist-cjs/commands/GenerateMacCommand.js +2 -2
  26. package/dist-cjs/commands/GenerateRandomCommand.js +2 -2
  27. package/dist-cjs/commands/GetKeyPolicyCommand.js +2 -2
  28. package/dist-cjs/commands/GetKeyRotationStatusCommand.js +2 -2
  29. package/dist-cjs/commands/GetParametersForImportCommand.js +2 -2
  30. package/dist-cjs/commands/GetPublicKeyCommand.js +2 -2
  31. package/dist-cjs/commands/ImportKeyMaterialCommand.js +2 -2
  32. package/dist-cjs/commands/ListAliasesCommand.js +2 -2
  33. package/dist-cjs/commands/ListGrantsCommand.js +2 -2
  34. package/dist-cjs/commands/ListKeyPoliciesCommand.js +2 -2
  35. package/dist-cjs/commands/ListKeysCommand.js +2 -2
  36. package/dist-cjs/commands/ListResourceTagsCommand.js +2 -2
  37. package/dist-cjs/commands/ListRetirableGrantsCommand.js +2 -2
  38. package/dist-cjs/commands/PutKeyPolicyCommand.js +1 -1
  39. package/dist-cjs/commands/ReEncryptCommand.js +2 -2
  40. package/dist-cjs/commands/ReplicateKeyCommand.js +2 -2
  41. package/dist-cjs/commands/RetireGrantCommand.js +1 -1
  42. package/dist-cjs/commands/RevokeGrantCommand.js +1 -1
  43. package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +2 -2
  44. package/dist-cjs/commands/SignCommand.js +2 -2
  45. package/dist-cjs/commands/TagResourceCommand.js +1 -1
  46. package/dist-cjs/commands/UntagResourceCommand.js +1 -1
  47. package/dist-cjs/commands/UpdateAliasCommand.js +1 -1
  48. package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +2 -2
  49. package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +1 -1
  50. package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +1 -1
  51. package/dist-cjs/commands/VerifyCommand.js +2 -2
  52. package/dist-cjs/commands/VerifyMacCommand.js +2 -2
  53. package/dist-cjs/models/models_0.js +393 -573
  54. package/dist-cjs/pagination/DescribeCustomKeyStoresPaginator.js +36 -0
  55. package/dist-cjs/pagination/ListResourceTagsPaginator.js +36 -0
  56. package/dist-cjs/pagination/ListRetirableGrantsPaginator.js +36 -0
  57. package/dist-cjs/pagination/index.js +3 -0
  58. package/dist-es/commands/CancelKeyDeletionCommand.js +3 -3
  59. package/dist-es/commands/ConnectCustomKeyStoreCommand.js +3 -3
  60. package/dist-es/commands/CreateAliasCommand.js +2 -2
  61. package/dist-es/commands/CreateCustomKeyStoreCommand.js +3 -3
  62. package/dist-es/commands/CreateGrantCommand.js +3 -3
  63. package/dist-es/commands/CreateKeyCommand.js +3 -3
  64. package/dist-es/commands/DecryptCommand.js +3 -3
  65. package/dist-es/commands/DeleteAliasCommand.js +2 -2
  66. package/dist-es/commands/DeleteCustomKeyStoreCommand.js +3 -3
  67. package/dist-es/commands/DeleteImportedKeyMaterialCommand.js +2 -2
  68. package/dist-es/commands/DescribeCustomKeyStoresCommand.js +3 -3
  69. package/dist-es/commands/DescribeKeyCommand.js +3 -3
  70. package/dist-es/commands/DisableKeyCommand.js +2 -2
  71. package/dist-es/commands/DisableKeyRotationCommand.js +2 -2
  72. package/dist-es/commands/DisconnectCustomKeyStoreCommand.js +3 -3
  73. package/dist-es/commands/EnableKeyCommand.js +2 -2
  74. package/dist-es/commands/EnableKeyRotationCommand.js +2 -2
  75. package/dist-es/commands/EncryptCommand.js +3 -3
  76. package/dist-es/commands/GenerateDataKeyCommand.js +3 -3
  77. package/dist-es/commands/GenerateDataKeyPairCommand.js +3 -3
  78. package/dist-es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +3 -3
  79. package/dist-es/commands/GenerateDataKeyWithoutPlaintextCommand.js +3 -3
  80. package/dist-es/commands/GenerateMacCommand.js +3 -3
  81. package/dist-es/commands/GenerateRandomCommand.js +3 -3
  82. package/dist-es/commands/GetKeyPolicyCommand.js +3 -3
  83. package/dist-es/commands/GetKeyRotationStatusCommand.js +3 -3
  84. package/dist-es/commands/GetParametersForImportCommand.js +3 -3
  85. package/dist-es/commands/GetPublicKeyCommand.js +3 -3
  86. package/dist-es/commands/ImportKeyMaterialCommand.js +3 -3
  87. package/dist-es/commands/ListAliasesCommand.js +3 -3
  88. package/dist-es/commands/ListGrantsCommand.js +3 -3
  89. package/dist-es/commands/ListKeyPoliciesCommand.js +3 -3
  90. package/dist-es/commands/ListKeysCommand.js +3 -3
  91. package/dist-es/commands/ListResourceTagsCommand.js +3 -3
  92. package/dist-es/commands/ListRetirableGrantsCommand.js +3 -3
  93. package/dist-es/commands/PutKeyPolicyCommand.js +2 -2
  94. package/dist-es/commands/ReEncryptCommand.js +3 -3
  95. package/dist-es/commands/ReplicateKeyCommand.js +3 -3
  96. package/dist-es/commands/RetireGrantCommand.js +2 -2
  97. package/dist-es/commands/RevokeGrantCommand.js +2 -2
  98. package/dist-es/commands/ScheduleKeyDeletionCommand.js +3 -3
  99. package/dist-es/commands/SignCommand.js +3 -3
  100. package/dist-es/commands/TagResourceCommand.js +2 -2
  101. package/dist-es/commands/UntagResourceCommand.js +2 -2
  102. package/dist-es/commands/UpdateAliasCommand.js +2 -2
  103. package/dist-es/commands/UpdateCustomKeyStoreCommand.js +3 -3
  104. package/dist-es/commands/UpdateKeyDescriptionCommand.js +2 -2
  105. package/dist-es/commands/UpdatePrimaryRegionCommand.js +2 -2
  106. package/dist-es/commands/VerifyCommand.js +3 -3
  107. package/dist-es/commands/VerifyMacCommand.js +3 -3
  108. package/dist-es/models/models_0.js +99 -372
  109. package/dist-es/pagination/DescribeCustomKeyStoresPaginator.js +75 -0
  110. package/dist-es/pagination/ListResourceTagsPaginator.js +75 -0
  111. package/dist-es/pagination/ListRetirableGrantsPaginator.js +75 -0
  112. package/dist-es/pagination/index.js +3 -0
  113. package/dist-types/KMS.d.ts +49 -27
  114. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +1 -1
  115. package/dist-types/commands/CreateKeyCommand.d.ts +5 -3
  116. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +2 -2
  117. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +1 -1
  118. package/dist-types/commands/DescribeKeyCommand.d.ts +1 -1
  119. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +1 -1
  120. package/dist-types/commands/EncryptCommand.d.ts +5 -1
  121. package/dist-types/commands/GenerateDataKeyCommand.d.ts +12 -6
  122. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +3 -3
  123. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +3 -3
  124. package/dist-types/commands/GenerateRandomCommand.d.ts +4 -1
  125. package/dist-types/commands/GetPublicKeyCommand.d.ts +5 -2
  126. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +1 -1
  127. package/dist-types/commands/VerifyCommand.d.ts +5 -1
  128. package/dist-types/models/models_0.d.ts +428 -596
  129. package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +4 -0
  130. package/dist-types/pagination/ListResourceTagsPaginator.d.ts +4 -0
  131. package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +4 -0
  132. package/dist-types/pagination/index.d.ts +3 -0
  133. package/dist-types/ts3.4/models/models_0.d.ts +197 -377
  134. package/dist-types/ts3.4/pagination/DescribeCustomKeyStoresPaginator.d.ts +4 -0
  135. package/dist-types/ts3.4/pagination/ListResourceTagsPaginator.d.ts +4 -0
  136. package/dist-types/ts3.4/pagination/ListRetirableGrantsPaginator.d.ts +4 -0
  137. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  138. package/package.json +6 -6
@@ -20,9 +20,9 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput extends Genera
20
20
  * custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
21
21
  * operation. </p>
22
22
  * <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
23
- * key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
24
- * either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
25
- * the use of data key pairs outside of KMS.</p>
23
+ * key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you
24
+ * use ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not
25
+ * both. However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.</p>
26
26
  * <p>
27
27
  * <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
28
28
  * request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
@@ -8,13 +8,16 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
8
8
  }
9
9
  /**
10
10
  * <p>Returns a random byte string that is cryptographically secure.</p>
11
+ * <p>You must use the <code>NumberOfBytes</code> parameter to specify the length of the random
12
+ * byte string. There is no default value for string length.</p>
11
13
  * <p>By default, the random byte string is generated in KMS. To generate the byte string in
12
14
  * the CloudHSM cluster that is associated with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, specify the custom key store
13
15
  * ID.</p>
14
16
  * <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
15
17
  * <p>For more information about entropy and random number generation, see
16
18
  * <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
17
- *
19
+ * <p>
20
+ * <b>Cross-account use</b>: Not applicable. <code>GenerateRandom</code> does not use any account-specific resources, such as KMS keys.</p>
18
21
  * <p>
19
22
  * <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateRandom</a> (IAM policy)</p>
20
23
  * @example
@@ -16,8 +16,11 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
16
16
  * KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the
17
17
  * public key within KMS, you benefit from the authentication, authorization, and logging that
18
18
  * are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
19
- * decrypted. These features are not effective outside of KMS. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations">Special
20
- * Considerations for Downloading Public Keys</a>.</p>
19
+ * decrypted. These features are not effective outside of KMS.</p>
20
+ * <p>To verify a signature outside of KMS with an SM2 public key (China Regions only), you must
21
+ * specify the distinguishing ID. By default, KMS uses <code>1234567812345678</code> as the
22
+ * distinguishing ID. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline verification
23
+ * with SM2 key pairs</a>.</p>
21
24
  * <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
22
25
  * important information about the public key in the response, including:</p>
23
26
  * <ul>
@@ -42,7 +42,7 @@ export interface UpdateCustomKeyStoreCommandOutput extends UpdateCustomKeyStoreR
42
42
  * </ul>
43
43
  * <p>If the operation succeeds, it returns a JSON object with no
44
44
  * properties.</p>
45
- * <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
45
+ * <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
46
46
  * combines the convenience and extensive integration of KMS with the isolation and control of a
47
47
  * single-tenant key store.</p>
48
48
  * <p>
@@ -22,7 +22,11 @@ export interface VerifyCommandOutput extends VerifyResponse, __MetadataBearer {
22
22
  * signature.</p>
23
23
  * <p>You can also verify the digital signature by using the public key of the KMS key outside
24
24
  * of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
25
- * asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
25
+ * asymmetric KMS key and then use the public key to verify the signature outside of KMS. To
26
+ * verify a signature outside of KMS with an SM2 public key, you must specify the distinguishing
27
+ * ID. By default, KMS uses <code>1234567812345678</code> as the distinguishing ID. For more
28
+ * information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification">Offline
29
+ * verification with SM2 key pairs</a> in <i>Key Management Service Developer Guide</i>. The
26
30
  * advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
27
31
  * a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
28
32
  * in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use