@aws-sdk/client-kms 3.278.0 → 3.281.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/README.md +409 -6
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/KMS.d.ts +17 -78
- package/dist-types/KMSClient.d.ts +6 -6
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +6 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +6 -1
- package/dist-types/commands/CreateAliasCommand.d.ts +6 -1
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +6 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +6 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +6 -4
- package/dist-types/commands/DecryptCommand.d.ts +11 -5
- package/dist-types/commands/DeleteAliasCommand.d.ts +6 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +6 -1
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +6 -1
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +6 -1
- package/dist-types/commands/DisableKeyCommand.d.ts +6 -1
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +6 -1
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -1
- package/dist-types/commands/EnableKeyCommand.d.ts +6 -1
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +6 -1
- package/dist-types/commands/EncryptCommand.d.ts +6 -3
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +8 -8
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +6 -6
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +6 -2
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +6 -6
- package/dist-types/commands/GenerateMacCommand.d.ts +6 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +6 -1
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +6 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +6 -1
- package/dist-types/commands/GetParametersForImportCommand.d.ts +6 -1
- package/dist-types/commands/GetPublicKeyCommand.d.ts +6 -2
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +6 -1
- package/dist-types/commands/ListAliasesCommand.d.ts +6 -2
- package/dist-types/commands/ListGrantsCommand.d.ts +6 -1
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +6 -1
- package/dist-types/commands/ListKeysCommand.d.ts +6 -1
- package/dist-types/commands/ListResourceTagsCommand.d.ts +6 -1
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +6 -1
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +6 -1
- package/dist-types/commands/ReEncryptCommand.d.ts +6 -3
- package/dist-types/commands/ReplicateKeyCommand.d.ts +6 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +6 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +6 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +6 -2
- package/dist-types/commands/SignCommand.d.ts +6 -1
- package/dist-types/commands/TagResourceCommand.d.ts +6 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -2
- package/dist-types/commands/UpdateAliasCommand.d.ts +6 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +6 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +6 -1
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +6 -0
- package/dist-types/commands/VerifyCommand.d.ts +10 -2
- package/dist-types/commands/VerifyMacCommand.d.ts +6 -1
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +123 -125
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +6 -6
package/dist-types/KMS.d.ts
CHANGED
|
@@ -80,12 +80,12 @@ import { KMSClient } from "./KMSClient";
|
|
|
80
80
|
* <p>
|
|
81
81
|
* <b>Signing Requests</b>
|
|
82
82
|
* </p>
|
|
83
|
-
* <p>Requests must be signed
|
|
84
|
-
* recommend that you
|
|
85
|
-
*
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
* <p>All KMS
|
|
83
|
+
* <p>Requests must be signed using an access key ID and a secret access key. We strongly
|
|
84
|
+
* recommend that you do not use your Amazon Web Services account root access key ID and secret access key for
|
|
85
|
+
* everyday work. You can use the access key ID and secret access key for an IAM user or you
|
|
86
|
+
* can use the Security Token Service (STS) to generate temporary security credentials and use those to sign
|
|
87
|
+
* requests. </p>
|
|
88
|
+
* <p>All KMS requests must be signed with <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
89
89
|
* <p>
|
|
90
90
|
* <b>Logging API Requests</b>
|
|
91
91
|
* </p>
|
|
@@ -222,7 +222,6 @@ export declare class KMS extends KMSClient {
|
|
|
222
222
|
* key store</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
223
223
|
* <p>
|
|
224
224
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
225
|
-
*
|
|
226
225
|
* <p>
|
|
227
226
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ConnectCustomKeyStore</a> (IAM policy)</p>
|
|
228
227
|
* <p>
|
|
@@ -280,7 +279,6 @@ export declare class KMS extends KMSClient {
|
|
|
280
279
|
* 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>
|
|
281
280
|
* <p>
|
|
282
281
|
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
283
|
-
*
|
|
284
282
|
* <p>
|
|
285
283
|
* <b>Required permissions</b>
|
|
286
284
|
* </p>
|
|
@@ -497,10 +495,7 @@ export declare class KMS extends KMSClient {
|
|
|
497
495
|
* <note>
|
|
498
496
|
* <p>KMS has replaced the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
499
497
|
* </note>
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
498
|
* <p>To create different types of KMS keys, use the following guidance:</p>
|
|
503
|
-
*
|
|
504
499
|
* <dl>
|
|
505
500
|
* <dt>Symmetric encryption KMS key</dt>
|
|
506
501
|
* <dd>
|
|
@@ -628,7 +623,6 @@ export declare class KMS extends KMSClient {
|
|
|
628
623
|
* <p>
|
|
629
624
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
630
625
|
* create a KMS key in a different Amazon Web Services account.</p>
|
|
631
|
-
*
|
|
632
626
|
* <p>
|
|
633
627
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
|
|
634
628
|
* <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
|
|
@@ -706,8 +700,8 @@ export declare class KMS extends KMSClient {
|
|
|
706
700
|
* the <code>Decrypt</code> operation fails. This practice ensures that you use the KMS key that
|
|
707
701
|
* you intend.</p>
|
|
708
702
|
* <p>Whenever possible, use key policies to give users permission to call the
|
|
709
|
-
* <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
|
|
710
|
-
* Otherwise, you might create an IAM
|
|
703
|
+
* <code>Decrypt</code> operation on a particular KMS key, instead of using &IAM; policies.
|
|
704
|
+
* Otherwise, you might create an &IAM; policy that gives the user <code>Decrypt</code>
|
|
711
705
|
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys
|
|
712
706
|
* in other accounts if the key policy for the cross-account KMS key permits it. If you must use
|
|
713
707
|
* an IAM policy for <code>Decrypt</code> permissions, limit the user to particular KMS keys or
|
|
@@ -717,9 +711,9 @@ export declare class KMS extends KMSClient {
|
|
|
717
711
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
718
712
|
* 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>
|
|
719
713
|
* <p>
|
|
720
|
-
* <b>Cross-account use</b>: Yes.
|
|
721
|
-
*
|
|
722
|
-
*
|
|
714
|
+
* <b>Cross-account use</b>: Yes. If you use the <code>KeyId</code>
|
|
715
|
+
* parameter to identify a KMS key in a different Amazon Web Services account, specify the key ARN or the alias
|
|
716
|
+
* ARN of the KMS key.</p>
|
|
723
717
|
* <p>
|
|
724
718
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Decrypt</a> (key policy)</p>
|
|
725
719
|
* <p>
|
|
@@ -832,7 +826,6 @@ export declare class KMS extends KMSClient {
|
|
|
832
826
|
* properties.</p>
|
|
833
827
|
* <p>
|
|
834
828
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
835
|
-
*
|
|
836
829
|
* <p>
|
|
837
830
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteCustomKeyStore</a> (IAM policy)</p>
|
|
838
831
|
* <p>
|
|
@@ -882,7 +875,6 @@ export declare class KMS extends KMSClient {
|
|
|
882
875
|
* 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>
|
|
883
876
|
* <p>
|
|
884
877
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
885
|
-
*
|
|
886
878
|
* <p>
|
|
887
879
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteImportedKeyMaterial</a> (key policy)</p>
|
|
888
880
|
* <p>
|
|
@@ -1010,7 +1002,6 @@ export declare class KMS extends KMSClient {
|
|
|
1010
1002
|
* <p>
|
|
1011
1003
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1012
1004
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1013
|
-
*
|
|
1014
1005
|
* <p>
|
|
1015
1006
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DescribeKey</a> (key policy)</p>
|
|
1016
1007
|
* <p>
|
|
@@ -1068,7 +1059,6 @@ export declare class KMS extends KMSClient {
|
|
|
1068
1059
|
* 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>
|
|
1069
1060
|
* <p>
|
|
1070
1061
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1071
|
-
*
|
|
1072
1062
|
* <p>
|
|
1073
1063
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKey</a> (key policy)</p>
|
|
1074
1064
|
* <p>
|
|
@@ -1095,7 +1085,6 @@ export declare class KMS extends KMSClient {
|
|
|
1095
1085
|
* 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>
|
|
1096
1086
|
* <p>
|
|
1097
1087
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1098
|
-
*
|
|
1099
1088
|
* <p>
|
|
1100
1089
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKeyRotation</a> (key policy)</p>
|
|
1101
1090
|
* <p>
|
|
@@ -1138,7 +1127,6 @@ export declare class KMS extends KMSClient {
|
|
|
1138
1127
|
* properties.</p>
|
|
1139
1128
|
* <p>
|
|
1140
1129
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
1141
|
-
*
|
|
1142
1130
|
* <p>
|
|
1143
1131
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisconnectCustomKeyStore</a> (IAM policy)</p>
|
|
1144
1132
|
* <p>
|
|
@@ -1182,7 +1170,6 @@ export declare class KMS extends KMSClient {
|
|
|
1182
1170
|
* 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>
|
|
1183
1171
|
* <p>
|
|
1184
1172
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1185
|
-
*
|
|
1186
1173
|
* <p>
|
|
1187
1174
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKey</a> (key policy)</p>
|
|
1188
1175
|
* <p>
|
|
@@ -1217,7 +1204,6 @@ export declare class KMS extends KMSClient {
|
|
|
1217
1204
|
* 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>
|
|
1218
1205
|
* <p>
|
|
1219
1206
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1220
|
-
*
|
|
1221
1207
|
* <p>
|
|
1222
1208
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKeyRotation</a> (key policy)</p>
|
|
1223
1209
|
* <p>
|
|
@@ -1260,8 +1246,6 @@ export declare class KMS extends KMSClient {
|
|
|
1260
1246
|
* <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
|
|
1261
1247
|
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
1262
1248
|
* </important>
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
1249
|
* <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
|
|
1266
1250
|
* encryption algorithm that you choose.</p>
|
|
1267
1251
|
* <ul>
|
|
@@ -1330,7 +1314,6 @@ export declare class KMS extends KMSClient {
|
|
|
1330
1314
|
* <b>Cross-account use</b>: Yes.
|
|
1331
1315
|
* To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1332
1316
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1333
|
-
*
|
|
1334
1317
|
* <p>
|
|
1335
1318
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Encrypt</a> (key policy)</p>
|
|
1336
1319
|
* <p>
|
|
@@ -1363,23 +1346,18 @@ export declare class KMS extends KMSClient {
|
|
|
1363
1346
|
* key that you specify. The bytes in the plaintext key are random; they are not related
|
|
1364
1347
|
* to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS
|
|
1365
1348
|
* and store the encrypted data key with the encrypted data.</p>
|
|
1366
|
-
*
|
|
1367
1349
|
* <p>To generate a data key, specify the symmetric encryption KMS key that will be used to
|
|
1368
1350
|
* encrypt the data key. You cannot use an asymmetric KMS key to encrypt data keys. To get the
|
|
1369
1351
|
* type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1370
|
-
*
|
|
1371
1352
|
* <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or
|
|
1372
1353
|
* <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use
|
|
1373
1354
|
* the <code>KeySpec</code> parameter.</p>
|
|
1374
|
-
*
|
|
1375
|
-
*
|
|
1376
|
-
* <code>AES_128</code> or <code>NumberOfBytes</code> value of <code>128</code>. The symmetric
|
|
1355
|
+
* <p>To generate a 128-bit SM4 data key (China Regions only), specify a <code>KeySpec</code> value of
|
|
1356
|
+
* <code>AES_128</code> or a <code>NumberOfBytes</code> value of <code>16</code>. The symmetric
|
|
1377
1357
|
* encryption key used in China Regions to encrypt your data key is an SM4 encryption key.</p>
|
|
1378
|
-
*
|
|
1379
1358
|
* <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use
|
|
1380
1359
|
* the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure
|
|
1381
1360
|
* random byte string, use <a>GenerateRandom</a>.</p>
|
|
1382
|
-
*
|
|
1383
1361
|
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
1384
1362
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1385
1363
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
@@ -1425,7 +1403,6 @@ export declare class KMS extends KMSClient {
|
|
|
1425
1403
|
* <p>
|
|
1426
1404
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1427
1405
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1428
|
-
*
|
|
1429
1406
|
* <p>
|
|
1430
1407
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKey</a> (key policy)</p>
|
|
1431
1408
|
* <p>
|
|
@@ -1469,11 +1446,9 @@ export declare class KMS extends KMSClient {
|
|
|
1469
1446
|
* perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes
|
|
1470
1447
|
* in the keys are random; they not related to the caller or to the KMS key that is used to
|
|
1471
1448
|
* encrypt the private key. </p>
|
|
1472
|
-
*
|
|
1473
1449
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
1474
1450
|
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
1475
1451
|
* When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
|
|
1476
|
-
*
|
|
1477
1452
|
* <p>To generate a data key pair, you must specify a symmetric encryption KMS key to encrypt
|
|
1478
1453
|
* the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
1479
1454
|
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
@@ -1481,7 +1456,6 @@ export declare class KMS extends KMSClient {
|
|
|
1481
1456
|
* key pair. In China Regions, you can also choose an SM2 data key pair. KMS recommends that you use
|
|
1482
1457
|
* ECC key pairs for signing, and use RSA and SM2 key pairs for either encryption or signing, but not both.
|
|
1483
1458
|
* However, KMS cannot enforce any restrictions on the use of data key pairs outside of KMS.</p>
|
|
1484
|
-
*
|
|
1485
1459
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
1486
1460
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
1487
1461
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a plaintext public key and an
|
|
@@ -1489,14 +1463,12 @@ export declare class KMS extends KMSClient {
|
|
|
1489
1463
|
* ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use
|
|
1490
1464
|
* the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
|
|
1491
1465
|
* pair.</p>
|
|
1492
|
-
*
|
|
1493
1466
|
* <p>
|
|
1494
1467
|
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1495
1468
|
* bytes in the keys are random; they are not related to the caller or the KMS key that is used
|
|
1496
1469
|
* to encrypt the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as
|
|
1497
1470
|
* specified in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The private
|
|
1498
1471
|
* key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</p>
|
|
1499
|
-
*
|
|
1500
1472
|
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
1501
1473
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1502
1474
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
@@ -1507,7 +1479,6 @@ export declare class KMS extends KMSClient {
|
|
|
1507
1479
|
* <p>
|
|
1508
1480
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1509
1481
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1510
|
-
*
|
|
1511
1482
|
* <p>
|
|
1512
1483
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPair</a> (key policy)</p>
|
|
1513
1484
|
* <p>
|
|
@@ -1565,7 +1536,6 @@ export declare class KMS extends KMSClient {
|
|
|
1565
1536
|
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
|
|
1566
1537
|
* the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1567
1538
|
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
1568
|
-
*
|
|
1569
1539
|
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
1570
1540
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1571
1541
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
@@ -1576,7 +1546,6 @@ export declare class KMS extends KMSClient {
|
|
|
1576
1546
|
* <p>
|
|
1577
1547
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1578
1548
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1579
|
-
*
|
|
1580
1549
|
* <p>
|
|
1581
1550
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPairWithoutPlaintext</a> (key
|
|
1582
1551
|
* policy)</p>
|
|
@@ -1633,22 +1602,17 @@ export declare class KMS extends KMSClient {
|
|
|
1633
1602
|
* plaintext data key.</p>
|
|
1634
1603
|
* <p>To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or
|
|
1635
1604
|
* <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
1636
|
-
*
|
|
1637
1605
|
* <p>To generate a data key, you must specify the symmetric encryption KMS key that is used to
|
|
1638
1606
|
* encrypt the data key. You cannot use an asymmetric KMS key or a key in a custom key store to generate a data key. To get the
|
|
1639
1607
|
* type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1640
|
-
*
|
|
1641
1608
|
* <p>You must also specify the length of the data key. Use either the <code>KeySpec</code> or
|
|
1642
1609
|
* <code>NumberOfBytes</code> parameters (but not both). For 128-bit and 256-bit data keys, use
|
|
1643
1610
|
* the <code>KeySpec</code> parameter.</p>
|
|
1644
|
-
*
|
|
1645
1611
|
* <p>To generate an SM4 data key (China Regions only), specify a <code>KeySpec</code> value of
|
|
1646
1612
|
* <code>AES_128</code> or <code>NumberOfBytes</code> value of <code>128</code>. The symmetric
|
|
1647
1613
|
* encryption key used in China Regions to encrypt your data key is an SM4 encryption key.</p>
|
|
1648
|
-
*
|
|
1649
1614
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
1650
1615
|
* <code>CiphertextBlob</code> field.</p>
|
|
1651
|
-
*
|
|
1652
1616
|
* <p>You can use an optional encryption context to add additional security to the encryption
|
|
1653
1617
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1654
1618
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
@@ -1659,7 +1623,6 @@ export declare class KMS extends KMSClient {
|
|
|
1659
1623
|
* <p>
|
|
1660
1624
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1661
1625
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1662
|
-
*
|
|
1663
1626
|
* <p>
|
|
1664
1627
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyWithoutPlaintext</a> (key
|
|
1665
1628
|
* policy)</p>
|
|
@@ -1740,7 +1703,6 @@ export declare class KMS extends KMSClient {
|
|
|
1740
1703
|
* <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>
|
|
1741
1704
|
* <p>For more information about entropy and random number generation, see
|
|
1742
1705
|
* <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
|
|
1743
|
-
*
|
|
1744
1706
|
* <p>
|
|
1745
1707
|
* <b>Cross-account use</b>: Not applicable.
|
|
1746
1708
|
* <code>GenerateRandom</code> does not use any account-specific resources, such as KMS
|
|
@@ -1755,7 +1717,6 @@ export declare class KMS extends KMSClient {
|
|
|
1755
1717
|
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
1756
1718
|
* <p>
|
|
1757
1719
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1758
|
-
*
|
|
1759
1720
|
* <p>
|
|
1760
1721
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyPolicy</a> (key policy)</p>
|
|
1761
1722
|
* <p>
|
|
@@ -1802,7 +1763,6 @@ export declare class KMS extends KMSClient {
|
|
|
1802
1763
|
* <p>
|
|
1803
1764
|
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
1804
1765
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1805
|
-
*
|
|
1806
1766
|
* <p>
|
|
1807
1767
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyRotationStatus</a> (key policy)</p>
|
|
1808
1768
|
* <p>
|
|
@@ -1842,7 +1802,6 @@ export declare class KMS extends KMSClient {
|
|
|
1842
1802
|
* 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>
|
|
1843
1803
|
* <p>
|
|
1844
1804
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1845
|
-
*
|
|
1846
1805
|
* <p>
|
|
1847
1806
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetParametersForImport</a> (key policy)</p>
|
|
1848
1807
|
* <p>
|
|
@@ -1875,7 +1834,6 @@ export declare class KMS extends KMSClient {
|
|
|
1875
1834
|
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
1876
1835
|
* are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
|
|
1877
1836
|
* decrypted. These features are not effective outside of KMS.</p>
|
|
1878
|
-
*
|
|
1879
1837
|
* <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
|
|
1880
1838
|
* important information about the public key in the response, including:</p>
|
|
1881
1839
|
* <ul>
|
|
@@ -1910,7 +1868,6 @@ export declare class KMS extends KMSClient {
|
|
|
1910
1868
|
* <b>Cross-account use</b>:
|
|
1911
1869
|
* Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1912
1870
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1913
|
-
*
|
|
1914
1871
|
* <p>
|
|
1915
1872
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetPublicKey</a> (key policy)</p>
|
|
1916
1873
|
* <p>
|
|
@@ -1968,7 +1925,6 @@ export declare class KMS extends KMSClient {
|
|
|
1968
1925
|
* 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>
|
|
1969
1926
|
* <p>
|
|
1970
1927
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1971
|
-
*
|
|
1972
1928
|
* <p>
|
|
1973
1929
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ImportKeyMaterial</a> (key policy)</p>
|
|
1974
1930
|
* <p>
|
|
@@ -2008,8 +1964,6 @@ export declare class KMS extends KMSClient {
|
|
|
2008
1964
|
* <p>
|
|
2009
1965
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
2010
1966
|
* return aliases in other Amazon Web Services accounts.</p>
|
|
2011
|
-
*
|
|
2012
|
-
*
|
|
2013
1967
|
* <p>
|
|
2014
1968
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListAliases</a> (IAM policy)</p>
|
|
2015
1969
|
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
@@ -2057,7 +2011,6 @@ export declare class KMS extends KMSClient {
|
|
|
2057
2011
|
* <p>
|
|
2058
2012
|
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
2059
2013
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2060
|
-
*
|
|
2061
2014
|
* <p>
|
|
2062
2015
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListGrants</a> (key policy)</p>
|
|
2063
2016
|
* <p>
|
|
@@ -2095,7 +2048,6 @@ export declare class KMS extends KMSClient {
|
|
|
2095
2048
|
* However, the only valid policy name is <code>default</code>. </p>
|
|
2096
2049
|
* <p>
|
|
2097
2050
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2098
|
-
*
|
|
2099
2051
|
* <p>
|
|
2100
2052
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeyPolicies</a> (key policy)</p>
|
|
2101
2053
|
* <p>
|
|
@@ -2121,7 +2073,6 @@ export declare class KMS extends KMSClient {
|
|
|
2121
2073
|
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
|
|
2122
2074
|
* <p>
|
|
2123
2075
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2124
|
-
*
|
|
2125
2076
|
* <p>
|
|
2126
2077
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeys</a> (IAM policy)</p>
|
|
2127
2078
|
* <p>
|
|
@@ -2161,7 +2112,6 @@ export declare class KMS extends KMSClient {
|
|
|
2161
2112
|
* keys</a>.</p>
|
|
2162
2113
|
* <p>
|
|
2163
2114
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2164
|
-
*
|
|
2165
2115
|
* <p>
|
|
2166
2116
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListResourceTags</a> (key policy)</p>
|
|
2167
2117
|
* <p>
|
|
@@ -2209,7 +2159,6 @@ export declare class KMS extends KMSClient {
|
|
|
2209
2159
|
* Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
|
|
2210
2160
|
* <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
|
|
2211
2161
|
* Amazon Web Services account other than your own.</p>
|
|
2212
|
-
*
|
|
2213
2162
|
* <p>
|
|
2214
2163
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
|
|
2215
2164
|
* Amazon Web Services account.</p>
|
|
@@ -2251,7 +2200,6 @@ export declare class KMS extends KMSClient {
|
|
|
2251
2200
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy">Setting a key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2252
2201
|
* <p>
|
|
2253
2202
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2254
|
-
*
|
|
2255
2203
|
* <p>
|
|
2256
2204
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:PutKeyPolicy</a> (key policy)</p>
|
|
2257
2205
|
* <p>
|
|
@@ -2301,7 +2249,6 @@ export declare class KMS extends KMSClient {
|
|
|
2301
2249
|
* specify the KMS key that re-encrypts the data after it is decrypted. If the destination
|
|
2302
2250
|
* KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The
|
|
2303
2251
|
* algorithm that you choose must be compatible with the KMS key.</p>
|
|
2304
|
-
*
|
|
2305
2252
|
* <important>
|
|
2306
2253
|
* <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
|
|
2307
2254
|
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric encryption KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
@@ -2315,7 +2262,6 @@ export declare class KMS extends KMSClient {
|
|
|
2315
2262
|
* destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a
|
|
2316
2263
|
* different account than the caller. To specify a KMS key in a different account, you must use
|
|
2317
2264
|
* its key ARN or alias ARN.</p>
|
|
2318
|
-
*
|
|
2319
2265
|
* <p>
|
|
2320
2266
|
* <b>Required permissions</b>:</p>
|
|
2321
2267
|
* <ul>
|
|
@@ -2334,7 +2280,6 @@ export declare class KMS extends KMSClient {
|
|
|
2334
2280
|
* permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is
|
|
2335
2281
|
* automatically included in the key policy when you use the console to create a KMS key. But you
|
|
2336
2282
|
* must include it manually when you create a KMS key programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p>
|
|
2337
|
-
*
|
|
2338
2283
|
* <p>
|
|
2339
2284
|
* <b>Related operations:</b>
|
|
2340
2285
|
* </p>
|
|
@@ -2591,8 +2536,6 @@ export declare class KMS extends KMSClient {
|
|
|
2591
2536
|
* 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>
|
|
2592
2537
|
* <p>
|
|
2593
2538
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2594
|
-
*
|
|
2595
|
-
*
|
|
2596
2539
|
* <p>
|
|
2597
2540
|
* <b>Required permissions</b>: kms:ScheduleKeyDeletion (key
|
|
2598
2541
|
* policy)</p>
|
|
@@ -2663,7 +2606,6 @@ export declare class KMS extends KMSClient {
|
|
|
2663
2606
|
* <p>
|
|
2664
2607
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2665
2608
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2666
|
-
*
|
|
2667
2609
|
* <p>
|
|
2668
2610
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Sign</a> (key policy)</p>
|
|
2669
2611
|
* <p>
|
|
@@ -2694,7 +2636,6 @@ export declare class KMS extends KMSClient {
|
|
|
2694
2636
|
* 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>
|
|
2695
2637
|
* <p>
|
|
2696
2638
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2697
|
-
*
|
|
2698
2639
|
* <p>
|
|
2699
2640
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
|
|
2700
2641
|
* <p>
|
|
@@ -2735,7 +2676,6 @@ export declare class KMS extends KMSClient {
|
|
|
2735
2676
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
2736
2677
|
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
|
|
2737
2678
|
* return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
2738
|
-
*
|
|
2739
2679
|
* <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
|
|
2740
2680
|
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
2741
2681
|
* Web Services General Reference</i>. </p>
|
|
@@ -2743,7 +2683,6 @@ export declare class KMS extends KMSClient {
|
|
|
2743
2683
|
* 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>
|
|
2744
2684
|
* <p>
|
|
2745
2685
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2746
|
-
*
|
|
2747
2686
|
* <p>
|
|
2748
2687
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
|
|
2749
2688
|
* <p>
|
|
@@ -2947,7 +2886,6 @@ export declare class KMS extends KMSClient {
|
|
|
2947
2886
|
* 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>
|
|
2948
2887
|
* <p>
|
|
2949
2888
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2950
|
-
*
|
|
2951
2889
|
* <p>
|
|
2952
2890
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
|
|
2953
2891
|
* <p>
|
|
@@ -3050,9 +2988,11 @@ export declare class KMS extends KMSClient {
|
|
|
3050
2988
|
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
3051
2989
|
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
3052
2990
|
* For information about asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3053
|
-
* <p>To
|
|
2991
|
+
* <p>To use the <code>Verify</code> operation, specify the
|
|
3054
2992
|
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
3055
|
-
* signature
|
|
2993
|
+
* signature. The message type does not need to be the same as the one used for signing, but it must
|
|
2994
|
+
* indicate whether the value of the <code>Message</code> parameter should be
|
|
2995
|
+
* hashed as part of the verification process.</p>
|
|
3056
2996
|
* <p>You can also verify the digital signature by using the public key of the KMS key outside
|
|
3057
2997
|
* of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
3058
2998
|
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
@@ -3095,7 +3035,6 @@ export declare class KMS extends KMSClient {
|
|
|
3095
3035
|
* <p>
|
|
3096
3036
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
3097
3037
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
3098
|
-
*
|
|
3099
3038
|
* <p>
|
|
3100
3039
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:VerifyMac</a> (key policy)</p>
|
|
3101
3040
|
* <p>
|
|
@@ -202,12 +202,12 @@ export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
|
|
|
202
202
|
* <p>
|
|
203
203
|
* <b>Signing Requests</b>
|
|
204
204
|
* </p>
|
|
205
|
-
* <p>Requests must be signed
|
|
206
|
-
* recommend that you
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
* <p>All KMS
|
|
205
|
+
* <p>Requests must be signed using an access key ID and a secret access key. We strongly
|
|
206
|
+
* recommend that you do not use your Amazon Web Services account root access key ID and secret access key for
|
|
207
|
+
* everyday work. You can use the access key ID and secret access key for an IAM user or you
|
|
208
|
+
* can use the Security Token Service (STS) to generate temporary security credentials and use those to sign
|
|
209
|
+
* requests. </p>
|
|
210
|
+
* <p>All KMS requests must be signed with <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
211
211
|
* <p>
|
|
212
212
|
* <b>Logging API Requests</b>
|
|
213
213
|
* </p>
|
|
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CancelKeyDeletionRequest, CancelKeyDeletionResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* The input for {@link CancelKeyDeletionCommand}.
|
|
8
|
+
*/
|
|
6
9
|
export interface CancelKeyDeletionCommandInput extends CancelKeyDeletionRequest {
|
|
7
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* The output of {@link CancelKeyDeletionCommand}.
|
|
13
|
+
*/
|
|
8
14
|
export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionResponse, __MetadataBearer {
|
|
9
15
|
}
|
|
10
16
|
/**
|
|
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { ConnectCustomKeyStoreRequest, ConnectCustomKeyStoreResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* The input for {@link ConnectCustomKeyStoreCommand}.
|
|
8
|
+
*/
|
|
6
9
|
export interface ConnectCustomKeyStoreCommandInput extends ConnectCustomKeyStoreRequest {
|
|
7
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* The output of {@link ConnectCustomKeyStoreCommand}.
|
|
13
|
+
*/
|
|
8
14
|
export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStoreResponse, __MetadataBearer {
|
|
9
15
|
}
|
|
10
16
|
/**
|
|
@@ -63,7 +69,6 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
|
|
|
63
69
|
* key store</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
64
70
|
* <p>
|
|
65
71
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
66
|
-
*
|
|
67
72
|
* <p>
|
|
68
73
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ConnectCustomKeyStore</a> (IAM policy)</p>
|
|
69
74
|
* <p>
|
|
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateAliasRequest } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* The input for {@link CreateAliasCommand}.
|
|
8
|
+
*/
|
|
6
9
|
export interface CreateAliasCommandInput extends CreateAliasRequest {
|
|
7
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* The output of {@link CreateAliasCommand}.
|
|
13
|
+
*/
|
|
8
14
|
export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
9
15
|
}
|
|
10
16
|
/**
|
|
@@ -28,7 +34,6 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
|
28
34
|
* 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>
|
|
29
35
|
* <p>
|
|
30
36
|
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
31
|
-
*
|
|
32
37
|
* <p>
|
|
33
38
|
* <b>Required permissions</b>
|
|
34
39
|
* </p>
|
|
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateCustomKeyStoreRequest, CreateCustomKeyStoreResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* The input for {@link CreateCustomKeyStoreCommand}.
|
|
8
|
+
*/
|
|
6
9
|
export interface CreateCustomKeyStoreCommandInput extends CreateCustomKeyStoreRequest {
|
|
7
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* The output of {@link CreateCustomKeyStoreCommand}.
|
|
13
|
+
*/
|
|
8
14
|
export interface CreateCustomKeyStoreCommandOutput extends CreateCustomKeyStoreResponse, __MetadataBearer {
|
|
9
15
|
}
|
|
10
16
|
/**
|
|
@@ -3,8 +3,14 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
|
3
3
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateGrantRequest, CreateGrantResponse } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* The input for {@link CreateGrantCommand}.
|
|
8
|
+
*/
|
|
6
9
|
export interface CreateGrantCommandInput extends CreateGrantRequest {
|
|
7
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* The output of {@link CreateGrantCommand}.
|
|
13
|
+
*/
|
|
8
14
|
export interface CreateGrantCommandOutput extends CreateGrantResponse, __MetadataBearer {
|
|
9
15
|
}
|
|
10
16
|
/**
|