@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/KMS.ts
CHANGED
|
@@ -166,22 +166,23 @@ import { VerifyCommand, VerifyCommandInput, VerifyCommandOutput } from "./comman
|
|
|
166
166
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
167
167
|
|
|
168
168
|
/**
|
|
169
|
-
* <fullname>
|
|
170
|
-
* <p>
|
|
171
|
-
* the
|
|
169
|
+
* <fullname>Key Management Service</fullname>
|
|
170
|
+
* <p>Key Management Service (KMS) is an encryption and key management web service. This guide describes
|
|
171
|
+
* the KMS operations that you can call programmatically. For general information about KMS,
|
|
172
172
|
* see the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/">
|
|
173
|
-
* <i>
|
|
173
|
+
* <i>Key Management Service Developer Guide</i>
|
|
174
174
|
* </a>.</p>
|
|
175
175
|
* <note>
|
|
176
|
-
* <p>
|
|
176
|
+
* <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>
|
|
177
|
+
* <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming
|
|
177
178
|
* languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a
|
|
178
|
-
* convenient way to create programmatic access to
|
|
179
|
+
* convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,
|
|
179
180
|
* the SDKs take care of tasks such as signing requests (see below), managing errors, and
|
|
180
|
-
* retrying requests automatically. For more information about the
|
|
181
|
+
* retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to
|
|
181
182
|
* download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web
|
|
182
183
|
* Services</a>.</p>
|
|
183
184
|
* </note>
|
|
184
|
-
* <p>We recommend that you use the
|
|
185
|
+
* <p>We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.</p>
|
|
185
186
|
* <p>Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients
|
|
186
187
|
* must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral
|
|
187
188
|
* Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems
|
|
@@ -190,19 +191,18 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
190
191
|
* <b>Signing Requests</b>
|
|
191
192
|
* </p>
|
|
192
193
|
* <p>Requests must be signed by using an access key ID and a secret access key. We strongly
|
|
193
|
-
* recommend that you <i>do not</i> use your
|
|
194
|
-
* secret key for everyday work with
|
|
195
|
-
* for an IAM user. You can also use the
|
|
194
|
+
* recommend that you <i>do not</i> use your Amazon Web Services account (root) access key ID and
|
|
195
|
+
* secret key for everyday work with KMS. Instead, use the access key ID and secret access key
|
|
196
|
+
* for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary
|
|
196
197
|
* security credentials that you can use to sign requests.</p>
|
|
197
|
-
* <p>All
|
|
198
|
+
* <p>All KMS operations require <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4</a>.</p>
|
|
198
199
|
* <p>
|
|
199
200
|
* <b>Logging API Requests</b>
|
|
200
201
|
* </p>
|
|
201
|
-
* <p>
|
|
202
|
-
*
|
|
203
|
-
* collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request,
|
|
202
|
+
* <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
|
|
203
|
+
* collected by CloudTrail, you can determine what requests were made to KMS, who made the request,
|
|
204
204
|
* when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find
|
|
205
|
-
* your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">
|
|
205
|
+
* your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
206
206
|
* <p>
|
|
207
207
|
* <b>Additional Resources</b>
|
|
208
208
|
* </p>
|
|
@@ -210,9 +210,9 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
210
210
|
* <ul>
|
|
211
211
|
* <li>
|
|
212
212
|
* <p>
|
|
213
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">
|
|
213
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services Security
|
|
214
214
|
* Credentials</a> - This topic provides general information about the types of
|
|
215
|
-
* credentials used
|
|
215
|
+
* credentials used to access Amazon Web Services.</p>
|
|
216
216
|
* </li>
|
|
217
217
|
* <li>
|
|
218
218
|
* <p>
|
|
@@ -258,14 +258,13 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
|
258
258
|
*/
|
|
259
259
|
export class KMS extends KMSClient {
|
|
260
260
|
/**
|
|
261
|
-
* <p>Cancels the deletion of a
|
|
262
|
-
* state of the
|
|
263
|
-
* <p>For more information about scheduling and canceling deletion of a
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
* 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>
|
|
261
|
+
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key
|
|
262
|
+
* state of the KMS key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
263
|
+
* <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>
|
|
264
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
265
|
+
* 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>
|
|
267
266
|
* <p>
|
|
268
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
267
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
269
268
|
* <p>
|
|
270
269
|
* <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>
|
|
271
270
|
* <p>
|
|
@@ -302,24 +301,24 @@ export class KMS extends KMSClient {
|
|
|
302
301
|
}
|
|
303
302
|
|
|
304
303
|
/**
|
|
305
|
-
* <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
|
|
306
|
-
* <p>The custom key store must be connected before you can create
|
|
307
|
-
* in the key store or use the
|
|
304
|
+
* <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>
|
|
305
|
+
* <p>The custom key store must be connected before you can create KMS keys
|
|
306
|
+
* in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key
|
|
308
307
|
* store at any time.</p>
|
|
309
|
-
* <p>To connect a custom key store, its associated
|
|
308
|
+
* <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
|
|
310
309
|
* 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
|
|
311
310
|
* 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">
|
|
312
311
|
* <code>kmsuser</code> crypto
|
|
313
|
-
* user</a> (CU) must not be logged into the cluster. This prevents
|
|
312
|
+
* user</a> (CU) must not be logged into the cluster. This prevents KMS from using this
|
|
314
313
|
* account to log in.</p>
|
|
315
314
|
* <p>The connection process can take an extended amount of time to complete; up to 20 minutes.
|
|
316
315
|
* This operation starts the connection process, but it does not wait for it to complete. When it
|
|
317
316
|
* succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no
|
|
318
317
|
* properties. However, this response does not indicate that the custom key store is connected.
|
|
319
318
|
* To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation.</p>
|
|
320
|
-
* <p>During the connection process,
|
|
319
|
+
* <p>During the connection process, KMS finds the CloudHSM cluster that is associated with the
|
|
321
320
|
* custom key store, creates the connection infrastructure, connects to the cluster, logs into
|
|
322
|
-
* the
|
|
321
|
+
* the CloudHSM client as the <code>kmsuser</code> CU, and rotates its password.</p>
|
|
323
322
|
* <p>The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find
|
|
324
323
|
* the reason, use the <a>DescribeCustomKeyStores</a> operation and see the
|
|
325
324
|
* <code>ConnectionErrorCode</code> in the response. For help interpreting the
|
|
@@ -328,9 +327,9 @@ export class KMS extends KMSClient {
|
|
|
328
327
|
* disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use
|
|
329
328
|
* <code>ConnectCustomKeyStore</code> again.</p>
|
|
330
329
|
* <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
|
|
331
|
-
* Store</a> in the <i>
|
|
330
|
+
* Store</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
332
331
|
* <p>
|
|
333
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
332
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
334
333
|
*
|
|
335
334
|
* <p>
|
|
336
335
|
* <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>
|
|
@@ -395,26 +394,25 @@ export class KMS extends KMSClient {
|
|
|
395
394
|
}
|
|
396
395
|
|
|
397
396
|
/**
|
|
398
|
-
* <p>Creates a friendly name for a
|
|
397
|
+
* <p>Creates a friendly name for a KMS key. </p>
|
|
399
398
|
* <note>
|
|
400
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
399
|
+
* <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>
|
|
401
400
|
* </note>
|
|
402
|
-
* <p>You can use an alias to identify a
|
|
403
|
-
* <a>GenerateDataKey</a>. You can also change the
|
|
401
|
+
* <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
|
|
402
|
+
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with the
|
|
404
403
|
* alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>) at
|
|
405
|
-
* any time. These operations don't affect the underlying
|
|
406
|
-
* <p>You can associate the alias with any customer managed
|
|
407
|
-
* alias is associated with only one
|
|
408
|
-
* CMK is required. You can't create an alias without a CMK.</p>
|
|
404
|
+
* any time. These operations don't affect the underlying KMS key. </p>
|
|
405
|
+
* <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
|
|
406
|
+
* 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>
|
|
409
407
|
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
410
408
|
* 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
|
|
411
|
-
* <i>
|
|
409
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
412
410
|
* <p>This operation does not return a response. To get the alias that you created, use the
|
|
413
411
|
* <a>ListAliases</a> operation.</p>
|
|
414
|
-
* <p>The
|
|
415
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
412
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
413
|
+
* 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>
|
|
416
414
|
* <p>
|
|
417
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
415
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
418
416
|
*
|
|
419
417
|
* <p>
|
|
420
418
|
* <b>Required permissions</b>
|
|
@@ -426,10 +424,10 @@ export class KMS extends KMSClient {
|
|
|
426
424
|
* </li>
|
|
427
425
|
* <li>
|
|
428
426
|
* <p>
|
|
429
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on the
|
|
427
|
+
* <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>
|
|
430
428
|
* </li>
|
|
431
429
|
* </ul>
|
|
432
|
-
* <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>
|
|
430
|
+
* <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>
|
|
433
431
|
* <p>
|
|
434
432
|
* <b>Related operations:</b>
|
|
435
433
|
* </p>
|
|
@@ -475,24 +473,24 @@ export class KMS extends KMSClient {
|
|
|
475
473
|
}
|
|
476
474
|
|
|
477
475
|
/**
|
|
478
|
-
* <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">
|
|
476
|
+
* <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
|
|
479
477
|
* manage.</p>
|
|
480
|
-
* <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
|
|
481
|
-
* combines the convenience and extensive integration of
|
|
478
|
+
* <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
|
|
479
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
482
480
|
* single-tenant key store.</p>
|
|
483
481
|
* <p>Before you create the custom key store, you must assemble
|
|
484
|
-
* the required elements, including an
|
|
482
|
+
* the required elements, including an CloudHSM cluster that fulfills the requirements for a custom
|
|
485
483
|
* 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>
|
|
486
|
-
* in the <i>
|
|
484
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
487
485
|
* <p>When the operation completes successfully, it returns the ID of the new custom key store.
|
|
488
|
-
* 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
|
|
486
|
+
* 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
|
|
489
487
|
* cluster. Even if you are not going to use your custom key store immediately, you might want to
|
|
490
488
|
* connect it to verify that all settings are correct and then disconnect it until you are ready
|
|
491
489
|
* to use it.</p>
|
|
492
490
|
* <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
|
|
493
|
-
* <i>
|
|
491
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
494
492
|
* <p>
|
|
495
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
493
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
496
494
|
* <p>
|
|
497
495
|
* <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>
|
|
498
496
|
* <p>
|
|
@@ -556,45 +554,38 @@ export class KMS extends KMSClient {
|
|
|
556
554
|
}
|
|
557
555
|
|
|
558
556
|
/**
|
|
559
|
-
* <p>Adds a grant to a
|
|
560
|
-
* <p>A <i>grant</i> is a policy instrument that allows
|
|
561
|
-
* KMS customer master keys (CMKs) in cryptographic operations. It also can allow them to view a
|
|
562
|
-
* CMK (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a
|
|
563
|
-
* CMK, grants are considered along with key policies and IAM policies. Grants are often used for
|
|
557
|
+
* <p>Adds a grant to a KMS key. </p>
|
|
558
|
+
* <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
|
|
564
559
|
* temporary permissions because you can create one, use its permissions, and delete it without
|
|
565
560
|
* changing your key policies or IAM policies. </p>
|
|
566
561
|
* <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
|
|
567
562
|
* <i>
|
|
568
|
-
* <i>
|
|
563
|
+
* <i>Key Management Service Developer Guide</i>
|
|
569
564
|
* </i>. For examples of working with grants in several
|
|
570
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
565
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
571
566
|
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
572
|
-
*
|
|
567
|
+
* <code>GrantId</code>.</p>
|
|
573
568
|
* <ul>
|
|
574
569
|
* <li>
|
|
575
|
-
* <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
|
|
576
|
-
*
|
|
570
|
+
* <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
|
|
571
|
+
* can use the permissions in the grant without identifying the grant. </p>
|
|
577
572
|
* <p>However, to use the permissions in the grant immediately, use the
|
|
578
|
-
*
|
|
573
|
+
* <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
|
|
579
574
|
* token</a> in the <i>
|
|
580
|
-
* <i>
|
|
575
|
+
* <i>Key Management Service Developer Guide</i>
|
|
581
576
|
* </i>.</p>
|
|
582
577
|
* </li>
|
|
583
578
|
* <li>
|
|
584
579
|
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can use the
|
|
585
|
-
*
|
|
586
|
-
*
|
|
587
|
-
*
|
|
580
|
+
* <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
|
|
581
|
+
* ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
|
|
582
|
+
* operations.</p>
|
|
588
583
|
* </li>
|
|
589
584
|
* </ul>
|
|
590
|
-
* <p>
|
|
591
|
-
*
|
|
592
|
-
* <i>AWS Key Management Service Developer Guide</i>
|
|
593
|
-
* </i>.</p>
|
|
594
|
-
* <p>The CMK that you use for this operation must be in a compatible key state. For
|
|
595
|
-
* 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>
|
|
585
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
586
|
+
* 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>
|
|
596
587
|
* <p>
|
|
597
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
588
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
598
589
|
* ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
599
590
|
* <p>
|
|
600
591
|
* <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>
|
|
@@ -648,109 +639,109 @@ export class KMS extends KMSClient {
|
|
|
648
639
|
}
|
|
649
640
|
|
|
650
641
|
/**
|
|
651
|
-
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#
|
|
652
|
-
*
|
|
642
|
+
* <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>
|
|
643
|
+
* <note>
|
|
644
|
+
* <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>
|
|
645
|
+
* </note>
|
|
653
646
|
*
|
|
654
|
-
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric
|
|
655
|
-
* CMKs.</p>
|
|
647
|
+
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS keys.</p>
|
|
656
648
|
* <ul>
|
|
657
649
|
* <li>
|
|
658
650
|
* <p>
|
|
659
|
-
* <b>Symmetric
|
|
660
|
-
* never leaves
|
|
661
|
-
* symmetric
|
|
651
|
+
* <b>Symmetric KMS keys</b> contain a 256-bit symmetric key that
|
|
652
|
+
* never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use a
|
|
653
|
+
* symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically used to
|
|
662
654
|
* generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|
663
655
|
* keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
|
|
664
656
|
* see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
|
|
665
657
|
* </li>
|
|
666
658
|
* <li>
|
|
667
659
|
* <p>
|
|
668
|
-
* <b>Asymmetric
|
|
669
|
-
* Elliptic Curve (ECC) key pair. The private key in an asymmetric
|
|
660
|
+
* <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
|
|
661
|
+
* Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
|
|
670
662
|
* unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
|
|
671
|
-
* the public key so it can be used outside of
|
|
672
|
-
* encrypt or decrypt data or sign and verify messages (but not both).
|
|
663
|
+
* the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used to
|
|
664
|
+
* encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC key
|
|
673
665
|
* pairs can be used only to sign and verify messages.</p>
|
|
674
666
|
* </li>
|
|
675
667
|
* </ul>
|
|
676
|
-
* <p>For information about symmetric and asymmetric
|
|
668
|
+
* <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>
|
|
677
669
|
*
|
|
678
670
|
*
|
|
679
|
-
* <p>To create different types of
|
|
671
|
+
* <p>To create different types of KMS keys, use the following guidance:</p>
|
|
680
672
|
*
|
|
681
673
|
* <dl>
|
|
682
|
-
* <dt>Asymmetric
|
|
674
|
+
* <dt>Asymmetric KMS keys</dt>
|
|
683
675
|
* <dd>
|
|
684
|
-
* <p>To create an asymmetric
|
|
685
|
-
*
|
|
686
|
-
*
|
|
687
|
-
*
|
|
676
|
+
* <p>To create an asymmetric KMS key, use the <code>KeySpec</code> parameter to specify
|
|
677
|
+
* the type of key material in the KMS key. Then, use the <code>KeyUsage</code> parameter
|
|
678
|
+
* to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.
|
|
679
|
+
* You can't change these properties after the KMS key is created.</p>
|
|
688
680
|
* <p> </p>
|
|
689
681
|
* </dd>
|
|
690
|
-
* <dt>Symmetric
|
|
682
|
+
* <dt>Symmetric KMS keys</dt>
|
|
691
683
|
* <dd>
|
|
692
|
-
* <p>When creating a symmetric
|
|
693
|
-
* <code>
|
|
694
|
-
*
|
|
695
|
-
*
|
|
696
|
-
*
|
|
684
|
+
* <p>When creating a symmetric KMS key, you don't need to specify the
|
|
685
|
+
* <code>KeySpec</code> or <code>KeyUsage</code> parameters. The default value for
|
|
686
|
+
* <code>KeySpec</code>, <code>SYMMETRIC_DEFAULT</code>, and the default value for
|
|
687
|
+
* <code>KeyUsage</code>, <code>ENCRYPT_DECRYPT</code>, are the only valid values for
|
|
688
|
+
* symmetric KMS keys. </p>
|
|
697
689
|
* <p> </p>
|
|
698
690
|
* </dd>
|
|
699
691
|
* <dt>Multi-Region primary keys</dt>
|
|
700
692
|
* <dt>Imported key material</dt>
|
|
701
693
|
* <dd>
|
|
702
|
-
* <p>To create a multi-Region <i>primary key</i> in the local
|
|
694
|
+
* <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
|
|
703
695
|
* use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
|
|
704
|
-
* a multi-Region <i>replica key</i>, that is, a
|
|
705
|
-
* key material as a primary key, but in a different
|
|
696
|
+
* a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID and
|
|
697
|
+
* 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
|
|
706
698
|
* primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
|
|
707
699
|
* operation.</p>
|
|
708
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
709
|
-
* interoperable
|
|
710
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
711
|
-
* it in a different
|
|
700
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
701
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
702
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
703
|
+
* 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>
|
|
712
704
|
* <p>You can create symmetric and asymmetric multi-Region keys and multi-Region keys with
|
|
713
705
|
* imported key material. You cannot create multi-Region keys in a custom key store.</p>
|
|
714
706
|
* <p> </p>
|
|
715
707
|
* </dd>
|
|
716
708
|
* <dd>
|
|
717
|
-
* <p>To import your own key material, begin by creating a symmetric
|
|
709
|
+
* <p>To import your own key material, begin by creating a symmetric KMS key with no key
|
|
718
710
|
* material. To do this, use the <code>Origin</code> parameter of <code>CreateKey</code>
|
|
719
711
|
* 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
|
|
720
712
|
* your key material. Then, use <a>ImportKeyMaterial</a> with your import token
|
|
721
713
|
* 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>
|
|
722
|
-
* <i>
|
|
714
|
+
* <i>Key Management Service Developer Guide</i>
|
|
723
715
|
* </i>. You
|
|
724
|
-
* cannot import the key material into an asymmetric
|
|
716
|
+
* cannot import the key material into an asymmetric KMS key.</p>
|
|
725
717
|
* <p>To create a multi-Region primary key with imported key material, use the
|
|
726
718
|
* <code>Origin</code> parameter of <code>CreateKey</code> with a value of
|
|
727
719
|
* <code>EXTERNAL</code> and the <code>MultiRegion</code> parameter with a value of
|
|
728
|
-
* <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>
|
|
720
|
+
* <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>
|
|
729
721
|
* <p> </p>
|
|
730
722
|
* </dd>
|
|
731
723
|
* <dt>Custom key store</dt>
|
|
732
724
|
* <dd>
|
|
733
|
-
* <p>To create a symmetric
|
|
725
|
+
* <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
|
|
734
726
|
* <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also
|
|
735
727
|
* use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The
|
|
736
|
-
*
|
|
737
|
-
* HSMs in different Availability Zones in the
|
|
738
|
-
* <p>You cannot create an asymmetric
|
|
739
|
-
*
|
|
728
|
+
* CloudHSM cluster that is associated with the custom key store must have at least two active
|
|
729
|
+
* HSMs in different Availability Zones in the Amazon Web Services Region. </p>
|
|
730
|
+
* <p>You cannot create an asymmetric KMS key in a custom key store. For information about
|
|
731
|
+
* 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
|
|
740
732
|
* the <i>
|
|
741
|
-
* <i>
|
|
733
|
+
* <i>Key Management Service Developer Guide</i>
|
|
742
734
|
* </i>.</p>
|
|
743
735
|
* </dd>
|
|
744
736
|
* </dl>
|
|
745
737
|
* <p>
|
|
746
738
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
747
|
-
* create a
|
|
739
|
+
* create a KMS key in a different Amazon Web Services account.</p>
|
|
748
740
|
*
|
|
749
741
|
* <p>
|
|
750
742
|
* <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
|
|
751
743
|
* <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
|
|
752
|
-
* 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
|
|
753
|
-
* CMKs</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|
744
|
+
* 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>
|
|
754
745
|
* <p>
|
|
755
746
|
* <b>Related operations:</b>
|
|
756
747
|
* </p>
|
|
@@ -796,7 +787,7 @@ export class KMS extends KMSClient {
|
|
|
796
787
|
}
|
|
797
788
|
|
|
798
789
|
/**
|
|
799
|
-
* <p>Decrypts ciphertext that was encrypted by a
|
|
790
|
+
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of
|
|
800
791
|
* the following operations:</p>
|
|
801
792
|
* <ul>
|
|
802
793
|
* <li>
|
|
@@ -826,33 +817,34 @@ export class KMS extends KMSClient {
|
|
|
826
817
|
* </li>
|
|
827
818
|
* </ul>
|
|
828
819
|
* <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
|
|
829
|
-
* asymmetric
|
|
830
|
-
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric
|
|
831
|
-
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of
|
|
832
|
-
* public key in an
|
|
833
|
-
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">
|
|
820
|
+
* asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption
|
|
821
|
+
* 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>
|
|
822
|
+
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
|
|
823
|
+
* public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other
|
|
824
|
+
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption
|
|
834
825
|
* 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
|
|
835
|
-
* is incompatible with
|
|
836
|
-
* <p>If the ciphertext was encrypted under a symmetric
|
|
837
|
-
* optional.
|
|
826
|
+
* is incompatible with KMS.</p>
|
|
827
|
+
* <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code> parameter is
|
|
828
|
+
* optional. KMS can get this information from metadata that it adds to the symmetric
|
|
838
829
|
* ciphertext blob. This feature adds durability to your implementation by ensuring that
|
|
839
830
|
* authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost
|
|
840
|
-
* track of the
|
|
841
|
-
* When you use the <code>KeyId</code> parameter to specify a
|
|
842
|
-
* specify. If the ciphertext was encrypted under a different
|
|
843
|
-
* operation fails. This practice ensures that you use the
|
|
831
|
+
* track of the key ID. However, specifying the KMS key is always recommended as a best practice.
|
|
832
|
+
* When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses the KMS key you
|
|
833
|
+
* specify. If the ciphertext was encrypted under a different KMS key, the <code>Decrypt</code>
|
|
834
|
+
* operation fails. This practice ensures that you use the KMS key that you intend.</p>
|
|
844
835
|
* <p>Whenever possible, use key policies to give users permission to call the
|
|
845
|
-
* <code>Decrypt</code> operation on a particular
|
|
836
|
+
* <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
|
|
846
837
|
* Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
|
|
847
|
-
* permission on all
|
|
848
|
-
* accounts if the key policy for the cross-account
|
|
849
|
-
* for <code>Decrypt</code> permissions, limit the user to particular
|
|
850
|
-
* 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>
|
|
851
|
-
* <p>
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
*
|
|
838
|
+
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other
|
|
839
|
+
* accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy
|
|
840
|
+
* for <code>Decrypt</code> permissions, limit the user to particular KMS keys or particular trusted
|
|
841
|
+
* 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>
|
|
842
|
+
* <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>
|
|
843
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
844
|
+
* 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>
|
|
845
|
+
* <p>
|
|
846
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
847
|
+
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
856
848
|
*
|
|
857
849
|
* <p>
|
|
858
850
|
* <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>
|
|
@@ -908,15 +900,14 @@ export class KMS extends KMSClient {
|
|
|
908
900
|
/**
|
|
909
901
|
* <p>Deletes the specified alias. </p>
|
|
910
902
|
* <note>
|
|
911
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
903
|
+
* <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>
|
|
912
904
|
* </note>
|
|
913
|
-
* <p>Because an alias is not a property of a
|
|
914
|
-
*
|
|
915
|
-
*
|
|
916
|
-
* create a new alias. To associate an existing alias with a different customer master key (CMK),
|
|
905
|
+
* <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>
|
|
906
|
+
* <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
|
|
907
|
+
* create a new alias. To associate an existing alias with a different KMS key,
|
|
917
908
|
* call <a>UpdateAlias</a>.</p>
|
|
918
909
|
* <p>
|
|
919
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different
|
|
910
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
920
911
|
* <p>
|
|
921
912
|
* <b>Required permissions</b>
|
|
922
913
|
* </p>
|
|
@@ -927,10 +918,10 @@ export class KMS extends KMSClient {
|
|
|
927
918
|
* </li>
|
|
928
919
|
* <li>
|
|
929
920
|
* <p>
|
|
930
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on the
|
|
921
|
+
* <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>
|
|
931
922
|
* </li>
|
|
932
923
|
* </ul>
|
|
933
|
-
* <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>
|
|
924
|
+
* <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>
|
|
934
925
|
* <p>
|
|
935
926
|
* <b>Related operations:</b>
|
|
936
927
|
* </p>
|
|
@@ -976,29 +967,29 @@ export class KMS extends KMSClient {
|
|
|
976
967
|
}
|
|
977
968
|
|
|
978
969
|
/**
|
|
979
|
-
* <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
|
|
970
|
+
* <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
|
|
980
971
|
* associated with the custom key store, or affect any users or keys in the cluster.</p>
|
|
981
|
-
* <p>The custom key store that you delete cannot contain any
|
|
982
|
-
* deleting the key store, verify that you will never need to use any of the
|
|
972
|
+
* <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
|
|
973
|
+
* deleting the key store, verify that you will never need to use any of the KMS keys in the key
|
|
983
974
|
* 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
|
|
984
|
-
*
|
|
985
|
-
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the
|
|
975
|
+
* KMS keys from the key store. When the scheduled waiting period
|
|
976
|
+
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the KMS keys. Then it makes a best
|
|
986
977
|
* effort to delete the key material from the associated cluster. However, you might need to
|
|
987
978
|
* manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
988
979
|
* material</a> from the cluster and its backups.</p>
|
|
989
|
-
* <p>After all
|
|
990
|
-
* disconnect the key store from
|
|
991
|
-
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from
|
|
992
|
-
* disconnected, you cannot create or use the
|
|
993
|
-
* delete
|
|
980
|
+
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a> to
|
|
981
|
+
* disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
982
|
+
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
|
|
983
|
+
* disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
|
|
984
|
+
* delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
|
|
994
985
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
995
986
|
* properties.</p>
|
|
996
|
-
* <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
|
|
997
|
-
* combines the convenience and extensive integration of
|
|
987
|
+
* <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
|
|
988
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
998
989
|
* single-tenant key store.</p>
|
|
999
990
|
*
|
|
1000
991
|
* <p>
|
|
1001
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
992
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
1002
993
|
*
|
|
1003
994
|
* <p>
|
|
1004
995
|
* <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>
|
|
@@ -1064,18 +1055,18 @@ export class KMS extends KMSClient {
|
|
|
1064
1055
|
|
|
1065
1056
|
/**
|
|
1066
1057
|
* <p>Deletes key material that you previously imported. This operation makes the specified
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1069
|
-
* Material</a> in the <i>
|
|
1070
|
-
* <p>When the specified
|
|
1071
|
-
* not change the
|
|
1058
|
+
* KMS key unusable. For more information about importing key material into
|
|
1059
|
+
* KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
1060
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
1061
|
+
* <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does
|
|
1062
|
+
* not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
1072
1063
|
* <code>PendingImport</code>.</p>
|
|
1073
1064
|
* <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
|
|
1074
|
-
* the same key material into the
|
|
1075
|
-
* <p>The
|
|
1076
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1065
|
+
* the same key material into the KMS key.</p>
|
|
1066
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1067
|
+
* 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>
|
|
1077
1068
|
* <p>
|
|
1078
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1069
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1079
1070
|
*
|
|
1080
1071
|
* <p>
|
|
1081
1072
|
* <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>
|
|
@@ -1126,14 +1117,14 @@ export class KMS extends KMSClient {
|
|
|
1126
1117
|
|
|
1127
1118
|
/**
|
|
1128
1119
|
* <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>
|
|
1129
|
-
* <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
|
|
1130
|
-
* combines the convenience and extensive integration of
|
|
1120
|
+
* <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
|
|
1121
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
1131
1122
|
* single-tenant key store.</p>
|
|
1132
1123
|
* <p>By default, this operation returns information about all custom key stores in the account and
|
|
1133
1124
|
* Region. To get only information about a particular custom key store, use either the
|
|
1134
1125
|
* <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not
|
|
1135
1126
|
* both).</p>
|
|
1136
|
-
* <p>To determine whether the custom key store is connected to its
|
|
1127
|
+
* <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
|
|
1137
1128
|
* <code>ConnectionState</code> element in the response. If an attempt to connect the custom
|
|
1138
1129
|
* key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
|
|
1139
1130
|
* <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
|
|
@@ -1141,12 +1132,12 @@ export class KMS extends KMSClient {
|
|
|
1141
1132
|
* <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
|
|
1142
1133
|
* never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
|
|
1143
1134
|
* disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
|
|
1144
|
-
* trouble using it, make sure that its associated
|
|
1135
|
+
* trouble using it, make sure that its associated CloudHSM cluster is active and contains the
|
|
1145
1136
|
* minimum number of HSMs required for the operation, if any.</p>
|
|
1146
1137
|
* <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
|
|
1147
|
-
* <i>
|
|
1138
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1148
1139
|
* <p>
|
|
1149
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
1140
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
1150
1141
|
* <p>
|
|
1151
1142
|
* <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>
|
|
1152
1143
|
* <p>
|
|
@@ -1210,41 +1201,40 @@ export class KMS extends KMSClient {
|
|
|
1210
1201
|
}
|
|
1211
1202
|
|
|
1212
1203
|
/**
|
|
1213
|
-
* <p>Provides detailed information about a
|
|
1214
|
-
* <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
1215
|
-
* CMK</a>.</p>
|
|
1204
|
+
* <p>Provides detailed information about a KMS key. You can run
|
|
1205
|
+
* <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>
|
|
1216
1206
|
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
|
|
1217
1207
|
* applicable), the key state, and the origin and expiration date (if any) of the key material.
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1221
|
-
*
|
|
1222
|
-
* the
|
|
1208
|
+
* It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
|
|
1209
|
+
* asymmetric KMS keys. It also provides information that is particularly important to asymmetric
|
|
1210
|
+
* keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
|
|
1211
|
+
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about
|
|
1212
|
+
* the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region
|
|
1213
|
+
* keys, it displays the primary key and all related replica keys. </p>
|
|
1223
1214
|
* <p>
|
|
1224
1215
|
* <code>DescribeKey</code> does not return the following information:</p>
|
|
1225
1216
|
* <ul>
|
|
1226
1217
|
* <li>
|
|
1227
|
-
* <p>Aliases associated with the
|
|
1218
|
+
* <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
|
|
1228
1219
|
* </li>
|
|
1229
1220
|
* <li>
|
|
1230
|
-
* <p>Whether automatic key rotation is enabled on the
|
|
1231
|
-
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a
|
|
1221
|
+
* <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
|
|
1222
|
+
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from being
|
|
1232
1223
|
* 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
|
|
1233
|
-
* Works</a> in <i>
|
|
1224
|
+
* Works</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
1234
1225
|
* </li>
|
|
1235
1226
|
* <li>
|
|
1236
|
-
* <p>Tags on the
|
|
1227
|
+
* <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
|
|
1237
1228
|
* </li>
|
|
1238
1229
|
* <li>
|
|
1239
|
-
* <p>Key policies and grants on the
|
|
1230
|
+
* <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
|
|
1240
1231
|
* </li>
|
|
1241
1232
|
* </ul>
|
|
1242
|
-
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1245
|
-
* <code>Arn</code> of the new CMK in the response.</p>
|
|
1233
|
+
* <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>.
|
|
1234
|
+
* Then, it associates the alias with the new KMS key, and returns the <code>KeyId</code> and
|
|
1235
|
+
* <code>Arn</code> of the new KMS key in the response.</p>
|
|
1246
1236
|
* <p>
|
|
1247
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1237
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1248
1238
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1249
1239
|
*
|
|
1250
1240
|
* <p>
|
|
@@ -1314,15 +1304,15 @@ export class KMS extends KMSClient {
|
|
|
1314
1304
|
}
|
|
1315
1305
|
|
|
1316
1306
|
/**
|
|
1317
|
-
* <p>Sets the state of a
|
|
1318
|
-
* prevents use of the
|
|
1319
|
-
* <p>For more information about how key state affects the use of a
|
|
1320
|
-
* <i>
|
|
1307
|
+
* <p>Sets the state of a KMS key to disabled. This change temporarily
|
|
1308
|
+
* 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>
|
|
1309
|
+
* <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>
|
|
1310
|
+
* <i>Key Management Service Developer Guide</i>
|
|
1321
1311
|
* </i>.</p>
|
|
1322
|
-
* <p>The
|
|
1323
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1312
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1313
|
+
* 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>
|
|
1324
1314
|
* <p>
|
|
1325
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1315
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1326
1316
|
*
|
|
1327
1317
|
* <p>
|
|
1328
1318
|
* <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>
|
|
@@ -1355,13 +1345,12 @@ export class KMS extends KMSClient {
|
|
|
1355
1345
|
|
|
1356
1346
|
/**
|
|
1357
1347
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
1358
|
-
* rotation of the key material</a> for the specified symmetric
|
|
1359
|
-
*
|
|
1360
|
-
* <p>
|
|
1361
|
-
*
|
|
1362
|
-
* 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>
|
|
1348
|
+
* rotation of the key material</a> for the specified symmetric KMS key.</p>
|
|
1349
|
+
* <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>
|
|
1350
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1351
|
+
* 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>
|
|
1363
1352
|
* <p>
|
|
1364
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1353
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1365
1354
|
*
|
|
1366
1355
|
* <p>
|
|
1367
1356
|
* <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>
|
|
@@ -1411,13 +1400,11 @@ export class KMS extends KMSClient {
|
|
|
1411
1400
|
}
|
|
1412
1401
|
|
|
1413
1402
|
/**
|
|
1414
|
-
* <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
|
|
1415
|
-
* store is disconnected, you can manage the custom key store and its
|
|
1416
|
-
* (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the
|
|
1403
|
+
* <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
|
|
1404
|
+
* 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
|
|
1417
1405
|
* custom key store at any time.</p>
|
|
1418
1406
|
* <note>
|
|
1419
|
-
* <p>While a custom key store is disconnected, all attempts to create
|
|
1420
|
-
* (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
|
|
1407
|
+
* <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
|
|
1421
1408
|
* fail. This action can prevent users from storing and accessing sensitive data.</p>
|
|
1422
1409
|
* </note>
|
|
1423
1410
|
* <p></p>
|
|
@@ -1425,12 +1412,12 @@ export class KMS extends KMSClient {
|
|
|
1425
1412
|
* <a>ConnectCustomKeyStore</a> operation.</p>
|
|
1426
1413
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
1427
1414
|
* properties.</p>
|
|
1428
|
-
* <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
|
|
1429
|
-
* combines the convenience and extensive integration of
|
|
1415
|
+
* <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
|
|
1416
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
1430
1417
|
* single-tenant key store.</p>
|
|
1431
1418
|
*
|
|
1432
1419
|
* <p>
|
|
1433
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
1420
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
1434
1421
|
*
|
|
1435
1422
|
* <p>
|
|
1436
1423
|
* <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>
|
|
@@ -1495,12 +1482,11 @@ export class KMS extends KMSClient {
|
|
|
1495
1482
|
}
|
|
1496
1483
|
|
|
1497
1484
|
/**
|
|
1498
|
-
* <p>Sets the key state of a
|
|
1499
|
-
*
|
|
1500
|
-
*
|
|
1501
|
-
* 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>
|
|
1485
|
+
* <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>
|
|
1486
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1487
|
+
* 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>
|
|
1502
1488
|
* <p>
|
|
1503
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1489
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1504
1490
|
*
|
|
1505
1491
|
* <p>
|
|
1506
1492
|
* <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>
|
|
@@ -1533,12 +1519,12 @@ export class KMS extends KMSClient {
|
|
|
1533
1519
|
|
|
1534
1520
|
/**
|
|
1535
1521
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
1536
|
-
* of the key material</a> for the specified symmetric
|
|
1537
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
1538
|
-
* <p>The
|
|
1539
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1522
|
+
* of the key material</a> for the specified symmetric KMS key.</p>
|
|
1523
|
+
* <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>
|
|
1524
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1525
|
+
* 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>
|
|
1540
1526
|
* <p>
|
|
1541
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
1527
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1542
1528
|
*
|
|
1543
1529
|
* <p>
|
|
1544
1530
|
* <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>
|
|
@@ -1588,7 +1574,7 @@ export class KMS extends KMSClient {
|
|
|
1588
1574
|
}
|
|
1589
1575
|
|
|
1590
1576
|
/**
|
|
1591
|
-
* <p>Encrypts plaintext into ciphertext by using a
|
|
1577
|
+
* <p>Encrypts plaintext into ciphertext by using a KMS key. The
|
|
1592
1578
|
* <code>Encrypt</code> operation has two primary use cases:</p>
|
|
1593
1579
|
* <ul>
|
|
1594
1580
|
* <li>
|
|
@@ -1596,41 +1582,40 @@ export class KMS extends KMSClient {
|
|
|
1596
1582
|
* database password, or other sensitive information. </p>
|
|
1597
1583
|
* </li>
|
|
1598
1584
|
* <li>
|
|
1599
|
-
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one
|
|
1600
|
-
*
|
|
1601
|
-
*
|
|
1602
|
-
*
|
|
1603
|
-
* the encrypted data
|
|
1604
|
-
* and the encrypted data entirely within in Region B.</p>
|
|
1585
|
+
* <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
|
|
1586
|
+
* your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the
|
|
1587
|
+
* plaintext data key under a KMS key in Region B. Now, you can move the encrypted data and the
|
|
1588
|
+
* encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and
|
|
1589
|
+
* the encrypted data entirely within in Region B.</p>
|
|
1605
1590
|
* </li>
|
|
1606
1591
|
* </ul>
|
|
1607
1592
|
*
|
|
1608
1593
|
* <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
|
|
1609
1594
|
* plaintext data key and an encrypted copy of that data key.</p>
|
|
1610
1595
|
*
|
|
1611
|
-
* <p>When you encrypt data, you must specify a symmetric or asymmetric
|
|
1612
|
-
* encryption operation. The
|
|
1613
|
-
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a
|
|
1596
|
+
* <p>When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the
|
|
1597
|
+
* encryption operation. The KMS key must have a <code>KeyUsage</code> value of
|
|
1598
|
+
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1614
1599
|
*
|
|
1615
|
-
* <p>If you use a symmetric
|
|
1600
|
+
* <p>If you use a symmetric KMS key, you can use an encryption context to add additional security
|
|
1616
1601
|
* to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting
|
|
1617
1602
|
* data, you must specify the same encryption context (a case-sensitive exact match) when
|
|
1618
1603
|
* decrypting the data. Otherwise, the request to decrypt fails with an
|
|
1619
1604
|
* <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1620
|
-
* Context</a> in the <i>
|
|
1621
|
-
* <p>If you specify an asymmetric
|
|
1622
|
-
* algorithm must be compatible with the
|
|
1605
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1606
|
+
* <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
|
|
1607
|
+
* algorithm must be compatible with the KMS key type.</p>
|
|
1623
1608
|
* <important>
|
|
1624
|
-
* <p>When you use an asymmetric
|
|
1625
|
-
* <p>You are not required to supply the
|
|
1609
|
+
* <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>
|
|
1610
|
+
* <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>
|
|
1626
1611
|
* </important>
|
|
1627
1612
|
*
|
|
1628
1613
|
*
|
|
1629
|
-
* <p>The maximum size of the data that you can encrypt varies with the type of
|
|
1614
|
+
* <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
|
|
1630
1615
|
* encryption algorithm that you choose.</p>
|
|
1631
1616
|
* <ul>
|
|
1632
1617
|
* <li>
|
|
1633
|
-
* <p>Symmetric
|
|
1618
|
+
* <p>Symmetric KMS keys</p>
|
|
1634
1619
|
* <ul>
|
|
1635
1620
|
* <li>
|
|
1636
1621
|
* <p>
|
|
@@ -1684,10 +1669,10 @@ export class KMS extends KMSClient {
|
|
|
1684
1669
|
* </ul>
|
|
1685
1670
|
* </li>
|
|
1686
1671
|
* </ul>
|
|
1687
|
-
* <p>The
|
|
1688
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1672
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1673
|
+
* 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>
|
|
1689
1674
|
* <p>
|
|
1690
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1675
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1691
1676
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1692
1677
|
*
|
|
1693
1678
|
* <p>
|
|
@@ -1738,16 +1723,16 @@ export class KMS extends KMSClient {
|
|
|
1738
1723
|
|
|
1739
1724
|
/**
|
|
1740
1725
|
* <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
|
|
1741
|
-
* plaintext copy of the data key and a copy that is encrypted under a
|
|
1742
|
-
* that you specify. You can use the plaintext key to encrypt your data outside of
|
|
1726
|
+
* plaintext copy of the data key and a copy that is encrypted under a KMS key
|
|
1727
|
+
* that you specify. You can use the plaintext key to encrypt your data outside of KMS and
|
|
1743
1728
|
* store the encrypted data key with the encrypted data.</p>
|
|
1744
1729
|
*
|
|
1745
1730
|
* <p>
|
|
1746
1731
|
* <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
|
|
1747
|
-
* plaintext key are not related to the caller or the
|
|
1732
|
+
* plaintext key are not related to the caller or the KMS key.</p>
|
|
1748
1733
|
*
|
|
1749
|
-
* <p>To generate a data key, specify the symmetric
|
|
1750
|
-
* key. You cannot use an asymmetric
|
|
1734
|
+
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the data
|
|
1735
|
+
* key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use
|
|
1751
1736
|
* the <a>DescribeKey</a> operation. You must also specify the length of the data key.
|
|
1752
1737
|
* Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both).
|
|
1753
1738
|
* For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
@@ -1760,45 +1745,44 @@ export class KMS extends KMSClient {
|
|
|
1760
1745
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1761
1746
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1762
1747
|
* 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
|
|
1763
|
-
* <i>
|
|
1764
|
-
* <p>
|
|
1765
|
-
*
|
|
1748
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1749
|
+
* <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>
|
|
1750
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1751
|
+
* 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>
|
|
1766
1752
|
* <p>
|
|
1767
|
-
* <b>How to use your
|
|
1768
|
-
* data key</b>
|
|
1753
|
+
* <b>How to use your data key</b>
|
|
1769
1754
|
* </p>
|
|
1770
|
-
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
1771
|
-
*
|
|
1772
|
-
* <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
|
|
1755
|
+
* <p>We recommend that you use the following pattern to encrypt data locally in your application.
|
|
1756
|
+
* 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
|
|
1773
1757
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
1774
1758
|
* client-side encryption</a> to do these tasks for you.</p>
|
|
1775
|
-
* <p>To encrypt data outside of
|
|
1759
|
+
* <p>To encrypt data outside of KMS:</p>
|
|
1776
1760
|
* <ol>
|
|
1777
1761
|
* <li>
|
|
1778
1762
|
* <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p>
|
|
1779
1763
|
* </li>
|
|
1780
1764
|
* <li>
|
|
1781
1765
|
* <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to
|
|
1782
|
-
* encrypt your data outside of
|
|
1766
|
+
* encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p>
|
|
1783
1767
|
* </li>
|
|
1784
1768
|
* <li>
|
|
1785
1769
|
* <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the
|
|
1786
1770
|
* response) with the encrypted data.</p>
|
|
1787
1771
|
* </li>
|
|
1788
1772
|
* </ol>
|
|
1789
|
-
* <p>To decrypt data outside of
|
|
1773
|
+
* <p>To decrypt data outside of KMS:</p>
|
|
1790
1774
|
* <ol>
|
|
1791
1775
|
* <li>
|
|
1792
1776
|
* <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The
|
|
1793
1777
|
* operation returns a plaintext copy of the data key.</p>
|
|
1794
1778
|
* </li>
|
|
1795
1779
|
* <li>
|
|
1796
|
-
* <p>Use the plaintext data key to decrypt data outside of
|
|
1780
|
+
* <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext
|
|
1797
1781
|
* data key from memory.</p>
|
|
1798
1782
|
* </li>
|
|
1799
1783
|
* </ol>
|
|
1800
1784
|
* <p>
|
|
1801
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1785
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1802
1786
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1803
1787
|
*
|
|
1804
1788
|
* <p>
|
|
@@ -1866,21 +1850,20 @@ export class KMS extends KMSClient {
|
|
|
1866
1850
|
/**
|
|
1867
1851
|
* <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
|
|
1868
1852
|
* operation returns a plaintext public key, a plaintext private key, and a copy of the private
|
|
1869
|
-
* key that is encrypted under the symmetric
|
|
1870
|
-
* perform asymmetric cryptography outside of
|
|
1871
|
-
*
|
|
1872
|
-
* <p>
|
|
1873
|
-
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1874
|
-
* bytes in the keys are not related to the caller or the CMK that is used to encrypt the private
|
|
1875
|
-
* key.</p>
|
|
1853
|
+
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to
|
|
1854
|
+
* perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
1876
1855
|
*
|
|
1877
1856
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
1878
|
-
* or verify a signature outside of
|
|
1857
|
+
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
1879
1858
|
* 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>
|
|
1880
1859
|
*
|
|
1881
|
-
* <p>To generate a data key pair, you must specify a symmetric
|
|
1882
|
-
* encrypt the private key in a data key pair. You cannot use an asymmetric
|
|
1883
|
-
* custom key store. To get the type and origin of your
|
|
1860
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1861
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
1862
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1863
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1864
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1865
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
1866
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
1884
1867
|
*
|
|
1885
1868
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
1886
1869
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
@@ -1890,15 +1873,22 @@ export class KMS extends KMSClient {
|
|
|
1890
1873
|
* the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
|
|
1891
1874
|
* pair.</p>
|
|
1892
1875
|
*
|
|
1876
|
+
* <p>
|
|
1877
|
+
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1878
|
+
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private
|
|
1879
|
+
* 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
|
|
1880
|
+
* private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC
|
|
1881
|
+
* 5958</a>.</p>
|
|
1882
|
+
*
|
|
1893
1883
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
1894
1884
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1895
1885
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1896
1886
|
* 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
|
|
1897
|
-
* <i>
|
|
1898
|
-
* <p>The
|
|
1899
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1887
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1888
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1889
|
+
* 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>
|
|
1900
1890
|
* <p>
|
|
1901
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1891
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1902
1892
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1903
1893
|
*
|
|
1904
1894
|
* <p>
|
|
@@ -1966,30 +1956,34 @@ export class KMS extends KMSClient {
|
|
|
1966
1956
|
/**
|
|
1967
1957
|
* <p>Generates a unique asymmetric data key pair. The
|
|
1968
1958
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key
|
|
1969
|
-
* and a copy of the private key that is encrypted under the symmetric
|
|
1959
|
+
* and a copy of the private key that is encrypted under the symmetric KMS key you specify. Unlike
|
|
1970
1960
|
* <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private
|
|
1971
1961
|
* key. </p>
|
|
1972
|
-
* <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to
|
|
1973
|
-
* encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a
|
|
1974
|
-
* custom key store. To get the type and origin of your CMK, use the <code>KeySpec</code> field
|
|
1975
|
-
* in the <a>DescribeKey</a> response.</p>
|
|
1976
1962
|
* <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
|
|
1977
|
-
* to encrypt data or verify a signature outside of
|
|
1963
|
+
* to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
|
|
1978
1964
|
* 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>
|
|
1965
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1966
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
1967
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1968
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1969
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1970
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
1971
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
1979
1972
|
* <p>
|
|
1980
1973
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
|
|
1981
|
-
* request. The bytes in the key are not related to the caller or
|
|
1982
|
-
* private key
|
|
1974
|
+
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the
|
|
1975
|
+
* private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1976
|
+
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
1983
1977
|
*
|
|
1984
1978
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
1985
1979
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
1986
1980
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
1987
1981
|
* 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
|
|
1988
|
-
* <i>
|
|
1989
|
-
* <p>The
|
|
1990
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
1982
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1983
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1984
|
+
* 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>
|
|
1991
1985
|
* <p>
|
|
1992
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
1986
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1993
1987
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1994
1988
|
*
|
|
1995
1989
|
* <p>
|
|
@@ -2056,7 +2050,7 @@ export class KMS extends KMSClient {
|
|
|
2056
2050
|
|
|
2057
2051
|
/**
|
|
2058
2052
|
* <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted
|
|
2059
|
-
* under a
|
|
2053
|
+
* under a KMS key that you specify. To request an asymmetric data key pair,
|
|
2060
2054
|
* use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
2061
2055
|
* <p>
|
|
2062
2056
|
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the
|
|
@@ -2072,12 +2066,12 @@ export class KMS extends KMSClient {
|
|
|
2072
2066
|
* plaintext data key.</p>
|
|
2073
2067
|
* <p>
|
|
2074
2068
|
* <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request.
|
|
2075
|
-
* The bytes in the keys are not related to the caller or
|
|
2069
|
+
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the private
|
|
2076
2070
|
* key.</p>
|
|
2077
2071
|
*
|
|
2078
|
-
* <p>To generate a data key, you must specify the symmetric
|
|
2079
|
-
* used to encrypt the data key. You cannot use an asymmetric
|
|
2080
|
-
* the type of your
|
|
2072
|
+
* <p>To generate a data key, you must specify the symmetric KMS key that is
|
|
2073
|
+
* used to encrypt the data key. You cannot use an asymmetric KMS key to generate a data key. To get
|
|
2074
|
+
* the type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
2081
2075
|
*
|
|
2082
2076
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
2083
2077
|
* <code>CiphertextBlob</code> field.</p>
|
|
@@ -2086,11 +2080,11 @@ export class KMS extends KMSClient {
|
|
|
2086
2080
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
2087
2081
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
2088
2082
|
* 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
|
|
2089
|
-
* <i>
|
|
2090
|
-
* <p>The
|
|
2091
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2083
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2084
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2085
|
+
* 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>
|
|
2092
2086
|
* <p>
|
|
2093
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
2087
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2094
2088
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2095
2089
|
*
|
|
2096
2090
|
* <p>
|
|
@@ -2157,10 +2151,11 @@ export class KMS extends KMSClient {
|
|
|
2157
2151
|
|
|
2158
2152
|
/**
|
|
2159
2153
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
2160
|
-
* <p>By default, the random byte string is generated in
|
|
2161
|
-
* the
|
|
2154
|
+
* <p>By default, the random byte string is generated in KMS. To generate the byte string in
|
|
2155
|
+
* 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
|
|
2162
2156
|
* ID.</p>
|
|
2163
|
-
* <p>For
|
|
2157
|
+
* <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>
|
|
2158
|
+
* <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>
|
|
2164
2159
|
*
|
|
2165
2160
|
* <p>
|
|
2166
2161
|
* <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>
|
|
@@ -2195,9 +2190,9 @@ export class KMS extends KMSClient {
|
|
|
2195
2190
|
}
|
|
2196
2191
|
|
|
2197
2192
|
/**
|
|
2198
|
-
* <p>Gets a key policy attached to the specified
|
|
2193
|
+
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
2199
2194
|
* <p>
|
|
2200
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2195
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2201
2196
|
*
|
|
2202
2197
|
* <p>
|
|
2203
2198
|
* <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>
|
|
@@ -2233,23 +2228,23 @@ export class KMS extends KMSClient {
|
|
|
2233
2228
|
|
|
2234
2229
|
/**
|
|
2235
2230
|
* <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
|
|
2236
|
-
* enabled for the specified
|
|
2237
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
2238
|
-
* <p>The
|
|
2239
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2231
|
+
* enabled for the specified KMS key.</p>
|
|
2232
|
+
* <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>
|
|
2233
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2234
|
+
* 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>
|
|
2240
2235
|
* <ul>
|
|
2241
2236
|
* <li>
|
|
2242
|
-
* <p>Disabled: The key rotation status does not change when you disable a
|
|
2243
|
-
* while the
|
|
2237
|
+
* <p>Disabled: The key rotation status does not change when you disable a KMS key. However,
|
|
2238
|
+
* while the KMS key is disabled, KMS does not rotate the key material.</p>
|
|
2244
2239
|
* </li>
|
|
2245
2240
|
* <li>
|
|
2246
|
-
* <p>Pending deletion: While a
|
|
2247
|
-
* <code>false</code> and
|
|
2241
|
+
* <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is
|
|
2242
|
+
* <code>false</code> and KMS does not rotate the key material. If you cancel the
|
|
2248
2243
|
* deletion, the original key rotation status is restored.</p>
|
|
2249
2244
|
* </li>
|
|
2250
2245
|
* </ul>
|
|
2251
2246
|
* <p>
|
|
2252
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
2247
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
2253
2248
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2254
2249
|
*
|
|
2255
2250
|
* <p>
|
|
@@ -2301,23 +2296,23 @@ export class KMS extends KMSClient {
|
|
|
2301
2296
|
|
|
2302
2297
|
/**
|
|
2303
2298
|
* <p>Returns the items you need to import key material into a symmetric, customer managed
|
|
2304
|
-
*
|
|
2299
|
+
* KMS key. For more information about importing key material into KMS, see
|
|
2305
2300
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
2306
|
-
* Material</a> in the <i>
|
|
2301
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2307
2302
|
* <p>This operation returns a public key and an import token. Use the public key to encrypt the
|
|
2308
2303
|
* symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
|
|
2309
|
-
* <p>You must specify the key ID of the symmetric
|
|
2310
|
-
* This
|
|
2304
|
+
* <p>You must specify the key ID of the symmetric KMS key into which you will import key material.
|
|
2305
|
+
* This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the
|
|
2311
2306
|
* wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key
|
|
2312
|
-
* material. You cannot perform this operation on an asymmetric
|
|
2307
|
+
* material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
2313
2308
|
* <p>To import key material, you must use the public key and import token from the same
|
|
2314
2309
|
* response. These items are valid for 24 hours. The expiration date and time appear in the
|
|
2315
2310
|
* <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
|
|
2316
2311
|
* <code>GetParametersForImport</code> request.</p>
|
|
2317
|
-
* <p>The
|
|
2318
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2312
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2313
|
+
* 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>
|
|
2319
2314
|
* <p>
|
|
2320
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2315
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2321
2316
|
*
|
|
2322
2317
|
* <p>
|
|
2323
2318
|
* <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>
|
|
@@ -2367,22 +2362,22 @@ export class KMS extends KMSClient {
|
|
|
2367
2362
|
}
|
|
2368
2363
|
|
|
2369
2364
|
/**
|
|
2370
|
-
* <p>Returns the public key of an asymmetric
|
|
2371
|
-
* which never leaves
|
|
2372
|
-
* can download the public key of an asymmetric
|
|
2373
|
-
* to encrypt messages and verify signatures outside of
|
|
2365
|
+
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key,
|
|
2366
|
+
* which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission
|
|
2367
|
+
* can download the public key of an asymmetric KMS key. You can share the public key to allow others
|
|
2368
|
+
* 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>
|
|
2374
2369
|
* <p>You do not need to download the public key. Instead, you can use the public key within
|
|
2375
|
-
*
|
|
2376
|
-
* public key within
|
|
2377
|
-
* are part of every
|
|
2378
|
-
* decrypted. These features are not effective outside of
|
|
2370
|
+
* 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
|
|
2371
|
+
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
2372
|
+
* are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
|
|
2373
|
+
* 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
|
|
2379
2374
|
* Considerations for Downloading Public Keys</a>.</p>
|
|
2380
|
-
* <p>To help you use the public key safely outside of
|
|
2375
|
+
* <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
|
|
2381
2376
|
* important information about the public key in the response, including:</p>
|
|
2382
2377
|
* <ul>
|
|
2383
2378
|
* <li>
|
|
2384
2379
|
* <p>
|
|
2385
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-
|
|
2380
|
+
* <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
|
|
2386
2381
|
* <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p>
|
|
2387
2382
|
* </li>
|
|
2388
2383
|
* <li>
|
|
@@ -2395,16 +2390,16 @@ export class KMS extends KMSClient {
|
|
|
2395
2390
|
* algorithms for the key.</p>
|
|
2396
2391
|
* </li>
|
|
2397
2392
|
* </ul>
|
|
2398
|
-
* <p>Although
|
|
2393
|
+
* <p>Although KMS cannot enforce these restrictions on external operations, it is crucial
|
|
2399
2394
|
* that you use this information to prevent the public key from being used improperly. For
|
|
2400
2395
|
* example, you can prevent a public signing key from being used encrypt data, or prevent a
|
|
2401
|
-
* public key from being used with an encryption algorithm that is not supported by
|
|
2396
|
+
* public key from being used with an encryption algorithm that is not supported by KMS. You
|
|
2402
2397
|
* can also avoid errors, such as using the wrong signing algorithm in a verification
|
|
2403
2398
|
* operation.</p>
|
|
2404
|
-
* <p>The
|
|
2405
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2399
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2400
|
+
* 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>
|
|
2406
2401
|
* <p>
|
|
2407
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
2402
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2408
2403
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2409
2404
|
*
|
|
2410
2405
|
* <p>
|
|
@@ -2440,13 +2435,13 @@ export class KMS extends KMSClient {
|
|
|
2440
2435
|
}
|
|
2441
2436
|
|
|
2442
2437
|
/**
|
|
2443
|
-
* <p>Imports key material into an existing symmetric
|
|
2444
|
-
* created without key material. After you successfully import key material into a
|
|
2445
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that
|
|
2438
|
+
* <p>Imports key material into an existing symmetric KMS KMS key that was
|
|
2439
|
+
* created without key material. After you successfully import key material into a KMS key, you can
|
|
2440
|
+
* <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
|
|
2446
2441
|
* material. </p>
|
|
2447
|
-
* <p>You cannot perform this operation on an asymmetric
|
|
2442
|
+
* <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
|
|
2448
2443
|
* then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
|
|
2449
|
-
* <i>
|
|
2444
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2450
2445
|
* <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
|
|
2451
2446
|
* includes a public key and an import token. Use the public key to encrypt the key material.
|
|
2452
2447
|
* Then, submit the import token from the same <code>GetParametersForImport</code>
|
|
@@ -2454,11 +2449,11 @@ export class KMS extends KMSClient {
|
|
|
2454
2449
|
* <p>When calling this operation, you must specify the following values:</p>
|
|
2455
2450
|
* <ul>
|
|
2456
2451
|
* <li>
|
|
2457
|
-
* <p>The key ID or key ARN of a
|
|
2452
|
+
* <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must be
|
|
2458
2453
|
* <code>EXTERNAL</code>.</p>
|
|
2459
|
-
* <p>To create a
|
|
2454
|
+
* <p>To create a KMS key with no key material, call <a>CreateKey</a> and set the
|
|
2460
2455
|
* value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the
|
|
2461
|
-
* <code>Origin</code> of a
|
|
2456
|
+
* <code>Origin</code> of a KMS key, call <a>DescribeKey</a>.)</p>
|
|
2462
2457
|
* </li>
|
|
2463
2458
|
* <li>
|
|
2464
2459
|
* <p>The encrypted key material. To get the public key to encrypt the key material, call
|
|
@@ -2469,23 +2464,23 @@ export class KMS extends KMSClient {
|
|
|
2469
2464
|
* a public key and token from the same <code>GetParametersForImport</code> response.</p>
|
|
2470
2465
|
* </li>
|
|
2471
2466
|
* <li>
|
|
2472
|
-
* <p>Whether the key material expires and if so, when. If you set an expiration date,
|
|
2473
|
-
* deletes the key material from the
|
|
2474
|
-
* To use the
|
|
2467
|
+
* <p>Whether the key material expires and if so, when. If you set an expiration date, KMS
|
|
2468
|
+
* deletes the key material from the KMS key on the specified date, and the KMS key becomes unusable.
|
|
2469
|
+
* To use the KMS key again, you must reimport the same key material. The only way to change an
|
|
2475
2470
|
* expiration date is by reimporting the same key material and specifying a new expiration
|
|
2476
2471
|
* date. </p>
|
|
2477
2472
|
* </li>
|
|
2478
2473
|
* </ul>
|
|
2479
|
-
* <p>When this operation is successful, the key state of the
|
|
2480
|
-
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the
|
|
2474
|
+
* <p>When this operation is successful, the key state of the KMS key changes from
|
|
2475
|
+
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key.</p>
|
|
2481
2476
|
* <p>If this operation fails, use the exception to help determine the problem. If the error is
|
|
2482
|
-
* 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
|
|
2477
|
+
* 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
|
|
2483
2478
|
* 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
|
|
2484
|
-
* Material</a> in the <i>
|
|
2485
|
-
* <p>The
|
|
2486
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
2479
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2480
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2481
|
+
* 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>
|
|
2487
2482
|
* <p>
|
|
2488
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2483
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2489
2484
|
*
|
|
2490
2485
|
* <p>
|
|
2491
2486
|
* <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>
|
|
@@ -2535,28 +2530,26 @@ export class KMS extends KMSClient {
|
|
|
2535
2530
|
}
|
|
2536
2531
|
|
|
2537
2532
|
/**
|
|
2538
|
-
* <p>Gets a list of aliases in the caller's
|
|
2533
|
+
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about
|
|
2539
2534
|
* aliases, see <a>CreateAlias</a>.</p>
|
|
2540
2535
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
2541
|
-
* region. To get only the aliases associated with a particular
|
|
2536
|
+
* region. To get only the aliases associated with a particular KMS key, use
|
|
2542
2537
|
* the <code>KeyId</code> parameter.</p>
|
|
2543
2538
|
* <p>The <code>ListAliases</code> response can include aliases that you created and associated
|
|
2544
|
-
* with your customer managed
|
|
2545
|
-
* CMKs in your account. You can recognize AWS aliases because their names have the format
|
|
2539
|
+
* 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
|
|
2546
2540
|
* <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p>
|
|
2547
2541
|
* <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
|
|
2548
|
-
* are predefined aliases that
|
|
2549
|
-
* that
|
|
2550
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">
|
|
2542
|
+
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases
|
|
2543
|
+
* that Amazon Web Services creates in your account, including predefined aliases, do not count against your
|
|
2544
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">KMS aliases
|
|
2551
2545
|
* quota</a>.</p>
|
|
2552
2546
|
* <p>
|
|
2553
2547
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
2554
|
-
* return aliases in other
|
|
2555
|
-
*
|
|
2548
|
+
* return aliases in other Amazon Web Services accounts.</p>
|
|
2556
2549
|
*
|
|
2557
2550
|
* <p>
|
|
2558
2551
|
* <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>
|
|
2559
|
-
* <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>
|
|
2552
|
+
* <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>
|
|
2560
2553
|
* <p>
|
|
2561
2554
|
* <b>Related operations:</b>
|
|
2562
2555
|
* </p>
|
|
@@ -2602,18 +2595,23 @@ export class KMS extends KMSClient {
|
|
|
2602
2595
|
}
|
|
2603
2596
|
|
|
2604
2597
|
/**
|
|
2605
|
-
* <p>Gets a list of all grants for the specified
|
|
2606
|
-
* <p>You must specify the
|
|
2598
|
+
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
2599
|
+
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID
|
|
2607
2600
|
* or grantee principal.</p>
|
|
2601
|
+
* <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
|
|
2602
|
+
* <i>
|
|
2603
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2604
|
+
* </i>. For examples of working with grants in several
|
|
2605
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
2608
2606
|
* <note>
|
|
2609
2607
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
2610
2608
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
2611
|
-
* principal in the grant is an
|
|
2609
|
+
* principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
|
|
2612
2610
|
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
|
|
2613
2611
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
2614
2612
|
* </note>
|
|
2615
2613
|
* <p>
|
|
2616
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
2614
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
2617
2615
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2618
2616
|
*
|
|
2619
2617
|
* <p>
|
|
@@ -2668,11 +2666,11 @@ export class KMS extends KMSClient {
|
|
|
2668
2666
|
}
|
|
2669
2667
|
|
|
2670
2668
|
/**
|
|
2671
|
-
* <p>Gets the names of the key policies that are attached to a
|
|
2669
|
+
* <p>Gets the names of the key policies that are attached to a KMS key. This
|
|
2672
2670
|
* operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a>
|
|
2673
2671
|
* operation. However, the only valid policy name is <code>default</code>. </p>
|
|
2674
2672
|
* <p>
|
|
2675
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2673
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2676
2674
|
*
|
|
2677
2675
|
* <p>
|
|
2678
2676
|
* <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>
|
|
@@ -2722,10 +2720,10 @@ export class KMS extends KMSClient {
|
|
|
2722
2720
|
}
|
|
2723
2721
|
|
|
2724
2722
|
/**
|
|
2725
|
-
* <p>Gets a list of all
|
|
2723
|
+
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and
|
|
2726
2724
|
* Region.</p>
|
|
2727
2725
|
* <p>
|
|
2728
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2726
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2729
2727
|
*
|
|
2730
2728
|
* <p>
|
|
2731
2729
|
* <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>
|
|
@@ -2779,13 +2777,13 @@ export class KMS extends KMSClient {
|
|
|
2779
2777
|
}
|
|
2780
2778
|
|
|
2781
2779
|
/**
|
|
2782
|
-
* <p>Returns all tags on the specified
|
|
2783
|
-
* <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
|
|
2780
|
+
* <p>Returns all tags on the specified KMS key.</p>
|
|
2781
|
+
* <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
|
|
2784
2782
|
* the <i>Amazon Web Services General Reference</i>. For information about using
|
|
2785
|
-
* tags in
|
|
2783
|
+
* tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging
|
|
2786
2784
|
* keys</a>.</p>
|
|
2787
2785
|
* <p>
|
|
2788
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2786
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2789
2787
|
*
|
|
2790
2788
|
* <p>
|
|
2791
2789
|
* <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>
|
|
@@ -2845,24 +2843,24 @@ export class KMS extends KMSClient {
|
|
|
2845
2843
|
}
|
|
2846
2844
|
|
|
2847
2845
|
/**
|
|
2848
|
-
* <p>Returns information about all grants in the
|
|
2849
|
-
* retiring principal.
|
|
2850
|
-
*
|
|
2851
|
-
*
|
|
2852
|
-
*
|
|
2853
|
-
* <p>
|
|
2854
|
-
*
|
|
2855
|
-
*
|
|
2856
|
-
*
|
|
2846
|
+
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the specified
|
|
2847
|
+
* retiring principal. </p>
|
|
2848
|
+
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
2849
|
+
* grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to
|
|
2850
|
+
* determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
|
|
2851
|
+
* <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
|
|
2852
|
+
* <i>
|
|
2853
|
+
* <i>Key Management Service Developer Guide</i>
|
|
2854
|
+
* </i>. For examples of working with grants in several
|
|
2855
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
2857
2856
|
* <p>
|
|
2858
2857
|
* <b>Cross-account use</b>: You must specify a principal in your
|
|
2859
|
-
*
|
|
2860
|
-
*
|
|
2861
|
-
*
|
|
2858
|
+
* Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
|
|
2859
|
+
* <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
|
|
2860
|
+
* Amazon Web Services account other than your own.</p>
|
|
2862
2861
|
*
|
|
2863
2862
|
* <p>
|
|
2864
|
-
* <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
|
|
2865
|
-
* account.</p>
|
|
2863
|
+
* <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>
|
|
2866
2864
|
* <p>
|
|
2867
2865
|
* <b>Related operations:</b>
|
|
2868
2866
|
* </p>
|
|
@@ -2919,14 +2917,14 @@ export class KMS extends KMSClient {
|
|
|
2919
2917
|
}
|
|
2920
2918
|
|
|
2921
2919
|
/**
|
|
2922
|
-
* <p>Attaches a key policy to the specified
|
|
2923
|
-
* <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>
|
|
2920
|
+
* <p>Attaches a key policy to the specified KMS key. </p>
|
|
2921
|
+
* <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>.
|
|
2924
2922
|
* 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>
|
|
2925
|
-
* <i>
|
|
2923
|
+
* <i>Identity and Access Management User Guide</i>
|
|
2926
2924
|
* </i>. For examples of adding a key policy in multiple programming languages,
|
|
2927
|
-
* 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>
|
|
2925
|
+
* 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>
|
|
2928
2926
|
* <p>
|
|
2929
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
2927
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2930
2928
|
*
|
|
2931
2929
|
* <p>
|
|
2932
2930
|
* <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>
|
|
@@ -2961,77 +2959,73 @@ export class KMS extends KMSClient {
|
|
|
2961
2959
|
}
|
|
2962
2960
|
|
|
2963
2961
|
/**
|
|
2964
|
-
* <p>Decrypts ciphertext and then reencrypts it entirely within
|
|
2965
|
-
* operation to change the
|
|
2966
|
-
* you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually rotate</a> a
|
|
2967
|
-
* use it to reencrypt ciphertext under the same
|
|
2962
|
+
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
2963
|
+
* operation to change the KMS key under which data is encrypted, such as when
|
|
2964
|
+
* 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
|
|
2965
|
+
* 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
|
|
2968
2966
|
* context</a> of a ciphertext.</p>
|
|
2969
2967
|
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an
|
|
2970
|
-
*
|
|
2971
|
-
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
2972
|
-
*
|
|
2973
|
-
*
|
|
2974
|
-
* encryption</a>. These libraries return a ciphertext format that is incompatible with
|
|
2975
|
-
* AWS KMS.</p>
|
|
2968
|
+
* 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
|
|
2969
|
+
* 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
|
|
2970
|
+
* 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>.
|
|
2971
|
+
* These libraries return a ciphertext format that is incompatible with KMS.</p>
|
|
2976
2972
|
* <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the
|
|
2977
2973
|
* decrypt operation and the subsequent encrypt operation.</p>
|
|
2978
2974
|
* <ul>
|
|
2979
2975
|
* <li>
|
|
2980
|
-
* <p>If your ciphertext was encrypted under an asymmetric
|
|
2981
|
-
* <code>SourceKeyId</code> parameter to identify the
|
|
2976
|
+
* <p>If your ciphertext was encrypted under an asymmetric KMS key, you must use the
|
|
2977
|
+
* <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the ciphertext.
|
|
2982
2978
|
* You must also supply the encryption algorithm that was used. This information is required
|
|
2983
2979
|
* to decrypt the data.</p>
|
|
2984
2980
|
* </li>
|
|
2985
2981
|
* <li>
|
|
2986
|
-
* <p>If your ciphertext was encrypted under a symmetric
|
|
2987
|
-
* parameter is optional.
|
|
2982
|
+
* <p>If your ciphertext was encrypted under a symmetric KMS key, the <code>SourceKeyId</code>
|
|
2983
|
+
* parameter is optional. KMS can get this information from metadata that it adds to the
|
|
2988
2984
|
* symmetric ciphertext blob. This feature adds durability to your implementation by ensuring
|
|
2989
2985
|
* that authorized users can decrypt ciphertext decades after it was encrypted, even if
|
|
2990
|
-
* they've lost track of the
|
|
2991
|
-
* as a best practice. When you use the <code>SourceKeyId</code> parameter to specify a
|
|
2992
|
-
*
|
|
2993
|
-
* CMK, the <code>ReEncrypt</code> operation fails. This practice ensures that you use the
|
|
2994
|
-
* CMK that you intend.</p>
|
|
2986
|
+
* they've lost track of the key ID. However, specifying the source KMS key is always recommended
|
|
2987
|
+
* as a best practice. When you use the <code>SourceKeyId</code> parameter to specify a KMS key,
|
|
2988
|
+
* 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>
|
|
2995
2989
|
* </li>
|
|
2996
2990
|
* <li>
|
|
2997
2991
|
* <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter
|
|
2998
|
-
* specify the
|
|
2999
|
-
* symmetric or asymmetric
|
|
2992
|
+
* specify the KMS key that re-encrypts the data after it is decrypted. You can select a
|
|
2993
|
+
* symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you must also
|
|
3000
2994
|
* provide the encryption algorithm. The algorithm that you choose must be compatible with
|
|
3001
|
-
* the
|
|
2995
|
+
* the KMS key.</p>
|
|
3002
2996
|
*
|
|
3003
2997
|
* <important>
|
|
3004
|
-
* <p>When you use an asymmetric
|
|
3005
|
-
* <p>You are not required to supply the
|
|
2998
|
+
* <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>
|
|
2999
|
+
* <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>
|
|
3006
3000
|
* </important>
|
|
3007
3001
|
* </li>
|
|
3008
3002
|
* </ul>
|
|
3009
3003
|
*
|
|
3010
3004
|
*
|
|
3011
3005
|
*
|
|
3012
|
-
* <p>The
|
|
3013
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3006
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3007
|
+
* 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>
|
|
3014
3008
|
* <p>
|
|
3015
|
-
* <b>Cross-account use</b>: Yes. The source
|
|
3016
|
-
*
|
|
3017
|
-
*
|
|
3009
|
+
* <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
|
|
3010
|
+
* the caller. To specify a KMS key in a different account, you must use its key ARN or alias
|
|
3011
|
+
* ARN.</p>
|
|
3018
3012
|
*
|
|
3019
3013
|
* <p>
|
|
3020
3014
|
* <b>Required permissions</b>:</p>
|
|
3021
3015
|
* <ul>
|
|
3022
3016
|
* <li>
|
|
3023
3017
|
* <p>
|
|
3024
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a> permission on the source
|
|
3018
|
+
* <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>
|
|
3025
3019
|
* </li>
|
|
3026
3020
|
* <li>
|
|
3027
3021
|
* <p>
|
|
3028
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a> permission on the destination
|
|
3022
|
+
* <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>
|
|
3029
3023
|
* </li>
|
|
3030
3024
|
* </ul>
|
|
3031
|
-
* <p>To permit reencryption from or to a
|
|
3025
|
+
* <p>To permit reencryption from or to a KMS key, include the <code>"kms:ReEncrypt*"</code>
|
|
3032
3026
|
* permission in your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key policy</a>. This permission is
|
|
3033
|
-
* automatically included in the key policy when you use the console to create a
|
|
3034
|
-
* must include it manually when you create a
|
|
3027
|
+
* automatically included in the key policy when you use the console to create a KMS key. But you
|
|
3028
|
+
* 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>
|
|
3035
3029
|
*
|
|
3036
3030
|
* <p>
|
|
3037
3031
|
* <b>Related operations:</b>
|
|
@@ -3085,24 +3079,24 @@ export class KMS extends KMSClient {
|
|
|
3085
3079
|
/**
|
|
3086
3080
|
* <p>Replicates a multi-Region key into the specified Region. This operation creates a
|
|
3087
3081
|
* multi-Region replica key based on a multi-Region primary key in a different Region of the same
|
|
3088
|
-
*
|
|
3082
|
+
* Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a
|
|
3089
3083
|
* different Region. To create a multi-Region primary key, use the <a>CreateKey</a>
|
|
3090
3084
|
* operation.</p>
|
|
3091
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
3092
|
-
* interoperable
|
|
3093
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
3094
|
-
* it in a different
|
|
3095
|
-
* <p>A <i>replica key</i> is a fully-functional
|
|
3085
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
3086
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
3087
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
3088
|
+
* 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>
|
|
3089
|
+
* <p>A <i>replica key</i> is a fully-functional KMS key that can be used
|
|
3096
3090
|
* independently of its primary and peer replica keys. A primary key and its replica keys share
|
|
3097
3091
|
* 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
|
|
3098
3092
|
* have the same <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key
|
|
3099
3093
|
* spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key
|
|
3100
3094
|
* usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key
|
|
3101
|
-
* material origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic key rotation status</a>.
|
|
3095
|
+
* 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
|
|
3102
3096
|
* properties among related multi-Region keys. All other properties of a replica key can differ,
|
|
3103
3097
|
* including its <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html">key
|
|
3104
3098
|
* 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
|
|
3105
|
-
* state</a>.
|
|
3099
|
+
* state</a>. KMS pricing and quotas for KMS keys apply to each primary key and replica
|
|
3106
3100
|
* key.</p>
|
|
3107
3101
|
* <p>When this operation completes, the new replica key has a transient key state of
|
|
3108
3102
|
* <code>Creating</code>. This key state changes to <code>Enabled</code> (or
|
|
@@ -3111,31 +3105,31 @@ export class KMS extends KMSClient {
|
|
|
3111
3105
|
* cannot yet use it in cryptographic operations. If you are creating and using the replica key
|
|
3112
3106
|
* programmatically, retry on <code>KMSInvalidStateException</code> or call
|
|
3113
3107
|
* <code>DescribeKey</code> to check its <code>KeyState</code> value before using it. For
|
|
3114
|
-
* details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3115
|
-
* <i>
|
|
3116
|
-
* <p>The
|
|
3108
|
+
* 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
|
|
3109
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3110
|
+
* <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a
|
|
3117
3111
|
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
|
|
3118
3112
|
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
|
|
3119
3113
|
* created with no key material. You must import the same key material that you imported into the
|
|
3120
|
-
* 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>
|
|
3114
|
+
* 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>
|
|
3121
3115
|
* <p>To convert a replica key to a primary key, use the <a>UpdatePrimaryRegion</a>
|
|
3122
3116
|
* operation.</p>
|
|
3123
3117
|
* <note>
|
|
3124
3118
|
* <p>
|
|
3125
3119
|
* <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code> and
|
|
3126
|
-
* <code>Tags</code> parameters than those used in the
|
|
3120
|
+
* <code>Tags</code> parameters than those used in the KMS console. For details, see the
|
|
3127
3121
|
* parameter descriptions.</p>
|
|
3128
3122
|
* </note>
|
|
3129
3123
|
* <p>
|
|
3130
3124
|
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
3131
|
-
* create a
|
|
3125
|
+
* create a replica key in a different Amazon Web Services account. </p>
|
|
3132
3126
|
* <p>
|
|
3133
3127
|
* <b>Required permissions</b>: </p>
|
|
3134
3128
|
* <ul>
|
|
3135
3129
|
* <li>
|
|
3136
3130
|
* <p>
|
|
3137
|
-
* <code>kms:ReplicateKey</code> on the primary
|
|
3138
|
-
* permission in the primary
|
|
3131
|
+
* <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region). Include this
|
|
3132
|
+
* permission in the primary key's key policy.</p>
|
|
3139
3133
|
* </li>
|
|
3140
3134
|
* <li>
|
|
3141
3135
|
* <p>
|
|
@@ -3191,24 +3185,24 @@ export class KMS extends KMSClient {
|
|
|
3191
3185
|
/**
|
|
3192
3186
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
3193
3187
|
* 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
|
|
3194
|
-
* key identifier (key ID or key ARN) of the
|
|
3188
|
+
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation returns both values.</p>
|
|
3195
3189
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
3196
3190
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
3197
|
-
* operation, and by the
|
|
3191
|
+
* operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be
|
|
3198
3192
|
* called by principals to whom permission for retiring a grant is delegated. For details, see
|
|
3199
|
-
*
|
|
3200
|
-
* revoking grants</a> in the <i>
|
|
3193
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
|
|
3194
|
+
* revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3201
3195
|
* <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
|
|
3202
3196
|
* <i>
|
|
3203
|
-
* <i>
|
|
3197
|
+
* <i>Key Management Service Developer Guide</i>
|
|
3204
3198
|
* </i>. For examples of working with grants in several
|
|
3205
|
-
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a
|
|
3199
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
3206
3200
|
* <p>
|
|
3207
|
-
* <b>Cross-account use</b>: Yes. You can retire a grant on a
|
|
3208
|
-
* in a different
|
|
3201
|
+
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS key
|
|
3202
|
+
* in a different Amazon Web Services account.</p>
|
|
3209
3203
|
* <p>
|
|
3210
3204
|
* <b>Required permissions:</b>:Permission to retire a grant is
|
|
3211
|
-
* 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>
|
|
3205
|
+
* 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>
|
|
3212
3206
|
* <p>
|
|
3213
3207
|
* <b>Related operations:</b>
|
|
3214
3208
|
* </p>
|
|
@@ -3263,14 +3257,19 @@ export class KMS extends KMSClient {
|
|
|
3263
3257
|
* grant allows. For more
|
|
3264
3258
|
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
3265
3259
|
* the <i>
|
|
3266
|
-
* <i>
|
|
3260
|
+
* <i>Key Management Service Developer Guide</i>
|
|
3267
3261
|
* </i>.</p>
|
|
3268
|
-
* <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
|
|
3262
|
+
* <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
|
|
3269
3263
|
* the <i>
|
|
3270
|
-
* <i>
|
|
3264
|
+
* <i>Key Management Service Developer Guide</i>
|
|
3271
3265
|
* </i>. </p>
|
|
3266
|
+
* <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
|
|
3267
|
+
* <i>
|
|
3268
|
+
* <i>Key Management Service Developer Guide</i>
|
|
3269
|
+
* </i>. For examples of working with grants in several
|
|
3270
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
3272
3271
|
* <p>
|
|
3273
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
3272
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
3274
3273
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
3275
3274
|
* <p>
|
|
3276
3275
|
* <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>
|
|
@@ -3324,38 +3323,38 @@ export class KMS extends KMSClient {
|
|
|
3324
3323
|
}
|
|
3325
3324
|
|
|
3326
3325
|
/**
|
|
3327
|
-
* <p>Schedules the deletion of a
|
|
3326
|
+
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting
|
|
3328
3327
|
* period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is
|
|
3329
|
-
* successful, the key state of the
|
|
3328
|
+
* successful, the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't
|
|
3330
3329
|
* be used in any cryptographic operations. It remains in this state for the duration of the
|
|
3331
|
-
* waiting period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to cancel the deletion of the
|
|
3332
|
-
* its key material, and all
|
|
3330
|
+
* 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,
|
|
3331
|
+
* its key material, and all KMS data associated with it, including all aliases that refer to
|
|
3333
3332
|
* it.</p>
|
|
3334
3333
|
* <important>
|
|
3335
|
-
* <p>Deleting a
|
|
3336
|
-
* deleted, all data that was encrypted under the
|
|
3337
|
-
* a multi-Region replica key.) To prevent the use of a
|
|
3334
|
+
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is
|
|
3335
|
+
* deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is
|
|
3336
|
+
* a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use <a>DisableKey</a>. </p>
|
|
3338
3337
|
* </important>
|
|
3339
|
-
* <p>If you schedule deletion of a
|
|
3340
|
-
* expires, <code>ScheduleKeyDeletion</code> deletes the
|
|
3341
|
-
* effort to delete the key material from the associated
|
|
3338
|
+
* <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
|
|
3339
|
+
* expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a best
|
|
3340
|
+
* effort to delete the key material from the associated CloudHSM cluster. However, you might need
|
|
3342
3341
|
* to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
3343
3342
|
* material</a> from the cluster and its backups.</p>
|
|
3344
3343
|
* <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
|
|
3345
|
-
* time. However,
|
|
3344
|
+
* time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
|
|
3346
3345
|
* you schedule the deletion of a primary key with replicas, its key state changes to
|
|
3347
3346
|
* <code>PendingReplicaDeletion</code> and it cannot be replicated or used in cryptographic
|
|
3348
3347
|
* operations. This status can continue indefinitely. When the last of its replicas keys is
|
|
3349
3348
|
* deleted (not just scheduled), the key state of the primary key changes to
|
|
3350
3349
|
* <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
|
|
3351
|
-
* 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>
|
|
3352
|
-
* <p>For more information about scheduling a
|
|
3353
|
-
* <i>
|
|
3354
|
-
* <p>The
|
|
3355
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3350
|
+
* 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>
|
|
3351
|
+
* <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
|
|
3352
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
3353
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3354
|
+
* 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>
|
|
3356
3355
|
*
|
|
3357
3356
|
* <p>
|
|
3358
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
3357
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
3359
3358
|
*
|
|
3360
3359
|
*
|
|
3361
3360
|
* <p>
|
|
@@ -3407,21 +3406,20 @@ export class KMS extends KMSClient {
|
|
|
3407
3406
|
|
|
3408
3407
|
/**
|
|
3409
3408
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
3410
|
-
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
3411
|
-
*
|
|
3412
|
-
* 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>
|
|
3409
|
+
* 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
|
|
3410
|
+
* 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>
|
|
3413
3411
|
* <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
|
|
3414
|
-
* or ECC pair that is represented by an asymmetric
|
|
3412
|
+
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or
|
|
3415
3413
|
* an authorized user) uses their private key to sign a message. Anyone with the public key can
|
|
3416
3414
|
* verify that the message was signed with that particular private key and that the message
|
|
3417
3415
|
* hasn't changed since it was signed. </p>
|
|
3418
3416
|
* <p>To use the <code>Sign</code> operation, provide the following information:</p>
|
|
3419
3417
|
* <ul>
|
|
3420
3418
|
* <li>
|
|
3421
|
-
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric
|
|
3419
|
+
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a
|
|
3422
3420
|
* <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the
|
|
3423
|
-
* <code>KeyUsage</code> value of a
|
|
3424
|
-
* The caller must have <code>kms:Sign</code> permission on the
|
|
3421
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a> operation.
|
|
3422
|
+
* The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
|
|
3425
3423
|
* </li>
|
|
3426
3424
|
* <li>
|
|
3427
3425
|
* <p>Use the <code>Message</code> parameter to specify the message or message digest to
|
|
@@ -3431,20 +3429,20 @@ export class KMS extends KMSClient {
|
|
|
3431
3429
|
* <code>MessageType</code> parameter.</p>
|
|
3432
3430
|
* </li>
|
|
3433
3431
|
* <li>
|
|
3434
|
-
* <p>Choose a signing algorithm that is compatible with the
|
|
3432
|
+
* <p>Choose a signing algorithm that is compatible with the KMS key. </p>
|
|
3435
3433
|
* </li>
|
|
3436
3434
|
* </ul>
|
|
3437
3435
|
* <important>
|
|
3438
|
-
* <p>When signing a message, be sure to record the
|
|
3436
|
+
* <p>When signing a message, be sure to record the KMS key and the signing algorithm. This
|
|
3439
3437
|
* information is required to verify the signature.</p>
|
|
3440
3438
|
* </important>
|
|
3441
3439
|
* <p>To verify the signature that this operation generates, use the <a>Verify</a>
|
|
3442
3440
|
* operation. Or use the <a>GetPublicKey</a> operation to download the public key and
|
|
3443
|
-
* then use the public key to verify the signature outside of
|
|
3444
|
-
* <p>The
|
|
3445
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3441
|
+
* then use the public key to verify the signature outside of KMS. </p>
|
|
3442
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3443
|
+
* 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>
|
|
3446
3444
|
* <p>
|
|
3447
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
3445
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
3448
3446
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
3449
3447
|
*
|
|
3450
3448
|
* <p>
|
|
@@ -3477,26 +3475,24 @@ export class KMS extends KMSClient {
|
|
|
3477
3475
|
}
|
|
3478
3476
|
|
|
3479
3477
|
/**
|
|
3480
|
-
* <p>Adds or edits tags on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
3478
|
+
* <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>
|
|
3481
3479
|
* <note>
|
|
3482
|
-
* <p>Tagging or untagging a
|
|
3483
|
-
* 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>
|
|
3480
|
+
* <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>
|
|
3484
3481
|
* </note>
|
|
3485
3482
|
* <p>Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.
|
|
3486
3483
|
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
3487
3484
|
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
3488
|
-
* <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
|
|
3489
|
-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">
|
|
3490
|
-
* 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
|
|
3485
|
+
* <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
|
|
3486
|
+
* 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
|
|
3491
3487
|
* an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
|
|
3492
|
-
* <p>You can also add tags to a
|
|
3493
|
-
* <p>For information about using tags in
|
|
3494
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
3488
|
+
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or replicating it (<a>ReplicateKey</a>).</p>
|
|
3489
|
+
* <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
|
|
3490
|
+
* 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
|
|
3495
3491
|
* Web Services General Reference</i>. </p>
|
|
3496
|
-
* <p>The
|
|
3497
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3492
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3493
|
+
* 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>
|
|
3498
3494
|
* <p>
|
|
3499
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
3495
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
3500
3496
|
*
|
|
3501
3497
|
* <p>
|
|
3502
3498
|
* <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>
|
|
@@ -3550,23 +3546,22 @@ export class KMS extends KMSClient {
|
|
|
3550
3546
|
}
|
|
3551
3547
|
|
|
3552
3548
|
/**
|
|
3553
|
-
* <p>Deletes tags from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
3554
|
-
* specify the tag key and the
|
|
3549
|
+
* <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,
|
|
3550
|
+
* specify the tag key and the KMS key.</p>
|
|
3555
3551
|
* <note>
|
|
3556
|
-
* <p>Tagging or untagging a
|
|
3557
|
-
* 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>
|
|
3552
|
+
* <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>
|
|
3558
3553
|
* </note>
|
|
3559
3554
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
3560
|
-
* Also, if the specified tag key isn't found on the
|
|
3555
|
+
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return
|
|
3561
3556
|
* a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
3562
3557
|
*
|
|
3563
|
-
* <p>For information about using tags in
|
|
3564
|
-
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging
|
|
3558
|
+
* <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
|
|
3559
|
+
* 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
|
|
3565
3560
|
* Web Services General Reference</i>. </p>
|
|
3566
|
-
* <p>The
|
|
3567
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3561
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3562
|
+
* 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>
|
|
3568
3563
|
* <p>
|
|
3569
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
3564
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
3570
3565
|
*
|
|
3571
3566
|
* <p>
|
|
3572
3567
|
* <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>
|
|
@@ -3626,27 +3621,27 @@ export class KMS extends KMSClient {
|
|
|
3626
3621
|
}
|
|
3627
3622
|
|
|
3628
3623
|
/**
|
|
3629
|
-
* <p>Associates an existing
|
|
3630
|
-
* is associated with only one
|
|
3631
|
-
* and the
|
|
3624
|
+
* <p>Associates an existing KMS alias with a different KMS key. Each alias
|
|
3625
|
+
* is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias
|
|
3626
|
+
* and the KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
3632
3627
|
* <note>
|
|
3633
|
-
* <p>Adding, deleting, or updating an alias can allow or deny permission to the
|
|
3628
|
+
* <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>
|
|
3634
3629
|
* </note>
|
|
3635
|
-
* <p>The current and new
|
|
3630
|
+
* <p>The current and new KMS key must be the same type (both symmetric or both asymmetric), and
|
|
3636
3631
|
* they must have the same key usage (<code>ENCRYPT_DECRYPT</code> or <code>SIGN_VERIFY</code>).
|
|
3637
3632
|
* This restriction prevents errors in code that uses aliases. If you must assign an alias to a
|
|
3638
|
-
* different type of
|
|
3633
|
+
* different type of KMS key, use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to create a new alias.</p>
|
|
3639
3634
|
* <p>You cannot use <code>UpdateAlias</code> to change an alias name. To change an alias name,
|
|
3640
3635
|
* use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
|
|
3641
3636
|
* create a new alias.</p>
|
|
3642
|
-
* <p>Because an alias is not a property of a
|
|
3643
|
-
* aliases of a
|
|
3644
|
-
* the <a>DescribeKey</a> operation. To get the aliases of all
|
|
3637
|
+
* <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
|
|
3638
|
+
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from
|
|
3639
|
+
* the <a>DescribeKey</a> operation. To get the aliases of all KMS keys in the account,
|
|
3645
3640
|
* use the <a>ListAliases</a> operation. </p>
|
|
3646
|
-
* <p>The
|
|
3647
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3641
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3642
|
+
* 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>
|
|
3648
3643
|
* <p>
|
|
3649
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
3644
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
3650
3645
|
* <p>
|
|
3651
3646
|
* <b>Required permissions</b>
|
|
3652
3647
|
* </p>
|
|
@@ -3657,14 +3652,14 @@ export class KMS extends KMSClient {
|
|
|
3657
3652
|
* </li>
|
|
3658
3653
|
* <li>
|
|
3659
3654
|
* <p>
|
|
3660
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the current
|
|
3655
|
+
* <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>
|
|
3661
3656
|
* </li>
|
|
3662
3657
|
* <li>
|
|
3663
3658
|
* <p>
|
|
3664
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on the new
|
|
3659
|
+
* <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>
|
|
3665
3660
|
* </li>
|
|
3666
3661
|
* </ul>
|
|
3667
|
-
* <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>
|
|
3662
|
+
* <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>
|
|
3668
3663
|
* <p>
|
|
3669
3664
|
* <b>Related operations:</b>
|
|
3670
3665
|
* </p>
|
|
@@ -3727,30 +3722,30 @@ export class KMS extends KMSClient {
|
|
|
3727
3722
|
* <p> </p>
|
|
3728
3723
|
* </li>
|
|
3729
3724
|
* <li>
|
|
3730
|
-
* <p>Use the <b>KeyStorePassword</b> parameter tell
|
|
3725
|
+
* <p>Use the <b>KeyStorePassword</b> parameter tell KMS the
|
|
3731
3726
|
* current password of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
3732
3727
|
* <code>kmsuser</code> crypto
|
|
3733
|
-
* user (CU)</a> in the associated
|
|
3734
|
-
* connection failures</a> that occur when
|
|
3728
|
+
* 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
|
|
3729
|
+
* connection failures</a> that occur when KMS cannot log into the associated cluster
|
|
3735
3730
|
* because the <code>kmsuser</code> password has changed. This value does not change the
|
|
3736
|
-
* password in the
|
|
3731
|
+
* password in the CloudHSM cluster.</p>
|
|
3737
3732
|
* <p> </p>
|
|
3738
3733
|
* </li>
|
|
3739
3734
|
* <li>
|
|
3740
3735
|
* <p>Use the <b>CloudHsmClusterId</b> parameter to associate the
|
|
3741
|
-
* custom key store with a different, but related,
|
|
3742
|
-
* to repair a custom key store if its
|
|
3736
|
+
* custom key store with a different, but related, CloudHSM cluster. You can use this parameter
|
|
3737
|
+
* to repair a custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when
|
|
3743
3738
|
* you need to create or restore a cluster from a backup. </p>
|
|
3744
3739
|
* </li>
|
|
3745
3740
|
* </ul>
|
|
3746
3741
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
3747
3742
|
* properties.</p>
|
|
3748
|
-
* <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
|
|
3749
|
-
* combines the convenience and extensive integration of
|
|
3743
|
+
* <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
|
|
3744
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
3750
3745
|
* single-tenant key store.</p>
|
|
3751
3746
|
*
|
|
3752
3747
|
* <p>
|
|
3753
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
3748
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
|
|
3754
3749
|
* <p>
|
|
3755
3750
|
* <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>
|
|
3756
3751
|
* <p>
|
|
@@ -3814,12 +3809,12 @@ export class KMS extends KMSClient {
|
|
|
3814
3809
|
}
|
|
3815
3810
|
|
|
3816
3811
|
/**
|
|
3817
|
-
* <p>Updates the description of a
|
|
3812
|
+
* <p>Updates the description of a KMS key. To see the description of a KMS key,
|
|
3818
3813
|
* use <a>DescribeKey</a>. </p>
|
|
3819
|
-
* <p>The
|
|
3820
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3814
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3815
|
+
* 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>
|
|
3821
3816
|
* <p>
|
|
3822
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
3817
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
3823
3818
|
*
|
|
3824
3819
|
* <p>
|
|
3825
3820
|
* <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>
|
|
@@ -3875,19 +3870,19 @@ export class KMS extends KMSClient {
|
|
|
3875
3870
|
* in <code>us-east-1</code> and a replica key in <code>eu-west-2</code>. If you run
|
|
3876
3871
|
* <code>UpdatePrimaryRegion</code> with a <code>PrimaryRegion</code> value of
|
|
3877
3872
|
* <code>eu-west-2</code>, the primary key is now the key in <code>eu-west-2</code>, and the
|
|
3878
|
-
* key in <code>us-east-1</code> becomes a replica key. For details, see </p>
|
|
3879
|
-
* <p>This operation supports <i>multi-Region keys</i>, an
|
|
3880
|
-
* interoperable
|
|
3881
|
-
* material, and other metadata, you can use them to encrypt data in one
|
|
3882
|
-
* it in a different
|
|
3873
|
+
* 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>
|
|
3874
|
+
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
3875
|
+
* interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key
|
|
3876
|
+
* material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt
|
|
3877
|
+
* 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>
|
|
3883
3878
|
* <p>The <i>primary key</i> of a multi-Region key is the source for properties
|
|
3884
3879
|
* 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
|
|
3885
3880
|
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
3886
3881
|
* 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
|
|
3887
|
-
*
|
|
3882
|
+
* key</a> until all replica keys are deleted.</p>
|
|
3888
3883
|
* <p>The key ID and primary Region that you specify uniquely identify the replica key that will
|
|
3889
3884
|
* become the primary key. The primary Region must already have a replica key. This operation
|
|
3890
|
-
* does not create a
|
|
3885
|
+
* 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
|
|
3891
3886
|
* key, use the <a>ReplicateKey</a> operation.</p>
|
|
3892
3887
|
* <p>You can run this operation while using the affected multi-Region keys in cryptographic
|
|
3893
3888
|
* operations. This operation should not delay, interrupt, or cause failures in cryptographic
|
|
@@ -3900,24 +3895,24 @@ export class KMS extends KMSClient {
|
|
|
3900
3895
|
* cryptographic operations, but you cannot replicate the new primary key or perform certain
|
|
3901
3896
|
* management operations, such as enabling or disabling these keys. For details about the
|
|
3902
3897
|
* <code>Updating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state:
|
|
3903
|
-
* Effect on your
|
|
3898
|
+
* Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
3904
3899
|
* <p>This operation does not return any output. To verify that primary key is changed, use the
|
|
3905
3900
|
* <a>DescribeKey</a> operation.</p>
|
|
3906
3901
|
* <p>
|
|
3907
3902
|
* <b>Cross-account use</b>: No. You cannot use this operation in a
|
|
3908
|
-
* different
|
|
3903
|
+
* different Amazon Web Services account. </p>
|
|
3909
3904
|
* <p>
|
|
3910
3905
|
* <b>Required permissions</b>: </p>
|
|
3911
3906
|
* <ul>
|
|
3912
3907
|
* <li>
|
|
3913
3908
|
* <p>
|
|
3914
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current primary
|
|
3915
|
-
* Region). Include this permission primary
|
|
3909
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current primary key (in the primary key's
|
|
3910
|
+
* Region). Include this permission primary key's key policy.</p>
|
|
3916
3911
|
* </li>
|
|
3917
3912
|
* <li>
|
|
3918
3913
|
* <p>
|
|
3919
|
-
* <code>kms:UpdatePrimaryRegion</code> on the current replica
|
|
3920
|
-
* Region). Include this permission in the replica
|
|
3914
|
+
* <code>kms:UpdatePrimaryRegion</code> on the current replica key (in the replica key's
|
|
3915
|
+
* Region). Include this permission in the replica key's key policy.</p>
|
|
3921
3916
|
* </li>
|
|
3922
3917
|
* </ul>
|
|
3923
3918
|
* <p>
|
|
@@ -3968,28 +3963,28 @@ export class KMS extends KMSClient {
|
|
|
3968
3963
|
/**
|
|
3969
3964
|
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
3970
3965
|
* <p></p>
|
|
3971
|
-
* <p>Verification confirms that an authorized user signed the message with the specified
|
|
3966
|
+
* <p>Verification confirms that an authorized user signed the message with the specified KMS key
|
|
3972
3967
|
* and signing algorithm, and the message hasn't changed since it was signed. If the signature is
|
|
3973
3968
|
* verified, the value of the <code>SignatureValid</code> field in the response is
|
|
3974
3969
|
* <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
|
|
3975
3970
|
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
3976
|
-
* <p>A digital signature is generated by using the private key in an asymmetric
|
|
3977
|
-
* signature is verified by using the public key in the same asymmetric
|
|
3978
|
-
* For information about symmetric and asymmetric
|
|
3971
|
+
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
3972
|
+
* signature is verified by using the public key in the same asymmetric KMS key.
|
|
3973
|
+
* 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>
|
|
3979
3974
|
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
3980
|
-
* same asymmetric
|
|
3975
|
+
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
3981
3976
|
* signature.</p>
|
|
3982
|
-
* <p>You can also verify the digital signature by using the public key of the
|
|
3983
|
-
*
|
|
3984
|
-
* asymmetric
|
|
3985
|
-
* advantage of using the <code>Verify</code> operation is that it is performed within
|
|
3977
|
+
* <p>You can also verify the digital signature by using the public key of the KMS key outside of
|
|
3978
|
+
* KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
3979
|
+
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
3980
|
+
* advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
|
|
3986
3981
|
* a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
|
|
3987
|
-
* in
|
|
3988
|
-
* the
|
|
3989
|
-
* <p>The
|
|
3990
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
3982
|
+
* in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use
|
|
3983
|
+
* the KMS key to verify signatures.</p>
|
|
3984
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
3985
|
+
* 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>
|
|
3991
3986
|
* <p>
|
|
3992
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
3987
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
3993
3988
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
3994
3989
|
*
|
|
3995
3990
|
* <p>
|