@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.
- package/dist-cjs/index.js +52 -6
- package/dist-es/models/models_0.js +17 -0
- package/dist-es/protocols/Aws_json1_1.js +22 -1
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +1 -1
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/CreateAliasCommand.d.ts +7 -7
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -7
- package/dist-types/commands/CreateGrantCommand.d.ts +8 -7
- package/dist-types/commands/CreateKeyCommand.d.ts +21 -20
- package/dist-types/commands/DecryptCommand.d.ts +17 -16
- package/dist-types/commands/DeleteAliasCommand.d.ts +1 -1
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +14 -5
- package/dist-types/commands/DeriveSharedSecretCommand.d.ts +40 -33
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +3 -3
- package/dist-types/commands/DescribeKeyCommand.d.ts +79 -78
- package/dist-types/commands/DisableKeyCommand.d.ts +5 -6
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +4 -4
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +4 -4
- package/dist-types/commands/EnableKeyCommand.d.ts +5 -4
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +12 -14
- package/dist-types/commands/EncryptCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +5 -4
- package/dist-types/commands/GenerateMacCommand.d.ts +3 -3
- package/dist-types/commands/GenerateRandomCommand.d.ts +2 -3
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +12 -11
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -7
- package/dist-types/commands/GetPublicKeyCommand.d.ts +8 -8
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +54 -38
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -5
- package/dist-types/commands/ListGrantsCommand.d.ts +3 -3
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListKeyRotationsCommand.d.ts +22 -4
- package/dist-types/commands/ListKeysCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceTagsCommand.d.ts +3 -3
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +3 -3
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -4
- package/dist-types/commands/ReEncryptCommand.d.ts +12 -13
- package/dist-types/commands/ReplicateKeyCommand.d.ts +10 -13
- package/dist-types/commands/RetireGrantCommand.d.ts +6 -7
- package/dist-types/commands/RevokeGrantCommand.d.ts +5 -5
- package/dist-types/commands/RotateKeyOnDemandCommand.d.ts +33 -23
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +15 -15
- package/dist-types/commands/SignCommand.d.ts +19 -19
- package/dist-types/commands/TagResourceCommand.d.ts +6 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -3
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +12 -12
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +2 -2
- package/dist-types/commands/VerifyCommand.d.ts +4 -4
- package/dist-types/commands/VerifyMacCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +423 -150
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +7 -3
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +51 -1
- package/package.json +11 -11
|
@@ -29,28 +29,32 @@ declare const RotateKeyOnDemandCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Immediately initiates rotation of the key material of the specified symmetric encryption
|
|
31
31
|
* KMS key.</p>
|
|
32
|
-
* <p>You can perform <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* as scheduled, on April 14, 2024 and every 730 days thereafter.</p>
|
|
32
|
+
* <p>You can perform <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-on-demand.html">on-demand rotation</a> of
|
|
33
|
+
* the key material in customer managed KMS keys, regardless of whether or not <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotating-keys-enable-disable.html">automatic key
|
|
34
|
+
* rotation</a> is enabled. On-demand rotations do not change existing automatic rotation
|
|
35
|
+
* schedules. For example, consider a KMS key that has automatic key rotation enabled with a
|
|
36
|
+
* rotation period of 730 days. If the key is scheduled to automatically rotate on April 14,
|
|
37
|
+
* 2024, and you perform an on-demand rotation on April 10, 2024, the key will automatically
|
|
38
|
+
* rotate, as scheduled, on April 14, 2024 and every 730 days thereafter.</p>
|
|
39
39
|
* <note>
|
|
40
|
-
* <p>You can perform on-demand key rotation a <b>maximum of 10
|
|
41
|
-
*
|
|
42
|
-
*
|
|
40
|
+
* <p>You can perform on-demand key rotation a <b>maximum of 10
|
|
41
|
+
* times</b> per KMS key. You can use the KMS console to view the number of
|
|
42
|
+
* remaining on-demand rotations available for a KMS key.</p>
|
|
43
43
|
* </note>
|
|
44
|
-
* <p>You can use <a>GetKeyRotationStatus</a> to identify any in progress
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* <p>On-demand key rotation is supported only on
|
|
49
|
-
*
|
|
50
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>,
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
44
|
+
* <p>You can use <a>GetKeyRotationStatus</a> to identify any in progress on-demand
|
|
45
|
+
* rotations. You can use <a>ListKeyRotations</a> to identify the date that completed
|
|
46
|
+
* on-demand rotations were performed. You can monitor rotation of the key material for your KMS
|
|
47
|
+
* keys in CloudTrail and Amazon CloudWatch.</p>
|
|
48
|
+
* <p>On-demand key rotation is supported only on symmetric encryption KMS keys. You cannot
|
|
49
|
+
* perform on-demand rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>,
|
|
50
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, multi-Region KMS keys
|
|
51
|
+
* with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>,
|
|
52
|
+
* or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>. When you initiate on-demand key rotation on a symmetric encryption KMS key
|
|
53
|
+
* with imported key material, you must have already imported
|
|
54
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-import-key-material.html">new key material</a>
|
|
55
|
+
* and that key material's state should be <code>PENDING_ROTATION</code>. Use the <code>ListKeyRotations</code>
|
|
56
|
+
* operation to check the state of all key materials associated with a KMS key. To perform on-demand rotation of
|
|
57
|
+
* a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#multi-region-rotate">multi-Region keys</a>, invoke the on-demand rotation on the primary key.</p>
|
|
54
58
|
* <p>You cannot initiate on-demand 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
|
|
55
59
|
* 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
|
|
56
60
|
* keys</a> is managed by the Amazon Web Services service that owns the key.</p>
|
|
@@ -81,13 +85,18 @@ declare const RotateKeyOnDemandCommand_base: {
|
|
|
81
85
|
* </li>
|
|
82
86
|
* <li>
|
|
83
87
|
* <p>
|
|
88
|
+
* <a>ImportKeyMaterial</a>
|
|
89
|
+
* </p>
|
|
90
|
+
* </li>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>
|
|
84
93
|
* <a>ListKeyRotations</a>
|
|
85
94
|
* </p>
|
|
86
95
|
* </li>
|
|
87
96
|
* </ul>
|
|
88
97
|
* <p>
|
|
89
98
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
90
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
99
|
+
* 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>
|
|
91
100
|
* @example
|
|
92
101
|
* Use a bare-bones client and the command you need to make an API call.
|
|
93
102
|
* ```javascript
|
|
@@ -151,8 +160,9 @@ declare const RotateKeyOnDemandCommand_base: {
|
|
|
151
160
|
* </ul>
|
|
152
161
|
*
|
|
153
162
|
* @throws {@link LimitExceededException} (client fault)
|
|
154
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
155
|
-
*
|
|
163
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
164
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
165
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
156
166
|
*
|
|
157
167
|
* @throws {@link NotFoundException} (client fault)
|
|
158
168
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
@@ -38,9 +38,9 @@ declare const ScheduleKeyDeletionCommand_base: {
|
|
|
38
38
|
* <important>
|
|
39
39
|
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key
|
|
40
40
|
* is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only
|
|
41
|
-
* exception is a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">multi-Region replica key</a>, or an <a href="kms/latest/developerguide/
|
|
42
|
-
*
|
|
43
|
-
*
|
|
41
|
+
* exception is a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">multi-Region replica key</a>, or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#import-delete-key">asymmetric or HMAC KMS key with
|
|
42
|
+
* imported key material</a>.) To prevent the use of a KMS key without deleting it, use
|
|
43
|
+
* <a>DisableKey</a>. </p>
|
|
44
44
|
* </important>
|
|
45
45
|
* <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
|
|
46
46
|
* time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
|
|
@@ -49,17 +49,17 @@ declare const ScheduleKeyDeletionCommand_base: {
|
|
|
49
49
|
* operations. This status can continue indefinitely. When the last of its replicas keys is
|
|
50
50
|
* deleted (not just scheduled), the key state of the primary key changes to
|
|
51
51
|
* <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
|
|
52
|
-
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
53
|
-
* <i>Key Management Service Developer Guide</i>.</p>
|
|
54
|
-
* <p>When KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
52
|
+
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-mrks">Deleting multi-Region keys</a> in
|
|
53
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
54
|
+
* <p>When KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#delete-cmk-keystore">deletes a KMS key from an CloudHSM
|
|
55
|
+
* key store</a>, it makes a best effort to delete the associated key material from the
|
|
56
|
+
* associated CloudHSM cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
57
|
+
* material</a> from the cluster and its backups. <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#delete-xks-key">Deleting a KMS key from an external key
|
|
58
|
+
* store</a> has no effect on the associated external key. However, for both types of
|
|
59
|
+
* custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt
|
|
60
|
+
* ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key.
|
|
61
|
+
* Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with
|
|
62
|
+
* the same key material.</p>
|
|
63
63
|
* <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</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
|
|
@@ -86,7 +86,7 @@ declare const ScheduleKeyDeletionCommand_base: {
|
|
|
86
86
|
* </ul>
|
|
87
87
|
* <p>
|
|
88
88
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
89
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
89
|
+
* 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>
|
|
90
90
|
* @example
|
|
91
91
|
* Use a bare-bones client and the command you need to make an API call.
|
|
92
92
|
* ```javascript
|
|
@@ -81,7 +81,7 @@ declare const SignCommand_base: {
|
|
|
81
81
|
* </p>
|
|
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
|
|
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
|
|
@@ -144,8 +144,8 @@ declare const SignCommand_base: {
|
|
|
144
144
|
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
145
145
|
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
146
146
|
* <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
|
|
147
|
-
*
|
|
148
|
-
*
|
|
147
|
+
* <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
|
|
148
|
+
* of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
149
149
|
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
150
150
|
* <a>DescribeKey</a> operation.</p>
|
|
151
151
|
*
|
|
@@ -185,42 +185,42 @@ declare const SignCommand_base: {
|
|
|
185
185
|
* <p>Base exception class for all service exceptions from KMS service.</p>
|
|
186
186
|
*
|
|
187
187
|
*
|
|
188
|
-
* @example To digitally sign a message with an asymmetric KMS key.
|
|
188
|
+
* @example To digitally sign a message digest with an asymmetric KMS key.
|
|
189
189
|
* ```javascript
|
|
190
|
-
* // This operation uses the private key in an asymmetric
|
|
190
|
+
* // This operation uses the private key in an asymmetric RSA signing KMS key to generate a digital signature for a message digest. In this example, a large message was hashed and the resulting digest is provided in the Message parameter. To tell KMS not to hash the message again, the MessageType field is set to DIGEST
|
|
191
191
|
* const input = {
|
|
192
|
-
* KeyId: "alias/
|
|
193
|
-
* Message: "<message to be signed>",
|
|
194
|
-
* MessageType: "
|
|
195
|
-
* SigningAlgorithm: "
|
|
192
|
+
* KeyId: "alias/RSA_signing_key",
|
|
193
|
+
* Message: "<message digest to be signed>",
|
|
194
|
+
* MessageType: "DIGEST",
|
|
195
|
+
* SigningAlgorithm: "RSASSA_PKCS1_V1_5_SHA_256"
|
|
196
196
|
* };
|
|
197
197
|
* const command = new SignCommand(input);
|
|
198
198
|
* const response = await client.send(command);
|
|
199
199
|
* /* response is
|
|
200
200
|
* {
|
|
201
|
-
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/
|
|
201
|
+
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321",
|
|
202
202
|
* Signature: "<binary data>",
|
|
203
|
-
* SigningAlgorithm: "
|
|
203
|
+
* SigningAlgorithm: "RSASSA_PKCS1_V1_5_SHA_256"
|
|
204
204
|
* }
|
|
205
205
|
* *\/
|
|
206
206
|
* ```
|
|
207
207
|
*
|
|
208
|
-
* @example To digitally sign a message
|
|
208
|
+
* @example To digitally sign a message with an asymmetric KMS key.
|
|
209
209
|
* ```javascript
|
|
210
|
-
* // This operation uses the private key in an asymmetric
|
|
210
|
+
* // This operation uses the private key in an asymmetric elliptic curve (ECC) KMS key to generate a digital signature for a given message.
|
|
211
211
|
* const input = {
|
|
212
|
-
* KeyId: "alias/
|
|
213
|
-
* Message: "<message
|
|
214
|
-
* MessageType: "
|
|
215
|
-
* SigningAlgorithm: "
|
|
212
|
+
* KeyId: "alias/ECC_signing_key",
|
|
213
|
+
* Message: "<message to be signed>",
|
|
214
|
+
* MessageType: "RAW",
|
|
215
|
+
* SigningAlgorithm: "ECDSA_SHA_384"
|
|
216
216
|
* };
|
|
217
217
|
* const command = new SignCommand(input);
|
|
218
218
|
* const response = await client.send(command);
|
|
219
219
|
* /* response is
|
|
220
220
|
* {
|
|
221
|
-
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/
|
|
221
|
+
* KeyId: "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab",
|
|
222
222
|
* Signature: "<binary data>",
|
|
223
|
-
* SigningAlgorithm: "
|
|
223
|
+
* SigningAlgorithm: "ECDSA_SHA_384"
|
|
224
224
|
* }
|
|
225
225
|
* *\/
|
|
226
226
|
* ```
|
|
@@ -36,8 +36,8 @@ declare const TagResourceCommand_base: {
|
|
|
36
36
|
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
37
37
|
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
|
|
38
38
|
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
|
|
39
|
-
* managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
40
|
-
*
|
|
39
|
+
* managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html">custom key store</a>,
|
|
40
|
+
* or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">alias</a>.</p>
|
|
41
41
|
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
|
|
42
42
|
* replicating it (<a>ReplicateKey</a>).</p>
|
|
43
43
|
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
@@ -76,7 +76,7 @@ declare const TagResourceCommand_base: {
|
|
|
76
76
|
* </ul>
|
|
77
77
|
* <p>
|
|
78
78
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
79
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
79
|
+
* 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>
|
|
80
80
|
* @example
|
|
81
81
|
* Use a bare-bones client and the command you need to make an API call.
|
|
82
82
|
* ```javascript
|
|
@@ -133,8 +133,9 @@ declare const TagResourceCommand_base: {
|
|
|
133
133
|
* </ul>
|
|
134
134
|
*
|
|
135
135
|
* @throws {@link LimitExceededException} (client fault)
|
|
136
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
137
|
-
*
|
|
136
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
137
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
138
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
138
139
|
*
|
|
139
140
|
* @throws {@link NotFoundException} (client fault)
|
|
140
141
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
@@ -71,7 +71,7 @@ declare const UntagResourceCommand_base: {
|
|
|
71
71
|
* </ul>
|
|
72
72
|
* <p>
|
|
73
73
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
74
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
74
|
+
* 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>
|
|
75
75
|
* @example
|
|
76
76
|
* Use a bare-bones client and the command you need to make an API call.
|
|
77
77
|
* ```javascript
|
|
@@ -92,7 +92,7 @@ declare const UpdateAliasCommand_base: {
|
|
|
92
92
|
* </ul>
|
|
93
93
|
* <p>
|
|
94
94
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
95
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
95
|
+
* 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>
|
|
96
96
|
* @example
|
|
97
97
|
* Use a bare-bones client and the command you need to make an API call.
|
|
98
98
|
* ```javascript
|
|
@@ -144,8 +144,9 @@ declare const UpdateAliasCommand_base: {
|
|
|
144
144
|
* </ul>
|
|
145
145
|
*
|
|
146
146
|
* @throws {@link LimitExceededException} (client fault)
|
|
147
|
-
* <p>The request was rejected because a quota was exceeded. For more
|
|
148
|
-
*
|
|
147
|
+
* <p>The request was rejected because a length constraint or quota was exceeded. For more
|
|
148
|
+
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in
|
|
149
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
149
150
|
*
|
|
150
151
|
* @throws {@link NotFoundException} (client fault)
|
|
151
152
|
* <p>The request was rejected because the specified entity or resource could not be
|
|
@@ -32,7 +32,7 @@ declare const UpdateCustomKeyStoreCommand_base: {
|
|
|
32
32
|
* <p>Use the required <code>CustomKeyStoreId</code> parameter to identify the custom key store.
|
|
33
33
|
* Use the remaining optional parameters to change its properties. This operation does not return
|
|
34
34
|
* any property values. To verify the updated property values, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
35
|
-
* <p> This operation is part of the
|
|
35
|
+
* <p> This operation is part of the custom key stores feature in KMS, which
|
|
36
36
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
37
37
|
* key store that you own and manage.</p>
|
|
38
38
|
* <important>
|
|
@@ -122,7 +122,7 @@ declare const UpdateCustomKeyStoreCommand_base: {
|
|
|
122
122
|
* </ul>
|
|
123
123
|
* <p>
|
|
124
124
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
125
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
125
|
+
* 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>
|
|
126
126
|
* @example
|
|
127
127
|
* Use a bare-bones client and the command you need to make an API call.
|
|
128
128
|
* ```javascript
|
|
@@ -343,12 +343,14 @@ declare const UpdateCustomKeyStoreCommand_base: {
|
|
|
343
343
|
* *\/
|
|
344
344
|
* ```
|
|
345
345
|
*
|
|
346
|
-
* @example To
|
|
346
|
+
* @example To update the proxy connectivity of an external key store to VPC_ENDPOINT_SERVICE
|
|
347
347
|
* ```javascript
|
|
348
|
-
* //
|
|
348
|
+
* // To change the external key store proxy connectivity option from public endpoint connectivity to VPC endpoint service connectivity, in addition to changing the <code>XksProxyConnectivity</code> value, you must change the <code>XksProxyUriEndpoint</code> value to reflect the private DNS name associated with the VPC endpoint service. You must also add an <code>XksProxyVpcEndpointServiceName</code> value.
|
|
349
349
|
* const input = {
|
|
350
|
-
*
|
|
351
|
-
*
|
|
350
|
+
* CustomKeyStoreId: "cks-1234567890abcdef0",
|
|
351
|
+
* XksProxyConnectivity: "VPC_ENDPOINT_SERVICE",
|
|
352
|
+
* XksProxyUriEndpoint: "https://myproxy-private.xks.example.com",
|
|
353
|
+
* XksProxyVpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example"
|
|
352
354
|
* };
|
|
353
355
|
* const command = new UpdateCustomKeyStoreCommand(input);
|
|
354
356
|
* const response = await client.send(command);
|
|
@@ -371,14 +373,12 @@ declare const UpdateCustomKeyStoreCommand_base: {
|
|
|
371
373
|
* *\/
|
|
372
374
|
* ```
|
|
373
375
|
*
|
|
374
|
-
* @example To
|
|
376
|
+
* @example To associate the custom key store with a different, but related, AWS CloudHSM cluster.
|
|
375
377
|
* ```javascript
|
|
376
|
-
* //
|
|
378
|
+
* // This example changes the AWS CloudHSM cluster that is associated with an AWS CloudHSM key store to a related cluster, such as a different backup of the same cluster. This operation does not return any data. To verify that the operation worked, use the DescribeCustomKeyStores operation.
|
|
377
379
|
* const input = {
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
* XksProxyUriEndpoint: "https://myproxy-private.xks.example.com",
|
|
381
|
-
* XksProxyVpcEndpointServiceName: "com.amazonaws.vpce.us-east-1.vpce-svc-example"
|
|
380
|
+
* CloudHsmClusterId: "cluster-234abcdefABC",
|
|
381
|
+
* CustomKeyStoreId: "cks-1234567890abcdef0"
|
|
382
382
|
* };
|
|
383
383
|
* const command = new UpdateCustomKeyStoreCommand(input);
|
|
384
384
|
* const response = await client.send(command);
|
|
@@ -51,7 +51,7 @@ declare const UpdateKeyDescriptionCommand_base: {
|
|
|
51
51
|
* </ul>
|
|
52
52
|
* <p>
|
|
53
53
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
54
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
54
|
+
* 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>
|
|
55
55
|
* @example
|
|
56
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
57
57
|
* ```javascript
|
|
@@ -33,7 +33,7 @@ declare const UpdatePrimaryRegionCommand_base: {
|
|
|
33
33
|
* in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
|
|
34
34
|
* <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
|
|
35
35
|
* <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
|
|
36
|
-
* key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-
|
|
36
|
+
* key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-update.html">Change the primary key in a set of multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
37
37
|
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
38
38
|
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
39
39
|
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
@@ -94,7 +94,7 @@ declare const UpdatePrimaryRegionCommand_base: {
|
|
|
94
94
|
* </ul>
|
|
95
95
|
* <p>
|
|
96
96
|
* <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
|
|
97
|
+
* 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
98
|
* @example
|
|
99
99
|
* Use a bare-bones client and the command you need to make an API call.
|
|
100
100
|
* ```javascript
|
|
@@ -50,7 +50,7 @@ declare const VerifyCommand_base: {
|
|
|
50
50
|
* the KMS key to verify signatures.</p>
|
|
51
51
|
* <p>To verify a signature outside of KMS with an SM2 public key (China Regions only), you
|
|
52
52
|
* must specify the distinguishing ID. By default, KMS uses <code>1234567812345678</code> as
|
|
53
|
-
* the distinguishing ID. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
53
|
+
* 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
|
|
54
54
|
* verification with SM2 key pairs</a>.</p>
|
|
55
55
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
56
56
|
* 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>
|
|
@@ -64,7 +64,7 @@ declare const VerifyCommand_base: {
|
|
|
64
64
|
* </p>
|
|
65
65
|
* <p>
|
|
66
66
|
* <b>Eventual consistency</b>: The KMS API follows an eventual consistency model.
|
|
67
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency
|
|
67
|
+
* 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>
|
|
68
68
|
* @example
|
|
69
69
|
* Use a bare-bones client and the command you need to make an API call.
|
|
70
70
|
* ```javascript
|
|
@@ -128,8 +128,8 @@ declare const VerifyCommand_base: {
|
|
|
128
128
|
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
129
129
|
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
130
130
|
* <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
|
|
131
|
-
*
|
|
132
|
-
*
|
|
131
|
+
* <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
|
|
132
|
+
* of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
133
133
|
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
134
134
|
* <a>DescribeKey</a> operation.</p>
|
|
135
135
|
*
|
|
@@ -50,7 +50,7 @@ declare const VerifyMacCommand_base: {
|
|
|
50
50
|
* </p>
|
|
51
51
|
* <p>
|
|
52
52
|
* <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
|
|
53
|
+
* 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
54
|
* @example
|
|
55
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
56
56
|
* ```javascript
|
|
@@ -109,8 +109,8 @@ declare const VerifyMacCommand_base: {
|
|
|
109
109
|
* messages, the <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. For generating and
|
|
110
110
|
* verifying message authentication codes (MACs), the <code>KeyUsage</code> must be
|
|
111
111
|
* <code>GENERATE_VERIFY_MAC</code>. For deriving key agreement secrets, the
|
|
112
|
-
*
|
|
113
|
-
*
|
|
112
|
+
* <code>KeyUsage</code> must be <code>KEY_AGREEMENT</code>. To find the <code>KeyUsage</code>
|
|
113
|
+
* of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
114
114
|
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the
|
|
115
115
|
* <a>DescribeKey</a> operation.</p>
|
|
116
116
|
*
|