@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
package/models/models_0.ts
CHANGED
|
@@ -22,7 +22,7 @@ export interface AliasListEntry {
|
|
|
22
22
|
AliasArn?: string;
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* <p>String that contains the key identifier of the
|
|
25
|
+
* <p>String that contains the key identifier of the KMS key associated with the alias.</p>
|
|
26
26
|
*/
|
|
27
27
|
TargetKeyId?: string;
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ export interface AliasListEntry {
|
|
|
32
32
|
CreationDate?: Date;
|
|
33
33
|
|
|
34
34
|
/**
|
|
35
|
-
* <p>Date and time that the alias was most recently associated with a
|
|
35
|
+
* <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>
|
|
36
36
|
*/
|
|
37
37
|
LastUpdatedDate?: Date;
|
|
38
38
|
}
|
|
@@ -67,8 +67,8 @@ export namespace AlreadyExistsException {
|
|
|
67
67
|
|
|
68
68
|
export interface CancelKeyDeletionRequest {
|
|
69
69
|
/**
|
|
70
|
-
* <p>Identifies the
|
|
71
|
-
* <p>Specify the key ID or key ARN of the
|
|
70
|
+
* <p>Identifies the KMS key whose deletion is being canceled.</p>
|
|
71
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
72
72
|
* <p>For example:</p>
|
|
73
73
|
* <ul>
|
|
74
74
|
* <li>
|
|
@@ -80,7 +80,7 @@ export interface CancelKeyDeletionRequest {
|
|
|
80
80
|
* </p>
|
|
81
81
|
* </li>
|
|
82
82
|
* </ul>
|
|
83
|
-
* <p>To get the key ID and key ARN for a
|
|
83
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
84
84
|
*/
|
|
85
85
|
KeyId: string | undefined;
|
|
86
86
|
}
|
|
@@ -96,7 +96,7 @@ export namespace CancelKeyDeletionRequest {
|
|
|
96
96
|
|
|
97
97
|
export interface CancelKeyDeletionResponse {
|
|
98
98
|
/**
|
|
99
|
-
* <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
|
|
99
|
+
* <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>
|
|
100
100
|
*/
|
|
101
101
|
KeyId?: string;
|
|
102
102
|
}
|
|
@@ -170,9 +170,8 @@ export namespace KMSInternalException {
|
|
|
170
170
|
/**
|
|
171
171
|
* <p>The request was rejected because the state of the specified resource is not valid for this
|
|
172
172
|
* request.</p>
|
|
173
|
-
* <p>For more information about how key state affects the use of a
|
|
174
|
-
*
|
|
175
|
-
* <i>AWS Key Management Service Developer Guide</i>
|
|
173
|
+
* <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>
|
|
174
|
+
* <i>Key Management Service Developer Guide</i>
|
|
176
175
|
* </i>.</p>
|
|
177
176
|
*/
|
|
178
177
|
export interface KMSInvalidStateException extends __SmithyException, $MetadataBearer {
|
|
@@ -210,9 +209,9 @@ export namespace NotFoundException {
|
|
|
210
209
|
}
|
|
211
210
|
|
|
212
211
|
/**
|
|
213
|
-
* <p>The request was rejected because the specified
|
|
212
|
+
* <p>The request was rejected because the specified CloudHSM cluster is already associated with a
|
|
214
213
|
* custom key store or it shares a backup history with a cluster that is associated with a custom
|
|
215
|
-
* key store. Each custom key store must be associated with a different
|
|
214
|
+
* key store. Each custom key store must be associated with a different CloudHSM cluster.</p>
|
|
216
215
|
* <p>Clusters that share a backup history have the same cluster certificate. To view the
|
|
217
216
|
* cluster certificate of a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
|
|
218
217
|
*/
|
|
@@ -232,7 +231,7 @@ export namespace CloudHsmClusterInUseException {
|
|
|
232
231
|
}
|
|
233
232
|
|
|
234
233
|
/**
|
|
235
|
-
* <p>The request was rejected because the associated
|
|
234
|
+
* <p>The request was rejected because the associated CloudHSM cluster did not meet the
|
|
236
235
|
* configuration requirements for a custom key store.</p>
|
|
237
236
|
*
|
|
238
237
|
* <ul>
|
|
@@ -250,20 +249,20 @@ export namespace CloudHsmClusterInUseException {
|
|
|
250
249
|
* </li>
|
|
251
250
|
* <li>
|
|
252
251
|
* <p>The cluster must contain at least as many HSMs as the operation requires. To add HSMs,
|
|
253
|
-
* use the
|
|
254
|
-
* <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the
|
|
255
|
-
* active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the
|
|
252
|
+
* use the CloudHSM <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation.</p>
|
|
253
|
+
* <p>For the <a>CreateCustomKeyStore</a>, <a>UpdateCustomKeyStore</a>, and <a>CreateKey</a> operations, the CloudHSM cluster must have at least two
|
|
254
|
+
* active HSMs, each in a different Availability Zone. For the <a>ConnectCustomKeyStore</a> operation, the CloudHSM must contain at least one active
|
|
256
255
|
* HSM.</p>
|
|
257
256
|
* </li>
|
|
258
257
|
* </ul>
|
|
259
|
-
* <p>For information about the requirements for an
|
|
258
|
+
* <p>For information about the requirements for an CloudHSM cluster that is associated with a
|
|
260
259
|
* custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
|
|
261
|
-
* in the <i>
|
|
260
|
+
* in the <i>Key Management Service Developer Guide</i>. For information about creating a private subnet for an CloudHSM cluster,
|
|
262
261
|
* see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html">Create a Private
|
|
263
|
-
* Subnet</a> in the <i>
|
|
262
|
+
* Subnet</a> in the <i>CloudHSM User Guide</i>. For information about cluster security groups, see
|
|
264
263
|
* <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html">Configure a Default Security
|
|
265
264
|
* Group</a> in the <i>
|
|
266
|
-
* <i>
|
|
265
|
+
* <i>CloudHSM User Guide</i>
|
|
267
266
|
* </i>. </p>
|
|
268
267
|
*/
|
|
269
268
|
export interface CloudHsmClusterInvalidConfigurationException extends __SmithyException, $MetadataBearer {
|
|
@@ -282,9 +281,9 @@ export namespace CloudHsmClusterInvalidConfigurationException {
|
|
|
282
281
|
}
|
|
283
282
|
|
|
284
283
|
/**
|
|
285
|
-
* <p>The request was rejected because the
|
|
284
|
+
* <p>The request was rejected because the CloudHSM cluster that is associated with the custom key
|
|
286
285
|
* store is not active. Initialize and activate the cluster and try the command again. For
|
|
287
|
-
* detailed instructions, see <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html">Getting Started</a> in the <i>
|
|
286
|
+
* 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>
|
|
288
287
|
*/
|
|
289
288
|
export interface CloudHsmClusterNotActiveException extends __SmithyException, $MetadataBearer {
|
|
290
289
|
name: "CloudHsmClusterNotActiveException";
|
|
@@ -302,7 +301,7 @@ export namespace CloudHsmClusterNotActiveException {
|
|
|
302
301
|
}
|
|
303
302
|
|
|
304
303
|
/**
|
|
305
|
-
* <p>The request was rejected because
|
|
304
|
+
* <p>The request was rejected because KMS cannot find the CloudHSM cluster with the specified
|
|
306
305
|
* cluster ID. Retry the request with a different cluster ID.</p>
|
|
307
306
|
*/
|
|
308
307
|
export interface CloudHsmClusterNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -321,7 +320,7 @@ export namespace CloudHsmClusterNotFoundException {
|
|
|
321
320
|
}
|
|
322
321
|
|
|
323
322
|
/**
|
|
324
|
-
* <p>The request was rejected because the specified
|
|
323
|
+
* <p>The request was rejected because the specified CloudHSM cluster has a different cluster
|
|
325
324
|
* certificate than the original cluster. You cannot use the operation to specify an unrelated
|
|
326
325
|
* cluster.</p>
|
|
327
326
|
* <p>Specify a cluster that shares a backup history with the original cluster. This includes
|
|
@@ -412,7 +411,7 @@ export namespace CustomKeyStoreInvalidStateException {
|
|
|
412
411
|
}
|
|
413
412
|
|
|
414
413
|
/**
|
|
415
|
-
* <p>The request was rejected because
|
|
414
|
+
* <p>The request was rejected because KMS cannot find a custom key store with the specified
|
|
416
415
|
* key store name or ID.</p>
|
|
417
416
|
*/
|
|
418
417
|
export interface CustomKeyStoreNotFoundException extends __SmithyException, $MetadataBearer {
|
|
@@ -456,19 +455,21 @@ export interface CreateAliasRequest {
|
|
|
456
455
|
* name, such as <code>alias/ExampleAlias</code>. </p>
|
|
457
456
|
* <p>The <code>AliasName</code> value must be string of 1-256 characters. It can contain only alphanumeric characters,
|
|
458
457
|
* forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with <code>alias/aws/</code>. The <code>alias/aws/</code> prefix is reserved
|
|
459
|
-
* for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
458
|
+
* for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed keys</a>.</p>
|
|
460
459
|
*/
|
|
461
460
|
AliasName: string | undefined;
|
|
462
461
|
|
|
463
462
|
/**
|
|
464
|
-
* <p>Associates the alias with the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
465
|
-
* in the same
|
|
466
|
-
* <p>A valid
|
|
463
|
+
* <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
|
|
464
|
+
* in the same Amazon Web Services Region. </p>
|
|
465
|
+
* <p>A valid key ID is required. If you supply a null or empty string value, this operation
|
|
467
466
|
* returns an error.</p>
|
|
468
467
|
* <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
|
|
469
|
-
* ARN</a> in the <i>
|
|
468
|
+
* ARN</a> in the <i>
|
|
469
|
+
* <i>Key Management Service Developer Guide</i>
|
|
470
|
+
* </i>.</p>
|
|
470
471
|
*
|
|
471
|
-
* <p>Specify the key ID or key ARN of the
|
|
472
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
472
473
|
* <p>For example:</p>
|
|
473
474
|
* <ul>
|
|
474
475
|
* <li>
|
|
@@ -480,7 +481,7 @@ export interface CreateAliasRequest {
|
|
|
480
481
|
* </p>
|
|
481
482
|
* </li>
|
|
482
483
|
* </ul>
|
|
483
|
-
* <p>To get the key ID and key ARN for a
|
|
484
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
484
485
|
*/
|
|
485
486
|
TargetKeyId: string | undefined;
|
|
486
487
|
}
|
|
@@ -514,7 +515,7 @@ export namespace InvalidAliasNameException {
|
|
|
514
515
|
|
|
515
516
|
/**
|
|
516
517
|
* <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
|
|
517
|
-
* <i>
|
|
518
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
518
519
|
*/
|
|
519
520
|
export interface LimitExceededException extends __SmithyException, $MetadataBearer {
|
|
520
521
|
name: "LimitExceededException";
|
|
@@ -533,14 +534,13 @@ export namespace LimitExceededException {
|
|
|
533
534
|
|
|
534
535
|
export interface CreateCustomKeyStoreRequest {
|
|
535
536
|
/**
|
|
536
|
-
* <p>Specifies a friendly name for the custom key store. The name must be unique in your
|
|
537
|
-
* account.</p>
|
|
537
|
+
* <p>Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.</p>
|
|
538
538
|
*/
|
|
539
539
|
CustomKeyStoreName: string | undefined;
|
|
540
540
|
|
|
541
541
|
/**
|
|
542
|
-
* <p>Identifies the
|
|
543
|
-
*
|
|
542
|
+
* <p>Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active
|
|
543
|
+
* CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,
|
|
544
544
|
* use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation.</p>
|
|
545
545
|
*/
|
|
546
546
|
CloudHsmClusterId: string | undefined;
|
|
@@ -554,11 +554,11 @@ export interface CreateCustomKeyStoreRequest {
|
|
|
554
554
|
/**
|
|
555
555
|
* <p>Enter the password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
556
556
|
* <code>kmsuser</code> crypto user
|
|
557
|
-
* (CU) account</a> in the specified
|
|
557
|
+
* (CU) account</a> in the specified CloudHSM cluster. KMS logs into the cluster as this
|
|
558
558
|
* user to manage key material on your behalf.</p>
|
|
559
559
|
* <p>The password must be a string of 7 to 32 characters. Its value is case sensitive.</p>
|
|
560
|
-
* <p>This parameter tells
|
|
561
|
-
* the password in the
|
|
560
|
+
* <p>This parameter tells KMS the <code>kmsuser</code> account password; it does not change
|
|
561
|
+
* the password in the CloudHSM cluster.</p>
|
|
562
562
|
*/
|
|
563
563
|
KeyStorePassword: string | undefined;
|
|
564
564
|
}
|
|
@@ -611,7 +611,7 @@ export namespace CustomKeyStoreNameInUseException {
|
|
|
611
611
|
|
|
612
612
|
/**
|
|
613
613
|
* <p>The request was rejected because the trust anchor certificate in the request is not the
|
|
614
|
-
* trust anchor certificate for the specified
|
|
614
|
+
* trust anchor certificate for the specified CloudHSM cluster.</p>
|
|
615
615
|
* <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
|
|
616
616
|
* <code>customerCA.crt</code> file.</p>
|
|
617
617
|
*/
|
|
@@ -633,10 +633,10 @@ export namespace IncorrectTrustAnchorException {
|
|
|
633
633
|
/**
|
|
634
634
|
* <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
|
|
635
635
|
* includes the specified <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption context</a>. </p>
|
|
636
|
-
* <p>
|
|
637
|
-
* 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
|
|
636
|
+
* <p>KMS applies the grant constraints only to cryptographic operations that support an
|
|
637
|
+
* 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
|
|
638
638
|
* constraints are not applied to operations that do not support an encryption context, such as
|
|
639
|
-
* cryptographic operations with asymmetric
|
|
639
|
+
* cryptographic operations with asymmetric KMS keys and management operations, such as <a>DescribeKey</a> or <a>RetireGrant</a>.</p>
|
|
640
640
|
* <important>
|
|
641
641
|
* <p>In a cryptographic operation, the encryption context in the decryption operation must be
|
|
642
642
|
* an exact, case-sensitive match for the keys and values in the encryption context of the
|
|
@@ -647,7 +647,7 @@ export namespace IncorrectTrustAnchorException {
|
|
|
647
647
|
* case. To require a fully case-sensitive encryption context, use the
|
|
648
648
|
* <code>kms:EncryptionContext:</code> and <code>kms:EncryptionContextKeys</code> conditions
|
|
649
649
|
* 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>
|
|
650
|
-
* <i>
|
|
650
|
+
* <i>Key Management Service Developer Guide</i>
|
|
651
651
|
* </i>.</p>
|
|
652
652
|
* </important>
|
|
653
653
|
*/
|
|
@@ -696,10 +696,10 @@ export enum GrantOperation {
|
|
|
696
696
|
|
|
697
697
|
export interface CreateGrantRequest {
|
|
698
698
|
/**
|
|
699
|
-
* <p>Identifies the
|
|
699
|
+
* <p>Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.</p>
|
|
700
700
|
*
|
|
701
|
-
* <p>Specify the key ID or key ARN of the
|
|
702
|
-
* different
|
|
701
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
702
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
703
703
|
* <p>For example:</p>
|
|
704
704
|
* <ul>
|
|
705
705
|
* <li>
|
|
@@ -711,65 +711,67 @@ export interface CreateGrantRequest {
|
|
|
711
711
|
* </p>
|
|
712
712
|
* </li>
|
|
713
713
|
* </ul>
|
|
714
|
-
* <p>To get the key ID and key ARN for a
|
|
714
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
715
715
|
*/
|
|
716
716
|
KeyId: string | undefined;
|
|
717
717
|
|
|
718
718
|
/**
|
|
719
719
|
* <p>The identity that gets the permissions specified in the grant.</p>
|
|
720
|
-
* <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
|
|
721
|
-
* principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated
|
|
720
|
+
* <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
|
|
722
721
|
* users, and assumed role users. For examples of the ARN syntax to use for specifying a
|
|
723
|
-
* principal, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam">
|
|
724
|
-
* Management (IAM)</a> in the Example ARNs section of the <i>
|
|
725
|
-
*
|
|
722
|
+
* 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
|
|
723
|
+
* Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General
|
|
724
|
+
* Reference</i>.</p>
|
|
726
725
|
*/
|
|
727
726
|
GranteePrincipal: string | undefined;
|
|
728
727
|
|
|
729
728
|
/**
|
|
730
|
-
* <p>The principal that
|
|
731
|
-
*
|
|
732
|
-
*
|
|
729
|
+
* <p>The principal that has permission to use the <a>RetireGrant</a> operation to
|
|
730
|
+
* retire the grant. </p>
|
|
731
|
+
* <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
|
|
733
732
|
* assumed role users. For examples of the ARN syntax to use for specifying a principal, see
|
|
734
|
-
*
|
|
735
|
-
*
|
|
733
|
+
* <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
|
|
734
|
+
* <i>Amazon Web Services General Reference</i>.</p>
|
|
735
|
+
* <p>The grant determines the retiring principal. Other principals might have permission to
|
|
736
|
+
* retire the grant or revoke the grant. For details, see <a>RevokeGrant</a> and
|
|
737
|
+
* <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>
|
|
736
738
|
*/
|
|
737
739
|
RetiringPrincipal?: string;
|
|
738
740
|
|
|
739
741
|
/**
|
|
740
742
|
* <p>A list of operations that the grant permits. </p>
|
|
741
|
-
* <p>The operation must be supported on the
|
|
742
|
-
* symmetric
|
|
743
|
-
*
|
|
744
|
-
*
|
|
745
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
743
|
+
* <p>The operation must be supported on the KMS key. For example, you cannot create a grant for a
|
|
744
|
+
* 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
|
|
745
|
+
* <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
|
|
746
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
746
747
|
*/
|
|
747
748
|
Operations: (GrantOperation | string)[] | undefined;
|
|
748
749
|
|
|
749
750
|
/**
|
|
750
751
|
* <p>Specifies a grant constraint. </p>
|
|
751
|
-
* <p>
|
|
752
|
-
*
|
|
752
|
+
* <p>KMS supports the <code>EncryptionContextEquals</code> and
|
|
753
|
+
* <code>EncryptionContextSubset</code> grant constraints. Each constraint value can include up
|
|
753
754
|
* to 8 encryption context pairs. The encryption context value in each constraint cannot exceed
|
|
754
755
|
* 384 characters.</p>
|
|
755
|
-
* <p>These grant constraints allow
|
|
756
|
-
* request matches (<code>EncryptionContextEquals</code>) or includes
|
|
757
|
-
*
|
|
758
|
-
* For
|
|
759
|
-
* <i>
|
|
760
|
-
*
|
|
761
|
-
*
|
|
762
|
-
*
|
|
756
|
+
* <p>These grant constraints allow the permissions in the grant only when the encryption
|
|
757
|
+
* context in the request matches (<code>EncryptionContextEquals</code>) or includes
|
|
758
|
+
* (<code>EncryptionContextSubset</code>) the encryption context specified in this structure.
|
|
759
|
+
* For information about grant constraints, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints">Using grant
|
|
760
|
+
* constraints</a> in the <i>Key Management Service Developer Guide</i>. For more information about encryption context,
|
|
761
|
+
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
762
|
+
* Context</a> in the <i>
|
|
763
|
+
* <i>Key Management Service Developer Guide</i>
|
|
764
|
+
* </i>. </p>
|
|
763
765
|
* <p>The encryption context grant constraints are supported only on operations that include an
|
|
764
766
|
* encryption context. You cannot use an encryption context grant constraint for cryptographic
|
|
765
|
-
* operations with asymmetric
|
|
767
|
+
* operations with asymmetric KMS keys or for management operations, such as <a>DescribeKey</a> or <a>RetireGrant</a>.</p>
|
|
766
768
|
*/
|
|
767
769
|
Constraints?: GrantConstraints;
|
|
768
770
|
|
|
769
771
|
/**
|
|
770
772
|
* <p>A list of grant tokens. </p>
|
|
771
|
-
* <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/
|
|
772
|
-
* <i>
|
|
773
|
+
* <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
|
|
774
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
773
775
|
*/
|
|
774
776
|
GrantTokens?: string[];
|
|
775
777
|
|
|
@@ -782,7 +784,7 @@ export interface CreateGrantRequest {
|
|
|
782
784
|
* <p>When this value is present, you can retry a <code>CreateGrant</code> request with
|
|
783
785
|
* identical parameters; if the grant already exists, the original <code>GrantId</code> is
|
|
784
786
|
* returned without creating a new grant. Note that the returned grant token is unique with every
|
|
785
|
-
*
|
|
787
|
+
* <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned.
|
|
786
788
|
* All grant tokens for the same grant ID can be used interchangeably.</p>
|
|
787
789
|
*/
|
|
788
790
|
Name?: string;
|
|
@@ -800,8 +802,8 @@ export namespace CreateGrantRequest {
|
|
|
800
802
|
export interface CreateGrantResponse {
|
|
801
803
|
/**
|
|
802
804
|
* <p>The grant token.</p>
|
|
803
|
-
* <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/
|
|
804
|
-
* <i>
|
|
805
|
+
* <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
|
|
806
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
805
807
|
*/
|
|
806
808
|
GrantToken?: string;
|
|
807
809
|
|
|
@@ -822,7 +824,7 @@ export namespace CreateGrantResponse {
|
|
|
822
824
|
}
|
|
823
825
|
|
|
824
826
|
/**
|
|
825
|
-
* <p>The request was rejected because the specified
|
|
827
|
+
* <p>The request was rejected because the specified KMS key is not enabled.</p>
|
|
826
828
|
*/
|
|
827
829
|
export interface DisabledException extends __SmithyException, $MetadataBearer {
|
|
828
830
|
name: "DisabledException";
|
|
@@ -868,6 +870,17 @@ export enum CustomerMasterKeySpec {
|
|
|
868
870
|
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT",
|
|
869
871
|
}
|
|
870
872
|
|
|
873
|
+
export enum KeySpec {
|
|
874
|
+
ECC_NIST_P256 = "ECC_NIST_P256",
|
|
875
|
+
ECC_NIST_P384 = "ECC_NIST_P384",
|
|
876
|
+
ECC_NIST_P521 = "ECC_NIST_P521",
|
|
877
|
+
ECC_SECG_P256K1 = "ECC_SECG_P256K1",
|
|
878
|
+
RSA_2048 = "RSA_2048",
|
|
879
|
+
RSA_3072 = "RSA_3072",
|
|
880
|
+
RSA_4096 = "RSA_4096",
|
|
881
|
+
SYMMETRIC_DEFAULT = "SYMMETRIC_DEFAULT",
|
|
882
|
+
}
|
|
883
|
+
|
|
871
884
|
export enum KeyUsageType {
|
|
872
885
|
ENCRYPT_DECRYPT = "ENCRYPT_DECRYPT",
|
|
873
886
|
SIGN_VERIFY = "SIGN_VERIFY",
|
|
@@ -882,7 +895,7 @@ export enum OriginType {
|
|
|
882
895
|
/**
|
|
883
896
|
* <p>A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are
|
|
884
897
|
* both required, but tag values can be empty (null) strings.</p>
|
|
885
|
-
* <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>
|
|
898
|
+
* <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
|
|
886
899
|
* Guide</i>.</p>
|
|
887
900
|
*/
|
|
888
901
|
export interface Tag {
|
|
@@ -908,85 +921,94 @@ export namespace Tag {
|
|
|
908
921
|
|
|
909
922
|
export interface CreateKeyRequest {
|
|
910
923
|
/**
|
|
911
|
-
* <p>The key policy to attach to the
|
|
924
|
+
* <p>The key policy to attach to the KMS key.</p>
|
|
912
925
|
* <p>If you provide a key policy, it must meet the following criteria:</p>
|
|
913
926
|
* <ul>
|
|
914
927
|
* <li>
|
|
915
928
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
916
929
|
* must allow the principal that is making the <code>CreateKey</code> request to make a
|
|
917
|
-
* subsequent <a>PutKeyPolicy</a> request on the
|
|
918
|
-
* the
|
|
919
|
-
* <i>
|
|
930
|
+
* subsequent <a>PutKeyPolicy</a> request on the KMS key. This reduces the risk that
|
|
931
|
+
* 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>
|
|
932
|
+
* <i>Key Management Service Developer Guide</i>
|
|
920
933
|
* </i>.</p>
|
|
921
934
|
* </li>
|
|
922
935
|
* <li>
|
|
923
936
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
924
|
-
* in the key policy must exist and be visible to
|
|
937
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
925
938
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
926
939
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
927
|
-
* to
|
|
928
|
-
* Identity and Access Management User Guide</i>.</p>
|
|
940
|
+
* 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>
|
|
929
941
|
* </li>
|
|
930
942
|
* </ul>
|
|
931
|
-
* <p>If you do not provide a key policy,
|
|
943
|
+
* <p>If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For
|
|
932
944
|
* 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
|
|
933
|
-
* <i>
|
|
945
|
+
* <i>Key Management Service Developer Guide</i>. </p>
|
|
934
946
|
* <p>The key policy size quota is 32 kilobytes (32768 bytes).</p>
|
|
935
947
|
* <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>
|
|
936
|
-
* <i>
|
|
948
|
+
* <i>Identity and Access Management User Guide</i>
|
|
937
949
|
* </i>.</p>
|
|
938
950
|
*/
|
|
939
951
|
Policy?: string;
|
|
940
952
|
|
|
941
953
|
/**
|
|
942
|
-
* <p>A description of the
|
|
943
|
-
* <p>Use a description that helps you decide whether the
|
|
954
|
+
* <p>A description of the KMS key.</p>
|
|
955
|
+
* <p>Use a description that helps you decide whether the KMS key is
|
|
944
956
|
* appropriate for a task. The default value is an empty string (no description).</p>
|
|
957
|
+
* <p>To set or change the description after the key is created, use <a>UpdateKeyDescription</a>.</p>
|
|
945
958
|
*/
|
|
946
959
|
Description?: string;
|
|
947
960
|
|
|
948
961
|
/**
|
|
949
|
-
* <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
|
|
950
|
-
* <code>ENCRYPT_DECRYPT</code>. This parameter is required only for asymmetric
|
|
951
|
-
* change the <code>KeyUsage</code> value after the
|
|
962
|
+
* <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
|
|
963
|
+
* <code>ENCRYPT_DECRYPT</code>. This parameter is required only for asymmetric KMS keys. You can't
|
|
964
|
+
* change the <code>KeyUsage</code> value after the KMS key is created.</p>
|
|
952
965
|
* <p>Select only one valid value.</p>
|
|
953
966
|
* <ul>
|
|
954
967
|
* <li>
|
|
955
|
-
* <p>For symmetric
|
|
968
|
+
* <p>For symmetric KMS keys, omit the parameter or specify <code>ENCRYPT_DECRYPT</code>.</p>
|
|
956
969
|
* </li>
|
|
957
970
|
* <li>
|
|
958
|
-
* <p>For asymmetric
|
|
971
|
+
* <p>For asymmetric KMS keys with RSA key material, specify <code>ENCRYPT_DECRYPT</code> or
|
|
959
972
|
* <code>SIGN_VERIFY</code>.</p>
|
|
960
973
|
* </li>
|
|
961
974
|
* <li>
|
|
962
|
-
* <p>For asymmetric
|
|
975
|
+
* <p>For asymmetric KMS keys with ECC key material, specify <code>SIGN_VERIFY</code>.</p>
|
|
963
976
|
* </li>
|
|
964
977
|
* </ul>
|
|
965
978
|
*/
|
|
966
979
|
KeyUsage?: KeyUsageType | string;
|
|
967
980
|
|
|
968
981
|
/**
|
|
969
|
-
*
|
|
970
|
-
*
|
|
971
|
-
*
|
|
972
|
-
*
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
*
|
|
978
|
-
*
|
|
979
|
-
*
|
|
982
|
+
* @deprecated
|
|
983
|
+
*
|
|
984
|
+
* <p>Instead, use the <code>KeySpec</code> parameter.</p>
|
|
985
|
+
* <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>
|
|
986
|
+
*/
|
|
987
|
+
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
988
|
+
|
|
989
|
+
/**
|
|
990
|
+
* <p>Specifies the type of KMS key to create. The default value, <code>SYMMETRIC_DEFAULT</code>,
|
|
991
|
+
* creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a
|
|
992
|
+
* 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
|
|
993
|
+
* Configuration</a> in the <i>
|
|
994
|
+
* <i>Key Management Service Developer Guide</i>
|
|
995
|
+
* </i>.</p>
|
|
996
|
+
* <p>The <code>KeySpec</code> determines whether the KMS key contains a symmetric key or an
|
|
997
|
+
* asymmetric key pair. It also determines the encryption algorithms or signing algorithms that
|
|
998
|
+
* the KMS key supports. You can't change the <code>KeySpec</code> after the KMS key is created.
|
|
999
|
+
* To further restrict the algorithms that can be used with the KMS key, use a condition key in
|
|
1000
|
+
* 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>
|
|
1001
|
+
* <i>Key Management Service Developer Guide</i>
|
|
1002
|
+
* </i>.</p>
|
|
980
1003
|
* <important>
|
|
981
1004
|
* <p>
|
|
982
|
-
* <a href="http://aws.amazon.com/kms/features/#AWS_Service_Integration">
|
|
983
|
-
*
|
|
984
|
-
* services do not support asymmetric
|
|
985
|
-
* asymmetric, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html">Identifying Symmetric and Asymmetric
|
|
986
|
-
*
|
|
987
|
-
* Guide</i>.</p>
|
|
1005
|
+
* <a href="http://aws.amazon.com/kms/features/#AWS_Service_Integration">Amazon Web Services services that
|
|
1006
|
+
* are integrated with KMS</a> use symmetric KMS keys to protect your data. These
|
|
1007
|
+
* services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or
|
|
1008
|
+
* 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
|
|
1009
|
+
* Guide</i>.</p>
|
|
988
1010
|
* </important>
|
|
989
|
-
* <p>
|
|
1011
|
+
* <p>KMS supports the following key specs for KMS keys:</p>
|
|
990
1012
|
* <ul>
|
|
991
1013
|
* <li>
|
|
992
1014
|
* <p>Symmetric key (default)</p>
|
|
@@ -1046,35 +1068,35 @@ export interface CreateKeyRequest {
|
|
|
1046
1068
|
* </li>
|
|
1047
1069
|
* </ul>
|
|
1048
1070
|
*/
|
|
1049
|
-
|
|
1071
|
+
KeySpec?: KeySpec | string;
|
|
1050
1072
|
|
|
1051
1073
|
/**
|
|
1052
|
-
* <p>The source of the key material for the
|
|
1053
|
-
* the
|
|
1074
|
+
* <p>The source of the key material for the KMS key. You cannot change the origin after you create
|
|
1075
|
+
* the KMS key. The default is <code>AWS_KMS</code>, which means that KMS creates the key
|
|
1054
1076
|
* material.</p>
|
|
1055
|
-
* <p>To create a
|
|
1056
|
-
* <code>EXTERNAL</code>. For more information about importing key material into
|
|
1077
|
+
* <p>To create a KMS key with no key material (for imported key material), set the value to
|
|
1078
|
+
* <code>EXTERNAL</code>. For more information about importing key material into KMS, see
|
|
1057
1079
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
1058
|
-
* Material</a> in the <i>
|
|
1059
|
-
* <p>To create a
|
|
1060
|
-
*
|
|
1080
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. This value is valid only for symmetric KMS keys.</p>
|
|
1081
|
+
* <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
|
|
1082
|
+
* CloudHSM cluster, set this value to <code>AWS_CLOUDHSM</code>. You must also use the
|
|
1061
1083
|
* <code>CustomKeyStoreId</code> parameter to identify the custom key store. This value is
|
|
1062
|
-
* valid only for symmetric
|
|
1084
|
+
* valid only for symmetric KMS keys.</p>
|
|
1063
1085
|
*/
|
|
1064
1086
|
Origin?: OriginType | string;
|
|
1065
1087
|
|
|
1066
1088
|
/**
|
|
1067
|
-
* <p>Creates the
|
|
1068
|
-
*
|
|
1069
|
-
* <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
|
|
1089
|
+
* <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
|
|
1090
|
+
* CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the
|
|
1091
|
+
* <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The CloudHSM cluster
|
|
1070
1092
|
* that is associated with the custom key store must have at least two active HSMs, each in a
|
|
1071
1093
|
* different Availability Zone in the Region.</p>
|
|
1072
|
-
* <p>This parameter is valid only for symmetric
|
|
1073
|
-
* asymmetric
|
|
1094
|
+
* <p>This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot create an
|
|
1095
|
+
* asymmetric KMS key or a multi-Region key in a custom key store.</p>
|
|
1074
1096
|
* <p>To find the ID of a custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
1075
|
-
* <p>The response includes the custom key store ID and the ID of the
|
|
1076
|
-
* <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
|
|
1077
|
-
* combines the convenience and extensive integration of
|
|
1097
|
+
* <p>The response includes the custom key store ID and the ID of the CloudHSM cluster.</p>
|
|
1098
|
+
* <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
|
|
1099
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
1078
1100
|
* single-tenant key store.</p>
|
|
1079
1101
|
*/
|
|
1080
1102
|
CustomKeyStoreId?: string;
|
|
@@ -1082,50 +1104,49 @@ export interface CreateKeyRequest {
|
|
|
1082
1104
|
/**
|
|
1083
1105
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
1084
1106
|
* <important>
|
|
1085
|
-
* <p>Setting this value to true increases the risk that the
|
|
1107
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
1086
1108
|
* set this value to true indiscriminately.</p>
|
|
1087
1109
|
* <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>
|
|
1088
|
-
* <i>
|
|
1110
|
+
* <i>Key Management Service Developer Guide</i>
|
|
1089
1111
|
* </i>.</p>
|
|
1090
1112
|
* </important>
|
|
1091
1113
|
* <p>Use this parameter only when you include a policy in the request and you intend to prevent
|
|
1092
|
-
* the principal that is making the request from making a subsequent <a>PutKeyPolicy</a> request on the
|
|
1114
|
+
* the principal that is making the request from making a subsequent <a>PutKeyPolicy</a> request on the KMS key.</p>
|
|
1093
1115
|
* <p>The default value is false.</p>
|
|
1094
1116
|
*/
|
|
1095
1117
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
1096
1118
|
|
|
1097
1119
|
/**
|
|
1098
|
-
* <p>Assigns one or more tags to the
|
|
1099
|
-
* To tag an existing
|
|
1120
|
+
* <p>Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created.
|
|
1121
|
+
* To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
1100
1122
|
* <note>
|
|
1101
|
-
* <p>Tagging or untagging a
|
|
1102
|
-
* 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>
|
|
1123
|
+
* <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>
|
|
1103
1124
|
* </note>
|
|
1104
1125
|
* <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>
|
|
1105
1126
|
* <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
|
|
1106
1127
|
* required, but the tag value can be an empty (null) string. You cannot have more than one tag
|
|
1107
|
-
* on a
|
|
1108
|
-
*
|
|
1109
|
-
* <p>When you
|
|
1110
|
-
* report with usage and costs aggregated by tags. Tags can also be used to control access to a
|
|
1128
|
+
* on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,
|
|
1129
|
+
* KMS replaces the current tag value with the specified one.</p>
|
|
1130
|
+
* <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
|
|
1131
|
+
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
|
|
1111
1132
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
1112
1133
|
*/
|
|
1113
1134
|
Tags?: Tag[];
|
|
1114
1135
|
|
|
1115
1136
|
/**
|
|
1116
|
-
* <p>Creates a multi-Region primary key that you can replicate into other
|
|
1117
|
-
* cannot change this value after you create the
|
|
1118
|
-
* <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region
|
|
1137
|
+
* <p>Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You
|
|
1138
|
+
* cannot change this value after you create the KMS key. </p>
|
|
1139
|
+
* <p>For a multi-Region key, set this parameter to <code>True</code>. For a single-Region KMS key,
|
|
1119
1140
|
* omit this parameter or set it to <code>False</code>. The default value is
|
|
1120
1141
|
* <code>False</code>.</p>
|
|
1121
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
1122
|
-
* interoperable
|
|
1123
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
1124
|
-
* it in a different
|
|
1142
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
1143
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
1144
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
1145
|
+
* 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>
|
|
1125
1146
|
* <p>This value creates a <i>primary key</i>, not a replica. To create a
|
|
1126
1147
|
* <i>replica key</i>, use the <a>ReplicateKey</a> operation. </p>
|
|
1127
|
-
* <p>You can create a symmetric or asymmetric multi-Region
|
|
1128
|
-
* multi-Region
|
|
1148
|
+
* <p>You can create a symmetric or asymmetric multi-Region key, and you can create a
|
|
1149
|
+
* multi-Region key with imported key material. However, you cannot create a multi-Region key in
|
|
1129
1150
|
* a custom key store.</p>
|
|
1130
1151
|
*/
|
|
1131
1152
|
MultiRegion?: boolean;
|
|
@@ -1182,7 +1203,7 @@ export interface MultiRegionKey {
|
|
|
1182
1203
|
Arn?: string;
|
|
1183
1204
|
|
|
1184
1205
|
/**
|
|
1185
|
-
* <p>Displays the
|
|
1206
|
+
* <p>Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.</p>
|
|
1186
1207
|
*/
|
|
1187
1208
|
Region?: string;
|
|
1188
1209
|
}
|
|
@@ -1197,25 +1218,25 @@ export namespace MultiRegionKey {
|
|
|
1197
1218
|
}
|
|
1198
1219
|
|
|
1199
1220
|
/**
|
|
1200
|
-
* <p>Describes the configuration of this multi-Region
|
|
1201
|
-
* is a primary or replica of a multi-Region
|
|
1202
|
-
* <p>For more information about any listed
|
|
1221
|
+
* <p>Describes the configuration of this multi-Region key. This field appears only when the KMS key
|
|
1222
|
+
* is a primary or replica of a multi-Region key.</p>
|
|
1223
|
+
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
1203
1224
|
* operation.</p>
|
|
1204
1225
|
*/
|
|
1205
1226
|
export interface MultiRegionConfiguration {
|
|
1206
1227
|
/**
|
|
1207
|
-
* <p>Indicates whether the
|
|
1228
|
+
* <p>Indicates whether the KMS key is a <code>PRIMARY</code> or <code>REPLICA</code> key.</p>
|
|
1208
1229
|
*/
|
|
1209
1230
|
MultiRegionKeyType?: MultiRegionKeyType | string;
|
|
1210
1231
|
|
|
1211
1232
|
/**
|
|
1212
|
-
* <p>Displays the key ARN and Region of the primary key. This field includes the current
|
|
1233
|
+
* <p>Displays the key ARN and Region of the primary key. This field includes the current KMS key if
|
|
1213
1234
|
* it is the primary key.</p>
|
|
1214
1235
|
*/
|
|
1215
1236
|
PrimaryKey?: MultiRegionKey;
|
|
1216
1237
|
|
|
1217
1238
|
/**
|
|
1218
|
-
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current
|
|
1239
|
+
* <p>displays the key ARNs and Regions of all replica keys. This field includes the current KMS key
|
|
1219
1240
|
* if it is a replica key.</p>
|
|
1220
1241
|
*/
|
|
1221
1242
|
ReplicaKeys?: MultiRegionKey[];
|
|
@@ -1243,58 +1264,57 @@ export enum SigningAlgorithmSpec {
|
|
|
1243
1264
|
}
|
|
1244
1265
|
|
|
1245
1266
|
/**
|
|
1246
|
-
* <p>Contains metadata about a
|
|
1267
|
+
* <p>Contains metadata about a KMS key.</p>
|
|
1247
1268
|
* <p>This data type is used as a response element for the <a>CreateKey</a> and <a>DescribeKey</a> operations.</p>
|
|
1248
1269
|
*/
|
|
1249
1270
|
export interface KeyMetadata {
|
|
1250
1271
|
/**
|
|
1251
|
-
* <p>The twelve-digit account ID of the
|
|
1272
|
+
* <p>The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.</p>
|
|
1252
1273
|
*/
|
|
1253
1274
|
AWSAccountId?: string;
|
|
1254
1275
|
|
|
1255
1276
|
/**
|
|
1256
|
-
* <p>The globally unique identifier for the
|
|
1277
|
+
* <p>The globally unique identifier for the KMS key.</p>
|
|
1257
1278
|
*/
|
|
1258
1279
|
KeyId: string | undefined;
|
|
1259
1280
|
|
|
1260
1281
|
/**
|
|
1261
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
1262
|
-
* (
|
|
1282
|
+
* <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
|
|
1283
|
+
* (KMS)</a> in the Example ARNs section of the <i>Amazon Web Services General
|
|
1263
1284
|
* Reference</i>.</p>
|
|
1264
1285
|
*/
|
|
1265
1286
|
Arn?: string;
|
|
1266
1287
|
|
|
1267
1288
|
/**
|
|
1268
|
-
* <p>The date and time when the
|
|
1289
|
+
* <p>The date and time when the KMS key was created.</p>
|
|
1269
1290
|
*/
|
|
1270
1291
|
CreationDate?: Date;
|
|
1271
1292
|
|
|
1272
1293
|
/**
|
|
1273
|
-
* <p>Specifies whether the
|
|
1294
|
+
* <p>Specifies whether the KMS key is enabled. When <code>KeyState</code> is <code>Enabled</code>
|
|
1274
1295
|
* this value is true, otherwise it is false.</p>
|
|
1275
1296
|
*/
|
|
1276
1297
|
Enabled?: boolean;
|
|
1277
1298
|
|
|
1278
1299
|
/**
|
|
1279
|
-
* <p>The description of the
|
|
1300
|
+
* <p>The description of the KMS key.</p>
|
|
1280
1301
|
*/
|
|
1281
1302
|
Description?: string;
|
|
1282
1303
|
|
|
1283
1304
|
/**
|
|
1284
|
-
* <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
|
|
1305
|
+
* <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>
|
|
1285
1306
|
*/
|
|
1286
1307
|
KeyUsage?: KeyUsageType | string;
|
|
1287
1308
|
|
|
1288
1309
|
/**
|
|
1289
|
-
* <p>The current status of the
|
|
1290
|
-
* <p>For more information about how key state affects the use of a
|
|
1291
|
-
* in the <i>
|
|
1310
|
+
* <p>The current status of the KMS key.</p>
|
|
1311
|
+
* <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>
|
|
1312
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1292
1313
|
*/
|
|
1293
1314
|
KeyState?: KeyState | string;
|
|
1294
1315
|
|
|
1295
1316
|
/**
|
|
1296
|
-
* <p>The date and time after which
|
|
1297
|
-
* CMK is scheduled for deletion, that is, when its <code>KeyState</code> is
|
|
1317
|
+
* <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
|
|
1298
1318
|
* <code>PendingDeletion</code>.</p>
|
|
1299
1319
|
* <p>When the primary key in a multi-Region key is scheduled for deletion but still has replica
|
|
1300
1320
|
* keys, its key state is <code>PendingReplicaDeletion</code> and the length of its waiting
|
|
@@ -1303,98 +1323,105 @@ export interface KeyMetadata {
|
|
|
1303
1323
|
DeletionDate?: Date;
|
|
1304
1324
|
|
|
1305
1325
|
/**
|
|
1306
|
-
* <p>The time at which the imported key material expires. When the key material expires,
|
|
1307
|
-
* deletes the key material and the
|
|
1326
|
+
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
1327
|
+
* deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys
|
|
1308
1328
|
* whose <code>Origin</code> is <code>EXTERNAL</code> and whose <code>ExpirationModel</code> is
|
|
1309
1329
|
* <code>KEY_MATERIAL_EXPIRES</code>, otherwise this value is omitted.</p>
|
|
1310
1330
|
*/
|
|
1311
1331
|
ValidTo?: Date;
|
|
1312
1332
|
|
|
1313
1333
|
/**
|
|
1314
|
-
* <p>The source of the
|
|
1334
|
+
* <p>The source of the key material for the KMS key. When this value is <code>AWS_KMS</code>, KMS
|
|
1315
1335
|
* created the key material. When this value is <code>EXTERNAL</code>, the key material was
|
|
1316
|
-
* imported
|
|
1317
|
-
* this value is <code>AWS_CLOUDHSM</code>, the key material was created in the
|
|
1336
|
+
* imported or the KMS key doesn't have any key material. When
|
|
1337
|
+
* this value is <code>AWS_CLOUDHSM</code>, the key material was created in the CloudHSM cluster
|
|
1318
1338
|
* associated with a custom key store.</p>
|
|
1319
1339
|
*/
|
|
1320
1340
|
Origin?: OriginType | string;
|
|
1321
1341
|
|
|
1322
1342
|
/**
|
|
1323
|
-
* <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
|
|
1324
|
-
* only when the
|
|
1343
|
+
* <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
|
|
1344
|
+
* only when the KMS key is created in a custom key store.</p>
|
|
1325
1345
|
*/
|
|
1326
1346
|
CustomKeyStoreId?: string;
|
|
1327
1347
|
|
|
1328
1348
|
/**
|
|
1329
|
-
* <p>The cluster ID of the
|
|
1330
|
-
* create a
|
|
1331
|
-
* associated
|
|
1349
|
+
* <p>The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you
|
|
1350
|
+
* 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
|
|
1351
|
+
* associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key
|
|
1332
1352
|
* store.</p>
|
|
1333
1353
|
*/
|
|
1334
1354
|
CloudHsmClusterId?: string;
|
|
1335
1355
|
|
|
1336
1356
|
/**
|
|
1337
|
-
* <p>Specifies whether the
|
|
1357
|
+
* <p>Specifies whether the KMS key's key material expires. This value is present only when
|
|
1338
1358
|
* <code>Origin</code> is <code>EXTERNAL</code>, otherwise this value is omitted.</p>
|
|
1339
1359
|
*/
|
|
1340
1360
|
ExpirationModel?: ExpirationModelType | string;
|
|
1341
1361
|
|
|
1342
1362
|
/**
|
|
1343
|
-
* <p>The manager of the
|
|
1344
|
-
*
|
|
1345
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
1363
|
+
* <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
|
|
1364
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1346
1365
|
*/
|
|
1347
1366
|
KeyManager?: KeyManagerType | string;
|
|
1348
1367
|
|
|
1349
1368
|
/**
|
|
1350
|
-
*
|
|
1369
|
+
* @deprecated
|
|
1370
|
+
*
|
|
1371
|
+
* <p>Instead, use the <code>KeySpec</code> field.</p>
|
|
1372
|
+
* <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>
|
|
1351
1373
|
*/
|
|
1352
1374
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
1353
1375
|
|
|
1354
1376
|
/**
|
|
1355
|
-
* <p>
|
|
1356
|
-
|
|
1357
|
-
|
|
1377
|
+
* <p>Describes the type of key material in the KMS key.</p>
|
|
1378
|
+
*/
|
|
1379
|
+
KeySpec?: KeySpec | string;
|
|
1380
|
+
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>The encryption algorithms that the KMS key supports. You cannot use the KMS key with other
|
|
1383
|
+
* encryption algorithms within KMS.</p>
|
|
1384
|
+
* <p>This value is present only when the <code>KeyUsage</code> of the KMS key is
|
|
1358
1385
|
* <code>ENCRYPT_DECRYPT</code>.</p>
|
|
1359
1386
|
*/
|
|
1360
1387
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
1361
1388
|
|
|
1362
1389
|
/**
|
|
1363
|
-
* <p>The signing algorithms that the
|
|
1364
|
-
* algorithms within
|
|
1365
|
-
* <p>This field appears only when the <code>KeyUsage</code> of the
|
|
1390
|
+
* <p>The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing
|
|
1391
|
+
* algorithms within KMS.</p>
|
|
1392
|
+
* <p>This field appears only when the <code>KeyUsage</code> of the KMS key is
|
|
1366
1393
|
* <code>SIGN_VERIFY</code>.</p>
|
|
1367
1394
|
*/
|
|
1368
1395
|
SigningAlgorithms?: (SigningAlgorithmSpec | string)[];
|
|
1369
1396
|
|
|
1370
1397
|
/**
|
|
1371
|
-
* <p>Indicates whether the
|
|
1398
|
+
* <p>Indicates whether the KMS key is a multi-Region (<code>True</code>) or regional
|
|
1372
1399
|
* (<code>False</code>) key. This value is <code>True</code> for multi-Region primary and
|
|
1373
|
-
* replica
|
|
1374
|
-
* <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>
|
|
1400
|
+
* replica keys and <code>False</code> for regional KMS keys.</p>
|
|
1401
|
+
* <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>
|
|
1375
1402
|
*/
|
|
1376
1403
|
MultiRegion?: boolean;
|
|
1377
1404
|
|
|
1378
1405
|
/**
|
|
1379
|
-
* <p>Lists the primary and replica
|
|
1406
|
+
* <p>Lists the primary and replica keys in same multi-Region key. This field is present only
|
|
1380
1407
|
* when the value of the <code>MultiRegion</code> field is <code>True</code>.</p>
|
|
1381
|
-
* <p>For more information about any listed
|
|
1408
|
+
* <p>For more information about any listed KMS key, use the <a>DescribeKey</a>
|
|
1382
1409
|
* operation.</p>
|
|
1383
1410
|
* <ul>
|
|
1384
1411
|
* <li>
|
|
1385
1412
|
* <p>
|
|
1386
|
-
* <code>MultiRegionKeyType</code> indicates whether the
|
|
1413
|
+
* <code>MultiRegionKeyType</code> indicates whether the KMS key is a <code>PRIMARY</code> or
|
|
1387
1414
|
* <code>REPLICA</code> key.</p>
|
|
1388
1415
|
* </li>
|
|
1389
1416
|
* <li>
|
|
1390
1417
|
* <p>
|
|
1391
1418
|
* <code>PrimaryKey</code> displays the key ARN and Region of the primary key. This field
|
|
1392
|
-
* displays the current
|
|
1419
|
+
* displays the current KMS key if it is the primary key.</p>
|
|
1393
1420
|
* </li>
|
|
1394
1421
|
* <li>
|
|
1395
1422
|
* <p>
|
|
1396
1423
|
* <code>ReplicaKeys</code> displays the key ARNs and Regions of all replica keys. This
|
|
1397
|
-
* field includes the current
|
|
1424
|
+
* field includes the current KMS key if it is a replica key.</p>
|
|
1398
1425
|
* </li>
|
|
1399
1426
|
* </ul>
|
|
1400
1427
|
*/
|
|
@@ -1403,10 +1430,10 @@ export interface KeyMetadata {
|
|
|
1403
1430
|
/**
|
|
1404
1431
|
* <p>The waiting period before the primary key in a multi-Region key is deleted. This waiting
|
|
1405
1432
|
* period begins when the last of its replica keys is deleted. This value is present only when
|
|
1406
|
-
* the <code>KeyState</code> of the
|
|
1407
|
-
* that the
|
|
1433
|
+
* the <code>KeyState</code> of the KMS key is <code>PendingReplicaDeletion</code>. That indicates
|
|
1434
|
+
* that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it
|
|
1408
1435
|
* still has existing replica keys.</p>
|
|
1409
|
-
* <p>When a
|
|
1436
|
+
* <p>When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its
|
|
1410
1437
|
* deletion date is displayed in the <code>DeletionDate</code> field. However, when the primary
|
|
1411
1438
|
* key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until
|
|
1412
1439
|
* all of its replica keys are deleted. This value displays that waiting period. When the last
|
|
@@ -1428,7 +1455,7 @@ export namespace KeyMetadata {
|
|
|
1428
1455
|
|
|
1429
1456
|
export interface CreateKeyResponse {
|
|
1430
1457
|
/**
|
|
1431
|
-
* <p>Metadata associated with the
|
|
1458
|
+
* <p>Metadata associated with the KMS key.</p>
|
|
1432
1459
|
*/
|
|
1433
1460
|
KeyMetadata?: KeyMetadata;
|
|
1434
1461
|
}
|
|
@@ -1499,8 +1526,7 @@ export namespace UnsupportedOperationException {
|
|
|
1499
1526
|
}
|
|
1500
1527
|
|
|
1501
1528
|
/**
|
|
1502
|
-
* <p>The request was rejected because the custom key store contains
|
|
1503
|
-
* (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
|
|
1529
|
+
* <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
|
|
1504
1530
|
* can delete the custom key store.</p>
|
|
1505
1531
|
*/
|
|
1506
1532
|
export interface CustomKeyStoreHasCMKsException extends __SmithyException, $MetadataBearer {
|
|
@@ -1533,30 +1559,30 @@ export interface CustomKeyStoresListEntry {
|
|
|
1533
1559
|
CustomKeyStoreName?: string;
|
|
1534
1560
|
|
|
1535
1561
|
/**
|
|
1536
|
-
* <p>A unique identifier for the
|
|
1562
|
+
* <p>A unique identifier for the CloudHSM cluster that is associated with the custom key
|
|
1537
1563
|
* store.</p>
|
|
1538
1564
|
*/
|
|
1539
1565
|
CloudHsmClusterId?: string;
|
|
1540
1566
|
|
|
1541
1567
|
/**
|
|
1542
|
-
* <p>The trust anchor certificate of the associated
|
|
1568
|
+
* <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
|
|
1543
1569
|
* cluster</a>, you create this certificate and save it in the <code>customerCA.crt</code>
|
|
1544
1570
|
* file.</p>
|
|
1545
1571
|
*/
|
|
1546
1572
|
TrustAnchorCertificate?: string;
|
|
1547
1573
|
|
|
1548
1574
|
/**
|
|
1549
|
-
* <p>Indicates whether the custom key store is connected to its
|
|
1550
|
-
* <p>You can create and use
|
|
1575
|
+
* <p>Indicates whether the custom key store is connected to its CloudHSM cluster.</p>
|
|
1576
|
+
* <p>You can create and use KMS keys in your custom key stores only when its connection state is
|
|
1551
1577
|
* <code>CONNECTED</code>.</p>
|
|
1552
1578
|
* <p>The value is <code>DISCONNECTED</code> if the key store has never been connected or you
|
|
1553
1579
|
* use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If the value is
|
|
1554
1580
|
* <code>CONNECTED</code> but you are having trouble using the custom key store, make sure that
|
|
1555
|
-
* its associated
|
|
1581
|
+
* its associated CloudHSM cluster is active and contains at least one active HSM.</p>
|
|
1556
1582
|
* <p>A value of <code>FAILED</code> indicates that an attempt to connect was unsuccessful. The
|
|
1557
1583
|
* <code>ConnectionErrorCode</code> field in the response indicates the cause of the failure.
|
|
1558
1584
|
* 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
|
|
1559
|
-
* <i>
|
|
1585
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1560
1586
|
*/
|
|
1561
1587
|
ConnectionState?: ConnectionStateType | string;
|
|
1562
1588
|
|
|
@@ -1564,70 +1590,70 @@ export interface CustomKeyStoresListEntry {
|
|
|
1564
1590
|
* <p>Describes the connection error. This field appears in the response only when the
|
|
1565
1591
|
* <code>ConnectionState</code> is <code>FAILED</code>. For help resolving these errors, see
|
|
1566
1592
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How to
|
|
1567
|
-
* Fix a Connection Failure</a> in <i>
|
|
1593
|
+
* Fix a Connection Failure</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
1568
1594
|
* <p>Valid values are:</p>
|
|
1569
1595
|
* <ul>
|
|
1570
1596
|
* <li>
|
|
1571
1597
|
* <p>
|
|
1572
|
-
* <code>CLUSTER_NOT_FOUND</code> -
|
|
1598
|
+
* <code>CLUSTER_NOT_FOUND</code> - KMS cannot find the CloudHSM cluster with the
|
|
1573
1599
|
* specified cluster ID.</p>
|
|
1574
1600
|
* </li>
|
|
1575
1601
|
* <li>
|
|
1576
1602
|
* <p>
|
|
1577
|
-
* <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated
|
|
1578
|
-
* contain any active HSMs. To connect a custom key store to its
|
|
1603
|
+
* <code>INSUFFICIENT_CLOUDHSM_HSMS</code> - The associated CloudHSM cluster does not
|
|
1604
|
+
* contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster
|
|
1579
1605
|
* must contain at least one active HSM.</p>
|
|
1580
1606
|
* </li>
|
|
1581
1607
|
* <li>
|
|
1582
1608
|
* <p>
|
|
1583
|
-
* <code>INTERNAL_ERROR</code> -
|
|
1609
|
+
* <code>INTERNAL_ERROR</code> - KMS could not complete the request due to an internal
|
|
1584
1610
|
* error. Retry the request. For <code>ConnectCustomKeyStore</code> requests, disconnect the
|
|
1585
1611
|
* custom key store before trying to connect again.</p>
|
|
1586
1612
|
* </li>
|
|
1587
1613
|
* <li>
|
|
1588
1614
|
* <p>
|
|
1589
|
-
* <code>INVALID_CREDENTIALS</code> -
|
|
1590
|
-
* <code>kmsuser</code> crypto user in the
|
|
1591
|
-
* custom key store to its
|
|
1615
|
+
* <code>INVALID_CREDENTIALS</code> - KMS does not have the correct password for the
|
|
1616
|
+
* <code>kmsuser</code> crypto user in the CloudHSM cluster. Before you can connect your
|
|
1617
|
+
* custom key store to its CloudHSM cluster, you must change the <code>kmsuser</code> account
|
|
1592
1618
|
* password and update the key store password value for the custom key store.</p>
|
|
1593
1619
|
* </li>
|
|
1594
1620
|
* <li>
|
|
1595
1621
|
* <p>
|
|
1596
|
-
* <code>NETWORK_ERRORS</code> - Network errors are preventing
|
|
1622
|
+
* <code>NETWORK_ERRORS</code> - Network errors are preventing KMS from connecting to
|
|
1597
1623
|
* the custom key store.</p>
|
|
1598
1624
|
* </li>
|
|
1599
1625
|
* <li>
|
|
1600
1626
|
* <p>
|
|
1601
|
-
* <code>SUBNET_NOT_FOUND</code> - A subnet in the
|
|
1602
|
-
* deleted. If
|
|
1603
|
-
* connect the custom key store to the
|
|
1627
|
+
* <code>SUBNET_NOT_FOUND</code> - A subnet in the CloudHSM cluster configuration was
|
|
1628
|
+
* deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to
|
|
1629
|
+
* connect the custom key store to the CloudHSM cluster fail. To fix this error, create a
|
|
1604
1630
|
* cluster from a recent backup and associate it with your custom key store. (This process
|
|
1605
1631
|
* creates a new cluster configuration with a VPC and private subnets.) For details, see
|
|
1606
1632
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed">How
|
|
1607
|
-
* to Fix a Connection Failure</a> in the <i>
|
|
1633
|
+
* to Fix a Connection Failure</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1608
1634
|
* </li>
|
|
1609
1635
|
* <li>
|
|
1610
1636
|
* <p>
|
|
1611
1637
|
* <code>USER_LOCKED_OUT</code> - The <code>kmsuser</code> CU account is locked out of
|
|
1612
|
-
* the associated
|
|
1613
|
-
* connect your custom key store to its
|
|
1638
|
+
* the associated CloudHSM cluster due to too many failed password attempts. Before you can
|
|
1639
|
+
* connect your custom key store to its CloudHSM cluster, you must change the
|
|
1614
1640
|
* <code>kmsuser</code> account password and update the key store password value for the
|
|
1615
1641
|
* custom key store.</p>
|
|
1616
1642
|
* </li>
|
|
1617
1643
|
* <li>
|
|
1618
1644
|
* <p>
|
|
1619
1645
|
* <code>USER_LOGGED_IN</code> - The <code>kmsuser</code> CU account is logged into the
|
|
1620
|
-
* the associated
|
|
1646
|
+
* the associated CloudHSM cluster. This prevents KMS from rotating the <code>kmsuser</code>
|
|
1621
1647
|
* account password and logging into the cluster. Before you can connect your custom key
|
|
1622
|
-
* store to its
|
|
1648
|
+
* store to its CloudHSM cluster, you must log the <code>kmsuser</code> CU out of the cluster.
|
|
1623
1649
|
* If you changed the <code>kmsuser</code> password to log into the cluster, you must also
|
|
1624
1650
|
* 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
|
|
1625
|
-
* and Reconnect</a> in the <i>
|
|
1651
|
+
* and Reconnect</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1626
1652
|
* </li>
|
|
1627
1653
|
* <li>
|
|
1628
1654
|
* <p>
|
|
1629
|
-
* <code>USER_NOT_FOUND</code> -
|
|
1630
|
-
* the associated
|
|
1655
|
+
* <code>USER_NOT_FOUND</code> - KMS cannot find a <code>kmsuser</code> CU account in
|
|
1656
|
+
* the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM
|
|
1631
1657
|
* cluster, you must create a <code>kmsuser</code> CU account in the cluster, and then update
|
|
1632
1658
|
* the key store password value for the custom key store.</p>
|
|
1633
1659
|
* </li>
|
|
@@ -1673,31 +1699,31 @@ export interface DecryptRequest {
|
|
|
1673
1699
|
|
|
1674
1700
|
/**
|
|
1675
1701
|
* <p>Specifies the encryption context to use when decrypting the data.
|
|
1676
|
-
* 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
|
|
1677
|
-
* <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
|
|
1702
|
+
* 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>
|
|
1703
|
+
* <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>
|
|
1678
1704
|
* <p>For more information, see
|
|
1679
1705
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1680
|
-
* Context</a> in the <i>
|
|
1706
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1681
1707
|
*/
|
|
1682
1708
|
EncryptionContext?: { [key: string]: string };
|
|
1683
1709
|
|
|
1684
1710
|
/**
|
|
1685
1711
|
* <p>A list of grant tokens. </p>
|
|
1686
|
-
* <p>Use a grant token when your permission to call this operation comes from a
|
|
1687
|
-
*
|
|
1688
|
-
* <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
1712
|
+
* <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
|
|
1713
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1689
1714
|
*/
|
|
1690
1715
|
GrantTokens?: string[];
|
|
1691
1716
|
|
|
1692
1717
|
/**
|
|
1693
|
-
* <p>Specifies the
|
|
1694
|
-
* key ID of the
|
|
1695
|
-
*
|
|
1696
|
-
*
|
|
1718
|
+
* <p>Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a
|
|
1719
|
+
* key ID of the KMS key that was used to encrypt the ciphertext. </p>
|
|
1720
|
+
*
|
|
1721
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
1722
|
+
* If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the
|
|
1697
1723
|
* symmetric ciphertext blob. However, it is always recommended as a best practice. This practice
|
|
1698
|
-
* ensures that you use the
|
|
1724
|
+
* ensures that you use the KMS key that you intend.</p>
|
|
1699
1725
|
*
|
|
1700
|
-
* <p>To specify a
|
|
1726
|
+
* <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>
|
|
1701
1727
|
* <p>For example:</p>
|
|
1702
1728
|
* <ul>
|
|
1703
1729
|
* <li>
|
|
@@ -1717,7 +1743,7 @@ export interface DecryptRequest {
|
|
|
1717
1743
|
* </p>
|
|
1718
1744
|
* </li>
|
|
1719
1745
|
* </ul>
|
|
1720
|
-
* <p>To get the key ID and key ARN for a
|
|
1746
|
+
* <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>
|
|
1721
1747
|
*/
|
|
1722
1748
|
KeyId?: string;
|
|
1723
1749
|
|
|
@@ -1725,9 +1751,9 @@ export interface DecryptRequest {
|
|
|
1725
1751
|
* <p>Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify
|
|
1726
1752
|
* the same algorithm that was used to encrypt the data. If you specify a different algorithm,
|
|
1727
1753
|
* the <code>Decrypt</code> operation fails.</p>
|
|
1728
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
1754
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
1729
1755
|
* The default value, <code>SYMMETRIC_DEFAULT</code>, represents the only supported algorithm
|
|
1730
|
-
* that is valid for symmetric
|
|
1756
|
+
* that is valid for symmetric KMS keys.</p>
|
|
1731
1757
|
*/
|
|
1732
1758
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
1733
1759
|
}
|
|
@@ -1743,12 +1769,12 @@ export namespace DecryptRequest {
|
|
|
1743
1769
|
|
|
1744
1770
|
export interface DecryptResponse {
|
|
1745
1771
|
/**
|
|
1746
|
-
* <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
|
|
1772
|
+
* <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>
|
|
1747
1773
|
*/
|
|
1748
1774
|
KeyId?: string;
|
|
1749
1775
|
|
|
1750
1776
|
/**
|
|
1751
|
-
* <p>Decrypted plaintext data. When you use the HTTP API or the
|
|
1777
|
+
* <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>
|
|
1752
1778
|
*/
|
|
1753
1779
|
Plaintext?: Uint8Array;
|
|
1754
1780
|
|
|
@@ -1769,9 +1795,9 @@ export namespace DecryptResponse {
|
|
|
1769
1795
|
}
|
|
1770
1796
|
|
|
1771
1797
|
/**
|
|
1772
|
-
* <p>The request was rejected because the specified
|
|
1798
|
+
* <p>The request was rejected because the specified KMS key cannot decrypt the data. The
|
|
1773
1799
|
* <code>KeyId</code> in a <a>Decrypt</a> request and the <code>SourceKeyId</code>
|
|
1774
|
-
* in a <a>ReEncrypt</a> request must identify the same
|
|
1800
|
+
* in a <a>ReEncrypt</a> request must identify the same KMS key that was used to encrypt
|
|
1775
1801
|
* the ciphertext.</p>
|
|
1776
1802
|
*/
|
|
1777
1803
|
export interface IncorrectKeyException extends __SmithyException, $MetadataBearer {
|
|
@@ -1795,7 +1821,7 @@ export namespace IncorrectKeyException {
|
|
|
1795
1821
|
* into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise
|
|
1796
1822
|
* invalid.</p>
|
|
1797
1823
|
* <p>From the <a>ImportKeyMaterial</a> operation, the request was rejected because
|
|
1798
|
-
*
|
|
1824
|
+
* KMS could not decrypt the encrypted (wrapped) key material. </p>
|
|
1799
1825
|
*/
|
|
1800
1826
|
export interface InvalidCiphertextException extends __SmithyException, $MetadataBearer {
|
|
1801
1827
|
name: "InvalidCiphertextException";
|
|
@@ -1816,20 +1842,20 @@ export namespace InvalidCiphertextException {
|
|
|
1816
1842
|
* <p>The request was rejected for one of the following reasons: </p>
|
|
1817
1843
|
* <ul>
|
|
1818
1844
|
* <li>
|
|
1819
|
-
* <p>The <code>KeyUsage</code> value of the
|
|
1845
|
+
* <p>The <code>KeyUsage</code> value of the KMS key is incompatible with the API
|
|
1820
1846
|
* operation.</p>
|
|
1821
1847
|
* </li>
|
|
1822
1848
|
* <li>
|
|
1823
1849
|
* <p>The encryption algorithm or signing algorithm specified for the operation is
|
|
1824
|
-
* incompatible with the type of key material in the
|
|
1825
|
-
* <code>(
|
|
1850
|
+
* incompatible with the type of key material in the KMS key
|
|
1851
|
+
* <code>(KeySpec</code>).</p>
|
|
1826
1852
|
* </li>
|
|
1827
1853
|
* </ul>
|
|
1828
1854
|
* <p>For encrypting, decrypting, re-encrypting, and generating data keys, the
|
|
1829
1855
|
* <code>KeyUsage</code> must be <code>ENCRYPT_DECRYPT</code>. For signing and verifying, the
|
|
1830
1856
|
* <code>KeyUsage</code> must be <code>SIGN_VERIFY</code>. To find the <code>KeyUsage</code> of
|
|
1831
|
-
* a
|
|
1832
|
-
* <p>To find the encryption or signing algorithms supported for a particular
|
|
1857
|
+
* a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1858
|
+
* <p>To find the encryption or signing algorithms supported for a particular KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1833
1859
|
*/
|
|
1834
1860
|
export interface InvalidKeyUsageException extends __SmithyException, $MetadataBearer {
|
|
1835
1861
|
name: "InvalidKeyUsageException";
|
|
@@ -1847,7 +1873,7 @@ export namespace InvalidKeyUsageException {
|
|
|
1847
1873
|
}
|
|
1848
1874
|
|
|
1849
1875
|
/**
|
|
1850
|
-
* <p>The request was rejected because the specified
|
|
1876
|
+
* <p>The request was rejected because the specified KMS key was not available. You can retry the
|
|
1851
1877
|
* request.</p>
|
|
1852
1878
|
*/
|
|
1853
1879
|
export interface KeyUnavailableException extends __SmithyException, $MetadataBearer {
|
|
@@ -1911,9 +1937,9 @@ export namespace DeleteCustomKeyStoreResponse {
|
|
|
1911
1937
|
|
|
1912
1938
|
export interface DeleteImportedKeyMaterialRequest {
|
|
1913
1939
|
/**
|
|
1914
|
-
* <p>Identifies the
|
|
1915
|
-
* <code>Origin</code> of the
|
|
1916
|
-
* <p>Specify the key ID or key ARN of the
|
|
1940
|
+
* <p>Identifies the KMS key from which you are deleting imported key material. The
|
|
1941
|
+
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
1942
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
1917
1943
|
* <p>For example:</p>
|
|
1918
1944
|
* <ul>
|
|
1919
1945
|
* <li>
|
|
@@ -1925,7 +1951,7 @@ export interface DeleteImportedKeyMaterialRequest {
|
|
|
1925
1951
|
* </p>
|
|
1926
1952
|
* </li>
|
|
1927
1953
|
* </ul>
|
|
1928
|
-
* <p>To get the key ID and key ARN for a
|
|
1954
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
1929
1955
|
*/
|
|
1930
1956
|
KeyId: string | undefined;
|
|
1931
1957
|
}
|
|
@@ -1961,7 +1987,7 @@ export interface DescribeCustomKeyStoresRequest {
|
|
|
1961
1987
|
|
|
1962
1988
|
/**
|
|
1963
1989
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
1964
|
-
* value is present,
|
|
1990
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
1965
1991
|
* return fewer.</p>
|
|
1966
1992
|
*/
|
|
1967
1993
|
Limit?: number;
|
|
@@ -2034,12 +2060,11 @@ export namespace InvalidMarkerException {
|
|
|
2034
2060
|
|
|
2035
2061
|
export interface DescribeKeyRequest {
|
|
2036
2062
|
/**
|
|
2037
|
-
* <p>Describes the specified
|
|
2038
|
-
* <p>If you specify a predefined
|
|
2039
|
-
* alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html
|
|
2040
|
-
* managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the
|
|
2063
|
+
* <p>Describes the specified KMS key. </p>
|
|
2064
|
+
* <p>If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the
|
|
2065
|
+
* 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
|
|
2041
2066
|
* response.</p>
|
|
2042
|
-
* <p>To specify a
|
|
2067
|
+
* <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>
|
|
2043
2068
|
* <p>For example:</p>
|
|
2044
2069
|
* <ul>
|
|
2045
2070
|
* <li>
|
|
@@ -2059,14 +2084,14 @@ export interface DescribeKeyRequest {
|
|
|
2059
2084
|
* </p>
|
|
2060
2085
|
* </li>
|
|
2061
2086
|
* </ul>
|
|
2062
|
-
* <p>To get the key ID and key ARN for a
|
|
2087
|
+
* <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>
|
|
2063
2088
|
*/
|
|
2064
2089
|
KeyId: string | undefined;
|
|
2065
2090
|
|
|
2066
2091
|
/**
|
|
2067
2092
|
* <p>A list of grant tokens.</p>
|
|
2068
|
-
* <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/
|
|
2069
|
-
* <i>
|
|
2093
|
+
* <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
|
|
2094
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2070
2095
|
*/
|
|
2071
2096
|
GrantTokens?: string[];
|
|
2072
2097
|
}
|
|
@@ -2098,8 +2123,8 @@ export namespace DescribeKeyResponse {
|
|
|
2098
2123
|
|
|
2099
2124
|
export interface DisableKeyRequest {
|
|
2100
2125
|
/**
|
|
2101
|
-
* <p>Identifies the
|
|
2102
|
-
* <p>Specify the key ID or key ARN of the
|
|
2126
|
+
* <p>Identifies the KMS key to disable.</p>
|
|
2127
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2103
2128
|
* <p>For example:</p>
|
|
2104
2129
|
* <ul>
|
|
2105
2130
|
* <li>
|
|
@@ -2111,7 +2136,7 @@ export interface DisableKeyRequest {
|
|
|
2111
2136
|
* </p>
|
|
2112
2137
|
* </li>
|
|
2113
2138
|
* </ul>
|
|
2114
|
-
* <p>To get the key ID and key ARN for a
|
|
2139
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2115
2140
|
*/
|
|
2116
2141
|
KeyId: string | undefined;
|
|
2117
2142
|
}
|
|
@@ -2127,11 +2152,11 @@ export namespace DisableKeyRequest {
|
|
|
2127
2152
|
|
|
2128
2153
|
export interface DisableKeyRotationRequest {
|
|
2129
2154
|
/**
|
|
2130
|
-
* <p>Identifies a symmetric
|
|
2131
|
-
* rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric
|
|
2155
|
+
* <p>Identifies a symmetric KMS key. You cannot enable or disable automatic
|
|
2156
|
+
* rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys
|
|
2132
2157
|
* with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key
|
|
2133
|
-
* material</a>, or
|
|
2134
|
-
* <p>Specify the key ID or key ARN of the
|
|
2158
|
+
* 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>
|
|
2159
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2135
2160
|
* <p>For example:</p>
|
|
2136
2161
|
* <ul>
|
|
2137
2162
|
* <li>
|
|
@@ -2143,7 +2168,7 @@ export interface DisableKeyRotationRequest {
|
|
|
2143
2168
|
* </p>
|
|
2144
2169
|
* </li>
|
|
2145
2170
|
* </ul>
|
|
2146
|
-
* <p>To get the key ID and key ARN for a
|
|
2171
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2147
2172
|
*/
|
|
2148
2173
|
KeyId: string | undefined;
|
|
2149
2174
|
}
|
|
@@ -2186,8 +2211,8 @@ export namespace DisconnectCustomKeyStoreResponse {
|
|
|
2186
2211
|
|
|
2187
2212
|
export interface EnableKeyRequest {
|
|
2188
2213
|
/**
|
|
2189
|
-
* <p>Identifies the
|
|
2190
|
-
* <p>Specify the key ID or key ARN of the
|
|
2214
|
+
* <p>Identifies the KMS key to enable.</p>
|
|
2215
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2191
2216
|
* <p>For example:</p>
|
|
2192
2217
|
* <ul>
|
|
2193
2218
|
* <li>
|
|
@@ -2199,7 +2224,7 @@ export interface EnableKeyRequest {
|
|
|
2199
2224
|
* </p>
|
|
2200
2225
|
* </li>
|
|
2201
2226
|
* </ul>
|
|
2202
|
-
* <p>To get the key ID and key ARN for a
|
|
2227
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2203
2228
|
*/
|
|
2204
2229
|
KeyId: string | undefined;
|
|
2205
2230
|
}
|
|
@@ -2215,9 +2240,9 @@ export namespace EnableKeyRequest {
|
|
|
2215
2240
|
|
|
2216
2241
|
export interface EnableKeyRotationRequest {
|
|
2217
2242
|
/**
|
|
2218
|
-
* <p>Identifies a symmetric
|
|
2243
|
+
* <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>
|
|
2219
2244
|
*
|
|
2220
|
-
* <p>Specify the key ID or key ARN of the
|
|
2245
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2221
2246
|
* <p>For example:</p>
|
|
2222
2247
|
* <ul>
|
|
2223
2248
|
* <li>
|
|
@@ -2229,7 +2254,7 @@ export interface EnableKeyRotationRequest {
|
|
|
2229
2254
|
* </p>
|
|
2230
2255
|
* </li>
|
|
2231
2256
|
* </ul>
|
|
2232
|
-
* <p>To get the key ID and key ARN for a
|
|
2257
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2233
2258
|
*/
|
|
2234
2259
|
KeyId: string | undefined;
|
|
2235
2260
|
}
|
|
@@ -2245,8 +2270,8 @@ export namespace EnableKeyRotationRequest {
|
|
|
2245
2270
|
|
|
2246
2271
|
export interface EncryptRequest {
|
|
2247
2272
|
/**
|
|
2248
|
-
* <p>Identifies the
|
|
2249
|
-
* <p>To specify a
|
|
2273
|
+
* <p>Identifies the KMS key to use in the encryption operation.</p>
|
|
2274
|
+
* <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>
|
|
2250
2275
|
* <p>For example:</p>
|
|
2251
2276
|
* <ul>
|
|
2252
2277
|
* <li>
|
|
@@ -2266,7 +2291,7 @@ export interface EncryptRequest {
|
|
|
2266
2291
|
* </p>
|
|
2267
2292
|
* </li>
|
|
2268
2293
|
* </ul>
|
|
2269
|
-
* <p>To get the key ID and key ARN for a
|
|
2294
|
+
* <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>
|
|
2270
2295
|
*/
|
|
2271
2296
|
KeyId: string | undefined;
|
|
2272
2297
|
|
|
@@ -2277,27 +2302,27 @@ export interface EncryptRequest {
|
|
|
2277
2302
|
|
|
2278
2303
|
/**
|
|
2279
2304
|
* <p>Specifies the encryption context that will be used to encrypt the data.
|
|
2280
|
-
* 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
|
|
2281
|
-
* <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
|
|
2305
|
+
* 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>
|
|
2306
|
+
* <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>
|
|
2282
2307
|
* <p>For more information, see
|
|
2283
2308
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2284
|
-
* Context</a> in the <i>
|
|
2309
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2285
2310
|
*/
|
|
2286
2311
|
EncryptionContext?: { [key: string]: string };
|
|
2287
2312
|
|
|
2288
2313
|
/**
|
|
2289
2314
|
* <p>A list of grant tokens.</p>
|
|
2290
|
-
* <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/
|
|
2291
|
-
* <i>
|
|
2315
|
+
* <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
|
|
2316
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2292
2317
|
*/
|
|
2293
2318
|
GrantTokens?: string[];
|
|
2294
2319
|
|
|
2295
2320
|
/**
|
|
2296
|
-
* <p>Specifies the encryption algorithm that
|
|
2297
|
-
* The algorithm must be compatible with the
|
|
2298
|
-
* <p>This parameter is required only for asymmetric
|
|
2299
|
-
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric
|
|
2300
|
-
* an asymmetric
|
|
2321
|
+
* <p>Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.
|
|
2322
|
+
* The algorithm must be compatible with the KMS key that you specify.</p>
|
|
2323
|
+
* <p>This parameter is required only for asymmetric KMS keys. The default value,
|
|
2324
|
+
* <code>SYMMETRIC_DEFAULT</code>, is the algorithm used for symmetric KMS keys. If you are using
|
|
2325
|
+
* an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.</p>
|
|
2301
2326
|
*/
|
|
2302
2327
|
EncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
2303
2328
|
}
|
|
@@ -2314,12 +2339,12 @@ export namespace EncryptRequest {
|
|
|
2314
2339
|
|
|
2315
2340
|
export interface EncryptResponse {
|
|
2316
2341
|
/**
|
|
2317
|
-
* <p>The encrypted plaintext. When you use the HTTP API or the
|
|
2342
|
+
* <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>
|
|
2318
2343
|
*/
|
|
2319
2344
|
CiphertextBlob?: Uint8Array;
|
|
2320
2345
|
|
|
2321
2346
|
/**
|
|
2322
|
-
* <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
|
|
2347
|
+
* <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>
|
|
2323
2348
|
*/
|
|
2324
2349
|
KeyId?: string;
|
|
2325
2350
|
|
|
@@ -2359,9 +2384,9 @@ export namespace ExpiredImportTokenException {
|
|
|
2359
2384
|
|
|
2360
2385
|
export interface GenerateDataKeyRequest {
|
|
2361
2386
|
/**
|
|
2362
|
-
* <p>Identifies the symmetric
|
|
2387
|
+
* <p>Identifies the symmetric KMS key that encrypts the data key.</p>
|
|
2363
2388
|
*
|
|
2364
|
-
* <p>To specify a
|
|
2389
|
+
* <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>
|
|
2365
2390
|
* <p>For example:</p>
|
|
2366
2391
|
* <ul>
|
|
2367
2392
|
* <li>
|
|
@@ -2381,16 +2406,16 @@ export interface GenerateDataKeyRequest {
|
|
|
2381
2406
|
* </p>
|
|
2382
2407
|
* </li>
|
|
2383
2408
|
* </ul>
|
|
2384
|
-
* <p>To get the key ID and key ARN for a
|
|
2409
|
+
* <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>
|
|
2385
2410
|
*/
|
|
2386
2411
|
KeyId: string | undefined;
|
|
2387
2412
|
|
|
2388
2413
|
/**
|
|
2389
2414
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
2390
|
-
* <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
|
|
2415
|
+
* <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>
|
|
2391
2416
|
* <p>For more information, see
|
|
2392
2417
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2393
|
-
* Context</a> in the <i>
|
|
2418
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2394
2419
|
*/
|
|
2395
2420
|
EncryptionContext?: { [key: string]: string };
|
|
2396
2421
|
|
|
@@ -2413,8 +2438,8 @@ export interface GenerateDataKeyRequest {
|
|
|
2413
2438
|
|
|
2414
2439
|
/**
|
|
2415
2440
|
* <p>A list of grant tokens.</p>
|
|
2416
|
-
* <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/
|
|
2417
|
-
* <i>
|
|
2441
|
+
* <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
|
|
2442
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2418
2443
|
*/
|
|
2419
2444
|
GrantTokens?: string[];
|
|
2420
2445
|
}
|
|
@@ -2430,18 +2455,18 @@ export namespace GenerateDataKeyRequest {
|
|
|
2430
2455
|
|
|
2431
2456
|
export interface GenerateDataKeyResponse {
|
|
2432
2457
|
/**
|
|
2433
|
-
* <p>The encrypted copy of the data key. When you use the HTTP API or the
|
|
2458
|
+
* <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>
|
|
2434
2459
|
*/
|
|
2435
2460
|
CiphertextBlob?: Uint8Array;
|
|
2436
2461
|
|
|
2437
2462
|
/**
|
|
2438
|
-
* <p>The plaintext data key. When you use the HTTP API or the
|
|
2463
|
+
* <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
|
|
2439
2464
|
* KMS. Then, remove it from memory as soon as possible.</p>
|
|
2440
2465
|
*/
|
|
2441
2466
|
Plaintext?: Uint8Array;
|
|
2442
2467
|
|
|
2443
2468
|
/**
|
|
2444
|
-
* <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
|
|
2469
|
+
* <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>
|
|
2445
2470
|
*/
|
|
2446
2471
|
KeyId?: string;
|
|
2447
2472
|
}
|
|
@@ -2460,19 +2485,18 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2460
2485
|
/**
|
|
2461
2486
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
2462
2487
|
* data key pair.</p>
|
|
2463
|
-
* <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
|
|
2488
|
+
* <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>
|
|
2464
2489
|
* <p>For more information, see
|
|
2465
2490
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2466
|
-
* Context</a> in the <i>
|
|
2491
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2467
2492
|
*/
|
|
2468
2493
|
EncryptionContext?: { [key: string]: string };
|
|
2469
2494
|
|
|
2470
2495
|
/**
|
|
2471
|
-
* <p>Specifies the symmetric
|
|
2472
|
-
* specify an asymmetric
|
|
2473
|
-
* CMK, use the <a>DescribeKey</a> operation.</p>
|
|
2496
|
+
* <p>Specifies the symmetric KMS key that encrypts the private key in the data key pair. You cannot
|
|
2497
|
+
* 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>
|
|
2474
2498
|
*
|
|
2475
|
-
* <p>To specify a
|
|
2499
|
+
* <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>
|
|
2476
2500
|
* <p>For example:</p>
|
|
2477
2501
|
* <ul>
|
|
2478
2502
|
* <li>
|
|
@@ -2492,20 +2516,20 @@ export interface GenerateDataKeyPairRequest {
|
|
|
2492
2516
|
* </p>
|
|
2493
2517
|
* </li>
|
|
2494
2518
|
* </ul>
|
|
2495
|
-
* <p>To get the key ID and key ARN for a
|
|
2519
|
+
* <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>
|
|
2496
2520
|
*/
|
|
2497
2521
|
KeyId: string | undefined;
|
|
2498
2522
|
|
|
2499
2523
|
/**
|
|
2500
2524
|
* <p>Determines the type of data key pair that is generated. </p>
|
|
2501
|
-
* <p>The
|
|
2525
|
+
* <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>
|
|
2502
2526
|
*/
|
|
2503
2527
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
2504
2528
|
|
|
2505
2529
|
/**
|
|
2506
2530
|
* <p>A list of grant tokens.</p>
|
|
2507
|
-
* <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/
|
|
2508
|
-
* <i>
|
|
2531
|
+
* <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
|
|
2532
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2509
2533
|
*/
|
|
2510
2534
|
GrantTokens?: string[];
|
|
2511
2535
|
}
|
|
@@ -2521,12 +2545,12 @@ export namespace GenerateDataKeyPairRequest {
|
|
|
2521
2545
|
|
|
2522
2546
|
export interface GenerateDataKeyPairResponse {
|
|
2523
2547
|
/**
|
|
2524
|
-
* <p>The encrypted copy of the private key. When you use the HTTP API or the
|
|
2548
|
+
* <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>
|
|
2525
2549
|
*/
|
|
2526
2550
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
2527
2551
|
|
|
2528
2552
|
/**
|
|
2529
|
-
* <p>The plaintext copy of the private key. When you use the HTTP API or the
|
|
2553
|
+
* <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>
|
|
2530
2554
|
*/
|
|
2531
2555
|
PrivateKeyPlaintext?: Uint8Array;
|
|
2532
2556
|
|
|
@@ -2536,7 +2560,7 @@ export interface GenerateDataKeyPairResponse {
|
|
|
2536
2560
|
PublicKey?: Uint8Array;
|
|
2537
2561
|
|
|
2538
2562
|
/**
|
|
2539
|
-
* <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
|
|
2563
|
+
* <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>
|
|
2540
2564
|
*/
|
|
2541
2565
|
KeyId?: string;
|
|
2542
2566
|
|
|
@@ -2560,18 +2584,18 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2560
2584
|
/**
|
|
2561
2585
|
* <p>Specifies the encryption context that will be used when encrypting the private key in the
|
|
2562
2586
|
* data key pair.</p>
|
|
2563
|
-
* <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
|
|
2587
|
+
* <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>
|
|
2564
2588
|
* <p>For more information, see
|
|
2565
2589
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2566
|
-
* Context</a> in the <i>
|
|
2590
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2567
2591
|
*/
|
|
2568
2592
|
EncryptionContext?: { [key: string]: string };
|
|
2569
2593
|
|
|
2570
2594
|
/**
|
|
2571
|
-
* <p>Specifies the
|
|
2572
|
-
* symmetric
|
|
2573
|
-
* type and origin of your
|
|
2574
|
-
* <p>To specify a
|
|
2595
|
+
* <p>Specifies the KMS key that encrypts the private key in the data key pair. You must specify a
|
|
2596
|
+
* symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the
|
|
2597
|
+
* type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
2598
|
+
* <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>
|
|
2575
2599
|
* <p>For example:</p>
|
|
2576
2600
|
* <ul>
|
|
2577
2601
|
* <li>
|
|
@@ -2591,20 +2615,20 @@ export interface GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2591
2615
|
* </p>
|
|
2592
2616
|
* </li>
|
|
2593
2617
|
* </ul>
|
|
2594
|
-
* <p>To get the key ID and key ARN for a
|
|
2618
|
+
* <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>
|
|
2595
2619
|
*/
|
|
2596
2620
|
KeyId: string | undefined;
|
|
2597
2621
|
|
|
2598
2622
|
/**
|
|
2599
2623
|
* <p>Determines the type of data key pair that is generated.</p>
|
|
2600
|
-
* <p>The
|
|
2624
|
+
* <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>
|
|
2601
2625
|
*/
|
|
2602
2626
|
KeyPairSpec: DataKeyPairSpec | string | undefined;
|
|
2603
2627
|
|
|
2604
2628
|
/**
|
|
2605
2629
|
* <p>A list of grant tokens.</p>
|
|
2606
|
-
* <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/
|
|
2607
|
-
* <i>
|
|
2630
|
+
* <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
|
|
2631
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2608
2632
|
*/
|
|
2609
2633
|
GrantTokens?: string[];
|
|
2610
2634
|
}
|
|
@@ -2620,7 +2644,7 @@ export namespace GenerateDataKeyPairWithoutPlaintextRequest {
|
|
|
2620
2644
|
|
|
2621
2645
|
export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
2622
2646
|
/**
|
|
2623
|
-
* <p>The encrypted copy of the private key. When you use the HTTP API or the
|
|
2647
|
+
* <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>
|
|
2624
2648
|
*/
|
|
2625
2649
|
PrivateKeyCiphertextBlob?: Uint8Array;
|
|
2626
2650
|
|
|
@@ -2630,7 +2654,7 @@ export interface GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
2630
2654
|
PublicKey?: Uint8Array;
|
|
2631
2655
|
|
|
2632
2656
|
/**
|
|
2633
|
-
* <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
|
|
2657
|
+
* <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>
|
|
2634
2658
|
*/
|
|
2635
2659
|
KeyId?: string;
|
|
2636
2660
|
|
|
@@ -2651,9 +2675,9 @@ export namespace GenerateDataKeyPairWithoutPlaintextResponse {
|
|
|
2651
2675
|
|
|
2652
2676
|
export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
2653
2677
|
/**
|
|
2654
|
-
* <p>The identifier of the symmetric
|
|
2678
|
+
* <p>The identifier of the symmetric KMS key that encrypts the data
|
|
2655
2679
|
* key.</p>
|
|
2656
|
-
* <p>To specify a
|
|
2680
|
+
* <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>
|
|
2657
2681
|
* <p>For example:</p>
|
|
2658
2682
|
* <ul>
|
|
2659
2683
|
* <li>
|
|
@@ -2673,16 +2697,16 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2673
2697
|
* </p>
|
|
2674
2698
|
* </li>
|
|
2675
2699
|
* </ul>
|
|
2676
|
-
* <p>To get the key ID and key ARN for a
|
|
2700
|
+
* <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>
|
|
2677
2701
|
*/
|
|
2678
2702
|
KeyId: string | undefined;
|
|
2679
2703
|
|
|
2680
2704
|
/**
|
|
2681
2705
|
* <p>Specifies the encryption context that will be used when encrypting the data key.</p>
|
|
2682
|
-
* <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
|
|
2706
|
+
* <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>
|
|
2683
2707
|
* <p>For more information, see
|
|
2684
2708
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
2685
|
-
* Context</a> in the <i>
|
|
2709
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2686
2710
|
*/
|
|
2687
2711
|
EncryptionContext?: { [key: string]: string };
|
|
2688
2712
|
|
|
@@ -2701,8 +2725,8 @@ export interface GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2701
2725
|
|
|
2702
2726
|
/**
|
|
2703
2727
|
* <p>A list of grant tokens.</p>
|
|
2704
|
-
* <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/
|
|
2705
|
-
* <i>
|
|
2728
|
+
* <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
|
|
2729
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2706
2730
|
*/
|
|
2707
2731
|
GrantTokens?: string[];
|
|
2708
2732
|
}
|
|
@@ -2718,12 +2742,12 @@ export namespace GenerateDataKeyWithoutPlaintextRequest {
|
|
|
2718
2742
|
|
|
2719
2743
|
export interface GenerateDataKeyWithoutPlaintextResponse {
|
|
2720
2744
|
/**
|
|
2721
|
-
* <p>The encrypted data key. When you use the HTTP API or the
|
|
2745
|
+
* <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>
|
|
2722
2746
|
*/
|
|
2723
2747
|
CiphertextBlob?: Uint8Array;
|
|
2724
2748
|
|
|
2725
2749
|
/**
|
|
2726
|
-
* <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
|
|
2750
|
+
* <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>
|
|
2727
2751
|
*/
|
|
2728
2752
|
KeyId?: string;
|
|
2729
2753
|
}
|
|
@@ -2744,7 +2768,7 @@ export interface GenerateRandomRequest {
|
|
|
2744
2768
|
NumberOfBytes?: number;
|
|
2745
2769
|
|
|
2746
2770
|
/**
|
|
2747
|
-
* <p>Generates the random byte string in the
|
|
2771
|
+
* <p>Generates the random byte string in the CloudHSM cluster that is associated with the
|
|
2748
2772
|
* 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>
|
|
2749
2773
|
*/
|
|
2750
2774
|
CustomKeyStoreId?: string;
|
|
@@ -2761,7 +2785,7 @@ export namespace GenerateRandomRequest {
|
|
|
2761
2785
|
|
|
2762
2786
|
export interface GenerateRandomResponse {
|
|
2763
2787
|
/**
|
|
2764
|
-
* <p>The random byte string. When you use the HTTP API or the
|
|
2788
|
+
* <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>
|
|
2765
2789
|
*/
|
|
2766
2790
|
Plaintext?: Uint8Array;
|
|
2767
2791
|
}
|
|
@@ -2778,8 +2802,8 @@ export namespace GenerateRandomResponse {
|
|
|
2778
2802
|
|
|
2779
2803
|
export interface GetKeyPolicyRequest {
|
|
2780
2804
|
/**
|
|
2781
|
-
* <p>Gets the key policy for the specified
|
|
2782
|
-
* <p>Specify the key ID or key ARN of the
|
|
2805
|
+
* <p>Gets the key policy for the specified KMS key.</p>
|
|
2806
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2783
2807
|
* <p>For example:</p>
|
|
2784
2808
|
* <ul>
|
|
2785
2809
|
* <li>
|
|
@@ -2791,7 +2815,7 @@ export interface GetKeyPolicyRequest {
|
|
|
2791
2815
|
* </p>
|
|
2792
2816
|
* </li>
|
|
2793
2817
|
* </ul>
|
|
2794
|
-
* <p>To get the key ID and key ARN for a
|
|
2818
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2795
2819
|
*/
|
|
2796
2820
|
KeyId: string | undefined;
|
|
2797
2821
|
|
|
@@ -2829,9 +2853,9 @@ export namespace GetKeyPolicyResponse {
|
|
|
2829
2853
|
|
|
2830
2854
|
export interface GetKeyRotationStatusRequest {
|
|
2831
2855
|
/**
|
|
2832
|
-
* <p>Gets the rotation status for the specified
|
|
2833
|
-
* <p>Specify the key ID or key ARN of the
|
|
2834
|
-
* different
|
|
2856
|
+
* <p>Gets the rotation status for the specified KMS key.</p>
|
|
2857
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
2858
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
2835
2859
|
* <p>For example:</p>
|
|
2836
2860
|
* <ul>
|
|
2837
2861
|
* <li>
|
|
@@ -2843,7 +2867,7 @@ export interface GetKeyRotationStatusRequest {
|
|
|
2843
2867
|
* </p>
|
|
2844
2868
|
* </li>
|
|
2845
2869
|
* </ul>
|
|
2846
|
-
* <p>To get the key ID and key ARN for a
|
|
2870
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2847
2871
|
*/
|
|
2848
2872
|
KeyId: string | undefined;
|
|
2849
2873
|
}
|
|
@@ -2879,9 +2903,9 @@ export enum WrappingKeySpec {
|
|
|
2879
2903
|
|
|
2880
2904
|
export interface GetParametersForImportRequest {
|
|
2881
2905
|
/**
|
|
2882
|
-
* <p>The identifier of the symmetric
|
|
2883
|
-
* <code>Origin</code> of the
|
|
2884
|
-
* <p>Specify the key ID or key ARN of the
|
|
2906
|
+
* <p>The identifier of the symmetric KMS key into which you will import key material. The
|
|
2907
|
+
* <code>Origin</code> of the KMS key must be <code>EXTERNAL</code>.</p>
|
|
2908
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
2885
2909
|
* <p>For example:</p>
|
|
2886
2910
|
* <ul>
|
|
2887
2911
|
* <li>
|
|
@@ -2893,13 +2917,13 @@ export interface GetParametersForImportRequest {
|
|
|
2893
2917
|
* </p>
|
|
2894
2918
|
* </li>
|
|
2895
2919
|
* </ul>
|
|
2896
|
-
* <p>To get the key ID and key ARN for a
|
|
2920
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
2897
2921
|
*/
|
|
2898
2922
|
KeyId: string | undefined;
|
|
2899
2923
|
|
|
2900
2924
|
/**
|
|
2901
2925
|
* <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>
|
|
2902
|
-
* in the <i>
|
|
2926
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2903
2927
|
*/
|
|
2904
2928
|
WrappingAlgorithm: AlgorithmSpec | string | undefined;
|
|
2905
2929
|
|
|
@@ -2921,8 +2945,8 @@ export namespace GetParametersForImportRequest {
|
|
|
2921
2945
|
|
|
2922
2946
|
export interface GetParametersForImportResponse {
|
|
2923
2947
|
/**
|
|
2924
|
-
* <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
|
|
2925
|
-
* request. This is the same
|
|
2948
|
+
* <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>
|
|
2949
|
+
* request. This is the same KMS key specified in the <code>GetParametersForImport</code>
|
|
2926
2950
|
* request.</p>
|
|
2927
2951
|
*/
|
|
2928
2952
|
KeyId?: string;
|
|
@@ -2958,9 +2982,9 @@ export namespace GetParametersForImportResponse {
|
|
|
2958
2982
|
|
|
2959
2983
|
export interface GetPublicKeyRequest {
|
|
2960
2984
|
/**
|
|
2961
|
-
* <p>Identifies the asymmetric
|
|
2985
|
+
* <p>Identifies the asymmetric KMS key that includes the public key.</p>
|
|
2962
2986
|
*
|
|
2963
|
-
* <p>To specify a
|
|
2987
|
+
* <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>
|
|
2964
2988
|
* <p>For example:</p>
|
|
2965
2989
|
* <ul>
|
|
2966
2990
|
* <li>
|
|
@@ -2980,14 +3004,14 @@ export interface GetPublicKeyRequest {
|
|
|
2980
3004
|
* </p>
|
|
2981
3005
|
* </li>
|
|
2982
3006
|
* </ul>
|
|
2983
|
-
* <p>To get the key ID and key ARN for a
|
|
3007
|
+
* <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>
|
|
2984
3008
|
*/
|
|
2985
3009
|
KeyId: string | undefined;
|
|
2986
3010
|
|
|
2987
3011
|
/**
|
|
2988
3012
|
* <p>A list of grant tokens.</p>
|
|
2989
|
-
* <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/
|
|
2990
|
-
* <i>
|
|
3013
|
+
* <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
|
|
3014
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2991
3015
|
*/
|
|
2992
3016
|
GrantTokens?: string[];
|
|
2993
3017
|
}
|
|
@@ -3003,34 +3027,42 @@ export namespace GetPublicKeyRequest {
|
|
|
3003
3027
|
|
|
3004
3028
|
export interface GetPublicKeyResponse {
|
|
3005
3029
|
/**
|
|
3006
|
-
* <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
|
|
3030
|
+
* <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>
|
|
3007
3031
|
*/
|
|
3008
3032
|
KeyId?: string;
|
|
3009
3033
|
|
|
3010
3034
|
/**
|
|
3011
3035
|
* <p>The exported public key. </p>
|
|
3012
3036
|
* <p>The value is a DER-encoded X.509 public key, also known as
|
|
3013
|
-
* <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
|
|
3037
|
+
* <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>
|
|
3014
3038
|
* <p></p>
|
|
3015
3039
|
*/
|
|
3016
3040
|
PublicKey?: Uint8Array;
|
|
3017
3041
|
|
|
3018
3042
|
/**
|
|
3019
|
-
*
|
|
3043
|
+
* @deprecated
|
|
3044
|
+
*
|
|
3045
|
+
* <p>Instead, use the <code>KeySpec</code> field in the <code>GetPublicKey</code> response.</p>
|
|
3046
|
+
* <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>
|
|
3020
3047
|
*/
|
|
3021
3048
|
CustomerMasterKeySpec?: CustomerMasterKeySpec | string;
|
|
3022
3049
|
|
|
3050
|
+
/**
|
|
3051
|
+
* <p>The type of the of the public key that was downloaded.</p>
|
|
3052
|
+
*/
|
|
3053
|
+
KeySpec?: KeySpec | string;
|
|
3054
|
+
|
|
3023
3055
|
/**
|
|
3024
3056
|
* <p>The permitted use of the public key. Valid values are <code>ENCRYPT_DECRYPT</code> or
|
|
3025
3057
|
* <code>SIGN_VERIFY</code>. </p>
|
|
3026
3058
|
* <p>This information is critical. If a public key with <code>SIGN_VERIFY</code> key usage
|
|
3027
|
-
* encrypts data outside of
|
|
3059
|
+
* encrypts data outside of KMS, the ciphertext cannot be decrypted. </p>
|
|
3028
3060
|
*/
|
|
3029
3061
|
KeyUsage?: KeyUsageType | string;
|
|
3030
3062
|
|
|
3031
3063
|
/**
|
|
3032
|
-
* <p>The encryption algorithms that
|
|
3033
|
-
* <p>This information is critical. If a public key encrypts data outside of
|
|
3064
|
+
* <p>The encryption algorithms that KMS supports for this key. </p>
|
|
3065
|
+
* <p>This information is critical. If a public key encrypts data outside of KMS by using an
|
|
3034
3066
|
* unsupported encryption algorithm, the ciphertext cannot be decrypted. </p>
|
|
3035
3067
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
3036
3068
|
* is <code>ENCRYPT_DECRYPT</code>.</p>
|
|
@@ -3038,7 +3070,7 @@ export interface GetPublicKeyResponse {
|
|
|
3038
3070
|
EncryptionAlgorithms?: (EncryptionAlgorithmSpec | string)[];
|
|
3039
3071
|
|
|
3040
3072
|
/**
|
|
3041
|
-
* <p>The signing algorithms that
|
|
3073
|
+
* <p>The signing algorithms that KMS supports for this key.</p>
|
|
3042
3074
|
* <p>This field appears in the response only when the <code>KeyUsage</code> of the public key
|
|
3043
3075
|
* is <code>SIGN_VERIFY</code>.</p>
|
|
3044
3076
|
*/
|
|
@@ -3059,7 +3091,7 @@ export namespace GetPublicKeyResponse {
|
|
|
3059
3091
|
*/
|
|
3060
3092
|
export interface GrantListEntry {
|
|
3061
3093
|
/**
|
|
3062
|
-
* <p>The unique identifier for the
|
|
3094
|
+
* <p>The unique identifier for the KMS key to which the grant applies.</p>
|
|
3063
3095
|
*/
|
|
3064
3096
|
KeyId?: string;
|
|
3065
3097
|
|
|
@@ -3082,7 +3114,7 @@ export interface GrantListEntry {
|
|
|
3082
3114
|
* <p>The identity that gets the permissions in the grant.</p>
|
|
3083
3115
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
3084
3116
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
3085
|
-
* principal in the grant is an
|
|
3117
|
+
* principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
|
|
3086
3118
|
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
|
|
3087
3119
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
3088
3120
|
*/
|
|
@@ -3094,7 +3126,7 @@ export interface GrantListEntry {
|
|
|
3094
3126
|
RetiringPrincipal?: string;
|
|
3095
3127
|
|
|
3096
3128
|
/**
|
|
3097
|
-
* <p>The
|
|
3129
|
+
* <p>The Amazon Web Services account under which the grant was issued.</p>
|
|
3098
3130
|
*/
|
|
3099
3131
|
IssuingAccount?: string;
|
|
3100
3132
|
|
|
@@ -3121,11 +3153,11 @@ export namespace GrantListEntry {
|
|
|
3121
3153
|
|
|
3122
3154
|
export interface ImportKeyMaterialRequest {
|
|
3123
3155
|
/**
|
|
3124
|
-
* <p>The identifier of the symmetric
|
|
3125
|
-
* <code>Origin</code> must be <code>EXTERNAL</code>. This must be the same
|
|
3156
|
+
* <p>The identifier of the symmetric KMS key that receives the imported key material. The KMS key's
|
|
3157
|
+
* <code>Origin</code> must be <code>EXTERNAL</code>. This must be the same KMS key specified in
|
|
3126
3158
|
* the <code>KeyID</code> parameter of the corresponding <a>GetParametersForImport</a>
|
|
3127
3159
|
* request.</p>
|
|
3128
|
-
* <p>Specify the key ID or key ARN of the
|
|
3160
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3129
3161
|
* <p>For example:</p>
|
|
3130
3162
|
* <ul>
|
|
3131
3163
|
* <li>
|
|
@@ -3137,7 +3169,7 @@ export interface ImportKeyMaterialRequest {
|
|
|
3137
3169
|
* </p>
|
|
3138
3170
|
* </li>
|
|
3139
3171
|
* </ul>
|
|
3140
|
-
* <p>To get the key ID and key ARN for a
|
|
3172
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3141
3173
|
*/
|
|
3142
3174
|
KeyId: string | undefined;
|
|
3143
3175
|
|
|
@@ -3155,8 +3187,8 @@ export interface ImportKeyMaterialRequest {
|
|
|
3155
3187
|
EncryptedKeyMaterial: Uint8Array | undefined;
|
|
3156
3188
|
|
|
3157
3189
|
/**
|
|
3158
|
-
* <p>The time at which the imported key material expires. When the key material expires,
|
|
3159
|
-
* deletes the key material and the
|
|
3190
|
+
* <p>The time at which the imported key material expires. When the key material expires, KMS
|
|
3191
|
+
* deletes the key material and the KMS key becomes unusable. You must omit this parameter when the
|
|
3160
3192
|
* <code>ExpirationModel</code> parameter is set to <code>KEY_MATERIAL_DOES_NOT_EXPIRE</code>.
|
|
3161
3193
|
* Otherwise it is required.</p>
|
|
3162
3194
|
*/
|
|
@@ -3193,8 +3225,7 @@ export namespace ImportKeyMaterialResponse {
|
|
|
3193
3225
|
|
|
3194
3226
|
/**
|
|
3195
3227
|
* <p>The request was rejected because the key material in the request is, expired, invalid, or
|
|
3196
|
-
* is not the same key material that was previously imported into this
|
|
3197
|
-
* (CMK).</p>
|
|
3228
|
+
* is not the same key material that was previously imported into this KMS key.</p>
|
|
3198
3229
|
*/
|
|
3199
3230
|
export interface IncorrectKeyMaterialException extends __SmithyException, $MetadataBearer {
|
|
3200
3231
|
name: "IncorrectKeyMaterialException";
|
|
@@ -3213,7 +3244,7 @@ export namespace IncorrectKeyMaterialException {
|
|
|
3213
3244
|
|
|
3214
3245
|
/**
|
|
3215
3246
|
* <p>The request was rejected because the provided import token is invalid or is associated
|
|
3216
|
-
* with a different
|
|
3247
|
+
* with a different KMS key.</p>
|
|
3217
3248
|
*/
|
|
3218
3249
|
export interface InvalidImportTokenException extends __SmithyException, $MetadataBearer {
|
|
3219
3250
|
name: "InvalidImportTokenException";
|
|
@@ -3275,7 +3306,7 @@ export namespace KeyListEntry {
|
|
|
3275
3306
|
/**
|
|
3276
3307
|
* <p>The request was rejected because the signature verification failed. Signature verification
|
|
3277
3308
|
* fails when it cannot confirm that signature was produced by signing the specified message with
|
|
3278
|
-
* the specified
|
|
3309
|
+
* the specified KMS key and signing algorithm.</p>
|
|
3279
3310
|
*/
|
|
3280
3311
|
export interface KMSInvalidSignatureException extends __SmithyException, $MetadataBearer {
|
|
3281
3312
|
name: "KMSInvalidSignatureException";
|
|
@@ -3294,12 +3325,11 @@ export namespace KMSInvalidSignatureException {
|
|
|
3294
3325
|
|
|
3295
3326
|
export interface ListAliasesRequest {
|
|
3296
3327
|
/**
|
|
3297
|
-
* <p>Lists only aliases that are associated with the specified
|
|
3298
|
-
* account. </p>
|
|
3328
|
+
* <p>Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account. </p>
|
|
3299
3329
|
* <p>This parameter is optional. If you omit it, <code>ListAliases</code> returns all aliases
|
|
3300
3330
|
* in the account and Region.</p>
|
|
3301
3331
|
*
|
|
3302
|
-
* <p>Specify the key ID or key ARN of the
|
|
3332
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3303
3333
|
* <p>For example:</p>
|
|
3304
3334
|
* <ul>
|
|
3305
3335
|
* <li>
|
|
@@ -3311,13 +3341,13 @@ export interface ListAliasesRequest {
|
|
|
3311
3341
|
* </p>
|
|
3312
3342
|
* </li>
|
|
3313
3343
|
* </ul>
|
|
3314
|
-
* <p>To get the key ID and key ARN for a
|
|
3344
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3315
3345
|
*/
|
|
3316
3346
|
KeyId?: string;
|
|
3317
3347
|
|
|
3318
3348
|
/**
|
|
3319
3349
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3320
|
-
* value is present,
|
|
3350
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3321
3351
|
* return fewer.</p>
|
|
3322
3352
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
3323
3353
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -3374,7 +3404,7 @@ export namespace ListAliasesResponse {
|
|
|
3374
3404
|
export interface ListGrantsRequest {
|
|
3375
3405
|
/**
|
|
3376
3406
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3377
|
-
* value is present,
|
|
3407
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3378
3408
|
* return fewer.</p>
|
|
3379
3409
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
3380
3410
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -3389,10 +3419,10 @@ export interface ListGrantsRequest {
|
|
|
3389
3419
|
Marker?: string;
|
|
3390
3420
|
|
|
3391
3421
|
/**
|
|
3392
|
-
* <p>Returns only grants for the specified
|
|
3422
|
+
* <p>Returns only grants for the specified KMS key. This parameter is
|
|
3393
3423
|
* required.</p>
|
|
3394
|
-
* <p>Specify the key ID or key ARN of the
|
|
3395
|
-
* different
|
|
3424
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
3425
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
3396
3426
|
* <p>For example:</p>
|
|
3397
3427
|
* <ul>
|
|
3398
3428
|
* <li>
|
|
@@ -3404,7 +3434,7 @@ export interface ListGrantsRequest {
|
|
|
3404
3434
|
* </p>
|
|
3405
3435
|
* </li>
|
|
3406
3436
|
* </ul>
|
|
3407
|
-
* <p>To get the key ID and key ARN for a
|
|
3437
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3408
3438
|
*/
|
|
3409
3439
|
KeyId: string | undefined;
|
|
3410
3440
|
|
|
@@ -3462,8 +3492,8 @@ export namespace ListGrantsResponse {
|
|
|
3462
3492
|
|
|
3463
3493
|
export interface ListKeyPoliciesRequest {
|
|
3464
3494
|
/**
|
|
3465
|
-
* <p>Gets the names of key policies for the specified
|
|
3466
|
-
* <p>Specify the key ID or key ARN of the
|
|
3495
|
+
* <p>Gets the names of key policies for the specified KMS key.</p>
|
|
3496
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3467
3497
|
* <p>For example:</p>
|
|
3468
3498
|
* <ul>
|
|
3469
3499
|
* <li>
|
|
@@ -3475,13 +3505,13 @@ export interface ListKeyPoliciesRequest {
|
|
|
3475
3505
|
* </p>
|
|
3476
3506
|
* </li>
|
|
3477
3507
|
* </ul>
|
|
3478
|
-
* <p>To get the key ID and key ARN for a
|
|
3508
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3479
3509
|
*/
|
|
3480
3510
|
KeyId: string | undefined;
|
|
3481
3511
|
|
|
3482
3512
|
/**
|
|
3483
3513
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3484
|
-
* value is present,
|
|
3514
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3485
3515
|
* return fewer.</p>
|
|
3486
3516
|
* <p>This value is optional. If you include a value, it must be between
|
|
3487
3517
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
@@ -3539,7 +3569,7 @@ export namespace ListKeyPoliciesResponse {
|
|
|
3539
3569
|
export interface ListKeysRequest {
|
|
3540
3570
|
/**
|
|
3541
3571
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3542
|
-
* value is present,
|
|
3572
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3543
3573
|
* return fewer.</p>
|
|
3544
3574
|
* <p>This value is optional. If you include a value, it must be between
|
|
3545
3575
|
* 1 and 1000, inclusive. If you do not include a value, it defaults to 100.</p>
|
|
@@ -3565,7 +3595,7 @@ export namespace ListKeysRequest {
|
|
|
3565
3595
|
|
|
3566
3596
|
export interface ListKeysResponse {
|
|
3567
3597
|
/**
|
|
3568
|
-
* <p>A list of
|
|
3598
|
+
* <p>A list of KMS keys.</p>
|
|
3569
3599
|
*/
|
|
3570
3600
|
Keys?: KeyListEntry[];
|
|
3571
3601
|
|
|
@@ -3595,8 +3625,8 @@ export namespace ListKeysResponse {
|
|
|
3595
3625
|
|
|
3596
3626
|
export interface ListResourceTagsRequest {
|
|
3597
3627
|
/**
|
|
3598
|
-
* <p>Gets tags on the specified
|
|
3599
|
-
* <p>Specify the key ID or key ARN of the
|
|
3628
|
+
* <p>Gets tags on the specified KMS key.</p>
|
|
3629
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3600
3630
|
* <p>For example:</p>
|
|
3601
3631
|
* <ul>
|
|
3602
3632
|
* <li>
|
|
@@ -3608,13 +3638,13 @@ export interface ListResourceTagsRequest {
|
|
|
3608
3638
|
* </p>
|
|
3609
3639
|
* </li>
|
|
3610
3640
|
* </ul>
|
|
3611
|
-
* <p>To get the key ID and key ARN for a
|
|
3641
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3612
3642
|
*/
|
|
3613
3643
|
KeyId: string | undefined;
|
|
3614
3644
|
|
|
3615
3645
|
/**
|
|
3616
3646
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3617
|
-
* value is present,
|
|
3647
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3618
3648
|
* return fewer.</p>
|
|
3619
3649
|
* <p>This value is optional. If you include a value, it must be between 1 and 50, inclusive. If
|
|
3620
3650
|
* you do not include a value, it defaults to 50.</p>
|
|
@@ -3644,8 +3674,7 @@ export interface ListResourceTagsResponse {
|
|
|
3644
3674
|
/**
|
|
3645
3675
|
* <p>A list of tags. Each tag consists of a tag key and a tag value.</p>
|
|
3646
3676
|
* <note>
|
|
3647
|
-
* <p>Tagging or untagging a
|
|
3648
|
-
* 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>
|
|
3677
|
+
* <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>
|
|
3649
3678
|
* </note>
|
|
3650
3679
|
*/
|
|
3651
3680
|
Tags?: Tag[];
|
|
@@ -3678,7 +3707,7 @@ export namespace ListResourceTagsResponse {
|
|
|
3678
3707
|
export interface ListRetirableGrantsRequest {
|
|
3679
3708
|
/**
|
|
3680
3709
|
* <p>Use this parameter to specify the maximum number of items to return. When this
|
|
3681
|
-
* value is present,
|
|
3710
|
+
* value is present, KMS does not return more than the specified number of items, but it might
|
|
3682
3711
|
* return fewer.</p>
|
|
3683
3712
|
* <p>This value is optional. If you include a value, it must be between 1
|
|
3684
3713
|
* and 100, inclusive. If you do not include a value, it defaults to 50.</p>
|
|
@@ -3693,13 +3722,10 @@ export interface ListRetirableGrantsRequest {
|
|
|
3693
3722
|
Marker?: string;
|
|
3694
3723
|
|
|
3695
3724
|
/**
|
|
3696
|
-
* <p>The retiring principal for which to list grants. Enter a principal in your
|
|
3697
|
-
*
|
|
3698
|
-
*
|
|
3699
|
-
*
|
|
3700
|
-
* 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
|
|
3701
|
-
* Identity and Access Management (IAM)</a> in the Example ARNs section of the
|
|
3702
|
-
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3725
|
+
* <p>The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.</p>
|
|
3726
|
+
* <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
|
|
3727
|
+
* 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
|
|
3728
|
+
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3703
3729
|
*/
|
|
3704
3730
|
RetiringPrincipal: string | undefined;
|
|
3705
3731
|
}
|
|
@@ -3720,8 +3746,8 @@ export enum MessageType {
|
|
|
3720
3746
|
|
|
3721
3747
|
export interface PutKeyPolicyRequest {
|
|
3722
3748
|
/**
|
|
3723
|
-
* <p>Sets the key policy on the specified
|
|
3724
|
-
* <p>Specify the key ID or key ARN of the
|
|
3749
|
+
* <p>Sets the key policy on the specified KMS key.</p>
|
|
3750
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
3725
3751
|
* <p>For example:</p>
|
|
3726
3752
|
* <ul>
|
|
3727
3753
|
* <li>
|
|
@@ -3733,7 +3759,7 @@ export interface PutKeyPolicyRequest {
|
|
|
3733
3759
|
* </p>
|
|
3734
3760
|
* </li>
|
|
3735
3761
|
* </ul>
|
|
3736
|
-
* <p>To get the key ID and key ARN for a
|
|
3762
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3737
3763
|
*/
|
|
3738
3764
|
KeyId: string | undefined;
|
|
3739
3765
|
|
|
@@ -3743,38 +3769,36 @@ export interface PutKeyPolicyRequest {
|
|
|
3743
3769
|
PolicyName: string | undefined;
|
|
3744
3770
|
|
|
3745
3771
|
/**
|
|
3746
|
-
* <p>The key policy to attach to the
|
|
3772
|
+
* <p>The key policy to attach to the KMS key.</p>
|
|
3747
3773
|
* <p>The key policy must meet the following criteria:</p>
|
|
3748
3774
|
* <ul>
|
|
3749
3775
|
* <li>
|
|
3750
3776
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
3751
3777
|
* must allow the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|
3752
|
-
* subsequent <code>PutKeyPolicy</code> request on the
|
|
3753
|
-
* 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>
|
|
3778
|
+
* 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>
|
|
3754
3779
|
* </li>
|
|
3755
3780
|
* <li>
|
|
3756
3781
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
3757
|
-
* in the key policy must exist and be visible to
|
|
3782
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
3758
3783
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
3759
3784
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
3760
|
-
* to
|
|
3761
|
-
* Identity and Access Management User Guide</i>.</p>
|
|
3785
|
+
* 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>
|
|
3762
3786
|
* </li>
|
|
3763
3787
|
* </ul>
|
|
3764
3788
|
* <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
|
|
3765
|
-
* <i>
|
|
3789
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3766
3790
|
*/
|
|
3767
3791
|
Policy: string | undefined;
|
|
3768
3792
|
|
|
3769
3793
|
/**
|
|
3770
3794
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
3771
3795
|
* <important>
|
|
3772
|
-
* <p>Setting this value to true increases the risk that the
|
|
3796
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
3773
3797
|
* set this value to true indiscriminately.</p>
|
|
3774
|
-
* <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>
|
|
3798
|
+
* <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>
|
|
3775
3799
|
* </important>
|
|
3776
3800
|
* <p>Use this parameter only when you intend to prevent the principal that is making the
|
|
3777
|
-
* request from making a subsequent <code>PutKeyPolicy</code> request on the
|
|
3801
|
+
* request from making a subsequent <code>PutKeyPolicy</code> request on the KMS key.</p>
|
|
3778
3802
|
* <p>The default value is false.</p>
|
|
3779
3803
|
*/
|
|
3780
3804
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
@@ -3798,23 +3822,23 @@ export interface ReEncryptRequest {
|
|
|
3798
3822
|
/**
|
|
3799
3823
|
* <p>Specifies the encryption context to use to decrypt the ciphertext. Enter the same
|
|
3800
3824
|
* encryption context that was used to encrypt the ciphertext.</p>
|
|
3801
|
-
* <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
|
|
3825
|
+
* <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>
|
|
3802
3826
|
* <p>For more information, see
|
|
3803
3827
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
3804
|
-
* Context</a> in the <i>
|
|
3828
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3805
3829
|
*/
|
|
3806
3830
|
SourceEncryptionContext?: { [key: string]: string };
|
|
3807
3831
|
|
|
3808
3832
|
/**
|
|
3809
|
-
* <p>Specifies the
|
|
3810
|
-
*
|
|
3833
|
+
* <p>Specifies the KMS key that
|
|
3834
|
+
* KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key
|
|
3811
3835
|
* that was used to encrypt the ciphertext.</p>
|
|
3812
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
3813
|
-
* If you used a symmetric
|
|
3836
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
|
|
3837
|
+
* If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the
|
|
3814
3838
|
* symmetric ciphertext blob. However, it is always recommended as a best practice. This practice
|
|
3815
|
-
* ensures that you use the
|
|
3839
|
+
* ensures that you use the KMS key that you intend.</p>
|
|
3816
3840
|
*
|
|
3817
|
-
* <p>To specify a
|
|
3841
|
+
* <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>
|
|
3818
3842
|
* <p>For example:</p>
|
|
3819
3843
|
* <ul>
|
|
3820
3844
|
* <li>
|
|
@@ -3834,16 +3858,16 @@ export interface ReEncryptRequest {
|
|
|
3834
3858
|
* </p>
|
|
3835
3859
|
* </li>
|
|
3836
3860
|
* </ul>
|
|
3837
|
-
* <p>To get the key ID and key ARN for a
|
|
3861
|
+
* <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>
|
|
3838
3862
|
*/
|
|
3839
3863
|
SourceKeyId?: string;
|
|
3840
3864
|
|
|
3841
3865
|
/**
|
|
3842
|
-
* <p>A unique identifier for the
|
|
3843
|
-
* asymmetric
|
|
3844
|
-
* <code>KeyUsage</code> value of a
|
|
3866
|
+
* <p>A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or
|
|
3867
|
+
* asymmetric KMS key with a <code>KeyUsage</code> value of <code>ENCRYPT_DECRYPT</code>. To find the
|
|
3868
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a>
|
|
3845
3869
|
* operation.</p>
|
|
3846
|
-
* <p>To specify a
|
|
3870
|
+
* <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>
|
|
3847
3871
|
* <p>For example:</p>
|
|
3848
3872
|
* <ul>
|
|
3849
3873
|
* <li>
|
|
@@ -3863,45 +3887,43 @@ export interface ReEncryptRequest {
|
|
|
3863
3887
|
* </p>
|
|
3864
3888
|
* </li>
|
|
3865
3889
|
* </ul>
|
|
3866
|
-
* <p>To get the key ID and key ARN for a
|
|
3890
|
+
* <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>
|
|
3867
3891
|
*/
|
|
3868
3892
|
DestinationKeyId: string | undefined;
|
|
3869
3893
|
|
|
3870
3894
|
/**
|
|
3871
3895
|
* <p>Specifies that encryption context to use when the reencrypting the data.</p>
|
|
3872
|
-
* <p>A destination encryption context is valid only when the destination
|
|
3873
|
-
* CMK. The standard ciphertext format for asymmetric CMKs does not include fields for
|
|
3896
|
+
* <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
|
|
3874
3897
|
* metadata.</p>
|
|
3875
|
-
* <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
|
|
3898
|
+
* <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>
|
|
3876
3899
|
* <p>For more information, see
|
|
3877
3900
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
3878
|
-
* Context</a> in the <i>
|
|
3901
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3879
3902
|
*/
|
|
3880
3903
|
DestinationEncryptionContext?: { [key: string]: string };
|
|
3881
3904
|
|
|
3882
3905
|
/**
|
|
3883
|
-
* <p>Specifies the encryption algorithm that
|
|
3906
|
+
* <p>Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it
|
|
3884
3907
|
* is reencrypted. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the algorithm
|
|
3885
|
-
* used for symmetric
|
|
3908
|
+
* used for symmetric KMS keys.</p>
|
|
3886
3909
|
* <p>Specify the same algorithm that was used to encrypt the ciphertext. If you specify a
|
|
3887
3910
|
* different algorithm, the decrypt attempt fails.</p>
|
|
3888
|
-
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric
|
|
3889
|
-
* CMK.</p>
|
|
3911
|
+
* <p>This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.</p>
|
|
3890
3912
|
*/
|
|
3891
3913
|
SourceEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
3892
3914
|
|
|
3893
3915
|
/**
|
|
3894
|
-
* <p>Specifies the encryption algorithm that
|
|
3916
|
+
* <p>Specifies the encryption algorithm that KMS will use to reecrypt the data after it has
|
|
3895
3917
|
* decrypted it. The default value, <code>SYMMETRIC_DEFAULT</code>, represents the encryption
|
|
3896
|
-
* algorithm used for symmetric
|
|
3897
|
-
* <p>This parameter is required only when the destination
|
|
3918
|
+
* algorithm used for symmetric KMS keys.</p>
|
|
3919
|
+
* <p>This parameter is required only when the destination KMS key is an asymmetric KMS key.</p>
|
|
3898
3920
|
*/
|
|
3899
3921
|
DestinationEncryptionAlgorithm?: EncryptionAlgorithmSpec | string;
|
|
3900
3922
|
|
|
3901
3923
|
/**
|
|
3902
3924
|
* <p>A list of grant tokens.</p>
|
|
3903
|
-
* <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/
|
|
3904
|
-
* <i>
|
|
3925
|
+
* <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
|
|
3926
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3905
3927
|
*/
|
|
3906
3928
|
GrantTokens?: string[];
|
|
3907
3929
|
}
|
|
@@ -3917,17 +3939,17 @@ export namespace ReEncryptRequest {
|
|
|
3917
3939
|
|
|
3918
3940
|
export interface ReEncryptResponse {
|
|
3919
3941
|
/**
|
|
3920
|
-
* <p>The reencrypted data. When you use the HTTP API or the
|
|
3942
|
+
* <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>
|
|
3921
3943
|
*/
|
|
3922
3944
|
CiphertextBlob?: Uint8Array;
|
|
3923
3945
|
|
|
3924
3946
|
/**
|
|
3925
|
-
* <p>Unique identifier of the
|
|
3947
|
+
* <p>Unique identifier of the KMS key used to originally encrypt the data.</p>
|
|
3926
3948
|
*/
|
|
3927
3949
|
SourceKeyId?: string;
|
|
3928
3950
|
|
|
3929
3951
|
/**
|
|
3930
|
-
* <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
|
|
3952
|
+
* <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>
|
|
3931
3953
|
*/
|
|
3932
3954
|
KeyId?: string;
|
|
3933
3955
|
|
|
@@ -3954,8 +3976,7 @@ export namespace ReEncryptResponse {
|
|
|
3954
3976
|
|
|
3955
3977
|
export interface ReplicateKeyRequest {
|
|
3956
3978
|
/**
|
|
3957
|
-
* <p>Identifies the multi-Region primary key that is being replicated. To determine whether a
|
|
3958
|
-
* CMK is a multi-Region primary key, use the <a>DescribeKey</a> operation to check
|
|
3979
|
+
* <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
|
|
3959
3980
|
* the value of the <code>MultiRegionKeyType</code> property.</p>
|
|
3960
3981
|
*
|
|
3961
3982
|
* <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
|
|
@@ -3970,20 +3991,20 @@ export interface ReplicateKeyRequest {
|
|
|
3970
3991
|
* </p>
|
|
3971
3992
|
* </li>
|
|
3972
3993
|
* </ul>
|
|
3973
|
-
* <p>To get the key ID and key ARN for a
|
|
3994
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
3974
3995
|
*/
|
|
3975
3996
|
KeyId: string | undefined;
|
|
3976
3997
|
|
|
3977
3998
|
/**
|
|
3978
|
-
* <p>The Region ID of the
|
|
3999
|
+
* <p>The Region ID of the Amazon Web Services Region for this replica key. </p>
|
|
3979
4000
|
* <p>Enter the Region ID, such as <code>us-east-1</code> or <code>ap-southeast-2</code>. For a
|
|
3980
|
-
* list of
|
|
4001
|
+
* 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
|
|
3981
4002
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
3982
|
-
* <p>The replica must be in a different
|
|
3983
|
-
* that primary key, but in the same
|
|
3984
|
-
* Region. If the Region is not enabled by default, the
|
|
4003
|
+
* <p>The replica must be in a different Amazon Web Services Region than its primary key and other replicas of
|
|
4004
|
+
* that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica
|
|
4005
|
+
* Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the
|
|
3985
4006
|
* Region. </p>
|
|
3986
|
-
* <p>For information about
|
|
4007
|
+
* <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
|
|
3987
4008
|
* <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
|
|
3988
4009
|
* 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
|
|
3989
4010
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
@@ -3991,27 +4012,28 @@ export interface ReplicateKeyRequest {
|
|
|
3991
4012
|
ReplicaRegion: string | undefined;
|
|
3992
4013
|
|
|
3993
4014
|
/**
|
|
3994
|
-
* <p>The key policy to attach to the
|
|
4015
|
+
* <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>
|
|
3995
4016
|
* <p>The key policy is not a shared property of multi-Region keys. You can specify the same key
|
|
3996
|
-
* policy or a different key policy for each key in a set of related multi-Region keys.
|
|
4017
|
+
* policy or a different key policy for each key in a set of related multi-Region keys. KMS
|
|
3997
4018
|
* does not synchronize this property.</p>
|
|
3998
4019
|
* <p>If you provide a key policy, it must meet the following criteria:</p>
|
|
3999
4020
|
* <ul>
|
|
4000
4021
|
* <li>
|
|
4001
4022
|
* <p>If you don't set <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy
|
|
4002
|
-
* must give the caller <code>kms:PutKeyPolicy</code> permission on the replica
|
|
4003
|
-
* risk that the
|
|
4023
|
+
* must give the caller <code>kms:PutKeyPolicy</code> permission on the replica key. This reduces the
|
|
4024
|
+
* risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the
|
|
4004
4025
|
* <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>
|
|
4005
|
-
* <i>
|
|
4026
|
+
* <i>Key Management Service Developer Guide</i>
|
|
4006
4027
|
* </i>.</p>
|
|
4007
4028
|
* </li>
|
|
4008
4029
|
* <li>
|
|
4009
4030
|
* <p>Each statement in the key policy must contain one or more principals. The principals
|
|
4010
|
-
* in the key policy must exist and be visible to
|
|
4031
|
+
* in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal
|
|
4011
4032
|
* (for example, an IAM user or role), you might need to enforce a delay before including the
|
|
4012
4033
|
* new principal in a key policy because the new principal might not be immediately visible
|
|
4013
|
-
* to
|
|
4014
|
-
*
|
|
4034
|
+
* 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>
|
|
4035
|
+
* <i>Identity and Access Management User Guide</i>
|
|
4036
|
+
* </i>.</p>
|
|
4015
4037
|
* </li>
|
|
4016
4038
|
* <li>
|
|
4017
4039
|
* <p>The key policy size quota is 32 kilobytes (32768 bytes).</p>
|
|
@@ -4023,42 +4045,39 @@ export interface ReplicateKeyRequest {
|
|
|
4023
4045
|
/**
|
|
4024
4046
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|
4025
4047
|
* <important>
|
|
4026
|
-
* <p>Setting this value to true increases the risk that the
|
|
4048
|
+
* <p>Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not
|
|
4027
4049
|
* set this value to true indiscriminately.</p>
|
|
4028
|
-
* <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>
|
|
4050
|
+
* <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>
|
|
4029
4051
|
* </important>
|
|
4030
4052
|
* <p>Use this parameter only when you intend to prevent the principal that is making the
|
|
4031
|
-
* request from making a subsequent <code>PutKeyPolicy</code> request on the
|
|
4053
|
+
* request from making a subsequent <code>PutKeyPolicy</code> request on the KMS key.</p>
|
|
4032
4054
|
* <p>The default value is false.</p>
|
|
4033
4055
|
*/
|
|
4034
4056
|
BypassPolicyLockoutSafetyCheck?: boolean;
|
|
4035
4057
|
|
|
4036
4058
|
/**
|
|
4037
|
-
* <p>A description of the
|
|
4038
|
-
* appropriate for a task. The default value is an empty string (no description).</p>
|
|
4059
|
+
* <p>A description of the KMS key. The default value is an empty string (no description).</p>
|
|
4039
4060
|
* <p>The description is not a shared property of multi-Region keys. You can specify the same
|
|
4040
|
-
* description or a different description for each key in a set of related multi-Region keys.
|
|
4041
|
-
* KMS does not synchronize this property.</p>
|
|
4061
|
+
* description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.</p>
|
|
4042
4062
|
*/
|
|
4043
4063
|
Description?: string;
|
|
4044
4064
|
|
|
4045
4065
|
/**
|
|
4046
|
-
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the
|
|
4047
|
-
* To tag an existing
|
|
4066
|
+
* <p>Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created.
|
|
4067
|
+
* To tag an existing KMS key, use the <a>TagResource</a> operation.</p>
|
|
4048
4068
|
* <note>
|
|
4049
|
-
* <p>Tagging or untagging a
|
|
4050
|
-
* 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>
|
|
4069
|
+
* <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>
|
|
4051
4070
|
* </note>
|
|
4052
4071
|
* <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>
|
|
4053
4072
|
* <p>Tags are not a shared property of multi-Region keys. You can specify the same tags or
|
|
4054
|
-
* different tags for each key in a set of related multi-Region keys.
|
|
4073
|
+
* different tags for each key in a set of related multi-Region keys. KMS does not
|
|
4055
4074
|
* synchronize this property.</p>
|
|
4056
4075
|
* <p>Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
|
|
4057
4076
|
* required, but the tag value can be an empty (null) string. You cannot have more than one tag
|
|
4058
|
-
* on a
|
|
4059
|
-
*
|
|
4060
|
-
* <p>When you
|
|
4061
|
-
* report with usage and costs aggregated by tags. Tags can also be used to control access to a
|
|
4077
|
+
* on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,
|
|
4078
|
+
* KMS replaces the current tag value with the specified one.</p>
|
|
4079
|
+
* <p>When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation
|
|
4080
|
+
* report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,
|
|
4062
4081
|
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging Keys</a>.</p>
|
|
4063
4082
|
*/
|
|
4064
4083
|
Tags?: Tag[];
|
|
@@ -4075,8 +4094,8 @@ export namespace ReplicateKeyRequest {
|
|
|
4075
4094
|
|
|
4076
4095
|
export interface ReplicateKeyResponse {
|
|
4077
4096
|
/**
|
|
4078
|
-
* <p>Displays details about the new replica
|
|
4079
|
-
* 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
|
|
4097
|
+
* <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
|
|
4098
|
+
* 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
|
|
4080
4099
|
* replica keys.</p>
|
|
4081
4100
|
*/
|
|
4082
4101
|
ReplicaKeyMetadata?: KeyMetadata;
|
|
@@ -4108,13 +4127,13 @@ export interface RetireGrantRequest {
|
|
|
4108
4127
|
* <p>Identifies the grant to be retired. You can use a grant token to identify a new grant even
|
|
4109
4128
|
* before it has achieved eventual consistency.</p>
|
|
4110
4129
|
* <p>Only the <a>CreateGrant</a> operation returns a grant token. For details, see
|
|
4111
|
-
*
|
|
4112
|
-
* and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in the <i>
|
|
4130
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">Grant token</a>
|
|
4131
|
+
* 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>
|
|
4113
4132
|
*/
|
|
4114
4133
|
GrantToken?: string;
|
|
4115
4134
|
|
|
4116
4135
|
/**
|
|
4117
|
-
* <p>The key ARN
|
|
4136
|
+
* <p>The key ARN KMS key associated with the grant. To find the key ARN, use the <a>ListKeys</a> operation.</p>
|
|
4118
4137
|
* <p>For example: <code>arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
4119
4138
|
* </p>
|
|
4120
4139
|
*/
|
|
@@ -4122,7 +4141,7 @@ export interface RetireGrantRequest {
|
|
|
4122
4141
|
|
|
4123
4142
|
/**
|
|
4124
4143
|
* <p>Identifies the grant to retire. To get the grant ID, use <a>CreateGrant</a>,
|
|
4125
|
-
*
|
|
4144
|
+
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
4126
4145
|
* <ul>
|
|
4127
4146
|
* <li>
|
|
4128
4147
|
* <p>Grant ID Example -
|
|
@@ -4144,11 +4163,11 @@ export namespace RetireGrantRequest {
|
|
|
4144
4163
|
|
|
4145
4164
|
export interface RevokeGrantRequest {
|
|
4146
4165
|
/**
|
|
4147
|
-
* <p>A unique identifier for the
|
|
4148
|
-
* the key ID and key ARN for a
|
|
4166
|
+
* <p>A unique identifier for the KMS key associated with the grant. To get
|
|
4167
|
+
* the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4149
4168
|
*
|
|
4150
|
-
* <p>Specify the key ID or key ARN of the
|
|
4151
|
-
* different
|
|
4169
|
+
* <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a
|
|
4170
|
+
* different Amazon Web Services account, you must use the key ARN.</p>
|
|
4152
4171
|
* <p>For example:</p>
|
|
4153
4172
|
* <ul>
|
|
4154
4173
|
* <li>
|
|
@@ -4160,13 +4179,13 @@ export interface RevokeGrantRequest {
|
|
|
4160
4179
|
* </p>
|
|
4161
4180
|
* </li>
|
|
4162
4181
|
* </ul>
|
|
4163
|
-
* <p>To get the key ID and key ARN for a
|
|
4182
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4164
4183
|
*/
|
|
4165
4184
|
KeyId: string | undefined;
|
|
4166
4185
|
|
|
4167
4186
|
/**
|
|
4168
4187
|
* <p>Identifies the grant to revoke. To get the grant ID, use <a>CreateGrant</a>,
|
|
4169
|
-
*
|
|
4188
|
+
* <a>ListGrants</a>, or <a>ListRetirableGrants</a>.</p>
|
|
4170
4189
|
*/
|
|
4171
4190
|
GrantId: string | undefined;
|
|
4172
4191
|
}
|
|
@@ -4182,9 +4201,9 @@ export namespace RevokeGrantRequest {
|
|
|
4182
4201
|
|
|
4183
4202
|
export interface ScheduleKeyDeletionRequest {
|
|
4184
4203
|
/**
|
|
4185
|
-
* <p>The unique identifier of the
|
|
4204
|
+
* <p>The unique identifier of the KMS key to delete.</p>
|
|
4186
4205
|
*
|
|
4187
|
-
* <p>Specify the key ID or key ARN of the
|
|
4206
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4188
4207
|
* <p>For example:</p>
|
|
4189
4208
|
* <ul>
|
|
4190
4209
|
* <li>
|
|
@@ -4196,14 +4215,14 @@ export interface ScheduleKeyDeletionRequest {
|
|
|
4196
4215
|
* </p>
|
|
4197
4216
|
* </li>
|
|
4198
4217
|
* </ul>
|
|
4199
|
-
* <p>To get the key ID and key ARN for a
|
|
4218
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4200
4219
|
*/
|
|
4201
4220
|
KeyId: string | undefined;
|
|
4202
4221
|
|
|
4203
4222
|
/**
|
|
4204
|
-
* <p>The waiting period, specified in number of days. After the waiting period ends,
|
|
4205
|
-
* deletes the
|
|
4206
|
-
* <p>If the
|
|
4223
|
+
* <p>The waiting period, specified in number of days. After the waiting period ends, KMS
|
|
4224
|
+
* deletes the KMS key.</p>
|
|
4225
|
+
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the
|
|
4207
4226
|
* last of its replica keys is deleted. Otherwise, the waiting period begins immediately.</p>
|
|
4208
4227
|
* <p>This value is optional. If you include a value, it must be between 7 and 30, inclusive. If
|
|
4209
4228
|
* you do not include a value, it defaults to 30.</p>
|
|
@@ -4222,28 +4241,28 @@ export namespace ScheduleKeyDeletionRequest {
|
|
|
4222
4241
|
|
|
4223
4242
|
export interface ScheduleKeyDeletionResponse {
|
|
4224
4243
|
/**
|
|
4225
|
-
* <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
|
|
4244
|
+
* <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>
|
|
4226
4245
|
*/
|
|
4227
4246
|
KeyId?: string;
|
|
4228
4247
|
|
|
4229
4248
|
/**
|
|
4230
|
-
* <p>The date and time after which
|
|
4231
|
-
* <p>If the
|
|
4249
|
+
* <p>The date and time after which KMS deletes the KMS key.</p>
|
|
4250
|
+
* <p>If the KMS key is a multi-Region primary key with replica keys, this field does not appear.
|
|
4232
4251
|
* The deletion date for the primary key isn't known until its last replica key is
|
|
4233
4252
|
* deleted.</p>
|
|
4234
4253
|
*/
|
|
4235
4254
|
DeletionDate?: Date;
|
|
4236
4255
|
|
|
4237
4256
|
/**
|
|
4238
|
-
* <p>The current status of the
|
|
4239
|
-
* <p>For more information about how key state affects the use of a
|
|
4240
|
-
* in the <i>
|
|
4257
|
+
* <p>The current status of the KMS key.</p>
|
|
4258
|
+
* <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>
|
|
4259
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
4241
4260
|
*/
|
|
4242
4261
|
KeyState?: KeyState | string;
|
|
4243
4262
|
|
|
4244
4263
|
/**
|
|
4245
|
-
* <p>The waiting period before the
|
|
4246
|
-
* <p>If the
|
|
4264
|
+
* <p>The waiting period before the KMS key is deleted. </p>
|
|
4265
|
+
* <p>If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the
|
|
4247
4266
|
* last of its replica keys is deleted. Otherwise, the waiting period begins immediately.</p>
|
|
4248
4267
|
*/
|
|
4249
4268
|
PendingWindowInDays?: number;
|
|
@@ -4260,11 +4279,11 @@ export namespace ScheduleKeyDeletionResponse {
|
|
|
4260
4279
|
|
|
4261
4280
|
export interface SignRequest {
|
|
4262
4281
|
/**
|
|
4263
|
-
* <p>Identifies an asymmetric
|
|
4264
|
-
* message. The <code>KeyUsage</code> type of the
|
|
4265
|
-
* the <code>KeyUsage</code> of a
|
|
4282
|
+
* <p>Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the
|
|
4283
|
+
* message. The <code>KeyUsage</code> type of the KMS key must be <code>SIGN_VERIFY</code>. To find
|
|
4284
|
+
* the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
4266
4285
|
*
|
|
4267
|
-
* <p>To specify a
|
|
4286
|
+
* <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>
|
|
4268
4287
|
* <p>For example:</p>
|
|
4269
4288
|
* <ul>
|
|
4270
4289
|
* <li>
|
|
@@ -4284,20 +4303,20 @@ export interface SignRequest {
|
|
|
4284
4303
|
* </p>
|
|
4285
4304
|
* </li>
|
|
4286
4305
|
* </ul>
|
|
4287
|
-
* <p>To get the key ID and key ARN for a
|
|
4306
|
+
* <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>
|
|
4288
4307
|
*/
|
|
4289
4308
|
KeyId: string | undefined;
|
|
4290
4309
|
|
|
4291
4310
|
/**
|
|
4292
4311
|
* <p>Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a
|
|
4293
4312
|
* larger message, provide the message digest.</p>
|
|
4294
|
-
* <p>If you provide a message,
|
|
4313
|
+
* <p>If you provide a message, KMS generates a hash digest of the message and then signs
|
|
4295
4314
|
* it.</p>
|
|
4296
4315
|
*/
|
|
4297
4316
|
Message: Uint8Array | undefined;
|
|
4298
4317
|
|
|
4299
4318
|
/**
|
|
4300
|
-
* <p>Tells
|
|
4319
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter is a message or
|
|
4301
4320
|
* message digest. The default value, RAW, indicates a message. To indicate a message digest,
|
|
4302
4321
|
* enter <code>DIGEST</code>.</p>
|
|
4303
4322
|
*/
|
|
@@ -4305,15 +4324,14 @@ export interface SignRequest {
|
|
|
4305
4324
|
|
|
4306
4325
|
/**
|
|
4307
4326
|
* <p>A list of grant tokens.</p>
|
|
4308
|
-
* <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/
|
|
4309
|
-
* <i>
|
|
4327
|
+
* <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
|
|
4328
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4310
4329
|
*/
|
|
4311
4330
|
GrantTokens?: string[];
|
|
4312
4331
|
|
|
4313
4332
|
/**
|
|
4314
4333
|
* <p>Specifies the signing algorithm to use when signing the message. </p>
|
|
4315
|
-
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric
|
|
4316
|
-
* CMK.</p>
|
|
4334
|
+
* <p>Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.</p>
|
|
4317
4335
|
*/
|
|
4318
4336
|
SigningAlgorithm: SigningAlgorithmSpec | string | undefined;
|
|
4319
4337
|
}
|
|
@@ -4330,7 +4348,7 @@ export namespace SignRequest {
|
|
|
4330
4348
|
|
|
4331
4349
|
export interface SignResponse {
|
|
4332
4350
|
/**
|
|
4333
|
-
* <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
|
|
4351
|
+
* <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>
|
|
4334
4352
|
*/
|
|
4335
4353
|
KeyId?: string;
|
|
4336
4354
|
|
|
@@ -4350,7 +4368,7 @@ export interface SignResponse {
|
|
|
4350
4368
|
* </p>
|
|
4351
4369
|
* </li>
|
|
4352
4370
|
* </ul>
|
|
4353
|
-
* <p>When you use the HTTP API or the
|
|
4371
|
+
* <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>
|
|
4354
4372
|
*/
|
|
4355
4373
|
Signature?: Uint8Array;
|
|
4356
4374
|
|
|
@@ -4371,9 +4389,9 @@ export namespace SignResponse {
|
|
|
4371
4389
|
|
|
4372
4390
|
export interface TagResourceRequest {
|
|
4373
4391
|
/**
|
|
4374
|
-
* <p>Identifies a customer managed
|
|
4392
|
+
* <p>Identifies a customer managed key in the account and Region.</p>
|
|
4375
4393
|
*
|
|
4376
|
-
* <p>Specify the key ID or key ARN of the
|
|
4394
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4377
4395
|
* <p>For example:</p>
|
|
4378
4396
|
* <ul>
|
|
4379
4397
|
* <li>
|
|
@@ -4385,7 +4403,7 @@ export interface TagResourceRequest {
|
|
|
4385
4403
|
* </p>
|
|
4386
4404
|
* </li>
|
|
4387
4405
|
* </ul>
|
|
4388
|
-
* <p>To get the key ID and key ARN for a
|
|
4406
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4389
4407
|
*/
|
|
4390
4408
|
KeyId: string | undefined;
|
|
4391
4409
|
|
|
@@ -4393,8 +4411,8 @@ export interface TagResourceRequest {
|
|
|
4393
4411
|
* <p>One or more tags. </p>
|
|
4394
4412
|
* <p>Each tag consists of a tag key and a tag value. The tag value can be an empty (null)
|
|
4395
4413
|
* string. </p>
|
|
4396
|
-
* <p>You cannot have more than one tag on a
|
|
4397
|
-
* existing tag key with a different tag value,
|
|
4414
|
+
* <p>You cannot have more than one tag on a KMS key with the same tag key. If you specify an
|
|
4415
|
+
* existing tag key with a different tag value, KMS replaces the current tag value with the
|
|
4398
4416
|
* specified one.</p>
|
|
4399
4417
|
*/
|
|
4400
4418
|
Tags: Tag[] | undefined;
|
|
@@ -4411,9 +4429,9 @@ export namespace TagResourceRequest {
|
|
|
4411
4429
|
|
|
4412
4430
|
export interface UntagResourceRequest {
|
|
4413
4431
|
/**
|
|
4414
|
-
* <p>Identifies the
|
|
4432
|
+
* <p>Identifies the KMS key from which you are removing tags.</p>
|
|
4415
4433
|
*
|
|
4416
|
-
* <p>Specify the key ID or key ARN of the
|
|
4434
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4417
4435
|
* <p>For example:</p>
|
|
4418
4436
|
* <ul>
|
|
4419
4437
|
* <li>
|
|
@@ -4425,7 +4443,7 @@ export interface UntagResourceRequest {
|
|
|
4425
4443
|
* </p>
|
|
4426
4444
|
* </li>
|
|
4427
4445
|
* </ul>
|
|
4428
|
-
* <p>To get the key ID and key ARN for a
|
|
4446
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4429
4447
|
*/
|
|
4430
4448
|
KeyId: string | undefined;
|
|
4431
4449
|
|
|
@@ -4446,19 +4464,19 @@ export namespace UntagResourceRequest {
|
|
|
4446
4464
|
|
|
4447
4465
|
export interface UpdateAliasRequest {
|
|
4448
4466
|
/**
|
|
4449
|
-
* <p>Identifies the alias that is changing its
|
|
4467
|
+
* <p>Identifies the alias that is changing its KMS key. This value must begin with
|
|
4450
4468
|
* <code>alias/</code> followed by the alias name, such as <code>alias/ExampleAlias</code>. You
|
|
4451
4469
|
* cannot use UpdateAlias to change the alias name.</p>
|
|
4452
4470
|
*/
|
|
4453
4471
|
AliasName: string | undefined;
|
|
4454
4472
|
|
|
4455
4473
|
/**
|
|
4456
|
-
* <p>Identifies the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
4457
|
-
* associate an alias with an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
4458
|
-
* <p>The
|
|
4459
|
-
* must be the same type as the current target
|
|
4474
|
+
* <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
|
|
4475
|
+
* 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>
|
|
4476
|
+
* <p>The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key
|
|
4477
|
+
* must be the same type as the current target KMS key (both symmetric or both asymmetric) and they
|
|
4460
4478
|
* must have the same key usage. </p>
|
|
4461
|
-
* <p>Specify the key ID or key ARN of the
|
|
4479
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4462
4480
|
* <p>For example:</p>
|
|
4463
4481
|
* <ul>
|
|
4464
4482
|
* <li>
|
|
@@ -4470,9 +4488,9 @@ export interface UpdateAliasRequest {
|
|
|
4470
4488
|
* </p>
|
|
4471
4489
|
* </li>
|
|
4472
4490
|
* </ul>
|
|
4473
|
-
* <p>To get the key ID and key ARN for a
|
|
4491
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4474
4492
|
* <p>To verify that the alias
|
|
4475
|
-
* is mapped to the correct
|
|
4493
|
+
* is mapped to the correct KMS key, use <a>ListAliases</a>.</p>
|
|
4476
4494
|
*/
|
|
4477
4495
|
TargetKeyId: string | undefined;
|
|
4478
4496
|
}
|
|
@@ -4495,20 +4513,20 @@ export interface UpdateCustomKeyStoreRequest {
|
|
|
4495
4513
|
|
|
4496
4514
|
/**
|
|
4497
4515
|
* <p>Changes the friendly name of the custom key store to the value that you specify. The
|
|
4498
|
-
* custom key store name must be unique in the
|
|
4516
|
+
* custom key store name must be unique in the Amazon Web Services account.</p>
|
|
4499
4517
|
*/
|
|
4500
4518
|
NewCustomKeyStoreName?: string;
|
|
4501
4519
|
|
|
4502
4520
|
/**
|
|
4503
|
-
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the
|
|
4521
|
+
* <p>Enter the current password of the <code>kmsuser</code> crypto user (CU) in the CloudHSM
|
|
4504
4522
|
* cluster that is associated with the custom key store.</p>
|
|
4505
|
-
* <p>This parameter tells
|
|
4506
|
-
* (CU). It does not set or change the password of any users in the
|
|
4523
|
+
* <p>This parameter tells KMS the current password of the <code>kmsuser</code> crypto user
|
|
4524
|
+
* (CU). It does not set or change the password of any users in the CloudHSM cluster.</p>
|
|
4507
4525
|
*/
|
|
4508
4526
|
KeyStorePassword?: string;
|
|
4509
4527
|
|
|
4510
4528
|
/**
|
|
4511
|
-
* <p>Associates the custom key store with a related
|
|
4529
|
+
* <p>Associates the custom key store with a related CloudHSM cluster. </p>
|
|
4512
4530
|
* <p>Enter the cluster ID of the cluster that you used to create the custom key store or a
|
|
4513
4531
|
* cluster that shares a backup history and has the same cluster certificate as the original
|
|
4514
4532
|
* cluster. You cannot use this parameter to associate a custom key store with an unrelated
|
|
@@ -4542,8 +4560,8 @@ export namespace UpdateCustomKeyStoreResponse {
|
|
|
4542
4560
|
|
|
4543
4561
|
export interface UpdateKeyDescriptionRequest {
|
|
4544
4562
|
/**
|
|
4545
|
-
* <p>Updates the description of the specified
|
|
4546
|
-
* <p>Specify the key ID or key ARN of the
|
|
4563
|
+
* <p>Updates the description of the specified KMS key.</p>
|
|
4564
|
+
* <p>Specify the key ID or key ARN of the KMS key.</p>
|
|
4547
4565
|
* <p>For example:</p>
|
|
4548
4566
|
* <ul>
|
|
4549
4567
|
* <li>
|
|
@@ -4555,12 +4573,12 @@ export interface UpdateKeyDescriptionRequest {
|
|
|
4555
4573
|
* </p>
|
|
4556
4574
|
* </li>
|
|
4557
4575
|
* </ul>
|
|
4558
|
-
* <p>To get the key ID and key ARN for a
|
|
4576
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4559
4577
|
*/
|
|
4560
4578
|
KeyId: string | undefined;
|
|
4561
4579
|
|
|
4562
4580
|
/**
|
|
4563
|
-
* <p>New description for the
|
|
4581
|
+
* <p>New description for the KMS key.</p>
|
|
4564
4582
|
*/
|
|
4565
4583
|
Description: string | undefined;
|
|
4566
4584
|
}
|
|
@@ -4576,7 +4594,7 @@ export namespace UpdateKeyDescriptionRequest {
|
|
|
4576
4594
|
|
|
4577
4595
|
export interface UpdatePrimaryRegionRequest {
|
|
4578
4596
|
/**
|
|
4579
|
-
* <p>Identifies the current primary key. When the operation completes, this
|
|
4597
|
+
* <p>Identifies the current primary key. When the operation completes, this KMS key will be a
|
|
4580
4598
|
* replica key.</p>
|
|
4581
4599
|
*
|
|
4582
4600
|
* <p>Specify the key ID or key ARN of a multi-Region primary key.</p>
|
|
@@ -4591,12 +4609,12 @@ export interface UpdatePrimaryRegionRequest {
|
|
|
4591
4609
|
* </p>
|
|
4592
4610
|
* </li>
|
|
4593
4611
|
* </ul>
|
|
4594
|
-
* <p>To get the key ID and key ARN for a
|
|
4612
|
+
* <p>To get the key ID and key ARN for a KMS key, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>
|
|
4595
4613
|
*/
|
|
4596
4614
|
KeyId: string | undefined;
|
|
4597
4615
|
|
|
4598
4616
|
/**
|
|
4599
|
-
* <p>The
|
|
4617
|
+
* <p>The Amazon Web Services Region of the new primary key. Enter the Region ID, such as <code>us-east-1</code>
|
|
4600
4618
|
* or <code>ap-southeast-2</code>. There must be an existing replica key in this Region. </p>
|
|
4601
4619
|
* <p>When the operation completes, the multi-Region key in this Region will be the primary
|
|
4602
4620
|
* key.</p>
|
|
@@ -4615,10 +4633,10 @@ export namespace UpdatePrimaryRegionRequest {
|
|
|
4615
4633
|
|
|
4616
4634
|
export interface VerifyRequest {
|
|
4617
4635
|
/**
|
|
4618
|
-
* <p>Identifies the asymmetric
|
|
4619
|
-
* same
|
|
4636
|
+
* <p>Identifies the asymmetric KMS key that will be used to verify the signature. This must be the
|
|
4637
|
+
* same KMS key that was used to generate the signature. If you specify a different KMS key, the
|
|
4620
4638
|
* signature verification fails.</p>
|
|
4621
|
-
* <p>To specify a
|
|
4639
|
+
* <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>
|
|
4622
4640
|
* <p>For example:</p>
|
|
4623
4641
|
* <ul>
|
|
4624
4642
|
* <li>
|
|
@@ -4638,7 +4656,7 @@ export interface VerifyRequest {
|
|
|
4638
4656
|
* </p>
|
|
4639
4657
|
* </li>
|
|
4640
4658
|
* </ul>
|
|
4641
|
-
* <p>To get the key ID and key ARN for a
|
|
4659
|
+
* <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>
|
|
4642
4660
|
*/
|
|
4643
4661
|
KeyId: string | undefined;
|
|
4644
4662
|
|
|
@@ -4653,7 +4671,7 @@ export interface VerifyRequest {
|
|
|
4653
4671
|
Message: Uint8Array | undefined;
|
|
4654
4672
|
|
|
4655
4673
|
/**
|
|
4656
|
-
* <p>Tells
|
|
4674
|
+
* <p>Tells KMS whether the value of the <code>Message</code> parameter is a message or
|
|
4657
4675
|
* message digest. The default value, RAW, indicates a message. To indicate a message digest,
|
|
4658
4676
|
* enter <code>DIGEST</code>.</p>
|
|
4659
4677
|
* <important>
|
|
@@ -4677,8 +4695,8 @@ export interface VerifyRequest {
|
|
|
4677
4695
|
|
|
4678
4696
|
/**
|
|
4679
4697
|
* <p>A list of grant tokens.</p>
|
|
4680
|
-
* <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/
|
|
4681
|
-
* <i>
|
|
4698
|
+
* <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
|
|
4699
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
4682
4700
|
*/
|
|
4683
4701
|
GrantTokens?: string[];
|
|
4684
4702
|
}
|
|
@@ -4695,7 +4713,7 @@ export namespace VerifyRequest {
|
|
|
4695
4713
|
|
|
4696
4714
|
export interface VerifyResponse {
|
|
4697
4715
|
/**
|
|
4698
|
-
* <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
|
|
4716
|
+
* <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>
|
|
4699
4717
|
*/
|
|
4700
4718
|
KeyId?: string;
|
|
4701
4719
|
|