@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
|
@@ -7,29 +7,29 @@ export interface DeleteCustomKeyStoreCommandInput extends DeleteCustomKeyStoreRe
|
|
|
7
7
|
export interface DeleteCustomKeyStoreCommandOutput extends DeleteCustomKeyStoreResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <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
|
|
10
|
+
* <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
|
|
11
11
|
* associated with the custom key store, or affect any users or keys in the cluster.</p>
|
|
12
|
-
* <p>The custom key store that you delete cannot contain any
|
|
13
|
-
* deleting the key store, verify that you will never need to use any of the
|
|
12
|
+
* <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
|
|
13
|
+
* deleting the key store, verify that you will never need to use any of the KMS keys in the key
|
|
14
14
|
* 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
|
|
15
|
-
*
|
|
16
|
-
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the
|
|
15
|
+
* KMS keys from the key store. When the scheduled waiting period
|
|
16
|
+
* expires, the <code>ScheduleKeyDeletion</code> operation deletes the KMS keys. Then it makes a best
|
|
17
17
|
* effort to delete the key material from the associated cluster. However, you might need to
|
|
18
18
|
* manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
19
19
|
* material</a> from the cluster and its backups.</p>
|
|
20
|
-
* <p>After all
|
|
21
|
-
* disconnect the key store from
|
|
22
|
-
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from
|
|
23
|
-
* disconnected, you cannot create or use the
|
|
24
|
-
* delete
|
|
20
|
+
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a> to
|
|
21
|
+
* disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
22
|
+
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
|
|
23
|
+
* disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
|
|
24
|
+
* delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
|
|
25
25
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
26
26
|
* properties.</p>
|
|
27
|
-
* <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
|
|
28
|
-
* combines the convenience and extensive integration of
|
|
27
|
+
* <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
|
|
28
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
29
29
|
* single-tenant key store.</p>
|
|
30
30
|
*
|
|
31
31
|
* <p>
|
|
32
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
32
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
33
33
|
*
|
|
34
34
|
* <p>
|
|
35
35
|
* <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>
|
|
@@ -8,18 +8,18 @@ export interface DeleteImportedKeyMaterialCommandOutput extends __MetadataBearer
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Deletes key material that you previously imported. This operation makes the specified
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* Material</a> in the <i>
|
|
14
|
-
* <p>When the specified
|
|
15
|
-
* not change the
|
|
11
|
+
* KMS key unusable. For more information about importing key material into
|
|
12
|
+
* KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key
|
|
13
|
+
* Material</a> in the <i>Key Management Service Developer Guide</i>. </p>
|
|
14
|
+
* <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation does
|
|
15
|
+
* not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
16
16
|
* <code>PendingImport</code>.</p>
|
|
17
17
|
* <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
|
|
18
|
-
* the same key material into the
|
|
19
|
-
* <p>The
|
|
20
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
18
|
+
* the same key material into the KMS key.</p>
|
|
19
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
20
|
+
* 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>
|
|
21
21
|
* <p>
|
|
22
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
22
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
23
23
|
*
|
|
24
24
|
* <p>
|
|
25
25
|
* <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>
|
|
@@ -8,14 +8,14 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <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>
|
|
11
|
-
* <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
|
|
12
|
-
* combines the convenience and extensive integration of
|
|
11
|
+
* <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
|
|
12
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
13
13
|
* single-tenant key store.</p>
|
|
14
14
|
* <p>By default, this operation returns information about all custom key stores in the account and
|
|
15
15
|
* Region. To get only information about a particular custom key store, use either the
|
|
16
16
|
* <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not
|
|
17
17
|
* both).</p>
|
|
18
|
-
* <p>To determine whether the custom key store is connected to its
|
|
18
|
+
* <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
|
|
19
19
|
* <code>ConnectionState</code> element in the response. If an attempt to connect the custom
|
|
20
20
|
* key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
|
|
21
21
|
* <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure.
|
|
@@ -23,12 +23,12 @@ export interface DescribeCustomKeyStoresCommandOutput extends DescribeCustomKeyS
|
|
|
23
23
|
* <p>Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has
|
|
24
24
|
* never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to
|
|
25
25
|
* disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having
|
|
26
|
-
* trouble using it, make sure that its associated
|
|
26
|
+
* trouble using it, make sure that its associated CloudHSM cluster is active and contains the
|
|
27
27
|
* minimum number of HSMs required for the operation, if any.</p>
|
|
28
28
|
* <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
|
|
29
|
-
* <i>
|
|
29
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
30
30
|
* <p>
|
|
31
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
31
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
32
32
|
* <p>
|
|
33
33
|
* <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>
|
|
34
34
|
* <p>
|
|
@@ -7,41 +7,40 @@ export interface DescribeKeyCommandInput extends DescribeKeyRequest {
|
|
|
7
7
|
export interface DescribeKeyCommandOutput extends DescribeKeyResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Provides detailed information about a
|
|
11
|
-
* <code>DescribeKey</code> on a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
12
|
-
* CMK</a>.</p>
|
|
10
|
+
* <p>Provides detailed information about a KMS key. You can run
|
|
11
|
+
* <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>
|
|
13
12
|
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
|
|
14
13
|
* applicable), the key state, and the origin and expiration date (if any) of the key material.
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* the
|
|
14
|
+
* It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
|
|
15
|
+
* asymmetric KMS keys. It also provides information that is particularly important to asymmetric
|
|
16
|
+
* keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
|
|
17
|
+
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about
|
|
18
|
+
* the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region
|
|
19
|
+
* keys, it displays the primary key and all related replica keys. </p>
|
|
20
20
|
* <p>
|
|
21
21
|
* <code>DescribeKey</code> does not return the following information:</p>
|
|
22
22
|
* <ul>
|
|
23
23
|
* <li>
|
|
24
|
-
* <p>Aliases associated with the
|
|
24
|
+
* <p>Aliases associated with the KMS key. To get this information, use <a>ListAliases</a>.</p>
|
|
25
25
|
* </li>
|
|
26
26
|
* <li>
|
|
27
|
-
* <p>Whether automatic key rotation is enabled on the
|
|
28
|
-
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a
|
|
27
|
+
* <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
|
|
28
|
+
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from being
|
|
29
29
|
* 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
|
|
30
|
-
* Works</a> in <i>
|
|
30
|
+
* Works</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
* <p>Tags on the
|
|
33
|
+
* <p>Tags on the KMS key. To get this information, use <a>ListResourceTags</a>.</p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
* <p>Key policies and grants on the
|
|
36
|
+
* <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* </ul>
|
|
39
|
-
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* <code>Arn</code> of the new CMK in the response.</p>
|
|
39
|
+
* <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>.
|
|
40
|
+
* Then, it associates the alias with the new KMS key, and returns the <code>KeyId</code> and
|
|
41
|
+
* <code>Arn</code> of the new KMS key in the response.</p>
|
|
43
42
|
* <p>
|
|
44
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
43
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
45
44
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
46
45
|
*
|
|
47
46
|
* <p>
|
|
@@ -7,15 +7,15 @@ export interface DisableKeyCommandInput extends DisableKeyRequest {
|
|
|
7
7
|
export interface DisableKeyCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Sets the state of a
|
|
11
|
-
* prevents use of the
|
|
12
|
-
* <p>For more information about how key state affects the use of a
|
|
13
|
-
* <i>
|
|
10
|
+
* <p>Sets the state of a KMS key to disabled. This change temporarily
|
|
11
|
+
* 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>
|
|
12
|
+
* <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>
|
|
13
|
+
* <i>Key Management Service Developer Guide</i>
|
|
14
14
|
* </i>.</p>
|
|
15
|
-
* <p>The
|
|
16
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
15
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
16
|
+
* 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>
|
|
17
17
|
* <p>
|
|
18
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
18
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
19
19
|
*
|
|
20
20
|
* <p>
|
|
21
21
|
* <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>
|
|
@@ -8,13 +8,12 @@ export interface DisableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Disables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
11
|
-
* rotation of the key material</a> for the specified symmetric
|
|
12
|
-
*
|
|
13
|
-
* <p>
|
|
14
|
-
*
|
|
15
|
-
* 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>
|
|
11
|
+
* rotation of the key material</a> for the specified symmetric KMS key.</p>
|
|
12
|
+
* <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>
|
|
13
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
14
|
+
* 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>
|
|
16
15
|
* <p>
|
|
17
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
16
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
18
17
|
*
|
|
19
18
|
* <p>
|
|
20
19
|
* <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>
|
|
@@ -7,13 +7,11 @@ export interface DisconnectCustomKeyStoreCommandInput extends DisconnectCustomKe
|
|
|
7
7
|
export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomKeyStoreResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <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
|
|
11
|
-
* store is disconnected, you can manage the custom key store and its
|
|
12
|
-
* (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the
|
|
10
|
+
* <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
|
|
11
|
+
* 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
|
|
13
12
|
* custom key store at any time.</p>
|
|
14
13
|
* <note>
|
|
15
|
-
* <p>While a custom key store is disconnected, all attempts to create
|
|
16
|
-
* (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
|
|
14
|
+
* <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
|
|
17
15
|
* fail. This action can prevent users from storing and accessing sensitive data.</p>
|
|
18
16
|
* </note>
|
|
19
17
|
* <p></p>
|
|
@@ -21,12 +19,12 @@ export interface DisconnectCustomKeyStoreCommandOutput extends DisconnectCustomK
|
|
|
21
19
|
* <a>ConnectCustomKeyStore</a> operation.</p>
|
|
22
20
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
23
21
|
* properties.</p>
|
|
24
|
-
* <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
|
|
25
|
-
* combines the convenience and extensive integration of
|
|
22
|
+
* <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
|
|
23
|
+
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
26
24
|
* single-tenant key store.</p>
|
|
27
25
|
*
|
|
28
26
|
* <p>
|
|
29
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different
|
|
27
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
30
28
|
*
|
|
31
29
|
* <p>
|
|
32
30
|
* <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>
|
|
@@ -7,12 +7,11 @@ export interface EnableKeyCommandInput extends EnableKeyRequest {
|
|
|
7
7
|
export interface EnableKeyCommandOutput extends __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Sets the key state of a
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
* 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>
|
|
10
|
+
* <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>
|
|
11
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
12
|
+
* 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>
|
|
14
13
|
* <p>
|
|
15
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
14
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
16
15
|
*
|
|
17
16
|
* <p>
|
|
18
17
|
* <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>
|
|
@@ -8,12 +8,12 @@ export interface EnableKeyRotationCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Enables <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation
|
|
11
|
-
* of the key material</a> for the specified symmetric
|
|
12
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric
|
|
13
|
-
* <p>The
|
|
14
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
11
|
+
* of the key material</a> for the specified symmetric KMS key.</p>
|
|
12
|
+
* <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>
|
|
13
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
14
|
+
* 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>
|
|
15
15
|
* <p>
|
|
16
|
-
* <b>Cross-account use</b>: No. You cannot perform this operation on a
|
|
16
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
17
17
|
*
|
|
18
18
|
* <p>
|
|
19
19
|
* <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>
|
|
@@ -7,7 +7,7 @@ export interface EncryptCommandInput extends EncryptRequest {
|
|
|
7
7
|
export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Encrypts plaintext into ciphertext by using a
|
|
10
|
+
* <p>Encrypts plaintext into ciphertext by using a KMS key. The
|
|
11
11
|
* <code>Encrypt</code> operation has two primary use cases:</p>
|
|
12
12
|
* <ul>
|
|
13
13
|
* <li>
|
|
@@ -15,41 +15,40 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
15
15
|
* database password, or other sensitive information. </p>
|
|
16
16
|
* </li>
|
|
17
17
|
* <li>
|
|
18
|
-
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* the encrypted data
|
|
23
|
-
* and the encrypted data entirely within in Region B.</p>
|
|
18
|
+
* <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
|
|
19
|
+
* your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt the
|
|
20
|
+
* plaintext data key under a KMS key in Region B. Now, you can move the encrypted data and the
|
|
21
|
+
* encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and
|
|
22
|
+
* the encrypted data entirely within in Region B.</p>
|
|
24
23
|
* </li>
|
|
25
24
|
* </ul>
|
|
26
25
|
*
|
|
27
26
|
* <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
|
|
28
27
|
* plaintext data key and an encrypted copy of that data key.</p>
|
|
29
28
|
*
|
|
30
|
-
* <p>When you encrypt data, you must specify a symmetric or asymmetric
|
|
31
|
-
* encryption operation. The
|
|
32
|
-
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a
|
|
29
|
+
* <p>When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the
|
|
30
|
+
* encryption operation. The KMS key must have a <code>KeyUsage</code> value of
|
|
31
|
+
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
33
32
|
*
|
|
34
|
-
* <p>If you use a symmetric
|
|
33
|
+
* <p>If you use a symmetric KMS key, you can use an encryption context to add additional security
|
|
35
34
|
* to your encryption operation. If you specify an <code>EncryptionContext</code> when encrypting
|
|
36
35
|
* data, you must specify the same encryption context (a case-sensitive exact match) when
|
|
37
36
|
* decrypting the data. Otherwise, the request to decrypt fails with an
|
|
38
37
|
* <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
39
|
-
* Context</a> in the <i>
|
|
40
|
-
* <p>If you specify an asymmetric
|
|
41
|
-
* algorithm must be compatible with the
|
|
38
|
+
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
39
|
+
* <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
|
|
40
|
+
* algorithm must be compatible with the KMS key type.</p>
|
|
42
41
|
* <important>
|
|
43
|
-
* <p>When you use an asymmetric
|
|
44
|
-
* <p>You are not required to supply the
|
|
42
|
+
* <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>
|
|
43
|
+
* <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>
|
|
45
44
|
* </important>
|
|
46
45
|
*
|
|
47
46
|
*
|
|
48
|
-
* <p>The maximum size of the data that you can encrypt varies with the type of
|
|
47
|
+
* <p>The maximum size of the data that you can encrypt varies with the type of KMS key and the
|
|
49
48
|
* encryption algorithm that you choose.</p>
|
|
50
49
|
* <ul>
|
|
51
50
|
* <li>
|
|
52
|
-
* <p>Symmetric
|
|
51
|
+
* <p>Symmetric KMS keys</p>
|
|
53
52
|
* <ul>
|
|
54
53
|
* <li>
|
|
55
54
|
* <p>
|
|
@@ -103,10 +102,10 @@ export interface EncryptCommandOutput extends EncryptResponse, __MetadataBearer
|
|
|
103
102
|
* </ul>
|
|
104
103
|
* </li>
|
|
105
104
|
* </ul>
|
|
106
|
-
* <p>The
|
|
107
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
105
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
106
|
+
* 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>
|
|
108
107
|
* <p>
|
|
109
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
108
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
110
109
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
111
110
|
*
|
|
112
111
|
* <p>
|
|
@@ -8,16 +8,16 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
|
|
11
|
-
* plaintext copy of the data key and a copy that is encrypted under a
|
|
12
|
-
* that you specify. You can use the plaintext key to encrypt your data outside of
|
|
11
|
+
* plaintext copy of the data key and a copy that is encrypted under a KMS key
|
|
12
|
+
* that you specify. You can use the plaintext key to encrypt your data outside of KMS and
|
|
13
13
|
* store the encrypted data key with the encrypted data.</p>
|
|
14
14
|
*
|
|
15
15
|
* <p>
|
|
16
16
|
* <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
|
|
17
|
-
* plaintext key are not related to the caller or the
|
|
17
|
+
* plaintext key are not related to the caller or the KMS key.</p>
|
|
18
18
|
*
|
|
19
|
-
* <p>To generate a data key, specify the symmetric
|
|
20
|
-
* key. You cannot use an asymmetric
|
|
19
|
+
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the data
|
|
20
|
+
* key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use
|
|
21
21
|
* the <a>DescribeKey</a> operation. You must also specify the length of the data key.
|
|
22
22
|
* Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters (but not both).
|
|
23
23
|
* For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
@@ -30,45 +30,44 @@ export interface GenerateDataKeyCommandOutput extends GenerateDataKeyResponse, _
|
|
|
30
30
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
31
31
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
32
32
|
* 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
|
|
33
|
-
* <i>
|
|
34
|
-
* <p>
|
|
35
|
-
*
|
|
33
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
34
|
+
* <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>
|
|
35
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
36
|
+
* 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>
|
|
36
37
|
* <p>
|
|
37
|
-
* <b>How to use your
|
|
38
|
-
* data key</b>
|
|
38
|
+
* <b>How to use your data key</b>
|
|
39
39
|
* </p>
|
|
40
|
-
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
41
|
-
*
|
|
42
|
-
* <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
|
|
40
|
+
* <p>We recommend that you use the following pattern to encrypt data locally in your application.
|
|
41
|
+
* 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
|
|
43
42
|
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
44
43
|
* client-side encryption</a> to do these tasks for you.</p>
|
|
45
|
-
* <p>To encrypt data outside of
|
|
44
|
+
* <p>To encrypt data outside of KMS:</p>
|
|
46
45
|
* <ol>
|
|
47
46
|
* <li>
|
|
48
47
|
* <p>Use the <code>GenerateDataKey</code> operation to get a data key.</p>
|
|
49
48
|
* </li>
|
|
50
49
|
* <li>
|
|
51
50
|
* <p>Use the plaintext data key (in the <code>Plaintext</code> field of the response) to
|
|
52
|
-
* encrypt your data outside of
|
|
51
|
+
* encrypt your data outside of KMS. Then erase the plaintext data key from memory.</p>
|
|
53
52
|
* </li>
|
|
54
53
|
* <li>
|
|
55
54
|
* <p>Store the encrypted data key (in the <code>CiphertextBlob</code> field of the
|
|
56
55
|
* response) with the encrypted data.</p>
|
|
57
56
|
* </li>
|
|
58
57
|
* </ol>
|
|
59
|
-
* <p>To decrypt data outside of
|
|
58
|
+
* <p>To decrypt data outside of KMS:</p>
|
|
60
59
|
* <ol>
|
|
61
60
|
* <li>
|
|
62
61
|
* <p>Use the <a>Decrypt</a> operation to decrypt the encrypted data key. The
|
|
63
62
|
* operation returns a plaintext copy of the data key.</p>
|
|
64
63
|
* </li>
|
|
65
64
|
* <li>
|
|
66
|
-
* <p>Use the plaintext data key to decrypt data outside of
|
|
65
|
+
* <p>Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext
|
|
67
66
|
* data key from memory.</p>
|
|
68
67
|
* </li>
|
|
69
68
|
* </ol>
|
|
70
69
|
* <p>
|
|
71
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
70
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
72
71
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
73
72
|
*
|
|
74
73
|
* <p>
|
|
@@ -9,21 +9,20 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
|
|
11
11
|
* operation returns a plaintext public key, a plaintext private key, and a copy of the private
|
|
12
|
-
* key that is encrypted under the symmetric
|
|
13
|
-
* perform asymmetric cryptography outside of
|
|
14
|
-
*
|
|
15
|
-
* <p>
|
|
16
|
-
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
17
|
-
* bytes in the keys are not related to the caller or the CMK that is used to encrypt the private
|
|
18
|
-
* key.</p>
|
|
12
|
+
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to
|
|
13
|
+
* perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
19
14
|
*
|
|
20
15
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
21
|
-
* or verify a signature outside of
|
|
16
|
+
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
22
17
|
* 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>
|
|
23
18
|
*
|
|
24
|
-
* <p>To generate a data key pair, you must specify a symmetric
|
|
25
|
-
* encrypt the private key in a data key pair. You cannot use an asymmetric
|
|
26
|
-
* custom key store. To get the type and origin of your
|
|
19
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
20
|
+
* encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a
|
|
21
|
+
* custom key store. To get the type and origin of your KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
22
|
+
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
23
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
24
|
+
* for either encryption or signing, but not both. However, KMS cannot enforce any restrictions
|
|
25
|
+
* on the use of data key pairs outside of KMS.</p>
|
|
27
26
|
*
|
|
28
27
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
29
28
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
@@ -33,15 +32,22 @@ export interface GenerateDataKeyPairCommandOutput extends GenerateDataKeyPairRes
|
|
|
33
32
|
* the <a>Decrypt</a> operation to decrypt the encrypted private key in the data key
|
|
34
33
|
* pair.</p>
|
|
35
34
|
*
|
|
35
|
+
* <p>
|
|
36
|
+
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
37
|
+
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private
|
|
38
|
+
* 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
|
|
39
|
+
* private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC
|
|
40
|
+
* 5958</a>.</p>
|
|
41
|
+
*
|
|
36
42
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
37
43
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
38
44
|
* encryption context (a case-sensitive exact match) when decrypting the encrypted data key.
|
|
39
45
|
* 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
|
|
40
|
-
* <i>
|
|
41
|
-
* <p>The
|
|
42
|
-
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your
|
|
46
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
47
|
+
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
48
|
+
* 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>
|
|
43
49
|
* <p>
|
|
44
|
-
* <b>Cross-account use</b>: Yes. To perform this operation with a
|
|
50
|
+
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
45
51
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
46
52
|
*
|
|
47
53
|
* <p>
|