@aws-sdk/client-kms 3.295.0 → 3.297.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-types/KMS.d.ts +51 -0
- package/dist-types/KMSClient.d.ts +24 -4
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateAliasCommand.d.ts +16 -0
- package/dist-types/commands/CreateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/CreateGrantCommand.d.ts +16 -0
- package/dist-types/commands/CreateKeyCommand.d.ts +16 -0
- package/dist-types/commands/DecryptCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAliasCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +16 -0
- package/dist-types/commands/DescribeKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyCommand.d.ts +16 -0
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyCommand.d.ts +16 -0
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +16 -0
- package/dist-types/commands/EncryptCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +16 -0
- package/dist-types/commands/GenerateMacCommand.d.ts +16 -0
- package/dist-types/commands/GenerateRandomCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetParametersForImportCommand.d.ts +16 -0
- package/dist-types/commands/GetPublicKeyCommand.d.ts +16 -0
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +16 -0
- package/dist-types/commands/ListAliasesCommand.d.ts +16 -0
- package/dist-types/commands/ListGrantsCommand.d.ts +16 -0
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListKeysCommand.d.ts +16 -0
- package/dist-types/commands/ListResourceTagsCommand.d.ts +16 -0
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +16 -0
- package/dist-types/commands/PutKeyPolicyCommand.d.ts +16 -0
- package/dist-types/commands/ReEncryptCommand.d.ts +16 -0
- package/dist-types/commands/ReplicateKeyCommand.d.ts +16 -0
- package/dist-types/commands/RetireGrantCommand.d.ts +16 -0
- package/dist-types/commands/RevokeGrantCommand.d.ts +16 -0
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +16 -0
- package/dist-types/commands/SignCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAliasCommand.d.ts +16 -0
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +16 -0
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +16 -0
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +16 -0
- package/dist-types/commands/VerifyCommand.d.ts +16 -0
- package/dist-types/commands/VerifyMacCommand.d.ts +16 -0
- package/dist-types/models/KMSServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +373 -0
- package/dist-types/pagination/DescribeCustomKeyStoresPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAliasesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListGrantsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeyPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListKeysPaginator.d.ts +3 -0
- package/dist-types/pagination/ListResourceTagsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListRetirableGrantsPaginator.d.ts +3 -0
- package/package.json +29 -29
package/dist-types/KMS.d.ts
CHANGED
|
@@ -51,6 +51,7 @@ import { VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyComman
|
|
|
51
51
|
import { VerifyMacCommandInput, VerifyMacCommandOutput } from "./commands/VerifyMacCommand";
|
|
52
52
|
import { KMSClient } from "./KMSClient";
|
|
53
53
|
/**
|
|
54
|
+
* @public
|
|
54
55
|
* <fullname>Key Management Service</fullname>
|
|
55
56
|
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
56
57
|
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
@@ -149,6 +150,7 @@ import { KMSClient } from "./KMSClient";
|
|
|
149
150
|
*/
|
|
150
151
|
export declare class KMS extends KMSClient {
|
|
151
152
|
/**
|
|
153
|
+
* @public
|
|
152
154
|
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
|
|
153
155
|
* key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
154
156
|
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
@@ -167,6 +169,7 @@ export declare class KMS extends KMSClient {
|
|
|
167
169
|
cancelKeyDeletion(args: CancelKeyDeletionCommandInput, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
|
|
168
170
|
cancelKeyDeletion(args: CancelKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
|
|
169
171
|
/**
|
|
172
|
+
* @public
|
|
170
173
|
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its backing key store. For an CloudHSM key
|
|
171
174
|
* store, <code>ConnectCustomKeyStore</code> connects the key store to its associated CloudHSM
|
|
172
175
|
* cluster. For an external key store, <code>ConnectCustomKeyStore</code> connects the key store
|
|
@@ -259,6 +262,7 @@ export declare class KMS extends KMSClient {
|
|
|
259
262
|
connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
|
|
260
263
|
connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
|
|
261
264
|
/**
|
|
265
|
+
* @public
|
|
262
266
|
* <p>Creates a friendly name for a KMS key. </p>
|
|
263
267
|
* <note>
|
|
264
268
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -321,6 +325,7 @@ export declare class KMS extends KMSClient {
|
|
|
321
325
|
createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
|
|
322
326
|
createAlias(args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
|
|
323
327
|
/**
|
|
328
|
+
* @public
|
|
324
329
|
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> backed by a key store that you own and manage. When you use a
|
|
325
330
|
* KMS key in a custom key store for a cryptographic operation, the cryptographic operation is
|
|
326
331
|
* actually performed in your key store using your keys. KMS supports <a href="https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html">CloudHSM key stores</a>
|
|
@@ -414,6 +419,7 @@ export declare class KMS extends KMSClient {
|
|
|
414
419
|
createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
|
|
415
420
|
createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
|
|
416
421
|
/**
|
|
422
|
+
* @public
|
|
417
423
|
* <p>Adds a grant to a KMS key. </p>
|
|
418
424
|
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
419
425
|
* KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key,
|
|
@@ -481,6 +487,7 @@ export declare class KMS extends KMSClient {
|
|
|
481
487
|
createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
482
488
|
createGrant(args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
483
489
|
/**
|
|
490
|
+
* @public
|
|
484
491
|
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and Region.
|
|
485
492
|
* You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services
|
|
486
493
|
* services let you use KMS keys that you create and manage to protect your service
|
|
@@ -653,6 +660,7 @@ export declare class KMS extends KMSClient {
|
|
|
653
660
|
createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
654
661
|
createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
655
662
|
/**
|
|
663
|
+
* @public
|
|
656
664
|
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
|
|
657
665
|
* operations:</p>
|
|
658
666
|
* <ul>
|
|
@@ -746,6 +754,7 @@ export declare class KMS extends KMSClient {
|
|
|
746
754
|
decrypt(args: DecryptCommandInput, cb: (err: any, data?: DecryptCommandOutput) => void): void;
|
|
747
755
|
decrypt(args: DecryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecryptCommandOutput) => void): void;
|
|
748
756
|
/**
|
|
757
|
+
* @public
|
|
749
758
|
* <p>Deletes the specified alias. </p>
|
|
750
759
|
* <note>
|
|
751
760
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -799,6 +808,7 @@ export declare class KMS extends KMSClient {
|
|
|
799
808
|
deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
|
|
800
809
|
deleteAlias(args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
|
|
801
810
|
/**
|
|
811
|
+
* @public
|
|
802
812
|
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not affect any backing elements of the
|
|
803
813
|
* custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key
|
|
804
814
|
* store, or affect any users or keys in the cluster. For an external key store, it does not
|
|
@@ -863,6 +873,7 @@ export declare class KMS extends KMSClient {
|
|
|
863
873
|
deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
|
|
864
874
|
deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
|
|
865
875
|
/**
|
|
876
|
+
* @public
|
|
866
877
|
* <p>Deletes key material that you previously imported. This operation makes the specified KMS
|
|
867
878
|
* key unusable. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
|
|
868
879
|
* in the <i>Key Management Service Developer Guide</i>. </p>
|
|
@@ -897,6 +908,7 @@ export declare class KMS extends KMSClient {
|
|
|
897
908
|
deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void): void;
|
|
898
909
|
deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void): void;
|
|
899
910
|
/**
|
|
911
|
+
* @public
|
|
900
912
|
* <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and Region.</p>
|
|
901
913
|
* <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
|
|
902
914
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
@@ -961,6 +973,7 @@ export declare class KMS extends KMSClient {
|
|
|
961
973
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
962
974
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
963
975
|
/**
|
|
976
|
+
* @public
|
|
964
977
|
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
|
|
965
978
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
966
979
|
* key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
|
|
@@ -1049,6 +1062,7 @@ export declare class KMS extends KMSClient {
|
|
|
1049
1062
|
describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
1050
1063
|
describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
1051
1064
|
/**
|
|
1065
|
+
* @public
|
|
1052
1066
|
* <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
|
|
1053
1067
|
* key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
1054
1068
|
* <p>For more information about how key state affects the use of a KMS key, see
|
|
@@ -1069,6 +1083,7 @@ export declare class KMS extends KMSClient {
|
|
|
1069
1083
|
disableKey(args: DisableKeyCommandInput, cb: (err: any, data?: DisableKeyCommandOutput) => void): void;
|
|
1070
1084
|
disableKey(args: DisableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyCommandOutput) => void): void;
|
|
1071
1085
|
/**
|
|
1086
|
+
* @public
|
|
1072
1087
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
1073
1088
|
* rotation of the key material</a> of the specified symmetric encryption KMS key.</p>
|
|
1074
1089
|
* <p>Automatic key rotation is supported only on symmetric encryption KMS keys.
|
|
@@ -1107,6 +1122,7 @@ export declare class KMS extends KMSClient {
|
|
|
1107
1122
|
disableKeyRotation(args: DisableKeyRotationCommandInput, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
|
|
1108
1123
|
disableKeyRotation(args: DisableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
|
|
1109
1124
|
/**
|
|
1125
|
+
* @public
|
|
1110
1126
|
* <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
|
|
1111
1127
|
* CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from
|
|
1112
1128
|
* the external key store proxy that communicates with your external key manager.</p>
|
|
@@ -1164,6 +1180,7 @@ export declare class KMS extends KMSClient {
|
|
|
1164
1180
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1165
1181
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1166
1182
|
/**
|
|
1183
|
+
* @public
|
|
1167
1184
|
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
1168
1185
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
1169
1186
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
@@ -1180,6 +1197,7 @@ export declare class KMS extends KMSClient {
|
|
|
1180
1197
|
enableKey(args: EnableKeyCommandInput, cb: (err: any, data?: EnableKeyCommandOutput) => void): void;
|
|
1181
1198
|
enableKey(args: EnableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyCommandOutput) => void): void;
|
|
1182
1199
|
/**
|
|
1200
|
+
* @public
|
|
1183
1201
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
1184
1202
|
* of the key material</a> of the specified symmetric encryption KMS key. </p>
|
|
1185
1203
|
* <p>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
|
|
@@ -1226,6 +1244,7 @@ export declare class KMS extends KMSClient {
|
|
|
1226
1244
|
enableKeyRotation(args: EnableKeyRotationCommandInput, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1227
1245
|
enableKeyRotation(args: EnableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1228
1246
|
/**
|
|
1247
|
+
* @public
|
|
1229
1248
|
* <p>Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or
|
|
1230
1249
|
* asymmetric KMS key with a <code>KeyUsage</code> of <code>ENCRYPT_DECRYPT</code>.</p>
|
|
1231
1250
|
* <p>You can use this operation to encrypt small amounts of arbitrary data, such as a personal
|
|
@@ -1341,6 +1360,7 @@ export declare class KMS extends KMSClient {
|
|
|
1341
1360
|
encrypt(args: EncryptCommandInput, cb: (err: any, data?: EncryptCommandOutput) => void): void;
|
|
1342
1361
|
encrypt(args: EncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EncryptCommandOutput) => void): void;
|
|
1343
1362
|
/**
|
|
1363
|
+
* @public
|
|
1344
1364
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
1345
1365
|
* plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS
|
|
1346
1366
|
* key that you specify. The bytes in the plaintext key are random; they are not related
|
|
@@ -1440,6 +1460,7 @@ export declare class KMS extends KMSClient {
|
|
|
1440
1460
|
generateDataKey(args: GenerateDataKeyCommandInput, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void): void;
|
|
1441
1461
|
generateDataKey(args: GenerateDataKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyCommandOutput) => void): void;
|
|
1442
1462
|
/**
|
|
1463
|
+
* @public
|
|
1443
1464
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
1444
1465
|
* a plaintext public key, a plaintext private key, and a copy of the private key that is
|
|
1445
1466
|
* encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to
|
|
@@ -1516,6 +1537,7 @@ export declare class KMS extends KMSClient {
|
|
|
1516
1537
|
generateDataKeyPair(args: GenerateDataKeyPairCommandInput, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void): void;
|
|
1517
1538
|
generateDataKeyPair(args: GenerateDataKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairCommandOutput) => void): void;
|
|
1518
1539
|
/**
|
|
1540
|
+
* @public
|
|
1519
1541
|
* <p>Returns a unique asymmetric data key pair for use outside of KMS. This operation returns
|
|
1520
1542
|
* a plaintext public key and a copy of the private key that is encrypted under the symmetric
|
|
1521
1543
|
* encryption KMS key you specify. Unlike <a>GenerateDataKeyPair</a>, this operation
|
|
@@ -1584,6 +1606,7 @@ export declare class KMS extends KMSClient {
|
|
|
1584
1606
|
generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
|
|
1585
1607
|
generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
|
|
1586
1608
|
/**
|
|
1609
|
+
* @public
|
|
1587
1610
|
* <p>Returns a unique symmetric data key for use outside of KMS. This operation returns a
|
|
1588
1611
|
* data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in
|
|
1589
1612
|
* the key are random; they are not related to the caller or to the KMS key.</p>
|
|
@@ -1661,6 +1684,7 @@ export declare class KMS extends KMSClient {
|
|
|
1661
1684
|
generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void): void;
|
|
1662
1685
|
generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void): void;
|
|
1663
1686
|
/**
|
|
1687
|
+
* @public
|
|
1664
1688
|
* <p>Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports.
|
|
1665
1689
|
* HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in <a href="https://datatracker.ietf.org/doc/html/rfc2104">RFC 2104</a>.</p>
|
|
1666
1690
|
* <p>You can use value that GenerateMac returns in the <a>VerifyMac</a> operation to
|
|
@@ -1694,6 +1718,7 @@ export declare class KMS extends KMSClient {
|
|
|
1694
1718
|
generateMac(args: GenerateMacCommandInput, cb: (err: any, data?: GenerateMacCommandOutput) => void): void;
|
|
1695
1719
|
generateMac(args: GenerateMacCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateMacCommandOutput) => void): void;
|
|
1696
1720
|
/**
|
|
1721
|
+
* @public
|
|
1697
1722
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
1698
1723
|
* <p>You must use the <code>NumberOfBytes</code> parameter to specify the length of the random
|
|
1699
1724
|
* byte string. There is no default value for string length.</p>
|
|
@@ -1714,6 +1739,7 @@ export declare class KMS extends KMSClient {
|
|
|
1714
1739
|
generateRandom(args: GenerateRandomCommandInput, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
1715
1740
|
generateRandom(args: GenerateRandomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
1716
1741
|
/**
|
|
1742
|
+
* @public
|
|
1717
1743
|
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
1718
1744
|
* <p>
|
|
1719
1745
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -1727,6 +1753,7 @@ export declare class KMS extends KMSClient {
|
|
|
1727
1753
|
getKeyPolicy(args: GetKeyPolicyCommandInput, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void;
|
|
1728
1754
|
getKeyPolicy(args: GetKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void;
|
|
1729
1755
|
/**
|
|
1756
|
+
* @public
|
|
1730
1757
|
* <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is
|
|
1731
1758
|
* enabled for the specified KMS key.</p>
|
|
1732
1759
|
* <p>When you enable automatic rotation for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed KMS keys</a>, KMS
|
|
@@ -1785,6 +1812,7 @@ export declare class KMS extends KMSClient {
|
|
|
1785
1812
|
getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
|
|
1786
1813
|
getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
|
|
1787
1814
|
/**
|
|
1815
|
+
* @public
|
|
1788
1816
|
* <p>Returns the items you need to import key material into a symmetric encryption KMS key. For
|
|
1789
1817
|
* more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing key material</a> in the
|
|
1790
1818
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -1824,6 +1852,7 @@ export declare class KMS extends KMSClient {
|
|
|
1824
1852
|
getParametersForImport(args: GetParametersForImportCommandInput, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1825
1853
|
getParametersForImport(args: GetParametersForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1826
1854
|
/**
|
|
1855
|
+
* @public
|
|
1827
1856
|
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
|
|
1828
1857
|
* KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
|
|
1829
1858
|
* permission can download the public key of an asymmetric KMS key. You can share the public key
|
|
@@ -1878,6 +1907,7 @@ export declare class KMS extends KMSClient {
|
|
|
1878
1907
|
getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1879
1908
|
getPublicKey(args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1880
1909
|
/**
|
|
1910
|
+
* @public
|
|
1881
1911
|
* <p>Imports key material into an existing symmetric encryption KMS key that was created
|
|
1882
1912
|
* without key material. After you successfully import key material into a KMS key, you can
|
|
1883
1913
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that KMS key, but you cannot import different
|
|
@@ -1947,6 +1977,7 @@ export declare class KMS extends KMSClient {
|
|
|
1947
1977
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1948
1978
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1949
1979
|
/**
|
|
1980
|
+
* @public
|
|
1950
1981
|
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
|
|
1951
1982
|
* about aliases, see <a>CreateAlias</a>.</p>
|
|
1952
1983
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
@@ -1993,6 +2024,7 @@ export declare class KMS extends KMSClient {
|
|
|
1993
2024
|
listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
1994
2025
|
listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
1995
2026
|
/**
|
|
2027
|
+
* @public
|
|
1996
2028
|
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
1997
2029
|
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
|
|
1998
2030
|
* grantee principal.</p>
|
|
@@ -2043,6 +2075,7 @@ export declare class KMS extends KMSClient {
|
|
|
2043
2075
|
listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
2044
2076
|
listGrants(args: ListGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
2045
2077
|
/**
|
|
2078
|
+
* @public
|
|
2046
2079
|
* <p>Gets the names of the key policies that are attached to a KMS key. This operation is
|
|
2047
2080
|
* designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation.
|
|
2048
2081
|
* However, the only valid policy name is <code>default</code>. </p>
|
|
@@ -2070,6 +2103,7 @@ export declare class KMS extends KMSClient {
|
|
|
2070
2103
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
2071
2104
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
2072
2105
|
/**
|
|
2106
|
+
* @public
|
|
2073
2107
|
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
|
|
2074
2108
|
* <p>
|
|
2075
2109
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
@@ -2105,6 +2139,7 @@ export declare class KMS extends KMSClient {
|
|
|
2105
2139
|
listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
2106
2140
|
listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
2107
2141
|
/**
|
|
2142
|
+
* @public
|
|
2108
2143
|
* <p>Returns all tags on the specified KMS key.</p>
|
|
2109
2144
|
* <p>For general information about 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
|
|
2110
2145
|
* the <i>Amazon Web Services General Reference</i>. For information about using
|
|
@@ -2144,6 +2179,7 @@ export declare class KMS extends KMSClient {
|
|
|
2144
2179
|
listResourceTags(args: ListResourceTagsCommandInput, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
2145
2180
|
listResourceTags(args: ListResourceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
2146
2181
|
/**
|
|
2182
|
+
* @public
|
|
2147
2183
|
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the
|
|
2148
2184
|
* specified retiring principal. </p>
|
|
2149
2185
|
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
@@ -2192,6 +2228,7 @@ export declare class KMS extends KMSClient {
|
|
|
2192
2228
|
listRetirableGrants(args: ListRetirableGrantsCommandInput, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
|
|
2193
2229
|
listRetirableGrants(args: ListRetirableGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
|
|
2194
2230
|
/**
|
|
2231
|
+
* @public
|
|
2195
2232
|
* <p>Attaches a key policy to the specified KMS key. </p>
|
|
2196
2233
|
* <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>Key Management Service Developer Guide</i>.
|
|
2197
2234
|
* For help writing and formatting a JSON policy document, see the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON Policy Reference</a> in the <i>
|
|
@@ -2210,6 +2247,7 @@ export declare class KMS extends KMSClient {
|
|
|
2210
2247
|
putKeyPolicy(args: PutKeyPolicyCommandInput, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
|
|
2211
2248
|
putKeyPolicy(args: PutKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
|
|
2212
2249
|
/**
|
|
2250
|
+
* @public
|
|
2213
2251
|
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
2214
2252
|
* operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually
|
|
2215
2253
|
* rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
|
|
@@ -2310,6 +2348,7 @@ export declare class KMS extends KMSClient {
|
|
|
2310
2348
|
reEncrypt(args: ReEncryptCommandInput, cb: (err: any, data?: ReEncryptCommandOutput) => void): void;
|
|
2311
2349
|
reEncrypt(args: ReEncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReEncryptCommandOutput) => void): void;
|
|
2312
2350
|
/**
|
|
2351
|
+
* @public
|
|
2313
2352
|
* <p>Replicates a multi-Region key into the specified Region. This operation creates a
|
|
2314
2353
|
* multi-Region replica key based on a multi-Region primary key in a different Region of the same
|
|
2315
2354
|
* Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
|
|
@@ -2398,6 +2437,7 @@ export declare class KMS extends KMSClient {
|
|
|
2398
2437
|
replicateKey(args: ReplicateKeyCommandInput, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void;
|
|
2399
2438
|
replicateKey(args: ReplicateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ReplicateKeyCommandOutput) => void): void;
|
|
2400
2439
|
/**
|
|
2440
|
+
* @public
|
|
2401
2441
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
2402
2442
|
* identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
|
|
2403
2443
|
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
|
|
@@ -2449,6 +2489,7 @@ export declare class KMS extends KMSClient {
|
|
|
2449
2489
|
retireGrant(args: RetireGrantCommandInput, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
|
|
2450
2490
|
retireGrant(args: RetireGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
|
|
2451
2491
|
/**
|
|
2492
|
+
* @public
|
|
2452
2493
|
* <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
|
|
2453
2494
|
* grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
2454
2495
|
* the <i>
|
|
@@ -2498,6 +2539,7 @@ export declare class KMS extends KMSClient {
|
|
|
2498
2539
|
revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2499
2540
|
revokeGrant(args: RevokeGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2500
2541
|
/**
|
|
2542
|
+
* @public
|
|
2501
2543
|
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
|
|
2502
2544
|
* days, but you can specify a waiting period of 7-30 days. When this operation is successful,
|
|
2503
2545
|
* the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used
|
|
@@ -2559,6 +2601,7 @@ export declare class KMS extends KMSClient {
|
|
|
2559
2601
|
scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
|
|
2560
2602
|
scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
|
|
2561
2603
|
/**
|
|
2604
|
+
* @public
|
|
2562
2605
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
2563
2606
|
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
2564
2607
|
* signing KMS key. To verify the signature, use the <a>Verify</a> operation, or use
|
|
@@ -2616,6 +2659,7 @@ export declare class KMS extends KMSClient {
|
|
|
2616
2659
|
sign(args: SignCommandInput, cb: (err: any, data?: SignCommandOutput) => void): void;
|
|
2617
2660
|
sign(args: SignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignCommandOutput) => void): void;
|
|
2618
2661
|
/**
|
|
2662
|
+
* @public
|
|
2619
2663
|
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
2620
2664
|
* <note>
|
|
2621
2665
|
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -2668,6 +2712,7 @@ export declare class KMS extends KMSClient {
|
|
|
2668
2712
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
2669
2713
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
2670
2714
|
/**
|
|
2715
|
+
* @public
|
|
2671
2716
|
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
2672
2717
|
* specify the tag key and the KMS key.</p>
|
|
2673
2718
|
* <note>
|
|
@@ -2715,6 +2760,7 @@ export declare class KMS extends KMSClient {
|
|
|
2715
2760
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2716
2761
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2717
2762
|
/**
|
|
2763
|
+
* @public
|
|
2718
2764
|
* <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
|
|
2719
2765
|
* only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
|
|
2720
2766
|
* KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
@@ -2783,6 +2829,7 @@ export declare class KMS extends KMSClient {
|
|
|
2783
2829
|
updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
|
|
2784
2830
|
updateAlias(args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
|
|
2785
2831
|
/**
|
|
2832
|
+
* @public
|
|
2786
2833
|
* <p>Changes the properties of a custom key store. You can use this operation to change the
|
|
2787
2834
|
* properties of an CloudHSM key store or an external key store.</p>
|
|
2788
2835
|
* <p>Use the required <code>CustomKeyStoreId</code> parameter to identify the custom key store.
|
|
@@ -2881,6 +2928,7 @@ export declare class KMS extends KMSClient {
|
|
|
2881
2928
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2882
2929
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2883
2930
|
/**
|
|
2931
|
+
* @public
|
|
2884
2932
|
* <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
|
|
2885
2933
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2886
2934
|
* 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>
|
|
@@ -2908,6 +2956,7 @@ export declare class KMS extends KMSClient {
|
|
|
2908
2956
|
updateKeyDescription(args: UpdateKeyDescriptionCommandInput, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void): void;
|
|
2909
2957
|
updateKeyDescription(args: UpdateKeyDescriptionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKeyDescriptionCommandOutput) => void): void;
|
|
2910
2958
|
/**
|
|
2959
|
+
* @public
|
|
2911
2960
|
* <p>Changes the primary key of a multi-Region key. </p>
|
|
2912
2961
|
* <p>This operation changes the replica key in the specified Region to a primary key and
|
|
2913
2962
|
* changes the former primary key to a replica key. For example, suppose you have a primary key
|
|
@@ -2978,6 +3027,7 @@ export declare class KMS extends KMSClient {
|
|
|
2978
3027
|
updatePrimaryRegion(args: UpdatePrimaryRegionCommandInput, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void): void;
|
|
2979
3028
|
updatePrimaryRegion(args: UpdatePrimaryRegionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdatePrimaryRegionCommandOutput) => void): void;
|
|
2980
3029
|
/**
|
|
3030
|
+
* @public
|
|
2981
3031
|
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
2982
3032
|
* <p></p>
|
|
2983
3033
|
* <p>Verification confirms that an authorized user signed the message with the specified KMS
|
|
@@ -3019,6 +3069,7 @@ export declare class KMS extends KMSClient {
|
|
|
3019
3069
|
verify(args: VerifyCommandInput, cb: (err: any, data?: VerifyCommandOutput) => void): void;
|
|
3020
3070
|
verify(args: VerifyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyCommandOutput) => void): void;
|
|
3021
3071
|
/**
|
|
3072
|
+
* @public
|
|
3022
3073
|
* <p>Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC
|
|
3023
3074
|
* KMS key, and MAC algorithm. To verify the HMAC, <code>VerifyMac</code> computes an HMAC using
|
|
3024
3075
|
* the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC
|
|
@@ -58,15 +58,24 @@ import { UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput } fro
|
|
|
58
58
|
import { VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyCommand";
|
|
59
59
|
import { VerifyMacCommandInput, VerifyMacCommandOutput } from "./commands/VerifyMacCommand";
|
|
60
60
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
61
64
|
export type ServiceInputTypes = CancelKeyDeletionCommandInput | ConnectCustomKeyStoreCommandInput | CreateAliasCommandInput | CreateCustomKeyStoreCommandInput | CreateGrantCommandInput | CreateKeyCommandInput | DecryptCommandInput | DeleteAliasCommandInput | DeleteCustomKeyStoreCommandInput | DeleteImportedKeyMaterialCommandInput | DescribeCustomKeyStoresCommandInput | DescribeKeyCommandInput | DisableKeyCommandInput | DisableKeyRotationCommandInput | DisconnectCustomKeyStoreCommandInput | EnableKeyCommandInput | EnableKeyRotationCommandInput | EncryptCommandInput | GenerateDataKeyCommandInput | GenerateDataKeyPairCommandInput | GenerateDataKeyPairWithoutPlaintextCommandInput | GenerateDataKeyWithoutPlaintextCommandInput | GenerateMacCommandInput | GenerateRandomCommandInput | GetKeyPolicyCommandInput | GetKeyRotationStatusCommandInput | GetParametersForImportCommandInput | GetPublicKeyCommandInput | ImportKeyMaterialCommandInput | ListAliasesCommandInput | ListGrantsCommandInput | ListKeyPoliciesCommandInput | ListKeysCommandInput | ListResourceTagsCommandInput | ListRetirableGrantsCommandInput | PutKeyPolicyCommandInput | ReEncryptCommandInput | ReplicateKeyCommandInput | RetireGrantCommandInput | RevokeGrantCommandInput | ScheduleKeyDeletionCommandInput | SignCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAliasCommandInput | UpdateCustomKeyStoreCommandInput | UpdateKeyDescriptionCommandInput | UpdatePrimaryRegionCommandInput | VerifyCommandInput | VerifyMacCommandInput;
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
62
68
|
export type ServiceOutputTypes = CancelKeyDeletionCommandOutput | ConnectCustomKeyStoreCommandOutput | CreateAliasCommandOutput | CreateCustomKeyStoreCommandOutput | CreateGrantCommandOutput | CreateKeyCommandOutput | DecryptCommandOutput | DeleteAliasCommandOutput | DeleteCustomKeyStoreCommandOutput | DeleteImportedKeyMaterialCommandOutput | DescribeCustomKeyStoresCommandOutput | DescribeKeyCommandOutput | DisableKeyCommandOutput | DisableKeyRotationCommandOutput | DisconnectCustomKeyStoreCommandOutput | EnableKeyCommandOutput | EnableKeyRotationCommandOutput | EncryptCommandOutput | GenerateDataKeyCommandOutput | GenerateDataKeyPairCommandOutput | GenerateDataKeyPairWithoutPlaintextCommandOutput | GenerateDataKeyWithoutPlaintextCommandOutput | GenerateMacCommandOutput | GenerateRandomCommandOutput | GetKeyPolicyCommandOutput | GetKeyRotationStatusCommandOutput | GetParametersForImportCommandOutput | GetPublicKeyCommandOutput | ImportKeyMaterialCommandOutput | ListAliasesCommandOutput | ListGrantsCommandOutput | ListKeyPoliciesCommandOutput | ListKeysCommandOutput | ListResourceTagsCommandOutput | ListRetirableGrantsCommandOutput | PutKeyPolicyCommandOutput | ReEncryptCommandOutput | ReplicateKeyCommandOutput | RetireGrantCommandOutput | RevokeGrantCommandOutput | ScheduleKeyDeletionCommandOutput | SignCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAliasCommandOutput | UpdateCustomKeyStoreCommandOutput | UpdateKeyDescriptionCommandOutput | UpdatePrimaryRegionCommandOutput | VerifyCommandOutput | VerifyMacCommandOutput;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
63
72
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
64
73
|
/**
|
|
65
74
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
66
75
|
*/
|
|
67
76
|
requestHandler?: __HttpHandler;
|
|
68
77
|
/**
|
|
69
|
-
* A constructor for a class implementing the {@link
|
|
78
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
70
79
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
71
80
|
* @internal
|
|
72
81
|
*/
|
|
@@ -156,23 +165,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
156
165
|
*/
|
|
157
166
|
logger?: __Logger;
|
|
158
167
|
/**
|
|
159
|
-
* The {@link
|
|
168
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
160
169
|
*/
|
|
161
170
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
162
171
|
}
|
|
172
|
+
/**
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
163
175
|
type KMSClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
164
176
|
/**
|
|
165
|
-
*
|
|
177
|
+
* @public
|
|
178
|
+
*
|
|
179
|
+
* The configuration interface of KMSClient class constructor that set the region, credentials and other options.
|
|
166
180
|
*/
|
|
167
181
|
export interface KMSClientConfig extends KMSClientConfigType {
|
|
168
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
169
186
|
type KMSClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
170
187
|
/**
|
|
171
|
-
*
|
|
188
|
+
* @public
|
|
189
|
+
*
|
|
190
|
+
* The resolved configuration interface of KMSClient class. This is resolved and normalized from the {@link KMSClientConfig | constructor configuration interface}.
|
|
172
191
|
*/
|
|
173
192
|
export interface KMSClientResolvedConfig extends KMSClientResolvedConfigType {
|
|
174
193
|
}
|
|
175
194
|
/**
|
|
195
|
+
* @public
|
|
176
196
|
* <fullname>Key Management Service</fullname>
|
|
177
197
|
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
178
198
|
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CancelKeyDeletionRequest, CancelKeyDeletionResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CancelKeyDeletionCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CancelKeyDeletionCommandInput extends CancelKeyDeletionRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CancelKeyDeletionCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
|
|
18
23
|
* key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
19
24
|
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
@@ -37,6 +42,8 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
|
|
|
37
42
|
* const response = await client.send(command);
|
|
38
43
|
* ```
|
|
39
44
|
*
|
|
45
|
+
* @param CancelKeyDeletionCommandInput - {@link CancelKeyDeletionCommandInput}
|
|
46
|
+
* @returns {@link CancelKeyDeletionCommandOutput}
|
|
40
47
|
* @see {@link CancelKeyDeletionCommandInput} for command's `input` shape.
|
|
41
48
|
* @see {@link CancelKeyDeletionCommandOutput} for command's `response` shape.
|
|
42
49
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -96,11 +103,20 @@ export interface CancelKeyDeletionCommandOutput extends CancelKeyDeletionRespons
|
|
|
96
103
|
export declare class CancelKeyDeletionCommand extends $Command<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput, KMSClientResolvedConfig> {
|
|
97
104
|
readonly input: CancelKeyDeletionCommandInput;
|
|
98
105
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
106
|
+
/**
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
99
109
|
constructor(input: CancelKeyDeletionCommandInput);
|
|
100
110
|
/**
|
|
101
111
|
* @internal
|
|
102
112
|
*/
|
|
103
113
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelKeyDeletionCommandInput, CancelKeyDeletionCommandOutput>;
|
|
114
|
+
/**
|
|
115
|
+
* @internal
|
|
116
|
+
*/
|
|
104
117
|
private serialize;
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
105
121
|
private deserialize;
|
|
106
122
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { ConnectCustomKeyStoreRequest, ConnectCustomKeyStoreResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ConnectCustomKeyStoreCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ConnectCustomKeyStoreCommandInput extends ConnectCustomKeyStoreRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ConnectCustomKeyStoreCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStoreResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its backing key store. For an CloudHSM key
|
|
18
23
|
* store, <code>ConnectCustomKeyStore</code> connects the key store to its associated CloudHSM
|
|
19
24
|
* cluster. For an external key store, <code>ConnectCustomKeyStore</code> connects the key store
|
|
@@ -111,6 +116,8 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
|
|
|
111
116
|
* const response = await client.send(command);
|
|
112
117
|
* ```
|
|
113
118
|
*
|
|
119
|
+
* @param ConnectCustomKeyStoreCommandInput - {@link ConnectCustomKeyStoreCommandInput}
|
|
120
|
+
* @returns {@link ConnectCustomKeyStoreCommandOutput}
|
|
114
121
|
* @see {@link ConnectCustomKeyStoreCommandInput} for command's `input` shape.
|
|
115
122
|
* @see {@link ConnectCustomKeyStoreCommandOutput} for command's `response` shape.
|
|
116
123
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -215,11 +222,20 @@ export interface ConnectCustomKeyStoreCommandOutput extends ConnectCustomKeyStor
|
|
|
215
222
|
export declare class ConnectCustomKeyStoreCommand extends $Command<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput, KMSClientResolvedConfig> {
|
|
216
223
|
readonly input: ConnectCustomKeyStoreCommandInput;
|
|
217
224
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
218
228
|
constructor(input: ConnectCustomKeyStoreCommandInput);
|
|
219
229
|
/**
|
|
220
230
|
* @internal
|
|
221
231
|
*/
|
|
222
232
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ConnectCustomKeyStoreCommandInput, ConnectCustomKeyStoreCommandOutput>;
|
|
233
|
+
/**
|
|
234
|
+
* @internal
|
|
235
|
+
*/
|
|
223
236
|
private serialize;
|
|
237
|
+
/**
|
|
238
|
+
* @internal
|
|
239
|
+
*/
|
|
224
240
|
private deserialize;
|
|
225
241
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KMSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KMSClient";
|
|
5
5
|
import { CreateAliasRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link CreateAliasCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface CreateAliasCommandInput extends CreateAliasRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link CreateAliasCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Creates a friendly name for a KMS key. </p>
|
|
18
23
|
* <note>
|
|
19
24
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">ABAC for KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -81,6 +86,8 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
|
81
86
|
* const response = await client.send(command);
|
|
82
87
|
* ```
|
|
83
88
|
*
|
|
89
|
+
* @param CreateAliasCommandInput - {@link CreateAliasCommandInput}
|
|
90
|
+
* @returns {@link CreateAliasCommandOutput}
|
|
84
91
|
* @see {@link CreateAliasCommandInput} for command's `input` shape.
|
|
85
92
|
* @see {@link CreateAliasCommandOutput} for command's `response` shape.
|
|
86
93
|
* @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape.
|
|
@@ -143,11 +150,20 @@ export interface CreateAliasCommandOutput extends __MetadataBearer {
|
|
|
143
150
|
export declare class CreateAliasCommand extends $Command<CreateAliasCommandInput, CreateAliasCommandOutput, KMSClientResolvedConfig> {
|
|
144
151
|
readonly input: CreateAliasCommandInput;
|
|
145
152
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
146
156
|
constructor(input: CreateAliasCommandInput);
|
|
147
157
|
/**
|
|
148
158
|
* @internal
|
|
149
159
|
*/
|
|
150
160
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KMSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAliasCommandInput, CreateAliasCommandOutput>;
|
|
161
|
+
/**
|
|
162
|
+
* @internal
|
|
163
|
+
*/
|
|
151
164
|
private serialize;
|
|
165
|
+
/**
|
|
166
|
+
* @internal
|
|
167
|
+
*/
|
|
152
168
|
private deserialize;
|
|
153
169
|
}
|