@aws-sdk/client-kms 3.28.0 → 3.32.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/CHANGELOG.md +35 -0
- package/KMS.ts +567 -572
- package/KMSClient.ts +18 -18
- package/README.md +18 -18
- package/commands/CancelKeyDeletionCommand.ts +6 -7
- package/commands/ConnectCustomKeyStoreCommand.ts +9 -9
- package/commands/CreateAliasCommand.ts +13 -14
- package/commands/CreateCustomKeyStoreCommand.ts +8 -8
- package/commands/CreateGrantCommand.ts +15 -22
- package/commands/CreateKeyCommand.ts +44 -44
- package/commands/DecryptCommand.ts +23 -22
- package/commands/DeleteAliasCommand.ts +7 -8
- package/commands/DeleteCustomKeyStoreCommand.ts +13 -13
- package/commands/DeleteImportedKeyMaterialCommand.ts +9 -9
- package/commands/DescribeCustomKeyStoresCommand.ts +6 -6
- package/commands/DescribeKeyCommand.ts +18 -19
- package/commands/DisableKeyCommand.ts +7 -7
- package/commands/DisableKeyRotationCommand.ts +5 -6
- package/commands/DisconnectCustomKeyStoreCommand.ts +6 -8
- package/commands/EnableKeyCommand.ts +4 -5
- package/commands/EnableKeyRotationCommand.ts +5 -5
- package/commands/EncryptCommand.ts +20 -21
- package/commands/GenerateDataKeyCommand.ts +17 -18
- package/commands/GenerateDataKeyPairCommand.ts +21 -15
- package/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts +16 -12
- package/commands/GenerateDataKeyWithoutPlaintextCommand.ts +9 -9
- package/commands/GenerateRandomCommand.ts +4 -3
- package/commands/GetKeyPolicyCommand.ts +2 -2
- package/commands/GetKeyRotationStatusCommand.ts +9 -9
- package/commands/GetParametersForImportCommand.ts +8 -8
- package/commands/GetPublicKeyCommand.ts +15 -15
- package/commands/ImportKeyMaterialCommand.ts +18 -18
- package/commands/ListAliasesCommand.ts +8 -10
- package/commands/ListGrantsCommand.ts +9 -4
- package/commands/ListKeyPoliciesCommand.ts +2 -2
- package/commands/ListKeysCommand.ts +2 -2
- package/commands/ListResourceTagsCommand.ts +4 -4
- package/commands/ListRetirableGrantsCommand.ts +14 -14
- package/commands/PutKeyPolicyCommand.ts +5 -5
- package/commands/ReEncryptCommand.ts +30 -34
- package/commands/ReplicateKeyCommand.ts +16 -16
- package/commands/RetireGrantCommand.ts +9 -9
- package/commands/RevokeGrantCommand.ts +9 -4
- package/commands/ScheduleKeyDeletionCommand.ts +17 -17
- package/commands/SignCommand.ts +12 -13
- package/commands/TagResourceCommand.ts +10 -12
- package/commands/UntagResourceCommand.ts +9 -10
- package/commands/UpdateAliasCommand.ts +15 -15
- package/commands/UpdateCustomKeyStoreCommand.ts +9 -9
- package/commands/UpdateKeyDescriptionCommand.ts +4 -4
- package/commands/UpdatePrimaryRegionCommand.ts +13 -13
- package/commands/VerifyCommand.ts +14 -14
- package/dist/cjs/KMS.js +18 -18
- package/dist/cjs/KMS.js.map +1 -1
- package/dist/cjs/KMSClient.js +18 -18
- package/dist/cjs/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/cjs/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/cjs/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/CreateAliasCommand.js +13 -14
- package/dist/cjs/commands/CreateAliasCommand.js.map +1 -1
- package/dist/cjs/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/cjs/commands/CreateGrantCommand.js +15 -22
- package/dist/cjs/commands/CreateGrantCommand.js.map +1 -1
- package/dist/cjs/commands/CreateKeyCommand.js +44 -44
- package/dist/cjs/commands/DecryptCommand.js +23 -22
- package/dist/cjs/commands/DecryptCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteAliasCommand.js +7 -8
- package/dist/cjs/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/cjs/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/cjs/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/cjs/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/cjs/commands/DescribeKeyCommand.js +18 -19
- package/dist/cjs/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/cjs/commands/DisableKeyCommand.js +7 -7
- package/dist/cjs/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/cjs/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/cjs/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyCommand.js +4 -5
- package/dist/cjs/commands/EnableKeyCommand.js.map +1 -1
- package/dist/cjs/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/cjs/commands/EncryptCommand.js +20 -21
- package/dist/cjs/commands/EncryptCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/cjs/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/cjs/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/cjs/commands/GenerateRandomCommand.js +4 -3
- package/dist/cjs/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/cjs/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/cjs/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/cjs/commands/GetParametersForImportCommand.js +8 -8
- package/dist/cjs/commands/GetPublicKeyCommand.js +15 -15
- package/dist/cjs/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/cjs/commands/ListAliasesCommand.js +8 -10
- package/dist/cjs/commands/ListAliasesCommand.js.map +1 -1
- package/dist/cjs/commands/ListGrantsCommand.js +9 -4
- package/dist/cjs/commands/ListGrantsCommand.js.map +1 -1
- package/dist/cjs/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/cjs/commands/ListKeysCommand.js +2 -2
- package/dist/cjs/commands/ListResourceTagsCommand.js +4 -4
- package/dist/cjs/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/cjs/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/cjs/commands/ReEncryptCommand.js +30 -34
- package/dist/cjs/commands/ReEncryptCommand.js.map +1 -1
- package/dist/cjs/commands/ReplicateKeyCommand.js +16 -16
- package/dist/cjs/commands/RetireGrantCommand.js +9 -9
- package/dist/cjs/commands/RevokeGrantCommand.js +9 -4
- package/dist/cjs/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/cjs/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/cjs/commands/SignCommand.js +12 -13
- package/dist/cjs/commands/SignCommand.js.map +1 -1
- package/dist/cjs/commands/TagResourceCommand.js +10 -12
- package/dist/cjs/commands/TagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UntagResourceCommand.js +9 -10
- package/dist/cjs/commands/UntagResourceCommand.js.map +1 -1
- package/dist/cjs/commands/UpdateAliasCommand.js +15 -15
- package/dist/cjs/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/cjs/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/cjs/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/cjs/commands/VerifyCommand.js +14 -14
- package/dist/cjs/models/models_0.js +14 -3
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_json1_1.js +16 -11
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/KMS.js +18 -18
- package/dist/es/KMS.js.map +1 -1
- package/dist/es/KMSClient.js +18 -18
- package/dist/es/commands/CancelKeyDeletionCommand.js +6 -7
- package/dist/es/commands/CancelKeyDeletionCommand.js.map +1 -1
- package/dist/es/commands/ConnectCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/CreateAliasCommand.js +13 -14
- package/dist/es/commands/CreateAliasCommand.js.map +1 -1
- package/dist/es/commands/CreateCustomKeyStoreCommand.js +8 -8
- package/dist/es/commands/CreateGrantCommand.js +15 -22
- package/dist/es/commands/CreateGrantCommand.js.map +1 -1
- package/dist/es/commands/CreateKeyCommand.js +44 -44
- package/dist/es/commands/DecryptCommand.js +23 -22
- package/dist/es/commands/DecryptCommand.js.map +1 -1
- package/dist/es/commands/DeleteAliasCommand.js +7 -8
- package/dist/es/commands/DeleteAliasCommand.js.map +1 -1
- package/dist/es/commands/DeleteCustomKeyStoreCommand.js +13 -13
- package/dist/es/commands/DeleteImportedKeyMaterialCommand.js +9 -9
- package/dist/es/commands/DescribeCustomKeyStoresCommand.js +6 -6
- package/dist/es/commands/DescribeKeyCommand.js +18 -19
- package/dist/es/commands/DescribeKeyCommand.js.map +1 -1
- package/dist/es/commands/DisableKeyCommand.js +7 -7
- package/dist/es/commands/DisableKeyRotationCommand.js +5 -6
- package/dist/es/commands/DisableKeyRotationCommand.js.map +1 -1
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js +6 -8
- package/dist/es/commands/DisconnectCustomKeyStoreCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyCommand.js +4 -5
- package/dist/es/commands/EnableKeyCommand.js.map +1 -1
- package/dist/es/commands/EnableKeyRotationCommand.js +5 -5
- package/dist/es/commands/EncryptCommand.js +20 -21
- package/dist/es/commands/EncryptCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyCommand.js +17 -18
- package/dist/es/commands/GenerateDataKeyCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairCommand.js +21 -15
- package/dist/es/commands/GenerateDataKeyPairCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -12
- package/dist/es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +1 -1
- package/dist/es/commands/GenerateDataKeyWithoutPlaintextCommand.js +9 -9
- package/dist/es/commands/GenerateRandomCommand.js +4 -3
- package/dist/es/commands/GenerateRandomCommand.js.map +1 -1
- package/dist/es/commands/GetKeyPolicyCommand.js +2 -2
- package/dist/es/commands/GetKeyRotationStatusCommand.js +9 -9
- package/dist/es/commands/GetParametersForImportCommand.js +8 -8
- package/dist/es/commands/GetPublicKeyCommand.js +15 -15
- package/dist/es/commands/ImportKeyMaterialCommand.js +18 -18
- package/dist/es/commands/ListAliasesCommand.js +8 -10
- package/dist/es/commands/ListAliasesCommand.js.map +1 -1
- package/dist/es/commands/ListGrantsCommand.js +9 -4
- package/dist/es/commands/ListGrantsCommand.js.map +1 -1
- package/dist/es/commands/ListKeyPoliciesCommand.js +2 -2
- package/dist/es/commands/ListKeysCommand.js +2 -2
- package/dist/es/commands/ListResourceTagsCommand.js +4 -4
- package/dist/es/commands/ListRetirableGrantsCommand.js +14 -14
- package/dist/es/commands/PutKeyPolicyCommand.js +5 -5
- package/dist/es/commands/ReEncryptCommand.js +30 -34
- package/dist/es/commands/ReEncryptCommand.js.map +1 -1
- package/dist/es/commands/ReplicateKeyCommand.js +16 -16
- package/dist/es/commands/RetireGrantCommand.js +9 -9
- package/dist/es/commands/RevokeGrantCommand.js +9 -4
- package/dist/es/commands/RevokeGrantCommand.js.map +1 -1
- package/dist/es/commands/ScheduleKeyDeletionCommand.js +17 -17
- package/dist/es/commands/SignCommand.js +12 -13
- package/dist/es/commands/SignCommand.js.map +1 -1
- package/dist/es/commands/TagResourceCommand.js +10 -12
- package/dist/es/commands/TagResourceCommand.js.map +1 -1
- package/dist/es/commands/UntagResourceCommand.js +9 -10
- package/dist/es/commands/UntagResourceCommand.js.map +1 -1
- package/dist/es/commands/UpdateAliasCommand.js +15 -15
- package/dist/es/commands/UpdateCustomKeyStoreCommand.js +9 -9
- package/dist/es/commands/UpdateKeyDescriptionCommand.js +4 -4
- package/dist/es/commands/UpdatePrimaryRegionCommand.js +13 -13
- package/dist/es/commands/VerifyCommand.js +14 -14
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +11 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_json1_1.js +18 -14
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/KMS.d.ts +567 -572
- package/dist/types/KMSClient.d.ts +18 -18
- package/dist/types/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/commands/SignCommand.d.ts +12 -13
- package/dist/types/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/models/models_0.d.ts +584 -570
- package/dist/types/ts3.4/KMS.d.ts +567 -572
- package/dist/types/ts3.4/KMSClient.d.ts +18 -18
- package/dist/types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +6 -7
- package/dist/types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/CreateAliasCommand.d.ts +13 -14
- package/dist/types/ts3.4/commands/CreateCustomKeyStoreCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/CreateGrantCommand.d.ts +15 -22
- package/dist/types/ts3.4/commands/CreateKeyCommand.d.ts +44 -44
- package/dist/types/ts3.4/commands/DecryptCommand.d.ts +23 -22
- package/dist/types/ts3.4/commands/DeleteAliasCommand.d.ts +7 -8
- package/dist/types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +6 -6
- package/dist/types/ts3.4/commands/DescribeKeyCommand.d.ts +18 -19
- package/dist/types/ts3.4/commands/DisableKeyCommand.d.ts +7 -7
- package/dist/types/ts3.4/commands/DisableKeyRotationCommand.d.ts +5 -6
- package/dist/types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -8
- package/dist/types/ts3.4/commands/EnableKeyCommand.d.ts +4 -5
- package/dist/types/ts3.4/commands/EnableKeyRotationCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/EncryptCommand.d.ts +20 -21
- package/dist/types/ts3.4/commands/GenerateDataKeyCommand.d.ts +17 -18
- package/dist/types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +21 -15
- package/dist/types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -12
- package/dist/types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GenerateRandomCommand.d.ts +4 -3
- package/dist/types/ts3.4/commands/GetKeyPolicyCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/GetParametersForImportCommand.d.ts +8 -8
- package/dist/types/ts3.4/commands/GetPublicKeyCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +18 -18
- package/dist/types/ts3.4/commands/ListAliasesCommand.d.ts +8 -10
- package/dist/types/ts3.4/commands/ListGrantsCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListKeysCommand.d.ts +2 -2
- package/dist/types/ts3.4/commands/ListResourceTagsCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +14 -14
- package/dist/types/ts3.4/commands/PutKeyPolicyCommand.d.ts +5 -5
- package/dist/types/ts3.4/commands/ReEncryptCommand.d.ts +30 -34
- package/dist/types/ts3.4/commands/ReplicateKeyCommand.d.ts +16 -16
- package/dist/types/ts3.4/commands/RetireGrantCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/RevokeGrantCommand.d.ts +9 -4
- package/dist/types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +17 -17
- package/dist/types/ts3.4/commands/SignCommand.d.ts +12 -13
- package/dist/types/ts3.4/commands/TagResourceCommand.d.ts +10 -12
- package/dist/types/ts3.4/commands/UntagResourceCommand.d.ts +9 -10
- package/dist/types/ts3.4/commands/UpdateAliasCommand.d.ts +15 -15
- package/dist/types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +9 -9
- package/dist/types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +4 -4
- package/dist/types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +13 -13
- package/dist/types/ts3.4/commands/VerifyCommand.d.ts +14 -14
- package/dist/types/ts3.4/models/models_0.d.ts +584 -570
- package/models/models_0.ts +588 -570
- package/package.json +31 -31
- package/protocols/Aws_json1_1.ts +20 -12
|
@@ -17,7 +17,7 @@ export interface AliasListEntry {
|
|
|
17
17
|
*/
|
|
18
18
|
AliasArn?: string;
|
|
19
19
|
/**
|
|
20
|
-
* <p>String that contains the key identifier of the
|
|
20
|
+
* <p>String that contains the key identifier of the KMS key associated with the alias.</p>
|
|
21
21
|
*/
|
|
22
22
|
TargetKeyId?: string;
|
|
23
23
|
/**
|
|
@@ -25,7 +25,7 @@ export interface AliasListEntry {
|
|
|
25
25
|
*/
|
|
26
26
|
CreationDate?: Date;
|
|
27
27
|
/**
|
|
28
|
-
* <p>Date and time that the alias was most recently associated with a
|
|
28
|
+
* <p>Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.</p>
|
|
29
29
|
*/
|
|
30
30
|
LastUpdatedDate?: Date;
|
|
31
31
|
}
|
|
@@ -52,8 +52,8 @@ export declare namespace AlreadyExistsException {
|
|
|
52
52
|
}
|
|
53
53
|
export interface CancelKeyDeletionRequest {
|
|
54
54
|
/**
|
|
55
|
-
* <p>Identifies the
|
|
56
|
-
* <p>Specify the key ID or key ARN of the
|
|
55
|
+
* <p>Identifies the KMS key whose deletion is being canceled.</p>
|
|
56
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
57
57
|
* <p>For example:</p>
|
|
58
58
|
* <ul>
|
|
59
59
|
* <li>
|
|
@@ -65,7 +65,7 @@ export interface CancelKeyDeletionRequest {
|
|
|
65
65
|
* </p>
|
|
66
66
|
* </li>
|
|
67
67
|
* </ul>
|
|
68
|
-
* <p>To get the key ID and key ARN for a
|
|
68
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
69
69
|
*/
|
|
70
70
|
KeyId: string | undefined;
|
|
71
71
|
}
|
|
@@ -77,7 +77,7 @@ export declare namespace CancelKeyDeletionRequest {
|
|
|
77
77
|
}
|
|
78
78
|
export interface CancelKeyDeletionResponse {
|
|
79
79
|
/**
|
|
80
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
80
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is canceled.</p>
|
|
81
81
|
*/
|
|
82
82
|
KeyId?: string;
|
|
83
83
|
}
|
|
@@ -135,9 +135,8 @@ export declare namespace KMSInternalException {
|
|
|
135
135
|
/**
|
|
136
136
|
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
137
137
|
* request.</p>
|
|
138
|
-
* <p>For more information about how key state affects the use of a
|
|
139
|
-
*
|
|
140
|
-
* <i>AWS Key Management Service Developer Guide</i>
|
|
138
|
+
* <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>
|
|
139
|
+
* <i>Key Management Service Developer Guide</i>
|
|
141
140
|
* </i>.</p>
|
|
142
141
|
*/
|
|
143
142
|
export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
|
|
@@ -167,9 +166,9 @@ export declare namespace NotFoundException {
|
|
|
167
166
|
const filterSensitiveLog: (obj: NotFoundException) => any;
|
|
168
167
|
}
|
|
169
168
|
/**
|
|
170
|
-
* <p>The request was rejected because the specified
|
|
169
|
+
* <p>The request was rejected because the specified CloudHSM cluster is already associated with a
|
|
171
170
|
* custom key store or it shares a backup history with a cluster that is associated with a custom
|
|
172
|
-
* key store. Each custom key store must be associated with a different
|
|
171
|
+
* key store. Each custom key store must be associated with a different CloudHSM cluster.</p>
|
|
173
172
|
* <p>Clusters that share a backup history have the same cluster certificate. To view the
|
|
174
173
|
* cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
|
|
175
174
|
*/
|
|
@@ -185,7 +184,7 @@ export declare namespace CloudHsmClusterInUseException {
|
|
|
185
184
|
const filterSensitiveLog: (obj: CloudHsmClusterInUseException) => any;
|
|
186
185
|
}
|
|
187
186
|
/**
|
|
188
|
-
* <p>The request was rejected because the associated
|
|
187
|
+
* <p>The request was rejected because the associated CloudHSM cluster did not meet the
|
|
189
188
|
* configuration requirements for a custom key store.</p>
|
|
190
189
|
*
|
|
191
190
|
* <ul>
|
|
@@ -203,20 +202,20 @@ export declare namespace CloudHsmClusterInUseException {
|
|
|
203
202
|
* </li>
|
|
204
203
|
* <li>
|
|
205
204
|
* <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs,
|
|
206
|
-
* use the
|
|
207
|
-
* <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the
|
|
208
|
-
* active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the
|
|
205
|
+
* use the CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p>
|
|
206
|
+
* <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the CloudHSM cluster must have at least two
|
|
207
|
+
* active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the CloudHSM must contain at least one active
|
|
209
208
|
* HSM.</p>
|
|
210
209
|
* </li>
|
|
211
210
|
* </ul>
|
|
212
|
-
* <p>For information about the requirements for an
|
|
211
|
+
* <p>For information about the requirements for an CloudHSM cluster that is associated with a
|
|
213
212
|
* custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
|
|
214
|
-
* in the <i>
|
|
213
|
+
* in the <i>Key Management Service Developer Guide</i>. For information about creating a private subnet for an CloudHSM cluster,
|
|
215
214
|
* see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private
|
|
216
|
-
* Subnet</a> in the <i>
|
|
215
|
+
* Subnet</a> in the <i>CloudHSM User Guide</i>. For information about cluster security groups, see
|
|
217
216
|
* <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security
|
|
218
217
|
* Group</a> in the <i>
|
|
219
|
-
* <i>
|
|
218
|
+
* <i>CloudHSM User Guide</i>
|
|
220
219
|
* </i>. </p>
|
|
221
220
|
*/
|
|
222
221
|
export interface CloudHsmClusterInvalidConfigurationException extends __SmithyException, $MetadataBearer {
|
|
@@ -231,9 +230,9 @@ export declare namespace CloudHsmClusterInvalidConfigurationException {
|
|
|
231
230
|
const filterSensitiveLog: (obj: CloudHsmClusterInvalidConfigurationException) => any;
|
|
232
231
|
}
|
|
233
232
|
/**
|
|
234
|
-
* <p>The request was rejected because the
|
|
233
|
+
* <p>The request was rejected because the CloudHSM cluster that is associated with the custom key
|
|
235
234
|
* store is not active. Initialize and activate the cluster and try the command again. For
|
|
236
|
-
* detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>
|
|
235
|
+
* detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>CloudHSM User Guide</i>.</p>
|
|
237
236
|
*/
|
|
238
237
|
export interface CloudHsmClusterNotActiveException extends __SmithyException, $MetadataBearer {
|
|
239
238
|
name: "CloudHsmClusterNotActiveException";
|
|
@@ -247,7 +246,7 @@ export declare namespace CloudHsmClusterNotActiveException {
|
|
|
247
246
|
const filterSensitiveLog: (obj: CloudHsmClusterNotActiveException) => any;
|
|
248
247
|
}
|
|
249
248
|
/**
|
|
250
|
-
* <p>The request was rejected because
|
|
249
|
+
* <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
|
|
251
250
|
* cluster ID. Retry the request with a different cluster ID.</p>
|
|
252
251
|
*/
|
|
253
252
|
export interface CloudHsmClusterNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -262,7 +261,7 @@ export declare namespace CloudHsmClusterNotFoundException {
|
|
|
262
261
|
const filterSensitiveLog: (obj: CloudHsmClusterNotFoundException) => any;
|
|
263
262
|
}
|
|
264
263
|
/**
|
|
265
|
-
* <p>The request was rejected because the specified
|
|
264
|
+
* <p>The request was rejected because the specified CloudHSM cluster has a different cluster
|
|
266
265
|
* certificate than the original cluster. You cannot use the operation to specify an unrelated
|
|
267
266
|
* cluster.</p>
|
|
268
267
|
* <p>Specify a cluster that shares a backup history with the original cluster. This includes
|
|
@@ -338,7 +337,7 @@ export declare namespace CustomKeyStoreInvalidStateException {
|
|
|
338
337
|
const filterSensitiveLog: (obj: CustomKeyStoreInvalidStateException) => any;
|
|
339
338
|
}
|
|
340
339
|
/**
|
|
341
|
-
* <p>The request was rejected because
|
|
340
|
+
* <p>The request was rejected because KMS cannot find a custom key store with the specified
|
|
342
341
|
* key store name or ID.</p>
|
|
343
342
|
*/
|
|
344
343
|
export interface CustomKeyStoreNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -376,18 +375,20 @@ export interface CreateAliasRequest {
|
|
|
376
375
|
* name, such as <code>alias/ExampleAlias</code>. </p>
|
|
377
376
|
* <p>The <code>AliasName</code> value must be string of 1-256 characters. It can contain only alphanumeric characters,
|
|
378
377
|
* forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved
|
|
379
|
-
* for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
378
|
+
* for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed keys</a>.</p>
|
|
380
379
|
*/
|
|
381
380
|
AliasName: string | undefined;
|
|
382
381
|
/**
|
|
383
|
-
* <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
384
|
-
* in the same
|
|
385
|
-
* <p>A valid
|
|
382
|
+
* <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. The KMS key must be
|
|
383
|
+
* in the same Amazon Web Services Region. </p>
|
|
384
|
+
* <p>A valid key ID is required. If you supply a null or empty string value, this operation
|
|
386
385
|
* returns an error.</p>
|
|
387
386
|
* <p>For help finding the key ID and ARN, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn">Finding the Key ID and
|
|
388
|
-
* ARN</a> in the <i>
|
|
387
|
+
* ARN</a> in the <i>
|
|
388
|
+
* <i>Key Management Service Developer Guide</i>
|
|
389
|
+
* </i>.</p>
|
|
389
390
|
*
|
|
390
|
-
* <p>Specify the key ID or key ARN of the
|
|
391
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
391
392
|
* <p>For example:</p>
|
|
392
393
|
* <ul>
|
|
393
394
|
* <li>
|
|
@@ -399,7 +400,7 @@ export interface CreateAliasRequest {
|
|
|
399
400
|
* </p>
|
|
400
401
|
* </li>
|
|
401
402
|
* </ul>
|
|
402
|
-
* <p>To get the key ID and key ARN for a
|
|
403
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
403
404
|
*/
|
|
404
405
|
TargetKeyId: string | undefined;
|
|
405
406
|
}
|
|
@@ -425,7 +426,7 @@ export declare namespace InvalidAliasNameException {
|
|
|
425
426
|
}
|
|
426
427
|
/**
|
|
427
428
|
* <p>The request was rejected because a quota was exceeded. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html">Quotas</a> in the
|
|
428
|
-
* <i>
|
|
429
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
429
430
|
*/
|
|
430
431
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
431
432
|
name: "LimitExceededException";
|
|
@@ -440,13 +441,12 @@ export declare namespace LimitExceededException {
|
|
|
440
441
|
}
|
|
441
442
|
export interface CreateCustomKeyStoreRequest {
|
|
442
443
|
/**
|
|
443
|
-
* <p>Specifies a friendly name for the custom key store. The name must be unique in your
|
|
444
|
-
* account.</p>
|
|
444
|
+
* <p>Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.</p>
|
|
445
445
|
*/
|
|
446
446
|
CustomKeyStoreName: string | undefined;
|
|
447
447
|
/**
|
|
448
|
-
* <p>Identifies the
|
|
449
|
-
*
|
|
448
|
+
* <p>Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active
|
|
449
|
+
* CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,
|
|
450
450
|
* use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
|
|
451
451
|
*/
|
|
452
452
|
CloudHsmClusterId: string | undefined;
|
|
@@ -458,11 +458,11 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
458
458
|
/**
|
|
459
459
|
* <p>Enter the password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
460
460
|
* <code>kmsuser</code> crypto user
|
|
461
|
-
* (CU) account</a> in the specified
|
|
461
|
+
* (CU) account</a> in the specified CloudHSM cluster. KMS logs into the cluster as this
|
|
462
462
|
* user to manage key material on your behalf.</p>
|
|
463
463
|
* <p>The password must be a string of 7 to 32 characters. Its value is case sensitive.</p>
|
|
464
|
-
* <p>This parameter tells
|
|
465
|
-
* the password in the
|
|
464
|
+
* <p>This parameter tells KMS the <code>kmsuser</code> account password; it does not change
|
|
465
|
+
* the password in the CloudHSM cluster.</p>
|
|
466
466
|
*/
|
|
467
467
|
KeyStorePassword: string | undefined;
|
|
468
468
|
}
|
|
@@ -502,7 +502,7 @@ export declare namespace CustomKeyStoreNameInUseException {
|
|
|
502
502
|
}
|
|
503
503
|
/**
|
|
504
504
|
* <p>The request was rejected because the trust anchor certificate in the request is not the
|
|
505
|
-
* trust anchor certificate for the specified
|
|
505
|
+
* trust anchor certificate for the specified CloudHSM cluster.</p>
|
|
506
506
|
* <p>When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the cluster</a>, you create the trust anchor certificate and save it in the
|
|
507
507
|
* <code>customerCA.crt</code> file.</p>
|
|
508
508
|
*/
|
|
@@ -520,10 +520,10 @@ export declare namespace IncorrectTrustAnchorException {
|
|
|
520
520
|
/**
|
|
521
521
|
* <p>Use this structure to allow <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> in the grant only when the operation request
|
|
522
522
|
* includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p>
|
|
523
|
-
* <p>
|
|
524
|
-
* encryption context, that is, all cryptographic operations with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks">symmetric
|
|
523
|
+
* <p>KMS applies the grant constraints only to cryptographic operations that support an
|
|
524
|
+
* encryption context, that is, all cryptographic operations with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks">symmetric KMS key</a>. Grant
|
|
525
525
|
* constraints are not applied to operations that do not support an encryption context, such as
|
|
526
|
-
* cryptographic operations with asymmetric
|
|
526
|
+
* cryptographic operations with asymmetric KMS keys and management operations, such as <a>DescribeKey</a> or <a>RetireGrant</a>.</p>
|
|
527
527
|
* <important>
|
|
528
528
|
* <p>In a cryptographic operation, the encryption context in the decryption operation must be
|
|
529
529
|
* an exact, case-sensitive match for the keys and values in the encryption context of the
|
|
@@ -534,7 +534,7 @@ export declare namespace IncorrectTrustAnchorException {
|
|
|
534
534
|
* case. To require a fully case-sensitive encryption context, use the
|
|
535
535
|
* <code>kms:EncryptionContext:</code> and <code>kms:EncryptionContextKeys</code> conditions
|
|
536
536
|
* in an IAM or key policy. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context">kms:EncryptionContext:</a> in the <i>
|
|
537
|
-
* <i>
|
|
537
|
+
* <i>Key Management Service Developer Guide</i>
|
|
538
538
|
* </i>.</p>
|
|
539
539
|
* </important>
|
|
540
540
|
*/
|
|
@@ -581,10 +581,10 @@ export declare enum GrantOperation {
|
|
|
581
581
|
}
|
|
582
582
|
export interface CreateGrantRequest {
|
|
583
583
|
/**
|
|
584
|
-
* <p>Identifies the
|
|
584
|
+
* <p>Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.</p>
|
|
585
585
|
*
|
|
586
|
-
* <p>Specify the key ID or key ARN of the
|
|
587
|
-
* different
|
|
586
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
587
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
588
588
|
* <p>For example:</p>
|
|
589
589
|
* <ul>
|
|
590
590
|
* <li>
|
|
@@ -596,60 +596,62 @@ export interface CreateGrantRequest {
|
|
|
596
596
|
* </p>
|
|
597
597
|
* </li>
|
|
598
598
|
* </ul>
|
|
599
|
-
* <p>To get the key ID and key ARN for a
|
|
599
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
600
600
|
*/
|
|
601
601
|
KeyId: string | undefined;
|
|
602
602
|
/**
|
|
603
603
|
* <p>The identity that gets the permissions specified in the grant.</p>
|
|
604
|
-
* <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an
|
|
605
|
-
* principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated
|
|
604
|
+
* <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated
|
|
606
605
|
* users, and assumed role users. For examples of the ARN syntax to use for specifying a
|
|
607
|
-
* principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">
|
|
608
|
-
* Management (IAM)</a> in the Example ARNs section of the <i>
|
|
609
|
-
*
|
|
606
|
+
* principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services Identity and Access
|
|
607
|
+
* Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General
|
|
608
|
+
* Reference</i>.</p>
|
|
610
609
|
*/
|
|
611
610
|
GranteePrincipal: string | undefined;
|
|
612
611
|
/**
|
|
613
|
-
* <p>The principal that
|
|
614
|
-
*
|
|
615
|
-
*
|
|
612
|
+
* <p>The principal that has permission to use the <a>RetireGrant</a> operation to
|
|
613
|
+
* retire the grant. </p>
|
|
614
|
+
* <p>To specify the principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and
|
|
616
615
|
* assumed role users. For examples of the ARN syntax to use for specifying a principal, see
|
|
617
|
-
*
|
|
618
|
-
*
|
|
616
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
617
|
+
* <i>Amazon Web Services General Reference</i>.</p>
|
|
618
|
+
* <p>The grant determines the retiring principal. Other principals might have permission to
|
|
619
|
+
* retire the grant or revoke the grant. For details, see <a>RevokeGrant</a> and
|
|
620
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
619
621
|
*/
|
|
620
622
|
RetiringPrincipal?: string;
|
|
621
623
|
/**
|
|
622
624
|
* <p>A list of operations that the grant permits. </p>
|
|
623
|
-
* <p>The operation must be supported on the
|
|
624
|
-
* symmetric
|
|
625
|
-
*
|
|
626
|
-
*
|
|
627
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
625
|
+
* <p>The operation must be supported on the KMS key. For example, you cannot create a grant for a
|
|
626
|
+
* symmetric KMS key that allows the <a>Sign</a> operation, or a grant for an asymmetric KMS key that allows the <a>GenerateDataKey</a> operation. If you try, KMS returns a
|
|
627
|
+
* <code>ValidationError</code> exception. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations">Grant operations</a> in the
|
|
628
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
628
629
|
*/
|
|
629
630
|
Operations: (GrantOperation | string)[] | undefined;
|
|
630
631
|
/**
|
|
631
632
|
* <p>Specifies a grant constraint. </p>
|
|
632
|
-
* <p>
|
|
633
|
-
*
|
|
633
|
+
* <p>KMS supports the <code>EncryptionContextEquals</code> and
|
|
634
|
+
* <code>EncryptionContextSubset</code> grant constraints. Each constraint value can include up
|
|
634
635
|
* to 8 encryption context pairs. The encryption context value in each constraint cannot exceed
|
|
635
636
|
* 384 characters.</p>
|
|
636
|
-
* <p>These grant constraints allow
|
|
637
|
-
* request matches (<code>EncryptionContextEquals</code>) or includes
|
|
638
|
-
*
|
|
639
|
-
* For
|
|
640
|
-
* <i>
|
|
641
|
-
*
|
|
642
|
-
*
|
|
643
|
-
*
|
|
637
|
+
* <p>These grant constraints allow the permissions in the grant only when the encryption
|
|
638
|
+
* context in the request matches (<code>EncryptionContextEquals</code>) or includes
|
|
639
|
+
* (<code>EncryptionContextSubset</code>) the encryption context specified in this structure.
|
|
640
|
+
* For information about grant constraints, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints">Using grant
|
|
641
|
+
* constraints</a> in the <i>Key Management Service Developer Guide</i>. For more information about encryption context,
|
|
642
|
+
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
643
|
+
* Context</a> in the <i>
|
|
644
|
+
* <i>Key Management Service Developer Guide</i>
|
|
645
|
+
* </i>. </p>
|
|
644
646
|
* <p>The encryption context grant constraints are supported only on operations that include an
|
|
645
647
|
* encryption context. You cannot use an encryption context grant constraint for cryptographic
|
|
646
|
-
* operations with asymmetric
|
|
648
|
+
* operations with asymmetric KMS keys or for management operations, such as <a>DescribeKey</a> or <a>RetireGrant</a>.</p>
|
|
647
649
|
*/
|
|
648
650
|
Constraints?: GrantConstraints;
|
|
649
651
|
/**
|
|
650
652
|
* <p>A list of grant tokens. </p>
|
|
651
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
652
|
-
* <i>
|
|
653
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
654
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
653
655
|
*/
|
|
654
656
|
GrantTokens?: string[];
|
|
655
657
|
/**
|
|
@@ -661,7 +663,7 @@ export interface CreateGrantRequest {
|
|
|
661
663
|
* <p>When this value is present, you can retry a <code>CreateGrant</code> request with
|
|
662
664
|
* identical parameters; if the grant already exists, the original <code>GrantId</code> is
|
|
663
665
|
* returned without creating a new grant. Note that the returned grant token is unique with every
|
|
664
|
-
*
|
|
666
|
+
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned.
|
|
665
667
|
* All grant tokens for the same grant ID can be used interchangeably.</p>
|
|
666
668
|
*/
|
|
667
669
|
Name?: string;
|
|
@@ -675,8 +677,8 @@ export declare namespace CreateGrantRequest {
|
|
|
675
677
|
export interface CreateGrantResponse {
|
|
676
678
|
/**
|
|
677
679
|
* <p>The grant token.</p>
|
|
678
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
679
|
-
* <i>
|
|
680
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
681
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
680
682
|
*/
|
|
681
683
|
GrantToken?: string;
|
|
682
684
|
/**
|
|
@@ -692,7 +694,7 @@ export declare namespace CreateGrantResponse {
|
|
|
692
694
|
const filterSensitiveLog: (obj: CreateGrantResponse) => any;
|
|
693
695
|
}
|
|
694
696
|
/**
|
|
695
|
-
* <p>The request was rejected because the specified
|
|
697
|
+
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
696
698
|
*/
|
|
697
699
|
export interface DisabledException extends __SmithyException, $MetadataBearer {
|
|
698
700
|
name: "DisabledException";
|
|
@@ -729,6 +731,16 @@ export declare enum CustomerMasterKeySpec {
|
|
|
729
731
|
RSA_4096 = "RSA_4096",
|
|
730
732
|
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
|
|
731
733
|
}
|
|
734
|
+
export declare enum KeySpec {
|
|
735
|
+
ECC_NIST_P256 = "ECC_NIST_P256",
|
|
736
|
+
ECC_NIST_P384 = "ECC_NIST_P384",
|
|
737
|
+
ECC_NIST_P521 = "ECC_NIST_P521",
|
|
738
|
+
ECC_SECG_P256K1 = "ECC_SECG_P256K1",
|
|
739
|
+
RSA_2048 = "RSA_2048",
|
|
740
|
+
RSA_3072 = "RSA_3072",
|
|
741
|
+
RSA_4096 = "RSA_4096",
|
|
742
|
+
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT"
|
|
743
|
+
}
|
|
732
744
|
export declare enum KeyUsageType {
|
|
733
745
|
ENCRYPT_DECRYPT = "ENCRYPT_DECRYPT",
|
|
734
746
|
SIGN_VERIFY = "SIGN_VERIFY"
|
|
@@ -741,7 +753,7 @@ export declare enum OriginType {
|
|
|
741
753
|
/**
|
|
742
754
|
* <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are
|
|
743
755
|
* both required, but tag values can be empty (null) strings.</p>
|
|
744
|
-
* <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>
|
|
756
|
+
* <p>For information about the rules that apply to tag keys and tag values, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html">User-Defined Tag Restrictions</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
745
757
|
* Guide</i>.</p>
|
|
746
758
|
*/
|
|
747
759
|
export interface Tag {
|
|
@@ -762,82 +774,90 @@ export declare namespace Tag {
|
|
|
762
774
|
}
|
|
763
775
|
export interface CreateKeyRequest {
|
|
764
776
|
/**
|
|
765
|
-
* <p>The key policy to attach to the
|
|
777
|
+
* <p>The key policy to attach to the KMS key.</p>
|
|
766
778
|
* <p>If you provide a key policy, it must meet the following criteria:</p>
|
|
767
779
|
* <ul>
|
|
768
780
|
* <li>
|
|
769
781
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
770
782
|
* must allow the principal that is making the <code>CreateKey</code> request to make a
|
|
771
|
-
* subsequent <a>PutKeyPolicy</a> request on the
|
|
772
|
-
* the
|
|
773
|
-
* <i>
|
|
783
|
+
* subsequent <a>PutKeyPolicy</a> request on the KMS key. This reduces the risk that
|
|
784
|
+
* the KMS key becomes unmanageable. For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i>
|
|
785
|
+
* <i>Key Management Service Developer Guide</i>
|
|
774
786
|
* </i>.</p>
|
|
775
787
|
* </li>
|
|
776
788
|
* <li>
|
|
777
789
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
778
|
-
* in the key policy must exist and be visible to
|
|
790
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
779
791
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
780
792
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
781
|
-
* to
|
|
782
|
-
* Identity and Access Management User Guide</i>.</p>
|
|
793
|
+
* to KMS. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes that I make are not always immediately visible</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
783
794
|
* </li>
|
|
784
795
|
* </ul>
|
|
785
|
-
* <p>If you do not provide a key policy,
|
|
796
|
+
* <p>If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For
|
|
786
797
|
* more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">Default Key Policy</a> in the
|
|
787
|
-
* <i>
|
|
798
|
+
* <i>Key Management Service Developer Guide</i>. </p>
|
|
788
799
|
* <p>The key policy size quota is 32 kilobytes (32768 bytes).</p>
|
|
789
800
|
* <p>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>
|
|
790
|
-
* <i>
|
|
801
|
+
* <i>Identity and Access Management User Guide</i>
|
|
791
802
|
* </i>.</p>
|
|
792
803
|
*/
|
|
793
804
|
Policy?: string;
|
|
794
805
|
/**
|
|
795
|
-
* <p>A description of the
|
|
796
|
-
* <p>Use a description that helps you decide whether the
|
|
806
|
+
* <p>A description of the KMS key.</p>
|
|
807
|
+
* <p>Use a description that helps you decide whether the KMS key is
|
|
797
808
|
* appropriate for a task. The default value is an empty string (no description).</p>
|
|
809
|
+
* <p>To set or change the description after the key is created, use <a>UpdateKeyDescription</a>.</p>
|
|
798
810
|
*/
|
|
799
811
|
Description?: string;
|
|
800
812
|
/**
|
|
801
|
-
* <p>Determines the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the
|
|
802
|
-
* <code>ENCRYPT_DECRYPT</code>. This parameter is required only for asymmetric
|
|
803
|
-
* change the <code>KeyUsage</code> value after the
|
|
813
|
+
* <p>Determines the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key. The default value is
|
|
814
|
+
* <code>ENCRYPT_DECRYPT</code>. This parameter is required only for asymmetric KMS keys. You can't
|
|
815
|
+
* change the <code>KeyUsage</code> value after the KMS key is created.</p>
|
|
804
816
|
* <p>Select only one valid value.</p>
|
|
805
817
|
* <ul>
|
|
806
818
|
* <li>
|
|
807
|
-
* <p>For symmetric
|
|
819
|
+
* <p>For symmetric KMS keys, omit the parameter or specify <code>ENCRYPT_DECRYPT</code>.</p>
|
|
808
820
|
* </li>
|
|
809
821
|
* <li>
|
|
810
|
-
* <p>For asymmetric
|
|
822
|
+
* <p>For asymmetric KMS keys with RSA key material, specify <code>ENCRYPT_DECRYPT</code> or
|
|
811
823
|
* <code>SIGN_VERIFY</code>.</p>
|
|
812
824
|
* </li>
|
|
813
825
|
* <li>
|
|
814
|
-
* <p>For asymmetric
|
|
826
|
+
* <p>For asymmetric KMS keys with ECC key material, specify <code>SIGN_VERIFY</code>.</p>
|
|
815
827
|
* </li>
|
|
816
828
|
* </ul>
|
|
817
829
|
*/
|
|
818
830
|
KeyUsage?: KeyUsageType | string;
|
|
819
831
|
/**
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
*
|
|
828
|
-
*
|
|
829
|
-
* key
|
|
830
|
-
*
|
|
832
|
+
* @deprecated
|
|
833
|
+
*
|
|
834
|
+
* <p>Instead, use the <code>KeySpec</code> parameter.</p>
|
|
835
|
+
* <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> parameters work the same way. Only the names differ. We recommend that you use <code>KeySpec</code> parameter in your code. However, to avoid breaking changes, KMS will support both parameters.</p>
|
|
836
|
+
*/
|
|
837
|
+
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
838
|
+
/**
|
|
839
|
+
* <p>Specifies the type of KMS key to create. The default value, <code>SYMMETRIC_DEFAULT</code>,
|
|
840
|
+
* creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a
|
|
841
|
+
* key spec for your KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html">How to Choose Your KMS key
|
|
842
|
+
* Configuration</a> in the <i>
|
|
843
|
+
* <i>Key Management Service Developer Guide</i>
|
|
844
|
+
* </i>.</p>
|
|
845
|
+
* <p>The <code>KeySpec</code> determines whether the KMS key contains a symmetric key or an
|
|
846
|
+
* asymmetric key pair. It also determines the encryption algorithms or signing algorithms that
|
|
847
|
+
* the KMS key supports. You can't change the <code>KeySpec</code> after the KMS key is created.
|
|
848
|
+
* To further restrict the algorithms that can be used with the KMS key, use a condition key in
|
|
849
|
+
* its key policy or IAM policy. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm">kms:EncryptionAlgorithm</a> or <a href="https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm">kms:Signing Algorithm</a> in the <i>
|
|
850
|
+
* <i>Key Management Service Developer Guide</i>
|
|
851
|
+
* </i>.</p>
|
|
831
852
|
* <important>
|
|
832
853
|
* <p>
|
|
833
|
-
* <a href="http://aws.amazon.com/kms/features/#AWS_Service_Integration">
|
|
834
|
-
*
|
|
835
|
-
* services do not support asymmetric
|
|
836
|
-
* asymmetric, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html">Identifying Symmetric and Asymmetric
|
|
837
|
-
*
|
|
838
|
-
* Guide</i>.</p>
|
|
854
|
+
* <a href="http://aws.amazon.com/kms/features/#AWS_Service_Integration">Amazon Web Services services that
|
|
855
|
+
* are integrated with KMS</a> use symmetric KMS keys to protect your data. These
|
|
856
|
+
* services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or
|
|
857
|
+
* asymmetric, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html">Identifying Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer
|
|
858
|
+
* Guide</i>.</p>
|
|
839
859
|
* </important>
|
|
840
|
-
* <p>
|
|
860
|
+
* <p>KMS supports the following key specs for KMS keys:</p>
|
|
841
861
|
* <ul>
|
|
842
862
|
* <li>
|
|
843
863
|
* <p>Symmetric key (default)</p>
|
|
@@ -897,81 +917,80 @@ export interface CreateKeyRequest {
|
|
|
897
917
|
* </li>
|
|
898
918
|
* </ul>
|
|
899
919
|
*/
|
|
900
|
-
|
|
920
|
+
KeySpec?: KeySpec | string;
|
|
901
921
|
/**
|
|
902
|
-
* <p>The source of the key material for the
|
|
903
|
-
* the
|
|
922
|
+
* <p>The source of the key material for the KMS key. You cannot change the origin after you create
|
|
923
|
+
* the KMS key. The default is <code>AWS_KMS</code>, which means that KMS creates the key
|
|
904
924
|
* material.</p>
|
|
905
|
-
* <p>To create a
|
|
906
|
-
* <code>EXTERNAL</code>. For more information about importing key material into
|
|
925
|
+
* <p>To create a KMS key with no key material (for imported key material), set the value to
|
|
926
|
+
* <code>EXTERNAL</code>. For more information about importing key material into KMS, see
|
|
907
927
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
908
|
-
* Material</a> in the <i>
|
|
909
|
-
* <p>To create a
|
|
910
|
-
*
|
|
928
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. This value is valid only for symmetric KMS keys.</p>
|
|
929
|
+
* <p>To create a KMS key in an KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> and create its key material in the associated
|
|
930
|
+
* CloudHSM cluster, set this value to <code>AWS_CLOUDHSM</code>. You must also use the
|
|
911
931
|
* <code>CustomKeyStoreId</code> parameter to identify the custom key store. This value is
|
|
912
|
-
* valid only for symmetric
|
|
932
|
+
* valid only for symmetric KMS keys.</p>
|
|
913
933
|
*/
|
|
914
934
|
Origin?: OriginType | string;
|
|
915
935
|
/**
|
|
916
|
-
* <p>Creates the
|
|
917
|
-
*
|
|
918
|
-
* <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
|
|
936
|
+
* <p>Creates the KMS key in the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> and the key material in its associated
|
|
937
|
+
* CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the
|
|
938
|
+
* <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The CloudHSM cluster
|
|
919
939
|
* that is associated with the custom key store must have at least two active HSMs, each in a
|
|
920
940
|
* different Availability Zone in the Region.</p>
|
|
921
|
-
* <p>This parameter is valid only for symmetric
|
|
922
|
-
* asymmetric
|
|
941
|
+
* <p>This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot create an
|
|
942
|
+
* asymmetric KMS key or a multi-Region key in a custom key store.</p>
|
|
923
943
|
* <p>To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
924
|
-
* <p>The response includes the custom key store ID and the ID of the
|
|
925
|
-
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in
|
|
926
|
-
* combines the convenience and extensive integration of
|
|
944
|
+
* <p>The response includes the custom key store ID and the ID of the CloudHSM cluster.</p>
|
|
945
|
+
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
946
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
927
947
|
* single-tenant key store.</p>
|
|
928
948
|
*/
|
|
929
949
|
CustomKeyStoreId?: string;
|
|
930
950
|
/**
|
|
931
951
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
932
952
|
* <important>
|
|
933
|
-
* <p>Setting this value to true increases the risk that the
|
|
953
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
934
954
|
* set this value to true indiscriminately.</p>
|
|
935
955
|
* <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>
|
|
936
|
-
* <i>
|
|
956
|
+
* <i>Key Management Service Developer Guide</i>
|
|
937
957
|
* </i>.</p>
|
|
938
958
|
* </important>
|
|
939
959
|
* <p>Use this parameter only when you include a policy in the request and you intend to prevent
|
|
940
|
-
* the principal that is making the request from making a subsequent <a>PutKeyPolicy</a> request on the
|
|
960
|
+
* the principal that is making the request from making a subsequent <a>PutKeyPolicy</a> request on the KMS key.</p>
|
|
941
961
|
* <p>The default value is false.</p>
|
|
942
962
|
*/
|
|
943
963
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
944
964
|
/**
|
|
945
|
-
* <p>Assigns one or more tags to the
|
|
946
|
-
* To tag an existing
|
|
965
|
+
* <p>Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created.
|
|
966
|
+
* To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
947
967
|
* <note>
|
|
948
|
-
* <p>Tagging or untagging a
|
|
949
|
-
* CMK. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
968
|
+
* <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">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
950
969
|
* </note>
|
|
951
970
|
* <p>To use this parameter, you must have <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> permission in an IAM policy.</p>
|
|
952
971
|
* <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
|
|
953
972
|
* required, but the tag value can be an empty (null) string. You cannot have more than one tag
|
|
954
|
-
* on a
|
|
955
|
-
*
|
|
956
|
-
* <p>When you
|
|
957
|
-
* report with usage and costs aggregated by tags. Tags can also be used to control access to a
|
|
973
|
+
* on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,
|
|
974
|
+
* KMS replaces the current tag value with the specified one.</p>
|
|
975
|
+
* <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
|
|
976
|
+
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
|
|
958
977
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
959
978
|
*/
|
|
960
979
|
Tags?: Tag[];
|
|
961
980
|
/**
|
|
962
|
-
* <p>Creates a multi-Region primary key that you can replicate into other
|
|
963
|
-
* cannot change this value after you create the
|
|
964
|
-
* <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region
|
|
981
|
+
* <p>Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
|
|
982
|
+
* cannot change this value after you create the KMS key. </p>
|
|
983
|
+
* <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region KMS key,
|
|
965
984
|
* omit this parameter or set it to <code>False</code>. The default value is
|
|
966
985
|
* <code>False</code>.</p>
|
|
967
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
968
|
-
* interoperable
|
|
969
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
970
|
-
* it in a different
|
|
986
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
987
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
988
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
989
|
+
* it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
971
990
|
* <p>This value creates a <i>primary key</i>, not a replica. To create a
|
|
972
991
|
* <i>replica key</i>, use the <a>ReplicateKey</a> operation. </p>
|
|
973
|
-
* <p>You can create a symmetric or asymmetric multi-Region
|
|
974
|
-
* multi-Region
|
|
992
|
+
* <p>You can create a symmetric or asymmetric multi-Region key, and you can create a
|
|
993
|
+
* multi-Region key with imported key material. However, you cannot create a multi-Region key in
|
|
975
994
|
* a custom key store.</p>
|
|
976
995
|
*/
|
|
977
996
|
MultiRegion?: boolean;
|
|
@@ -1018,7 +1037,7 @@ export interface MultiRegionKey {
|
|
|
1018
1037
|
*/
|
|
1019
1038
|
Arn?: string;
|
|
1020
1039
|
/**
|
|
1021
|
-
* <p>Displays the
|
|
1040
|
+
* <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
|
|
1022
1041
|
*/
|
|
1023
1042
|
Region?: string;
|
|
1024
1043
|
}
|
|
@@ -1029,23 +1048,23 @@ export declare namespace MultiRegionKey {
|
|
|
1029
1048
|
const filterSensitiveLog: (obj: MultiRegionKey) => any;
|
|
1030
1049
|
}
|
|
1031
1050
|
/**
|
|
1032
|
-
* <p>Describes the configuration of this multi-Region
|
|
1033
|
-
* is a primary or replica of a multi-Region
|
|
1034
|
-
* <p>For more information about any listed
|
|
1051
|
+
* <p>Describes the configuration of this multi-Region key. This field appears only when the KMS key
|
|
1052
|
+
* is a primary or replica of a multi-Region key.</p>
|
|
1053
|
+
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
1035
1054
|
* operation.</p>
|
|
1036
1055
|
*/
|
|
1037
1056
|
export interface MultiRegionConfiguration {
|
|
1038
1057
|
/**
|
|
1039
|
-
* <p>Indicates whether the
|
|
1058
|
+
* <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
|
|
1040
1059
|
*/
|
|
1041
1060
|
MultiRegionKeyType?: MultiRegionKeyType | string;
|
|
1042
1061
|
/**
|
|
1043
|
-
* <p>Displays the key ARN and Region of the primary key. This field includes the current
|
|
1062
|
+
* <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if
|
|
1044
1063
|
* it is the primary key.</p>
|
|
1045
1064
|
*/
|
|
1046
1065
|
PrimaryKey?: MultiRegionKey;
|
|
1047
1066
|
/**
|
|
1048
|
-
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current
|
|
1067
|
+
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key
|
|
1049
1068
|
* if it is a replica key.</p>
|
|
1050
1069
|
*/
|
|
1051
1070
|
ReplicaKeys?: MultiRegionKey[];
|
|
@@ -1068,50 +1087,49 @@ export declare enum SigningAlgorithmSpec {
|
|
|
1068
1087
|
RSASSA_PSS_SHA_512 = "RSASSA_PSS_SHA_512"
|
|
1069
1088
|
}
|
|
1070
1089
|
/**
|
|
1071
|
-
* <p>Contains metadata about a
|
|
1090
|
+
* <p>Contains metadata about a KMS key.</p>
|
|
1072
1091
|
* <p>This data type is used as a response element for the <a>CreateKey</a> and <a>DescribeKey</a> operations.</p>
|
|
1073
1092
|
*/
|
|
1074
1093
|
export interface KeyMetadata {
|
|
1075
1094
|
/**
|
|
1076
|
-
* <p>The twelve-digit account ID of the
|
|
1095
|
+
* <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
|
|
1077
1096
|
*/
|
|
1078
1097
|
AWSAccountId?: string;
|
|
1079
1098
|
/**
|
|
1080
|
-
* <p>The globally unique identifier for the
|
|
1099
|
+
* <p>The globally unique identifier for the KMS key.</p>
|
|
1081
1100
|
*/
|
|
1082
1101
|
KeyId: string | undefined;
|
|
1083
1102
|
/**
|
|
1084
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1085
|
-
* (
|
|
1103
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key. For examples, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Key Management Service
|
|
1104
|
+
* (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General
|
|
1086
1105
|
* Reference</i>.</p>
|
|
1087
1106
|
*/
|
|
1088
1107
|
Arn?: string;
|
|
1089
1108
|
/**
|
|
1090
|
-
* <p>The date and time when the
|
|
1109
|
+
* <p>The date and time when the KMS key was created.</p>
|
|
1091
1110
|
*/
|
|
1092
1111
|
CreationDate?: Date;
|
|
1093
1112
|
/**
|
|
1094
|
-
* <p>Specifies whether the
|
|
1113
|
+
* <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code>
|
|
1095
1114
|
* this value is true, otherwise it is false.</p>
|
|
1096
1115
|
*/
|
|
1097
1116
|
Enabled?: boolean;
|
|
1098
1117
|
/**
|
|
1099
|
-
* <p>The description of the
|
|
1118
|
+
* <p>The description of the KMS key.</p>
|
|
1100
1119
|
*/
|
|
1101
1120
|
Description?: string;
|
|
1102
1121
|
/**
|
|
1103
|
-
* <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the
|
|
1122
|
+
* <p>The <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> for which you can use the KMS key.</p>
|
|
1104
1123
|
*/
|
|
1105
1124
|
KeyUsage?: KeyUsageType | string;
|
|
1106
1125
|
/**
|
|
1107
|
-
* <p>The current status of the
|
|
1108
|
-
* <p>For more information about how key state affects the use of a
|
|
1109
|
-
* in the <i>
|
|
1126
|
+
* <p>The current status of the KMS key.</p>
|
|
1127
|
+
* <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>
|
|
1128
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1110
1129
|
*/
|
|
1111
1130
|
KeyState?: KeyState | string;
|
|
1112
1131
|
/**
|
|
1113
|
-
* <p>The date and time after which
|
|
1114
|
-
* CMK is scheduled for deletion, that is, when its <code>KeyState</code> is
|
|
1132
|
+
* <p>The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its <code>KeyState</code> is
|
|
1115
1133
|
* <code>PendingDeletion</code>.</p>
|
|
1116
1134
|
* <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica
|
|
1117
1135
|
* keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting
|
|
@@ -1119,88 +1137,94 @@ export interface KeyMetadata {
|
|
|
1119
1137
|
*/
|
|
1120
1138
|
DeletionDate?: Date;
|
|
1121
1139
|
/**
|
|
1122
|
-
* <p>The time at which the imported key material expires. When the key material expires,
|
|
1123
|
-
* deletes the key material and the
|
|
1140
|
+
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
1141
|
+
* deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys
|
|
1124
1142
|
* whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is
|
|
1125
1143
|
* <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
|
|
1126
1144
|
*/
|
|
1127
1145
|
ValidTo?: Date;
|
|
1128
1146
|
/**
|
|
1129
|
-
* <p>The source of the
|
|
1147
|
+
* <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS
|
|
1130
1148
|
* created the key material. When this value is <code>EXTERNAL</code>, the key material was
|
|
1131
|
-
* imported
|
|
1132
|
-
* this value is <code>AWS_CLOUDHSM</code>, the key material was created in the
|
|
1149
|
+
* imported or the KMS key doesn't have any key material. When
|
|
1150
|
+
* this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster
|
|
1133
1151
|
* associated with a custom key store.</p>
|
|
1134
1152
|
*/
|
|
1135
1153
|
Origin?: OriginType | string;
|
|
1136
1154
|
/**
|
|
1137
|
-
* <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the
|
|
1138
|
-
* only when the
|
|
1155
|
+
* <p>A unique identifier for the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that contains the KMS key. This value is present
|
|
1156
|
+
* only when the KMS key is created in a custom key store.</p>
|
|
1139
1157
|
*/
|
|
1140
1158
|
CustomKeyStoreId?: string;
|
|
1141
1159
|
/**
|
|
1142
|
-
* <p>The cluster ID of the
|
|
1143
|
-
* create a
|
|
1144
|
-
* associated
|
|
1160
|
+
* <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you
|
|
1161
|
+
* create a KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, KMS creates the key material for the KMS key in the
|
|
1162
|
+
* associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key
|
|
1145
1163
|
* store.</p>
|
|
1146
1164
|
*/
|
|
1147
1165
|
CloudHsmClusterId?: string;
|
|
1148
1166
|
/**
|
|
1149
|
-
* <p>Specifies whether the
|
|
1167
|
+
* <p>Specifies whether the KMS key's key material expires. This value is present only when
|
|
1150
1168
|
* <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
|
|
1151
1169
|
*/
|
|
1152
1170
|
ExpirationModel?: ExpirationModelType | string;
|
|
1153
1171
|
/**
|
|
1154
|
-
* <p>The manager of the
|
|
1155
|
-
*
|
|
1156
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
1172
|
+
* <p>The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a> in the
|
|
1173
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1157
1174
|
*/
|
|
1158
1175
|
KeyManager?: KeyManagerType | string;
|
|
1159
1176
|
/**
|
|
1160
|
-
*
|
|
1177
|
+
* @deprecated
|
|
1178
|
+
*
|
|
1179
|
+
* <p>Instead, use the <code>KeySpec</code> field.</p>
|
|
1180
|
+
* <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
|
|
1161
1181
|
*/
|
|
1162
1182
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
1163
1183
|
/**
|
|
1164
|
-
* <p>
|
|
1165
|
-
|
|
1166
|
-
|
|
1184
|
+
* <p>Describes the type of key material in the KMS key.</p>
|
|
1185
|
+
*/
|
|
1186
|
+
KeySpec?: KeySpec | string;
|
|
1187
|
+
/**
|
|
1188
|
+
* <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1189
|
+
* encryption algorithms within KMS.</p>
|
|
1190
|
+
* <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
|
|
1167
1191
|
* <code>ENCRYPT_DECRYPT</code>.</p>
|
|
1168
1192
|
*/
|
|
1169
1193
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
1170
1194
|
/**
|
|
1171
|
-
* <p>The signing algorithms that the
|
|
1172
|
-
* algorithms within
|
|
1173
|
-
* <p>This field appears only when the <code>KeyUsage</code> of the
|
|
1195
|
+
* <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing
|
|
1196
|
+
* algorithms within KMS.</p>
|
|
1197
|
+
* <p>This field appears only when the <code>KeyUsage</code> of the KMS key is
|
|
1174
1198
|
* <code>SIGN_VERIFY</code>.</p>
|
|
1175
1199
|
*/
|
|
1176
1200
|
SigningAlgorithms?: (SigningAlgorithmSpec | string)[];
|
|
1177
1201
|
/**
|
|
1178
|
-
* <p>Indicates whether the
|
|
1202
|
+
* <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional
|
|
1179
1203
|
* (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and
|
|
1180
|
-
* replica
|
|
1181
|
-
* <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>
|
|
1204
|
+
* replica keys and <code>False</code> for regional KMS keys.</p>
|
|
1205
|
+
* <p>For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1182
1206
|
*/
|
|
1183
1207
|
MultiRegion?: boolean;
|
|
1184
1208
|
/**
|
|
1185
|
-
* <p>Lists the primary and replica
|
|
1209
|
+
* <p>Lists the primary and replica keys in same multi-Region key. This field is present only
|
|
1186
1210
|
* when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
|
|
1187
|
-
* <p>For more information about any listed
|
|
1211
|
+
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
1188
1212
|
* operation.</p>
|
|
1189
1213
|
* <ul>
|
|
1190
1214
|
* <li>
|
|
1191
1215
|
* <p>
|
|
1192
|
-
* <code>MultiRegionKeyType</code> indicates whether the
|
|
1216
|
+
* <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or
|
|
1193
1217
|
* <code>REPLICA</code> key.</p>
|
|
1194
1218
|
* </li>
|
|
1195
1219
|
* <li>
|
|
1196
1220
|
* <p>
|
|
1197
1221
|
* <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field
|
|
1198
|
-
* displays the current
|
|
1222
|
+
* displays the current KMS key if it is the primary key.</p>
|
|
1199
1223
|
* </li>
|
|
1200
1224
|
* <li>
|
|
1201
1225
|
* <p>
|
|
1202
1226
|
* <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This
|
|
1203
|
-
* field includes the current
|
|
1227
|
+
* field includes the current KMS key if it is a replica key.</p>
|
|
1204
1228
|
* </li>
|
|
1205
1229
|
* </ul>
|
|
1206
1230
|
*/
|
|
@@ -1208,10 +1232,10 @@ export interface KeyMetadata {
|
|
|
1208
1232
|
/**
|
|
1209
1233
|
* <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting
|
|
1210
1234
|
* period begins when the last of its replica keys is deleted. This value is present only when
|
|
1211
|
-
* the <code>KeyState</code> of the
|
|
1212
|
-
* that the
|
|
1235
|
+
* the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates
|
|
1236
|
+
* that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it
|
|
1213
1237
|
* still has existing replica keys.</p>
|
|
1214
|
-
* <p>When a
|
|
1238
|
+
* <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its
|
|
1215
1239
|
* deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary
|
|
1216
1240
|
* key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until
|
|
1217
1241
|
* all of its replica keys are deleted. This value displays that waiting period. When the last
|
|
@@ -1229,7 +1253,7 @@ export declare namespace KeyMetadata {
|
|
|
1229
1253
|
}
|
|
1230
1254
|
export interface CreateKeyResponse {
|
|
1231
1255
|
/**
|
|
1232
|
-
* <p>Metadata associated with the
|
|
1256
|
+
* <p>Metadata associated with the KMS key.</p>
|
|
1233
1257
|
*/
|
|
1234
1258
|
KeyMetadata?: KeyMetadata;
|
|
1235
1259
|
}
|
|
@@ -1284,8 +1308,7 @@ export declare namespace UnsupportedOperationException {
|
|
|
1284
1308
|
const filterSensitiveLog: (obj: UnsupportedOperationException) => any;
|
|
1285
1309
|
}
|
|
1286
1310
|
/**
|
|
1287
|
-
* <p>The request was rejected because the custom key store contains
|
|
1288
|
-
* (CMKs). After verifying that you do not need to use the CMKs, use the <a>ScheduleKeyDeletion</a> operation to delete the CMKs. After they are deleted, you
|
|
1311
|
+
* <p>The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the <a>ScheduleKeyDeletion</a> operation to delete the KMS keys. After they are deleted, you
|
|
1289
1312
|
* can delete the custom key store.</p>
|
|
1290
1313
|
*/
|
|
1291
1314
|
export interface CustomKeyStoreHasCMKsException extends __SmithyException, $MetadataBearer {
|
|
@@ -1312,98 +1335,98 @@ export interface CustomKeyStoresListEntry {
|
|
|
1312
1335
|
*/
|
|
1313
1336
|
CustomKeyStoreName?: string;
|
|
1314
1337
|
/**
|
|
1315
|
-
* <p>A unique identifier for the
|
|
1338
|
+
* <p>A unique identifier for the CloudHSM cluster that is associated with the custom key
|
|
1316
1339
|
* store.</p>
|
|
1317
1340
|
*/
|
|
1318
1341
|
CloudHsmClusterId?: string;
|
|
1319
1342
|
/**
|
|
1320
|
-
* <p>The trust anchor certificate of the associated
|
|
1343
|
+
* <p>The trust anchor certificate of the associated CloudHSM cluster. When you <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr">initialize the
|
|
1321
1344
|
* cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code>
|
|
1322
1345
|
* file.</p>
|
|
1323
1346
|
*/
|
|
1324
1347
|
TrustAnchorCertificate?: string;
|
|
1325
1348
|
/**
|
|
1326
|
-
* <p>Indicates whether the custom key store is connected to its
|
|
1327
|
-
* <p>You can create and use
|
|
1349
|
+
* <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
|
|
1350
|
+
* <p>You can create and use KMS keys in your custom key stores only when its connection state is
|
|
1328
1351
|
* <code>CONNECTED</code>.</p>
|
|
1329
1352
|
* <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you
|
|
1330
1353
|
* use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If the value is
|
|
1331
1354
|
* <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that
|
|
1332
|
-
* its associated
|
|
1355
|
+
* its associated CloudHSM cluster is active and contains at least one active HSM.</p>
|
|
1333
1356
|
* <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The
|
|
1334
1357
|
* <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure.
|
|
1335
1358
|
* For help resolving a connection failure, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the
|
|
1336
|
-
* <i>
|
|
1359
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1337
1360
|
*/
|
|
1338
1361
|
ConnectionState?: ConnectionStateType | string;
|
|
1339
1362
|
/**
|
|
1340
1363
|
* <p>Describes the connection error. This field appears in the response only when the
|
|
1341
1364
|
* <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see
|
|
1342
1365
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to
|
|
1343
|
-
* Fix a Connection Failure</a> in <i>
|
|
1366
|
+
* Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
1344
1367
|
* <p>Valid values are:</p>
|
|
1345
1368
|
* <ul>
|
|
1346
1369
|
* <li>
|
|
1347
1370
|
* <p>
|
|
1348
|
-
* <code>CLUSTER_NOT_FOUND</code> -
|
|
1371
|
+
* <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the
|
|
1349
1372
|
* specified cluster ID.</p>
|
|
1350
1373
|
* </li>
|
|
1351
1374
|
* <li>
|
|
1352
1375
|
* <p>
|
|
1353
|
-
* <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated
|
|
1354
|
-
* contain any active HSMs. To connect a custom key store to its
|
|
1376
|
+
* <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not
|
|
1377
|
+
* contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster
|
|
1355
1378
|
* must contain at least one active HSM.</p>
|
|
1356
1379
|
* </li>
|
|
1357
1380
|
* <li>
|
|
1358
1381
|
* <p>
|
|
1359
|
-
* <code>INTERNAL_ERROR</code> -
|
|
1382
|
+
* <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal
|
|
1360
1383
|
* error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the
|
|
1361
1384
|
* custom key store before trying to connect again.</p>
|
|
1362
1385
|
* </li>
|
|
1363
1386
|
* <li>
|
|
1364
1387
|
* <p>
|
|
1365
|
-
* <code>INVALID_CREDENTIALS</code> -
|
|
1366
|
-
* <code>kmsuser</code> crypto user in the
|
|
1367
|
-
* custom key store to its
|
|
1388
|
+
* <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the
|
|
1389
|
+
* <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your
|
|
1390
|
+
* custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account
|
|
1368
1391
|
* password and update the key store password value for the custom key store.</p>
|
|
1369
1392
|
* </li>
|
|
1370
1393
|
* <li>
|
|
1371
1394
|
* <p>
|
|
1372
|
-
* <code>NETWORK_ERRORS</code> - Network errors are preventing
|
|
1395
|
+
* <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to
|
|
1373
1396
|
* the custom key store.</p>
|
|
1374
1397
|
* </li>
|
|
1375
1398
|
* <li>
|
|
1376
1399
|
* <p>
|
|
1377
|
-
* <code>SUBNET_NOT_FOUND</code> - A subnet in the
|
|
1378
|
-
* deleted. If
|
|
1379
|
-
* connect the custom key store to the
|
|
1400
|
+
* <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was
|
|
1401
|
+
* deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to
|
|
1402
|
+
* connect the custom key store to the CloudHSM cluster fail. To fix this error, create a
|
|
1380
1403
|
* cluster from a recent backup and associate it with your custom key store. (This process
|
|
1381
1404
|
* creates a new cluster configuration with a VPC and private subnets.) For details, see
|
|
1382
1405
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How
|
|
1383
|
-
* to Fix a Connection Failure</a> in the <i>
|
|
1406
|
+
* to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1384
1407
|
* </li>
|
|
1385
1408
|
* <li>
|
|
1386
1409
|
* <p>
|
|
1387
1410
|
* <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of
|
|
1388
|
-
* the associated
|
|
1389
|
-
* connect your custom key store to its
|
|
1411
|
+
* the associated CloudHSM cluster due to too many failed password attempts. Before you can
|
|
1412
|
+
* connect your custom key store to its CloudHSM cluster, you must change the
|
|
1390
1413
|
* <code>kmsuser</code> account password and update the key store password value for the
|
|
1391
1414
|
* custom key store.</p>
|
|
1392
1415
|
* </li>
|
|
1393
1416
|
* <li>
|
|
1394
1417
|
* <p>
|
|
1395
1418
|
* <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the
|
|
1396
|
-
* the associated
|
|
1419
|
+
* the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code>
|
|
1397
1420
|
* account password and logging into the cluster. Before you can connect your custom key
|
|
1398
|
-
* store to its
|
|
1421
|
+
* store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster.
|
|
1399
1422
|
* If you changed the <code>kmsuser</code> password to log into the cluster, you must also
|
|
1400
1423
|
* and update the key store password value for the custom key store. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2">How to Log Out
|
|
1401
|
-
* and Reconnect</a> in the <i>
|
|
1424
|
+
* and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1402
1425
|
* </li>
|
|
1403
1426
|
* <li>
|
|
1404
1427
|
* <p>
|
|
1405
|
-
* <code>USER_NOT_FOUND</code> -
|
|
1406
|
-
* the associated
|
|
1428
|
+
* <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in
|
|
1429
|
+
* the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM
|
|
1407
1430
|
* cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update
|
|
1408
1431
|
* the key store password value for the custom key store.</p>
|
|
1409
1432
|
* </li>
|
|
@@ -1441,31 +1464,31 @@ export interface DecryptRequest {
|
|
|
1441
1464
|
CiphertextBlob: Uint8Array | undefined;
|
|
1442
1465
|
/**
|
|
1443
1466
|
* <p>Specifies the encryption context to use when decrypting the data.
|
|
1444
|
-
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric
|
|
1445
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
1467
|
+
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.</p>
|
|
1468
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
1446
1469
|
* <p>For more information, see
|
|
1447
1470
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1448
|
-
* Context</a> in the <i>
|
|
1471
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1449
1472
|
*/
|
|
1450
1473
|
EncryptionContext?: {
|
|
1451
1474
|
[key: string]: string;
|
|
1452
1475
|
};
|
|
1453
1476
|
/**
|
|
1454
1477
|
* <p>A list of grant tokens. </p>
|
|
1455
|
-
* <p>Use a grant token when your permission to call this operation comes from a
|
|
1456
|
-
*
|
|
1457
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
1478
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
1479
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1458
1480
|
*/
|
|
1459
1481
|
GrantTokens?: string[];
|
|
1460
1482
|
/**
|
|
1461
|
-
* <p>Specifies the
|
|
1462
|
-
* key ID of the
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1483
|
+
* <p>Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a
|
|
1484
|
+
* key ID of the KMS key that was used to encrypt the ciphertext. </p>
|
|
1485
|
+
*
|
|
1486
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
1487
|
+
* If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the
|
|
1465
1488
|
* symmetric ciphertext blob. However, it is always recommended as a best practice. This practice
|
|
1466
|
-
* ensures that you use the
|
|
1489
|
+
* ensures that you use the KMS key that you intend.</p>
|
|
1467
1490
|
*
|
|
1468
|
-
* <p>To specify a
|
|
1491
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
1469
1492
|
* <p>For example:</p>
|
|
1470
1493
|
* <ul>
|
|
1471
1494
|
* <li>
|
|
@@ -1485,16 +1508,16 @@ export interface DecryptRequest {
|
|
|
1485
1508
|
* </p>
|
|
1486
1509
|
* </li>
|
|
1487
1510
|
* </ul>
|
|
1488
|
-
* <p>To get the key ID and key ARN for a
|
|
1511
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
1489
1512
|
*/
|
|
1490
1513
|
KeyId?: string;
|
|
1491
1514
|
/**
|
|
1492
1515
|
* <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify
|
|
1493
1516
|
* the same algorithm that was used to encrypt the data. If you specify a different algorithm,
|
|
1494
1517
|
* the <code>Decrypt</code> operation fails.</p>
|
|
1495
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
1518
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
1496
1519
|
* The default value, <code>SYMMETRIC_DEFAULT</code>, represents the only supported algorithm
|
|
1497
|
-
* that is valid for symmetric
|
|
1520
|
+
* that is valid for symmetric KMS keys.</p>
|
|
1498
1521
|
*/
|
|
1499
1522
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
1500
1523
|
}
|
|
@@ -1506,11 +1529,11 @@ export declare namespace DecryptRequest {
|
|
|
1506
1529
|
}
|
|
1507
1530
|
export interface DecryptResponse {
|
|
1508
1531
|
/**
|
|
1509
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
1532
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to decrypt the ciphertext.</p>
|
|
1510
1533
|
*/
|
|
1511
1534
|
KeyId?: string;
|
|
1512
1535
|
/**
|
|
1513
|
-
* <p>Decrypted plaintext data. When you use the HTTP API or the
|
|
1536
|
+
* <p>Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
1514
1537
|
*/
|
|
1515
1538
|
Plaintext?: Uint8Array;
|
|
1516
1539
|
/**
|
|
@@ -1525,9 +1548,9 @@ export declare namespace DecryptResponse {
|
|
|
1525
1548
|
const filterSensitiveLog: (obj: DecryptResponse) => any;
|
|
1526
1549
|
}
|
|
1527
1550
|
/**
|
|
1528
|
-
* <p>The request was rejected because the specified
|
|
1551
|
+
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
1529
1552
|
* <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
|
|
1530
|
-
* in a <a>ReEncrypt</a> request must identify the same
|
|
1553
|
+
* in a <a>ReEncrypt</a> request must identify the same KMS key that was used to encrypt
|
|
1531
1554
|
* the ciphertext.</p>
|
|
1532
1555
|
*/
|
|
1533
1556
|
export interface IncorrectKeyException extends __SmithyException, $MetadataBearer {
|
|
@@ -1547,7 +1570,7 @@ export declare namespace IncorrectKeyException {
|
|
|
1547
1570
|
* into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
|
|
1548
1571
|
* invalid.</p>
|
|
1549
1572
|
* <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
|
|
1550
|
-
*
|
|
1573
|
+
* KMS could not decrypt the encrypted (wrapped) key material. </p>
|
|
1551
1574
|
*/
|
|
1552
1575
|
export interface InvalidCiphertextException extends __SmithyException, $MetadataBearer {
|
|
1553
1576
|
name: "InvalidCiphertextException";
|
|
@@ -1564,20 +1587,20 @@ export declare namespace InvalidCiphertextException {
|
|
|
1564
1587
|
* <p>The request was rejected for one of the following reasons: </p>
|
|
1565
1588
|
* <ul>
|
|
1566
1589
|
* <li>
|
|
1567
|
-
* <p>The <code>KeyUsage</code> value of the
|
|
1590
|
+
* <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
|
|
1568
1591
|
* operation.</p>
|
|
1569
1592
|
* </li>
|
|
1570
1593
|
* <li>
|
|
1571
1594
|
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
1572
|
-
* incompatible with the type of key material in the
|
|
1573
|
-
* <code>(
|
|
1595
|
+
* incompatible with the type of key material in the KMS key
|
|
1596
|
+
* <code>(KeySpec</code>).</p>
|
|
1574
1597
|
* </li>
|
|
1575
1598
|
* </ul>
|
|
1576
1599
|
* <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
|
|
1577
1600
|
* <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the
|
|
1578
1601
|
* <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of
|
|
1579
|
-
* a
|
|
1580
|
-
* <p>To find the encryption or signing algorithms supported for a particular
|
|
1602
|
+
* a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1603
|
+
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1581
1604
|
*/
|
|
1582
1605
|
export interface InvalidKeyUsageException extends __SmithyException, $MetadataBearer {
|
|
1583
1606
|
name: "InvalidKeyUsageException";
|
|
@@ -1591,7 +1614,7 @@ export declare namespace InvalidKeyUsageException {
|
|
|
1591
1614
|
const filterSensitiveLog: (obj: InvalidKeyUsageException) => any;
|
|
1592
1615
|
}
|
|
1593
1616
|
/**
|
|
1594
|
-
* <p>The request was rejected because the specified
|
|
1617
|
+
* <p>The request was rejected because the specified KMS key was not available. You can retry the
|
|
1595
1618
|
* request.</p>
|
|
1596
1619
|
*/
|
|
1597
1620
|
export interface KeyUnavailableException extends __SmithyException, $MetadataBearer {
|
|
@@ -1640,9 +1663,9 @@ export declare namespace DeleteCustomKeyStoreResponse {
|
|
|
1640
1663
|
}
|
|
1641
1664
|
export interface DeleteImportedKeyMaterialRequest {
|
|
1642
1665
|
/**
|
|
1643
|
-
* <p>Identifies the
|
|
1644
|
-
* <code>Origin</code> of the
|
|
1645
|
-
* <p>Specify the key ID or key ARN of the
|
|
1666
|
+
* <p>Identifies the KMS key from which you are deleting imported key material. The
|
|
1667
|
+
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
1668
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1646
1669
|
* <p>For example:</p>
|
|
1647
1670
|
* <ul>
|
|
1648
1671
|
* <li>
|
|
@@ -1654,7 +1677,7 @@ export interface DeleteImportedKeyMaterialRequest {
|
|
|
1654
1677
|
* </p>
|
|
1655
1678
|
* </li>
|
|
1656
1679
|
* </ul>
|
|
1657
|
-
* <p>To get the key ID and key ARN for a
|
|
1680
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1658
1681
|
*/
|
|
1659
1682
|
KeyId: string | undefined;
|
|
1660
1683
|
}
|
|
@@ -1684,7 +1707,7 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
1684
1707
|
CustomKeyStoreName?: string;
|
|
1685
1708
|
/**
|
|
1686
1709
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
1687
|
-
* value is present,
|
|
1710
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
1688
1711
|
* return fewer.</p>
|
|
1689
1712
|
*/
|
|
1690
1713
|
Limit?: number;
|
|
@@ -1742,12 +1765,11 @@ export declare namespace InvalidMarkerException {
|
|
|
1742
1765
|
}
|
|
1743
1766
|
export interface DescribeKeyRequest {
|
|
1744
1767
|
/**
|
|
1745
|
-
* <p>Describes the specified
|
|
1746
|
-
* <p>If you specify a predefined
|
|
1747
|
-
* alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
|
|
1748
|
-
* managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the
|
|
1768
|
+
* <p>Describes the specified KMS key. </p>
|
|
1769
|
+
* <p>If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the
|
|
1770
|
+
* alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html##aws-managed-cmk">Amazon Web Services managed key</a> and returns its <code>KeyId</code> and <code>Arn</code> in the
|
|
1749
1771
|
* response.</p>
|
|
1750
|
-
* <p>To specify a
|
|
1772
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
1751
1773
|
* <p>For example:</p>
|
|
1752
1774
|
* <ul>
|
|
1753
1775
|
* <li>
|
|
@@ -1767,13 +1789,13 @@ export interface DescribeKeyRequest {
|
|
|
1767
1789
|
* </p>
|
|
1768
1790
|
* </li>
|
|
1769
1791
|
* </ul>
|
|
1770
|
-
* <p>To get the key ID and key ARN for a
|
|
1792
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
1771
1793
|
*/
|
|
1772
1794
|
KeyId: string | undefined;
|
|
1773
1795
|
/**
|
|
1774
1796
|
* <p>A list of grant tokens.</p>
|
|
1775
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1776
|
-
* <i>
|
|
1797
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
1798
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1777
1799
|
*/
|
|
1778
1800
|
GrantTokens?: string[];
|
|
1779
1801
|
}
|
|
@@ -1797,8 +1819,8 @@ export declare namespace DescribeKeyResponse {
|
|
|
1797
1819
|
}
|
|
1798
1820
|
export interface DisableKeyRequest {
|
|
1799
1821
|
/**
|
|
1800
|
-
* <p>Identifies the
|
|
1801
|
-
* <p>Specify the key ID or key ARN of the
|
|
1822
|
+
* <p>Identifies the KMS key to disable.</p>
|
|
1823
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1802
1824
|
* <p>For example:</p>
|
|
1803
1825
|
* <ul>
|
|
1804
1826
|
* <li>
|
|
@@ -1810,7 +1832,7 @@ export interface DisableKeyRequest {
|
|
|
1810
1832
|
* </p>
|
|
1811
1833
|
* </li>
|
|
1812
1834
|
* </ul>
|
|
1813
|
-
* <p>To get the key ID and key ARN for a
|
|
1835
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1814
1836
|
*/
|
|
1815
1837
|
KeyId: string | undefined;
|
|
1816
1838
|
}
|
|
@@ -1822,11 +1844,11 @@ export declare namespace DisableKeyRequest {
|
|
|
1822
1844
|
}
|
|
1823
1845
|
export interface DisableKeyRotationRequest {
|
|
1824
1846
|
/**
|
|
1825
|
-
* <p>Identifies a symmetric
|
|
1826
|
-
* rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric
|
|
1847
|
+
* <p>Identifies a symmetric KMS key. You cannot enable or disable automatic
|
|
1848
|
+
* rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys
|
|
1827
1849
|
* with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key
|
|
1828
|
-
* material</a>, or
|
|
1829
|
-
* <p>Specify the key ID or key ARN of the
|
|
1850
|
+
* material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>.</p>
|
|
1851
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1830
1852
|
* <p>For example:</p>
|
|
1831
1853
|
* <ul>
|
|
1832
1854
|
* <li>
|
|
@@ -1838,7 +1860,7 @@ export interface DisableKeyRotationRequest {
|
|
|
1838
1860
|
* </p>
|
|
1839
1861
|
* </li>
|
|
1840
1862
|
* </ul>
|
|
1841
|
-
* <p>To get the key ID and key ARN for a
|
|
1863
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1842
1864
|
*/
|
|
1843
1865
|
KeyId: string | undefined;
|
|
1844
1866
|
}
|
|
@@ -1870,8 +1892,8 @@ export declare namespace DisconnectCustomKeyStoreResponse {
|
|
|
1870
1892
|
}
|
|
1871
1893
|
export interface EnableKeyRequest {
|
|
1872
1894
|
/**
|
|
1873
|
-
* <p>Identifies the
|
|
1874
|
-
* <p>Specify the key ID or key ARN of the
|
|
1895
|
+
* <p>Identifies the KMS key to enable.</p>
|
|
1896
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1875
1897
|
* <p>For example:</p>
|
|
1876
1898
|
* <ul>
|
|
1877
1899
|
* <li>
|
|
@@ -1883,7 +1905,7 @@ export interface EnableKeyRequest {
|
|
|
1883
1905
|
* </p>
|
|
1884
1906
|
* </li>
|
|
1885
1907
|
* </ul>
|
|
1886
|
-
* <p>To get the key ID and key ARN for a
|
|
1908
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1887
1909
|
*/
|
|
1888
1910
|
KeyId: string | undefined;
|
|
1889
1911
|
}
|
|
@@ -1895,9 +1917,9 @@ export declare namespace EnableKeyRequest {
|
|
|
1895
1917
|
}
|
|
1896
1918
|
export interface EnableKeyRotationRequest {
|
|
1897
1919
|
/**
|
|
1898
|
-
* <p>Identifies a symmetric
|
|
1920
|
+
* <p>Identifies a symmetric KMS key. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key">multi-Region keys</a>, set the property on the primary key.</p>
|
|
1899
1921
|
*
|
|
1900
|
-
* <p>Specify the key ID or key ARN of the
|
|
1922
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1901
1923
|
* <p>For example:</p>
|
|
1902
1924
|
* <ul>
|
|
1903
1925
|
* <li>
|
|
@@ -1909,7 +1931,7 @@ export interface EnableKeyRotationRequest {
|
|
|
1909
1931
|
* </p>
|
|
1910
1932
|
* </li>
|
|
1911
1933
|
* </ul>
|
|
1912
|
-
* <p>To get the key ID and key ARN for a
|
|
1934
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1913
1935
|
*/
|
|
1914
1936
|
KeyId: string | undefined;
|
|
1915
1937
|
}
|
|
@@ -1921,8 +1943,8 @@ export declare namespace EnableKeyRotationRequest {
|
|
|
1921
1943
|
}
|
|
1922
1944
|
export interface EncryptRequest {
|
|
1923
1945
|
/**
|
|
1924
|
-
* <p>Identifies the
|
|
1925
|
-
* <p>To specify a
|
|
1946
|
+
* <p>Identifies the KMS key to use in the encryption operation.</p>
|
|
1947
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
1926
1948
|
* <p>For example:</p>
|
|
1927
1949
|
* <ul>
|
|
1928
1950
|
* <li>
|
|
@@ -1942,7 +1964,7 @@ export interface EncryptRequest {
|
|
|
1942
1964
|
* </p>
|
|
1943
1965
|
* </li>
|
|
1944
1966
|
* </ul>
|
|
1945
|
-
* <p>To get the key ID and key ARN for a
|
|
1967
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
1946
1968
|
*/
|
|
1947
1969
|
KeyId: string | undefined;
|
|
1948
1970
|
/**
|
|
@@ -1951,27 +1973,27 @@ export interface EncryptRequest {
|
|
|
1951
1973
|
Plaintext: Uint8Array | undefined;
|
|
1952
1974
|
/**
|
|
1953
1975
|
* <p>Specifies the encryption context that will be used to encrypt the data.
|
|
1954
|
-
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric
|
|
1955
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
1976
|
+
* An encryption context is valid only for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context. </p>
|
|
1977
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
1956
1978
|
* <p>For more information, see
|
|
1957
1979
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1958
|
-
* Context</a> in the <i>
|
|
1980
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1959
1981
|
*/
|
|
1960
1982
|
EncryptionContext?: {
|
|
1961
1983
|
[key: string]: string;
|
|
1962
1984
|
};
|
|
1963
1985
|
/**
|
|
1964
1986
|
* <p>A list of grant tokens.</p>
|
|
1965
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
1966
|
-
* <i>
|
|
1987
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
1988
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1967
1989
|
*/
|
|
1968
1990
|
GrantTokens?: string[];
|
|
1969
1991
|
/**
|
|
1970
|
-
* <p>Specifies the encryption algorithm that
|
|
1971
|
-
* The algorithm must be compatible with the
|
|
1972
|
-
* <p>This parameter is required only for asymmetric
|
|
1973
|
-
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric
|
|
1974
|
-
* an asymmetric
|
|
1992
|
+
* <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
|
1993
|
+
* The algorithm must be compatible with the KMS key that you specify.</p>
|
|
1994
|
+
* <p>This parameter is required only for asymmetric KMS keys. The default value,
|
|
1995
|
+
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric KMS keys. If you are using
|
|
1996
|
+
* an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.</p>
|
|
1975
1997
|
*/
|
|
1976
1998
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
1977
1999
|
}
|
|
@@ -1983,11 +2005,11 @@ export declare namespace EncryptRequest {
|
|
|
1983
2005
|
}
|
|
1984
2006
|
export interface EncryptResponse {
|
|
1985
2007
|
/**
|
|
1986
|
-
* <p>The encrypted plaintext. When you use the HTTP API or the
|
|
2008
|
+
* <p>The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
1987
2009
|
*/
|
|
1988
2010
|
CiphertextBlob?: Uint8Array;
|
|
1989
2011
|
/**
|
|
1990
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2012
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to encrypt the plaintext.</p>
|
|
1991
2013
|
*/
|
|
1992
2014
|
KeyId?: string;
|
|
1993
2015
|
/**
|
|
@@ -2018,9 +2040,9 @@ export declare namespace ExpiredImportTokenException {
|
|
|
2018
2040
|
}
|
|
2019
2041
|
export interface GenerateDataKeyRequest {
|
|
2020
2042
|
/**
|
|
2021
|
-
* <p>Identifies the symmetric
|
|
2043
|
+
* <p>Identifies the symmetric KMS key that encrypts the data key.</p>
|
|
2022
2044
|
*
|
|
2023
|
-
* <p>To specify a
|
|
2045
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
2024
2046
|
* <p>For example:</p>
|
|
2025
2047
|
* <ul>
|
|
2026
2048
|
* <li>
|
|
@@ -2040,15 +2062,15 @@ export interface GenerateDataKeyRequest {
|
|
|
2040
2062
|
* </p>
|
|
2041
2063
|
* </li>
|
|
2042
2064
|
* </ul>
|
|
2043
|
-
* <p>To get the key ID and key ARN for a
|
|
2065
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2044
2066
|
*/
|
|
2045
2067
|
KeyId: string | undefined;
|
|
2046
2068
|
/**
|
|
2047
2069
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
2048
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
2070
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
2049
2071
|
* <p>For more information, see
|
|
2050
2072
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2051
|
-
* Context</a> in the <i>
|
|
2073
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2052
2074
|
*/
|
|
2053
2075
|
EncryptionContext?: {
|
|
2054
2076
|
[key: string]: string;
|
|
@@ -2070,8 +2092,8 @@ export interface GenerateDataKeyRequest {
|
|
|
2070
2092
|
KeySpec?: DataKeySpec | string;
|
|
2071
2093
|
/**
|
|
2072
2094
|
* <p>A list of grant tokens.</p>
|
|
2073
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2074
|
-
* <i>
|
|
2095
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2096
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2075
2097
|
*/
|
|
2076
2098
|
GrantTokens?: string[];
|
|
2077
2099
|
}
|
|
@@ -2083,16 +2105,16 @@ export declare namespace GenerateDataKeyRequest {
|
|
|
2083
2105
|
}
|
|
2084
2106
|
export interface GenerateDataKeyResponse {
|
|
2085
2107
|
/**
|
|
2086
|
-
* <p>The encrypted copy of the data key. When you use the HTTP API or the
|
|
2108
|
+
* <p>The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2087
2109
|
*/
|
|
2088
2110
|
CiphertextBlob?: Uint8Array;
|
|
2089
2111
|
/**
|
|
2090
|
-
* <p>The plaintext data key. When you use the HTTP API or the
|
|
2112
|
+
* <p>The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of
|
|
2091
2113
|
* KMS. Then, remove it from memory as soon as possible.</p>
|
|
2092
2114
|
*/
|
|
2093
2115
|
Plaintext?: Uint8Array;
|
|
2094
2116
|
/**
|
|
2095
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2117
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the data key.</p>
|
|
2096
2118
|
*/
|
|
2097
2119
|
KeyId?: string;
|
|
2098
2120
|
}
|
|
@@ -2106,20 +2128,19 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2106
2128
|
/**
|
|
2107
2129
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
2108
2130
|
* data key pair.</p>
|
|
2109
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
2131
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
2110
2132
|
* <p>For more information, see
|
|
2111
2133
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2112
|
-
* Context</a> in the <i>
|
|
2134
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2113
2135
|
*/
|
|
2114
2136
|
EncryptionContext?: {
|
|
2115
2137
|
[key: string]: string;
|
|
2116
2138
|
};
|
|
2117
2139
|
/**
|
|
2118
|
-
* <p>Specifies the symmetric
|
|
2119
|
-
* specify an asymmetric
|
|
2120
|
-
* CMK, use the <a>DescribeKey</a> operation.</p>
|
|
2140
|
+
* <p>Specifies the symmetric KMS key that encrypts the private key in the data key pair. You cannot
|
|
2141
|
+
* specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
2121
2142
|
*
|
|
2122
|
-
* <p>To specify a
|
|
2143
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
2123
2144
|
* <p>For example:</p>
|
|
2124
2145
|
* <ul>
|
|
2125
2146
|
* <li>
|
|
@@ -2139,18 +2160,18 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2139
2160
|
* </p>
|
|
2140
2161
|
* </li>
|
|
2141
2162
|
* </ul>
|
|
2142
|
-
* <p>To get the key ID and key ARN for a
|
|
2163
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2143
2164
|
*/
|
|
2144
2165
|
KeyId: string | undefined;
|
|
2145
2166
|
/**
|
|
2146
2167
|
* <p>Determines the type of data key pair that is generated. </p>
|
|
2147
|
-
* <p>The
|
|
2168
|
+
* <p>The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.</p>
|
|
2148
2169
|
*/
|
|
2149
2170
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
2150
2171
|
/**
|
|
2151
2172
|
* <p>A list of grant tokens.</p>
|
|
2152
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2153
|
-
* <i>
|
|
2173
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2174
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2154
2175
|
*/
|
|
2155
2176
|
GrantTokens?: string[];
|
|
2156
2177
|
}
|
|
@@ -2162,11 +2183,11 @@ export declare namespace GenerateDataKeyPairRequest {
|
|
|
2162
2183
|
}
|
|
2163
2184
|
export interface GenerateDataKeyPairResponse {
|
|
2164
2185
|
/**
|
|
2165
|
-
* <p>The encrypted copy of the private key. When you use the HTTP API or the
|
|
2186
|
+
* <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2166
2187
|
*/
|
|
2167
2188
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
2168
2189
|
/**
|
|
2169
|
-
* <p>The plaintext copy of the private key. When you use the HTTP API or the
|
|
2190
|
+
* <p>The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2170
2191
|
*/
|
|
2171
2192
|
PrivateKeyPlaintext?: Uint8Array;
|
|
2172
2193
|
/**
|
|
@@ -2174,7 +2195,7 @@ export interface GenerateDataKeyPairResponse {
|
|
|
2174
2195
|
*/
|
|
2175
2196
|
PublicKey?: Uint8Array;
|
|
2176
2197
|
/**
|
|
2177
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2198
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the private key.</p>
|
|
2178
2199
|
*/
|
|
2179
2200
|
KeyId?: string;
|
|
2180
2201
|
/**
|
|
@@ -2192,19 +2213,19 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2192
2213
|
/**
|
|
2193
2214
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
2194
2215
|
* data key pair.</p>
|
|
2195
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
2216
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
2196
2217
|
* <p>For more information, see
|
|
2197
2218
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2198
|
-
* Context</a> in the <i>
|
|
2219
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2199
2220
|
*/
|
|
2200
2221
|
EncryptionContext?: {
|
|
2201
2222
|
[key: string]: string;
|
|
2202
2223
|
};
|
|
2203
2224
|
/**
|
|
2204
|
-
* <p>Specifies the
|
|
2205
|
-
* symmetric
|
|
2206
|
-
* type and origin of your
|
|
2207
|
-
* <p>To specify a
|
|
2225
|
+
* <p>Specifies the KMS key that encrypts the private key in the data key pair. You must specify a
|
|
2226
|
+
* symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
2227
|
+
* type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
2228
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
2208
2229
|
* <p>For example:</p>
|
|
2209
2230
|
* <ul>
|
|
2210
2231
|
* <li>
|
|
@@ -2224,18 +2245,18 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2224
2245
|
* </p>
|
|
2225
2246
|
* </li>
|
|
2226
2247
|
* </ul>
|
|
2227
|
-
* <p>To get the key ID and key ARN for a
|
|
2248
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2228
2249
|
*/
|
|
2229
2250
|
KeyId: string | undefined;
|
|
2230
2251
|
/**
|
|
2231
2252
|
* <p>Determines the type of data key pair that is generated.</p>
|
|
2232
|
-
* <p>The
|
|
2253
|
+
* <p>The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.</p>
|
|
2233
2254
|
*/
|
|
2234
2255
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
2235
2256
|
/**
|
|
2236
2257
|
* <p>A list of grant tokens.</p>
|
|
2237
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2238
|
-
* <i>
|
|
2258
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2259
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2239
2260
|
*/
|
|
2240
2261
|
GrantTokens?: string[];
|
|
2241
2262
|
}
|
|
@@ -2247,7 +2268,7 @@ export declare namespace GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2247
2268
|
}
|
|
2248
2269
|
export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
2249
2270
|
/**
|
|
2250
|
-
* <p>The encrypted copy of the private key. When you use the HTTP API or the
|
|
2271
|
+
* <p>The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2251
2272
|
*/
|
|
2252
2273
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
2253
2274
|
/**
|
|
@@ -2255,7 +2276,7 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
2255
2276
|
*/
|
|
2256
2277
|
PublicKey?: Uint8Array;
|
|
2257
2278
|
/**
|
|
2258
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2279
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the private key.</p>
|
|
2259
2280
|
*/
|
|
2260
2281
|
KeyId?: string;
|
|
2261
2282
|
/**
|
|
@@ -2271,9 +2292,9 @@ export declare namespace GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
2271
2292
|
}
|
|
2272
2293
|
export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
2273
2294
|
/**
|
|
2274
|
-
* <p>The identifier of the symmetric
|
|
2295
|
+
* <p>The identifier of the symmetric KMS key that encrypts the data
|
|
2275
2296
|
* key.</p>
|
|
2276
|
-
* <p>To specify a
|
|
2297
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
2277
2298
|
* <p>For example:</p>
|
|
2278
2299
|
* <ul>
|
|
2279
2300
|
* <li>
|
|
@@ -2293,15 +2314,15 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2293
2314
|
* </p>
|
|
2294
2315
|
* </li>
|
|
2295
2316
|
* </ul>
|
|
2296
|
-
* <p>To get the key ID and key ARN for a
|
|
2317
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2297
2318
|
*/
|
|
2298
2319
|
KeyId: string | undefined;
|
|
2299
2320
|
/**
|
|
2300
2321
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
2301
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
2322
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
2302
2323
|
* <p>For more information, see
|
|
2303
2324
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2304
|
-
* Context</a> in the <i>
|
|
2325
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2305
2326
|
*/
|
|
2306
2327
|
EncryptionContext?: {
|
|
2307
2328
|
[key: string]: string;
|
|
@@ -2319,8 +2340,8 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2319
2340
|
NumberOfBytes?: number;
|
|
2320
2341
|
/**
|
|
2321
2342
|
* <p>A list of grant tokens.</p>
|
|
2322
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2323
|
-
* <i>
|
|
2343
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2344
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2324
2345
|
*/
|
|
2325
2346
|
GrantTokens?: string[];
|
|
2326
2347
|
}
|
|
@@ -2332,11 +2353,11 @@ export declare namespace GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2332
2353
|
}
|
|
2333
2354
|
export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
2334
2355
|
/**
|
|
2335
|
-
* <p>The encrypted data key. When you use the HTTP API or the
|
|
2356
|
+
* <p>The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2336
2357
|
*/
|
|
2337
2358
|
CiphertextBlob?: Uint8Array;
|
|
2338
2359
|
/**
|
|
2339
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2360
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that encrypted the data key.</p>
|
|
2340
2361
|
*/
|
|
2341
2362
|
KeyId?: string;
|
|
2342
2363
|
}
|
|
@@ -2352,7 +2373,7 @@ export interface GenerateRandomRequest {
|
|
|
2352
2373
|
*/
|
|
2353
2374
|
NumberOfBytes?: number;
|
|
2354
2375
|
/**
|
|
2355
|
-
* <p>Generates the random byte string in the
|
|
2376
|
+
* <p>Generates the random byte string in the CloudHSM cluster that is associated with the
|
|
2356
2377
|
* specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
2357
2378
|
*/
|
|
2358
2379
|
CustomKeyStoreId?: string;
|
|
@@ -2365,7 +2386,7 @@ export declare namespace GenerateRandomRequest {
|
|
|
2365
2386
|
}
|
|
2366
2387
|
export interface GenerateRandomResponse {
|
|
2367
2388
|
/**
|
|
2368
|
-
* <p>The random byte string. When you use the HTTP API or the
|
|
2389
|
+
* <p>The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2369
2390
|
*/
|
|
2370
2391
|
Plaintext?: Uint8Array;
|
|
2371
2392
|
}
|
|
@@ -2377,8 +2398,8 @@ export declare namespace GenerateRandomResponse {
|
|
|
2377
2398
|
}
|
|
2378
2399
|
export interface GetKeyPolicyRequest {
|
|
2379
2400
|
/**
|
|
2380
|
-
* <p>Gets the key policy for the specified
|
|
2381
|
-
* <p>Specify the key ID or key ARN of the
|
|
2401
|
+
* <p>Gets the key policy for the specified KMS key.</p>
|
|
2402
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2382
2403
|
* <p>For example:</p>
|
|
2383
2404
|
* <ul>
|
|
2384
2405
|
* <li>
|
|
@@ -2390,7 +2411,7 @@ export interface GetKeyPolicyRequest {
|
|
|
2390
2411
|
* </p>
|
|
2391
2412
|
* </li>
|
|
2392
2413
|
* </ul>
|
|
2393
|
-
* <p>To get the key ID and key ARN for a
|
|
2414
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2394
2415
|
*/
|
|
2395
2416
|
KeyId: string | undefined;
|
|
2396
2417
|
/**
|
|
@@ -2419,9 +2440,9 @@ export declare namespace GetKeyPolicyResponse {
|
|
|
2419
2440
|
}
|
|
2420
2441
|
export interface GetKeyRotationStatusRequest {
|
|
2421
2442
|
/**
|
|
2422
|
-
* <p>Gets the rotation status for the specified
|
|
2423
|
-
* <p>Specify the key ID or key ARN of the
|
|
2424
|
-
* different
|
|
2443
|
+
* <p>Gets the rotation status for the specified KMS key.</p>
|
|
2444
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
2445
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
2425
2446
|
* <p>For example:</p>
|
|
2426
2447
|
* <ul>
|
|
2427
2448
|
* <li>
|
|
@@ -2433,7 +2454,7 @@ export interface GetKeyRotationStatusRequest {
|
|
|
2433
2454
|
* </p>
|
|
2434
2455
|
* </li>
|
|
2435
2456
|
* </ul>
|
|
2436
|
-
* <p>To get the key ID and key ARN for a
|
|
2457
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2437
2458
|
*/
|
|
2438
2459
|
KeyId: string | undefined;
|
|
2439
2460
|
}
|
|
@@ -2460,9 +2481,9 @@ export declare enum WrappingKeySpec {
|
|
|
2460
2481
|
}
|
|
2461
2482
|
export interface GetParametersForImportRequest {
|
|
2462
2483
|
/**
|
|
2463
|
-
* <p>The identifier of the symmetric
|
|
2464
|
-
* <code>Origin</code> of the
|
|
2465
|
-
* <p>Specify the key ID or key ARN of the
|
|
2484
|
+
* <p>The identifier of the symmetric KMS key into which you will import key material. The
|
|
2485
|
+
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
2486
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2466
2487
|
* <p>For example:</p>
|
|
2467
2488
|
* <ul>
|
|
2468
2489
|
* <li>
|
|
@@ -2474,12 +2495,12 @@ export interface GetParametersForImportRequest {
|
|
|
2474
2495
|
* </p>
|
|
2475
2496
|
* </li>
|
|
2476
2497
|
* </ul>
|
|
2477
|
-
* <p>To get the key ID and key ARN for a
|
|
2498
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2478
2499
|
*/
|
|
2479
2500
|
KeyId: string | undefined;
|
|
2480
2501
|
/**
|
|
2481
2502
|
* <p>The algorithm you will use to encrypt the key material before importing it with <a>ImportKeyMaterial</a>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html">Encrypt the Key Material</a>
|
|
2482
|
-
* in the <i>
|
|
2503
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2483
2504
|
*/
|
|
2484
2505
|
WrappingAlgorithm: AlgorithmSpec | string | undefined;
|
|
2485
2506
|
/**
|
|
@@ -2496,8 +2517,8 @@ export declare namespace GetParametersForImportRequest {
|
|
|
2496
2517
|
}
|
|
2497
2518
|
export interface GetParametersForImportResponse {
|
|
2498
2519
|
/**
|
|
2499
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
2500
|
-
* request. This is the same
|
|
2520
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key to use in a subsequent <a>ImportKeyMaterial</a>
|
|
2521
|
+
* request. This is the same KMS key specified in the <code>GetParametersForImport</code>
|
|
2501
2522
|
* request.</p>
|
|
2502
2523
|
*/
|
|
2503
2524
|
KeyId?: string;
|
|
@@ -2525,9 +2546,9 @@ export declare namespace GetParametersForImportResponse {
|
|
|
2525
2546
|
}
|
|
2526
2547
|
export interface GetPublicKeyRequest {
|
|
2527
2548
|
/**
|
|
2528
|
-
* <p>Identifies the asymmetric
|
|
2549
|
+
* <p>Identifies the asymmetric KMS key that includes the public key.</p>
|
|
2529
2550
|
*
|
|
2530
|
-
* <p>To specify a
|
|
2551
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
2531
2552
|
* <p>For example:</p>
|
|
2532
2553
|
* <ul>
|
|
2533
2554
|
* <li>
|
|
@@ -2547,13 +2568,13 @@ export interface GetPublicKeyRequest {
|
|
|
2547
2568
|
* </p>
|
|
2548
2569
|
* </li>
|
|
2549
2570
|
* </ul>
|
|
2550
|
-
* <p>To get the key ID and key ARN for a
|
|
2571
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
2551
2572
|
*/
|
|
2552
2573
|
KeyId: string | undefined;
|
|
2553
2574
|
/**
|
|
2554
2575
|
* <p>A list of grant tokens.</p>
|
|
2555
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
2556
|
-
* <i>
|
|
2576
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
2577
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2557
2578
|
*/
|
|
2558
2579
|
GrantTokens?: string[];
|
|
2559
2580
|
}
|
|
@@ -2565,37 +2586,44 @@ export declare namespace GetPublicKeyRequest {
|
|
|
2565
2586
|
}
|
|
2566
2587
|
export interface GetPublicKeyResponse {
|
|
2567
2588
|
/**
|
|
2568
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric
|
|
2589
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key from which the public key was downloaded.</p>
|
|
2569
2590
|
*/
|
|
2570
2591
|
KeyId?: string;
|
|
2571
2592
|
/**
|
|
2572
2593
|
* <p>The exported public key. </p>
|
|
2573
2594
|
* <p>The value is a DER-encoded X.509 public key, also known as
|
|
2574
|
-
* <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. When you use the HTTP API or the
|
|
2595
|
+
* <code>SubjectPublicKeyInfo</code> (SPKI), as defined in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
2575
2596
|
* <p></p>
|
|
2576
2597
|
*/
|
|
2577
2598
|
PublicKey?: Uint8Array;
|
|
2578
2599
|
/**
|
|
2579
|
-
*
|
|
2600
|
+
* @deprecated
|
|
2601
|
+
*
|
|
2602
|
+
* <p>Instead, use the <code>KeySpec</code> field in the <code>GetPublicKey</code> response.</p>
|
|
2603
|
+
* <p>The <code>KeySpec</code> and <code>CustomerMasterKeySpec</code> fields have the same value. We recommend that you use the <code>KeySpec</code> field in your code. However, to avoid breaking changes, KMS will support both fields.</p>
|
|
2580
2604
|
*/
|
|
2581
2605
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
2606
|
+
/**
|
|
2607
|
+
* <p>The type of the of the public key that was downloaded.</p>
|
|
2608
|
+
*/
|
|
2609
|
+
KeySpec?: KeySpec | string;
|
|
2582
2610
|
/**
|
|
2583
2611
|
* <p>The permitted use of the public key. Valid values are <code>ENCRYPT_DECRYPT</code> or
|
|
2584
2612
|
* <code>SIGN_VERIFY</code>. </p>
|
|
2585
2613
|
* <p>This information is critical. If a public key with <code>SIGN_VERIFY</code> key usage
|
|
2586
|
-
* encrypts data outside of
|
|
2614
|
+
* encrypts data outside of KMS, the ciphertext cannot be decrypted. </p>
|
|
2587
2615
|
*/
|
|
2588
2616
|
KeyUsage?: KeyUsageType | string;
|
|
2589
2617
|
/**
|
|
2590
|
-
* <p>The encryption algorithms that
|
|
2591
|
-
* <p>This information is critical. If a public key encrypts data outside of
|
|
2618
|
+
* <p>The encryption algorithms that KMS supports for this key. </p>
|
|
2619
|
+
* <p>This information is critical. If a public key encrypts data outside of KMS by using an
|
|
2592
2620
|
* unsupported encryption algorithm, the ciphertext cannot be decrypted. </p>
|
|
2593
2621
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
2594
2622
|
* is <code>ENCRYPT_DECRYPT</code>.</p>
|
|
2595
2623
|
*/
|
|
2596
2624
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
2597
2625
|
/**
|
|
2598
|
-
* <p>The signing algorithms that
|
|
2626
|
+
* <p>The signing algorithms that KMS supports for this key.</p>
|
|
2599
2627
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
2600
2628
|
* is <code>SIGN_VERIFY</code>.</p>
|
|
2601
2629
|
*/
|
|
@@ -2612,7 +2640,7 @@ export declare namespace GetPublicKeyResponse {
|
|
|
2612
2640
|
*/
|
|
2613
2641
|
export interface GrantListEntry {
|
|
2614
2642
|
/**
|
|
2615
|
-
* <p>The unique identifier for the
|
|
2643
|
+
* <p>The unique identifier for the KMS key to which the grant applies.</p>
|
|
2616
2644
|
*/
|
|
2617
2645
|
KeyId?: string;
|
|
2618
2646
|
/**
|
|
@@ -2631,7 +2659,7 @@ export interface GrantListEntry {
|
|
|
2631
2659
|
* <p>The identity that gets the permissions in the grant.</p>
|
|
2632
2660
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
2633
2661
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
2634
|
-
* principal in the grant is an
|
|
2662
|
+
* principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
|
|
2635
2663
|
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
|
|
2636
2664
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
2637
2665
|
*/
|
|
@@ -2641,7 +2669,7 @@ export interface GrantListEntry {
|
|
|
2641
2669
|
*/
|
|
2642
2670
|
RetiringPrincipal?: string;
|
|
2643
2671
|
/**
|
|
2644
|
-
* <p>The
|
|
2672
|
+
* <p>The Amazon Web Services account under which the grant was issued.</p>
|
|
2645
2673
|
*/
|
|
2646
2674
|
IssuingAccount?: string;
|
|
2647
2675
|
/**
|
|
@@ -2662,11 +2690,11 @@ export declare namespace GrantListEntry {
|
|
|
2662
2690
|
}
|
|
2663
2691
|
export interface ImportKeyMaterialRequest {
|
|
2664
2692
|
/**
|
|
2665
|
-
* <p>The identifier of the symmetric
|
|
2666
|
-
* <code>Origin</code> must be <code>EXTERNAL</code>. This must be the same
|
|
2693
|
+
* <p>The identifier of the symmetric KMS key that receives the imported key material. The KMS key's
|
|
2694
|
+
* <code>Origin</code> must be <code>EXTERNAL</code>. This must be the same KMS key specified in
|
|
2667
2695
|
* the <code>KeyID</code> parameter of the corresponding <a>GetParametersForImport</a>
|
|
2668
2696
|
* request.</p>
|
|
2669
|
-
* <p>Specify the key ID or key ARN of the
|
|
2697
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2670
2698
|
* <p>For example:</p>
|
|
2671
2699
|
* <ul>
|
|
2672
2700
|
* <li>
|
|
@@ -2678,7 +2706,7 @@ export interface ImportKeyMaterialRequest {
|
|
|
2678
2706
|
* </p>
|
|
2679
2707
|
* </li>
|
|
2680
2708
|
* </ul>
|
|
2681
|
-
* <p>To get the key ID and key ARN for a
|
|
2709
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2682
2710
|
*/
|
|
2683
2711
|
KeyId: string | undefined;
|
|
2684
2712
|
/**
|
|
@@ -2693,8 +2721,8 @@ export interface ImportKeyMaterialRequest {
|
|
|
2693
2721
|
*/
|
|
2694
2722
|
EncryptedKeyMaterial: Uint8Array | undefined;
|
|
2695
2723
|
/**
|
|
2696
|
-
* <p>The time at which the imported key material expires. When the key material expires,
|
|
2697
|
-
* deletes the key material and the
|
|
2724
|
+
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
2725
|
+
* deletes the key material and the KMS key becomes unusable. You must omit this parameter when the
|
|
2698
2726
|
* <code>ExpirationModel</code> parameter is set to <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>.
|
|
2699
2727
|
* Otherwise it is required.</p>
|
|
2700
2728
|
*/
|
|
@@ -2723,8 +2751,7 @@ export declare namespace ImportKeyMaterialResponse {
|
|
|
2723
2751
|
}
|
|
2724
2752
|
/**
|
|
2725
2753
|
* <p>The request was rejected because the key material in the request is, expired, invalid, or
|
|
2726
|
-
* is not the same key material that was previously imported into this
|
|
2727
|
-
* (CMK).</p>
|
|
2754
|
+
* is not the same key material that was previously imported into this KMS key.</p>
|
|
2728
2755
|
*/
|
|
2729
2756
|
export interface IncorrectKeyMaterialException extends __SmithyException, $MetadataBearer {
|
|
2730
2757
|
name: "IncorrectKeyMaterialException";
|
|
@@ -2739,7 +2766,7 @@ export declare namespace IncorrectKeyMaterialException {
|
|
|
2739
2766
|
}
|
|
2740
2767
|
/**
|
|
2741
2768
|
* <p>The request was rejected because the provided import token is invalid or is associated
|
|
2742
|
-
* with a different
|
|
2769
|
+
* with a different KMS key.</p>
|
|
2743
2770
|
*/
|
|
2744
2771
|
export interface InvalidImportTokenException extends __SmithyException, $MetadataBearer {
|
|
2745
2772
|
name: "InvalidImportTokenException";
|
|
@@ -2788,7 +2815,7 @@ export declare namespace KeyListEntry {
|
|
|
2788
2815
|
/**
|
|
2789
2816
|
* <p>The request was rejected because the signature verification failed. Signature verification
|
|
2790
2817
|
* fails when it cannot confirm that signature was produced by signing the specified message with
|
|
2791
|
-
* the specified
|
|
2818
|
+
* the specified KMS key and signing algorithm.</p>
|
|
2792
2819
|
*/
|
|
2793
2820
|
export interface KMSInvalidSignatureException extends __SmithyException, $MetadataBearer {
|
|
2794
2821
|
name: "KMSInvalidSignatureException";
|
|
@@ -2803,12 +2830,11 @@ export declare namespace KMSInvalidSignatureException {
|
|
|
2803
2830
|
}
|
|
2804
2831
|
export interface ListAliasesRequest {
|
|
2805
2832
|
/**
|
|
2806
|
-
* <p>Lists only aliases that are associated with the specified
|
|
2807
|
-
* account. </p>
|
|
2833
|
+
* <p>Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account. </p>
|
|
2808
2834
|
* <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases
|
|
2809
2835
|
* in the account and Region.</p>
|
|
2810
2836
|
*
|
|
2811
|
-
* <p>Specify the key ID or key ARN of the
|
|
2837
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2812
2838
|
* <p>For example:</p>
|
|
2813
2839
|
* <ul>
|
|
2814
2840
|
* <li>
|
|
@@ -2820,12 +2846,12 @@ export interface ListAliasesRequest {
|
|
|
2820
2846
|
* </p>
|
|
2821
2847
|
* </li>
|
|
2822
2848
|
* </ul>
|
|
2823
|
-
* <p>To get the key ID and key ARN for a
|
|
2849
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2824
2850
|
*/
|
|
2825
2851
|
KeyId?: string;
|
|
2826
2852
|
/**
|
|
2827
2853
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
2828
|
-
* value is present,
|
|
2854
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
2829
2855
|
* return fewer.</p>
|
|
2830
2856
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
2831
2857
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -2871,7 +2897,7 @@ export declare namespace ListAliasesResponse {
|
|
|
2871
2897
|
export interface ListGrantsRequest {
|
|
2872
2898
|
/**
|
|
2873
2899
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
2874
|
-
* value is present,
|
|
2900
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
2875
2901
|
* return fewer.</p>
|
|
2876
2902
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
2877
2903
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -2884,10 +2910,10 @@ export interface ListGrantsRequest {
|
|
|
2884
2910
|
*/
|
|
2885
2911
|
Marker?: string;
|
|
2886
2912
|
/**
|
|
2887
|
-
* <p>Returns only grants for the specified
|
|
2913
|
+
* <p>Returns only grants for the specified KMS key. This parameter is
|
|
2888
2914
|
* required.</p>
|
|
2889
|
-
* <p>Specify the key ID or key ARN of the
|
|
2890
|
-
* different
|
|
2915
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
2916
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
2891
2917
|
* <p>For example:</p>
|
|
2892
2918
|
* <ul>
|
|
2893
2919
|
* <li>
|
|
@@ -2899,7 +2925,7 @@ export interface ListGrantsRequest {
|
|
|
2899
2925
|
* </p>
|
|
2900
2926
|
* </li>
|
|
2901
2927
|
* </ul>
|
|
2902
|
-
* <p>To get the key ID and key ARN for a
|
|
2928
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2903
2929
|
*/
|
|
2904
2930
|
KeyId: string | undefined;
|
|
2905
2931
|
/**
|
|
@@ -2945,8 +2971,8 @@ export declare namespace ListGrantsResponse {
|
|
|
2945
2971
|
}
|
|
2946
2972
|
export interface ListKeyPoliciesRequest {
|
|
2947
2973
|
/**
|
|
2948
|
-
* <p>Gets the names of key policies for the specified
|
|
2949
|
-
* <p>Specify the key ID or key ARN of the
|
|
2974
|
+
* <p>Gets the names of key policies for the specified KMS key.</p>
|
|
2975
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2950
2976
|
* <p>For example:</p>
|
|
2951
2977
|
* <ul>
|
|
2952
2978
|
* <li>
|
|
@@ -2958,12 +2984,12 @@ export interface ListKeyPoliciesRequest {
|
|
|
2958
2984
|
* </p>
|
|
2959
2985
|
* </li>
|
|
2960
2986
|
* </ul>
|
|
2961
|
-
* <p>To get the key ID and key ARN for a
|
|
2987
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2962
2988
|
*/
|
|
2963
2989
|
KeyId: string | undefined;
|
|
2964
2990
|
/**
|
|
2965
2991
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
2966
|
-
* value is present,
|
|
2992
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
2967
2993
|
* return fewer.</p>
|
|
2968
2994
|
* <p>This value is optional. If you include a value, it must be between
|
|
2969
2995
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
@@ -3010,7 +3036,7 @@ export declare namespace ListKeyPoliciesResponse {
|
|
|
3010
3036
|
export interface ListKeysRequest {
|
|
3011
3037
|
/**
|
|
3012
3038
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3013
|
-
* value is present,
|
|
3039
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3014
3040
|
* return fewer.</p>
|
|
3015
3041
|
* <p>This value is optional. If you include a value, it must be between
|
|
3016
3042
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
@@ -3031,7 +3057,7 @@ export declare namespace ListKeysRequest {
|
|
|
3031
3057
|
}
|
|
3032
3058
|
export interface ListKeysResponse {
|
|
3033
3059
|
/**
|
|
3034
|
-
* <p>A list of
|
|
3060
|
+
* <p>A list of KMS keys.</p>
|
|
3035
3061
|
*/
|
|
3036
3062
|
Keys?: KeyListEntry[];
|
|
3037
3063
|
/**
|
|
@@ -3055,8 +3081,8 @@ export declare namespace ListKeysResponse {
|
|
|
3055
3081
|
}
|
|
3056
3082
|
export interface ListResourceTagsRequest {
|
|
3057
3083
|
/**
|
|
3058
|
-
* <p>Gets tags on the specified
|
|
3059
|
-
* <p>Specify the key ID or key ARN of the
|
|
3084
|
+
* <p>Gets tags on the specified KMS key.</p>
|
|
3085
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3060
3086
|
* <p>For example:</p>
|
|
3061
3087
|
* <ul>
|
|
3062
3088
|
* <li>
|
|
@@ -3068,12 +3094,12 @@ export interface ListResourceTagsRequest {
|
|
|
3068
3094
|
* </p>
|
|
3069
3095
|
* </li>
|
|
3070
3096
|
* </ul>
|
|
3071
|
-
* <p>To get the key ID and key ARN for a
|
|
3097
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3072
3098
|
*/
|
|
3073
3099
|
KeyId: string | undefined;
|
|
3074
3100
|
/**
|
|
3075
3101
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3076
|
-
* value is present,
|
|
3102
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3077
3103
|
* return fewer.</p>
|
|
3078
3104
|
* <p>This value is optional. If you include a value, it must be between 1 and 50, inclusive. If
|
|
3079
3105
|
* you do not include a value, it defaults to 50.</p>
|
|
@@ -3098,8 +3124,7 @@ export interface ListResourceTagsResponse {
|
|
|
3098
3124
|
/**
|
|
3099
3125
|
* <p>A list of tags. Each tag consists of a tag key and a tag value.</p>
|
|
3100
3126
|
* <note>
|
|
3101
|
-
* <p>Tagging or untagging a
|
|
3102
|
-
* CMK. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
3127
|
+
* <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">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3103
3128
|
* </note>
|
|
3104
3129
|
*/
|
|
3105
3130
|
Tags?: Tag[];
|
|
@@ -3126,7 +3151,7 @@ export declare namespace ListResourceTagsResponse {
|
|
|
3126
3151
|
export interface ListRetirableGrantsRequest {
|
|
3127
3152
|
/**
|
|
3128
3153
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3129
|
-
* value is present,
|
|
3154
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3130
3155
|
* return fewer.</p>
|
|
3131
3156
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
3132
3157
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -3139,13 +3164,10 @@ export interface ListRetirableGrantsRequest {
|
|
|
3139
3164
|
*/
|
|
3140
3165
|
Marker?: string;
|
|
3141
3166
|
/**
|
|
3142
|
-
* <p>The retiring principal for which to list grants. Enter a principal in your
|
|
3143
|
-
*
|
|
3144
|
-
*
|
|
3145
|
-
*
|
|
3146
|
-
* assumed role users. For examples of the ARN syntax for specifying a principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">AWS
|
|
3147
|
-
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
3148
|
-
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3167
|
+
* <p>The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.</p>
|
|
3168
|
+
* <p>To specify the retiring principal, use the <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and
|
|
3169
|
+
* assumed role users. For examples of the ARN syntax for specifying a principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">Amazon Web Services Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
3170
|
+
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3149
3171
|
*/
|
|
3150
3172
|
RetiringPrincipal: string | undefined;
|
|
3151
3173
|
}
|
|
@@ -3161,8 +3183,8 @@ export declare enum MessageType {
|
|
|
3161
3183
|
}
|
|
3162
3184
|
export interface PutKeyPolicyRequest {
|
|
3163
3185
|
/**
|
|
3164
|
-
* <p>Sets the key policy on the specified
|
|
3165
|
-
* <p>Specify the key ID or key ARN of the
|
|
3186
|
+
* <p>Sets the key policy on the specified KMS key.</p>
|
|
3187
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3166
3188
|
* <p>For example:</p>
|
|
3167
3189
|
* <ul>
|
|
3168
3190
|
* <li>
|
|
@@ -3174,7 +3196,7 @@ export interface PutKeyPolicyRequest {
|
|
|
3174
3196
|
* </p>
|
|
3175
3197
|
* </li>
|
|
3176
3198
|
* </ul>
|
|
3177
|
-
* <p>To get the key ID and key ARN for a
|
|
3199
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3178
3200
|
*/
|
|
3179
3201
|
KeyId: string | undefined;
|
|
3180
3202
|
/**
|
|
@@ -3182,37 +3204,35 @@ export interface PutKeyPolicyRequest {
|
|
|
3182
3204
|
*/
|
|
3183
3205
|
PolicyName: string | undefined;
|
|
3184
3206
|
/**
|
|
3185
|
-
* <p>The key policy to attach to the
|
|
3207
|
+
* <p>The key policy to attach to the KMS key.</p>
|
|
3186
3208
|
* <p>The key policy must meet the following criteria:</p>
|
|
3187
3209
|
* <ul>
|
|
3188
3210
|
* <li>
|
|
3189
3211
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
3190
3212
|
* must allow the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|
3191
|
-
* subsequent <code>PutKeyPolicy</code> request on the
|
|
3192
|
-
* CMK becomes unmanageable. For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
3213
|
+
* subsequent <code>PutKeyPolicy</code> request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i>Key Management Service Developer Guide</i>.</p>
|
|
3193
3214
|
* </li>
|
|
3194
3215
|
* <li>
|
|
3195
3216
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
3196
|
-
* in the key policy must exist and be visible to
|
|
3217
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
3197
3218
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
3198
3219
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
3199
|
-
* to
|
|
3200
|
-
* Identity and Access Management User Guide</i>.</p>
|
|
3220
|
+
* to KMS. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes that I make are not always immediately visible</a> in the <i>Amazon Web Services Identity and Access Management User Guide</i>.</p>
|
|
3201
3221
|
* </li>
|
|
3202
3222
|
* </ul>
|
|
3203
3223
|
* <p>The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource Quotas</a> in the
|
|
3204
|
-
* <i>
|
|
3224
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3205
3225
|
*/
|
|
3206
3226
|
Policy: string | undefined;
|
|
3207
3227
|
/**
|
|
3208
3228
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
3209
3229
|
* <important>
|
|
3210
|
-
* <p>Setting this value to true increases the risk that the
|
|
3230
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
3211
3231
|
* set this value to true indiscriminately.</p>
|
|
3212
|
-
* <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>
|
|
3232
|
+
* <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3213
3233
|
* </important>
|
|
3214
3234
|
* <p>Use this parameter only when you intend to prevent the principal that is making the
|
|
3215
|
-
* request from making a subsequent <code>PutKeyPolicy</code> request on the
|
|
3235
|
+
* request from making a subsequent <code>PutKeyPolicy</code> request on the KMS key.</p>
|
|
3216
3236
|
* <p>The default value is false.</p>
|
|
3217
3237
|
*/
|
|
3218
3238
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
@@ -3231,24 +3251,24 @@ export interface ReEncryptRequest {
|
|
|
3231
3251
|
/**
|
|
3232
3252
|
* <p>Specifies the encryption context to use to decrypt the ciphertext. Enter the same
|
|
3233
3253
|
* encryption context that was used to encrypt the ciphertext.</p>
|
|
3234
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
3254
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
3235
3255
|
* <p>For more information, see
|
|
3236
3256
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
3237
|
-
* Context</a> in the <i>
|
|
3257
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3238
3258
|
*/
|
|
3239
3259
|
SourceEncryptionContext?: {
|
|
3240
3260
|
[key: string]: string;
|
|
3241
3261
|
};
|
|
3242
3262
|
/**
|
|
3243
|
-
* <p>Specifies the
|
|
3244
|
-
*
|
|
3263
|
+
* <p>Specifies the KMS key that
|
|
3264
|
+
* KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key
|
|
3245
3265
|
* that was used to encrypt the ciphertext.</p>
|
|
3246
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
3247
|
-
* If you used a symmetric
|
|
3266
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
3267
|
+
* If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the
|
|
3248
3268
|
* symmetric ciphertext blob. However, it is always recommended as a best practice. This practice
|
|
3249
|
-
* ensures that you use the
|
|
3269
|
+
* ensures that you use the KMS key that you intend.</p>
|
|
3250
3270
|
*
|
|
3251
|
-
* <p>To specify a
|
|
3271
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
3252
3272
|
* <p>For example:</p>
|
|
3253
3273
|
* <ul>
|
|
3254
3274
|
* <li>
|
|
@@ -3268,15 +3288,15 @@ export interface ReEncryptRequest {
|
|
|
3268
3288
|
* </p>
|
|
3269
3289
|
* </li>
|
|
3270
3290
|
* </ul>
|
|
3271
|
-
* <p>To get the key ID and key ARN for a
|
|
3291
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
3272
3292
|
*/
|
|
3273
3293
|
SourceKeyId?: string;
|
|
3274
3294
|
/**
|
|
3275
|
-
* <p>A unique identifier for the
|
|
3276
|
-
* asymmetric
|
|
3277
|
-
* <code>KeyUsage</code> value of a
|
|
3295
|
+
* <p>A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or
|
|
3296
|
+
* asymmetric KMS key with a <code>KeyUsage</code> value of <code>ENCRYPT_DECRYPT</code>. To find the
|
|
3297
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a>
|
|
3278
3298
|
* operation.</p>
|
|
3279
|
-
* <p>To specify a
|
|
3299
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
3280
3300
|
* <p>For example:</p>
|
|
3281
3301
|
* <ul>
|
|
3282
3302
|
* <li>
|
|
@@ -3296,43 +3316,41 @@ export interface ReEncryptRequest {
|
|
|
3296
3316
|
* </p>
|
|
3297
3317
|
* </li>
|
|
3298
3318
|
* </ul>
|
|
3299
|
-
* <p>To get the key ID and key ARN for a
|
|
3319
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
3300
3320
|
*/
|
|
3301
3321
|
DestinationKeyId: string | undefined;
|
|
3302
3322
|
/**
|
|
3303
3323
|
* <p>Specifies that encryption context to use when the reencrypting the data.</p>
|
|
3304
|
-
* <p>A destination encryption context is valid only when the destination
|
|
3305
|
-
* CMK. The standard ciphertext format for asymmetric CMKs does not include fields for
|
|
3324
|
+
* <p>A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for
|
|
3306
3325
|
* metadata.</p>
|
|
3307
|
-
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric
|
|
3326
|
+
* <p>An <i>encryption context</i> is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.</p>
|
|
3308
3327
|
* <p>For more information, see
|
|
3309
3328
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
3310
|
-
* Context</a> in the <i>
|
|
3329
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3311
3330
|
*/
|
|
3312
3331
|
DestinationEncryptionContext?: {
|
|
3313
3332
|
[key: string]: string;
|
|
3314
3333
|
};
|
|
3315
3334
|
/**
|
|
3316
|
-
* <p>Specifies the encryption algorithm that
|
|
3335
|
+
* <p>Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it
|
|
3317
3336
|
* is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm
|
|
3318
|
-
* used for symmetric
|
|
3337
|
+
* used for symmetric KMS keys.</p>
|
|
3319
3338
|
* <p>Specify the same algorithm that was used to encrypt the ciphertext. If you specify a
|
|
3320
3339
|
* different algorithm, the decrypt attempt fails.</p>
|
|
3321
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
3322
|
-
* CMK.</p>
|
|
3340
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.</p>
|
|
3323
3341
|
*/
|
|
3324
3342
|
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
3325
3343
|
/**
|
|
3326
|
-
* <p>Specifies the encryption algorithm that
|
|
3344
|
+
* <p>Specifies the encryption algorithm that KMS will use to reecrypt the data after it has
|
|
3327
3345
|
* decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption
|
|
3328
|
-
* algorithm used for symmetric
|
|
3329
|
-
* <p>This parameter is required only when the destination
|
|
3346
|
+
* algorithm used for symmetric KMS keys.</p>
|
|
3347
|
+
* <p>This parameter is required only when the destination KMS key is an asymmetric KMS key.</p>
|
|
3330
3348
|
*/
|
|
3331
3349
|
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
3332
3350
|
/**
|
|
3333
3351
|
* <p>A list of grant tokens.</p>
|
|
3334
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3335
|
-
* <i>
|
|
3352
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3353
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3336
3354
|
*/
|
|
3337
3355
|
GrantTokens?: string[];
|
|
3338
3356
|
}
|
|
@@ -3344,15 +3362,15 @@ export declare namespace ReEncryptRequest {
|
|
|
3344
3362
|
}
|
|
3345
3363
|
export interface ReEncryptResponse {
|
|
3346
3364
|
/**
|
|
3347
|
-
* <p>The reencrypted data. When you use the HTTP API or the
|
|
3365
|
+
* <p>The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
3348
3366
|
*/
|
|
3349
3367
|
CiphertextBlob?: Uint8Array;
|
|
3350
3368
|
/**
|
|
3351
|
-
* <p>Unique identifier of the
|
|
3369
|
+
* <p>Unique identifier of the KMS key used to originally encrypt the data.</p>
|
|
3352
3370
|
*/
|
|
3353
3371
|
SourceKeyId?: string;
|
|
3354
3372
|
/**
|
|
3355
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
3373
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key that was used to reencrypt the data.</p>
|
|
3356
3374
|
*/
|
|
3357
3375
|
KeyId?: string;
|
|
3358
3376
|
/**
|
|
@@ -3373,8 +3391,7 @@ export declare namespace ReEncryptResponse {
|
|
|
3373
3391
|
}
|
|
3374
3392
|
export interface ReplicateKeyRequest {
|
|
3375
3393
|
/**
|
|
3376
|
-
* <p>Identifies the multi-Region primary key that is being replicated. To determine whether a
|
|
3377
|
-
* CMK is a multi-Region primary key, use the <a>DescribeKey</a> operation to check
|
|
3394
|
+
* <p>Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the <a>DescribeKey</a> operation to check
|
|
3378
3395
|
* the value of the <code>MultiRegionKeyType</code> property.</p>
|
|
3379
3396
|
*
|
|
3380
3397
|
* <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
|
|
@@ -3389,46 +3406,47 @@ export interface ReplicateKeyRequest {
|
|
|
3389
3406
|
* </p>
|
|
3390
3407
|
* </li>
|
|
3391
3408
|
* </ul>
|
|
3392
|
-
* <p>To get the key ID and key ARN for a
|
|
3409
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3393
3410
|
*/
|
|
3394
3411
|
KeyId: string | undefined;
|
|
3395
3412
|
/**
|
|
3396
|
-
* <p>The Region ID of the
|
|
3413
|
+
* <p>The Region ID of the Amazon Web Services Region for this replica key. </p>
|
|
3397
3414
|
* <p>Enter the Region ID, such as <code>us-east-1</code> or <code>ap-southeast-2</code>. For a
|
|
3398
|
-
* list of
|
|
3415
|
+
* list of Amazon Web Services Regions in which KMS is supported, see <a href="https://docs.aws.amazon.com/general/latest/gr/kms.html#kms_region">KMS service endpoints</a> in the
|
|
3399
3416
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3400
|
-
* <p>The replica must be in a different
|
|
3401
|
-
* that primary key, but in the same
|
|
3402
|
-
* Region. If the Region is not enabled by default, the
|
|
3417
|
+
* <p>The replica must be in a different Amazon Web Services Region than its primary key and other replicas of
|
|
3418
|
+
* that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica
|
|
3419
|
+
* Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the
|
|
3403
3420
|
* Region. </p>
|
|
3404
|
-
* <p>For information about
|
|
3421
|
+
* <p>For information about Amazon Web Services partitions, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) in the
|
|
3405
3422
|
* <i>Amazon Web Services General Reference</i>.</a> For information about enabling and disabling Regions, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable">Enabling a
|
|
3406
3423
|
* Region</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-disable">Disabling a Region</a> in the
|
|
3407
3424
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3408
3425
|
*/
|
|
3409
3426
|
ReplicaRegion: string | undefined;
|
|
3410
3427
|
/**
|
|
3411
|
-
* <p>The key policy to attach to the
|
|
3428
|
+
* <p>The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default">default key policy</a> to the KMS key.</p>
|
|
3412
3429
|
* <p>The key policy is not a shared property of multi-Region keys. You can specify the same key
|
|
3413
|
-
* policy or a different key policy for each key in a set of related multi-Region keys.
|
|
3430
|
+
* policy or a different key policy for each key in a set of related multi-Region keys. KMS
|
|
3414
3431
|
* does not synchronize this property.</p>
|
|
3415
3432
|
* <p>If you provide a key policy, it must meet the following criteria:</p>
|
|
3416
3433
|
* <ul>
|
|
3417
3434
|
* <li>
|
|
3418
3435
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
3419
|
-
* must give the caller <code>kms:PutKeyPolicy</code> permission on the replica
|
|
3420
|
-
* risk that the
|
|
3436
|
+
* must give the caller <code>kms:PutKeyPolicy</code> permission on the replica key. This reduces the
|
|
3437
|
+
* risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the
|
|
3421
3438
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section of the <i>
|
|
3422
|
-
* <i>
|
|
3439
|
+
* <i>Key Management Service Developer Guide</i>
|
|
3423
3440
|
* </i>.</p>
|
|
3424
3441
|
* </li>
|
|
3425
3442
|
* <li>
|
|
3426
3443
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
3427
|
-
* in the key policy must exist and be visible to
|
|
3444
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
3428
3445
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
3429
3446
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
3430
|
-
* to
|
|
3431
|
-
*
|
|
3447
|
+
* to KMS. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes that I make are not always immediately visible</a> in the <i>
|
|
3448
|
+
* <i>Identity and Access Management User Guide</i>
|
|
3449
|
+
* </i>.</p>
|
|
3432
3450
|
* </li>
|
|
3433
3451
|
* <li>
|
|
3434
3452
|
* <p>The key policy size quota is 32 kilobytes (32768 bytes).</p>
|
|
@@ -3439,40 +3457,37 @@ export interface ReplicateKeyRequest {
|
|
|
3439
3457
|
/**
|
|
3440
3458
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
3441
3459
|
* <important>
|
|
3442
|
-
* <p>Setting this value to true increases the risk that the
|
|
3460
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
3443
3461
|
* set this value to true indiscriminately.</p>
|
|
3444
|
-
* <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>
|
|
3462
|
+
* <p>For more information, refer to the scenario in the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default Key Policy</a> section in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3445
3463
|
* </important>
|
|
3446
3464
|
* <p>Use this parameter only when you intend to prevent the principal that is making the
|
|
3447
|
-
* request from making a subsequent <code>PutKeyPolicy</code> request on the
|
|
3465
|
+
* request from making a subsequent <code>PutKeyPolicy</code> request on the KMS key.</p>
|
|
3448
3466
|
* <p>The default value is false.</p>
|
|
3449
3467
|
*/
|
|
3450
3468
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
3451
3469
|
/**
|
|
3452
|
-
* <p>A description of the
|
|
3453
|
-
* appropriate for a task. The default value is an empty string (no description).</p>
|
|
3470
|
+
* <p>A description of the KMS key. The default value is an empty string (no description).</p>
|
|
3454
3471
|
* <p>The description is not a shared property of multi-Region keys. You can specify the same
|
|
3455
|
-
* description or a different description for each key in a set of related multi-Region keys.
|
|
3456
|
-
* KMS does not synchronize this property.</p>
|
|
3472
|
+
* description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.</p>
|
|
3457
3473
|
*/
|
|
3458
3474
|
Description?: string;
|
|
3459
3475
|
/**
|
|
3460
|
-
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the
|
|
3461
|
-
* To tag an existing
|
|
3476
|
+
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created.
|
|
3477
|
+
* To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
3462
3478
|
* <note>
|
|
3463
|
-
* <p>Tagging or untagging a
|
|
3464
|
-
* CMK. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in AWS KMS</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
3479
|
+
* <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">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3465
3480
|
* </note>
|
|
3466
3481
|
* <p>To use this parameter, you must have <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> permission in an IAM policy.</p>
|
|
3467
3482
|
* <p>Tags are not a shared property of multi-Region keys. You can specify the same tags or
|
|
3468
|
-
* different tags for each key in a set of related multi-Region keys.
|
|
3483
|
+
* different tags for each key in a set of related multi-Region keys. KMS does not
|
|
3469
3484
|
* synchronize this property.</p>
|
|
3470
3485
|
* <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
|
|
3471
3486
|
* required, but the tag value can be an empty (null) string. You cannot have more than one tag
|
|
3472
|
-
* on a
|
|
3473
|
-
*
|
|
3474
|
-
* <p>When you
|
|
3475
|
-
* report with usage and costs aggregated by tags. Tags can also be used to control access to a
|
|
3487
|
+
* on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,
|
|
3488
|
+
* KMS replaces the current tag value with the specified one.</p>
|
|
3489
|
+
* <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
|
|
3490
|
+
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
|
|
3476
3491
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
3477
3492
|
*/
|
|
3478
3493
|
Tags?: Tag[];
|
|
@@ -3485,8 +3500,8 @@ export declare namespace ReplicateKeyRequest {
|
|
|
3485
3500
|
}
|
|
3486
3501
|
export interface ReplicateKeyResponse {
|
|
3487
3502
|
/**
|
|
3488
|
-
* <p>Displays details about the new replica
|
|
3489
|
-
* ARN</a>) and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key state</a>. It also includes the ARN and
|
|
3503
|
+
* <p>Displays details about the new replica key, including its Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key
|
|
3504
|
+
* ARN</a>) and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key state</a>. It also includes the ARN and Amazon Web Services Region of its primary key and other
|
|
3490
3505
|
* replica keys.</p>
|
|
3491
3506
|
*/
|
|
3492
3507
|
ReplicaKeyMetadata?: KeyMetadata;
|
|
@@ -3512,19 +3527,19 @@ export interface RetireGrantRequest {
|
|
|
3512
3527
|
* <p>Identifies the grant to be retired. You can use a grant token to identify a new grant even
|
|
3513
3528
|
* before it has achieved eventual consistency.</p>
|
|
3514
3529
|
* <p>Only the <a>CreateGrant</a> operation returns a grant token. For details, see
|
|
3515
|
-
*
|
|
3516
|
-
* and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in the <i>
|
|
3530
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a>
|
|
3531
|
+
* and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3517
3532
|
*/
|
|
3518
3533
|
GrantToken?: string;
|
|
3519
3534
|
/**
|
|
3520
|
-
* <p>The key ARN
|
|
3535
|
+
* <p>The key ARN KMS key associated with the grant. To find the key ARN, use the <a>ListKeys</a> operation.</p>
|
|
3521
3536
|
* <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
3522
3537
|
* </p>
|
|
3523
3538
|
*/
|
|
3524
3539
|
KeyId?: string;
|
|
3525
3540
|
/**
|
|
3526
3541
|
* <p>Identifies the grant to retire. To get the grant ID, use <a>CreateGrant</a>,
|
|
3527
|
-
*
|
|
3542
|
+
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
3528
3543
|
* <ul>
|
|
3529
3544
|
* <li>
|
|
3530
3545
|
* <p>Grant ID Example -
|
|
@@ -3542,11 +3557,11 @@ export declare namespace RetireGrantRequest {
|
|
|
3542
3557
|
}
|
|
3543
3558
|
export interface RevokeGrantRequest {
|
|
3544
3559
|
/**
|
|
3545
|
-
* <p>A unique identifier for the
|
|
3546
|
-
* the key ID and key ARN for a
|
|
3560
|
+
* <p>A unique identifier for the KMS key associated with the grant. To get
|
|
3561
|
+
* the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3547
3562
|
*
|
|
3548
|
-
* <p>Specify the key ID or key ARN of the
|
|
3549
|
-
* different
|
|
3563
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
3564
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
3550
3565
|
* <p>For example:</p>
|
|
3551
3566
|
* <ul>
|
|
3552
3567
|
* <li>
|
|
@@ -3558,12 +3573,12 @@ export interface RevokeGrantRequest {
|
|
|
3558
3573
|
* </p>
|
|
3559
3574
|
* </li>
|
|
3560
3575
|
* </ul>
|
|
3561
|
-
* <p>To get the key ID and key ARN for a
|
|
3576
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3562
3577
|
*/
|
|
3563
3578
|
KeyId: string | undefined;
|
|
3564
3579
|
/**
|
|
3565
3580
|
* <p>Identifies the grant to revoke. To get the grant ID, use <a>CreateGrant</a>,
|
|
3566
|
-
*
|
|
3581
|
+
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
3567
3582
|
*/
|
|
3568
3583
|
GrantId: string | undefined;
|
|
3569
3584
|
}
|
|
@@ -3575,9 +3590,9 @@ export declare namespace RevokeGrantRequest {
|
|
|
3575
3590
|
}
|
|
3576
3591
|
export interface ScheduleKeyDeletionRequest {
|
|
3577
3592
|
/**
|
|
3578
|
-
* <p>The unique identifier of the
|
|
3593
|
+
* <p>The unique identifier of the KMS key to delete.</p>
|
|
3579
3594
|
*
|
|
3580
|
-
* <p>Specify the key ID or key ARN of the
|
|
3595
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3581
3596
|
* <p>For example:</p>
|
|
3582
3597
|
* <ul>
|
|
3583
3598
|
* <li>
|
|
@@ -3589,13 +3604,13 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
3589
3604
|
* </p>
|
|
3590
3605
|
* </li>
|
|
3591
3606
|
* </ul>
|
|
3592
|
-
* <p>To get the key ID and key ARN for a
|
|
3607
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3593
3608
|
*/
|
|
3594
3609
|
KeyId: string | undefined;
|
|
3595
3610
|
/**
|
|
3596
|
-
* <p>The waiting period, specified in number of days. After the waiting period ends,
|
|
3597
|
-
* deletes the
|
|
3598
|
-
* <p>If the
|
|
3611
|
+
* <p>The waiting period, specified in number of days. After the waiting period ends, KMS
|
|
3612
|
+
* deletes the KMS key.</p>
|
|
3613
|
+
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the
|
|
3599
3614
|
* last of its replica keys is deleted. Otherwise, the waiting period begins immediately.</p>
|
|
3600
3615
|
* <p>This value is optional. If you include a value, it must be between 7 and 30, inclusive. If
|
|
3601
3616
|
* you do not include a value, it defaults to 30.</p>
|
|
@@ -3610,25 +3625,25 @@ export declare namespace ScheduleKeyDeletionRequest {
|
|
|
3610
3625
|
}
|
|
3611
3626
|
export interface ScheduleKeyDeletionResponse {
|
|
3612
3627
|
/**
|
|
3613
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the
|
|
3628
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the KMS key whose deletion is scheduled.</p>
|
|
3614
3629
|
*/
|
|
3615
3630
|
KeyId?: string;
|
|
3616
3631
|
/**
|
|
3617
|
-
* <p>The date and time after which
|
|
3618
|
-
* <p>If the
|
|
3632
|
+
* <p>The date and time after which KMS deletes the KMS key.</p>
|
|
3633
|
+
* <p>If the KMS key is a multi-Region primary key with replica keys, this field does not appear.
|
|
3619
3634
|
* The deletion date for the primary key isn't known until its last replica key is
|
|
3620
3635
|
* deleted.</p>
|
|
3621
3636
|
*/
|
|
3622
3637
|
DeletionDate?: Date;
|
|
3623
3638
|
/**
|
|
3624
|
-
* <p>The current status of the
|
|
3625
|
-
* <p>For more information about how key state affects the use of a
|
|
3626
|
-
* in the <i>
|
|
3639
|
+
* <p>The current status of the KMS key.</p>
|
|
3640
|
+
* <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a>
|
|
3641
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3627
3642
|
*/
|
|
3628
3643
|
KeyState?: KeyState | string;
|
|
3629
3644
|
/**
|
|
3630
|
-
* <p>The waiting period before the
|
|
3631
|
-
* <p>If the
|
|
3645
|
+
* <p>The waiting period before the KMS key is deleted. </p>
|
|
3646
|
+
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the
|
|
3632
3647
|
* last of its replica keys is deleted. Otherwise, the waiting period begins immediately.</p>
|
|
3633
3648
|
*/
|
|
3634
3649
|
PendingWindowInDays?: number;
|
|
@@ -3641,11 +3656,11 @@ export declare namespace ScheduleKeyDeletionResponse {
|
|
|
3641
3656
|
}
|
|
3642
3657
|
export interface SignRequest {
|
|
3643
3658
|
/**
|
|
3644
|
-
* <p>Identifies an asymmetric
|
|
3645
|
-
* message. The <code>KeyUsage</code> type of the
|
|
3646
|
-
* the <code>KeyUsage</code> of a
|
|
3659
|
+
* <p>Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the
|
|
3660
|
+
* message. The <code>KeyUsage</code> type of the KMS key must be <code>SIGN_VERIFY</code>. To find
|
|
3661
|
+
* the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
3647
3662
|
*
|
|
3648
|
-
* <p>To specify a
|
|
3663
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
3649
3664
|
* <p>For example:</p>
|
|
3650
3665
|
* <ul>
|
|
3651
3666
|
* <li>
|
|
@@ -3665,32 +3680,31 @@ export interface SignRequest {
|
|
|
3665
3680
|
* </p>
|
|
3666
3681
|
* </li>
|
|
3667
3682
|
* </ul>
|
|
3668
|
-
* <p>To get the key ID and key ARN for a
|
|
3683
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
3669
3684
|
*/
|
|
3670
3685
|
KeyId: string | undefined;
|
|
3671
3686
|
/**
|
|
3672
3687
|
* <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a
|
|
3673
3688
|
* larger message, provide the message digest.</p>
|
|
3674
|
-
* <p>If you provide a message,
|
|
3689
|
+
* <p>If you provide a message, KMS generates a hash digest of the message and then signs
|
|
3675
3690
|
* it.</p>
|
|
3676
3691
|
*/
|
|
3677
3692
|
Message: Uint8Array | undefined;
|
|
3678
3693
|
/**
|
|
3679
|
-
* <p>Tells
|
|
3694
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter is a message or
|
|
3680
3695
|
* message digest. The default value, RAW, indicates a message. To indicate a message digest,
|
|
3681
3696
|
* enter <code>DIGEST</code>.</p>
|
|
3682
3697
|
*/
|
|
3683
3698
|
MessageType?: MessageType | string;
|
|
3684
3699
|
/**
|
|
3685
3700
|
* <p>A list of grant tokens.</p>
|
|
3686
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
3687
|
-
* <i>
|
|
3701
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
3702
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3688
3703
|
*/
|
|
3689
3704
|
GrantTokens?: string[];
|
|
3690
3705
|
/**
|
|
3691
3706
|
* <p>Specifies the signing algorithm to use when signing the message. </p>
|
|
3692
|
-
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
|
|
3693
|
-
* CMK.</p>
|
|
3707
|
+
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.</p>
|
|
3694
3708
|
*/
|
|
3695
3709
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
3696
3710
|
}
|
|
@@ -3702,7 +3716,7 @@ export declare namespace SignRequest {
|
|
|
3702
3716
|
}
|
|
3703
3717
|
export interface SignResponse {
|
|
3704
3718
|
/**
|
|
3705
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric
|
|
3719
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to sign the message.</p>
|
|
3706
3720
|
*/
|
|
3707
3721
|
KeyId?: string;
|
|
3708
3722
|
/**
|
|
@@ -3721,7 +3735,7 @@ export interface SignResponse {
|
|
|
3721
3735
|
* </p>
|
|
3722
3736
|
* </li>
|
|
3723
3737
|
* </ul>
|
|
3724
|
-
* <p>When you use the HTTP API or the
|
|
3738
|
+
* <p>When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
|
|
3725
3739
|
*/
|
|
3726
3740
|
Signature?: Uint8Array;
|
|
3727
3741
|
/**
|
|
@@ -3737,9 +3751,9 @@ export declare namespace SignResponse {
|
|
|
3737
3751
|
}
|
|
3738
3752
|
export interface TagResourceRequest {
|
|
3739
3753
|
/**
|
|
3740
|
-
* <p>Identifies a customer managed
|
|
3754
|
+
* <p>Identifies a customer managed key in the account and Region.</p>
|
|
3741
3755
|
*
|
|
3742
|
-
* <p>Specify the key ID or key ARN of the
|
|
3756
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3743
3757
|
* <p>For example:</p>
|
|
3744
3758
|
* <ul>
|
|
3745
3759
|
* <li>
|
|
@@ -3751,15 +3765,15 @@ export interface TagResourceRequest {
|
|
|
3751
3765
|
* </p>
|
|
3752
3766
|
* </li>
|
|
3753
3767
|
* </ul>
|
|
3754
|
-
* <p>To get the key ID and key ARN for a
|
|
3768
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3755
3769
|
*/
|
|
3756
3770
|
KeyId: string | undefined;
|
|
3757
3771
|
/**
|
|
3758
3772
|
* <p>One or more tags. </p>
|
|
3759
3773
|
* <p>Each tag consists of a tag key and a tag value. The tag value can be an empty (null)
|
|
3760
3774
|
* string. </p>
|
|
3761
|
-
* <p>You cannot have more than one tag on a
|
|
3762
|
-
* existing tag key with a different tag value,
|
|
3775
|
+
* <p>You cannot have more than one tag on a KMS key with the same tag key. If you specify an
|
|
3776
|
+
* existing tag key with a different tag value, KMS replaces the current tag value with the
|
|
3763
3777
|
* specified one.</p>
|
|
3764
3778
|
*/
|
|
3765
3779
|
Tags: Tag[] | undefined;
|
|
@@ -3772,9 +3786,9 @@ export declare namespace TagResourceRequest {
|
|
|
3772
3786
|
}
|
|
3773
3787
|
export interface UntagResourceRequest {
|
|
3774
3788
|
/**
|
|
3775
|
-
* <p>Identifies the
|
|
3789
|
+
* <p>Identifies the KMS key from which you are removing tags.</p>
|
|
3776
3790
|
*
|
|
3777
|
-
* <p>Specify the key ID or key ARN of the
|
|
3791
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3778
3792
|
* <p>For example:</p>
|
|
3779
3793
|
* <ul>
|
|
3780
3794
|
* <li>
|
|
@@ -3786,7 +3800,7 @@ export interface UntagResourceRequest {
|
|
|
3786
3800
|
* </p>
|
|
3787
3801
|
* </li>
|
|
3788
3802
|
* </ul>
|
|
3789
|
-
* <p>To get the key ID and key ARN for a
|
|
3803
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3790
3804
|
*/
|
|
3791
3805
|
KeyId: string | undefined;
|
|
3792
3806
|
/**
|
|
@@ -3802,18 +3816,18 @@ export declare namespace UntagResourceRequest {
|
|
|
3802
3816
|
}
|
|
3803
3817
|
export interface UpdateAliasRequest {
|
|
3804
3818
|
/**
|
|
3805
|
-
* <p>Identifies the alias that is changing its
|
|
3819
|
+
* <p>Identifies the alias that is changing its KMS key. This value must begin with
|
|
3806
3820
|
* <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You
|
|
3807
3821
|
* cannot use UpdateAlias to change the alias name.</p>
|
|
3808
3822
|
*/
|
|
3809
3823
|
AliasName: string | undefined;
|
|
3810
3824
|
/**
|
|
3811
|
-
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
3812
|
-
* associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
3813
|
-
* <p>The
|
|
3814
|
-
* must be the same type as the current target
|
|
3825
|
+
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> to associate with the alias. You don't have permission
|
|
3826
|
+
* to associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
|
|
3827
|
+
* <p>The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key
|
|
3828
|
+
* must be the same type as the current target KMS key (both symmetric or both asymmetric) and they
|
|
3815
3829
|
* must have the same key usage. </p>
|
|
3816
|
-
* <p>Specify the key ID or key ARN of the
|
|
3830
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3817
3831
|
* <p>For example:</p>
|
|
3818
3832
|
* <ul>
|
|
3819
3833
|
* <li>
|
|
@@ -3825,9 +3839,9 @@ export interface UpdateAliasRequest {
|
|
|
3825
3839
|
* </p>
|
|
3826
3840
|
* </li>
|
|
3827
3841
|
* </ul>
|
|
3828
|
-
* <p>To get the key ID and key ARN for a
|
|
3842
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3829
3843
|
* <p>To verify that the alias
|
|
3830
|
-
* is mapped to the correct
|
|
3844
|
+
* is mapped to the correct KMS key, use <a>ListAliases</a>.</p>
|
|
3831
3845
|
*/
|
|
3832
3846
|
TargetKeyId: string | undefined;
|
|
3833
3847
|
}
|
|
@@ -3845,18 +3859,18 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
3845
3859
|
CustomKeyStoreId: string | undefined;
|
|
3846
3860
|
/**
|
|
3847
3861
|
* <p>Changes the friendly name of the custom key store to the value that you specify. The
|
|
3848
|
-
* custom key store name must be unique in the
|
|
3862
|
+
* custom key store name must be unique in the Amazon Web Services account.</p>
|
|
3849
3863
|
*/
|
|
3850
3864
|
NewCustomKeyStoreName?: string;
|
|
3851
3865
|
/**
|
|
3852
|
-
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the
|
|
3866
|
+
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the CloudHSM
|
|
3853
3867
|
* cluster that is associated with the custom key store.</p>
|
|
3854
|
-
* <p>This parameter tells
|
|
3855
|
-
* (CU). It does not set or change the password of any users in the
|
|
3868
|
+
* <p>This parameter tells KMS the current password of the <code>kmsuser</code> crypto user
|
|
3869
|
+
* (CU). It does not set or change the password of any users in the CloudHSM cluster.</p>
|
|
3856
3870
|
*/
|
|
3857
3871
|
KeyStorePassword?: string;
|
|
3858
3872
|
/**
|
|
3859
|
-
* <p>Associates the custom key store with a related
|
|
3873
|
+
* <p>Associates the custom key store with a related CloudHSM cluster. </p>
|
|
3860
3874
|
* <p>Enter the cluster ID of the cluster that you used to create the custom key store or a
|
|
3861
3875
|
* cluster that shares a backup history and has the same cluster certificate as the original
|
|
3862
3876
|
* cluster. You cannot use this parameter to associate a custom key store with an unrelated
|
|
@@ -3882,8 +3896,8 @@ export declare namespace UpdateCustomKeyStoreResponse {
|
|
|
3882
3896
|
}
|
|
3883
3897
|
export interface UpdateKeyDescriptionRequest {
|
|
3884
3898
|
/**
|
|
3885
|
-
* <p>Updates the description of the specified
|
|
3886
|
-
* <p>Specify the key ID or key ARN of the
|
|
3899
|
+
* <p>Updates the description of the specified KMS key.</p>
|
|
3900
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3887
3901
|
* <p>For example:</p>
|
|
3888
3902
|
* <ul>
|
|
3889
3903
|
* <li>
|
|
@@ -3895,11 +3909,11 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
3895
3909
|
* </p>
|
|
3896
3910
|
* </li>
|
|
3897
3911
|
* </ul>
|
|
3898
|
-
* <p>To get the key ID and key ARN for a
|
|
3912
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3899
3913
|
*/
|
|
3900
3914
|
KeyId: string | undefined;
|
|
3901
3915
|
/**
|
|
3902
|
-
* <p>New description for the
|
|
3916
|
+
* <p>New description for the KMS key.</p>
|
|
3903
3917
|
*/
|
|
3904
3918
|
Description: string | undefined;
|
|
3905
3919
|
}
|
|
@@ -3911,7 +3925,7 @@ export declare namespace UpdateKeyDescriptionRequest {
|
|
|
3911
3925
|
}
|
|
3912
3926
|
export interface UpdatePrimaryRegionRequest {
|
|
3913
3927
|
/**
|
|
3914
|
-
* <p>Identifies the current primary key. When the operation completes, this
|
|
3928
|
+
* <p>Identifies the current primary key. When the operation completes, this KMS key will be a
|
|
3915
3929
|
* replica key.</p>
|
|
3916
3930
|
*
|
|
3917
3931
|
* <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
|
|
@@ -3926,11 +3940,11 @@ export interface UpdatePrimaryRegionRequest {
|
|
|
3926
3940
|
* </p>
|
|
3927
3941
|
* </li>
|
|
3928
3942
|
* </ul>
|
|
3929
|
-
* <p>To get the key ID and key ARN for a
|
|
3943
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3930
3944
|
*/
|
|
3931
3945
|
KeyId: string | undefined;
|
|
3932
3946
|
/**
|
|
3933
|
-
* <p>The
|
|
3947
|
+
* <p>The Amazon Web Services Region of the new primary key. Enter the Region ID, such as <code>us-east-1</code>
|
|
3934
3948
|
* or <code>ap-southeast-2</code>. There must be an existing replica key in this Region. </p>
|
|
3935
3949
|
* <p>When the operation completes, the multi-Region key in this Region will be the primary
|
|
3936
3950
|
* key.</p>
|
|
@@ -3945,10 +3959,10 @@ export declare namespace UpdatePrimaryRegionRequest {
|
|
|
3945
3959
|
}
|
|
3946
3960
|
export interface VerifyRequest {
|
|
3947
3961
|
/**
|
|
3948
|
-
* <p>Identifies the asymmetric
|
|
3949
|
-
* same
|
|
3962
|
+
* <p>Identifies the asymmetric KMS key that will be used to verify the signature. This must be the
|
|
3963
|
+
* same KMS key that was used to generate the signature. If you specify a different KMS key, the
|
|
3950
3964
|
* signature verification fails.</p>
|
|
3951
|
-
* <p>To specify a
|
|
3965
|
+
* <p>To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with <code>"alias/"</code>. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.</p>
|
|
3952
3966
|
* <p>For example:</p>
|
|
3953
3967
|
* <ul>
|
|
3954
3968
|
* <li>
|
|
@@ -3968,7 +3982,7 @@ export interface VerifyRequest {
|
|
|
3968
3982
|
* </p>
|
|
3969
3983
|
* </li>
|
|
3970
3984
|
* </ul>
|
|
3971
|
-
* <p>To get the key ID and key ARN for a
|
|
3985
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>. To get the alias name and alias ARN, use <a>ListAliases</a>.</p>
|
|
3972
3986
|
*/
|
|
3973
3987
|
KeyId: string | undefined;
|
|
3974
3988
|
/**
|
|
@@ -3981,7 +3995,7 @@ export interface VerifyRequest {
|
|
|
3981
3995
|
*/
|
|
3982
3996
|
Message: Uint8Array | undefined;
|
|
3983
3997
|
/**
|
|
3984
|
-
* <p>Tells
|
|
3998
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter is a message or
|
|
3985
3999
|
* message digest. The default value, RAW, indicates a message. To indicate a message digest,
|
|
3986
4000
|
* enter <code>DIGEST</code>.</p>
|
|
3987
4001
|
* <important>
|
|
@@ -4002,8 +4016,8 @@ export interface VerifyRequest {
|
|
|
4002
4016
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
4003
4017
|
/**
|
|
4004
4018
|
* <p>A list of grant tokens.</p>
|
|
4005
|
-
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/
|
|
4006
|
-
* <i>
|
|
4019
|
+
* <p>Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved <i>eventual consistency</i>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant token</a> in the
|
|
4020
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4007
4021
|
*/
|
|
4008
4022
|
GrantTokens?: string[];
|
|
4009
4023
|
}
|
|
@@ -4015,7 +4029,7 @@ export declare namespace VerifyRequest {
|
|
|
4015
4029
|
}
|
|
4016
4030
|
export interface VerifyResponse {
|
|
4017
4031
|
/**
|
|
4018
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric
|
|
4032
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN">key ARN</a>) of the asymmetric KMS key that was used to verify the signature.</p>
|
|
4019
4033
|
*/
|
|
4020
4034
|
KeyId?: string;
|
|
4021
4035
|
/**
|