@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/dist/types/KMS.d.ts
CHANGED
|
@@ -49,22 +49,23 @@ import { UpdatePrimaryRegionCommandInput, UpdatePrimaryRegionCommandOutput } fro
|
|
|
49
49
|
import { VerifyCommandInput, VerifyCommandOutput } from "./commands/VerifyCommand";
|
|
50
50
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
51
51
|
/**
|
|
52
|
-
* <fullname>
|
|
53
|
-
* <p>
|
|
54
|
-
* the
|
|
52
|
+
* <fullname>Key Management Service</fullname>
|
|
53
|
+
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
54
|
+
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
55
55
|
* see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
|
|
56
|
-
* <i>
|
|
56
|
+
* <i>Key Management Service Developer Guide</i>
|
|
57
57
|
* </a>.</p>
|
|
58
58
|
* <note>
|
|
59
|
-
* <p>
|
|
59
|
+
* <p>KMS is replacing the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
60
|
+
* <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
|
|
60
61
|
* languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
|
|
61
|
-
* convenient way to create programmatic access to
|
|
62
|
+
* convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
|
|
62
63
|
* the SDKs take care of tasks such as signing requests (see below), managing errors, and
|
|
63
|
-
* retrying requests automatically. For more information about the
|
|
64
|
+
* retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
|
|
64
65
|
* download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
|
|
65
66
|
* Services</a>.</p>
|
|
66
67
|
* </note>
|
|
67
|
-
* <p>We recommend that you use the
|
|
68
|
+
* <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
|
|
68
69
|
* <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
|
|
69
70
|
* must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
|
|
70
71
|
* Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
|
|
@@ -73,19 +74,18 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
73
74
|
* <b>Signing Requests</b>
|
|
74
75
|
* </p>
|
|
75
76
|
* <p>Requests must be signed by using an access key ID and a secret access key. We strongly
|
|
76
|
-
* recommend that you <i>do not</i> use your
|
|
77
|
-
* secret key for everyday work with
|
|
78
|
-
* for an IAM user. You can also use the
|
|
77
|
+
* recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
|
|
78
|
+
* secret key for everyday work with KMS. Instead, use the access key ID and secret access key
|
|
79
|
+
* for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
|
|
79
80
|
* security credentials that you can use to sign requests.</p>
|
|
80
|
-
* <p>All
|
|
81
|
+
* <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
81
82
|
* <p>
|
|
82
83
|
* <b>Logging API Requests</b>
|
|
83
84
|
* </p>
|
|
84
|
-
* <p>
|
|
85
|
-
*
|
|
86
|
-
* collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request,
|
|
85
|
+
* <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information
|
|
86
|
+
* collected by CloudTrail, you can determine what requests were made to KMS, who made the request,
|
|
87
87
|
* when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find
|
|
88
|
-
* your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">
|
|
88
|
+
* your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
89
89
|
* <p>
|
|
90
90
|
* <b>Additional Resources</b>
|
|
91
91
|
* </p>
|
|
@@ -93,9 +93,9 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
93
93
|
* <ul>
|
|
94
94
|
* <li>
|
|
95
95
|
* <p>
|
|
96
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">
|
|
96
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services Security
|
|
97
97
|
* Credentials</a> - This topic provides general information about the types of
|
|
98
|
-
* credentials used
|
|
98
|
+
* credentials used to access Amazon Web Services.</p>
|
|
99
99
|
* </li>
|
|
100
100
|
* <li>
|
|
101
101
|
* <p>
|
|
@@ -141,14 +141,13 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
141
141
|
*/
|
|
142
142
|
export declare class KMS extends KMSClient {
|
|
143
143
|
/**
|
|
144
|
-
* <p>Cancels the deletion of a
|
|
145
|
-
* state of the
|
|
146
|
-
* <p>For more information about scheduling and canceling deletion of a
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
144
|
+
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key
|
|
145
|
+
* state of the KMS key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
146
|
+
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
147
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
148
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
150
149
|
* <p>
|
|
151
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
150
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
152
151
|
* <p>
|
|
153
152
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CancelKeyDeletion</a> (key policy)</p>
|
|
154
153
|
* <p>
|
|
@@ -159,24 +158,24 @@ export declare class KMS extends KMSClient {
|
|
|
159
158
|
cancelKeyDeletion(args: CancelKeyDeletionCommandInput, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
|
|
160
159
|
cancelKeyDeletion(args: CancelKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
|
|
161
160
|
/**
|
|
162
|
-
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated
|
|
163
|
-
* <p>The custom key store must be connected before you can create
|
|
164
|
-
* in the key store or use the
|
|
161
|
+
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated CloudHSM cluster.</p>
|
|
162
|
+
* <p>The custom key store must be connected before you can create KMS keys
|
|
163
|
+
* in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key
|
|
165
164
|
* store at any time.</p>
|
|
166
|
-
* <p>To connect a custom key store, its associated
|
|
165
|
+
* <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
|
|
167
166
|
* HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs
|
|
168
167
|
* to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
169
168
|
* <code>kmsuser</code> crypto
|
|
170
|
-
* user</a> (CU) must not be logged into the cluster. This prevents
|
|
169
|
+
* user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
|
|
171
170
|
* account to log in.</p>
|
|
172
171
|
* <p>The connection process can take an extended amount of time to complete; up to 20 minutes.
|
|
173
172
|
* This operation starts the connection process, but it does not wait for it to complete. When it
|
|
174
173
|
* succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no
|
|
175
174
|
* properties. However, this response does not indicate that the custom key store is connected.
|
|
176
175
|
* To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
177
|
-
* <p>During the connection process,
|
|
176
|
+
* <p>During the connection process, KMS finds the CloudHSM cluster that is associated with the
|
|
178
177
|
* custom key store, creates the connection infrastructure, connects to the cluster, logs into
|
|
179
|
-
* the
|
|
178
|
+
* the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p>
|
|
180
179
|
* <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
|
|
181
180
|
* the reason, use the <a>DescribeCustomKeyStores</a> operation and see the
|
|
182
181
|
* <code>ConnectionErrorCode</code> in the response. For help interpreting the
|
|
@@ -185,9 +184,9 @@ export declare class KMS extends KMSClient {
|
|
|
185
184
|
* disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use
|
|
186
185
|
* <code>ConnectCustomKeyStore</code> again.</p>
|
|
187
186
|
* <p>If you are having trouble connecting or disconnecting a custom key store, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key
|
|
188
|
-
* Store</a> in the <i>
|
|
187
|
+
* Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
189
188
|
* <p>
|
|
190
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
189
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
191
190
|
*
|
|
192
191
|
* <p>
|
|
193
192
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ConnectCustomKeyStore</a> (IAM policy)</p>
|
|
@@ -226,26 +225,25 @@ export declare class KMS extends KMSClient {
|
|
|
226
225
|
connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
|
|
227
226
|
connectCustomKeyStore(args: ConnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ConnectCustomKeyStoreCommandOutput) => void): void;
|
|
228
227
|
/**
|
|
229
|
-
* <p>Creates a friendly name for a
|
|
228
|
+
* <p>Creates a friendly name for a KMS key. </p>
|
|
230
229
|
* <note>
|
|
231
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
230
|
+
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
232
231
|
* </note>
|
|
233
|
-
* <p>You can use an alias to identify a
|
|
234
|
-
* <a>GenerateDataKey</a>. You can also change the
|
|
232
|
+
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and
|
|
233
|
+
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with the
|
|
235
234
|
* alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>) at
|
|
236
|
-
* any time. These operations don't affect the underlying
|
|
237
|
-
* <p>You can associate the alias with any customer managed
|
|
238
|
-
* alias is associated with only one
|
|
239
|
-
* CMK is required. You can't create an alias without a CMK.</p>
|
|
235
|
+
* any time. These operations don't affect the underlying KMS key. </p>
|
|
236
|
+
* <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
|
|
237
|
+
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.</p>
|
|
240
238
|
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
241
239
|
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">Using aliases</a> in the
|
|
242
|
-
* <i>
|
|
240
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
243
241
|
* <p>This operation does not return a response. To get the alias that you created, use the
|
|
244
242
|
* <a>ListAliases</a> operation.</p>
|
|
245
|
-
* <p>The
|
|
246
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
243
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
244
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
247
245
|
* <p>
|
|
248
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
246
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
249
247
|
*
|
|
250
248
|
* <p>
|
|
251
249
|
* <b>Required permissions</b>
|
|
@@ -257,10 +255,10 @@ export declare class KMS extends KMSClient {
|
|
|
257
255
|
* </li>
|
|
258
256
|
* <li>
|
|
259
257
|
* <p>
|
|
260
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on the
|
|
258
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on the KMS key (key policy).</p>
|
|
261
259
|
* </li>
|
|
262
260
|
* </ul>
|
|
263
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
261
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
264
262
|
* <p>
|
|
265
263
|
* <b>Related operations:</b>
|
|
266
264
|
* </p>
|
|
@@ -286,24 +284,24 @@ export declare class KMS extends KMSClient {
|
|
|
286
284
|
createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
|
|
287
285
|
createAlias(args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
|
|
288
286
|
/**
|
|
289
|
-
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">
|
|
287
|
+
* <p>Creates a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> that is associated with an <a href="https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html">CloudHSM cluster</a> that you own and
|
|
290
288
|
* manage.</p>
|
|
291
|
-
* <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
|
|
292
|
-
* combines the convenience and extensive integration of
|
|
289
|
+
* <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
|
|
290
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
293
291
|
* single-tenant key store.</p>
|
|
294
292
|
* <p>Before you create the custom key store, you must assemble
|
|
295
|
-
* the required elements, including an
|
|
293
|
+
* the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
|
|
296
294
|
* key store. For details about the required elements, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore">Assemble the Prerequisites</a>
|
|
297
|
-
* in the <i>
|
|
295
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
298
296
|
* <p>When the operation completes successfully, it returns the ID of the new custom key store.
|
|
299
|
-
* Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its
|
|
297
|
+
* Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its CloudHSM
|
|
300
298
|
* cluster. Even if you are not going to use your custom key store immediately, you might want to
|
|
301
299
|
* connect it to verify that all settings are correct and then disconnect it until you are ready
|
|
302
300
|
* to use it.</p>
|
|
303
301
|
* <p>For help with failures, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting a Custom Key Store</a> in the
|
|
304
|
-
* <i>
|
|
302
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
305
303
|
* <p>
|
|
306
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
304
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
307
305
|
* <p>
|
|
308
306
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateCustomKeyStore</a> (IAM policy).</p>
|
|
309
307
|
* <p>
|
|
@@ -341,45 +339,38 @@ export declare class KMS extends KMSClient {
|
|
|
341
339
|
createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
|
|
342
340
|
createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
|
|
343
341
|
/**
|
|
344
|
-
* <p>Adds a grant to a
|
|
345
|
-
* <p>A <i>grant</i> is a policy instrument that allows
|
|
346
|
-
* KMS customer master keys (CMKs) in cryptographic operations. It also can allow them to view a
|
|
347
|
-
* CMK (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a
|
|
348
|
-
* CMK, grants are considered along with key policies and IAM policies. Grants are often used for
|
|
342
|
+
* <p>Adds a grant to a KMS key. </p>
|
|
343
|
+
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for
|
|
349
344
|
* temporary permissions because you can create one, use its permissions, and delete it without
|
|
350
345
|
* changing your key policies or IAM policies. </p>
|
|
351
346
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
352
347
|
* <i>
|
|
353
|
-
* <i>
|
|
348
|
+
* <i>Key Management Service Developer Guide</i>
|
|
354
349
|
* </i>. For examples of working with grants in several
|
|
355
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
350
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
356
351
|
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
357
|
-
*
|
|
352
|
+
* <code>GrantId</code>.</p>
|
|
358
353
|
* <ul>
|
|
359
354
|
* <li>
|
|
360
|
-
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout
|
|
361
|
-
*
|
|
355
|
+
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee principal
|
|
356
|
+
* can use the permissions in the grant without identifying the grant. </p>
|
|
362
357
|
* <p>However, to use the permissions in the grant immediately, use the
|
|
363
|
-
*
|
|
358
|
+
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a grant
|
|
364
359
|
* token</a> in the <i>
|
|
365
|
-
* <i>
|
|
360
|
+
* <i>Key Management Service Developer Guide</i>
|
|
366
361
|
* </i>.</p>
|
|
367
362
|
* </li>
|
|
368
363
|
* <li>
|
|
369
364
|
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can use the
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
365
|
+
* <code>GrantId</code> and a key identifier to identify the grant in the <a>RetireGrant</a> and <a>RevokeGrant</a> operations. To find the grant
|
|
366
|
+
* ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
|
|
367
|
+
* operations.</p>
|
|
373
368
|
* </li>
|
|
374
369
|
* </ul>
|
|
375
|
-
* <p>
|
|
376
|
-
*
|
|
377
|
-
* <i>AWS Key Management Service Developer Guide</i>
|
|
378
|
-
* </i>.</p>
|
|
379
|
-
* <p>The CMK that you use for this operation must be in a compatible key state. For
|
|
380
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
370
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
371
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
381
372
|
* <p>
|
|
382
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
373
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
383
374
|
* ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
384
375
|
* <p>
|
|
385
376
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateGrant</a> (key policy)</p>
|
|
@@ -413,109 +404,109 @@ export declare class KMS extends KMSClient {
|
|
|
413
404
|
createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
414
405
|
createGrant(args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
415
406
|
/**
|
|
416
|
-
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#
|
|
417
|
-
*
|
|
407
|
+
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and Region.</p>
|
|
408
|
+
* <note>
|
|
409
|
+
* <p>KMS is replacing the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
410
|
+
* </note>
|
|
418
411
|
*
|
|
419
|
-
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric
|
|
420
|
-
* CMKs.</p>
|
|
412
|
+
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS keys.</p>
|
|
421
413
|
* <ul>
|
|
422
414
|
* <li>
|
|
423
415
|
* <p>
|
|
424
|
-
* <b>Symmetric
|
|
425
|
-
* never leaves
|
|
426
|
-
* symmetric
|
|
416
|
+
* <b>Symmetric KMS keys</b> contain a 256-bit symmetric key that
|
|
417
|
+
* never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use a
|
|
418
|
+
* symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically used to
|
|
427
419
|
* generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|
428
420
|
* keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
|
|
429
421
|
* see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
|
|
430
422
|
* </li>
|
|
431
423
|
* <li>
|
|
432
424
|
* <p>
|
|
433
|
-
* <b>Asymmetric
|
|
434
|
-
* Elliptic Curve (ECC) key pair. The private key in an asymmetric
|
|
425
|
+
* <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
|
|
426
|
+
* Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
|
|
435
427
|
* unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
|
|
436
|
-
* the public key so it can be used outside of
|
|
437
|
-
* encrypt or decrypt data or sign and verify messages (but not both).
|
|
428
|
+
* the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used to
|
|
429
|
+
* encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key
|
|
438
430
|
* pairs can be used only to sign and verify messages.</p>
|
|
439
431
|
* </li>
|
|
440
432
|
* </ul>
|
|
441
|
-
* <p>For information about symmetric and asymmetric
|
|
433
|
+
* <p>For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
442
434
|
*
|
|
443
435
|
*
|
|
444
|
-
* <p>To create different types of
|
|
436
|
+
* <p>To create different types of KMS keys, use the following guidance:</p>
|
|
445
437
|
*
|
|
446
438
|
* <dl>
|
|
447
|
-
* <dt>Asymmetric
|
|
439
|
+
* <dt>Asymmetric KMS keys</dt>
|
|
448
440
|
* <dd>
|
|
449
|
-
* <p>To create an asymmetric
|
|
450
|
-
*
|
|
451
|
-
*
|
|
452
|
-
*
|
|
441
|
+
* <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify
|
|
442
|
+
* the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter
|
|
443
|
+
* to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.
|
|
444
|
+
* You can't change these properties after the KMS key is created.</p>
|
|
453
445
|
* <p> </p>
|
|
454
446
|
* </dd>
|
|
455
|
-
* <dt>Symmetric
|
|
447
|
+
* <dt>Symmetric KMS keys</dt>
|
|
456
448
|
* <dd>
|
|
457
|
-
* <p>When creating a symmetric
|
|
458
|
-
* <code>
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
449
|
+
* <p>When creating a symmetric KMS key, you don't need to specify the
|
|
450
|
+
* <code>KeySpec</code> or <code>KeyUsage</code> parameters. The default value for
|
|
451
|
+
* <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for
|
|
452
|
+
* <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for
|
|
453
|
+
* symmetric KMS keys. </p>
|
|
462
454
|
* <p> </p>
|
|
463
455
|
* </dd>
|
|
464
456
|
* <dt>Multi-Region primary keys</dt>
|
|
465
457
|
* <dt>Imported key material</dt>
|
|
466
458
|
* <dd>
|
|
467
|
-
* <p>To create a multi-Region <i>primary key</i> in the local
|
|
459
|
+
* <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
|
|
468
460
|
* use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
|
|
469
|
-
* a multi-Region <i>replica key</i>, that is, a
|
|
470
|
-
* key material as a primary key, but in a different
|
|
461
|
+
* a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID and
|
|
462
|
+
* key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its
|
|
471
463
|
* primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
|
|
472
464
|
* operation.</p>
|
|
473
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
474
|
-
* interoperable
|
|
475
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
476
|
-
* it in a different
|
|
465
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
466
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
467
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
468
|
+
* 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>
|
|
477
469
|
* <p>You can create symmetric and asymmetric multi-Region keys and multi-Region keys with
|
|
478
470
|
* imported key material. You cannot create multi-Region keys in a custom key store.</p>
|
|
479
471
|
* <p> </p>
|
|
480
472
|
* </dd>
|
|
481
473
|
* <dd>
|
|
482
|
-
* <p>To import your own key material, begin by creating a symmetric
|
|
474
|
+
* <p>To import your own key material, begin by creating a symmetric KMS key with no key
|
|
483
475
|
* material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code>
|
|
484
476
|
* with a value of <code>EXTERNAL</code>. Next, use <a>GetParametersForImport</a> operation to get a public key and import token, and use the public key to encrypt
|
|
485
477
|
* your key material. Then, use <a>ImportKeyMaterial</a> with your import token
|
|
486
478
|
* to import the key material. For step-by-step instructions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the <i>
|
|
487
|
-
* <i>
|
|
479
|
+
* <i>Key Management Service Developer Guide</i>
|
|
488
480
|
* </i>. You
|
|
489
|
-
* cannot import the key material into an asymmetric
|
|
481
|
+
* cannot import the key material into an asymmetric KMS key.</p>
|
|
490
482
|
* <p>To create a multi-Region primary key with imported key material, use the
|
|
491
483
|
* <code>Origin</code> parameter of <code>CreateKey</code> with a value of
|
|
492
484
|
* <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
|
|
493
|
-
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. 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>
|
|
485
|
+
* <code>True</code>. To create replicas of the multi-Region primary key, use the <a>ReplicateKey</a> operation. 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>
|
|
494
486
|
* <p> </p>
|
|
495
487
|
* </dd>
|
|
496
488
|
* <dt>Custom key store</dt>
|
|
497
489
|
* <dd>
|
|
498
|
-
* <p>To create a symmetric
|
|
490
|
+
* <p>To create a symmetric KMS key in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, use the
|
|
499
491
|
* <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also
|
|
500
492
|
* use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
|
|
501
|
-
*
|
|
502
|
-
* HSMs in different Availability Zones in the
|
|
503
|
-
* <p>You cannot create an asymmetric
|
|
504
|
-
*
|
|
493
|
+
* CloudHSM cluster that is associated with the custom key store must have at least two active
|
|
494
|
+
* HSMs in different Availability Zones in the Amazon Web Services Region. </p>
|
|
495
|
+
* <p>You cannot create an asymmetric KMS key in a custom key store. For information about
|
|
496
|
+
* custom key stores in KMS see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Using Custom Key Stores</a> in
|
|
505
497
|
* the <i>
|
|
506
|
-
* <i>
|
|
498
|
+
* <i>Key Management Service Developer Guide</i>
|
|
507
499
|
* </i>.</p>
|
|
508
500
|
* </dd>
|
|
509
501
|
* </dl>
|
|
510
502
|
* <p>
|
|
511
503
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
512
|
-
* create a
|
|
504
|
+
* create a KMS key in a different Amazon Web Services account.</p>
|
|
513
505
|
*
|
|
514
506
|
* <p>
|
|
515
507
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
|
|
516
508
|
* <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
|
|
517
|
-
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create
|
|
518
|
-
* CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
509
|
+
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
519
510
|
* <p>
|
|
520
511
|
* <b>Related operations:</b>
|
|
521
512
|
* </p>
|
|
@@ -541,7 +532,7 @@ export declare class KMS extends KMSClient {
|
|
|
541
532
|
createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
542
533
|
createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
543
534
|
/**
|
|
544
|
-
* <p>Decrypts ciphertext that was encrypted by a
|
|
535
|
+
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of
|
|
545
536
|
* the following operations:</p>
|
|
546
537
|
* <ul>
|
|
547
538
|
* <li>
|
|
@@ -571,33 +562,34 @@ export declare class KMS extends KMSClient {
|
|
|
571
562
|
* </li>
|
|
572
563
|
* </ul>
|
|
573
564
|
* <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
|
|
574
|
-
* asymmetric
|
|
575
|
-
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric
|
|
576
|
-
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of
|
|
577
|
-
* public key in an
|
|
578
|
-
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">
|
|
565
|
+
* asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption
|
|
566
|
+
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
567
|
+
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
|
|
568
|
+
* public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other
|
|
569
|
+
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption
|
|
579
570
|
* SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>. These libraries return a ciphertext format that
|
|
580
|
-
* is incompatible with
|
|
581
|
-
* <p>If the ciphertext was encrypted under a symmetric
|
|
582
|
-
* optional.
|
|
571
|
+
* is incompatible with KMS.</p>
|
|
572
|
+
* <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code> parameter is
|
|
573
|
+
* optional. KMS can get this information from metadata that it adds to the symmetric
|
|
583
574
|
* ciphertext blob. This feature adds durability to your implementation by ensuring that
|
|
584
575
|
* authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost
|
|
585
|
-
* track of the
|
|
586
|
-
* When you use the <code>KeyId</code> parameter to specify a
|
|
587
|
-
* specify. If the ciphertext was encrypted under a different
|
|
588
|
-
* operation fails. This practice ensures that you use the
|
|
576
|
+
* track of the key ID. However, specifying the KMS key is always recommended as a best practice.
|
|
577
|
+
* When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses the KMS key you
|
|
578
|
+
* specify. If the ciphertext was encrypted under a different KMS key, the <code>Decrypt</code>
|
|
579
|
+
* operation fails. This practice ensures that you use the KMS key that you intend.</p>
|
|
589
580
|
* <p>Whenever possible, use key policies to give users permission to call the
|
|
590
|
-
* <code>Decrypt</code> operation on a particular
|
|
581
|
+
* <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
|
|
591
582
|
* Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
|
|
592
|
-
* permission on all
|
|
593
|
-
* accounts if the key policy for the cross-account
|
|
594
|
-
* for <code>Decrypt</code> permissions, limit the user to particular
|
|
595
|
-
* accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM policies</a> in the <i>
|
|
596
|
-
* <p>
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
583
|
+
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other
|
|
584
|
+
* accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy
|
|
585
|
+
* for <code>Decrypt</code> permissions, limit the user to particular KMS keys or particular trusted
|
|
586
|
+
* accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
587
|
+
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
588
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
589
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
590
|
+
* <p>
|
|
591
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
592
|
+
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
601
593
|
*
|
|
602
594
|
* <p>
|
|
603
595
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:Decrypt</a> (key policy)</p>
|
|
@@ -633,15 +625,14 @@ export declare class KMS extends KMSClient {
|
|
|
633
625
|
/**
|
|
634
626
|
* <p>Deletes the specified alias. </p>
|
|
635
627
|
* <note>
|
|
636
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
628
|
+
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
637
629
|
* </note>
|
|
638
|
-
* <p>Because an alias is not a property of a
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
* create a new alias. To associate an existing alias with a different customer master key (CMK),
|
|
630
|
+
* <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
|
|
631
|
+
* <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to
|
|
632
|
+
* create a new alias. To associate an existing alias with a different KMS key,
|
|
642
633
|
* call <a>UpdateAlias</a>.</p>
|
|
643
634
|
* <p>
|
|
644
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
635
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
645
636
|
* <p>
|
|
646
637
|
* <b>Required permissions</b>
|
|
647
638
|
* </p>
|
|
@@ -652,10 +643,10 @@ export declare class KMS extends KMSClient {
|
|
|
652
643
|
* </li>
|
|
653
644
|
* <li>
|
|
654
645
|
* <p>
|
|
655
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the
|
|
646
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the KMS key (key policy).</p>
|
|
656
647
|
* </li>
|
|
657
648
|
* </ul>
|
|
658
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
649
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
659
650
|
* <p>
|
|
660
651
|
* <b>Related operations:</b>
|
|
661
652
|
* </p>
|
|
@@ -681,29 +672,29 @@ export declare class KMS extends KMSClient {
|
|
|
681
672
|
deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
|
|
682
673
|
deleteAlias(args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
|
|
683
674
|
/**
|
|
684
|
-
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the
|
|
675
|
+
* <p>Deletes a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. This operation does not delete the CloudHSM cluster that is
|
|
685
676
|
* associated with the custom key store, or affect any users or keys in the cluster.</p>
|
|
686
|
-
* <p>The custom key store that you delete cannot contain any
|
|
687
|
-
* deleting the key store, verify that you will never need to use any of the
|
|
677
|
+
* <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before
|
|
678
|
+
* deleting the key store, verify that you will never need to use any of the KMS keys in the key
|
|
688
679
|
* store for any <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. Then, use <a>ScheduleKeyDeletion</a> to delete the
|
|
689
|
-
*
|
|
690
|
-
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the
|
|
680
|
+
* KMS keys from the key store. When the scheduled waiting period
|
|
681
|
+
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the KMS keys. Then it makes a best
|
|
691
682
|
* effort to delete the key material from the associated cluster. However, you might need to
|
|
692
683
|
* manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
693
684
|
* material</a> from the cluster and its backups.</p>
|
|
694
|
-
* <p>After all
|
|
695
|
-
* disconnect the key store from
|
|
696
|
-
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from
|
|
697
|
-
* disconnected, you cannot create or use the
|
|
698
|
-
* delete
|
|
685
|
+
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a> to
|
|
686
|
+
* disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
687
|
+
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
|
|
688
|
+
* disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
|
|
689
|
+
* delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
|
|
699
690
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
700
691
|
* properties.</p>
|
|
701
|
-
* <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
|
|
702
|
-
* combines the convenience and extensive integration of
|
|
692
|
+
* <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
|
|
693
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
703
694
|
* single-tenant key store.</p>
|
|
704
695
|
*
|
|
705
696
|
* <p>
|
|
706
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
697
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
707
698
|
*
|
|
708
699
|
* <p>
|
|
709
700
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteCustomKeyStore</a> (IAM policy)</p>
|
|
@@ -743,18 +734,18 @@ export declare class KMS extends KMSClient {
|
|
|
743
734
|
deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
|
|
744
735
|
/**
|
|
745
736
|
* <p>Deletes key material that you previously imported. This operation makes the specified
|
|
746
|
-
*
|
|
747
|
-
*
|
|
748
|
-
* Material</a> in the <i>
|
|
749
|
-
* <p>When the specified
|
|
750
|
-
* not change the
|
|
737
|
+
* KMS key unusable. For more information about importing key material into
|
|
738
|
+
* KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
739
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
740
|
+
* <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does
|
|
741
|
+
* not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
751
742
|
* <code>PendingImport</code>.</p>
|
|
752
743
|
* <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
|
|
753
|
-
* the same key material into the
|
|
754
|
-
* <p>The
|
|
755
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
744
|
+
* the same key material into the KMS key.</p>
|
|
745
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
746
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
756
747
|
* <p>
|
|
757
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
748
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
758
749
|
*
|
|
759
750
|
* <p>
|
|
760
751
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteImportedKeyMaterial</a> (key policy)</p>
|
|
@@ -779,14 +770,14 @@ export declare class KMS extends KMSClient {
|
|
|
779
770
|
deleteImportedKeyMaterial(args: DeleteImportedKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteImportedKeyMaterialCommandOutput) => void): void;
|
|
780
771
|
/**
|
|
781
772
|
* <p>Gets information about <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key stores</a> in the account and Region.</p>
|
|
782
|
-
* <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
|
|
783
|
-
* combines the convenience and extensive integration of
|
|
773
|
+
* <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
|
|
774
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
784
775
|
* single-tenant key store.</p>
|
|
785
776
|
* <p>By default, this operation returns information about all custom key stores in the account and
|
|
786
777
|
* Region. To get only information about a particular custom key store, use either the
|
|
787
778
|
* <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not
|
|
788
779
|
* both).</p>
|
|
789
|
-
* <p>To determine whether the custom key store is connected to its
|
|
780
|
+
* <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
|
|
790
781
|
* <code>ConnectionState</code> element in the response. If an attempt to connect the custom
|
|
791
782
|
* key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
|
|
792
783
|
* <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
|
|
@@ -794,12 +785,12 @@ export declare class KMS extends KMSClient {
|
|
|
794
785
|
* <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
|
|
795
786
|
* never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
|
|
796
787
|
* disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
|
|
797
|
-
* trouble using it, make sure that its associated
|
|
788
|
+
* trouble using it, make sure that its associated CloudHSM cluster is active and contains the
|
|
798
789
|
* minimum number of HSMs required for the operation, if any.</p>
|
|
799
790
|
* <p> For help repairing your custom key store, see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html">Troubleshooting Custom Key Stores</a> topic in the
|
|
800
|
-
* <i>
|
|
791
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
801
792
|
* <p>
|
|
802
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
793
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
803
794
|
* <p>
|
|
804
795
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DescribeCustomKeyStores</a> (IAM policy)</p>
|
|
805
796
|
* <p>
|
|
@@ -837,41 +828,40 @@ export declare class KMS extends KMSClient {
|
|
|
837
828
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
838
829
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
839
830
|
/**
|
|
840
|
-
* <p>Provides detailed information about a
|
|
841
|
-
* <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
842
|
-
* CMK</a>.</p>
|
|
831
|
+
* <p>Provides detailed information about a KMS key. You can run
|
|
832
|
+
* <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a> or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.</p>
|
|
843
833
|
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
|
|
844
834
|
* applicable), the key state, and the origin and expiration date (if any) of the key material.
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
* the
|
|
835
|
+
* It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
|
|
836
|
+
* asymmetric KMS keys. It also provides information that is particularly important to asymmetric
|
|
837
|
+
* keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
|
|
838
|
+
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about
|
|
839
|
+
* the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region
|
|
840
|
+
* keys, it displays the primary key and all related replica keys. </p>
|
|
850
841
|
* <p>
|
|
851
842
|
* <code>DescribeKey</code> does not return the following information:</p>
|
|
852
843
|
* <ul>
|
|
853
844
|
* <li>
|
|
854
|
-
* <p>Aliases associated with the
|
|
845
|
+
* <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
|
|
855
846
|
* </li>
|
|
856
847
|
* <li>
|
|
857
|
-
* <p>Whether automatic key rotation is enabled on the
|
|
858
|
-
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a
|
|
848
|
+
* <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
|
|
849
|
+
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from being
|
|
859
850
|
* automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation
|
|
860
|
-
* Works</a> in <i>
|
|
851
|
+
* Works</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
861
852
|
* </li>
|
|
862
853
|
* <li>
|
|
863
|
-
* <p>Tags on the
|
|
854
|
+
* <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
|
|
864
855
|
* </li>
|
|
865
856
|
* <li>
|
|
866
|
-
* <p>Key policies and grants on the
|
|
857
|
+
* <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
|
|
867
858
|
* </li>
|
|
868
859
|
* </ul>
|
|
869
|
-
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined
|
|
870
|
-
*
|
|
871
|
-
*
|
|
872
|
-
* <code>Arn</code> of the new CMK in the response.</p>
|
|
860
|
+
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services alias</i>, that is, an Amazon Web Services alias with no key ID, KMS creates an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>.
|
|
861
|
+
* Then, it associates the alias with the new KMS key, and returns the <code>KeyId</code> and
|
|
862
|
+
* <code>Arn</code> of the new KMS key in the response.</p>
|
|
873
863
|
* <p>
|
|
874
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
864
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
875
865
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
876
866
|
*
|
|
877
867
|
* <p>
|
|
@@ -921,15 +911,15 @@ export declare class KMS extends KMSClient {
|
|
|
921
911
|
describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
922
912
|
describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
923
913
|
/**
|
|
924
|
-
* <p>Sets the state of a
|
|
925
|
-
* prevents use of the
|
|
926
|
-
* <p>For more information about how key state affects the use of a
|
|
927
|
-
* <i>
|
|
914
|
+
* <p>Sets the state of a KMS key to disabled. This change temporarily
|
|
915
|
+
* prevents use of the KMS key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
916
|
+
* <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>
|
|
917
|
+
* <i>Key Management Service Developer Guide</i>
|
|
928
918
|
* </i>.</p>
|
|
929
|
-
* <p>The
|
|
930
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
919
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
920
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
931
921
|
* <p>
|
|
932
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
922
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
933
923
|
*
|
|
934
924
|
* <p>
|
|
935
925
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKey</a> (key policy)</p>
|
|
@@ -942,13 +932,12 @@ export declare class KMS extends KMSClient {
|
|
|
942
932
|
disableKey(args: DisableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyCommandOutput) => void): void;
|
|
943
933
|
/**
|
|
944
934
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
945
|
-
* rotation of the key material</a> for the specified symmetric
|
|
946
|
-
*
|
|
947
|
-
* <p>
|
|
948
|
-
*
|
|
949
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
935
|
+
* rotation of the key material</a> for the specified symmetric KMS key.</p>
|
|
936
|
+
* <p> 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>
|
|
937
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
938
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
950
939
|
* <p>
|
|
951
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
940
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
952
941
|
*
|
|
953
942
|
* <p>
|
|
954
943
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisableKeyRotation</a> (key policy)</p>
|
|
@@ -972,13 +961,11 @@ export declare class KMS extends KMSClient {
|
|
|
972
961
|
disableKeyRotation(args: DisableKeyRotationCommandInput, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
|
|
973
962
|
disableKeyRotation(args: DisableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
|
|
974
963
|
/**
|
|
975
|
-
* <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated
|
|
976
|
-
* store is disconnected, you can manage the custom key store and its
|
|
977
|
-
* (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the
|
|
964
|
+
* <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated CloudHSM cluster. While a custom key
|
|
965
|
+
* store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use KMS keys in the custom key store. You can reconnect the
|
|
978
966
|
* custom key store at any time.</p>
|
|
979
967
|
* <note>
|
|
980
|
-
* <p>While a custom key store is disconnected, all attempts to create
|
|
981
|
-
* (CMKs) in the custom key store or to use existing CMKs in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will
|
|
968
|
+
* <p>While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a> will
|
|
982
969
|
* fail. This action can prevent users from storing and accessing sensitive data.</p>
|
|
983
970
|
* </note>
|
|
984
971
|
* <p></p>
|
|
@@ -986,12 +973,12 @@ export declare class KMS extends KMSClient {
|
|
|
986
973
|
* <a>ConnectCustomKeyStore</a> operation.</p>
|
|
987
974
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
988
975
|
* properties.</p>
|
|
989
|
-
* <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
|
|
990
|
-
* combines the convenience and extensive integration of
|
|
976
|
+
* <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
|
|
977
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
991
978
|
* single-tenant key store.</p>
|
|
992
979
|
*
|
|
993
980
|
* <p>
|
|
994
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
981
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
995
982
|
*
|
|
996
983
|
* <p>
|
|
997
984
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DisconnectCustomKeyStore</a> (IAM policy)</p>
|
|
@@ -1030,12 +1017,11 @@ export declare class KMS extends KMSClient {
|
|
|
1030
1017
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1031
1018
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1032
1019
|
/**
|
|
1033
|
-
* <p>Sets the key state of a
|
|
1034
|
-
*
|
|
1035
|
-
*
|
|
1036
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your CMK</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
1020
|
+
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
1021
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1022
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1037
1023
|
* <p>
|
|
1038
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1024
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1039
1025
|
*
|
|
1040
1026
|
* <p>
|
|
1041
1027
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKey</a> (key policy)</p>
|
|
@@ -1048,12 +1034,12 @@ export declare class KMS extends KMSClient {
|
|
|
1048
1034
|
enableKey(args: EnableKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyCommandOutput) => void): void;
|
|
1049
1035
|
/**
|
|
1050
1036
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
1051
|
-
* of the key material</a> for the specified symmetric
|
|
1052
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
1053
|
-
* <p>The
|
|
1054
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1037
|
+
* of the key material</a> for the specified symmetric KMS key.</p>
|
|
1038
|
+
* <p>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>
|
|
1039
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1040
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1055
1041
|
* <p>
|
|
1056
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1042
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1057
1043
|
*
|
|
1058
1044
|
* <p>
|
|
1059
1045
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:EnableKeyRotation</a> (key policy)</p>
|
|
@@ -1077,7 +1063,7 @@ export declare class KMS extends KMSClient {
|
|
|
1077
1063
|
enableKeyRotation(args: EnableKeyRotationCommandInput, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1078
1064
|
enableKeyRotation(args: EnableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1079
1065
|
/**
|
|
1080
|
-
* <p>Encrypts plaintext into ciphertext by using a
|
|
1066
|
+
* <p>Encrypts plaintext into ciphertext by using a KMS key. The
|
|
1081
1067
|
* <code>Encrypt</code> operation has two primary use cases:</p>
|
|
1082
1068
|
* <ul>
|
|
1083
1069
|
* <li>
|
|
@@ -1085,41 +1071,40 @@ export declare class KMS extends KMSClient {
|
|
|
1085
1071
|
* database password, or other sensitive information. </p>
|
|
1086
1072
|
* </li>
|
|
1087
1073
|
* <li>
|
|
1088
|
-
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one
|
|
1089
|
-
*
|
|
1090
|
-
*
|
|
1091
|
-
*
|
|
1092
|
-
* the encrypted data
|
|
1093
|
-
* and the encrypted data entirely within in Region B.</p>
|
|
1074
|
+
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt
|
|
1075
|
+
* your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the
|
|
1076
|
+
* plaintext data key under a KMS key in Region B. Now, you can move the encrypted data and the
|
|
1077
|
+
* encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and
|
|
1078
|
+
* the encrypted data entirely within in Region B.</p>
|
|
1094
1079
|
* </li>
|
|
1095
1080
|
* </ul>
|
|
1096
1081
|
*
|
|
1097
1082
|
* <p>You don't need to use the <code>Encrypt</code> operation to encrypt a data key. The <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a> operations return a
|
|
1098
1083
|
* plaintext data key and an encrypted copy of that data key.</p>
|
|
1099
1084
|
*
|
|
1100
|
-
* <p>When you encrypt data, you must specify a symmetric or asymmetric
|
|
1101
|
-
* encryption operation. The
|
|
1102
|
-
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a
|
|
1085
|
+
* <p>When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the
|
|
1086
|
+
* encryption operation. The KMS key must have a <code>KeyUsage</code> value of
|
|
1087
|
+
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1103
1088
|
*
|
|
1104
|
-
* <p>If you use a symmetric
|
|
1089
|
+
* <p>If you use a symmetric KMS key, you can use an encryption context to add additional security
|
|
1105
1090
|
* to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting
|
|
1106
1091
|
* data, you must specify the same encryption context (a case-sensitive exact match) when
|
|
1107
1092
|
* decrypting the data. Otherwise, the request to decrypt fails with an
|
|
1108
1093
|
* <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1109
|
-
* Context</a> in the <i>
|
|
1110
|
-
* <p>If you specify an asymmetric
|
|
1111
|
-
* algorithm must be compatible with the
|
|
1094
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1095
|
+
* <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
|
|
1096
|
+
* algorithm must be compatible with the KMS key type.</p>
|
|
1112
1097
|
* <important>
|
|
1113
|
-
* <p>When you use an asymmetric
|
|
1114
|
-
* <p>You are not required to supply the
|
|
1098
|
+
* <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
|
|
1099
|
+
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
1115
1100
|
* </important>
|
|
1116
1101
|
*
|
|
1117
1102
|
*
|
|
1118
|
-
* <p>The maximum size of the data that you can encrypt varies with the type of
|
|
1103
|
+
* <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
|
|
1119
1104
|
* encryption algorithm that you choose.</p>
|
|
1120
1105
|
* <ul>
|
|
1121
1106
|
* <li>
|
|
1122
|
-
* <p>Symmetric
|
|
1107
|
+
* <p>Symmetric KMS keys</p>
|
|
1123
1108
|
* <ul>
|
|
1124
1109
|
* <li>
|
|
1125
1110
|
* <p>
|
|
@@ -1173,10 +1158,10 @@ export declare class KMS extends KMSClient {
|
|
|
1173
1158
|
* </ul>
|
|
1174
1159
|
* </li>
|
|
1175
1160
|
* </ul>
|
|
1176
|
-
* <p>The
|
|
1177
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1161
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1162
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1178
1163
|
* <p>
|
|
1179
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1164
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1180
1165
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1181
1166
|
*
|
|
1182
1167
|
* <p>
|
|
@@ -1207,16 +1192,16 @@ export declare class KMS extends KMSClient {
|
|
|
1207
1192
|
encrypt(args: EncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EncryptCommandOutput) => void): void;
|
|
1208
1193
|
/**
|
|
1209
1194
|
* <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
|
|
1210
|
-
* plaintext copy of the data key and a copy that is encrypted under a
|
|
1211
|
-
* that you specify. You can use the plaintext key to encrypt your data outside of
|
|
1195
|
+
* plaintext copy of the data key and a copy that is encrypted under a KMS key
|
|
1196
|
+
* that you specify. You can use the plaintext key to encrypt your data outside of KMS and
|
|
1212
1197
|
* store the encrypted data key with the encrypted data.</p>
|
|
1213
1198
|
*
|
|
1214
1199
|
* <p>
|
|
1215
1200
|
* <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
|
|
1216
|
-
* plaintext key are not related to the caller or the
|
|
1201
|
+
* plaintext key are not related to the caller or the KMS key.</p>
|
|
1217
1202
|
*
|
|
1218
|
-
* <p>To generate a data key, specify the symmetric
|
|
1219
|
-
* key. You cannot use an asymmetric
|
|
1203
|
+
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the data
|
|
1204
|
+
* key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use
|
|
1220
1205
|
* the <a>DescribeKey</a> operation. You must also specify the length of the data key.
|
|
1221
1206
|
* Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both).
|
|
1222
1207
|
* For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
@@ -1229,45 +1214,44 @@ export declare class KMS extends KMSClient {
|
|
|
1229
1214
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1230
1215
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1231
1216
|
* Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
|
|
1232
|
-
* <i>
|
|
1233
|
-
* <p>
|
|
1234
|
-
*
|
|
1217
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1218
|
+
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1219
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1220
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1235
1221
|
* <p>
|
|
1236
|
-
* <b>How to use your
|
|
1237
|
-
* data key</b>
|
|
1222
|
+
* <b>How to use your data key</b>
|
|
1238
1223
|
* </p>
|
|
1239
|
-
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
1240
|
-
*
|
|
1241
|
-
* <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">AWS Encryption SDK</a>, the <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>, or
|
|
1224
|
+
* <p>We recommend that you use the following pattern to encrypt data locally in your application.
|
|
1225
|
+
* You can write your own code or use a client-side encryption library, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a>, the <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>, or
|
|
1242
1226
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
1243
1227
|
* client-side encryption</a> to do these tasks for you.</p>
|
|
1244
|
-
* <p>To encrypt data outside of
|
|
1228
|
+
* <p>To encrypt data outside of KMS:</p>
|
|
1245
1229
|
* <ol>
|
|
1246
1230
|
* <li>
|
|
1247
1231
|
* <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p>
|
|
1248
1232
|
* </li>
|
|
1249
1233
|
* <li>
|
|
1250
1234
|
* <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to
|
|
1251
|
-
* encrypt your data outside of
|
|
1235
|
+
* encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p>
|
|
1252
1236
|
* </li>
|
|
1253
1237
|
* <li>
|
|
1254
1238
|
* <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the
|
|
1255
1239
|
* response) with the encrypted data.</p>
|
|
1256
1240
|
* </li>
|
|
1257
1241
|
* </ol>
|
|
1258
|
-
* <p>To decrypt data outside of
|
|
1242
|
+
* <p>To decrypt data outside of KMS:</p>
|
|
1259
1243
|
* <ol>
|
|
1260
1244
|
* <li>
|
|
1261
1245
|
* <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The
|
|
1262
1246
|
* operation returns a plaintext copy of the data key.</p>
|
|
1263
1247
|
* </li>
|
|
1264
1248
|
* <li>
|
|
1265
|
-
* <p>Use the plaintext data key to decrypt data outside of
|
|
1249
|
+
* <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext
|
|
1266
1250
|
* data key from memory.</p>
|
|
1267
1251
|
* </li>
|
|
1268
1252
|
* </ol>
|
|
1269
1253
|
* <p>
|
|
1270
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1254
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1271
1255
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1272
1256
|
*
|
|
1273
1257
|
* <p>
|
|
@@ -1309,21 +1293,20 @@ export declare class KMS extends KMSClient {
|
|
|
1309
1293
|
/**
|
|
1310
1294
|
* <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
|
|
1311
1295
|
* operation returns a plaintext public key, a plaintext private key, and a copy of the private
|
|
1312
|
-
* key that is encrypted under the symmetric
|
|
1313
|
-
* perform asymmetric cryptography outside of
|
|
1314
|
-
*
|
|
1315
|
-
* <p>
|
|
1316
|
-
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1317
|
-
* bytes in the keys are not related to the caller or the CMK that is used to encrypt the private
|
|
1318
|
-
* key.</p>
|
|
1296
|
+
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to
|
|
1297
|
+
* perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
1319
1298
|
*
|
|
1320
1299
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
1321
|
-
* or verify a signature outside of
|
|
1300
|
+
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
1322
1301
|
* When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
|
|
1323
1302
|
*
|
|
1324
|
-
* <p>To generate a data key pair, you must specify a symmetric
|
|
1325
|
-
* encrypt the private key in a data key pair. You cannot use an asymmetric
|
|
1326
|
-
* custom key store. To get the type and origin of your
|
|
1303
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1304
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
1305
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1306
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1307
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1308
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
1309
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
1327
1310
|
*
|
|
1328
1311
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
1329
1312
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
@@ -1333,15 +1316,22 @@ export declare class KMS extends KMSClient {
|
|
|
1333
1316
|
* the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
|
|
1334
1317
|
* pair.</p>
|
|
1335
1318
|
*
|
|
1319
|
+
* <p>
|
|
1320
|
+
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1321
|
+
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private
|
|
1322
|
+
* key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The
|
|
1323
|
+
* private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC
|
|
1324
|
+
* 5958</a>.</p>
|
|
1325
|
+
*
|
|
1336
1326
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
1337
1327
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1338
1328
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1339
1329
|
* Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
|
|
1340
|
-
* <i>
|
|
1341
|
-
* <p>The
|
|
1342
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1330
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1331
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1332
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1343
1333
|
* <p>
|
|
1344
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1334
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1345
1335
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1346
1336
|
*
|
|
1347
1337
|
* <p>
|
|
@@ -1383,30 +1373,34 @@ export declare class KMS extends KMSClient {
|
|
|
1383
1373
|
/**
|
|
1384
1374
|
* <p>Generates a unique asymmetric data key pair. The
|
|
1385
1375
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key
|
|
1386
|
-
* and a copy of the private key that is encrypted under the symmetric
|
|
1376
|
+
* and a copy of the private key that is encrypted under the symmetric KMS key you specify. Unlike
|
|
1387
1377
|
* <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private
|
|
1388
1378
|
* key. </p>
|
|
1389
|
-
* <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to
|
|
1390
|
-
* encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a
|
|
1391
|
-
* custom key store. To get the type and origin of your CMK, use the <code>KeySpec</code> field
|
|
1392
|
-
* in the <a>DescribeKey</a> response.</p>
|
|
1393
1379
|
* <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
|
|
1394
|
-
* to encrypt data or verify a signature outside of
|
|
1380
|
+
* to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
|
|
1395
1381
|
* with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
|
|
1382
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1383
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
1384
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1385
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1386
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1387
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
1388
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
1396
1389
|
* <p>
|
|
1397
1390
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
|
|
1398
|
-
* request. The bytes in the key are not related to the caller or
|
|
1399
|
-
* private key
|
|
1391
|
+
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the
|
|
1392
|
+
* private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1393
|
+
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
1400
1394
|
*
|
|
1401
1395
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
1402
1396
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1403
1397
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1404
1398
|
* Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
|
|
1405
|
-
* <i>
|
|
1406
|
-
* <p>The
|
|
1407
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1399
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1400
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1401
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1408
1402
|
* <p>
|
|
1409
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1403
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1410
1404
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1411
1405
|
*
|
|
1412
1406
|
* <p>
|
|
@@ -1447,7 +1441,7 @@ export declare class KMS extends KMSClient {
|
|
|
1447
1441
|
generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
|
|
1448
1442
|
/**
|
|
1449
1443
|
* <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted
|
|
1450
|
-
* under a
|
|
1444
|
+
* under a KMS key that you specify. To request an asymmetric data key pair,
|
|
1451
1445
|
* use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
1452
1446
|
* <p>
|
|
1453
1447
|
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the
|
|
@@ -1463,12 +1457,12 @@ export declare class KMS extends KMSClient {
|
|
|
1463
1457
|
* plaintext data key.</p>
|
|
1464
1458
|
* <p>
|
|
1465
1459
|
* <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request.
|
|
1466
|
-
* The bytes in the keys are not related to the caller or
|
|
1460
|
+
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the private
|
|
1467
1461
|
* key.</p>
|
|
1468
1462
|
*
|
|
1469
|
-
* <p>To generate a data key, you must specify the symmetric
|
|
1470
|
-
* used to encrypt the data key. You cannot use an asymmetric
|
|
1471
|
-
* the type of your
|
|
1463
|
+
* <p>To generate a data key, you must specify the symmetric KMS key that is
|
|
1464
|
+
* used to encrypt the data key. You cannot use an asymmetric KMS key to generate a data key. To get
|
|
1465
|
+
* the type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1472
1466
|
*
|
|
1473
1467
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
1474
1468
|
* <code>CiphertextBlob</code> field.</p>
|
|
@@ -1477,11 +1471,11 @@ export declare class KMS extends KMSClient {
|
|
|
1477
1471
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1478
1472
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1479
1473
|
* Otherwise, the request to decrypt fails with an <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption Context</a> in the
|
|
1480
|
-
* <i>
|
|
1481
|
-
* <p>The
|
|
1482
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1474
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1475
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1476
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1483
1477
|
* <p>
|
|
1484
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1478
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1485
1479
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1486
1480
|
*
|
|
1487
1481
|
* <p>
|
|
@@ -1522,10 +1516,11 @@ export declare class KMS extends KMSClient {
|
|
|
1522
1516
|
generateDataKeyWithoutPlaintext(args: GenerateDataKeyWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyWithoutPlaintextCommandOutput) => void): void;
|
|
1523
1517
|
/**
|
|
1524
1518
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
1525
|
-
* <p>By default, the random byte string is generated in
|
|
1526
|
-
* the
|
|
1519
|
+
* <p>By default, the random byte string is generated in KMS. To generate the byte string in
|
|
1520
|
+
* the CloudHSM cluster that is associated with a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, specify the custom key store
|
|
1527
1521
|
* ID.</p>
|
|
1528
|
-
* <p>For
|
|
1522
|
+
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1523
|
+
* <p>For more information about entropy and random number generation, see <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
|
|
1529
1524
|
*
|
|
1530
1525
|
* <p>
|
|
1531
1526
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateRandom</a> (IAM policy)</p>
|
|
@@ -1534,9 +1529,9 @@ export declare class KMS extends KMSClient {
|
|
|
1534
1529
|
generateRandom(args: GenerateRandomCommandInput, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
1535
1530
|
generateRandom(args: GenerateRandomCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateRandomCommandOutput) => void): void;
|
|
1536
1531
|
/**
|
|
1537
|
-
* <p>Gets a key policy attached to the specified
|
|
1532
|
+
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
1538
1533
|
* <p>
|
|
1539
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1534
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1540
1535
|
*
|
|
1541
1536
|
* <p>
|
|
1542
1537
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyPolicy</a> (key policy)</p>
|
|
@@ -1549,23 +1544,23 @@ export declare class KMS extends KMSClient {
|
|
|
1549
1544
|
getKeyPolicy(args: GetKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyPolicyCommandOutput) => void): void;
|
|
1550
1545
|
/**
|
|
1551
1546
|
* <p>Gets a Boolean value that indicates whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is
|
|
1552
|
-
* enabled for the specified
|
|
1553
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
1554
|
-
* <p>The
|
|
1555
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1547
|
+
* enabled for the specified KMS key.</p>
|
|
1548
|
+
* <p>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. The key rotation status for these KMS keys is always <code>false</code>.</p>
|
|
1549
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1550
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1556
1551
|
* <ul>
|
|
1557
1552
|
* <li>
|
|
1558
|
-
* <p>Disabled: The key rotation status does not change when you disable a
|
|
1559
|
-
* while the
|
|
1553
|
+
* <p>Disabled: The key rotation status does not change when you disable a KMS key. However,
|
|
1554
|
+
* while the KMS key is disabled, KMS does not rotate the key material.</p>
|
|
1560
1555
|
* </li>
|
|
1561
1556
|
* <li>
|
|
1562
|
-
* <p>Pending deletion: While a
|
|
1563
|
-
* <code>false</code> and
|
|
1557
|
+
* <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is
|
|
1558
|
+
* <code>false</code> and KMS does not rotate the key material. If you cancel the
|
|
1564
1559
|
* deletion, the original key rotation status is restored.</p>
|
|
1565
1560
|
* </li>
|
|
1566
1561
|
* </ul>
|
|
1567
1562
|
* <p>
|
|
1568
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
1563
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
1569
1564
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1570
1565
|
*
|
|
1571
1566
|
* <p>
|
|
@@ -1591,23 +1586,23 @@ export declare class KMS extends KMSClient {
|
|
|
1591
1586
|
getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
|
|
1592
1587
|
/**
|
|
1593
1588
|
* <p>Returns the items you need to import key material into a symmetric, customer managed
|
|
1594
|
-
*
|
|
1589
|
+
* KMS key. For more information about importing key material into KMS, see
|
|
1595
1590
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
1596
|
-
* Material</a> in the <i>
|
|
1591
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1597
1592
|
* <p>This operation returns a public key and an import token. Use the public key to encrypt the
|
|
1598
1593
|
* symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
|
|
1599
|
-
* <p>You must specify the key ID of the symmetric
|
|
1600
|
-
* This
|
|
1594
|
+
* <p>You must specify the key ID of the symmetric KMS key into which you will import key material.
|
|
1595
|
+
* This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the
|
|
1601
1596
|
* wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key
|
|
1602
|
-
* material. You cannot perform this operation on an asymmetric
|
|
1597
|
+
* material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
1603
1598
|
* <p>To import key material, you must use the public key and import token from the same
|
|
1604
1599
|
* response. These items are valid for 24 hours. The expiration date and time appear in the
|
|
1605
1600
|
* <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
|
|
1606
1601
|
* <code>GetParametersForImport</code> request.</p>
|
|
1607
|
-
* <p>The
|
|
1608
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1602
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1603
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1609
1604
|
* <p>
|
|
1610
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1605
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1611
1606
|
*
|
|
1612
1607
|
* <p>
|
|
1613
1608
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetParametersForImport</a> (key policy)</p>
|
|
@@ -1631,22 +1626,22 @@ export declare class KMS extends KMSClient {
|
|
|
1631
1626
|
getParametersForImport(args: GetParametersForImportCommandInput, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1632
1627
|
getParametersForImport(args: GetParametersForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1633
1628
|
/**
|
|
1634
|
-
* <p>Returns the public key of an asymmetric
|
|
1635
|
-
* which never leaves
|
|
1636
|
-
* can download the public key of an asymmetric
|
|
1637
|
-
* to encrypt messages and verify signatures outside of
|
|
1629
|
+
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key,
|
|
1630
|
+
* which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission
|
|
1631
|
+
* can download the public key of an asymmetric KMS key. You can share the public key to allow others
|
|
1632
|
+
* to encrypt messages and verify signatures outside of KMS. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1638
1633
|
* <p>You do not need to download the public key. Instead, you can use the public key within
|
|
1639
|
-
*
|
|
1640
|
-
* public key within
|
|
1641
|
-
* are part of every
|
|
1642
|
-
* decrypted. These features are not effective outside of
|
|
1634
|
+
* KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the
|
|
1635
|
+
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
1636
|
+
* are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
|
|
1637
|
+
* decrypted. These features are not effective outside of KMS. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations">Special
|
|
1643
1638
|
* Considerations for Downloading Public Keys</a>.</p>
|
|
1644
|
-
* <p>To help you use the public key safely outside of
|
|
1639
|
+
* <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
|
|
1645
1640
|
* important information about the public key in the response, including:</p>
|
|
1646
1641
|
* <ul>
|
|
1647
1642
|
* <li>
|
|
1648
1643
|
* <p>
|
|
1649
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-
|
|
1644
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeySpec">KeySpec</a>: The type of key material in the public key, such as
|
|
1650
1645
|
* <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p>
|
|
1651
1646
|
* </li>
|
|
1652
1647
|
* <li>
|
|
@@ -1659,16 +1654,16 @@ export declare class KMS extends KMSClient {
|
|
|
1659
1654
|
* algorithms for the key.</p>
|
|
1660
1655
|
* </li>
|
|
1661
1656
|
* </ul>
|
|
1662
|
-
* <p>Although
|
|
1657
|
+
* <p>Although KMS cannot enforce these restrictions on external operations, it is crucial
|
|
1663
1658
|
* that you use this information to prevent the public key from being used improperly. For
|
|
1664
1659
|
* example, you can prevent a public signing key from being used encrypt data, or prevent a
|
|
1665
|
-
* public key from being used with an encryption algorithm that is not supported by
|
|
1660
|
+
* public key from being used with an encryption algorithm that is not supported by KMS. You
|
|
1666
1661
|
* can also avoid errors, such as using the wrong signing algorithm in a verification
|
|
1667
1662
|
* operation.</p>
|
|
1668
|
-
* <p>The
|
|
1669
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1663
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1664
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1670
1665
|
* <p>
|
|
1671
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1666
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1672
1667
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1673
1668
|
*
|
|
1674
1669
|
* <p>
|
|
@@ -1681,13 +1676,13 @@ export declare class KMS extends KMSClient {
|
|
|
1681
1676
|
getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1682
1677
|
getPublicKey(args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1683
1678
|
/**
|
|
1684
|
-
* <p>Imports key material into an existing symmetric
|
|
1685
|
-
* created without key material. After you successfully import key material into a
|
|
1686
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that
|
|
1679
|
+
* <p>Imports key material into an existing symmetric KMS KMS key that was
|
|
1680
|
+
* created without key material. After you successfully import key material into a KMS key, you can
|
|
1681
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that KMS key, but you cannot import different key
|
|
1687
1682
|
* material. </p>
|
|
1688
|
-
* <p>You cannot perform this operation on an asymmetric
|
|
1683
|
+
* <p>You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material and
|
|
1689
1684
|
* then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
|
|
1690
|
-
* <i>
|
|
1685
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1691
1686
|
* <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
|
|
1692
1687
|
* includes a public key and an import token. Use the public key to encrypt the key material.
|
|
1693
1688
|
* Then, submit the import token from the same <code>GetParametersForImport</code>
|
|
@@ -1695,11 +1690,11 @@ export declare class KMS extends KMSClient {
|
|
|
1695
1690
|
* <p>When calling this operation, you must specify the following values:</p>
|
|
1696
1691
|
* <ul>
|
|
1697
1692
|
* <li>
|
|
1698
|
-
* <p>The key ID or key ARN of a
|
|
1693
|
+
* <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must be
|
|
1699
1694
|
* <code>EXTERNAL</code>.</p>
|
|
1700
|
-
* <p>To create a
|
|
1695
|
+
* <p>To create a KMS key with no key material, call <a>CreateKey</a> and set the
|
|
1701
1696
|
* value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the
|
|
1702
|
-
* <code>Origin</code> of a
|
|
1697
|
+
* <code>Origin</code> of a KMS key, call <a>DescribeKey</a>.)</p>
|
|
1703
1698
|
* </li>
|
|
1704
1699
|
* <li>
|
|
1705
1700
|
* <p>The encrypted key material. To get the public key to encrypt the key material, call
|
|
@@ -1710,23 +1705,23 @@ export declare class KMS extends KMSClient {
|
|
|
1710
1705
|
* a public key and token from the same <code>GetParametersForImport</code> response.</p>
|
|
1711
1706
|
* </li>
|
|
1712
1707
|
* <li>
|
|
1713
|
-
* <p>Whether the key material expires and if so, when. If you set an expiration date,
|
|
1714
|
-
* deletes the key material from the
|
|
1715
|
-
* To use the
|
|
1708
|
+
* <p>Whether the key material expires and if so, when. If you set an expiration date, KMS
|
|
1709
|
+
* deletes the key material from the KMS key on the specified date, and the KMS key becomes unusable.
|
|
1710
|
+
* To use the KMS key again, you must reimport the same key material. The only way to change an
|
|
1716
1711
|
* expiration date is by reimporting the same key material and specifying a new expiration
|
|
1717
1712
|
* date. </p>
|
|
1718
1713
|
* </li>
|
|
1719
1714
|
* </ul>
|
|
1720
|
-
* <p>When this operation is successful, the key state of the
|
|
1721
|
-
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the
|
|
1715
|
+
* <p>When this operation is successful, the key state of the KMS key changes from
|
|
1716
|
+
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key.</p>
|
|
1722
1717
|
* <p>If this operation fails, use the exception to help determine the problem. If the error is
|
|
1723
|
-
* related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the
|
|
1718
|
+
* related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key and
|
|
1724
1719
|
* repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key
|
|
1725
|
-
* Material</a> in the <i>
|
|
1726
|
-
* <p>The
|
|
1727
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1720
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1721
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1722
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
1728
1723
|
* <p>
|
|
1729
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1724
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1730
1725
|
*
|
|
1731
1726
|
* <p>
|
|
1732
1727
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ImportKeyMaterial</a> (key policy)</p>
|
|
@@ -1750,28 +1745,26 @@ export declare class KMS extends KMSClient {
|
|
|
1750
1745
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1751
1746
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1752
1747
|
/**
|
|
1753
|
-
* <p>Gets a list of aliases in the caller's
|
|
1748
|
+
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about
|
|
1754
1749
|
* aliases, see <a>CreateAlias</a>.</p>
|
|
1755
1750
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
1756
|
-
* region. To get only the aliases associated with a particular
|
|
1751
|
+
* region. To get only the aliases associated with a particular KMS key, use
|
|
1757
1752
|
* the <code>KeyId</code> parameter.</p>
|
|
1758
1753
|
* <p>The <code>ListAliases</code> response can include aliases that you created and associated
|
|
1759
|
-
* with your customer managed
|
|
1760
|
-
* CMKs in your account. You can recognize AWS aliases because their names have the format
|
|
1754
|
+
* with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format
|
|
1761
1755
|
* <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p>
|
|
1762
1756
|
* <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
|
|
1763
|
-
* are predefined aliases that
|
|
1764
|
-
* that
|
|
1765
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">
|
|
1757
|
+
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases
|
|
1758
|
+
* that Amazon Web Services creates in your account, including predefined aliases, do not count against your
|
|
1759
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">KMS aliases
|
|
1766
1760
|
* quota</a>.</p>
|
|
1767
1761
|
* <p>
|
|
1768
1762
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
1769
|
-
* return aliases in other
|
|
1770
|
-
*
|
|
1763
|
+
* return aliases in other Amazon Web Services accounts.</p>
|
|
1771
1764
|
*
|
|
1772
1765
|
* <p>
|
|
1773
1766
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListAliases</a> (IAM policy)</p>
|
|
1774
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
1767
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1775
1768
|
* <p>
|
|
1776
1769
|
* <b>Related operations:</b>
|
|
1777
1770
|
* </p>
|
|
@@ -1797,18 +1790,23 @@ export declare class KMS extends KMSClient {
|
|
|
1797
1790
|
listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
1798
1791
|
listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
1799
1792
|
/**
|
|
1800
|
-
* <p>Gets a list of all grants for the specified
|
|
1801
|
-
* <p>You must specify the
|
|
1793
|
+
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
1794
|
+
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID
|
|
1802
1795
|
* or grantee principal.</p>
|
|
1796
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
1797
|
+
* <i>
|
|
1798
|
+
* <i>Key Management Service Developer Guide</i>
|
|
1799
|
+
* </i>. For examples of working with grants in several
|
|
1800
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
1803
1801
|
* <note>
|
|
1804
1802
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
1805
1803
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
1806
|
-
* principal in the grant is an
|
|
1804
|
+
* principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
|
|
1807
1805
|
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
|
|
1808
1806
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
1809
1807
|
* </note>
|
|
1810
1808
|
* <p>
|
|
1811
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
1809
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
1812
1810
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1813
1811
|
*
|
|
1814
1812
|
* <p>
|
|
@@ -1843,11 +1841,11 @@ export declare class KMS extends KMSClient {
|
|
|
1843
1841
|
listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
1844
1842
|
listGrants(args: ListGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
1845
1843
|
/**
|
|
1846
|
-
* <p>Gets the names of the key policies that are attached to a
|
|
1844
|
+
* <p>Gets the names of the key policies that are attached to a KMS key. This
|
|
1847
1845
|
* operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a>
|
|
1848
1846
|
* operation. However, the only valid policy name is <code>default</code>. </p>
|
|
1849
1847
|
* <p>
|
|
1850
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1848
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1851
1849
|
*
|
|
1852
1850
|
* <p>
|
|
1853
1851
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeyPolicies</a> (key policy)</p>
|
|
@@ -1871,10 +1869,10 @@ export declare class KMS extends KMSClient {
|
|
|
1871
1869
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
1872
1870
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
1873
1871
|
/**
|
|
1874
|
-
* <p>Gets a list of all
|
|
1872
|
+
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and
|
|
1875
1873
|
* Region.</p>
|
|
1876
1874
|
* <p>
|
|
1877
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1875
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1878
1876
|
*
|
|
1879
1877
|
* <p>
|
|
1880
1878
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListKeys</a> (IAM policy)</p>
|
|
@@ -1908,13 +1906,13 @@ export declare class KMS extends KMSClient {
|
|
|
1908
1906
|
listKeys(args: ListKeysCommandInput, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
1909
1907
|
listKeys(args: ListKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeysCommandOutput) => void): void;
|
|
1910
1908
|
/**
|
|
1911
|
-
* <p>Returns all tags on the specified
|
|
1912
|
-
* <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
1909
|
+
* <p>Returns all tags on the specified KMS key.</p>
|
|
1910
|
+
* <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in
|
|
1913
1911
|
* the <i>Amazon Web Services General Reference</i>. For information about using
|
|
1914
|
-
* tags in
|
|
1912
|
+
* tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging
|
|
1915
1913
|
* keys</a>.</p>
|
|
1916
1914
|
* <p>
|
|
1917
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1915
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1918
1916
|
*
|
|
1919
1917
|
* <p>
|
|
1920
1918
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListResourceTags</a> (key policy)</p>
|
|
@@ -1948,24 +1946,24 @@ export declare class KMS extends KMSClient {
|
|
|
1948
1946
|
listResourceTags(args: ListResourceTagsCommandInput, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
1949
1947
|
listResourceTags(args: ListResourceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
1950
1948
|
/**
|
|
1951
|
-
* <p>Returns information about all grants in the
|
|
1952
|
-
* retiring principal.
|
|
1953
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1956
|
-
* <p>
|
|
1957
|
-
*
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
1949
|
+
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the specified
|
|
1950
|
+
* retiring principal. </p>
|
|
1951
|
+
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
1952
|
+
* grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to
|
|
1953
|
+
* determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
|
|
1954
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
1955
|
+
* <i>
|
|
1956
|
+
* <i>Key Management Service Developer Guide</i>
|
|
1957
|
+
* </i>. For examples of working with grants in several
|
|
1958
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
1960
1959
|
* <p>
|
|
1961
1960
|
* <b>Cross-account use</b>: You must specify a principal in your
|
|
1962
|
-
*
|
|
1963
|
-
*
|
|
1964
|
-
*
|
|
1961
|
+
* Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
|
|
1962
|
+
* <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
|
|
1963
|
+
* Amazon Web Services account other than your own.</p>
|
|
1965
1964
|
*
|
|
1966
1965
|
* <p>
|
|
1967
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
|
|
1968
|
-
* account.</p>
|
|
1966
|
+
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your Amazon Web Services account.</p>
|
|
1969
1967
|
* <p>
|
|
1970
1968
|
* <b>Related operations:</b>
|
|
1971
1969
|
* </p>
|
|
@@ -1996,14 +1994,14 @@ export declare class KMS extends KMSClient {
|
|
|
1996
1994
|
listRetirableGrants(args: ListRetirableGrantsCommandInput, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
|
|
1997
1995
|
listRetirableGrants(args: ListRetirableGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRetirableGrantsCommandOutput) => void): void;
|
|
1998
1996
|
/**
|
|
1999
|
-
* <p>Attaches a key policy to the specified
|
|
2000
|
-
* <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>
|
|
1997
|
+
* <p>Attaches a key policy to the specified KMS key. </p>
|
|
1998
|
+
* <p>For more information about key policies, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">Key Policies</a> in the <i>Key Management Service Developer Guide</i>.
|
|
2001
1999
|
* 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>
|
|
2002
|
-
* <i>
|
|
2000
|
+
* <i>Identity and Access Management User Guide</i>
|
|
2003
2001
|
* </i>. For examples of adding a key policy in multiple programming languages,
|
|
2004
|
-
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy">Setting a key policy</a> in the <i>
|
|
2002
|
+
* see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy">Setting a key policy</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2005
2003
|
* <p>
|
|
2006
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2004
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2007
2005
|
*
|
|
2008
2006
|
* <p>
|
|
2009
2007
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:PutKeyPolicy</a> (key policy)</p>
|
|
@@ -2015,77 +2013,73 @@ export declare class KMS extends KMSClient {
|
|
|
2015
2013
|
putKeyPolicy(args: PutKeyPolicyCommandInput, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
|
|
2016
2014
|
putKeyPolicy(args: PutKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
|
|
2017
2015
|
/**
|
|
2018
|
-
* <p>Decrypts ciphertext and then reencrypts it entirely within
|
|
2019
|
-
* operation to change the
|
|
2020
|
-
* you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually rotate</a> a
|
|
2021
|
-
* use it to reencrypt ciphertext under the same
|
|
2016
|
+
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
2017
|
+
* operation to change the KMS key under which data is encrypted, such as when
|
|
2018
|
+
* you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also
|
|
2019
|
+
* use it to reencrypt ciphertext under the same KMS key, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
|
|
2022
2020
|
* context</a> of a ciphertext.</p>
|
|
2023
2021
|
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an
|
|
2024
|
-
*
|
|
2025
|
-
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
2026
|
-
*
|
|
2027
|
-
*
|
|
2028
|
-
* encryption</a>. These libraries return a ciphertext format that is incompatible with
|
|
2029
|
-
* AWS KMS.</p>
|
|
2022
|
+
* KMS KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the
|
|
2023
|
+
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS key</a> outside of KMS. However, it cannot decrypt ciphertext
|
|
2024
|
+
* produced by other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
|
|
2025
|
+
* These libraries return a ciphertext format that is incompatible with KMS.</p>
|
|
2030
2026
|
* <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the
|
|
2031
2027
|
* decrypt operation and the subsequent encrypt operation.</p>
|
|
2032
2028
|
* <ul>
|
|
2033
2029
|
* <li>
|
|
2034
|
-
* <p>If your ciphertext was encrypted under an asymmetric
|
|
2035
|
-
* <code>SourceKeyId</code> parameter to identify the
|
|
2030
|
+
* <p>If your ciphertext was encrypted under an asymmetric KMS key, you must use the
|
|
2031
|
+
* <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the ciphertext.
|
|
2036
2032
|
* You must also supply the encryption algorithm that was used. This information is required
|
|
2037
2033
|
* to decrypt the data.</p>
|
|
2038
2034
|
* </li>
|
|
2039
2035
|
* <li>
|
|
2040
|
-
* <p>If your ciphertext was encrypted under a symmetric
|
|
2041
|
-
* parameter is optional.
|
|
2036
|
+
* <p>If your ciphertext was encrypted under a symmetric KMS key, the <code>SourceKeyId</code>
|
|
2037
|
+
* parameter is optional. KMS can get this information from metadata that it adds to the
|
|
2042
2038
|
* symmetric ciphertext blob. This feature adds durability to your implementation by ensuring
|
|
2043
2039
|
* that authorized users can decrypt ciphertext decades after it was encrypted, even if
|
|
2044
|
-
* they've lost track of the
|
|
2045
|
-
* as a best practice. When you use the <code>SourceKeyId</code> parameter to specify a
|
|
2046
|
-
*
|
|
2047
|
-
* CMK, the <code>ReEncrypt</code> operation fails. This practice ensures that you use the
|
|
2048
|
-
* CMK that you intend.</p>
|
|
2040
|
+
* they've lost track of the key ID. However, specifying the source KMS key is always recommended
|
|
2041
|
+
* as a best practice. When you use the <code>SourceKeyId</code> parameter to specify a KMS key,
|
|
2042
|
+
* KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the <code>ReEncrypt</code> operation fails. This practice ensures that you use the KMS key that you intend.</p>
|
|
2049
2043
|
* </li>
|
|
2050
2044
|
* <li>
|
|
2051
2045
|
* <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter
|
|
2052
|
-
* specify the
|
|
2053
|
-
* symmetric or asymmetric
|
|
2046
|
+
* specify the KMS key that re-encrypts the data after it is decrypted. You can select a
|
|
2047
|
+
* symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you must also
|
|
2054
2048
|
* provide the encryption algorithm. The algorithm that you choose must be compatible with
|
|
2055
|
-
* the
|
|
2049
|
+
* the KMS key.</p>
|
|
2056
2050
|
*
|
|
2057
2051
|
* <important>
|
|
2058
|
-
* <p>When you use an asymmetric
|
|
2059
|
-
* <p>You are not required to supply the
|
|
2052
|
+
* <p>When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.</p>
|
|
2053
|
+
* <p>You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.</p>
|
|
2060
2054
|
* </important>
|
|
2061
2055
|
* </li>
|
|
2062
2056
|
* </ul>
|
|
2063
2057
|
*
|
|
2064
2058
|
*
|
|
2065
2059
|
*
|
|
2066
|
-
* <p>The
|
|
2067
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2060
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2061
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2068
2062
|
* <p>
|
|
2069
|
-
* <b>Cross-account use</b>: Yes. The source
|
|
2070
|
-
*
|
|
2071
|
-
*
|
|
2063
|
+
* <b>Cross-account use</b>: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than
|
|
2064
|
+
* the caller. To specify a KMS key in a different account, you must use its key ARN or alias
|
|
2065
|
+
* ARN.</p>
|
|
2072
2066
|
*
|
|
2073
2067
|
* <p>
|
|
2074
2068
|
* <b>Required permissions</b>:</p>
|
|
2075
2069
|
* <ul>
|
|
2076
2070
|
* <li>
|
|
2077
2071
|
* <p>
|
|
2078
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a> permission on the source
|
|
2072
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a> permission on the source KMS key (key policy)</p>
|
|
2079
2073
|
* </li>
|
|
2080
2074
|
* <li>
|
|
2081
2075
|
* <p>
|
|
2082
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a> permission on the destination
|
|
2076
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a> permission on the destination KMS key (key policy)</p>
|
|
2083
2077
|
* </li>
|
|
2084
2078
|
* </ul>
|
|
2085
|
-
* <p>To permit reencryption from or to a
|
|
2079
|
+
* <p>To permit reencryption from or to a KMS key, include the <code>"kms:ReEncrypt*"</code>
|
|
2086
2080
|
* permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is
|
|
2087
|
-
* automatically included in the key policy when you use the console to create a
|
|
2088
|
-
* must include it manually when you create a
|
|
2081
|
+
* automatically included in the key policy when you use the console to create a KMS key. But you
|
|
2082
|
+
* must include it manually when you create a KMS key programmatically or when you use the <a>PutKeyPolicy</a> operation to set a key policy.</p>
|
|
2089
2083
|
*
|
|
2090
2084
|
* <p>
|
|
2091
2085
|
* <b>Related operations:</b>
|
|
@@ -2119,24 +2113,24 @@ export declare class KMS extends KMSClient {
|
|
|
2119
2113
|
/**
|
|
2120
2114
|
* <p>Replicates a multi-Region key into the specified Region. This operation creates a
|
|
2121
2115
|
* multi-Region replica key based on a multi-Region primary key in a different Region of the same
|
|
2122
|
-
*
|
|
2116
|
+
* Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
|
|
2123
2117
|
* different Region. To create a multi-Region primary key, use the <a>CreateKey</a>
|
|
2124
2118
|
* operation.</p>
|
|
2125
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
2126
|
-
* interoperable
|
|
2127
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
2128
|
-
* it in a different
|
|
2129
|
-
* <p>A <i>replica key</i> is a fully-functional
|
|
2119
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
2120
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
2121
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
2122
|
+
* 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>
|
|
2123
|
+
* <p>A <i>replica key</i> is a fully-functional KMS key that can be used
|
|
2130
2124
|
* independently of its primary and peer replica keys. A primary key and its replica keys share
|
|
2131
2125
|
* properties that make them interoperable. They have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a> and key material. They also
|
|
2132
2126
|
* have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key
|
|
2133
2127
|
* spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key
|
|
2134
2128
|
* usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key
|
|
2135
|
-
* material origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation status</a>.
|
|
2129
|
+
* material origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation status</a>. KMS automatically synchronizes these shared
|
|
2136
2130
|
* properties among related multi-Region keys. All other properties of a replica key can differ,
|
|
2137
2131
|
* including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key
|
|
2138
2132
|
* policy</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">tags</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">aliases</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">key
|
|
2139
|
-
* state</a>.
|
|
2133
|
+
* state</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica
|
|
2140
2134
|
* key.</p>
|
|
2141
2135
|
* <p>When this operation completes, the new replica key has a transient key state of
|
|
2142
2136
|
* <code>Creating</code>. This key state changes to <code>Enabled</code> (or
|
|
@@ -2145,31 +2139,31 @@ export declare class KMS extends KMSClient {
|
|
|
2145
2139
|
* cannot yet use it in cryptographic operations. If you are creating and using the replica key
|
|
2146
2140
|
* programmatically, retry on <code>KMSInvalidStateException</code> or call
|
|
2147
2141
|
* <code>DescribeKey</code> to check its <code>KeyState</code> value before using it. For
|
|
2148
|
-
* details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2149
|
-
* <i>
|
|
2150
|
-
* <p>The
|
|
2142
|
+
* details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the
|
|
2143
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2144
|
+
* <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a
|
|
2151
2145
|
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
|
|
2152
2146
|
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
|
|
2153
2147
|
* created with no key material. You must import the same key material that you imported into the
|
|
2154
|
-
* primary key. For details, see <a href="kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>
|
|
2148
|
+
* primary key. For details, see <a href="kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2155
2149
|
* <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
|
|
2156
2150
|
* operation.</p>
|
|
2157
2151
|
* <note>
|
|
2158
2152
|
* <p>
|
|
2159
2153
|
* <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code> and
|
|
2160
|
-
* <code>Tags</code> parameters than those used in the
|
|
2154
|
+
* <code>Tags</code> parameters than those used in the KMS console. For details, see the
|
|
2161
2155
|
* parameter descriptions.</p>
|
|
2162
2156
|
* </note>
|
|
2163
2157
|
* <p>
|
|
2164
2158
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
2165
|
-
* create a
|
|
2159
|
+
* create a replica key in a different Amazon Web Services account. </p>
|
|
2166
2160
|
* <p>
|
|
2167
2161
|
* <b>Required permissions</b>: </p>
|
|
2168
2162
|
* <ul>
|
|
2169
2163
|
* <li>
|
|
2170
2164
|
* <p>
|
|
2171
|
-
* <code>kms:ReplicateKey</code> on the primary
|
|
2172
|
-
* permission in the primary
|
|
2165
|
+
* <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region). Include this
|
|
2166
|
+
* permission in the primary key's key policy.</p>
|
|
2173
2167
|
* </li>
|
|
2174
2168
|
* <li>
|
|
2175
2169
|
* <p>
|
|
@@ -2202,24 +2196,24 @@ export declare class KMS extends KMSClient {
|
|
|
2202
2196
|
/**
|
|
2203
2197
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
2204
2198
|
* identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
|
|
2205
|
-
* key identifier (key ID or key ARN) of the
|
|
2199
|
+
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation returns both values.</p>
|
|
2206
2200
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
2207
2201
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
2208
|
-
* operation, and by the
|
|
2202
|
+
* operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be
|
|
2209
2203
|
* called by principals to whom permission for retiring a grant is delegated. For details, see
|
|
2210
|
-
*
|
|
2211
|
-
* revoking grants</a> in the <i>
|
|
2204
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
|
|
2205
|
+
* revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2212
2206
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
2213
2207
|
* <i>
|
|
2214
|
-
* <i>
|
|
2208
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2215
2209
|
* </i>. For examples of working with grants in several
|
|
2216
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
2210
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
2217
2211
|
* <p>
|
|
2218
|
-
* <b>Cross-account use</b>: Yes. You can retire a grant on a
|
|
2219
|
-
* in a different
|
|
2212
|
+
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS key
|
|
2213
|
+
* in a different Amazon Web Services account.</p>
|
|
2220
2214
|
* <p>
|
|
2221
2215
|
* <b>Required permissions:</b>:Permission to retire a grant is
|
|
2222
|
-
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in the <i>
|
|
2216
|
+
* determined primarily by the grant. For details, see <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>
|
|
2223
2217
|
* <p>
|
|
2224
2218
|
* <b>Related operations:</b>
|
|
2225
2219
|
* </p>
|
|
@@ -2254,14 +2248,19 @@ export declare class KMS extends KMSClient {
|
|
|
2254
2248
|
* grant allows. For more
|
|
2255
2249
|
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
2256
2250
|
* the <i>
|
|
2257
|
-
* <i>
|
|
2251
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2258
2252
|
* </i>.</p>
|
|
2259
|
-
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout
|
|
2253
|
+
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency">Eventual consistency</a> in
|
|
2260
2254
|
* the <i>
|
|
2261
|
-
* <i>
|
|
2255
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2262
2256
|
* </i>. </p>
|
|
2257
|
+
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
2258
|
+
* <i>
|
|
2259
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2260
|
+
* </i>. For examples of working with grants in several
|
|
2261
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
2263
2262
|
* <p>
|
|
2264
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
2263
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
2265
2264
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2266
2265
|
* <p>
|
|
2267
2266
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:RevokeGrant</a> (key policy).</p>
|
|
@@ -2295,38 +2294,38 @@ export declare class KMS extends KMSClient {
|
|
|
2295
2294
|
revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2296
2295
|
revokeGrant(args: RevokeGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2297
2296
|
/**
|
|
2298
|
-
* <p>Schedules the deletion of a
|
|
2297
|
+
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting
|
|
2299
2298
|
* period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is
|
|
2300
|
-
* successful, the key state of the
|
|
2299
|
+
* successful, the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't
|
|
2301
2300
|
* be used in any cryptographic operations. It remains in this state for the duration of the
|
|
2302
|
-
* waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the
|
|
2303
|
-
* its key material, and all
|
|
2301
|
+
* waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,
|
|
2302
|
+
* its key material, and all KMS data associated with it, including all aliases that refer to
|
|
2304
2303
|
* it.</p>
|
|
2305
2304
|
* <important>
|
|
2306
|
-
* <p>Deleting a
|
|
2307
|
-
* deleted, all data that was encrypted under the
|
|
2308
|
-
* a multi-Region replica key.) To prevent the use of a
|
|
2305
|
+
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is
|
|
2306
|
+
* deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is
|
|
2307
|
+
* a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use <a>DisableKey</a>. </p>
|
|
2309
2308
|
* </important>
|
|
2310
|
-
* <p>If you schedule deletion of a
|
|
2311
|
-
* expires, <code>ScheduleKeyDeletion</code> deletes the
|
|
2312
|
-
* effort to delete the key material from the associated
|
|
2309
|
+
* <p>If you schedule deletion of a KMS key from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period
|
|
2310
|
+
* expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a best
|
|
2311
|
+
* effort to delete the key material from the associated CloudHSM cluster. However, you might need
|
|
2313
2312
|
* to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
2314
2313
|
* material</a> from the cluster and its backups.</p>
|
|
2315
2314
|
* <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
|
|
2316
|
-
* time. However,
|
|
2315
|
+
* time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
|
|
2317
2316
|
* you schedule the deletion of a primary key with replicas, its key state changes to
|
|
2318
2317
|
* <code>PendingReplicaDeletion</code> and it cannot be replicated or used in cryptographic
|
|
2319
2318
|
* operations. This status can continue indefinitely. When the last of its replicas keys is
|
|
2320
2319
|
* deleted (not just scheduled), the key state of the primary key changes to
|
|
2321
2320
|
* <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
|
|
2322
|
-
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the <i>
|
|
2323
|
-
* <p>For more information about scheduling a
|
|
2324
|
-
* <i>
|
|
2325
|
-
* <p>The
|
|
2326
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2321
|
+
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
2322
|
+
* <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
2323
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2324
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2325
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2327
2326
|
*
|
|
2328
2327
|
* <p>
|
|
2329
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2328
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2330
2329
|
*
|
|
2331
2330
|
*
|
|
2332
2331
|
* <p>
|
|
@@ -2352,21 +2351,20 @@ export declare class KMS extends KMSClient {
|
|
|
2352
2351
|
scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
|
|
2353
2352
|
/**
|
|
2354
2353
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
2355
|
-
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
2356
|
-
*
|
|
2357
|
-
* key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
2354
|
+
* signature</a> for a message or message digest by using the private key in an asymmetric KMS key. To verify the signature, use the <a>Verify</a> operation, or use the public
|
|
2355
|
+
* key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2358
2356
|
* <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
|
|
2359
|
-
* or ECC pair that is represented by an asymmetric
|
|
2357
|
+
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or
|
|
2360
2358
|
* an authorized user) uses their private key to sign a message. Anyone with the public key can
|
|
2361
2359
|
* verify that the message was signed with that particular private key and that the message
|
|
2362
2360
|
* hasn't changed since it was signed. </p>
|
|
2363
2361
|
* <p>To use the <code>Sign</code> operation, provide the following information:</p>
|
|
2364
2362
|
* <ul>
|
|
2365
2363
|
* <li>
|
|
2366
|
-
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric
|
|
2364
|
+
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a
|
|
2367
2365
|
* <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the
|
|
2368
|
-
* <code>KeyUsage</code> value of a
|
|
2369
|
-
* The caller must have <code>kms:Sign</code> permission on the
|
|
2366
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a> operation.
|
|
2367
|
+
* The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
|
|
2370
2368
|
* </li>
|
|
2371
2369
|
* <li>
|
|
2372
2370
|
* <p>Use the <code>Message</code> parameter to specify the message or message digest to
|
|
@@ -2376,20 +2374,20 @@ export declare class KMS extends KMSClient {
|
|
|
2376
2374
|
* <code>MessageType</code> parameter.</p>
|
|
2377
2375
|
* </li>
|
|
2378
2376
|
* <li>
|
|
2379
|
-
* <p>Choose a signing algorithm that is compatible with the
|
|
2377
|
+
* <p>Choose a signing algorithm that is compatible with the KMS key. </p>
|
|
2380
2378
|
* </li>
|
|
2381
2379
|
* </ul>
|
|
2382
2380
|
* <important>
|
|
2383
|
-
* <p>When signing a message, be sure to record the
|
|
2381
|
+
* <p>When signing a message, be sure to record the KMS key and the signing algorithm. This
|
|
2384
2382
|
* information is required to verify the signature.</p>
|
|
2385
2383
|
* </important>
|
|
2386
2384
|
* <p>To verify the signature that this operation generates, use the <a>Verify</a>
|
|
2387
2385
|
* operation. Or use the <a>GetPublicKey</a> operation to download the public key and
|
|
2388
|
-
* then use the public key to verify the signature outside of
|
|
2389
|
-
* <p>The
|
|
2390
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2386
|
+
* then use the public key to verify the signature outside of KMS. </p>
|
|
2387
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2388
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2391
2389
|
* <p>
|
|
2392
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
2390
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2393
2391
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2394
2392
|
*
|
|
2395
2393
|
* <p>
|
|
@@ -2402,26 +2400,24 @@ export declare class KMS extends KMSClient {
|
|
|
2402
2400
|
sign(args: SignCommandInput, cb: (err: any, data?: SignCommandOutput) => void): void;
|
|
2403
2401
|
sign(args: SignCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignCommandOutput) => void): void;
|
|
2404
2402
|
/**
|
|
2405
|
-
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
2403
|
+
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>.</p>
|
|
2406
2404
|
* <note>
|
|
2407
|
-
* <p>Tagging or untagging a
|
|
2408
|
-
* 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>
|
|
2405
|
+
* <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>
|
|
2409
2406
|
* </note>
|
|
2410
2407
|
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
|
|
2411
2408
|
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
2412
2409
|
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
2413
|
-
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
2414
|
-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
2415
|
-
* managed CMK</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">AWS owned CMK</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key store</a>, or
|
|
2410
|
+
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
|
|
2411
|
+
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key store</a>, or
|
|
2416
2412
|
* an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
|
|
2417
|
-
* <p>You can also add tags to a
|
|
2418
|
-
* <p>For information about using tags in
|
|
2419
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
2413
|
+
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or replicating it (<a>ReplicateKey</a>).</p>
|
|
2414
|
+
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
2415
|
+
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
2420
2416
|
* Web Services General Reference</i>. </p>
|
|
2421
|
-
* <p>The
|
|
2422
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2417
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2418
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2423
2419
|
* <p>
|
|
2424
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2420
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2425
2421
|
*
|
|
2426
2422
|
* <p>
|
|
2427
2423
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
|
|
@@ -2455,23 +2451,22 @@ export declare class KMS extends KMSClient {
|
|
|
2455
2451
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
2456
2452
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
2457
2453
|
/**
|
|
2458
|
-
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
2459
|
-
* specify the tag key and the
|
|
2454
|
+
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>. To delete a tag,
|
|
2455
|
+
* specify the tag key and the KMS key.</p>
|
|
2460
2456
|
* <note>
|
|
2461
|
-
* <p>Tagging or untagging a
|
|
2462
|
-
* 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>
|
|
2457
|
+
* <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>
|
|
2463
2458
|
* </note>
|
|
2464
2459
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
2465
|
-
* Also, if the specified tag key isn't found on the
|
|
2460
|
+
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return
|
|
2466
2461
|
* a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
2467
2462
|
*
|
|
2468
|
-
* <p>For information about using tags in
|
|
2469
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
2463
|
+
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
2464
|
+
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
2470
2465
|
* Web Services General Reference</i>. </p>
|
|
2471
|
-
* <p>The
|
|
2472
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2466
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2467
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2473
2468
|
* <p>
|
|
2474
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2469
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2475
2470
|
*
|
|
2476
2471
|
* <p>
|
|
2477
2472
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
|
|
@@ -2505,27 +2500,27 @@ export declare class KMS extends KMSClient {
|
|
|
2505
2500
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2506
2501
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2507
2502
|
/**
|
|
2508
|
-
* <p>Associates an existing
|
|
2509
|
-
* is associated with only one
|
|
2510
|
-
* and the
|
|
2503
|
+
* <p>Associates an existing KMS alias with a different KMS key. Each alias
|
|
2504
|
+
* is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias
|
|
2505
|
+
* and the KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
2511
2506
|
* <note>
|
|
2512
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
2507
|
+
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2513
2508
|
* </note>
|
|
2514
|
-
* <p>The current and new
|
|
2509
|
+
* <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
|
|
2515
2510
|
* they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
|
|
2516
2511
|
* This restriction prevents errors in code that uses aliases. If you must assign an alias to a
|
|
2517
|
-
* different type of
|
|
2512
|
+
* different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p>
|
|
2518
2513
|
* <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name,
|
|
2519
2514
|
* use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
|
|
2520
2515
|
* create a new alias.</p>
|
|
2521
|
-
* <p>Because an alias is not a property of a
|
|
2522
|
-
* aliases of a
|
|
2523
|
-
* the <a>DescribeKey</a> operation. To get the aliases of all
|
|
2516
|
+
* <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
|
|
2517
|
+
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from
|
|
2518
|
+
* the <a>DescribeKey</a> operation. To get the aliases of all KMS keys in the account,
|
|
2524
2519
|
* use the <a>ListAliases</a> operation. </p>
|
|
2525
|
-
* <p>The
|
|
2526
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2520
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2521
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2527
2522
|
* <p>
|
|
2528
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2523
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2529
2524
|
* <p>
|
|
2530
2525
|
* <b>Required permissions</b>
|
|
2531
2526
|
* </p>
|
|
@@ -2536,14 +2531,14 @@ export declare class KMS extends KMSClient {
|
|
|
2536
2531
|
* </li>
|
|
2537
2532
|
* <li>
|
|
2538
2533
|
* <p>
|
|
2539
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the current
|
|
2534
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the current KMS key (key policy).</p>
|
|
2540
2535
|
* </li>
|
|
2541
2536
|
* <li>
|
|
2542
2537
|
* <p>
|
|
2543
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the new
|
|
2538
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the new KMS key (key policy).</p>
|
|
2544
2539
|
* </li>
|
|
2545
2540
|
* </ul>
|
|
2546
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>
|
|
2541
|
+
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2547
2542
|
* <p>
|
|
2548
2543
|
* <b>Related operations:</b>
|
|
2549
2544
|
* </p>
|
|
@@ -2586,30 +2581,30 @@ export declare class KMS extends KMSClient {
|
|
|
2586
2581
|
* <p> </p>
|
|
2587
2582
|
* </li>
|
|
2588
2583
|
* <li>
|
|
2589
|
-
* <p>Use the <b>KeyStorePassword</b> parameter tell
|
|
2584
|
+
* <p>Use the <b>KeyStorePassword</b> parameter tell KMS the
|
|
2590
2585
|
* current password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
2591
2586
|
* <code>kmsuser</code> crypto
|
|
2592
|
-
* user (CU)</a> in the associated
|
|
2593
|
-
* connection failures</a> that occur when
|
|
2587
|
+
* user (CU)</a> in the associated CloudHSM cluster. You can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix
|
|
2588
|
+
* connection failures</a> that occur when KMS cannot log into the associated cluster
|
|
2594
2589
|
* because the <code>kmsuser</code> password has changed. This value does not change the
|
|
2595
|
-
* password in the
|
|
2590
|
+
* password in the CloudHSM cluster.</p>
|
|
2596
2591
|
* <p> </p>
|
|
2597
2592
|
* </li>
|
|
2598
2593
|
* <li>
|
|
2599
2594
|
* <p>Use the <b>CloudHsmClusterId</b> parameter to associate the
|
|
2600
|
-
* custom key store with a different, but related,
|
|
2601
|
-
* to repair a custom key store if its
|
|
2595
|
+
* custom key store with a different, but related, CloudHSM cluster. You can use this parameter
|
|
2596
|
+
* to repair a custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when
|
|
2602
2597
|
* you need to create or restore a cluster from a backup. </p>
|
|
2603
2598
|
* </li>
|
|
2604
2599
|
* </ul>
|
|
2605
2600
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
2606
2601
|
* properties.</p>
|
|
2607
|
-
* <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
|
|
2608
|
-
* combines the convenience and extensive integration of
|
|
2602
|
+
* <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
|
|
2603
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
2609
2604
|
* single-tenant key store.</p>
|
|
2610
2605
|
*
|
|
2611
2606
|
* <p>
|
|
2612
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
2607
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
|
|
2613
2608
|
* <p>
|
|
2614
2609
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateCustomKeyStore</a> (IAM policy)</p>
|
|
2615
2610
|
* <p>
|
|
@@ -2647,12 +2642,12 @@ export declare class KMS extends KMSClient {
|
|
|
2647
2642
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2648
2643
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2649
2644
|
/**
|
|
2650
|
-
* <p>Updates the description of a
|
|
2645
|
+
* <p>Updates the description of a KMS key. To see the description of a KMS key,
|
|
2651
2646
|
* use <a>DescribeKey</a>. </p>
|
|
2652
|
-
* <p>The
|
|
2653
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2647
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2648
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2654
2649
|
* <p>
|
|
2655
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2650
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2656
2651
|
*
|
|
2657
2652
|
* <p>
|
|
2658
2653
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
|
|
@@ -2682,19 +2677,19 @@ export declare class KMS extends KMSClient {
|
|
|
2682
2677
|
* in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
|
|
2683
2678
|
* <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
|
|
2684
2679
|
* <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
|
|
2685
|
-
* key in <code>us-east-1</code> becomes a replica key. For details, see </p>
|
|
2686
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
2687
|
-
* interoperable
|
|
2688
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
2689
|
-
* it in a different
|
|
2680
|
+
* key in <code>us-east-1</code> becomes a replica key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update">Updating the primary Region</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2681
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
2682
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
2683
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
2684
|
+
* 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>
|
|
2690
2685
|
* <p>The <i>primary key</i> of a multi-Region key is the source for properties
|
|
2691
2686
|
* that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
|
|
2692
2687
|
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
2693
2688
|
* key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
|
|
2694
|
-
*
|
|
2689
|
+
* key</a> until all replica keys are deleted.</p>
|
|
2695
2690
|
* <p>The key ID and primary Region that you specify uniquely identify the replica key that will
|
|
2696
2691
|
* become the primary key. The primary Region must already have a replica key. This operation
|
|
2697
|
-
* does not create a
|
|
2692
|
+
* does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
|
|
2698
2693
|
* key, use the <a>ReplicateKey</a> operation.</p>
|
|
2699
2694
|
* <p>You can run this operation while using the affected multi-Region keys in cryptographic
|
|
2700
2695
|
* operations. This operation should not delay, interrupt, or cause failures in cryptographic
|
|
@@ -2707,24 +2702,24 @@ export declare class KMS extends KMSClient {
|
|
|
2707
2702
|
* cryptographic operations, but you cannot replicate the new primary key or perform certain
|
|
2708
2703
|
* management operations, such as enabling or disabling these keys. For details about the
|
|
2709
2704
|
* <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state:
|
|
2710
|
-
* Effect on your
|
|
2705
|
+
* Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2711
2706
|
* <p>This operation does not return any output. To verify that primary key is changed, use the
|
|
2712
2707
|
* <a>DescribeKey</a> operation.</p>
|
|
2713
2708
|
* <p>
|
|
2714
2709
|
* <b>Cross-account use</b>: No. You cannot use this operation in a
|
|
2715
|
-
* different
|
|
2710
|
+
* different Amazon Web Services account. </p>
|
|
2716
2711
|
* <p>
|
|
2717
2712
|
* <b>Required permissions</b>: </p>
|
|
2718
2713
|
* <ul>
|
|
2719
2714
|
* <li>
|
|
2720
2715
|
* <p>
|
|
2721
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current primary
|
|
2722
|
-
* Region). Include this permission primary
|
|
2716
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
|
|
2717
|
+
* Region). Include this permission primary key's key policy.</p>
|
|
2723
2718
|
* </li>
|
|
2724
2719
|
* <li>
|
|
2725
2720
|
* <p>
|
|
2726
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current replica
|
|
2727
|
-
* Region). Include this permission in the replica
|
|
2721
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
|
|
2722
|
+
* Region). Include this permission in the replica key's key policy.</p>
|
|
2728
2723
|
* </li>
|
|
2729
2724
|
* </ul>
|
|
2730
2725
|
* <p>
|
|
@@ -2749,28 +2744,28 @@ export declare class KMS extends KMSClient {
|
|
|
2749
2744
|
/**
|
|
2750
2745
|
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
2751
2746
|
* <p></p>
|
|
2752
|
-
* <p>Verification confirms that an authorized user signed the message with the specified
|
|
2747
|
+
* <p>Verification confirms that an authorized user signed the message with the specified KMS key
|
|
2753
2748
|
* and signing algorithm, and the message hasn't changed since it was signed. If the signature is
|
|
2754
2749
|
* verified, the value of the <code>SignatureValid</code> field in the response is
|
|
2755
2750
|
* <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
|
|
2756
2751
|
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
2757
|
-
* <p>A digital signature is generated by using the private key in an asymmetric
|
|
2758
|
-
* signature is verified by using the public key in the same asymmetric
|
|
2759
|
-
* For information about symmetric and asymmetric
|
|
2752
|
+
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
2753
|
+
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
2754
|
+
* For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2760
2755
|
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
2761
|
-
* same asymmetric
|
|
2756
|
+
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
2762
2757
|
* signature.</p>
|
|
2763
|
-
* <p>You can also verify the digital signature by using the public key of the
|
|
2764
|
-
*
|
|
2765
|
-
* asymmetric
|
|
2766
|
-
* advantage of using the <code>Verify</code> operation is that it is performed within
|
|
2758
|
+
* <p>You can also verify the digital signature by using the public key of the KMS key outside of
|
|
2759
|
+
* KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
2760
|
+
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
2761
|
+
* advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
|
|
2767
2762
|
* a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
|
|
2768
|
-
* in
|
|
2769
|
-
* the
|
|
2770
|
-
* <p>The
|
|
2771
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2763
|
+
* in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
|
|
2764
|
+
* the KMS key to verify signatures.</p>
|
|
2765
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2766
|
+
* details, 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>Key Management Service Developer Guide</i>.</p>
|
|
2772
2767
|
* <p>
|
|
2773
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
2768
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2774
2769
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
2775
2770
|
*
|
|
2776
2771
|
* <p>
|