@aws-sdk/client-kms 3.823.0 → 3.825.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 (61) hide show
  1. package/dist-cjs/index.js +52 -6
  2. package/dist-es/models/models_0.js +17 -0
  3. package/dist-es/protocols/Aws_json1_1.js +22 -1
  4. package/dist-types/commands/CancelKeyDeletionCommand.d.ts +1 -1
  5. package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +4 -4
  6. package/dist-types/commands/CreateAliasCommand.d.ts +7 -7
  7. package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -7
  8. package/dist-types/commands/CreateGrantCommand.d.ts +8 -7
  9. package/dist-types/commands/CreateKeyCommand.d.ts +21 -20
  10. package/dist-types/commands/DecryptCommand.d.ts +17 -16
  11. package/dist-types/commands/DeleteAliasCommand.d.ts +1 -1
  12. package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +4 -4
  13. package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +14 -5
  14. package/dist-types/commands/DeriveSharedSecretCommand.d.ts +40 -33
  15. package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +3 -3
  16. package/dist-types/commands/DescribeKeyCommand.d.ts +79 -78
  17. package/dist-types/commands/DisableKeyCommand.d.ts +5 -6
  18. package/dist-types/commands/DisableKeyRotationCommand.d.ts +4 -4
  19. package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +4 -4
  20. package/dist-types/commands/EnableKeyCommand.d.ts +5 -4
  21. package/dist-types/commands/EnableKeyRotationCommand.d.ts +12 -14
  22. package/dist-types/commands/EncryptCommand.d.ts +5 -4
  23. package/dist-types/commands/GenerateDataKeyCommand.d.ts +5 -4
  24. package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +5 -4
  25. package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +5 -4
  26. package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +5 -4
  27. package/dist-types/commands/GenerateMacCommand.d.ts +3 -3
  28. package/dist-types/commands/GenerateRandomCommand.d.ts +2 -3
  29. package/dist-types/commands/GetKeyPolicyCommand.d.ts +1 -1
  30. package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +12 -11
  31. package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -7
  32. package/dist-types/commands/GetPublicKeyCommand.d.ts +8 -8
  33. package/dist-types/commands/ImportKeyMaterialCommand.d.ts +54 -38
  34. package/dist-types/commands/ListAliasesCommand.d.ts +4 -5
  35. package/dist-types/commands/ListGrantsCommand.d.ts +3 -3
  36. package/dist-types/commands/ListKeyPoliciesCommand.d.ts +1 -1
  37. package/dist-types/commands/ListKeyRotationsCommand.d.ts +22 -4
  38. package/dist-types/commands/ListKeysCommand.d.ts +1 -1
  39. package/dist-types/commands/ListResourceTagsCommand.d.ts +3 -3
  40. package/dist-types/commands/ListRetirableGrantsCommand.d.ts +3 -3
  41. package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -4
  42. package/dist-types/commands/ReEncryptCommand.d.ts +12 -13
  43. package/dist-types/commands/ReplicateKeyCommand.d.ts +10 -13
  44. package/dist-types/commands/RetireGrantCommand.d.ts +6 -7
  45. package/dist-types/commands/RevokeGrantCommand.d.ts +5 -5
  46. package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +33 -23
  47. package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +15 -15
  48. package/dist-types/commands/SignCommand.d.ts +19 -19
  49. package/dist-types/commands/TagResourceCommand.d.ts +6 -5
  50. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  51. package/dist-types/commands/UpdateAliasCommand.d.ts +4 -3
  52. package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +12 -12
  53. package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +1 -1
  54. package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -2
  55. package/dist-types/commands/VerifyCommand.d.ts +4 -4
  56. package/dist-types/commands/VerifyMacCommand.d.ts +3 -3
  57. package/dist-types/models/models_0.d.ts +423 -150
  58. package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -3
  59. package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +1 -1
  60. package/dist-types/ts3.4/models/models_0.d.ts +51 -1
  61. package/package.json +11 -11
@@ -27,17 +27,17 @@ declare const DisconnectCustomKeyStoreCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its backing key store. This operation disconnects an
30
+ * <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a> from its backing key store. This operation disconnects an
31
31
  * CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from
32
32
  * the external key store proxy that communicates with your external key manager.</p>
33
- * <p> This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> feature in KMS, which
33
+ * <p> This operation is part of the custom key stores feature in KMS, which
34
34
  * combines the convenience and extensive integration of KMS with the isolation and control of a
35
35
  * key store that you own and manage.</p>
36
36
  * <p>While a custom key store is disconnected, you can manage the custom key store and its KMS
37
37
  * keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any
38
38
  * time.</p>
39
39
  * <note>
40
- * <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will
40
+ * <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations">cryptographic operations</a> will
41
41
  * fail. This action can prevent users from storing and accessing sensitive data.</p>
42
42
  * </note>
43
43
  * <p>When you disconnect a custom key store, its <code>ConnectionState</code> changes to
@@ -81,7 +81,7 @@ declare const DisconnectCustomKeyStoreCommand_base: {
81
81
  * </ul>
82
82
  * <p>
83
83
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
84
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
84
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
85
85
  * @example
86
86
  * Use a bare-bones client and the command you need to make an API call.
87
87
  * ```javascript
@@ -28,7 +28,7 @@ declare const EnableKeyCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
31
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
31
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#cryptographic-operations">cryptographic operations</a>. </p>
32
32
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
33
33
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
34
34
  * <p>
@@ -40,7 +40,7 @@ declare const EnableKeyCommand_base: {
40
40
  * </p>
41
41
  * <p>
42
42
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
43
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
43
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
44
44
  * @example
45
45
  * Use a bare-bones client and the command you need to make an API call.
46
46
  * ```javascript
@@ -95,8 +95,9 @@ declare const EnableKeyCommand_base: {
95
95
  * </ul>
96
96
  *
97
97
  * @throws {@link LimitExceededException} (client fault)
98
- * <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
99
- * <i>Key Management Service Developer Guide</i>.</p>
98
+ * <p>The request was rejected because a length constraint or quota was exceeded. For more
99
+ * information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
100
+ * the <i>Key Management Service Developer Guide</i>.</p>
100
101
  *
101
102
  * @throws {@link NotFoundException} (client fault)
102
103
  * <p>The request was rejected because the specified entity or resource could not be
@@ -27,22 +27,19 @@ declare const EnableKeyRotationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable">automatic rotation
31
- * of the key material</a> of the specified symmetric encryption KMS key. </p>
30
+ * <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html">automatic rotation of the key material</a> of the specified symmetric encryption KMS
31
+ * key. </p>
32
32
  * <p>By default, when you enable automatic rotation of a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS key</a>, KMS
33
33
  * rotates the key material of the KMS key one year (approximately 365 days) from the enable date
34
34
  * and every year thereafter. You can use the optional <code>RotationPeriodInDays</code>
35
35
  * parameter to specify a custom rotation period when you enable key rotation, or you can use
36
- * <code>RotationPeriodInDays</code> to modify the rotation period of a key that you previously
36
+ * <code>RotationPeriodInDays</code> to modify the rotation period of a key that you previously
37
37
  * enabled automatic key rotation on.</p>
38
- * <p>You can monitor rotation of the key material
39
- * for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key
40
- * material in a customer managed KMS key, use the <a>DisableKeyRotation</a>
41
- * operation. You can use the <a>GetKeyRotationStatus</a> operation to identify any in progress
42
- * rotations. You can use the <a>ListKeyRotations</a> operation to view the details of
43
- * completed rotations.</p>
44
- * <p>Automatic key rotation is supported only on <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks">symmetric encryption KMS keys</a>.
45
- * You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key. </p>
38
+ * <p>You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch. To disable rotation of the key material in a customer managed KMS key, use
39
+ * the <a>DisableKeyRotation</a> operation. You can use the <a>GetKeyRotationStatus</a> operation to identify any in progress rotations. You can
40
+ * use the <a>ListKeyRotations</a> operation to view the details of completed
41
+ * rotations.</p>
42
+ * <p>Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key. </p>
46
43
  * <p>You cannot enable or disable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a>. KMS
47
44
  * always rotates the key material of Amazon Web Services managed keys every year. Rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned KMS
48
45
  * keys</a> is managed by the Amazon Web Services service that owns the key.</p>
@@ -84,14 +81,15 @@ declare const EnableKeyRotationCommand_base: {
84
81
  * <a>RotateKeyOnDemand</a>
85
82
  * </p>
86
83
  * <note>
87
- * <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the
88
- * key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.</p>
84
+ * <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key
85
+ * material in customer managed KMS keys, regardless of whether or not automatic key
86
+ * rotation is enabled.</p>
89
87
  * </note>
90
88
  * </li>
91
89
  * </ul>
92
90
  * <p>
93
91
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
94
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
92
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
95
93
  * @example
96
94
  * Use a bare-bones client and the command you need to make an API call.
97
95
  * ```javascript
@@ -39,7 +39,7 @@ declare const EncryptCommand_base: {
39
39
  * <code>EncryptionContext</code> when encrypting data, you must specify the same encryption
40
40
  * context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to
41
41
  * decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see
42
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
42
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">Encryption
43
43
  * Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
44
44
  * <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
45
45
  * algorithm must be compatible with the KMS key spec.</p>
@@ -138,7 +138,7 @@ declare const EncryptCommand_base: {
138
138
  * </ul>
139
139
  * <p>
140
140
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
141
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
141
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
142
142
  * @example
143
143
  * Use a bare-bones client and the command you need to make an API call.
144
144
  * ```javascript
@@ -163,6 +163,7 @@ declare const EncryptCommand_base: {
163
163
  * // CiphertextBlob: new Uint8Array(),
164
164
  * // KeyId: "STRING_VALUE",
165
165
  * // EncryptionAlgorithm: "SYMMETRIC_DEFAULT" || "RSAES_OAEP_SHA_1" || "RSAES_OAEP_SHA_256" || "SM2PKE",
166
+ * // KeyMaterialId: "STRING_VALUE",
166
167
  * // };
167
168
  *
168
169
  * ```
@@ -203,8 +204,8 @@ declare const EncryptCommand_base: {
203
204
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
204
205
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
205
206
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
206
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
207
- * <a>DescribeKey</a> operation.</p>
207
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
208
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
208
209
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
209
210
  * <a>DescribeKey</a> operation.</p>
210
211
  *
@@ -48,7 +48,7 @@ declare const GenerateDataKeyCommand_base: {
48
48
  * <p>You can use an optional encryption context to add additional security to the encryption
49
49
  * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
50
50
  * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
51
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
51
+ * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">Encryption Context</a> in the
52
52
  * <i>Key Management Service Developer Guide</i>.</p>
53
53
  * <p>
54
54
  * <code>GenerateDataKey</code> also supports <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html">Amazon Web Services Nitro Enclaves</a>, which provide an
@@ -132,7 +132,7 @@ declare const GenerateDataKeyCommand_base: {
132
132
  * </ul>
133
133
  * <p>
134
134
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
135
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
135
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
136
136
  * @example
137
137
  * Use a bare-bones client and the command you need to make an API call.
138
138
  * ```javascript
@@ -162,6 +162,7 @@ declare const GenerateDataKeyCommand_base: {
162
162
  * // Plaintext: new Uint8Array(),
163
163
  * // KeyId: "STRING_VALUE",
164
164
  * // CiphertextForRecipient: new Uint8Array(),
165
+ * // KeyMaterialId: "STRING_VALUE",
165
166
  * // };
166
167
  *
167
168
  * ```
@@ -202,8 +203,8 @@ declare const GenerateDataKeyCommand_base: {
202
203
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
203
204
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
204
205
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
205
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
206
- * <a>DescribeKey</a> operation.</p>
206
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
207
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
207
208
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
208
209
  * <a>DescribeKey</a> operation.</p>
209
210
  *
@@ -70,7 +70,7 @@ declare const GenerateDataKeyPairCommand_base: {
70
70
  * <p>You can use an optional encryption context to add additional security to the encryption
71
71
  * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
72
72
  * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
73
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
73
+ * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">Encryption Context</a> in the
74
74
  * <i>Key Management Service Developer Guide</i>.</p>
75
75
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
76
76
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -111,7 +111,7 @@ declare const GenerateDataKeyPairCommand_base: {
111
111
  * </ul>
112
112
  * <p>
113
113
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
114
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
114
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
115
115
  * @example
116
116
  * Use a bare-bones client and the command you need to make an API call.
117
117
  * ```javascript
@@ -142,6 +142,7 @@ declare const GenerateDataKeyPairCommand_base: {
142
142
  * // KeyId: "STRING_VALUE",
143
143
  * // KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2",
144
144
  * // CiphertextForRecipient: new Uint8Array(),
145
+ * // KeyMaterialId: "STRING_VALUE",
145
146
  * // };
146
147
  *
147
148
  * ```
@@ -182,8 +183,8 @@ declare const GenerateDataKeyPairCommand_base: {
182
183
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
183
184
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
184
185
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
185
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
186
- * <a>DescribeKey</a> operation.</p>
186
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
187
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
187
188
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
188
189
  * <a>DescribeKey</a> operation.</p>
189
190
  *
@@ -51,7 +51,7 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
51
51
  * <p>You can use an optional encryption context to add additional security to the encryption
52
52
  * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
53
53
  * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
54
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
54
+ * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">Encryption Context</a> in the
55
55
  * <i>Key Management Service Developer Guide</i>.</p>
56
56
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
57
57
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -93,7 +93,7 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
93
93
  * </ul>
94
94
  * <p>
95
95
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
96
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
96
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
97
97
  * @example
98
98
  * Use a bare-bones client and the command you need to make an API call.
99
99
  * ```javascript
@@ -118,6 +118,7 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
118
118
  * // PublicKey: new Uint8Array(),
119
119
  * // KeyId: "STRING_VALUE",
120
120
  * // KeyPairSpec: "RSA_2048" || "RSA_3072" || "RSA_4096" || "ECC_NIST_P256" || "ECC_NIST_P384" || "ECC_NIST_P521" || "ECC_SECG_P256K1" || "SM2",
121
+ * // KeyMaterialId: "STRING_VALUE",
121
122
  * // };
122
123
  *
123
124
  * ```
@@ -158,8 +159,8 @@ declare const GenerateDataKeyPairWithoutPlaintextCommand_base: {
158
159
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
159
160
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
160
161
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
161
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
162
- * <a>DescribeKey</a> operation.</p>
162
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
163
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
163
164
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
164
165
  * <a>DescribeKey</a> operation.</p>
165
166
  *
@@ -60,7 +60,7 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
60
60
  * <p>You can use an optional encryption context to add additional security to the encryption
61
61
  * operation. If you specify an <code>EncryptionContext</code>, you must specify the same
62
62
  * encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
63
- * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
63
+ * Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/encrypt_context.html">Encryption Context</a> in the
64
64
  * <i>Key Management Service Developer Guide</i>.</p>
65
65
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
66
66
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -102,7 +102,7 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
102
102
  * </ul>
103
103
  * <p>
104
104
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
105
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
105
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
106
106
  * @example
107
107
  * Use a bare-bones client and the command you need to make an API call.
108
108
  * ```javascript
@@ -126,6 +126,7 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
126
126
  * // { // GenerateDataKeyWithoutPlaintextResponse
127
127
  * // CiphertextBlob: new Uint8Array(),
128
128
  * // KeyId: "STRING_VALUE",
129
+ * // KeyMaterialId: "STRING_VALUE",
129
130
  * // };
130
131
  *
131
132
  * ```
@@ -166,8 +167,8 @@ declare const GenerateDataKeyWithoutPlaintextCommand_base: {
166
167
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
167
168
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
168
169
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
169
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
170
- * <a>DescribeKey</a> operation.</p>
170
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
171
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
171
172
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
172
173
  * <a>DescribeKey</a> operation.</p>
173
174
  *
@@ -58,7 +58,7 @@ declare const GenerateMacCommand_base: {
58
58
  * </p>
59
59
  * <p>
60
60
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
61
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
61
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
62
62
  * @example
63
63
  * Use a bare-bones client and the command you need to make an API call.
64
64
  * ```javascript
@@ -116,8 +116,8 @@ declare const GenerateMacCommand_base: {
116
116
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
117
117
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
118
118
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
119
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
120
- * <a>DescribeKey</a> operation.</p>
119
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
120
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
121
121
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
122
122
  * <a>DescribeKey</a> operation.</p>
123
123
  *
@@ -40,8 +40,7 @@ declare const GenerateRandomCommand_base: {
40
40
  * to provide the attestation document for the enclave. Instead of plaintext bytes, the response
41
41
  * includes the plaintext bytes encrypted under the public key from the attestation document
42
42
  * (<code>CiphertextForRecipient</code>).For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves uses KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
43
- * <p>For more information about entropy and random number generation, see
44
- * <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
43
+ * <p>For more information about entropy and random number generation, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-cryptography.html#entropy-and-random-numbers">Entropy and random number generation</a> in the <i>Key Management Service Developer Guide</i>.</p>
45
44
  * <p>
46
45
  * <b>Cross-account use</b>: Not applicable.
47
46
  * <code>GenerateRandom</code> does not use any account-specific resources, such as KMS
@@ -50,7 +49,7 @@ declare const GenerateRandomCommand_base: {
50
49
  * <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>
51
50
  * <p>
52
51
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
53
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
52
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
54
53
  * @example
55
54
  * Use a bare-bones client and the command you need to make an API call.
56
55
  * ```javascript
@@ -37,7 +37,7 @@ declare const GetKeyPolicyCommand_base: {
37
37
  * </p>
38
38
  * <p>
39
39
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
40
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
40
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
41
41
  * @example
42
42
  * Use a bare-bones client and the command you need to make an API call.
43
43
  * ```javascript
@@ -27,20 +27,21 @@ declare const GetKeyRotationStatusCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Provides detailed information about the rotation status for a KMS key, including
31
- * whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is enabled for the specified KMS key, the
32
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period">rotation period</a>, and the next scheduled
33
- * rotation date.</p>
34
- * <p>Automatic key rotation is supported only on <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks">symmetric encryption KMS keys</a>.
35
- * You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key..</p>
30
+ * <p>Provides detailed information about the rotation status for a KMS key, including whether
31
+ * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html">automatic
32
+ * rotation of the key material</a> is enabled for the specified KMS key, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period">rotation
33
+ * period</a>, and the next scheduled rotation date.</p>
34
+ * <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
35
+ * You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key.</p>
36
36
  * <p>You can enable (<a>EnableKeyRotation</a>) and disable automatic rotation (<a>DisableKeyRotation</a>) of the key material in customer managed KMS keys. Key
37
37
  * material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> is not
38
38
  * configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The
39
39
  * key rotation status for Amazon Web Services managed KMS keys is always <code>true</code>.</p>
40
- * <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the
41
- * key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled.
42
- * You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation
43
- * was initiated. You can use <a>ListKeyRotations</a> to view the details of completed rotations.</p>
40
+ * <p>You can perform on-demand (<a>RotateKeyOnDemand</a>) rotation of the key
41
+ * material in customer managed KMS keys, regardless of whether or not automatic key rotation is
42
+ * enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress
43
+ * on-demand rotation was initiated. You can use <a>ListKeyRotations</a> to view the
44
+ * details of completed rotations.</p>
44
45
  * <note>
45
46
  * <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three
46
47
  * years to every year. For details, see <a>EnableKeyRotation</a>.</p>
@@ -94,7 +95,7 @@ declare const GetKeyRotationStatusCommand_base: {
94
95
  * </ul>
95
96
  * <p>
96
97
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
97
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
98
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
98
99
  * @example
99
100
  * Use a bare-bones client and the command you need to make an API call.
100
101
  * ```javascript
@@ -32,17 +32,17 @@ declare const GetParametersForImportCommand_base: {
32
32
  * <p>By default, KMS keys are created with key material that KMS generates. This operation
33
33
  * supports <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key
34
34
  * material</a>, an advanced feature that lets you generate and import the cryptographic
35
- * key material for a KMS key. For more information about importing key material into KMS, see
36
- * <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key
37
- * material</a> in the <i>Key Management Service Developer Guide</i>.</p>
35
+ * key material for a KMS key.</p>
38
36
  * <p>Before calling <code>GetParametersForImport</code>, use the <a>CreateKey</a>
39
37
  * operation with an <code>Origin</code> value of <code>EXTERNAL</code> to create a KMS key with
40
38
  * no key material. You can import key material for a symmetric encryption KMS key, HMAC KMS key,
41
39
  * asymmetric encryption KMS key, or asymmetric signing KMS key. You can also import key material
42
40
  * into a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">multi-Region key</a> of any supported type. However, you can't import key material into
43
- * a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. You can also use <code>GetParametersForImport</code> to get a
44
- * public key and import token to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the original key
45
- * material</a> into a KMS key whose key material expired or was deleted.</p>
41
+ * a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom
42
+ * key store</a>. You can also use <code>GetParametersForImport</code> to get a public key
43
+ * and import token to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html#reimport-key-material">reimport
44
+ * the original key material</a> into a KMS key whose key material expired or was
45
+ * deleted.</p>
46
46
  * <p>
47
47
  * <code>GetParametersForImport</code> returns the items that you need to import your key
48
48
  * material.</p>
@@ -103,7 +103,7 @@ declare const GetParametersForImportCommand_base: {
103
103
  * </ul>
104
104
  * <p>
105
105
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
106
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
106
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
107
107
  * @example
108
108
  * Use a bare-bones client and the command you need to make an API call.
109
109
  * ```javascript
@@ -47,13 +47,13 @@ declare const GetPublicKeyCommand_base: {
47
47
  * </li>
48
48
  * <li>
49
49
  * <p>
50
- * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage">KeyUsage</a>: Whether the key is used for encryption, signing, or
51
- * deriving a shared secret.</p>
50
+ * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage">KeyUsage</a>: Whether the key is used for encryption, signing, or deriving a shared
51
+ * secret.</p>
52
52
  * </li>
53
53
  * <li>
54
54
  * <p>
55
- * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms">EncryptionAlgorithms</a> or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms">SigningAlgorithms</a>: A list of the encryption algorithms or the signing
56
- * algorithms for the key.</p>
55
+ * <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms">EncryptionAlgorithms</a>, <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyAgreementAlgorithms">KeyAgreementAlgorithms</a>, or <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms">SigningAlgorithms</a>: A list of the encryption algorithms, key agreement
56
+ * algorithms, or signing algorithms for the key.</p>
57
57
  * </li>
58
58
  * </ul>
59
59
  * <p>Although KMS cannot enforce these restrictions on external operations, it is crucial
@@ -64,7 +64,7 @@ declare const GetPublicKeyCommand_base: {
64
64
  * operation.</p>
65
65
  * <p>To verify a signature outside of KMS with an SM2 public key (China Regions only), you
66
66
  * must specify the distinguishing ID. By default, KMS uses <code>1234567812345678</code> as
67
- * the 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
67
+ * the distinguishing ID. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/offline-operations.html#key-spec-sm-offline-verification">Offline
68
68
  * verification with SM2 key pairs</a>.</p>
69
69
  * <p>The KMS key that you use for this operation must be in a compatible key state. For
70
70
  * details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
@@ -78,7 +78,7 @@ declare const GetPublicKeyCommand_base: {
78
78
  * </p>
79
79
  * <p>
80
80
  * <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
81
- * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
81
+ * For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/accessing-kms.html#programming-eventual-consistency">KMS eventual consistency</a>.</p>
82
82
  * @example
83
83
  * Use a bare-bones client and the command you need to make an API call.
84
84
  * ```javascript
@@ -149,8 +149,8 @@ declare const GetPublicKeyCommand_base: {
149
149
  * messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
150
150
  * verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
151
151
  * <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
152
- * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code> of a KMS key, use the
153
- * <a>DescribeKey</a> operation.</p>
152
+ * <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
153
+ * of a KMS key, use the <a>DescribeKey</a> operation.</p>
154
154
  * <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
155
155
  * <a>DescribeKey</a> operation.</p>
156
156
  *