@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
|
@@ -22,16 +22,16 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
|
|
25
|
-
* plaintext copy of the data key and a copy that is encrypted under a
|
|
26
|
-
* that you specify. You can use the plaintext key to encrypt your data outside of
|
|
25
|
+
* plaintext copy of the data key and a copy that is encrypted under a KMS key
|
|
26
|
+
* that you specify. You can use the plaintext key to encrypt your data outside of KMS and
|
|
27
27
|
* store the encrypted data key with the encrypted data.</p>
|
|
28
28
|
*
|
|
29
29
|
* <p>
|
|
30
30
|
* <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
|
|
31
|
-
* plaintext key are not related to the caller or the
|
|
31
|
+
* plaintext key are not related to the caller or the KMS key.</p>
|
|
32
32
|
*
|
|
33
|
-
* <p>To generate a data key, specify the symmetric
|
|
34
|
-
* key. You cannot use an asymmetric
|
|
33
|
+
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the data
|
|
34
|
+
* key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use
|
|
35
35
|
* the <a>DescribeKey</a> operation. You must also specify the length of the data key.
|
|
36
36
|
* Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both).
|
|
37
37
|
* For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
@@ -44,45 +44,44 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
44
44
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
45
45
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
46
46
|
* 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
|
|
47
|
-
* <i>
|
|
48
|
-
* <p>
|
|
49
|
-
*
|
|
47
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
48
|
+
* <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>
|
|
49
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
50
|
+
* 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>
|
|
50
51
|
* <p>
|
|
51
|
-
* <b>How to use your
|
|
52
|
-
* data key</b>
|
|
52
|
+
* <b>How to use your data key</b>
|
|
53
53
|
* </p>
|
|
54
|
-
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
55
|
-
*
|
|
56
|
-
* <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
|
|
54
|
+
* <p>We recommend that you use the following pattern to encrypt data locally in your application.
|
|
55
|
+
* 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
|
|
57
56
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
58
57
|
* client-side encryption</a> to do these tasks for you.</p>
|
|
59
|
-
* <p>To encrypt data outside of
|
|
58
|
+
* <p>To encrypt data outside of KMS:</p>
|
|
60
59
|
* <ol>
|
|
61
60
|
* <li>
|
|
62
61
|
* <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p>
|
|
63
62
|
* </li>
|
|
64
63
|
* <li>
|
|
65
64
|
* <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to
|
|
66
|
-
* encrypt your data outside of
|
|
65
|
+
* encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p>
|
|
67
66
|
* </li>
|
|
68
67
|
* <li>
|
|
69
68
|
* <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the
|
|
70
69
|
* response) with the encrypted data.</p>
|
|
71
70
|
* </li>
|
|
72
71
|
* </ol>
|
|
73
|
-
* <p>To decrypt data outside of
|
|
72
|
+
* <p>To decrypt data outside of KMS:</p>
|
|
74
73
|
* <ol>
|
|
75
74
|
* <li>
|
|
76
75
|
* <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The
|
|
77
76
|
* operation returns a plaintext copy of the data key.</p>
|
|
78
77
|
* </li>
|
|
79
78
|
* <li>
|
|
80
|
-
* <p>Use the plaintext data key to decrypt data outside of
|
|
79
|
+
* <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext
|
|
81
80
|
* data key from memory.</p>
|
|
82
81
|
* </li>
|
|
83
82
|
* </ol>
|
|
84
83
|
* <p>
|
|
85
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
84
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
86
85
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
87
86
|
*
|
|
88
87
|
* <p>
|
|
@@ -23,21 +23,20 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
|
|
25
25
|
* operation returns a plaintext public key, a plaintext private key, and a copy of the private
|
|
26
|
-
* key that is encrypted under the symmetric
|
|
27
|
-
* perform asymmetric cryptography outside of
|
|
28
|
-
*
|
|
29
|
-
* <p>
|
|
30
|
-
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
31
|
-
* bytes in the keys are not related to the caller or the CMK that is used to encrypt the private
|
|
32
|
-
* key.</p>
|
|
26
|
+
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to
|
|
27
|
+
* perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
33
28
|
*
|
|
34
29
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
35
|
-
* or verify a signature outside of
|
|
30
|
+
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
36
31
|
* 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>
|
|
37
32
|
*
|
|
38
|
-
* <p>To generate a data key pair, you must specify a symmetric
|
|
39
|
-
* encrypt the private key in a data key pair. You cannot use an asymmetric
|
|
40
|
-
* custom key store. To get the type and origin of your
|
|
33
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
34
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
35
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
36
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
37
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
38
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
39
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
41
40
|
*
|
|
42
41
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
43
42
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
@@ -47,15 +46,22 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
47
46
|
* the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
|
|
48
47
|
* pair.</p>
|
|
49
48
|
*
|
|
49
|
+
* <p>
|
|
50
|
+
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
51
|
+
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private
|
|
52
|
+
* 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
|
|
53
|
+
* private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC
|
|
54
|
+
* 5958</a>.</p>
|
|
55
|
+
*
|
|
50
56
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
51
57
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
52
58
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
53
59
|
* 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
|
|
54
|
-
* <i>
|
|
55
|
-
* <p>The
|
|
56
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
60
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
61
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
62
|
+
* 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>
|
|
57
63
|
* <p>
|
|
58
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
64
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
59
65
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
60
66
|
*
|
|
61
67
|
* <p>
|
|
@@ -28,30 +28,34 @@ export interface GenerateDataKeyPairWithoutPlaintextCommandOutput
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Generates a unique asymmetric data key pair. The
|
|
30
30
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key
|
|
31
|
-
* and a copy of the private key that is encrypted under the symmetric
|
|
31
|
+
* and a copy of the private key that is encrypted under the symmetric KMS key you specify. Unlike
|
|
32
32
|
* <a>GenerateDataKeyPair</a>, this operation does not return a plaintext private
|
|
33
33
|
* key. </p>
|
|
34
|
-
* <p>To generate a data key pair, you must specify a symmetric customer master key (CMK) to
|
|
35
|
-
* encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a
|
|
36
|
-
* custom key store. To get the type and origin of your CMK, use the <code>KeySpec</code> field
|
|
37
|
-
* in the <a>DescribeKey</a> response.</p>
|
|
38
34
|
* <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
|
|
39
|
-
* to encrypt data or verify a signature outside of
|
|
35
|
+
* to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
|
|
40
36
|
* 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>
|
|
37
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
38
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
39
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
40
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
41
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
42
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
43
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
41
44
|
* <p>
|
|
42
45
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
|
|
43
|
-
* request. The bytes in the key are not related to the caller or
|
|
44
|
-
* private key
|
|
46
|
+
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the
|
|
47
|
+
* private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
48
|
+
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
45
49
|
*
|
|
46
50
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
47
51
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
48
52
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
49
53
|
* 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
|
|
50
|
-
* <i>
|
|
51
|
-
* <p>The
|
|
52
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
54
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
55
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
56
|
+
* 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>
|
|
53
57
|
* <p>
|
|
54
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
58
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
55
59
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
56
60
|
*
|
|
57
61
|
* <p>
|
|
@@ -24,7 +24,7 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput
|
|
|
24
24
|
|
|
25
25
|
/**
|
|
26
26
|
* <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted
|
|
27
|
-
* under a
|
|
27
|
+
* under a KMS key that you specify. To request an asymmetric data key pair,
|
|
28
28
|
* use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operations.</p>
|
|
29
29
|
* <p>
|
|
30
30
|
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the
|
|
@@ -40,12 +40,12 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput
|
|
|
40
40
|
* plaintext data key.</p>
|
|
41
41
|
* <p>
|
|
42
42
|
* <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request.
|
|
43
|
-
* The bytes in the keys are not related to the caller or
|
|
43
|
+
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the private
|
|
44
44
|
* key.</p>
|
|
45
45
|
*
|
|
46
|
-
* <p>To generate a data key, you must specify the symmetric
|
|
47
|
-
* used to encrypt the data key. You cannot use an asymmetric
|
|
48
|
-
* the type of your
|
|
46
|
+
* <p>To generate a data key, you must specify the symmetric KMS key that is
|
|
47
|
+
* used to encrypt the data key. You cannot use an asymmetric KMS key to generate a data key. To get
|
|
48
|
+
* the type of your KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
49
49
|
*
|
|
50
50
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
51
51
|
* <code>CiphertextBlob</code> field.</p>
|
|
@@ -54,11 +54,11 @@ export interface GenerateDataKeyWithoutPlaintextCommandOutput
|
|
|
54
54
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
55
55
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
56
56
|
* 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
|
|
57
|
-
* <i>
|
|
58
|
-
* <p>The
|
|
59
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
57
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
58
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
59
|
+
* 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>
|
|
60
60
|
* <p>
|
|
61
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
61
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
62
62
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
63
63
|
*
|
|
64
64
|
* <p>
|
|
@@ -22,10 +22,11 @@ export interface GenerateRandomCommandOutput extends GenerateRandomResponse, __M
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Returns a random byte string that is cryptographically secure.</p>
|
|
25
|
-
* <p>By default, the random byte string is generated in
|
|
26
|
-
* the
|
|
25
|
+
* <p>By default, the random byte string is generated in KMS. To generate the byte string in
|
|
26
|
+
* 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
|
|
27
27
|
* ID.</p>
|
|
28
|
-
* <p>For
|
|
28
|
+
* <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>
|
|
29
|
+
* <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>
|
|
29
30
|
*
|
|
30
31
|
* <p>
|
|
31
32
|
* <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>
|
|
@@ -21,9 +21,9 @@ export interface GetKeyPolicyCommandInput extends GetKeyPolicyRequest {}
|
|
|
21
21
|
export interface GetKeyPolicyCommandOutput extends GetKeyPolicyResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Gets a key policy attached to the specified
|
|
24
|
+
* <p>Gets a key policy attached to the specified KMS key.</p>
|
|
25
25
|
* <p>
|
|
26
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
26
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
27
27
|
*
|
|
28
28
|
* <p>
|
|
29
29
|
* <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>
|
|
@@ -22,23 +22,23 @@ export interface GetKeyRotationStatusCommandOutput extends GetKeyRotationStatusR
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <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
|
|
25
|
-
* enabled for the specified
|
|
26
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
27
|
-
* <p>The
|
|
28
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
25
|
+
* enabled for the specified KMS key.</p>
|
|
26
|
+
* <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>
|
|
27
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
28
|
+
* 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>
|
|
29
29
|
* <ul>
|
|
30
30
|
* <li>
|
|
31
|
-
* <p>Disabled: The key rotation status does not change when you disable a
|
|
32
|
-
* while the
|
|
31
|
+
* <p>Disabled: The key rotation status does not change when you disable a KMS key. However,
|
|
32
|
+
* while the KMS key is disabled, KMS does not rotate the key material.</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
* <p>Pending deletion: While a
|
|
36
|
-
* <code>false</code> and
|
|
35
|
+
* <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is
|
|
36
|
+
* <code>false</code> and KMS does not rotate the key material. If you cancel the
|
|
37
37
|
* deletion, the original key rotation status is restored.</p>
|
|
38
38
|
* </li>
|
|
39
39
|
* </ul>
|
|
40
40
|
* <p>
|
|
41
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
41
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
42
42
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
43
43
|
*
|
|
44
44
|
* <p>
|
|
@@ -22,23 +22,23 @@ export interface GetParametersForImportCommandOutput extends GetParametersForImp
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
24
|
* <p>Returns the items you need to import key material into a symmetric, customer managed
|
|
25
|
-
*
|
|
25
|
+
* KMS key. For more information about importing key material into KMS, see
|
|
26
26
|
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
27
|
-
* Material</a> in the <i>
|
|
27
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
28
28
|
* <p>This operation returns a public key and an import token. Use the public key to encrypt the
|
|
29
29
|
* symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
|
|
30
|
-
* <p>You must specify the key ID of the symmetric
|
|
31
|
-
* This
|
|
30
|
+
* <p>You must specify the key ID of the symmetric KMS key into which you will import key material.
|
|
31
|
+
* This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also specify the
|
|
32
32
|
* wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key
|
|
33
|
-
* material. You cannot perform this operation on an asymmetric
|
|
33
|
+
* material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
34
34
|
* <p>To import key material, you must use the public key and import token from the same
|
|
35
35
|
* response. These items are valid for 24 hours. The expiration date and time appear in the
|
|
36
36
|
* <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
|
|
37
37
|
* <code>GetParametersForImport</code> request.</p>
|
|
38
|
-
* <p>The
|
|
39
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
38
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
39
|
+
* 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>
|
|
40
40
|
* <p>
|
|
41
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
41
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
42
42
|
*
|
|
43
43
|
* <p>
|
|
44
44
|
* <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>
|
|
@@ -21,22 +21,22 @@ export interface GetPublicKeyCommandInput extends GetPublicKeyRequest {}
|
|
|
21
21
|
export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Returns the public key of an asymmetric
|
|
25
|
-
* which never leaves
|
|
26
|
-
* can download the public key of an asymmetric
|
|
27
|
-
* to encrypt messages and verify signatures outside of
|
|
24
|
+
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key,
|
|
25
|
+
* which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code> permission
|
|
26
|
+
* can download the public key of an asymmetric KMS key. You can share the public key to allow others
|
|
27
|
+
* 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>
|
|
28
28
|
* <p>You do not need to download the public key. Instead, you can use the public key within
|
|
29
|
-
*
|
|
30
|
-
* public key within
|
|
31
|
-
* are part of every
|
|
32
|
-
* decrypted. These features are not effective outside of
|
|
29
|
+
* 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
|
|
30
|
+
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
31
|
+
* are part of every KMS operation. You also reduce of risk of encrypting data that cannot be
|
|
32
|
+
* 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
|
|
33
33
|
* Considerations for Downloading Public Keys</a>.</p>
|
|
34
|
-
* <p>To help you use the public key safely outside of
|
|
34
|
+
* <p>To help you use the public key safely outside of KMS, <code>GetPublicKey</code> returns
|
|
35
35
|
* important information about the public key in the response, including:</p>
|
|
36
36
|
* <ul>
|
|
37
37
|
* <li>
|
|
38
38
|
* <p>
|
|
39
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-
|
|
39
|
+
* <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
|
|
40
40
|
* <code>RSA_4096</code> or <code>ECC_NIST_P521</code>.</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
@@ -49,16 +49,16 @@ export interface GetPublicKeyCommandOutput extends GetPublicKeyResponse, __Metad
|
|
|
49
49
|
* algorithms for the key.</p>
|
|
50
50
|
* </li>
|
|
51
51
|
* </ul>
|
|
52
|
-
* <p>Although
|
|
52
|
+
* <p>Although KMS cannot enforce these restrictions on external operations, it is crucial
|
|
53
53
|
* that you use this information to prevent the public key from being used improperly. For
|
|
54
54
|
* example, you can prevent a public signing key from being used encrypt data, or prevent a
|
|
55
|
-
* public key from being used with an encryption algorithm that is not supported by
|
|
55
|
+
* public key from being used with an encryption algorithm that is not supported by KMS. You
|
|
56
56
|
* can also avoid errors, such as using the wrong signing algorithm in a verification
|
|
57
57
|
* operation.</p>
|
|
58
|
-
* <p>The
|
|
59
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
58
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
59
|
+
* 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>
|
|
60
60
|
* <p>
|
|
61
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
61
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
62
62
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
63
63
|
*
|
|
64
64
|
* <p>
|
|
@@ -21,13 +21,13 @@ export interface ImportKeyMaterialCommandInput extends ImportKeyMaterialRequest
|
|
|
21
21
|
export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Imports key material into an existing symmetric
|
|
25
|
-
* created without key material. After you successfully import key material into a
|
|
26
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport the same key material</a> into that
|
|
24
|
+
* <p>Imports key material into an existing symmetric KMS KMS key that was
|
|
25
|
+
* created without key material. After you successfully import key material into a KMS key, you can
|
|
26
|
+
* <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
|
|
27
27
|
* material. </p>
|
|
28
|
-
* <p>You cannot perform this operation on an asymmetric
|
|
28
|
+
* <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
|
|
29
29
|
* then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
|
|
30
|
-
* <i>
|
|
30
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
31
31
|
* <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
|
|
32
32
|
* includes a public key and an import token. Use the public key to encrypt the key material.
|
|
33
33
|
* Then, submit the import token from the same <code>GetParametersForImport</code>
|
|
@@ -35,11 +35,11 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
|
|
|
35
35
|
* <p>When calling this operation, you must specify the following values:</p>
|
|
36
36
|
* <ul>
|
|
37
37
|
* <li>
|
|
38
|
-
* <p>The key ID or key ARN of a
|
|
38
|
+
* <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must be
|
|
39
39
|
* <code>EXTERNAL</code>.</p>
|
|
40
|
-
* <p>To create a
|
|
40
|
+
* <p>To create a KMS key with no key material, call <a>CreateKey</a> and set the
|
|
41
41
|
* value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the
|
|
42
|
-
* <code>Origin</code> of a
|
|
42
|
+
* <code>Origin</code> of a KMS key, call <a>DescribeKey</a>.)</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
45
|
* <p>The encrypted key material. To get the public key to encrypt the key material, call
|
|
@@ -50,23 +50,23 @@ export interface ImportKeyMaterialCommandOutput extends ImportKeyMaterialRespons
|
|
|
50
50
|
* a public key and token from the same <code>GetParametersForImport</code> response.</p>
|
|
51
51
|
* </li>
|
|
52
52
|
* <li>
|
|
53
|
-
* <p>Whether the key material expires and if so, when. If you set an expiration date,
|
|
54
|
-
* deletes the key material from the
|
|
55
|
-
* To use the
|
|
53
|
+
* <p>Whether the key material expires and if so, when. If you set an expiration date, KMS
|
|
54
|
+
* deletes the key material from the KMS key on the specified date, and the KMS key becomes unusable.
|
|
55
|
+
* To use the KMS key again, you must reimport the same key material. The only way to change an
|
|
56
56
|
* expiration date is by reimporting the same key material and specifying a new expiration
|
|
57
57
|
* date. </p>
|
|
58
58
|
* </li>
|
|
59
59
|
* </ul>
|
|
60
|
-
* <p>When this operation is successful, the key state of the
|
|
61
|
-
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the
|
|
60
|
+
* <p>When this operation is successful, the key state of the KMS key changes from
|
|
61
|
+
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key.</p>
|
|
62
62
|
* <p>If this operation fails, use the exception to help determine the problem. If the error is
|
|
63
|
-
* 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
|
|
63
|
+
* 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
|
|
64
64
|
* 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
|
|
65
|
-
* Material</a> in the <i>
|
|
66
|
-
* <p>The
|
|
67
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
65
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
66
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
67
|
+
* 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>
|
|
68
68
|
* <p>
|
|
69
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
69
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
70
70
|
*
|
|
71
71
|
* <p>
|
|
72
72
|
* <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>
|
|
@@ -21,28 +21,26 @@ export interface ListAliasesCommandInput extends ListAliasesRequest {}
|
|
|
21
21
|
export interface ListAliasesCommandOutput extends ListAliasesResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Gets a list of aliases in the caller's
|
|
24
|
+
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about
|
|
25
25
|
* aliases, see <a>CreateAlias</a>.</p>
|
|
26
26
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
27
|
-
* region. To get only the aliases associated with a particular
|
|
27
|
+
* region. To get only the aliases associated with a particular KMS key, use
|
|
28
28
|
* the <code>KeyId</code> parameter.</p>
|
|
29
29
|
* <p>The <code>ListAliases</code> response can include aliases that you created and associated
|
|
30
|
-
* with your customer managed
|
|
31
|
-
* CMKs in your account. You can recognize AWS aliases because their names have the format
|
|
30
|
+
* 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
|
|
32
31
|
* <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p>
|
|
33
32
|
* <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
|
|
34
|
-
* are predefined aliases that
|
|
35
|
-
* that
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">
|
|
33
|
+
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases
|
|
34
|
+
* that Amazon Web Services creates in your account, including predefined aliases, do not count against your
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">KMS aliases
|
|
37
36
|
* quota</a>.</p>
|
|
38
37
|
* <p>
|
|
39
38
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
40
|
-
* return aliases in other
|
|
41
|
-
*
|
|
39
|
+
* return aliases in other Amazon Web Services accounts.</p>
|
|
42
40
|
*
|
|
43
41
|
* <p>
|
|
44
42
|
* <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>
|
|
45
|
-
* <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>
|
|
43
|
+
* <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>
|
|
46
44
|
* <p>
|
|
47
45
|
* <b>Related operations:</b>
|
|
48
46
|
* </p>
|
|
@@ -21,18 +21,23 @@ export interface ListGrantsCommandInput extends ListGrantsRequest {}
|
|
|
21
21
|
export interface ListGrantsCommandOutput extends ListGrantsResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Gets a list of all grants for the specified
|
|
25
|
-
* <p>You must specify the
|
|
24
|
+
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
25
|
+
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID
|
|
26
26
|
* or grantee principal.</p>
|
|
27
|
+
* <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
|
|
28
|
+
* <i>
|
|
29
|
+
* <i>Key Management Service Developer Guide</i>
|
|
30
|
+
* </i>. For examples of working with grants in several
|
|
31
|
+
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
27
32
|
* <note>
|
|
28
33
|
* <p>The <code>GranteePrincipal</code> field in the <code>ListGrants</code> response usually contains the
|
|
29
34
|
* user or role designated as the grantee principal in the grant. However, when the grantee
|
|
30
|
-
* principal in the grant is an
|
|
35
|
+
* principal in the grant is an Amazon Web Services service, the <code>GranteePrincipal</code> field contains
|
|
31
36
|
* the <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">service
|
|
32
37
|
* principal</a>, which might represent several different grantee principals.</p>
|
|
33
38
|
* </note>
|
|
34
39
|
* <p>
|
|
35
|
-
* <b>Cross-account use</b>: Yes. To perform this operation on a
|
|
40
|
+
* <b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
36
41
|
* ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
37
42
|
*
|
|
38
43
|
* <p>
|
|
@@ -21,11 +21,11 @@ export interface ListKeyPoliciesCommandInput extends ListKeyPoliciesRequest {}
|
|
|
21
21
|
export interface ListKeyPoliciesCommandOutput extends ListKeyPoliciesResponse, __MetadataBearer {}
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* <p>Gets the names of the key policies that are attached to a
|
|
24
|
+
* <p>Gets the names of the key policies that are attached to a KMS key. This
|
|
25
25
|
* operation is designed to get policy names that you can use in a <a>GetKeyPolicy</a>
|
|
26
26
|
* operation. However, the only valid policy name is <code>default</code>. </p>
|
|
27
27
|
* <p>
|
|
28
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
28
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
29
29
|
*
|
|
30
30
|
* <p>
|
|
31
31
|
* <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>
|
|
@@ -18,10 +18,10 @@ export interface ListKeysCommandInput extends ListKeysRequest {}
|
|
|
18
18
|
export interface ListKeysCommandOutput extends ListKeysResponse, __MetadataBearer {}
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
|
-
* <p>Gets a list of all
|
|
21
|
+
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and
|
|
22
22
|
* Region.</p>
|
|
23
23
|
* <p>
|
|
24
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
24
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
25
25
|
*
|
|
26
26
|
* <p>
|
|
27
27
|
* <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>
|