@aws-sdk/client-kms 3.35.0 → 3.36.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 +14 -0
- package/README.md +8 -7
- package/dist-cjs/KMS.js +8 -8
- package/dist-cjs/KMSClient.js +8 -8
- package/dist-cjs/commands/CancelKeyDeletionCommand.js +6 -5
- package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js +3 -4
- package/dist-cjs/commands/CreateAliasCommand.js +11 -8
- package/dist-cjs/commands/CreateCustomKeyStoreCommand.js +0 -1
- package/dist-cjs/commands/CreateGrantCommand.js +14 -12
- package/dist-cjs/commands/CreateKeyCommand.js +16 -15
- package/dist-cjs/commands/DecryptCommand.js +24 -22
- package/dist-cjs/commands/DeleteAliasCommand.js +11 -8
- package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js +10 -12
- package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js +5 -7
- package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js +4 -5
- package/dist-cjs/commands/DescribeKeyCommand.js +12 -11
- package/dist-cjs/commands/DisableKeyCommand.js +5 -5
- package/dist-cjs/commands/DisableKeyRotationCommand.js +2 -2
- package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js +6 -5
- package/dist-cjs/commands/EnableKeyCommand.js +4 -3
- package/dist-cjs/commands/EnableKeyRotationCommand.js +2 -2
- package/dist-cjs/commands/EncryptCommand.js +14 -13
- package/dist-cjs/commands/GenerateDataKeyCommand.js +15 -13
- package/dist-cjs/commands/GenerateDataKeyPairCommand.js +15 -14
- package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +16 -14
- package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js +11 -10
- package/dist-cjs/commands/GenerateRandomCommand.js +2 -2
- package/dist-cjs/commands/GetKeyPolicyCommand.js +0 -1
- package/dist-cjs/commands/GetKeyRotationStatusCommand.js +2 -2
- package/dist-cjs/commands/GetParametersForImportCommand.js +7 -9
- package/dist-cjs/commands/GetPublicKeyCommand.js +7 -6
- package/dist-cjs/commands/ImportKeyMaterialCommand.js +13 -14
- package/dist-cjs/commands/ListAliasesCommand.js +13 -11
- package/dist-cjs/commands/ListGrantsCommand.js +2 -3
- package/dist-cjs/commands/ListKeyPoliciesCommand.js +3 -4
- package/dist-cjs/commands/ListKeysCommand.js +1 -3
- package/dist-cjs/commands/ListResourceTagsCommand.js +0 -1
- package/dist-cjs/commands/ListRetirableGrantsCommand.js +7 -7
- package/dist-cjs/commands/PutKeyPolicyCommand.js +0 -1
- package/dist-cjs/commands/ReEncryptCommand.js +33 -28
- package/dist-cjs/commands/ReplicateKeyCommand.js +5 -6
- package/dist-cjs/commands/RetireGrantCommand.js +7 -6
- package/dist-cjs/commands/RevokeGrantCommand.js +1 -3
- package/dist-cjs/commands/ScheduleKeyDeletionCommand.js +19 -16
- package/dist-cjs/commands/SignCommand.js +10 -10
- package/dist-cjs/commands/TagResourceCommand.js +6 -5
- package/dist-cjs/commands/UntagResourceCommand.js +3 -4
- package/dist-cjs/commands/UpdateAliasCommand.js +15 -12
- package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js +17 -18
- package/dist-cjs/commands/UpdateKeyDescriptionCommand.js +3 -4
- package/dist-cjs/commands/UpdatePrimaryRegionCommand.js +1 -2
- package/dist-cjs/commands/VerifyCommand.js +5 -6
- package/dist-cjs/endpoints.js +0 -1
- package/dist-cjs/index.js +0 -1
- package/dist-cjs/models/index.js +0 -1
- package/dist-cjs/models/models_0.js +0 -1
- package/dist-cjs/pagination/Interfaces.js +0 -1
- package/dist-cjs/pagination/ListAliasesPaginator.js +0 -1
- package/dist-cjs/pagination/ListGrantsPaginator.js +0 -1
- package/dist-cjs/pagination/ListKeyPoliciesPaginator.js +0 -1
- package/dist-cjs/pagination/ListKeysPaginator.js +0 -1
- package/dist-cjs/protocols/Aws_json1_1.js +0 -1
- package/dist-cjs/runtimeConfig.browser.js +2 -3
- package/dist-cjs/runtimeConfig.js +3 -4
- package/dist-cjs/runtimeConfig.native.js +0 -1
- package/dist-cjs/runtimeConfig.shared.js +0 -1
- package/dist-es/KMS.js +0 -1
- package/dist-es/KMSClient.js +0 -1
- package/dist-es/commands/CancelKeyDeletionCommand.js +0 -1
- package/dist-es/commands/ConnectCustomKeyStoreCommand.js +0 -1
- package/dist-es/commands/CreateAliasCommand.js +0 -1
- package/dist-es/commands/CreateCustomKeyStoreCommand.js +0 -1
- package/dist-es/commands/CreateGrantCommand.js +0 -1
- package/dist-es/commands/CreateKeyCommand.js +0 -1
- package/dist-es/commands/DecryptCommand.js +0 -1
- package/dist-es/commands/DeleteAliasCommand.js +0 -1
- package/dist-es/commands/DeleteCustomKeyStoreCommand.js +0 -1
- package/dist-es/commands/DeleteImportedKeyMaterialCommand.js +0 -1
- package/dist-es/commands/DescribeCustomKeyStoresCommand.js +0 -1
- package/dist-es/commands/DescribeKeyCommand.js +0 -1
- package/dist-es/commands/DisableKeyCommand.js +0 -1
- package/dist-es/commands/DisableKeyRotationCommand.js +0 -1
- package/dist-es/commands/DisconnectCustomKeyStoreCommand.js +0 -1
- package/dist-es/commands/EnableKeyCommand.js +0 -1
- package/dist-es/commands/EnableKeyRotationCommand.js +0 -1
- package/dist-es/commands/EncryptCommand.js +0 -1
- package/dist-es/commands/GenerateDataKeyCommand.js +0 -1
- package/dist-es/commands/GenerateDataKeyPairCommand.js +0 -1
- package/dist-es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js +0 -1
- package/dist-es/commands/GenerateDataKeyWithoutPlaintextCommand.js +0 -1
- package/dist-es/commands/GenerateRandomCommand.js +0 -1
- package/dist-es/commands/GetKeyPolicyCommand.js +0 -1
- package/dist-es/commands/GetKeyRotationStatusCommand.js +0 -1
- package/dist-es/commands/GetParametersForImportCommand.js +0 -1
- package/dist-es/commands/GetPublicKeyCommand.js +0 -1
- package/dist-es/commands/ImportKeyMaterialCommand.js +0 -1
- package/dist-es/commands/ListAliasesCommand.js +0 -1
- package/dist-es/commands/ListGrantsCommand.js +0 -1
- package/dist-es/commands/ListKeyPoliciesCommand.js +0 -1
- package/dist-es/commands/ListKeysCommand.js +0 -1
- package/dist-es/commands/ListResourceTagsCommand.js +0 -1
- package/dist-es/commands/ListRetirableGrantsCommand.js +0 -1
- package/dist-es/commands/PutKeyPolicyCommand.js +0 -1
- package/dist-es/commands/ReEncryptCommand.js +0 -1
- package/dist-es/commands/ReplicateKeyCommand.js +0 -1
- package/dist-es/commands/RetireGrantCommand.js +0 -1
- package/dist-es/commands/RevokeGrantCommand.js +0 -1
- package/dist-es/commands/ScheduleKeyDeletionCommand.js +0 -1
- package/dist-es/commands/SignCommand.js +0 -1
- package/dist-es/commands/TagResourceCommand.js +0 -1
- package/dist-es/commands/UntagResourceCommand.js +0 -1
- package/dist-es/commands/UpdateAliasCommand.js +0 -1
- package/dist-es/commands/UpdateCustomKeyStoreCommand.js +0 -1
- package/dist-es/commands/UpdateKeyDescriptionCommand.js +0 -1
- package/dist-es/commands/UpdatePrimaryRegionCommand.js +0 -1
- package/dist-es/commands/VerifyCommand.js +0 -1
- package/dist-es/endpoints.js +0 -1
- package/dist-es/index.js +0 -1
- package/dist-es/models/index.js +0 -1
- package/dist-es/models/models_0.js +0 -1
- package/dist-es/pagination/Interfaces.js +0 -1
- package/dist-es/pagination/ListAliasesPaginator.js +0 -1
- package/dist-es/pagination/ListGrantsPaginator.js +0 -1
- package/dist-es/pagination/ListKeyPoliciesPaginator.js +0 -1
- package/dist-es/pagination/ListKeysPaginator.js +0 -1
- package/dist-es/protocols/Aws_json1_1.js +0 -1
- package/dist-es/runtimeConfig.browser.js +1 -2
- package/dist-es/runtimeConfig.js +2 -3
- package/dist-es/runtimeConfig.native.js +0 -1
- package/dist-es/runtimeConfig.shared.js +0 -1
- package/dist-types/KMS.d.ts +396 -334
- package/dist-types/KMSClient.d.ts +8 -7
- package/dist-types/commands/CancelKeyDeletionCommand.d.ts +6 -4
- package/dist-types/commands/ConnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/commands/CreateAliasCommand.d.ts +11 -7
- package/dist-types/commands/CreateGrantCommand.d.ts +14 -11
- package/dist-types/commands/CreateKeyCommand.d.ts +16 -14
- package/dist-types/commands/DecryptCommand.d.ts +24 -21
- package/dist-types/commands/DeleteAliasCommand.d.ts +11 -7
- package/dist-types/commands/DeleteCustomKeyStoreCommand.d.ts +10 -11
- package/dist-types/commands/DeleteImportedKeyMaterialCommand.d.ts +5 -6
- package/dist-types/commands/DescribeCustomKeyStoresCommand.d.ts +4 -4
- package/dist-types/commands/DescribeKeyCommand.d.ts +12 -10
- package/dist-types/commands/DisableKeyCommand.d.ts +5 -4
- package/dist-types/commands/DisableKeyRotationCommand.d.ts +2 -1
- package/dist-types/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -4
- package/dist-types/commands/EnableKeyCommand.d.ts +4 -2
- package/dist-types/commands/EnableKeyRotationCommand.d.ts +2 -1
- package/dist-types/commands/EncryptCommand.d.ts +14 -12
- package/dist-types/commands/GenerateDataKeyCommand.d.ts +15 -12
- package/dist-types/commands/GenerateDataKeyPairCommand.d.ts +15 -13
- package/dist-types/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -13
- package/dist-types/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +11 -9
- package/dist-types/commands/GenerateRandomCommand.d.ts +2 -1
- package/dist-types/commands/GetKeyRotationStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetParametersForImportCommand.d.ts +7 -8
- package/dist-types/commands/GetPublicKeyCommand.d.ts +7 -5
- package/dist-types/commands/ImportKeyMaterialCommand.d.ts +13 -13
- package/dist-types/commands/ListAliasesCommand.d.ts +13 -10
- package/dist-types/commands/ListGrantsCommand.d.ts +2 -2
- package/dist-types/commands/ListKeyPoliciesCommand.d.ts +3 -3
- package/dist-types/commands/ListKeysCommand.d.ts +1 -2
- package/dist-types/commands/ListRetirableGrantsCommand.d.ts +7 -6
- package/dist-types/commands/ReEncryptCommand.d.ts +33 -27
- package/dist-types/commands/ReplicateKeyCommand.d.ts +5 -5
- package/dist-types/commands/RetireGrantCommand.d.ts +7 -5
- package/dist-types/commands/RevokeGrantCommand.d.ts +1 -2
- package/dist-types/commands/ScheduleKeyDeletionCommand.d.ts +19 -15
- package/dist-types/commands/SignCommand.d.ts +10 -9
- package/dist-types/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAliasCommand.d.ts +15 -11
- package/dist-types/commands/UpdateCustomKeyStoreCommand.d.ts +17 -17
- package/dist-types/commands/UpdateKeyDescriptionCommand.d.ts +3 -3
- package/dist-types/commands/UpdatePrimaryRegionCommand.d.ts +1 -1
- package/dist-types/commands/VerifyCommand.d.ts +5 -5
- package/dist-types/models/models_0.d.ts +296 -249
- package/dist-types/ts3.4/KMS.d.ts +396 -334
- package/dist-types/ts3.4/KMSClient.d.ts +8 -7
- package/dist-types/ts3.4/commands/CancelKeyDeletionCommand.d.ts +6 -4
- package/dist-types/ts3.4/commands/ConnectCustomKeyStoreCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/CreateAliasCommand.d.ts +11 -7
- package/dist-types/ts3.4/commands/CreateGrantCommand.d.ts +14 -11
- package/dist-types/ts3.4/commands/CreateKeyCommand.d.ts +16 -14
- package/dist-types/ts3.4/commands/DecryptCommand.d.ts +24 -21
- package/dist-types/ts3.4/commands/DeleteAliasCommand.d.ts +11 -7
- package/dist-types/ts3.4/commands/DeleteCustomKeyStoreCommand.d.ts +10 -11
- package/dist-types/ts3.4/commands/DeleteImportedKeyMaterialCommand.d.ts +5 -6
- package/dist-types/ts3.4/commands/DescribeCustomKeyStoresCommand.d.ts +4 -4
- package/dist-types/ts3.4/commands/DescribeKeyCommand.d.ts +12 -10
- package/dist-types/ts3.4/commands/DisableKeyCommand.d.ts +5 -4
- package/dist-types/ts3.4/commands/DisableKeyRotationCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/DisconnectCustomKeyStoreCommand.d.ts +6 -4
- package/dist-types/ts3.4/commands/EnableKeyCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/EnableKeyRotationCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/EncryptCommand.d.ts +14 -12
- package/dist-types/ts3.4/commands/GenerateDataKeyCommand.d.ts +15 -12
- package/dist-types/ts3.4/commands/GenerateDataKeyPairCommand.d.ts +15 -13
- package/dist-types/ts3.4/commands/GenerateDataKeyPairWithoutPlaintextCommand.d.ts +16 -13
- package/dist-types/ts3.4/commands/GenerateDataKeyWithoutPlaintextCommand.d.ts +11 -9
- package/dist-types/ts3.4/commands/GenerateRandomCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetKeyRotationStatusCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetParametersForImportCommand.d.ts +7 -8
- package/dist-types/ts3.4/commands/GetPublicKeyCommand.d.ts +7 -5
- package/dist-types/ts3.4/commands/ImportKeyMaterialCommand.d.ts +13 -13
- package/dist-types/ts3.4/commands/ListAliasesCommand.d.ts +13 -10
- package/dist-types/ts3.4/commands/ListGrantsCommand.d.ts +2 -2
- package/dist-types/ts3.4/commands/ListKeyPoliciesCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/ListKeysCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ListRetirableGrantsCommand.d.ts +7 -6
- package/dist-types/ts3.4/commands/ReEncryptCommand.d.ts +33 -27
- package/dist-types/ts3.4/commands/ReplicateKeyCommand.d.ts +5 -5
- package/dist-types/ts3.4/commands/RetireGrantCommand.d.ts +7 -5
- package/dist-types/ts3.4/commands/RevokeGrantCommand.d.ts +1 -2
- package/dist-types/ts3.4/commands/ScheduleKeyDeletionCommand.d.ts +19 -15
- package/dist-types/ts3.4/commands/SignCommand.d.ts +10 -9
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +6 -4
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +15 -11
- package/dist-types/ts3.4/commands/UpdateCustomKeyStoreCommand.d.ts +17 -17
- package/dist-types/ts3.4/commands/UpdateKeyDescriptionCommand.d.ts +3 -3
- package/dist-types/ts3.4/commands/UpdatePrimaryRegionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/VerifyCommand.d.ts +5 -5
- package/dist-types/ts3.4/models/models_0.d.ts +296 -249
- package/package.json +33 -30
- package/dist-cjs/KMS.js.map +0 -1
- package/dist-cjs/KMSClient.js.map +0 -1
- package/dist-cjs/commands/CancelKeyDeletionCommand.js.map +0 -1
- package/dist-cjs/commands/ConnectCustomKeyStoreCommand.js.map +0 -1
- package/dist-cjs/commands/CreateAliasCommand.js.map +0 -1
- package/dist-cjs/commands/CreateCustomKeyStoreCommand.js.map +0 -1
- package/dist-cjs/commands/CreateGrantCommand.js.map +0 -1
- package/dist-cjs/commands/CreateKeyCommand.js.map +0 -1
- package/dist-cjs/commands/DecryptCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteAliasCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteCustomKeyStoreCommand.js.map +0 -1
- package/dist-cjs/commands/DeleteImportedKeyMaterialCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeCustomKeyStoresCommand.js.map +0 -1
- package/dist-cjs/commands/DescribeKeyCommand.js.map +0 -1
- package/dist-cjs/commands/DisableKeyCommand.js.map +0 -1
- package/dist-cjs/commands/DisableKeyRotationCommand.js.map +0 -1
- package/dist-cjs/commands/DisconnectCustomKeyStoreCommand.js.map +0 -1
- package/dist-cjs/commands/EnableKeyCommand.js.map +0 -1
- package/dist-cjs/commands/EnableKeyRotationCommand.js.map +0 -1
- package/dist-cjs/commands/EncryptCommand.js.map +0 -1
- package/dist-cjs/commands/GenerateDataKeyCommand.js.map +0 -1
- package/dist-cjs/commands/GenerateDataKeyPairCommand.js.map +0 -1
- package/dist-cjs/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +0 -1
- package/dist-cjs/commands/GenerateDataKeyWithoutPlaintextCommand.js.map +0 -1
- package/dist-cjs/commands/GenerateRandomCommand.js.map +0 -1
- package/dist-cjs/commands/GetKeyPolicyCommand.js.map +0 -1
- package/dist-cjs/commands/GetKeyRotationStatusCommand.js.map +0 -1
- package/dist-cjs/commands/GetParametersForImportCommand.js.map +0 -1
- package/dist-cjs/commands/GetPublicKeyCommand.js.map +0 -1
- package/dist-cjs/commands/ImportKeyMaterialCommand.js.map +0 -1
- package/dist-cjs/commands/ListAliasesCommand.js.map +0 -1
- package/dist-cjs/commands/ListGrantsCommand.js.map +0 -1
- package/dist-cjs/commands/ListKeyPoliciesCommand.js.map +0 -1
- package/dist-cjs/commands/ListKeysCommand.js.map +0 -1
- package/dist-cjs/commands/ListResourceTagsCommand.js.map +0 -1
- package/dist-cjs/commands/ListRetirableGrantsCommand.js.map +0 -1
- package/dist-cjs/commands/PutKeyPolicyCommand.js.map +0 -1
- package/dist-cjs/commands/ReEncryptCommand.js.map +0 -1
- package/dist-cjs/commands/ReplicateKeyCommand.js.map +0 -1
- package/dist-cjs/commands/RetireGrantCommand.js.map +0 -1
- package/dist-cjs/commands/RevokeGrantCommand.js.map +0 -1
- package/dist-cjs/commands/ScheduleKeyDeletionCommand.js.map +0 -1
- package/dist-cjs/commands/SignCommand.js.map +0 -1
- package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateAliasCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateCustomKeyStoreCommand.js.map +0 -1
- package/dist-cjs/commands/UpdateKeyDescriptionCommand.js.map +0 -1
- package/dist-cjs/commands/UpdatePrimaryRegionCommand.js.map +0 -1
- package/dist-cjs/commands/VerifyCommand.js.map +0 -1
- package/dist-cjs/endpoints.js.map +0 -1
- package/dist-cjs/index.js.map +0 -1
- package/dist-cjs/models/index.js.map +0 -1
- package/dist-cjs/models/models_0.js.map +0 -1
- package/dist-cjs/pagination/Interfaces.js.map +0 -1
- package/dist-cjs/pagination/ListAliasesPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListGrantsPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListKeyPoliciesPaginator.js.map +0 -1
- package/dist-cjs/pagination/ListKeysPaginator.js.map +0 -1
- package/dist-cjs/protocols/Aws_json1_1.js.map +0 -1
- package/dist-cjs/runtimeConfig.browser.js.map +0 -1
- package/dist-cjs/runtimeConfig.js.map +0 -1
- package/dist-cjs/runtimeConfig.native.js.map +0 -1
- package/dist-cjs/runtimeConfig.shared.js.map +0 -1
- package/dist-es/KMS.js.map +0 -1
- package/dist-es/KMSClient.js.map +0 -1
- package/dist-es/commands/CancelKeyDeletionCommand.js.map +0 -1
- package/dist-es/commands/ConnectCustomKeyStoreCommand.js.map +0 -1
- package/dist-es/commands/CreateAliasCommand.js.map +0 -1
- package/dist-es/commands/CreateCustomKeyStoreCommand.js.map +0 -1
- package/dist-es/commands/CreateGrantCommand.js.map +0 -1
- package/dist-es/commands/CreateKeyCommand.js.map +0 -1
- package/dist-es/commands/DecryptCommand.js.map +0 -1
- package/dist-es/commands/DeleteAliasCommand.js.map +0 -1
- package/dist-es/commands/DeleteCustomKeyStoreCommand.js.map +0 -1
- package/dist-es/commands/DeleteImportedKeyMaterialCommand.js.map +0 -1
- package/dist-es/commands/DescribeCustomKeyStoresCommand.js.map +0 -1
- package/dist-es/commands/DescribeKeyCommand.js.map +0 -1
- package/dist-es/commands/DisableKeyCommand.js.map +0 -1
- package/dist-es/commands/DisableKeyRotationCommand.js.map +0 -1
- package/dist-es/commands/DisconnectCustomKeyStoreCommand.js.map +0 -1
- package/dist-es/commands/EnableKeyCommand.js.map +0 -1
- package/dist-es/commands/EnableKeyRotationCommand.js.map +0 -1
- package/dist-es/commands/EncryptCommand.js.map +0 -1
- package/dist-es/commands/GenerateDataKeyCommand.js.map +0 -1
- package/dist-es/commands/GenerateDataKeyPairCommand.js.map +0 -1
- package/dist-es/commands/GenerateDataKeyPairWithoutPlaintextCommand.js.map +0 -1
- package/dist-es/commands/GenerateDataKeyWithoutPlaintextCommand.js.map +0 -1
- package/dist-es/commands/GenerateRandomCommand.js.map +0 -1
- package/dist-es/commands/GetKeyPolicyCommand.js.map +0 -1
- package/dist-es/commands/GetKeyRotationStatusCommand.js.map +0 -1
- package/dist-es/commands/GetParametersForImportCommand.js.map +0 -1
- package/dist-es/commands/GetPublicKeyCommand.js.map +0 -1
- package/dist-es/commands/ImportKeyMaterialCommand.js.map +0 -1
- package/dist-es/commands/ListAliasesCommand.js.map +0 -1
- package/dist-es/commands/ListGrantsCommand.js.map +0 -1
- package/dist-es/commands/ListKeyPoliciesCommand.js.map +0 -1
- package/dist-es/commands/ListKeysCommand.js.map +0 -1
- package/dist-es/commands/ListResourceTagsCommand.js.map +0 -1
- package/dist-es/commands/ListRetirableGrantsCommand.js.map +0 -1
- package/dist-es/commands/PutKeyPolicyCommand.js.map +0 -1
- package/dist-es/commands/ReEncryptCommand.js.map +0 -1
- package/dist-es/commands/ReplicateKeyCommand.js.map +0 -1
- package/dist-es/commands/RetireGrantCommand.js.map +0 -1
- package/dist-es/commands/RevokeGrantCommand.js.map +0 -1
- package/dist-es/commands/ScheduleKeyDeletionCommand.js.map +0 -1
- package/dist-es/commands/SignCommand.js.map +0 -1
- package/dist-es/commands/TagResourceCommand.js.map +0 -1
- package/dist-es/commands/UntagResourceCommand.js.map +0 -1
- package/dist-es/commands/UpdateAliasCommand.js.map +0 -1
- package/dist-es/commands/UpdateCustomKeyStoreCommand.js.map +0 -1
- package/dist-es/commands/UpdateKeyDescriptionCommand.js.map +0 -1
- package/dist-es/commands/UpdatePrimaryRegionCommand.js.map +0 -1
- package/dist-es/commands/VerifyCommand.js.map +0 -1
- package/dist-es/endpoints.js.map +0 -1
- package/dist-es/index.js.map +0 -1
- package/dist-es/models/index.js.map +0 -1
- package/dist-es/models/models_0.js.map +0 -1
- package/dist-es/pagination/Interfaces.js.map +0 -1
- package/dist-es/pagination/ListAliasesPaginator.js.map +0 -1
- package/dist-es/pagination/ListGrantsPaginator.js.map +0 -1
- package/dist-es/pagination/ListKeyPoliciesPaginator.js.map +0 -1
- package/dist-es/pagination/ListKeysPaginator.js.map +0 -1
- package/dist-es/protocols/Aws_json1_1.js.map +0 -1
- package/dist-es/runtimeConfig.browser.js.map +0 -1
- package/dist-es/runtimeConfig.js.map +0 -1
- package/dist-es/runtimeConfig.native.js.map +0 -1
- package/dist-es/runtimeConfig.shared.js.map +0 -1
- package/jest.config.js +0 -4
- package/src/KMS.ts +0 -4019
- package/src/KMSClient.ts +0 -516
- package/src/commands/CancelKeyDeletionCommand.ts +0 -106
- package/src/commands/ConnectCustomKeyStoreCommand.ts +0 -156
- package/src/commands/CreateAliasCommand.ts +0 -148
- package/src/commands/CreateCustomKeyStoreCommand.ts +0 -144
- package/src/commands/CreateGrantCommand.ts +0 -154
- package/src/commands/CreateKeyCommand.ts +0 -210
- package/src/commands/DecryptCommand.ts +0 -173
- package/src/commands/DeleteAliasCommand.ts +0 -138
- package/src/commands/DeleteCustomKeyStoreCommand.ts +0 -150
- package/src/commands/DeleteImportedKeyMaterialCommand.ts +0 -128
- package/src/commands/DescribeCustomKeyStoresCommand.ts +0 -148
- package/src/commands/DescribeKeyCommand.ts +0 -172
- package/src/commands/DisableKeyCommand.ts +0 -109
- package/src/commands/DisableKeyRotationCommand.ts +0 -119
- package/src/commands/DisconnectCustomKeyStoreCommand.ts +0 -145
- package/src/commands/EnableKeyCommand.ts +0 -98
- package/src/commands/EnableKeyRotationCommand.ts +0 -119
- package/src/commands/EncryptCommand.ts +0 -210
- package/src/commands/GenerateDataKeyCommand.ts +0 -189
- package/src/commands/GenerateDataKeyPairCommand.ts +0 -169
- package/src/commands/GenerateDataKeyPairWithoutPlaintextCommand.ts +0 -169
- package/src/commands/GenerateDataKeyWithoutPlaintextCommand.ts +0 -172
- package/src/commands/GenerateRandomCommand.ts +0 -103
- package/src/commands/GetKeyPolicyCommand.ts +0 -103
- package/src/commands/GetKeyRotationStatusCommand.ts +0 -131
- package/src/commands/GetParametersForImportCommand.ts +0 -130
- package/src/commands/GetPublicKeyCommand.ts +0 -139
- package/src/commands/ImportKeyMaterialCommand.ts +0 -158
- package/src/commands/ListAliasesCommand.ts +0 -134
- package/src/commands/ListGrantsCommand.ts +0 -140
- package/src/commands/ListKeyPoliciesCommand.ts +0 -117
- package/src/commands/ListKeysCommand.ts +0 -119
- package/src/commands/ListResourceTagsCommand.ts +0 -129
- package/src/commands/ListRetirableGrantsCommand.ts +0 -137
- package/src/commands/PutKeyPolicyCommand.ts +0 -108
- package/src/commands/ReEncryptCommand.ts +0 -180
- package/src/commands/ReplicateKeyCommand.ts +0 -172
- package/src/commands/RetireGrantCommand.ts +0 -139
- package/src/commands/RevokeGrantCommand.ts +0 -139
- package/src/commands/ScheduleKeyDeletionCommand.ts +0 -145
- package/src/commands/SignCommand.ts +0 -132
- package/src/commands/TagResourceCommand.ts +0 -140
- package/src/commands/UntagResourceCommand.ts +0 -138
- package/src/commands/UpdateAliasCommand.ts +0 -153
- package/src/commands/UpdateCustomKeyStoreCommand.ts +0 -167
- package/src/commands/UpdateKeyDescriptionCommand.ts +0 -118
- package/src/commands/UpdatePrimaryRegionCommand.ts +0 -160
- package/src/commands/VerifyCommand.ts +0 -118
- package/src/endpoints.ts +0 -62
- package/src/index.ts +0 -56
- package/src/models/index.ts +0 -1
- package/src/models/models_0.ts +0 -4742
- package/src/pagination/Interfaces.ts +0 -8
- package/src/pagination/ListAliasesPaginator.ts +0 -55
- package/src/pagination/ListGrantsPaginator.ts +0 -55
- package/src/pagination/ListKeyPoliciesPaginator.ts +0 -59
- package/src/pagination/ListKeysPaginator.ts +0 -55
- package/src/protocols/Aws_json1_1.ts +0 -7632
- package/src/runtimeConfig.browser.ts +0 -41
- package/src/runtimeConfig.native.ts +0 -17
- package/src/runtimeConfig.shared.ts +0 -17
- package/src/runtimeConfig.ts +0 -46
- package/tsconfig.es.json +0 -10
- package/tsconfig.json +0 -33
- package/tsconfig.types.json +0 -9
package/dist-types/KMS.d.ts
CHANGED
|
@@ -82,10 +82,11 @@ import { KMSClient } from "./KMSClient";
|
|
|
82
82
|
* <p>
|
|
83
83
|
* <b>Logging API Requests</b>
|
|
84
84
|
* </p>
|
|
85
|
-
* <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
85
|
+
* <p>KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your
|
|
86
|
+
* Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the
|
|
87
|
+
* information collected by CloudTrail, you can determine what requests were made to KMS, who made
|
|
88
|
+
* the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it
|
|
89
|
+
* on and find your log files, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/">CloudTrail User Guide</a>.</p>
|
|
89
90
|
* <p>
|
|
90
91
|
* <b>Additional Resources</b>
|
|
91
92
|
* </p>
|
|
@@ -93,9 +94,9 @@ import { KMSClient } from "./KMSClient";
|
|
|
93
94
|
* <ul>
|
|
94
95
|
* <li>
|
|
95
96
|
* <p>
|
|
96
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
|
|
97
|
-
* Credentials</a> - This topic provides general information about the types
|
|
98
|
-
* credentials used to access Amazon Web Services.</p>
|
|
97
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html">Amazon Web Services
|
|
98
|
+
* Security Credentials</a> - This topic provides general information about the types
|
|
99
|
+
* of credentials used to access Amazon Web Services.</p>
|
|
99
100
|
* </li>
|
|
100
101
|
* <li>
|
|
101
102
|
* <p>
|
|
@@ -141,13 +142,15 @@ import { KMSClient } from "./KMSClient";
|
|
|
141
142
|
*/
|
|
142
143
|
export declare class KMS extends KMSClient {
|
|
143
144
|
/**
|
|
144
|
-
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key
|
|
145
|
-
*
|
|
146
|
-
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
145
|
+
* <p>Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS
|
|
146
|
+
* key is <code>Disabled</code>. To enable the KMS key, use <a>EnableKey</a>. </p>
|
|
147
|
+
* <p>For more information about scheduling and canceling deletion of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
148
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
147
149
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
148
150
|
* 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>
|
|
149
151
|
* <p>
|
|
150
|
-
* <b>Cross-account
|
|
152
|
+
* <b>Cross-account
|
|
153
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
151
154
|
* <p>
|
|
152
155
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CancelKeyDeletion</a> (key policy)</p>
|
|
153
156
|
* <p>
|
|
@@ -159,9 +162,9 @@ export declare class KMS extends KMSClient {
|
|
|
159
162
|
cancelKeyDeletion(args: CancelKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelKeyDeletionCommandOutput) => void): void;
|
|
160
163
|
/**
|
|
161
164
|
* <p>Connects or reconnects a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> to its associated CloudHSM cluster.</p>
|
|
162
|
-
* <p>The custom key store must be connected before you can create KMS keys
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
+
* <p>The custom key store must be connected before you can create KMS keys in the key store or
|
|
166
|
+
* use the KMS keys it contains. You can disconnect and reconnect a custom key store at any
|
|
167
|
+
* time.</p>
|
|
165
168
|
* <p>To connect a custom key store, its associated CloudHSM cluster must have at least one active
|
|
166
169
|
* HSM. To get the number of active HSMs in a cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html">DescribeClusters</a> operation. To add HSMs
|
|
167
170
|
* to the cluster, use the <a href="https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html">CreateHsm</a> operation. Also, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
@@ -230,11 +233,12 @@ export declare class KMS extends KMSClient {
|
|
|
230
233
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
231
234
|
* </note>
|
|
232
235
|
* <p>You can use an alias to identify a KMS key in the KMS console, in the <a>DescribeKey</a> operation and in <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>, such as <a>Encrypt</a> and
|
|
233
|
-
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
|
|
234
|
-
* alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
|
|
235
|
-
* any time. These operations don't affect the underlying KMS key. </p>
|
|
236
|
+
* <a>GenerateDataKey</a>. You can also change the KMS key that's associated with
|
|
237
|
+
* the alias (<a>UpdateAlias</a>) or delete the alias (<a>DeleteAlias</a>)
|
|
238
|
+
* at any time. These operations don't affect the underlying KMS key. </p>
|
|
236
239
|
* <p>You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each
|
|
237
|
-
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
|
|
240
|
+
* alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases.
|
|
241
|
+
* A valid KMS key is required. You can't create an alias without a KMS key.</p>
|
|
238
242
|
* <p>The alias must be unique in the account and Region, but you can have aliases with the same
|
|
239
243
|
* name in different Regions. For detailed information about aliases, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html">Using aliases</a> in the
|
|
240
244
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -251,14 +255,17 @@ export declare class KMS extends KMSClient {
|
|
|
251
255
|
* <ul>
|
|
252
256
|
* <li>
|
|
253
257
|
* <p>
|
|
254
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
258
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
259
|
+
* the alias (IAM policy).</p>
|
|
255
260
|
* </li>
|
|
256
261
|
* <li>
|
|
257
262
|
* <p>
|
|
258
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
263
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateAlias</a> on
|
|
264
|
+
* the KMS key (key policy).</p>
|
|
259
265
|
* </li>
|
|
260
266
|
* </ul>
|
|
261
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
267
|
+
* <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
|
|
268
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
262
269
|
* <p>
|
|
263
270
|
* <b>Related operations:</b>
|
|
264
271
|
* </p>
|
|
@@ -340,7 +347,9 @@ export declare class KMS extends KMSClient {
|
|
|
340
347
|
createCustomKeyStore(args: CreateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomKeyStoreCommandOutput) => void): void;
|
|
341
348
|
/**
|
|
342
349
|
* <p>Adds a grant to a KMS key. </p>
|
|
343
|
-
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
350
|
+
* <p>A <i>grant</i> is a policy instrument that allows Amazon Web Services principals to use
|
|
351
|
+
* KMS keys in cryptographic operations. It also can allow them to view a KMS key (<a>DescribeKey</a>) and create and manage grants. When authorizing access to a KMS key,
|
|
352
|
+
* grants are considered along with key policies and IAM policies. Grants are often used for
|
|
344
353
|
* temporary permissions because you can create one, use its permissions, and delete it without
|
|
345
354
|
* changing your key policies or IAM policies. </p>
|
|
346
355
|
* <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
|
|
@@ -349,28 +358,29 @@ export declare class KMS extends KMSClient {
|
|
|
349
358
|
* </i>. For examples of working with grants in several
|
|
350
359
|
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
351
360
|
* <p>The <code>CreateGrant</code> operation returns a <code>GrantToken</code> and a
|
|
352
|
-
*
|
|
361
|
+
* <code>GrantId</code>.</p>
|
|
353
362
|
* <ul>
|
|
354
363
|
* <li>
|
|
355
|
-
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee
|
|
356
|
-
*
|
|
364
|
+
* <p>When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as <i>eventual consistency</i>. Once the grant has achieved eventual consistency, the grantee
|
|
365
|
+
* principal can use the permissions in the grant without identifying the grant. </p>
|
|
357
366
|
* <p>However, to use the permissions in the grant immediately, use the
|
|
358
|
-
*
|
|
359
|
-
* token</a> in the <i>
|
|
367
|
+
* <code>GrantToken</code> that <code>CreateGrant</code> returns. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token">Using a
|
|
368
|
+
* grant token</a> in the <i>
|
|
360
369
|
* <i>Key Management Service Developer Guide</i>
|
|
361
370
|
* </i>.</p>
|
|
362
371
|
* </li>
|
|
363
372
|
* <li>
|
|
364
|
-
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can
|
|
365
|
-
*
|
|
366
|
-
*
|
|
367
|
-
*
|
|
373
|
+
* <p>The <code>CreateGrant</code> operation also returns a <code>GrantId</code>. You can
|
|
374
|
+
* use the <code>GrantId</code> and a key identifier to identify the grant in the <a>RetireGrant</a> and <a>RevokeGrant</a> operations. To find the grant
|
|
375
|
+
* ID, use the <a>ListGrants</a> or <a>ListRetirableGrants</a>
|
|
376
|
+
* operations.</p>
|
|
368
377
|
* </li>
|
|
369
378
|
* </ul>
|
|
370
379
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
371
380
|
* 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>
|
|
372
381
|
* <p>
|
|
373
|
-
* <b>Cross-account use</b>: Yes.
|
|
382
|
+
* <b>Cross-account use</b>: Yes.
|
|
383
|
+
* To perform this operation on a KMS key in a different Amazon Web Services account, specify the key
|
|
374
384
|
* ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
375
385
|
* <p>
|
|
376
386
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateGrant</a> (key policy)</p>
|
|
@@ -404,20 +414,21 @@ export declare class KMS extends KMSClient {
|
|
|
404
414
|
createGrant(args: CreateGrantCommandInput, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
405
415
|
createGrant(args: CreateGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGrantCommandOutput) => void): void;
|
|
406
416
|
/**
|
|
407
|
-
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and
|
|
417
|
+
* <p>Creates a unique customer managed <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys">KMS key</a> in your Amazon Web Services account and
|
|
418
|
+
* Region.</p>
|
|
408
419
|
* <note>
|
|
409
420
|
* <p>KMS is replacing the term <i>customer master key (CMK)</i> with <i>KMS key</i> and <i>KMS key</i>. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.</p>
|
|
410
421
|
* </note>
|
|
411
422
|
*
|
|
412
|
-
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS
|
|
423
|
+
* <p>You can use the <code>CreateKey</code> operation to create symmetric or asymmetric KMS
|
|
424
|
+
* keys.</p>
|
|
413
425
|
* <ul>
|
|
414
426
|
* <li>
|
|
415
427
|
* <p>
|
|
416
|
-
* <b>Symmetric KMS keys</b> contain a 256-bit symmetric key
|
|
417
|
-
* never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use
|
|
418
|
-
* symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically
|
|
419
|
-
* generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data
|
|
420
|
-
* keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
|
|
428
|
+
* <b>Symmetric KMS keys</b> contain a 256-bit symmetric key
|
|
429
|
+
* that never leaves KMS unencrypted. To use the KMS key, you must call KMS. You can use
|
|
430
|
+
* a symmetric KMS key to encrypt and decrypt small amounts of data, but they are typically
|
|
431
|
+
* used to generate <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys">data keys</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs">data keys pairs</a>. For details,
|
|
421
432
|
* see <a>GenerateDataKey</a> and <a>GenerateDataKeyPair</a>.</p>
|
|
422
433
|
* </li>
|
|
423
434
|
* <li>
|
|
@@ -425,9 +436,9 @@ export declare class KMS extends KMSClient {
|
|
|
425
436
|
* <b>Asymmetric KMS keys</b> can contain an RSA key pair or an
|
|
426
437
|
* Elliptic Curve (ECC) key pair. The private key in an asymmetric KMS key never leaves KMS
|
|
427
438
|
* unencrypted. However, you can use the <a>GetPublicKey</a> operation to download
|
|
428
|
-
* the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used
|
|
429
|
-
* encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC
|
|
430
|
-
* pairs can be used only to sign and verify messages.</p>
|
|
439
|
+
* the public key so it can be used outside of KMS. KMS keys with RSA key pairs can be used
|
|
440
|
+
* to encrypt or decrypt data or sign and verify messages (but not both). KMS keys with ECC
|
|
441
|
+
* key pairs can be used only to sign and verify messages.</p>
|
|
431
442
|
* </li>
|
|
432
443
|
* </ul>
|
|
433
444
|
* <p>For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -458,8 +469,8 @@ export declare class KMS extends KMSClient {
|
|
|
458
469
|
* <dd>
|
|
459
470
|
* <p>To create a multi-Region <i>primary key</i> in the local Amazon Web Services Region,
|
|
460
471
|
* use the <code>MultiRegion</code> parameter with a value of <code>True</code>. To create
|
|
461
|
-
* a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID
|
|
462
|
-
* key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its
|
|
472
|
+
* a multi-Region <i>replica key</i>, that is, a KMS key with the same key ID
|
|
473
|
+
* and key material as a primary key, but in a different Amazon Web Services Region, use the <a>ReplicateKey</a> operation. To change a replica key to a primary key, and its
|
|
463
474
|
* primary key to a replica key, use the <a>UpdatePrimaryRegion</a>
|
|
464
475
|
* operation.</p>
|
|
465
476
|
* <p>This operation supports <i>multi-Region keys</i>, an KMS feature that lets you create multiple
|
|
@@ -500,13 +511,14 @@ export declare class KMS extends KMSClient {
|
|
|
500
511
|
* </dd>
|
|
501
512
|
* </dl>
|
|
502
513
|
* <p>
|
|
503
|
-
* <b>Cross-account use</b>:
|
|
514
|
+
* <b>Cross-account use</b>: No. You cannot use this operation to
|
|
504
515
|
* create a KMS key in a different Amazon Web Services account.</p>
|
|
505
516
|
*
|
|
506
517
|
* <p>
|
|
507
518
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:CreateKey</a> (IAM policy). To use the
|
|
508
519
|
* <code>Tags</code> parameter, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (IAM policy). For examples and information about related
|
|
509
|
-
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create
|
|
520
|
+
* permissions, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key">Allow a user to create
|
|
521
|
+
* KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
510
522
|
* <p>
|
|
511
523
|
* <b>Related operations:</b>
|
|
512
524
|
* </p>
|
|
@@ -532,8 +544,8 @@ export declare class KMS extends KMSClient {
|
|
|
532
544
|
createKey(args: CreateKeyCommandInput, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
533
545
|
createKey(args: CreateKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateKeyCommandOutput) => void): void;
|
|
534
546
|
/**
|
|
535
|
-
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of
|
|
536
|
-
*
|
|
547
|
+
* <p>Decrypts ciphertext that was encrypted by a KMS key using any of the following
|
|
548
|
+
* operations:</p>
|
|
537
549
|
* <ul>
|
|
538
550
|
* <li>
|
|
539
551
|
* <p>
|
|
@@ -562,33 +574,36 @@ export declare class KMS extends KMSClient {
|
|
|
562
574
|
* </li>
|
|
563
575
|
* </ul>
|
|
564
576
|
* <p>You can use this operation to decrypt ciphertext that was encrypted under a symmetric or
|
|
565
|
-
* asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the
|
|
566
|
-
* algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
577
|
+
* asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the
|
|
578
|
+
* encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
567
579
|
* <p>The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the
|
|
568
|
-
* public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by
|
|
569
|
-
* libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services
|
|
570
|
-
* SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
|
|
571
|
-
* is incompatible with KMS.</p>
|
|
572
|
-
* <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code>
|
|
573
|
-
* optional. KMS can get this information from metadata that it adds to the
|
|
574
|
-
* ciphertext blob. This feature adds durability to your implementation by ensuring
|
|
575
|
-
* authorized users can decrypt ciphertext decades after it was encrypted, even if they've
|
|
576
|
-
* track of the key ID. However, specifying the KMS key is always recommended as a best
|
|
577
|
-
* When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses
|
|
578
|
-
* specify. If the ciphertext was encrypted under a different KMS key, the
|
|
579
|
-
*
|
|
580
|
+
* public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by
|
|
581
|
+
* other libraries, such as the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services
|
|
582
|
+
* Encryption SDK</a> or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3 client-side encryption</a>.
|
|
583
|
+
* These libraries return a ciphertext format that is incompatible with KMS.</p>
|
|
584
|
+
* <p>If the ciphertext was encrypted under a symmetric KMS key, the <code>KeyId</code>
|
|
585
|
+
* parameter is optional. KMS can get this information from metadata that it adds to the
|
|
586
|
+
* symmetric ciphertext blob. This feature adds durability to your implementation by ensuring
|
|
587
|
+
* that authorized users can decrypt ciphertext decades after it was encrypted, even if they've
|
|
588
|
+
* lost track of the key ID. However, specifying the KMS key is always recommended as a best
|
|
589
|
+
* practice. When you use the <code>KeyId</code> parameter to specify a KMS key, KMS only uses
|
|
590
|
+
* the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the
|
|
591
|
+
* <code>Decrypt</code> operation fails. This practice ensures that you use the KMS key that
|
|
592
|
+
* you intend.</p>
|
|
580
593
|
* <p>Whenever possible, use key policies to give users permission to call the
|
|
581
594
|
* <code>Decrypt</code> operation on a particular KMS key, instead of using IAM policies.
|
|
582
595
|
* Otherwise, you might create an IAM user policy that gives the user <code>Decrypt</code>
|
|
583
|
-
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys
|
|
584
|
-
* accounts if the key policy for the cross-account KMS key permits it. If you must use
|
|
585
|
-
* for <code>Decrypt</code> permissions, limit the user to particular KMS keys or
|
|
586
|
-
* accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM
|
|
596
|
+
* permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys
|
|
597
|
+
* in other accounts if the key policy for the cross-account KMS key permits it. If you must use
|
|
598
|
+
* an IAM policy for <code>Decrypt</code> permissions, limit the user to particular KMS keys or
|
|
599
|
+
* particular trusted accounts. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policies-best-practices">Best practices for IAM
|
|
600
|
+
* policies</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
587
601
|
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
588
602
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
589
603
|
* details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
590
604
|
* <p>
|
|
591
|
-
* <b>Cross-account
|
|
605
|
+
* <b>Cross-account
|
|
606
|
+
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
592
607
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter. </p>
|
|
593
608
|
*
|
|
594
609
|
* <p>
|
|
@@ -623,14 +638,15 @@ export declare class KMS extends KMSClient {
|
|
|
623
638
|
decrypt(args: DecryptCommandInput, cb: (err: any, data?: DecryptCommandOutput) => void): void;
|
|
624
639
|
decrypt(args: DecryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DecryptCommandOutput) => void): void;
|
|
625
640
|
/**
|
|
626
|
-
* <p>Deletes the specified alias.
|
|
641
|
+
* <p>Deletes the specified alias. </p>
|
|
627
642
|
* <note>
|
|
628
643
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
629
644
|
* </note>
|
|
630
|
-
* <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of
|
|
645
|
+
* <p>Because an alias is not a property of a KMS key, you can delete and change the aliases of
|
|
646
|
+
* a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the
|
|
647
|
+
* <a>DescribeKey</a> operation. To get the aliases of all KMS keys, use the <a>ListAliases</a> operation. </p>
|
|
631
648
|
* <p>Each KMS key can have multiple aliases. To change the alias of a KMS key, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to
|
|
632
|
-
* create a new alias. To associate an existing alias with a different KMS key,
|
|
633
|
-
* call <a>UpdateAlias</a>.</p>
|
|
649
|
+
* create a new alias. To associate an existing alias with a different KMS key, call <a>UpdateAlias</a>.</p>
|
|
634
650
|
* <p>
|
|
635
651
|
* <b>Cross-account use</b>: No. You cannot perform this operation on an alias in a different Amazon Web Services account.</p>
|
|
636
652
|
* <p>
|
|
@@ -639,14 +655,17 @@ export declare class KMS extends KMSClient {
|
|
|
639
655
|
* <ul>
|
|
640
656
|
* <li>
|
|
641
657
|
* <p>
|
|
642
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
|
|
658
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
|
|
659
|
+
* the alias (IAM policy).</p>
|
|
643
660
|
* </li>
|
|
644
661
|
* <li>
|
|
645
662
|
* <p>
|
|
646
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
|
|
663
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:DeleteAlias</a> on
|
|
664
|
+
* the KMS key (key policy).</p>
|
|
647
665
|
* </li>
|
|
648
666
|
* </ul>
|
|
649
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
667
|
+
* <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
|
|
668
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
650
669
|
* <p>
|
|
651
670
|
* <b>Related operations:</b>
|
|
652
671
|
* </p>
|
|
@@ -674,16 +693,15 @@ export declare class KMS extends KMSClient {
|
|
|
674
693
|
/**
|
|
675
694
|
* <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
|
|
676
695
|
* associated with the custom key store, or affect any users or keys in the cluster.</p>
|
|
677
|
-
* <p>The custom key store that you delete cannot contain any KMS <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys">KMS keys</a>. Before
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
683
|
-
* manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
696
|
+
* <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 deleting the key store,
|
|
697
|
+
* verify that you will never need to use any of the KMS keys in the key store for any
|
|
698
|
+
* <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 KMS keys from the
|
|
699
|
+
* key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code>
|
|
700
|
+
* operation deletes the KMS keys. Then it makes a best effort to delete the key material from
|
|
701
|
+
* the associated cluster. However, you might need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
684
702
|
* material</a> from the cluster and its backups.</p>
|
|
685
|
-
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a>
|
|
686
|
-
* disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
703
|
+
* <p>After all KMS keys are deleted from KMS, use <a>DisconnectCustomKeyStore</a>
|
|
704
|
+
* to disconnect the key store from KMS. Then, you can delete the custom key store.</p>
|
|
687
705
|
* <p>Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from KMS. While the key store is
|
|
688
706
|
* disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to
|
|
689
707
|
* delete KMS keys and you can reconnect a disconnected custom key store at any time.</p>
|
|
@@ -692,9 +710,9 @@ export declare class KMS extends KMSClient {
|
|
|
692
710
|
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
693
711
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
694
712
|
* single-tenant key store.</p>
|
|
695
|
-
*
|
|
696
713
|
* <p>
|
|
697
|
-
* <b>Cross-account use</b>: No.
|
|
714
|
+
* <b>Cross-account use</b>: No.
|
|
715
|
+
* You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
698
716
|
*
|
|
699
717
|
* <p>
|
|
700
718
|
* <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>
|
|
@@ -733,12 +751,11 @@ export declare class KMS extends KMSClient {
|
|
|
733
751
|
deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
|
|
734
752
|
deleteCustomKeyStore(args: DeleteCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomKeyStoreCommandOutput) => void): void;
|
|
735
753
|
/**
|
|
736
|
-
* <p>Deletes key material that you previously imported. This operation makes the specified
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
* not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
754
|
+
* <p>Deletes key material that you previously imported. This operation makes the specified KMS
|
|
755
|
+
* key unusable. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
|
|
756
|
+
* in the <i>Key Management Service Developer Guide</i>. </p>
|
|
757
|
+
* <p>When the specified KMS key is in the <code>PendingDeletion</code> state, this operation
|
|
758
|
+
* does not change the KMS key's state. Otherwise, it changes the KMS key's state to
|
|
742
759
|
* <code>PendingImport</code>.</p>
|
|
743
760
|
* <p>After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport
|
|
744
761
|
* the same key material into the KMS key.</p>
|
|
@@ -773,10 +790,10 @@ export declare class KMS extends KMSClient {
|
|
|
773
790
|
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
774
791
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
775
792
|
* single-tenant key store.</p>
|
|
776
|
-
* <p>By default, this operation returns information about all custom key
|
|
777
|
-
* Region. To get only information about a particular custom key store,
|
|
778
|
-
*
|
|
779
|
-
* both).</p>
|
|
793
|
+
* <p>By default, this operation returns information about all custom key
|
|
794
|
+
* stores in the account and Region. To get only information about a particular custom key store,
|
|
795
|
+
* use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but
|
|
796
|
+
* not both).</p>
|
|
780
797
|
* <p>To determine whether the custom key store is connected to its CloudHSM cluster, use the
|
|
781
798
|
* <code>ConnectionState</code> element in the response. If an attempt to connect the custom
|
|
782
799
|
* key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the
|
|
@@ -828,16 +845,17 @@ export declare class KMS extends KMSClient {
|
|
|
828
845
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
829
846
|
describeCustomKeyStores(args: DescribeCustomKeyStoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomKeyStoresCommandOutput) => void): void;
|
|
830
847
|
/**
|
|
831
|
-
* <p>Provides detailed information about a KMS key. You can run
|
|
832
|
-
* <
|
|
848
|
+
* <p>Provides detailed information about a KMS key. You can run <code>DescribeKey</code> on a
|
|
849
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed
|
|
850
|
+
* 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>
|
|
833
851
|
* <p>This detailed information includes the key ARN, creation date (and deletion date, if
|
|
834
852
|
* applicable), the key state, and the origin and expiration date (if any) of the key material.
|
|
835
853
|
* It includes fields, like <code>KeySpec</code>, that help you distinguish symmetric from
|
|
836
854
|
* asymmetric KMS keys. It also provides information that is particularly important to asymmetric
|
|
837
855
|
* keys, such as the key usage (encryption or signing) and the encryption algorithms or signing
|
|
838
|
-
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
|
|
839
|
-
* the custom key store, such as the key store ID and the CloudHSM cluster ID. For
|
|
840
|
-
* keys, it displays the primary key and all related replica keys. </p>
|
|
856
|
+
* algorithms that the KMS key supports. For KMS keys in custom key stores, it includes
|
|
857
|
+
* information about the custom key store, such as the key store ID and the CloudHSM cluster ID. For
|
|
858
|
+
* multi-Region keys, it displays the primary key and all related replica keys. </p>
|
|
841
859
|
* <p>
|
|
842
860
|
* <code>DescribeKey</code> does not return the following information:</p>
|
|
843
861
|
* <ul>
|
|
@@ -846,8 +864,8 @@ export declare class KMS extends KMSClient {
|
|
|
846
864
|
* </li>
|
|
847
865
|
* <li>
|
|
848
866
|
* <p>Whether automatic key rotation is enabled on the KMS key. To get this information, use
|
|
849
|
-
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
|
|
850
|
-
* automatically rotated. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works">How Automatic Key Rotation
|
|
867
|
+
* <a>GetKeyRotationStatus</a>. Also, some key states prevent a KMS key from
|
|
868
|
+
* being 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
|
|
851
869
|
* Works</a> in <i>Key Management Service Developer Guide</i>.</p>
|
|
852
870
|
* </li>
|
|
853
871
|
* <li>
|
|
@@ -857,9 +875,10 @@ export declare class KMS extends KMSClient {
|
|
|
857
875
|
* <p>Key policies and grants on the KMS key. To get this information, use <a>GetKeyPolicy</a> and <a>ListGrants</a>.</p>
|
|
858
876
|
* </li>
|
|
859
877
|
* </ul>
|
|
860
|
-
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
|
|
861
|
-
*
|
|
862
|
-
*
|
|
878
|
+
* <p>If you call the <code>DescribeKey</code> operation on a <i>predefined Amazon Web Services
|
|
879
|
+
* 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
|
|
880
|
+
* key</a>. Then, it associates the alias with the new KMS key, and returns the
|
|
881
|
+
* <code>KeyId</code> and <code>Arn</code> of the new KMS key in the response.</p>
|
|
863
882
|
* <p>
|
|
864
883
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
865
884
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
@@ -911,14 +930,15 @@ export declare class KMS extends KMSClient {
|
|
|
911
930
|
describeKey(args: DescribeKeyCommandInput, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
912
931
|
describeKey(args: DescribeKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyCommandOutput) => void): void;
|
|
913
932
|
/**
|
|
914
|
-
* <p>Sets the state of a KMS key to disabled. This change temporarily
|
|
915
|
-
*
|
|
916
|
-
* <p>For more information about how key state affects the use of a KMS key, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key state: Effect on your KMS
|
|
933
|
+
* <p>Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS
|
|
934
|
+
* key for <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
935
|
+
* <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
|
|
936
|
+
* key</a> in the <i>
|
|
917
937
|
* <i>Key Management Service Developer Guide</i>
|
|
918
938
|
* </i>.</p>
|
|
919
939
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
920
940
|
* 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>
|
|
921
|
-
*
|
|
941
|
+
* <p>
|
|
922
942
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
923
943
|
*
|
|
924
944
|
* <p>
|
|
@@ -937,7 +957,8 @@ export declare class KMS extends KMSClient {
|
|
|
937
957
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
938
958
|
* 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>
|
|
939
959
|
* <p>
|
|
940
|
-
* <b>Cross-account
|
|
960
|
+
* <b>Cross-account
|
|
961
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
941
962
|
*
|
|
942
963
|
* <p>
|
|
943
964
|
* <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>
|
|
@@ -962,8 +983,9 @@ export declare class KMS extends KMSClient {
|
|
|
962
983
|
disableKeyRotation(args: DisableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisableKeyRotationCommandOutput) => void): void;
|
|
963
984
|
/**
|
|
964
985
|
* <p>Disconnects the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a> from its associated CloudHSM cluster. While a custom key
|
|
965
|
-
* store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
|
|
966
|
-
* custom key store at any
|
|
986
|
+
* store is disconnected, you can manage the custom key store and its KMS keys, but you cannot
|
|
987
|
+
* create or use KMS keys in the custom key store. You can reconnect the custom key store at any
|
|
988
|
+
* time.</p>
|
|
967
989
|
* <note>
|
|
968
990
|
* <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
|
|
969
991
|
* fail. This action can prevent users from storing and accessing sensitive data.</p>
|
|
@@ -977,8 +999,9 @@ export declare class KMS extends KMSClient {
|
|
|
977
999
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
978
1000
|
* single-tenant key store.</p>
|
|
979
1001
|
*
|
|
980
|
-
*
|
|
981
|
-
* <b>Cross-account use</b>: No.
|
|
1002
|
+
* <p>
|
|
1003
|
+
* <b>Cross-account use</b>: No.
|
|
1004
|
+
* You cannot perform this operation on a custom key store in a different Amazon Web Services account.</p>
|
|
982
1005
|
*
|
|
983
1006
|
* <p>
|
|
984
1007
|
* <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>
|
|
@@ -1017,11 +1040,13 @@ export declare class KMS extends KMSClient {
|
|
|
1017
1040
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1018
1041
|
disconnectCustomKeyStore(args: DisconnectCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisconnectCustomKeyStoreCommandOutput) => void): void;
|
|
1019
1042
|
/**
|
|
1020
|
-
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
1043
|
+
* <p>Sets the key state of a KMS key to enabled. This allows you to use the KMS key for
|
|
1044
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations">cryptographic operations</a>. </p>
|
|
1021
1045
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1022
1046
|
* 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>
|
|
1023
1047
|
* <p>
|
|
1024
|
-
* <b>Cross-account
|
|
1048
|
+
* <b>Cross-account
|
|
1049
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1025
1050
|
*
|
|
1026
1051
|
* <p>
|
|
1027
1052
|
* <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>
|
|
@@ -1039,7 +1064,8 @@ export declare class KMS extends KMSClient {
|
|
|
1039
1064
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1040
1065
|
* 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>
|
|
1041
1066
|
* <p>
|
|
1042
|
-
* <b>Cross-account
|
|
1067
|
+
* <b>Cross-account
|
|
1068
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1043
1069
|
*
|
|
1044
1070
|
* <p>
|
|
1045
1071
|
* <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>
|
|
@@ -1063,19 +1089,20 @@ export declare class KMS extends KMSClient {
|
|
|
1063
1089
|
enableKeyRotation(args: EnableKeyRotationCommandInput, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1064
1090
|
enableKeyRotation(args: EnableKeyRotationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EnableKeyRotationCommandOutput) => void): void;
|
|
1065
1091
|
/**
|
|
1066
|
-
* <p>Encrypts plaintext into ciphertext by using a KMS key. The
|
|
1067
|
-
*
|
|
1092
|
+
* <p>Encrypts plaintext into ciphertext by using a KMS key. The <code>Encrypt</code> operation
|
|
1093
|
+
* has two primary use cases:</p>
|
|
1068
1094
|
* <ul>
|
|
1069
1095
|
* <li>
|
|
1070
1096
|
* <p>You can encrypt small amounts of arbitrary data, such as a personal identifier or
|
|
1071
1097
|
* database password, or other sensitive information. </p>
|
|
1072
1098
|
* </li>
|
|
1073
1099
|
* <li>
|
|
1074
|
-
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services
|
|
1075
|
-
*
|
|
1076
|
-
*
|
|
1077
|
-
*
|
|
1078
|
-
* the encrypted data
|
|
1100
|
+
* <p>You can use the <code>Encrypt</code> operation to move encrypted data from one Amazon Web Services
|
|
1101
|
+
* Region to another. For example, in Region A, generate a data key and use the plaintext key
|
|
1102
|
+
* to encrypt your data. Then, in Region A, use the <code>Encrypt</code> operation to encrypt
|
|
1103
|
+
* the plaintext data key under a KMS key in Region B. Now, you can move the encrypted data
|
|
1104
|
+
* and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data
|
|
1105
|
+
* key and the encrypted data entirely within in Region B.</p>
|
|
1079
1106
|
* </li>
|
|
1080
1107
|
* </ul>
|
|
1081
1108
|
*
|
|
@@ -1086,10 +1113,10 @@ export declare class KMS extends KMSClient {
|
|
|
1086
1113
|
* encryption operation. The KMS key must have a <code>KeyUsage</code> value of
|
|
1087
1114
|
* <code>ENCRYPT_DECRYPT.</code> To find the <code>KeyUsage</code> of a KMS key, use the <a>DescribeKey</a> operation. </p>
|
|
1088
1115
|
*
|
|
1089
|
-
* <p>If you use a symmetric KMS key, you can use an encryption context to add additional
|
|
1090
|
-
* to your encryption operation. If you specify an <code>EncryptionContext</code> when
|
|
1091
|
-
* data, you must specify the same encryption context (a case-sensitive exact match)
|
|
1092
|
-
* decrypting the data. Otherwise, the request to decrypt fails with an
|
|
1116
|
+
* <p>If you use a symmetric KMS key, you can use an encryption context to add additional
|
|
1117
|
+
* security to your encryption operation. If you specify an <code>EncryptionContext</code> when
|
|
1118
|
+
* encrypting data, you must specify the same encryption context (a case-sensitive exact match)
|
|
1119
|
+
* when decrypting the data. Otherwise, the request to decrypt fails with an
|
|
1093
1120
|
* <code>InvalidCiphertextException</code>. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">Encryption
|
|
1094
1121
|
* Context</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1095
1122
|
* <p>If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The
|
|
@@ -1161,7 +1188,8 @@ export declare class KMS extends KMSClient {
|
|
|
1161
1188
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1162
1189
|
* 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>
|
|
1163
1190
|
* <p>
|
|
1164
|
-
* <b>Cross-account use</b>: Yes.
|
|
1191
|
+
* <b>Cross-account use</b>: Yes.
|
|
1192
|
+
* To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1165
1193
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1166
1194
|
*
|
|
1167
1195
|
* <p>
|
|
@@ -1192,19 +1220,19 @@ export declare class KMS extends KMSClient {
|
|
|
1192
1220
|
encrypt(args: EncryptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EncryptCommandOutput) => void): void;
|
|
1193
1221
|
/**
|
|
1194
1222
|
* <p>Generates a unique symmetric data key for client-side encryption. This operation returns a
|
|
1195
|
-
* plaintext copy of the data key and a copy that is encrypted under a KMS key
|
|
1196
|
-
*
|
|
1197
|
-
*
|
|
1223
|
+
* plaintext copy of the data key and a copy that is encrypted under a KMS key that you specify.
|
|
1224
|
+
* You can use the plaintext key to encrypt your data outside of KMS and store the encrypted
|
|
1225
|
+
* data key with the encrypted data.</p>
|
|
1198
1226
|
*
|
|
1199
1227
|
* <p>
|
|
1200
1228
|
* <code>GenerateDataKey</code> returns a unique data key for each request. The bytes in the
|
|
1201
1229
|
* plaintext key are not related to the caller or the KMS key.</p>
|
|
1202
1230
|
*
|
|
1203
|
-
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the
|
|
1204
|
-
* key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your
|
|
1205
|
-
* the <a>DescribeKey</a> operation. You must also specify the length of
|
|
1206
|
-
* Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters
|
|
1207
|
-
* For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
1231
|
+
* <p>To generate a data key, specify the symmetric KMS key that will be used to encrypt the
|
|
1232
|
+
* data key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your
|
|
1233
|
+
* KMS key, use the <a>DescribeKey</a> operation. You must also specify the length of
|
|
1234
|
+
* the data key. Use either the <code>KeySpec</code> or <code>NumberOfBytes</code> parameters
|
|
1235
|
+
* (but not both). For 128-bit and 256-bit data keys, use the <code>KeySpec</code> parameter. </p>
|
|
1208
1236
|
*
|
|
1209
1237
|
* <p>To get only an encrypted copy of the data key, use <a>GenerateDataKeyWithoutPlaintext</a>. To generate an asymmetric data key pair, use
|
|
1210
1238
|
* the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a> operation. To get a cryptographically secure
|
|
@@ -1219,11 +1247,14 @@ export declare class KMS extends KMSClient {
|
|
|
1219
1247
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1220
1248
|
* 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>
|
|
1221
1249
|
* <p>
|
|
1222
|
-
* <b>How to use your data
|
|
1250
|
+
* <b>How to use your data
|
|
1251
|
+
* key</b>
|
|
1223
1252
|
* </p>
|
|
1224
|
-
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
1225
|
-
* You can write your own code or use a client-side encryption library, such as the
|
|
1226
|
-
* <a href="https://docs.aws.amazon.com/
|
|
1253
|
+
* <p>We recommend that you use the following pattern to encrypt data locally in your
|
|
1254
|
+
* application. You can write your own code or use a client-side encryption library, such as the
|
|
1255
|
+
* <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a>, the
|
|
1256
|
+
* <a href="https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/">Amazon DynamoDB Encryption Client</a>,
|
|
1257
|
+
* or <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
1227
1258
|
* client-side encryption</a> to do these tasks for you.</p>
|
|
1228
1259
|
* <p>To encrypt data outside of KMS:</p>
|
|
1229
1260
|
* <ol>
|
|
@@ -1293,20 +1324,21 @@ export declare class KMS extends KMSClient {
|
|
|
1293
1324
|
/**
|
|
1294
1325
|
* <p>Generates a unique asymmetric data key pair. The <code>GenerateDataKeyPair</code>
|
|
1295
1326
|
* operation returns a plaintext public key, a plaintext private key, and a copy of the private
|
|
1296
|
-
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair
|
|
1297
|
-
* perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
1327
|
+
* key that is encrypted under the symmetric KMS key you specify. You can use the data key pair
|
|
1328
|
+
* to perform asymmetric cryptography and implement digital signatures outside of KMS.</p>
|
|
1298
1329
|
*
|
|
1299
1330
|
* <p>You can use the public key that <code>GenerateDataKeyPair</code> returns to encrypt data
|
|
1300
1331
|
* or verify a signature outside of KMS. Then, store the encrypted private key with the data.
|
|
1301
1332
|
* 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>
|
|
1302
1333
|
*
|
|
1303
|
-
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1304
|
-
*
|
|
1305
|
-
*
|
|
1334
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt the private
|
|
1335
|
+
* key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key
|
|
1336
|
+
* store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
|
|
1337
|
+
* operation. </p>
|
|
1306
1338
|
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1307
|
-
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1339
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
|
|
1340
|
+
* either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
|
|
1341
|
+
* the use of data key pairs outside of KMS.</p>
|
|
1310
1342
|
*
|
|
1311
1343
|
* <p>If you are using the data key pair to encrypt data, or for any operation where you don't
|
|
1312
1344
|
* immediately need a private key, consider using the <a>GenerateDataKeyPairWithoutPlaintext</a> operation.
|
|
@@ -1318,10 +1350,10 @@ export declare class KMS extends KMSClient {
|
|
|
1318
1350
|
*
|
|
1319
1351
|
* <p>
|
|
1320
1352
|
* <code>GenerateDataKeyPair</code> returns a unique data key pair for each request. The
|
|
1321
|
-
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the
|
|
1322
|
-
* key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1323
|
-
*
|
|
1324
|
-
*
|
|
1353
|
+
* bytes in the keys are not related to the caller or the KMS key that is used to encrypt the
|
|
1354
|
+
* private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1355
|
+
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>. The private key is a
|
|
1356
|
+
* DER-encoded PKCS8 PrivateKeyInfo, as specified in <a href="https://tools.ietf.org/html/rfc5958">RFC 5958</a>.</p>
|
|
1325
1357
|
*
|
|
1326
1358
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
1327
1359
|
* operation. If you specify an <code>EncryptionContext</code>, you must specify the same
|
|
@@ -1331,7 +1363,8 @@ export declare class KMS extends KMSClient {
|
|
|
1331
1363
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1332
1364
|
* 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>
|
|
1333
1365
|
* <p>
|
|
1334
|
-
* <b>Cross-account
|
|
1366
|
+
* <b>Cross-account
|
|
1367
|
+
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1335
1368
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1336
1369
|
*
|
|
1337
1370
|
* <p>
|
|
@@ -1373,23 +1406,24 @@ export declare class KMS extends KMSClient {
|
|
|
1373
1406
|
/**
|
|
1374
1407
|
* <p>Generates a unique asymmetric data key pair. The
|
|
1375
1408
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> operation returns a plaintext public key
|
|
1376
|
-
* and a copy of the private key that is encrypted under the symmetric KMS key you specify.
|
|
1377
|
-
*
|
|
1378
|
-
* key. </p>
|
|
1409
|
+
* and a copy of the private key that is encrypted under the symmetric KMS key you specify.
|
|
1410
|
+
* Unlike <a>GenerateDataKeyPair</a>, this operation does not return a plaintext
|
|
1411
|
+
* private key. </p>
|
|
1379
1412
|
* <p>You can use the public key that <code>GenerateDataKeyPairWithoutPlaintext</code> returns
|
|
1380
1413
|
* to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key
|
|
1381
1414
|
* with the data. When you are ready to decrypt data or sign a message, you can use the <a>Decrypt</a> operation to decrypt the encrypted private key.</p>
|
|
1382
|
-
* <p>To generate a data key pair, you must specify a symmetric KMS key to
|
|
1383
|
-
*
|
|
1384
|
-
*
|
|
1415
|
+
* <p>To generate a data key pair, you must specify a symmetric KMS key to encrypt the private
|
|
1416
|
+
* key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a custom key
|
|
1417
|
+
* store. To get the type and origin of your KMS key, use the <a>DescribeKey</a>
|
|
1418
|
+
* operation. </p>
|
|
1385
1419
|
* <p>Use the <code>KeyPairSpec</code> parameter to choose an RSA or Elliptic Curve (ECC) data
|
|
1386
|
-
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs
|
|
1387
|
-
*
|
|
1388
|
-
*
|
|
1420
|
+
* key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs for
|
|
1421
|
+
* either encryption or signing, but not both. However, KMS cannot enforce any restrictions on
|
|
1422
|
+
* the use of data key pairs outside of KMS.</p>
|
|
1389
1423
|
* <p>
|
|
1390
1424
|
* <code>GenerateDataKeyPairWithoutPlaintext</code> returns a unique data key pair for each
|
|
1391
|
-
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
|
|
1392
|
-
* private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1425
|
+
* request. The bytes in the key are not related to the caller or KMS key that is used to encrypt
|
|
1426
|
+
* the private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in
|
|
1393
1427
|
* <a href="https://tools.ietf.org/html/rfc5280">RFC 5280</a>.</p>
|
|
1394
1428
|
*
|
|
1395
1429
|
* <p>You can use the optional encryption context to add additional security to the encryption
|
|
@@ -1400,11 +1434,13 @@ export declare class KMS extends KMSClient {
|
|
|
1400
1434
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1401
1435
|
* 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>
|
|
1402
1436
|
* <p>
|
|
1403
|
-
* <b>Cross-account
|
|
1437
|
+
* <b>Cross-account
|
|
1438
|
+
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1404
1439
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1405
1440
|
*
|
|
1406
1441
|
* <p>
|
|
1407
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPairWithoutPlaintext</a> (key
|
|
1442
|
+
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyPairWithoutPlaintext</a> (key
|
|
1443
|
+
* policy)</p>
|
|
1408
1444
|
* <p>
|
|
1409
1445
|
* <b>Related operations:</b>
|
|
1410
1446
|
* </p>
|
|
@@ -1441,8 +1477,8 @@ export declare class KMS extends KMSClient {
|
|
|
1441
1477
|
generateDataKeyPairWithoutPlaintext(args: GenerateDataKeyPairWithoutPlaintextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateDataKeyPairWithoutPlaintextCommandOutput) => void): void;
|
|
1442
1478
|
/**
|
|
1443
1479
|
* <p>Generates a unique symmetric data key. This operation returns a data key that is encrypted
|
|
1444
|
-
* under a KMS key that you specify. To request an asymmetric data key pair,
|
|
1445
|
-
*
|
|
1480
|
+
* under a KMS key that you specify. To request an asymmetric data key pair, use the <a>GenerateDataKeyPair</a> or <a>GenerateDataKeyPairWithoutPlaintext</a>
|
|
1481
|
+
* operations.</p>
|
|
1446
1482
|
* <p>
|
|
1447
1483
|
* <code>GenerateDataKeyWithoutPlaintext</code> is identical to the <a>GenerateDataKey</a> operation except that returns only the encrypted copy of the
|
|
1448
1484
|
* data key. This operation is useful for systems that need to encrypt data at some point, but
|
|
@@ -1457,12 +1493,12 @@ export declare class KMS extends KMSClient {
|
|
|
1457
1493
|
* plaintext data key.</p>
|
|
1458
1494
|
* <p>
|
|
1459
1495
|
* <code>GenerateDataKeyWithoutPlaintext</code> returns a unique data key for each request.
|
|
1460
|
-
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the
|
|
1461
|
-
* key.</p>
|
|
1496
|
+
* The bytes in the keys are not related to the caller or KMS key that is used to encrypt the
|
|
1497
|
+
* private key.</p>
|
|
1462
1498
|
*
|
|
1463
|
-
* <p>To generate a data key, you must specify the symmetric KMS key that is
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1499
|
+
* <p>To generate a data key, you must specify the symmetric KMS key that is used to encrypt the
|
|
1500
|
+
* data key. You cannot use an asymmetric KMS key to generate a data key. To get the type of your
|
|
1501
|
+
* KMS key, use the <a>DescribeKey</a> operation.</p>
|
|
1466
1502
|
*
|
|
1467
1503
|
* <p>If the operation succeeds, you will find the encrypted copy of the data key in the
|
|
1468
1504
|
* <code>CiphertextBlob</code> field.</p>
|
|
@@ -1475,11 +1511,13 @@ export declare class KMS extends KMSClient {
|
|
|
1475
1511
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1476
1512
|
* 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>
|
|
1477
1513
|
* <p>
|
|
1478
|
-
* <b>Cross-account
|
|
1514
|
+
* <b>Cross-account
|
|
1515
|
+
* use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1479
1516
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1480
1517
|
*
|
|
1481
1518
|
* <p>
|
|
1482
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyWithoutPlaintext</a> (key
|
|
1519
|
+
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GenerateDataKeyWithoutPlaintext</a> (key
|
|
1520
|
+
* policy)</p>
|
|
1483
1521
|
* <p>
|
|
1484
1522
|
* <b>Related operations:</b>
|
|
1485
1523
|
* </p>
|
|
@@ -1520,7 +1558,8 @@ export declare class KMS extends KMSClient {
|
|
|
1520
1558
|
* 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
|
|
1521
1559
|
* ID.</p>
|
|
1522
1560
|
* <p>Applications in Amazon Web Services Nitro Enclaves can call this operation by using the <a href="https://github.com/aws/aws-nitro-enclaves-sdk-c">Amazon Web Services Nitro Enclaves Development Kit</a>. For information about the supporting parameters, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html">How Amazon Web Services Nitro Enclaves use KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1523
|
-
* <p>For more information about entropy and random number generation, see
|
|
1561
|
+
* <p>For more information about entropy and random number generation, see
|
|
1562
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/cryptographic-details/">Key Management Service Cryptographic Details</a>.</p>
|
|
1524
1563
|
*
|
|
1525
1564
|
* <p>
|
|
1526
1565
|
* <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>
|
|
@@ -1545,7 +1584,8 @@ export declare class KMS extends KMSClient {
|
|
|
1545
1584
|
/**
|
|
1546
1585
|
* <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
|
|
1547
1586
|
* enabled for the specified KMS key.</p>
|
|
1548
|
-
* <p>You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-replica-key">multi-Region keys</a>, set the property on the primary key. The key rotation status for these KMS keys is always
|
|
1587
|
+
* <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
|
|
1588
|
+
* <code>false</code>.</p>
|
|
1549
1589
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1550
1590
|
* 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>
|
|
1551
1591
|
* <ul>
|
|
@@ -1585,16 +1625,15 @@ export declare class KMS extends KMSClient {
|
|
|
1585
1625
|
getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
|
|
1586
1626
|
getKeyRotationStatus(args: GetKeyRotationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKeyRotationStatusCommandOutput) => void): void;
|
|
1587
1627
|
/**
|
|
1588
|
-
* <p>Returns the items you need to import key material into a symmetric, customer managed
|
|
1589
|
-
*
|
|
1590
|
-
*
|
|
1591
|
-
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1628
|
+
* <p>Returns the items you need to import key material into a symmetric, customer managed KMS
|
|
1629
|
+
* key. For more information about importing key material into KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a>
|
|
1630
|
+
* in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1592
1631
|
* <p>This operation returns a public key and an import token. Use the public key to encrypt the
|
|
1593
1632
|
* symmetric key material. Store the import token to send with a subsequent <a>ImportKeyMaterial</a> request.</p>
|
|
1594
|
-
* <p>You must specify the key ID of the symmetric KMS key into which you will import key
|
|
1595
|
-
* This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also
|
|
1596
|
-
* wrapping algorithm and type of wrapping key (public key) that you will use to
|
|
1597
|
-
* material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
1633
|
+
* <p>You must specify the key ID of the symmetric KMS key into which you will import key
|
|
1634
|
+
* material. This KMS key's <code>Origin</code> must be <code>EXTERNAL</code>. You must also
|
|
1635
|
+
* specify the wrapping algorithm and type of wrapping key (public key) that you will use to
|
|
1636
|
+
* encrypt the key material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.</p>
|
|
1598
1637
|
* <p>To import key material, you must use the public key and import token from the same
|
|
1599
1638
|
* response. These items are valid for 24 hours. The expiration date and time appear in the
|
|
1600
1639
|
* <code>GetParametersForImport</code> response. You cannot use an expired token in an <a>ImportKeyMaterial</a> request. If your key and token expire, send another
|
|
@@ -1626,10 +1665,11 @@ export declare class KMS extends KMSClient {
|
|
|
1626
1665
|
getParametersForImport(args: GetParametersForImportCommandInput, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1627
1666
|
getParametersForImport(args: GetParametersForImportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetParametersForImportCommandOutput) => void): void;
|
|
1628
1667
|
/**
|
|
1629
|
-
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
|
|
1630
|
-
* which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
|
|
1631
|
-
* can download the public key of an asymmetric KMS key. You can share the public key
|
|
1632
|
-
* to encrypt messages and verify signatures outside of KMS.
|
|
1668
|
+
* <p>Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric
|
|
1669
|
+
* KMS key, which never leaves KMS unencrypted, callers with <code>kms:GetPublicKey</code>
|
|
1670
|
+
* permission can download the public key of an asymmetric KMS key. You can share the public key
|
|
1671
|
+
* to allow others to encrypt messages and verify signatures outside of KMS.
|
|
1672
|
+
* 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>
|
|
1633
1673
|
* <p>You do not need to download the public key. Instead, you can use the public key within
|
|
1634
1674
|
* KMS by calling the <a>Encrypt</a>, <a>ReEncrypt</a>, or <a>Verify</a> operations with the identifier of an asymmetric KMS key. When you use the
|
|
1635
1675
|
* public key within KMS, you benefit from the authentication, authorization, and logging that
|
|
@@ -1663,7 +1703,8 @@ export declare class KMS extends KMSClient {
|
|
|
1663
1703
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1664
1704
|
* 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>
|
|
1665
1705
|
* <p>
|
|
1666
|
-
* <b>Cross-account use</b>:
|
|
1706
|
+
* <b>Cross-account use</b>:
|
|
1707
|
+
* Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
1667
1708
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
1668
1709
|
*
|
|
1669
1710
|
* <p>
|
|
@@ -1676,12 +1717,12 @@ export declare class KMS extends KMSClient {
|
|
|
1676
1717
|
getPublicKey(args: GetPublicKeyCommandInput, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1677
1718
|
getPublicKey(args: GetPublicKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPublicKeyCommandOutput) => void): void;
|
|
1678
1719
|
/**
|
|
1679
|
-
* <p>Imports key material into an existing symmetric KMS KMS key that was
|
|
1680
|
-
*
|
|
1681
|
-
*
|
|
1720
|
+
* <p>Imports key material into an existing symmetric KMS KMS key that was created without key
|
|
1721
|
+
* material. After you successfully import key material into a KMS key, you can <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material">reimport
|
|
1722
|
+
* the same key material</a> into that KMS key, but you cannot import different key
|
|
1682
1723
|
* material. </p>
|
|
1683
|
-
* <p>You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material
|
|
1684
|
-
* then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
|
|
1724
|
+
* <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
|
|
1725
|
+
* and then importing key material, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">Importing Key Material</a> in the
|
|
1685
1726
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1686
1727
|
* <p>Before using this operation, call <a>GetParametersForImport</a>. Its response
|
|
1687
1728
|
* includes a public key and an import token. Use the public key to encrypt the key material.
|
|
@@ -1690,8 +1731,8 @@ export declare class KMS extends KMSClient {
|
|
|
1690
1731
|
* <p>When calling this operation, you must specify the following values:</p>
|
|
1691
1732
|
* <ul>
|
|
1692
1733
|
* <li>
|
|
1693
|
-
* <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must
|
|
1694
|
-
*
|
|
1734
|
+
* <p>The key ID or key ARN of a KMS key with no key material. Its <code>Origin</code> must
|
|
1735
|
+
* be <code>EXTERNAL</code>.</p>
|
|
1695
1736
|
* <p>To create a KMS key with no key material, call <a>CreateKey</a> and set the
|
|
1696
1737
|
* value of its <code>Origin</code> parameter to <code>EXTERNAL</code>. To get the
|
|
1697
1738
|
* <code>Origin</code> of a KMS key, call <a>DescribeKey</a>.)</p>
|
|
@@ -1706,17 +1747,17 @@ export declare class KMS extends KMSClient {
|
|
|
1706
1747
|
* </li>
|
|
1707
1748
|
* <li>
|
|
1708
1749
|
* <p>Whether the key material expires and if so, when. If you set an expiration date, KMS
|
|
1709
|
-
* deletes the key material from the KMS key on the specified date, and the KMS key becomes
|
|
1710
|
-
* To use the KMS key again, you must reimport the same key material. The only way
|
|
1711
|
-
* expiration date is by reimporting the same key material and specifying a new
|
|
1712
|
-
* date. </p>
|
|
1750
|
+
* deletes the key material from the KMS key on the specified date, and the KMS key becomes
|
|
1751
|
+
* unusable. To use the KMS key again, you must reimport the same key material. The only way
|
|
1752
|
+
* to change an expiration date is by reimporting the same key material and specifying a new
|
|
1753
|
+
* expiration date. </p>
|
|
1713
1754
|
* </li>
|
|
1714
1755
|
* </ul>
|
|
1715
1756
|
* <p>When this operation is successful, the key state of the KMS key changes from
|
|
1716
1757
|
* <code>PendingImport</code> to <code>Enabled</code>, and you can use the KMS key.</p>
|
|
1717
1758
|
* <p>If this operation fails, use the exception to help determine the problem. If the error is
|
|
1718
|
-
* related to the key material, the import token, or wrapping key, use <a>GetParametersForImport</a> to get a new public key and import token for the KMS key
|
|
1719
|
-
* repeat the import procedure. For help, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview">How To Import Key
|
|
1759
|
+
* 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
|
|
1760
|
+
* and 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
|
|
1720
1761
|
* Material</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
1721
1762
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
1722
1763
|
* 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>
|
|
@@ -1745,26 +1786,29 @@ export declare class KMS extends KMSClient {
|
|
|
1745
1786
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1746
1787
|
importKeyMaterial(args: ImportKeyMaterialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportKeyMaterialCommandOutput) => void): void;
|
|
1747
1788
|
/**
|
|
1748
|
-
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
|
|
1749
|
-
* aliases, see <a>CreateAlias</a>.</p>
|
|
1789
|
+
* <p>Gets a list of aliases in the caller's Amazon Web Services account and region. For more information
|
|
1790
|
+
* about aliases, see <a>CreateAlias</a>.</p>
|
|
1750
1791
|
* <p>By default, the <code>ListAliases</code> operation returns all aliases in the account and
|
|
1751
|
-
* region. To get only the aliases associated with a particular KMS key, use
|
|
1752
|
-
*
|
|
1792
|
+
* region. To get only the aliases associated with a particular KMS key, use the
|
|
1793
|
+
* <code>KeyId</code> parameter.</p>
|
|
1753
1794
|
* <p>The <code>ListAliases</code> response can include aliases that you created and associated
|
|
1754
|
-
* with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services
|
|
1755
|
-
*
|
|
1795
|
+
* with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services
|
|
1796
|
+
* managed keys in your account. You can recognize Amazon Web Services aliases because their names have the
|
|
1797
|
+
* format <code>aws/<service-name></code>, such as <code>aws/dynamodb</code>.</p>
|
|
1756
1798
|
* <p>The response might also include aliases that have no <code>TargetKeyId</code> field. These
|
|
1757
|
-
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key.
|
|
1758
|
-
* that Amazon Web Services creates in your account, including predefined aliases, do not count against
|
|
1759
|
-
*
|
|
1799
|
+
* are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key.
|
|
1800
|
+
* Aliases that Amazon Web Services creates in your account, including predefined aliases, do not count against
|
|
1801
|
+
* your <a href="https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit">KMS aliases
|
|
1760
1802
|
* quota</a>.</p>
|
|
1761
1803
|
* <p>
|
|
1762
1804
|
* <b>Cross-account use</b>: No. <code>ListAliases</code> does not
|
|
1763
1805
|
* return aliases in other Amazon Web Services accounts.</p>
|
|
1764
1806
|
*
|
|
1807
|
+
*
|
|
1765
1808
|
* <p>
|
|
1766
1809
|
* <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>
|
|
1767
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
1810
|
+
* <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
|
|
1811
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
1768
1812
|
* <p>
|
|
1769
1813
|
* <b>Related operations:</b>
|
|
1770
1814
|
* </p>
|
|
@@ -1791,8 +1835,8 @@ export declare class KMS extends KMSClient {
|
|
|
1791
1835
|
listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
|
|
1792
1836
|
/**
|
|
1793
1837
|
* <p>Gets a list of all grants for the specified KMS key. </p>
|
|
1794
|
-
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID
|
|
1795
|
-
*
|
|
1838
|
+
* <p>You must specify the KMS key in all requests. You can filter the grant list by grant ID or
|
|
1839
|
+
* grantee principal.</p>
|
|
1796
1840
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
1797
1841
|
* <i>
|
|
1798
1842
|
* <i>Key Management Service Developer Guide</i>
|
|
@@ -1841,9 +1885,9 @@ export declare class KMS extends KMSClient {
|
|
|
1841
1885
|
listGrants(args: ListGrantsCommandInput, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
1842
1886
|
listGrants(args: ListGrantsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGrantsCommandOutput) => void): void;
|
|
1843
1887
|
/**
|
|
1844
|
-
* <p>Gets the names of the key policies that are attached to a KMS key. This
|
|
1845
|
-
*
|
|
1846
|
-
*
|
|
1888
|
+
* <p>Gets the names of the key policies that are attached to a KMS key. This operation is
|
|
1889
|
+
* designed to get policy names that you can use in a <a>GetKeyPolicy</a> operation.
|
|
1890
|
+
* However, the only valid policy name is <code>default</code>. </p>
|
|
1847
1891
|
* <p>
|
|
1848
1892
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1849
1893
|
*
|
|
@@ -1869,8 +1913,7 @@ export declare class KMS extends KMSClient {
|
|
|
1869
1913
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
1870
1914
|
listKeyPolicies(args: ListKeyPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPoliciesCommandOutput) => void): void;
|
|
1871
1915
|
/**
|
|
1872
|
-
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and
|
|
1873
|
-
* Region.</p>
|
|
1916
|
+
* <p>Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.</p>
|
|
1874
1917
|
* <p>
|
|
1875
1918
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
1876
1919
|
*
|
|
@@ -1946,11 +1989,11 @@ export declare class KMS extends KMSClient {
|
|
|
1946
1989
|
listResourceTags(args: ListResourceTagsCommandInput, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
1947
1990
|
listResourceTags(args: ListResourceTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceTagsCommandOutput) => void): void;
|
|
1948
1991
|
/**
|
|
1949
|
-
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the
|
|
1950
|
-
* retiring principal. </p>
|
|
1992
|
+
* <p>Returns information about all grants in the Amazon Web Services account and Region that have the
|
|
1993
|
+
* specified retiring principal. </p>
|
|
1951
1994
|
* <p>You can specify any principal in your Amazon Web Services account. The grants that are returned include
|
|
1952
|
-
* grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this
|
|
1953
|
-
* determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
|
|
1995
|
+
* grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this
|
|
1996
|
+
* operation to determine which grants you may retire. To retire a grant, use the <a>RetireGrant</a> operation.</p>
|
|
1954
1997
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
1955
1998
|
* <i>
|
|
1956
1999
|
* <i>Key Management Service Developer Guide</i>
|
|
@@ -1959,11 +2002,12 @@ export declare class KMS extends KMSClient {
|
|
|
1959
2002
|
* <p>
|
|
1960
2003
|
* <b>Cross-account use</b>: You must specify a principal in your
|
|
1961
2004
|
* Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need
|
|
1962
|
-
*
|
|
2005
|
+
* <code>kms:ListRetirableGrants</code> permission (or any other additional permission) in any
|
|
1963
2006
|
* Amazon Web Services account other than your own.</p>
|
|
1964
2007
|
*
|
|
1965
2008
|
* <p>
|
|
1966
|
-
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
|
|
2009
|
+
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ListRetirableGrants</a> (IAM policy) in your
|
|
2010
|
+
* Amazon Web Services account.</p>
|
|
1967
2011
|
* <p>
|
|
1968
2012
|
* <b>Related operations:</b>
|
|
1969
2013
|
* </p>
|
|
@@ -2014,39 +2058,45 @@ export declare class KMS extends KMSClient {
|
|
|
2014
2058
|
putKeyPolicy(args: PutKeyPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutKeyPolicyCommandOutput) => void): void;
|
|
2015
2059
|
/**
|
|
2016
2060
|
* <p>Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this
|
|
2017
|
-
* operation to change the KMS key under which data is encrypted, such as when
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
2061
|
+
* operation to change the KMS key under which data is encrypted, such as when you <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually">manually
|
|
2062
|
+
* rotate</a> a KMS key or change the KMS key that protects a ciphertext. You can also use
|
|
2063
|
+
* it to reencrypt ciphertext under the same KMS key, such as to change the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context">encryption
|
|
2020
2064
|
* context</a> of a ciphertext.</p>
|
|
2021
2065
|
* <p>The <code>ReEncrypt</code> operation can decrypt ciphertext that was encrypted by using an
|
|
2022
2066
|
* KMS KMS key in an KMS operation, such as <a>Encrypt</a> or <a>GenerateDataKey</a>. It can also decrypt ciphertext that was encrypted by using the
|
|
2023
|
-
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS key</a>
|
|
2024
|
-
*
|
|
2025
|
-
*
|
|
2067
|
+
* public key of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks">asymmetric KMS key</a>
|
|
2068
|
+
* outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as
|
|
2069
|
+
* the <a href="https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/">Amazon Web Services Encryption SDK</a> or
|
|
2070
|
+
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html">Amazon S3
|
|
2071
|
+
* client-side encryption</a>. These libraries return a ciphertext format that is
|
|
2072
|
+
* incompatible with KMS.</p>
|
|
2026
2073
|
* <p>When you use the <code>ReEncrypt</code> operation, you need to provide information for the
|
|
2027
2074
|
* decrypt operation and the subsequent encrypt operation.</p>
|
|
2028
2075
|
* <ul>
|
|
2029
2076
|
* <li>
|
|
2030
2077
|
* <p>If your ciphertext was encrypted under an asymmetric KMS key, you must use the
|
|
2031
|
-
* <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the
|
|
2032
|
-
* You must also supply the encryption algorithm that was used. This information
|
|
2033
|
-
* to decrypt the data.</p>
|
|
2078
|
+
* <code>SourceKeyId</code> parameter to identify the KMS key that encrypted the
|
|
2079
|
+
* ciphertext. You must also supply the encryption algorithm that was used. This information
|
|
2080
|
+
* is required to decrypt the data.</p>
|
|
2034
2081
|
* </li>
|
|
2035
2082
|
* <li>
|
|
2036
|
-
* <p>If your ciphertext was encrypted under a symmetric KMS key, the
|
|
2037
|
-
*
|
|
2038
|
-
* symmetric ciphertext blob. This feature adds durability to
|
|
2039
|
-
* that authorized users can decrypt ciphertext decades after
|
|
2040
|
-
* they've lost track of the key ID. However, specifying the source
|
|
2041
|
-
* as a best practice. When you use the
|
|
2042
|
-
*
|
|
2083
|
+
* <p>If your ciphertext was encrypted under a symmetric KMS key, the
|
|
2084
|
+
* <code>SourceKeyId</code> parameter is optional. KMS can get this information from
|
|
2085
|
+
* metadata that it adds to the symmetric ciphertext blob. This feature adds durability to
|
|
2086
|
+
* your implementation by ensuring that authorized users can decrypt ciphertext decades after
|
|
2087
|
+
* it was encrypted, even if they've lost track of the key ID. However, specifying the source
|
|
2088
|
+
* KMS key is always recommended as a best practice. When you use the
|
|
2089
|
+
* <code>SourceKeyId</code> parameter to specify a KMS key, KMS uses only the KMS key you
|
|
2090
|
+
* specify. If the ciphertext was encrypted under a different KMS key, the
|
|
2091
|
+
* <code>ReEncrypt</code> operation fails. This practice ensures that you use the KMS key
|
|
2092
|
+
* that you intend.</p>
|
|
2043
2093
|
* </li>
|
|
2044
2094
|
* <li>
|
|
2045
2095
|
* <p>To reencrypt the data, you must use the <code>DestinationKeyId</code> parameter
|
|
2046
2096
|
* specify the KMS key that re-encrypts the data after it is decrypted. You can select a
|
|
2047
|
-
* symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you
|
|
2048
|
-
* provide the encryption algorithm. The algorithm that you choose must be
|
|
2049
|
-
* the KMS key.</p>
|
|
2097
|
+
* symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you
|
|
2098
|
+
* must also provide the encryption algorithm. The algorithm that you choose must be
|
|
2099
|
+
* compatible with the KMS key.</p>
|
|
2050
2100
|
*
|
|
2051
2101
|
* <important>
|
|
2052
2102
|
* <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>
|
|
@@ -2054,26 +2104,26 @@ export declare class KMS extends KMSClient {
|
|
|
2054
2104
|
* </important>
|
|
2055
2105
|
* </li>
|
|
2056
2106
|
* </ul>
|
|
2057
|
-
*
|
|
2058
|
-
*
|
|
2059
|
-
*
|
|
2060
2107
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2061
2108
|
* 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>
|
|
2062
2109
|
* <p>
|
|
2063
|
-
* <b>Cross-account use</b>: Yes.
|
|
2064
|
-
*
|
|
2065
|
-
*
|
|
2110
|
+
* <b>Cross-account use</b>: Yes.
|
|
2111
|
+
* The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both
|
|
2112
|
+
* KMS keys can be in a different account than the caller. To specify a KMS key in a different
|
|
2113
|
+
* account, you must use its key ARN or alias ARN.</p>
|
|
2066
2114
|
*
|
|
2067
2115
|
* <p>
|
|
2068
2116
|
* <b>Required permissions</b>:</p>
|
|
2069
2117
|
* <ul>
|
|
2070
2118
|
* <li>
|
|
2071
2119
|
* <p>
|
|
2072
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a>
|
|
2120
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptFrom</a>
|
|
2121
|
+
* permission on the source KMS key (key policy)</p>
|
|
2073
2122
|
* </li>
|
|
2074
2123
|
* <li>
|
|
2075
2124
|
* <p>
|
|
2076
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a>
|
|
2125
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:ReEncryptTo</a>
|
|
2126
|
+
* permission on the destination KMS key (key policy)</p>
|
|
2077
2127
|
* </li>
|
|
2078
2128
|
* </ul>
|
|
2079
2129
|
* <p>To permit reencryption from or to a KMS key, include the <code>"kms:ReEncrypt*"</code>
|
|
@@ -2142,7 +2192,7 @@ export declare class KMS extends KMSClient {
|
|
|
2142
2192
|
* details about the <code>Creating</code> key state, see <a href="kms/latest/developerguide/key-state.html">Key state: Effect on your KMS key</a> in the
|
|
2143
2193
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2144
2194
|
* <p>The CloudTrail log of a <code>ReplicateKey</code> operation records a
|
|
2145
|
-
*
|
|
2195
|
+
* <code>ReplicateKey</code> operation in the primary key's Region and a <a>CreateKey</a> operation in the replica key's Region.</p>
|
|
2146
2196
|
* <p>If you replicate a multi-Region primary key with imported key material, the replica key is
|
|
2147
2197
|
* created with no key material. You must import the same key material that you imported into the
|
|
2148
2198
|
* primary key. For details, see <a href="kms/latest/developerguide/multi-region-keys-import.html">Importing key material into multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -2150,8 +2200,8 @@ export declare class KMS extends KMSClient {
|
|
|
2150
2200
|
* operation.</p>
|
|
2151
2201
|
* <note>
|
|
2152
2202
|
* <p>
|
|
2153
|
-
* <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code>
|
|
2154
|
-
*
|
|
2203
|
+
* <code>ReplicateKey</code> uses different default values for the <code>KeyPolicy</code>
|
|
2204
|
+
* and <code>Tags</code> parameters than those used in the KMS console. For details, see the
|
|
2155
2205
|
* parameter descriptions.</p>
|
|
2156
2206
|
* </note>
|
|
2157
2207
|
* <p>
|
|
@@ -2162,8 +2212,8 @@ export declare class KMS extends KMSClient {
|
|
|
2162
2212
|
* <ul>
|
|
2163
2213
|
* <li>
|
|
2164
2214
|
* <p>
|
|
2165
|
-
* <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region).
|
|
2166
|
-
* permission in the primary key's key policy.</p>
|
|
2215
|
+
* <code>kms:ReplicateKey</code> on the primary key (in the primary key's Region).
|
|
2216
|
+
* Include this permission in the primary key's key policy.</p>
|
|
2167
2217
|
* </li>
|
|
2168
2218
|
* <li>
|
|
2169
2219
|
* <p>
|
|
@@ -2196,12 +2246,13 @@ export declare class KMS extends KMSClient {
|
|
|
2196
2246
|
/**
|
|
2197
2247
|
* <p>Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To
|
|
2198
2248
|
* identify the grant to retire, use a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token">grant token</a>, or both the grant ID and a
|
|
2199
|
-
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
|
|
2249
|
+
* key identifier (key ID or key ARN) of the KMS key. The <a>CreateGrant</a> operation
|
|
2250
|
+
* returns both values.</p>
|
|
2200
2251
|
* <p>This operation can be called by the <i>retiring principal</i> for a grant,
|
|
2201
2252
|
* by the <i>grantee principal</i> if the grant allows the <code>RetireGrant</code>
|
|
2202
2253
|
* operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be
|
|
2203
2254
|
* called by principals to whom permission for retiring a grant is delegated. For details, see
|
|
2204
|
-
*
|
|
2255
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and
|
|
2205
2256
|
* revoking grants</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2206
2257
|
* <p>For detailed information about grants, including grant terminology, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grants.html">Using grants</a> in the
|
|
2207
2258
|
* <i>
|
|
@@ -2209,11 +2260,12 @@ export declare class KMS extends KMSClient {
|
|
|
2209
2260
|
* </i>. For examples of working with grants in several
|
|
2210
2261
|
* programming languages, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html">Programming grants</a>. </p>
|
|
2211
2262
|
* <p>
|
|
2212
|
-
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS
|
|
2213
|
-
* in a different Amazon Web Services account.</p>
|
|
2263
|
+
* <b>Cross-account use</b>: Yes. You can retire a grant on a KMS
|
|
2264
|
+
* key in a different Amazon Web Services account.</p>
|
|
2214
2265
|
* <p>
|
|
2215
2266
|
* <b>Required permissions:</b>:Permission to retire a grant is
|
|
2216
|
-
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in
|
|
2267
|
+
* determined primarily by the grant. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete">Retiring and revoking grants</a> in
|
|
2268
|
+
* the <i>Key Management Service Developer Guide</i>.</p>
|
|
2217
2269
|
* <p>
|
|
2218
2270
|
* <b>Related operations:</b>
|
|
2219
2271
|
* </p>
|
|
@@ -2245,8 +2297,7 @@ export declare class KMS extends KMSClient {
|
|
|
2245
2297
|
retireGrant(args: RetireGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RetireGrantCommandOutput) => void): void;
|
|
2246
2298
|
/**
|
|
2247
2299
|
* <p>Deletes the specified grant. You revoke a grant to terminate the permissions that the
|
|
2248
|
-
* grant allows. For more
|
|
2249
|
-
* information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
2300
|
+
* grant allows. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete">Retiring and revoking grants</a> in
|
|
2250
2301
|
* the <i>
|
|
2251
2302
|
* <i>Key Management Service Developer Guide</i>
|
|
2252
2303
|
* </i>.</p>
|
|
@@ -2294,22 +2345,24 @@ export declare class KMS extends KMSClient {
|
|
|
2294
2345
|
revokeGrant(args: RevokeGrantCommandInput, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2295
2346
|
revokeGrant(args: RevokeGrantCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RevokeGrantCommandOutput) => void): void;
|
|
2296
2347
|
/**
|
|
2297
|
-
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting
|
|
2298
|
-
*
|
|
2299
|
-
*
|
|
2300
|
-
*
|
|
2301
|
-
*
|
|
2348
|
+
* <p>Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
|
|
2349
|
+
* days, but you can specify a waiting period of 7-30 days. When this operation is successful,
|
|
2350
|
+
* the key state of the KMS key changes to <code>PendingDeletion</code> and the key can't be used
|
|
2351
|
+
* in any cryptographic operations. It remains in this state for the duration of the waiting
|
|
2352
|
+
* period. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> to
|
|
2353
|
+
* cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,
|
|
2302
2354
|
* its key material, and all KMS data associated with it, including all aliases that refer to
|
|
2303
2355
|
* it.</p>
|
|
2304
2356
|
* <important>
|
|
2305
|
-
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key
|
|
2306
|
-
* deleted, all data that was encrypted under the KMS key is unrecoverable. (The only
|
|
2307
|
-
* a multi-Region replica key.) To prevent the use of a KMS key without deleting
|
|
2357
|
+
* <p>Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key
|
|
2358
|
+
* is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only
|
|
2359
|
+
* exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting
|
|
2360
|
+
* it, use <a>DisableKey</a>. </p>
|
|
2308
2361
|
* </important>
|
|
2309
2362
|
* <p>If you schedule deletion of a KMS key from a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>, when the waiting period
|
|
2310
|
-
* expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a
|
|
2311
|
-
* effort to delete the key material from the associated CloudHSM cluster. However, you might
|
|
2312
|
-
* to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
2363
|
+
* expires, <code>ScheduleKeyDeletion</code> deletes the KMS key from KMS. Then KMS makes a
|
|
2364
|
+
* best effort to delete the key material from the associated CloudHSM cluster. However, you might
|
|
2365
|
+
* need to manually <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key">delete the orphaned key
|
|
2313
2366
|
* material</a> from the cluster and its backups.</p>
|
|
2314
2367
|
* <p>You can schedule the deletion of a multi-Region primary key and its replica keys at any
|
|
2315
2368
|
* time. However, KMS will not delete a multi-Region primary key with existing replica keys. If
|
|
@@ -2318,18 +2371,20 @@ export declare class KMS extends KMSClient {
|
|
|
2318
2371
|
* operations. This status can continue indefinitely. When the last of its replicas keys is
|
|
2319
2372
|
* deleted (not just scheduled), the key state of the primary key changes to
|
|
2320
2373
|
* <code>PendingDeletion</code> and its waiting period (<code>PendingWindowInDays</code>)
|
|
2321
|
-
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the
|
|
2374
|
+
* begins. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html">Deleting multi-Region keys</a> in the
|
|
2375
|
+
* <i>Key Management Service Developer Guide</i>. </p>
|
|
2322
2376
|
* <p>For more information about scheduling a KMS key for deletion, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html">Deleting KMS keys</a> in the
|
|
2323
2377
|
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2324
2378
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2325
2379
|
* 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>
|
|
2326
|
-
*
|
|
2327
2380
|
* <p>
|
|
2328
|
-
* <b>Cross-account
|
|
2381
|
+
* <b>Cross-account
|
|
2382
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2329
2383
|
*
|
|
2330
2384
|
*
|
|
2331
2385
|
* <p>
|
|
2332
|
-
* <b>Required permissions</b>: kms:ScheduleKeyDeletion (key
|
|
2386
|
+
* <b>Required permissions</b>: kms:ScheduleKeyDeletion (key
|
|
2387
|
+
* policy)</p>
|
|
2333
2388
|
* <p>
|
|
2334
2389
|
* <b>Related operations</b>
|
|
2335
2390
|
* </p>
|
|
@@ -2351,20 +2406,21 @@ export declare class KMS extends KMSClient {
|
|
|
2351
2406
|
scheduleKeyDeletion(args: ScheduleKeyDeletionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ScheduleKeyDeletionCommandOutput) => void): void;
|
|
2352
2407
|
/**
|
|
2353
2408
|
* <p>Creates a <a href="https://en.wikipedia.org/wiki/Digital_signature">digital
|
|
2354
|
-
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
2355
|
-
*
|
|
2409
|
+
* signature</a> for a message or message digest by using the private key in an asymmetric
|
|
2410
|
+
* KMS key. To verify the signature, use the <a>Verify</a> operation, or use the
|
|
2411
|
+
* public key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2356
2412
|
* <p>Digital signatures are generated and verified by using asymmetric key pair, such as an RSA
|
|
2357
|
-
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or
|
|
2358
|
-
*
|
|
2359
|
-
*
|
|
2360
|
-
*
|
|
2413
|
+
* or ECC pair that is represented by an asymmetric KMS key. The key owner (or an authorized
|
|
2414
|
+
* user) uses their private key to sign a message. Anyone with the public key can verify that the
|
|
2415
|
+
* message was signed with that particular private key and that the message hasn't changed since
|
|
2416
|
+
* it was signed. </p>
|
|
2361
2417
|
* <p>To use the <code>Sign</code> operation, provide the following information:</p>
|
|
2362
2418
|
* <ul>
|
|
2363
2419
|
* <li>
|
|
2364
2420
|
* <p>Use the <code>KeyId</code> parameter to identify an asymmetric KMS key with a
|
|
2365
2421
|
* <code>KeyUsage</code> value of <code>SIGN_VERIFY</code>. To get the
|
|
2366
|
-
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a>
|
|
2367
|
-
* The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
|
|
2422
|
+
* <code>KeyUsage</code> value of a KMS key, use the <a>DescribeKey</a>
|
|
2423
|
+
* operation. The caller must have <code>kms:Sign</code> permission on the KMS key.</p>
|
|
2368
2424
|
* </li>
|
|
2369
2425
|
* <li>
|
|
2370
2426
|
* <p>Use the <code>Message</code> parameter to specify the message or message digest to
|
|
@@ -2386,7 +2442,7 @@ export declare class KMS extends KMSClient {
|
|
|
2386
2442
|
* then use the public key to verify the signature outside of KMS. </p>
|
|
2387
2443
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2388
2444
|
* 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>
|
|
2389
|
-
*
|
|
2445
|
+
* <p>
|
|
2390
2446
|
* <b>Cross-account use</b>: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify
|
|
2391
2447
|
* the key ARN or alias ARN in the value of the <code>KeyId</code> parameter.</p>
|
|
2392
2448
|
*
|
|
@@ -2408,16 +2464,18 @@ export declare class KMS extends KMSClient {
|
|
|
2408
2464
|
* The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag
|
|
2409
2465
|
* value. To edit a tag, specify an existing tag key and a new tag value.</p>
|
|
2410
2466
|
* <p>You can use this operation to tag a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk">customer managed key</a>, but you cannot
|
|
2411
|
-
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
|
|
2412
|
-
*
|
|
2413
|
-
*
|
|
2467
|
+
* tag an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services
|
|
2468
|
+
* managed key</a>, an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk">Amazon Web Services owned key</a>, a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#keystore-concept">custom key
|
|
2469
|
+
* store</a>, or an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#alias-concept">alias</a>.</p>
|
|
2470
|
+
* <p>You can also add tags to a KMS key while creating it (<a>CreateKey</a>) or
|
|
2471
|
+
* replicating it (<a>ReplicateKey</a>).</p>
|
|
2414
2472
|
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
2415
2473
|
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
2416
2474
|
* Web Services General Reference</i>. </p>
|
|
2417
2475
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2418
2476
|
* 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>
|
|
2419
2477
|
* <p>
|
|
2420
|
-
* <b>Cross-account use</b>: No.
|
|
2478
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2421
2479
|
*
|
|
2422
2480
|
* <p>
|
|
2423
2481
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:TagResource</a> (key policy)</p>
|
|
@@ -2457,8 +2515,8 @@ export declare class KMS extends KMSClient {
|
|
|
2457
2515
|
* <p>Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2458
2516
|
* </note>
|
|
2459
2517
|
* <p>When it succeeds, the <code>UntagResource</code> operation doesn't return any output.
|
|
2460
|
-
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
|
|
2461
|
-
* a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
2518
|
+
* Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or
|
|
2519
|
+
* return a response. To confirm that the operation worked, use the <a>ListResourceTags</a> operation.</p>
|
|
2462
2520
|
*
|
|
2463
2521
|
* <p>For information about using tags in KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html">Tagging keys</a>. For general information about
|
|
2464
2522
|
* tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon
|
|
@@ -2466,7 +2524,7 @@ export declare class KMS extends KMSClient {
|
|
|
2466
2524
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2467
2525
|
* 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>
|
|
2468
2526
|
* <p>
|
|
2469
|
-
* <b>Cross-account use</b>: No.
|
|
2527
|
+
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.</p>
|
|
2470
2528
|
*
|
|
2471
2529
|
* <p>
|
|
2472
2530
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UntagResource</a> (key policy)</p>
|
|
@@ -2500,9 +2558,9 @@ export declare class KMS extends KMSClient {
|
|
|
2500
2558
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2501
2559
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
2502
2560
|
/**
|
|
2503
|
-
* <p>Associates an existing KMS alias with a different KMS key. Each alias
|
|
2504
|
-
*
|
|
2505
|
-
*
|
|
2561
|
+
* <p>Associates an existing KMS alias with a different KMS key. Each alias is associated with
|
|
2562
|
+
* only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the
|
|
2563
|
+
* KMS key must be in the same Amazon Web Services account and Region.</p>
|
|
2506
2564
|
* <note>
|
|
2507
2565
|
* <p>Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/abac.html">Using ABAC in KMS</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
2508
2566
|
* </note>
|
|
@@ -2514,12 +2572,12 @@ export declare class KMS extends KMSClient {
|
|
|
2514
2572
|
* use <a>DeleteAlias</a> to delete the old alias and <a>CreateAlias</a> to
|
|
2515
2573
|
* create a new alias.</p>
|
|
2516
2574
|
* <p>Because an alias is not a property of a KMS key, you can create, update, and delete the
|
|
2517
|
-
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the
|
|
2518
|
-
* the <a>DescribeKey</a> operation. To get the aliases of all KMS keys
|
|
2519
|
-
* use the <a>ListAliases</a> operation. </p>
|
|
2575
|
+
* aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the
|
|
2576
|
+
* response from the <a>DescribeKey</a> operation. To get the aliases of all KMS keys
|
|
2577
|
+
* in the account, use the <a>ListAliases</a> operation. </p>
|
|
2520
2578
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2521
2579
|
* 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>
|
|
2522
|
-
*
|
|
2580
|
+
* <p>
|
|
2523
2581
|
* <b>Cross-account use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2524
2582
|
* <p>
|
|
2525
2583
|
* <b>Required permissions</b>
|
|
@@ -2527,18 +2585,22 @@ export declare class KMS extends KMSClient {
|
|
|
2527
2585
|
* <ul>
|
|
2528
2586
|
* <li>
|
|
2529
2587
|
* <p>
|
|
2530
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2588
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2589
|
+
* the alias (IAM policy).</p>
|
|
2531
2590
|
* </li>
|
|
2532
2591
|
* <li>
|
|
2533
2592
|
* <p>
|
|
2534
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2593
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2594
|
+
* the current KMS key (key policy).</p>
|
|
2535
2595
|
* </li>
|
|
2536
2596
|
* <li>
|
|
2537
2597
|
* <p>
|
|
2538
|
-
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2598
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateAlias</a> on
|
|
2599
|
+
* the new KMS key (key policy).</p>
|
|
2539
2600
|
* </li>
|
|
2540
2601
|
* </ul>
|
|
2541
|
-
* <p>For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access">Controlling access to aliases</a> in the
|
|
2602
|
+
* <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
|
|
2603
|
+
* <i>Key Management Service Developer Guide</i>.</p>
|
|
2542
2604
|
* <p>
|
|
2543
2605
|
* <b>Related operations:</b>
|
|
2544
2606
|
* </p>
|
|
@@ -2572,29 +2634,29 @@ export declare class KMS extends KMSClient {
|
|
|
2572
2634
|
* the update completes, use <a>ConnectCustomKeyStore</a>. To find the connection
|
|
2573
2635
|
* state of a custom key store, use the <a>DescribeCustomKeyStores</a>
|
|
2574
2636
|
* operation.</p>
|
|
2575
|
-
* <p>
|
|
2576
|
-
* settings.</p>
|
|
2637
|
+
* <p>The <code>CustomKeyStoreId</code> parameter is required in all commands. Use the other
|
|
2638
|
+
* parameters of <code>UpdateCustomKeyStore</code> to edit your key store settings.</p>
|
|
2577
2639
|
* <ul>
|
|
2578
2640
|
* <li>
|
|
2579
|
-
* <p>Use the <
|
|
2580
|
-
*
|
|
2641
|
+
* <p>Use the <code>NewCustomKeyStoreName</code> parameter to change the friendly name of
|
|
2642
|
+
* the custom key store to the value that you specify.</p>
|
|
2581
2643
|
* <p> </p>
|
|
2582
2644
|
* </li>
|
|
2583
2645
|
* <li>
|
|
2584
|
-
* <p>Use the <
|
|
2585
|
-
*
|
|
2586
|
-
* <code>kmsuser</code> crypto
|
|
2587
|
-
*
|
|
2588
|
-
*
|
|
2589
|
-
*
|
|
2590
|
-
*
|
|
2646
|
+
* <p>Use the <code>KeyStorePassword</code> parameter tell KMS the current password of the
|
|
2647
|
+
* <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser">
|
|
2648
|
+
* <code>kmsuser</code> crypto user (CU)</a> in the associated CloudHSM cluster. You
|
|
2649
|
+
* can use this parameter to <a href="https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password">fix connection
|
|
2650
|
+
* failures</a> that occur when KMS cannot log into the associated cluster because
|
|
2651
|
+
* the <code>kmsuser</code> password has changed. This value does not change the password in
|
|
2652
|
+
* the CloudHSM cluster.</p>
|
|
2591
2653
|
* <p> </p>
|
|
2592
2654
|
* </li>
|
|
2593
2655
|
* <li>
|
|
2594
|
-
* <p>Use the <
|
|
2595
|
-
*
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
2656
|
+
* <p>Use the <code>CloudHsmClusterId</code> parameter to associate the custom key store
|
|
2657
|
+
* with a different, but related, CloudHSM cluster. You can use this parameter to repair a
|
|
2658
|
+
* custom key store if its CloudHSM cluster becomes corrupted or is deleted, or when you need to
|
|
2659
|
+
* create or restore a cluster from a backup. </p>
|
|
2598
2660
|
* </li>
|
|
2599
2661
|
* </ul>
|
|
2600
2662
|
* <p>If the operation succeeds, it returns a JSON object with no
|
|
@@ -2602,9 +2664,9 @@ export declare class KMS extends KMSClient {
|
|
|
2602
2664
|
* <p>This operation is part of the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">Custom Key Store feature</a> feature in KMS, which
|
|
2603
2665
|
* combines the convenience and extensive integration of KMS with the isolation and control of a
|
|
2604
2666
|
* single-tenant key store.</p>
|
|
2605
|
-
*
|
|
2606
2667
|
* <p>
|
|
2607
|
-
* <b>Cross-account
|
|
2668
|
+
* <b>Cross-account
|
|
2669
|
+
* use</b>: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account. </p>
|
|
2608
2670
|
* <p>
|
|
2609
2671
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateCustomKeyStore</a> (IAM policy)</p>
|
|
2610
2672
|
* <p>
|
|
@@ -2642,12 +2704,12 @@ export declare class KMS extends KMSClient {
|
|
|
2642
2704
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2643
2705
|
updateCustomKeyStore(args: UpdateCustomKeyStoreCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateCustomKeyStoreCommandOutput) => void): void;
|
|
2644
2706
|
/**
|
|
2645
|
-
* <p>Updates the description of a KMS key. To see the description of a KMS key,
|
|
2646
|
-
* use <a>DescribeKey</a>. </p>
|
|
2707
|
+
* <p>Updates the description of a KMS key. To see the description of a KMS key, use <a>DescribeKey</a>. </p>
|
|
2647
2708
|
* <p>The KMS key that you use for this operation must be in a compatible key state. For
|
|
2648
2709
|
* 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>
|
|
2649
2710
|
* <p>
|
|
2650
|
-
* <b>Cross-account
|
|
2711
|
+
* <b>Cross-account
|
|
2712
|
+
* use</b>: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account. </p>
|
|
2651
2713
|
*
|
|
2652
2714
|
* <p>
|
|
2653
2715
|
* <b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:UpdateKeyDescription</a> (key policy)</p>
|
|
@@ -2686,7 +2748,7 @@ export declare class KMS extends KMSClient {
|
|
|
2686
2748
|
* that are always shared by primary and replica keys, including the key material, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">key ID</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-spec">key spec</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-usage">key usage</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-origin">key material
|
|
2687
2749
|
* origin</a>, and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic
|
|
2688
2750
|
* key rotation</a>. It's the only key that can be replicated. You cannot <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html">delete the primary
|
|
2689
|
-
*
|
|
2751
|
+
* key</a> until all replica keys are deleted.</p>
|
|
2690
2752
|
* <p>The key ID and primary Region that you specify uniquely identify the replica key that will
|
|
2691
2753
|
* become the primary key. The primary Region must already have a replica key. This operation
|
|
2692
2754
|
* does not create a KMS key in the specified Region. To find the replica keys, use the <a>DescribeKey</a> operation on the primary key or any replica key. To create a replica
|
|
@@ -2744,9 +2806,9 @@ export declare class KMS extends KMSClient {
|
|
|
2744
2806
|
/**
|
|
2745
2807
|
* <p>Verifies a digital signature that was generated by the <a>Sign</a> operation. </p>
|
|
2746
2808
|
* <p></p>
|
|
2747
|
-
* <p>Verification confirms that an authorized user signed the message with the specified KMS
|
|
2748
|
-
* and signing algorithm, and the message hasn't changed since it was signed. If the
|
|
2749
|
-
* verified, the value of the <code>SignatureValid</code> field in the response is
|
|
2809
|
+
* <p>Verification confirms that an authorized user signed the message with the specified KMS
|
|
2810
|
+
* key and signing algorithm, and the message hasn't changed since it was signed. If the
|
|
2811
|
+
* signature is verified, the value of the <code>SignatureValid</code> field in the response is
|
|
2750
2812
|
* <code>True</code>. If the signature verification fails, the <code>Verify</code> operation
|
|
2751
2813
|
* fails with an <code>KMSInvalidSignatureException</code> exception.</p>
|
|
2752
2814
|
* <p>A digital signature is generated by using the private key in an asymmetric KMS key. The
|
|
@@ -2755,8 +2817,8 @@ export declare class KMS extends KMSClient {
|
|
|
2755
2817
|
* <p>To verify a digital signature, you can use the <code>Verify</code> operation. Specify the
|
|
2756
2818
|
* same asymmetric KMS key, message, and signing algorithm that were used to produce the
|
|
2757
2819
|
* signature.</p>
|
|
2758
|
-
* <p>You can also verify the digital signature by using the public key of the KMS key outside
|
|
2759
|
-
* KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
2820
|
+
* <p>You can also verify the digital signature by using the public key of the KMS key outside
|
|
2821
|
+
* of KMS. Use the <a>GetPublicKey</a> operation to download the public key in the
|
|
2760
2822
|
* asymmetric KMS key and then use the public key to verify the signature outside of KMS. The
|
|
2761
2823
|
* advantage of using the <code>Verify</code> operation is that it is performed within KMS. As
|
|
2762
2824
|
* a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged
|