Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- CancelKeyDeletion
- ConnectCustomKeyStore
- CreateAlias
- CreateCustomKeyStore
- CreateGrant
- CreateKey
- Decrypt
- DeleteAlias
- DeleteCustomKeyStore
- DeleteImportedKeyMaterial
- DescribeCustomKeyStores
- DescribeKey
- DisableKey
- DisableKeyRotation
- DisconnectCustomKeyStore
- EnableKey
- EnableKeyRotation
- Encrypt
- GenerateDataKey
- GenerateDataKeyPair
- GenerateDataKeyPairWithoutPlaintext
- GenerateDataKeyWithoutPlaintext
- GenerateMac
- GenerateRandom
- GetKeyPolicy
- GetKeyRotationStatus
- GetParametersForImport
- GetPublicKey
- ImportKeyMaterial
- ListAliases
- ListGrants
- ListKeyPolicies
- ListKeys
- ListResourceTags
- ListRetirableGrants
- PutKeyPolicy
- ReEncrypt
- ReplicateKey
- RetireGrant
- RevokeGrant
- ScheduleKeyDeletion
- Sign
- TagResource
- UntagResource
- UpdateAlias
- UpdateCustomKeyStore
- UpdateKeyDescription
- UpdatePrimaryRegion
- Verify
- VerifyMac
- Types
Synopsis
- cancelKeyDeletion_keyId :: Lens' CancelKeyDeletion Text
- cancelKeyDeletionResponse_keyId :: Lens' CancelKeyDeletionResponse (Maybe Text)
- cancelKeyDeletionResponse_httpStatus :: Lens' CancelKeyDeletionResponse Int
- connectCustomKeyStore_customKeyStoreId :: Lens' ConnectCustomKeyStore Text
- connectCustomKeyStoreResponse_httpStatus :: Lens' ConnectCustomKeyStoreResponse Int
- createAlias_aliasName :: Lens' CreateAlias Text
- createAlias_targetKeyId :: Lens' CreateAlias Text
- createCustomKeyStore_cloudHsmClusterId :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_customKeyStoreType :: Lens' CreateCustomKeyStore (Maybe CustomKeyStoreType)
- createCustomKeyStore_keyStorePassword :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_trustAnchorCertificate :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_xksProxyAuthenticationCredential :: Lens' CreateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType)
- createCustomKeyStore_xksProxyConnectivity :: Lens' CreateCustomKeyStore (Maybe XksProxyConnectivityType)
- createCustomKeyStore_xksProxyUriEndpoint :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_xksProxyUriPath :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' CreateCustomKeyStore (Maybe Text)
- createCustomKeyStore_customKeyStoreName :: Lens' CreateCustomKeyStore Text
- createCustomKeyStoreResponse_customKeyStoreId :: Lens' CreateCustomKeyStoreResponse (Maybe Text)
- createCustomKeyStoreResponse_httpStatus :: Lens' CreateCustomKeyStoreResponse Int
- createGrant_constraints :: Lens' CreateGrant (Maybe GrantConstraints)
- createGrant_grantTokens :: Lens' CreateGrant (Maybe [Text])
- createGrant_name :: Lens' CreateGrant (Maybe Text)
- createGrant_retiringPrincipal :: Lens' CreateGrant (Maybe Text)
- createGrant_keyId :: Lens' CreateGrant Text
- createGrant_granteePrincipal :: Lens' CreateGrant Text
- createGrant_operations :: Lens' CreateGrant [GrantOperation]
- createGrantResponse_grantId :: Lens' CreateGrantResponse (Maybe Text)
- createGrantResponse_grantToken :: Lens' CreateGrantResponse (Maybe Text)
- createGrantResponse_httpStatus :: Lens' CreateGrantResponse Int
- createKey_bypassPolicyLockoutSafetyCheck :: Lens' CreateKey (Maybe Bool)
- createKey_customKeyStoreId :: Lens' CreateKey (Maybe Text)
- createKey_customerMasterKeySpec :: Lens' CreateKey (Maybe CustomerMasterKeySpec)
- createKey_description :: Lens' CreateKey (Maybe Text)
- createKey_keySpec :: Lens' CreateKey (Maybe KeySpec)
- createKey_keyUsage :: Lens' CreateKey (Maybe KeyUsageType)
- createKey_multiRegion :: Lens' CreateKey (Maybe Bool)
- createKey_origin :: Lens' CreateKey (Maybe OriginType)
- createKey_policy :: Lens' CreateKey (Maybe Text)
- createKey_tags :: Lens' CreateKey (Maybe [Tag])
- createKey_xksKeyId :: Lens' CreateKey (Maybe Text)
- createKeyResponse_keyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata)
- createKeyResponse_httpStatus :: Lens' CreateKeyResponse Int
- decrypt_encryptionAlgorithm :: Lens' Decrypt (Maybe EncryptionAlgorithmSpec)
- decrypt_encryptionContext :: Lens' Decrypt (Maybe (HashMap Text Text))
- decrypt_grantTokens :: Lens' Decrypt (Maybe [Text])
- decrypt_keyId :: Lens' Decrypt (Maybe Text)
- decrypt_ciphertextBlob :: Lens' Decrypt ByteString
- decryptResponse_encryptionAlgorithm :: Lens' DecryptResponse (Maybe EncryptionAlgorithmSpec)
- decryptResponse_keyId :: Lens' DecryptResponse (Maybe Text)
- decryptResponse_plaintext :: Lens' DecryptResponse (Maybe ByteString)
- decryptResponse_httpStatus :: Lens' DecryptResponse Int
- deleteAlias_aliasName :: Lens' DeleteAlias Text
- deleteCustomKeyStore_customKeyStoreId :: Lens' DeleteCustomKeyStore Text
- deleteCustomKeyStoreResponse_httpStatus :: Lens' DeleteCustomKeyStoreResponse Int
- deleteImportedKeyMaterial_keyId :: Lens' DeleteImportedKeyMaterial Text
- describeCustomKeyStores_customKeyStoreId :: Lens' DescribeCustomKeyStores (Maybe Text)
- describeCustomKeyStores_customKeyStoreName :: Lens' DescribeCustomKeyStores (Maybe Text)
- describeCustomKeyStores_limit :: Lens' DescribeCustomKeyStores (Maybe Natural)
- describeCustomKeyStores_marker :: Lens' DescribeCustomKeyStores (Maybe Text)
- describeCustomKeyStoresResponse_customKeyStores :: Lens' DescribeCustomKeyStoresResponse (Maybe [CustomKeyStoresListEntry])
- describeCustomKeyStoresResponse_nextMarker :: Lens' DescribeCustomKeyStoresResponse (Maybe Text)
- describeCustomKeyStoresResponse_truncated :: Lens' DescribeCustomKeyStoresResponse (Maybe Bool)
- describeCustomKeyStoresResponse_httpStatus :: Lens' DescribeCustomKeyStoresResponse Int
- describeKey_grantTokens :: Lens' DescribeKey (Maybe [Text])
- describeKey_keyId :: Lens' DescribeKey Text
- describeKeyResponse_keyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata)
- describeKeyResponse_httpStatus :: Lens' DescribeKeyResponse Int
- disableKey_keyId :: Lens' DisableKey Text
- disableKeyRotation_keyId :: Lens' DisableKeyRotation Text
- disconnectCustomKeyStore_customKeyStoreId :: Lens' DisconnectCustomKeyStore Text
- disconnectCustomKeyStoreResponse_httpStatus :: Lens' DisconnectCustomKeyStoreResponse Int
- enableKey_keyId :: Lens' EnableKey Text
- enableKeyRotation_keyId :: Lens' EnableKeyRotation Text
- encrypt_encryptionAlgorithm :: Lens' Encrypt (Maybe EncryptionAlgorithmSpec)
- encrypt_encryptionContext :: Lens' Encrypt (Maybe (HashMap Text Text))
- encrypt_grantTokens :: Lens' Encrypt (Maybe [Text])
- encrypt_keyId :: Lens' Encrypt Text
- encrypt_plaintext :: Lens' Encrypt ByteString
- encryptResponse_ciphertextBlob :: Lens' EncryptResponse (Maybe ByteString)
- encryptResponse_encryptionAlgorithm :: Lens' EncryptResponse (Maybe EncryptionAlgorithmSpec)
- encryptResponse_keyId :: Lens' EncryptResponse (Maybe Text)
- encryptResponse_httpStatus :: Lens' EncryptResponse Int
- generateDataKey_encryptionContext :: Lens' GenerateDataKey (Maybe (HashMap Text Text))
- generateDataKey_grantTokens :: Lens' GenerateDataKey (Maybe [Text])
- generateDataKey_keySpec :: Lens' GenerateDataKey (Maybe DataKeySpec)
- generateDataKey_numberOfBytes :: Lens' GenerateDataKey (Maybe Natural)
- generateDataKey_keyId :: Lens' GenerateDataKey Text
- generateDataKeyResponse_httpStatus :: Lens' GenerateDataKeyResponse Int
- generateDataKeyResponse_keyId :: Lens' GenerateDataKeyResponse Text
- generateDataKeyResponse_plaintext :: Lens' GenerateDataKeyResponse ByteString
- generateDataKeyResponse_ciphertextBlob :: Lens' GenerateDataKeyResponse ByteString
- generateDataKeyPair_encryptionContext :: Lens' GenerateDataKeyPair (Maybe (HashMap Text Text))
- generateDataKeyPair_grantTokens :: Lens' GenerateDataKeyPair (Maybe [Text])
- generateDataKeyPair_keyId :: Lens' GenerateDataKeyPair Text
- generateDataKeyPair_keyPairSpec :: Lens' GenerateDataKeyPair DataKeyPairSpec
- generateDataKeyPairResponse_keyId :: Lens' GenerateDataKeyPairResponse (Maybe Text)
- generateDataKeyPairResponse_keyPairSpec :: Lens' GenerateDataKeyPairResponse (Maybe DataKeyPairSpec)
- generateDataKeyPairResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_privateKeyPlaintext :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_publicKey :: Lens' GenerateDataKeyPairResponse (Maybe ByteString)
- generateDataKeyPairResponse_httpStatus :: Lens' GenerateDataKeyPairResponse Int
- generateDataKeyPairWithoutPlaintext_encryptionContext :: Lens' GenerateDataKeyPairWithoutPlaintext (Maybe (HashMap Text Text))
- generateDataKeyPairWithoutPlaintext_grantTokens :: Lens' GenerateDataKeyPairWithoutPlaintext (Maybe [Text])
- generateDataKeyPairWithoutPlaintext_keyId :: Lens' GenerateDataKeyPairWithoutPlaintext Text
- generateDataKeyPairWithoutPlaintext_keyPairSpec :: Lens' GenerateDataKeyPairWithoutPlaintext DataKeyPairSpec
- generateDataKeyPairWithoutPlaintextResponse_keyId :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe Text)
- generateDataKeyPairWithoutPlaintextResponse_keyPairSpec :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe DataKeyPairSpec)
- generateDataKeyPairWithoutPlaintextResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe ByteString)
- generateDataKeyPairWithoutPlaintextResponse_publicKey :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe ByteString)
- generateDataKeyPairWithoutPlaintextResponse_httpStatus :: Lens' GenerateDataKeyPairWithoutPlaintextResponse Int
- generateDataKeyWithoutPlaintext_encryptionContext :: Lens' GenerateDataKeyWithoutPlaintext (Maybe (HashMap Text Text))
- generateDataKeyWithoutPlaintext_grantTokens :: Lens' GenerateDataKeyWithoutPlaintext (Maybe [Text])
- generateDataKeyWithoutPlaintext_keySpec :: Lens' GenerateDataKeyWithoutPlaintext (Maybe DataKeySpec)
- generateDataKeyWithoutPlaintext_numberOfBytes :: Lens' GenerateDataKeyWithoutPlaintext (Maybe Natural)
- generateDataKeyWithoutPlaintext_keyId :: Lens' GenerateDataKeyWithoutPlaintext Text
- generateDataKeyWithoutPlaintextResponse_ciphertextBlob :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe ByteString)
- generateDataKeyWithoutPlaintextResponse_keyId :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe Text)
- generateDataKeyWithoutPlaintextResponse_httpStatus :: Lens' GenerateDataKeyWithoutPlaintextResponse Int
- generateMac_grantTokens :: Lens' GenerateMac (Maybe [Text])
- generateMac_message :: Lens' GenerateMac ByteString
- generateMac_keyId :: Lens' GenerateMac Text
- generateMac_macAlgorithm :: Lens' GenerateMac MacAlgorithmSpec
- generateMacResponse_keyId :: Lens' GenerateMacResponse (Maybe Text)
- generateMacResponse_mac :: Lens' GenerateMacResponse (Maybe ByteString)
- generateMacResponse_macAlgorithm :: Lens' GenerateMacResponse (Maybe MacAlgorithmSpec)
- generateMacResponse_httpStatus :: Lens' GenerateMacResponse Int
- generateRandom_customKeyStoreId :: Lens' GenerateRandom (Maybe Text)
- generateRandom_numberOfBytes :: Lens' GenerateRandom (Maybe Natural)
- generateRandomResponse_plaintext :: Lens' GenerateRandomResponse (Maybe ByteString)
- generateRandomResponse_httpStatus :: Lens' GenerateRandomResponse Int
- getKeyPolicy_keyId :: Lens' GetKeyPolicy Text
- getKeyPolicy_policyName :: Lens' GetKeyPolicy Text
- getKeyPolicyResponse_policy :: Lens' GetKeyPolicyResponse (Maybe Text)
- getKeyPolicyResponse_httpStatus :: Lens' GetKeyPolicyResponse Int
- getKeyRotationStatus_keyId :: Lens' GetKeyRotationStatus Text
- getKeyRotationStatusResponse_keyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool)
- getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int
- getParametersForImport_keyId :: Lens' GetParametersForImport Text
- getParametersForImport_wrappingAlgorithm :: Lens' GetParametersForImport AlgorithmSpec
- getParametersForImport_wrappingKeySpec :: Lens' GetParametersForImport WrappingKeySpec
- getParametersForImportResponse_importToken :: Lens' GetParametersForImportResponse (Maybe ByteString)
- getParametersForImportResponse_keyId :: Lens' GetParametersForImportResponse (Maybe Text)
- getParametersForImportResponse_parametersValidTo :: Lens' GetParametersForImportResponse (Maybe UTCTime)
- getParametersForImportResponse_publicKey :: Lens' GetParametersForImportResponse (Maybe ByteString)
- getParametersForImportResponse_httpStatus :: Lens' GetParametersForImportResponse Int
- getPublicKey_grantTokens :: Lens' GetPublicKey (Maybe [Text])
- getPublicKey_keyId :: Lens' GetPublicKey Text
- getPublicKeyResponse_customerMasterKeySpec :: Lens' GetPublicKeyResponse (Maybe CustomerMasterKeySpec)
- getPublicKeyResponse_encryptionAlgorithms :: Lens' GetPublicKeyResponse (Maybe [EncryptionAlgorithmSpec])
- getPublicKeyResponse_keyId :: Lens' GetPublicKeyResponse (Maybe Text)
- getPublicKeyResponse_keySpec :: Lens' GetPublicKeyResponse (Maybe KeySpec)
- getPublicKeyResponse_keyUsage :: Lens' GetPublicKeyResponse (Maybe KeyUsageType)
- getPublicKeyResponse_publicKey :: Lens' GetPublicKeyResponse (Maybe ByteString)
- getPublicKeyResponse_signingAlgorithms :: Lens' GetPublicKeyResponse (Maybe [SigningAlgorithmSpec])
- getPublicKeyResponse_httpStatus :: Lens' GetPublicKeyResponse Int
- importKeyMaterial_expirationModel :: Lens' ImportKeyMaterial (Maybe ExpirationModelType)
- importKeyMaterial_validTo :: Lens' ImportKeyMaterial (Maybe UTCTime)
- importKeyMaterial_keyId :: Lens' ImportKeyMaterial Text
- importKeyMaterial_importToken :: Lens' ImportKeyMaterial ByteString
- importKeyMaterial_encryptedKeyMaterial :: Lens' ImportKeyMaterial ByteString
- importKeyMaterialResponse_httpStatus :: Lens' ImportKeyMaterialResponse Int
- listAliases_keyId :: Lens' ListAliases (Maybe Text)
- listAliases_limit :: Lens' ListAliases (Maybe Natural)
- listAliases_marker :: Lens' ListAliases (Maybe Text)
- listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [AliasListEntry])
- listAliasesResponse_nextMarker :: Lens' ListAliasesResponse (Maybe Text)
- listAliasesResponse_truncated :: Lens' ListAliasesResponse (Maybe Bool)
- listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int
- listGrants_grantId :: Lens' ListGrants (Maybe Text)
- listGrants_granteePrincipal :: Lens' ListGrants (Maybe Text)
- listGrants_limit :: Lens' ListGrants (Maybe Natural)
- listGrants_marker :: Lens' ListGrants (Maybe Text)
- listGrants_keyId :: Lens' ListGrants Text
- listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry])
- listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text)
- listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool)
- listKeyPolicies_limit :: Lens' ListKeyPolicies (Maybe Natural)
- listKeyPolicies_marker :: Lens' ListKeyPolicies (Maybe Text)
- listKeyPolicies_keyId :: Lens' ListKeyPolicies Text
- listKeyPoliciesResponse_nextMarker :: Lens' ListKeyPoliciesResponse (Maybe Text)
- listKeyPoliciesResponse_policyNames :: Lens' ListKeyPoliciesResponse (Maybe [Text])
- listKeyPoliciesResponse_truncated :: Lens' ListKeyPoliciesResponse (Maybe Bool)
- listKeyPoliciesResponse_httpStatus :: Lens' ListKeyPoliciesResponse Int
- listKeys_limit :: Lens' ListKeys (Maybe Natural)
- listKeys_marker :: Lens' ListKeys (Maybe Text)
- listKeysResponse_keys :: Lens' ListKeysResponse (Maybe [KeyListEntry])
- listKeysResponse_nextMarker :: Lens' ListKeysResponse (Maybe Text)
- listKeysResponse_truncated :: Lens' ListKeysResponse (Maybe Bool)
- listKeysResponse_httpStatus :: Lens' ListKeysResponse Int
- listResourceTags_limit :: Lens' ListResourceTags (Maybe Natural)
- listResourceTags_marker :: Lens' ListResourceTags (Maybe Text)
- listResourceTags_keyId :: Lens' ListResourceTags Text
- listResourceTagsResponse_nextMarker :: Lens' ListResourceTagsResponse (Maybe Text)
- listResourceTagsResponse_tags :: Lens' ListResourceTagsResponse (Maybe [Tag])
- listResourceTagsResponse_truncated :: Lens' ListResourceTagsResponse (Maybe Bool)
- listResourceTagsResponse_httpStatus :: Lens' ListResourceTagsResponse Int
- listRetirableGrants_limit :: Lens' ListRetirableGrants (Maybe Natural)
- listRetirableGrants_marker :: Lens' ListRetirableGrants (Maybe Text)
- listRetirableGrants_retiringPrincipal :: Lens' ListRetirableGrants Text
- listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry])
- listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text)
- listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool)
- putKeyPolicy_bypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool)
- putKeyPolicy_keyId :: Lens' PutKeyPolicy Text
- putKeyPolicy_policyName :: Lens' PutKeyPolicy Text
- putKeyPolicy_policy :: Lens' PutKeyPolicy Text
- reEncrypt_destinationEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec)
- reEncrypt_destinationEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text))
- reEncrypt_grantTokens :: Lens' ReEncrypt (Maybe [Text])
- reEncrypt_sourceEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec)
- reEncrypt_sourceEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text))
- reEncrypt_sourceKeyId :: Lens' ReEncrypt (Maybe Text)
- reEncrypt_ciphertextBlob :: Lens' ReEncrypt ByteString
- reEncrypt_destinationKeyId :: Lens' ReEncrypt Text
- reEncryptResponse_ciphertextBlob :: Lens' ReEncryptResponse (Maybe ByteString)
- reEncryptResponse_destinationEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec)
- reEncryptResponse_keyId :: Lens' ReEncryptResponse (Maybe Text)
- reEncryptResponse_sourceEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec)
- reEncryptResponse_sourceKeyId :: Lens' ReEncryptResponse (Maybe Text)
- reEncryptResponse_httpStatus :: Lens' ReEncryptResponse Int
- replicateKey_bypassPolicyLockoutSafetyCheck :: Lens' ReplicateKey (Maybe Bool)
- replicateKey_description :: Lens' ReplicateKey (Maybe Text)
- replicateKey_policy :: Lens' ReplicateKey (Maybe Text)
- replicateKey_tags :: Lens' ReplicateKey (Maybe [Tag])
- replicateKey_keyId :: Lens' ReplicateKey Text
- replicateKey_replicaRegion :: Lens' ReplicateKey Text
- replicateKeyResponse_replicaKeyMetadata :: Lens' ReplicateKeyResponse (Maybe KeyMetadata)
- replicateKeyResponse_replicaPolicy :: Lens' ReplicateKeyResponse (Maybe Text)
- replicateKeyResponse_replicaTags :: Lens' ReplicateKeyResponse (Maybe [Tag])
- replicateKeyResponse_httpStatus :: Lens' ReplicateKeyResponse Int
- retireGrant_grantId :: Lens' RetireGrant (Maybe Text)
- retireGrant_grantToken :: Lens' RetireGrant (Maybe Text)
- retireGrant_keyId :: Lens' RetireGrant (Maybe Text)
- revokeGrant_keyId :: Lens' RevokeGrant Text
- revokeGrant_grantId :: Lens' RevokeGrant Text
- scheduleKeyDeletion_pendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural)
- scheduleKeyDeletion_keyId :: Lens' ScheduleKeyDeletion Text
- scheduleKeyDeletionResponse_deletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime)
- scheduleKeyDeletionResponse_keyId :: Lens' ScheduleKeyDeletionResponse (Maybe Text)
- scheduleKeyDeletionResponse_keyState :: Lens' ScheduleKeyDeletionResponse (Maybe KeyState)
- scheduleKeyDeletionResponse_pendingWindowInDays :: Lens' ScheduleKeyDeletionResponse (Maybe Natural)
- scheduleKeyDeletionResponse_httpStatus :: Lens' ScheduleKeyDeletionResponse Int
- sign_grantTokens :: Lens' Sign (Maybe [Text])
- sign_messageType :: Lens' Sign (Maybe MessageType)
- sign_keyId :: Lens' Sign Text
- sign_message :: Lens' Sign ByteString
- sign_signingAlgorithm :: Lens' Sign SigningAlgorithmSpec
- signResponse_keyId :: Lens' SignResponse (Maybe Text)
- signResponse_signature :: Lens' SignResponse (Maybe ByteString)
- signResponse_signingAlgorithm :: Lens' SignResponse (Maybe SigningAlgorithmSpec)
- signResponse_httpStatus :: Lens' SignResponse Int
- tagResource_keyId :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- untagResource_keyId :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- updateAlias_aliasName :: Lens' UpdateAlias Text
- updateAlias_targetKeyId :: Lens' UpdateAlias Text
- updateCustomKeyStore_cloudHsmClusterId :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_keyStorePassword :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_newCustomKeyStoreName :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyAuthenticationCredential :: Lens' UpdateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType)
- updateCustomKeyStore_xksProxyConnectivity :: Lens' UpdateCustomKeyStore (Maybe XksProxyConnectivityType)
- updateCustomKeyStore_xksProxyUriEndpoint :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyUriPath :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' UpdateCustomKeyStore (Maybe Text)
- updateCustomKeyStore_customKeyStoreId :: Lens' UpdateCustomKeyStore Text
- updateCustomKeyStoreResponse_httpStatus :: Lens' UpdateCustomKeyStoreResponse Int
- updateKeyDescription_keyId :: Lens' UpdateKeyDescription Text
- updateKeyDescription_description :: Lens' UpdateKeyDescription Text
- updatePrimaryRegion_keyId :: Lens' UpdatePrimaryRegion Text
- updatePrimaryRegion_primaryRegion :: Lens' UpdatePrimaryRegion Text
- verify_grantTokens :: Lens' Verify (Maybe [Text])
- verify_messageType :: Lens' Verify (Maybe MessageType)
- verify_keyId :: Lens' Verify Text
- verify_message :: Lens' Verify ByteString
- verify_signature :: Lens' Verify ByteString
- verify_signingAlgorithm :: Lens' Verify SigningAlgorithmSpec
- verifyResponse_keyId :: Lens' VerifyResponse (Maybe Text)
- verifyResponse_signatureValid :: Lens' VerifyResponse (Maybe Bool)
- verifyResponse_signingAlgorithm :: Lens' VerifyResponse (Maybe SigningAlgorithmSpec)
- verifyResponse_httpStatus :: Lens' VerifyResponse Int
- verifyMac_grantTokens :: Lens' VerifyMac (Maybe [Text])
- verifyMac_message :: Lens' VerifyMac ByteString
- verifyMac_keyId :: Lens' VerifyMac Text
- verifyMac_macAlgorithm :: Lens' VerifyMac MacAlgorithmSpec
- verifyMac_mac :: Lens' VerifyMac ByteString
- verifyMacResponse_keyId :: Lens' VerifyMacResponse (Maybe Text)
- verifyMacResponse_macAlgorithm :: Lens' VerifyMacResponse (Maybe MacAlgorithmSpec)
- verifyMacResponse_macValid :: Lens' VerifyMacResponse (Maybe Bool)
- verifyMacResponse_httpStatus :: Lens' VerifyMacResponse Int
- aliasListEntry_aliasArn :: Lens' AliasListEntry (Maybe Text)
- aliasListEntry_aliasName :: Lens' AliasListEntry (Maybe Text)
- aliasListEntry_creationDate :: Lens' AliasListEntry (Maybe UTCTime)
- aliasListEntry_lastUpdatedDate :: Lens' AliasListEntry (Maybe UTCTime)
- aliasListEntry_targetKeyId :: Lens' AliasListEntry (Maybe Text)
- customKeyStoresListEntry_cloudHsmClusterId :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_connectionErrorCode :: Lens' CustomKeyStoresListEntry (Maybe ConnectionErrorCodeType)
- customKeyStoresListEntry_connectionState :: Lens' CustomKeyStoresListEntry (Maybe ConnectionStateType)
- customKeyStoresListEntry_creationDate :: Lens' CustomKeyStoresListEntry (Maybe UTCTime)
- customKeyStoresListEntry_customKeyStoreId :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_customKeyStoreName :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_customKeyStoreType :: Lens' CustomKeyStoresListEntry (Maybe CustomKeyStoreType)
- customKeyStoresListEntry_trustAnchorCertificate :: Lens' CustomKeyStoresListEntry (Maybe Text)
- customKeyStoresListEntry_xksProxyConfiguration :: Lens' CustomKeyStoresListEntry (Maybe XksProxyConfigurationType)
- grantConstraints_encryptionContextEquals :: Lens' GrantConstraints (Maybe (HashMap Text Text))
- grantConstraints_encryptionContextSubset :: Lens' GrantConstraints (Maybe (HashMap Text Text))
- grantListEntry_constraints :: Lens' GrantListEntry (Maybe GrantConstraints)
- grantListEntry_creationDate :: Lens' GrantListEntry (Maybe UTCTime)
- grantListEntry_grantId :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_granteePrincipal :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_issuingAccount :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_keyId :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_name :: Lens' GrantListEntry (Maybe Text)
- grantListEntry_operations :: Lens' GrantListEntry (Maybe [GrantOperation])
- grantListEntry_retiringPrincipal :: Lens' GrantListEntry (Maybe Text)
- keyListEntry_keyArn :: Lens' KeyListEntry (Maybe Text)
- keyListEntry_keyId :: Lens' KeyListEntry (Maybe Text)
- keyMetadata_aWSAccountId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_arn :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_cloudHsmClusterId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_creationDate :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_customKeyStoreId :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_customerMasterKeySpec :: Lens' KeyMetadata (Maybe CustomerMasterKeySpec)
- keyMetadata_deletionDate :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_description :: Lens' KeyMetadata (Maybe Text)
- keyMetadata_enabled :: Lens' KeyMetadata (Maybe Bool)
- keyMetadata_encryptionAlgorithms :: Lens' KeyMetadata (Maybe [EncryptionAlgorithmSpec])
- keyMetadata_expirationModel :: Lens' KeyMetadata (Maybe ExpirationModelType)
- keyMetadata_keyManager :: Lens' KeyMetadata (Maybe KeyManagerType)
- keyMetadata_keySpec :: Lens' KeyMetadata (Maybe KeySpec)
- keyMetadata_keyState :: Lens' KeyMetadata (Maybe KeyState)
- keyMetadata_keyUsage :: Lens' KeyMetadata (Maybe KeyUsageType)
- keyMetadata_macAlgorithms :: Lens' KeyMetadata (Maybe [MacAlgorithmSpec])
- keyMetadata_multiRegion :: Lens' KeyMetadata (Maybe Bool)
- keyMetadata_multiRegionConfiguration :: Lens' KeyMetadata (Maybe MultiRegionConfiguration)
- keyMetadata_origin :: Lens' KeyMetadata (Maybe OriginType)
- keyMetadata_pendingDeletionWindowInDays :: Lens' KeyMetadata (Maybe Natural)
- keyMetadata_signingAlgorithms :: Lens' KeyMetadata (Maybe [SigningAlgorithmSpec])
- keyMetadata_validTo :: Lens' KeyMetadata (Maybe UTCTime)
- keyMetadata_xksKeyConfiguration :: Lens' KeyMetadata (Maybe XksKeyConfigurationType)
- keyMetadata_keyId :: Lens' KeyMetadata Text
- listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry])
- listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text)
- listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool)
- multiRegionConfiguration_multiRegionKeyType :: Lens' MultiRegionConfiguration (Maybe MultiRegionKeyType)
- multiRegionConfiguration_primaryKey :: Lens' MultiRegionConfiguration (Maybe MultiRegionKey)
- multiRegionConfiguration_replicaKeys :: Lens' MultiRegionConfiguration (Maybe [MultiRegionKey])
- multiRegionKey_arn :: Lens' MultiRegionKey (Maybe Text)
- multiRegionKey_region :: Lens' MultiRegionKey (Maybe Text)
- tag_tagKey :: Lens' Tag Text
- tag_tagValue :: Lens' Tag Text
- xksKeyConfigurationType_id :: Lens' XksKeyConfigurationType (Maybe Text)
- xksProxyAuthenticationCredentialType_accessKeyId :: Lens' XksProxyAuthenticationCredentialType Text
- xksProxyAuthenticationCredentialType_rawSecretAccessKey :: Lens' XksProxyAuthenticationCredentialType Text
- xksProxyConfigurationType_accessKeyId :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_connectivity :: Lens' XksProxyConfigurationType (Maybe XksProxyConnectivityType)
- xksProxyConfigurationType_uriEndpoint :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_uriPath :: Lens' XksProxyConfigurationType (Maybe Text)
- xksProxyConfigurationType_vpcEndpointServiceName :: Lens' XksProxyConfigurationType (Maybe Text)
Operations
CancelKeyDeletion
cancelKeyDeletion_keyId :: Lens' CancelKeyDeletion Text Source #
Identifies the KMS key whose deletion is being canceled.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
cancelKeyDeletionResponse_keyId :: Lens' CancelKeyDeletionResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.
cancelKeyDeletionResponse_httpStatus :: Lens' CancelKeyDeletionResponse Int Source #
The response's http status code.
ConnectCustomKeyStore
connectCustomKeyStore_customKeyStoreId :: Lens' ConnectCustomKeyStore Text Source #
Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
connectCustomKeyStoreResponse_httpStatus :: Lens' ConnectCustomKeyStoreResponse Int Source #
The response's http status code.
CreateAlias
createAlias_aliasName :: Lens' CreateAlias Text Source #
Specifies the alias name. This value must begin with alias/
followed
by a name, such as alias/ExampleAlias
.
The AliasName
value must be string of 1-256 characters. It can contain
only alphanumeric characters, forward slashes (/), underscores (_), and
dashes (-). The alias name cannot begin with alias/aws/
. The
alias/aws/
prefix is reserved for
Amazon Web Services managed keys.
createAlias_targetKeyId :: Lens' CreateAlias Text Source #
Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.
A valid key ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see Finding the Key ID and ARN in the /Key Management Service Developer Guide/ .
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
CreateCustomKeyStore
createCustomKeyStore_cloudHsmClusterId :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Identifies the CloudHSM cluster for an CloudHSM key store. This
parameter is required for custom key stores with CustomKeyStoreType
of
AWS_CLOUDHSM
.
Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
createCustomKeyStore_customKeyStoreType :: Lens' CreateCustomKeyStore (Maybe CustomKeyStoreType) Source #
Specifies the type of custom key store. The default value is
AWS_CLOUDHSM
.
For a custom key store backed by an CloudHSM cluster, omit the parameter
or enter AWS_CLOUDHSM
. For a custom key store backed by an external
key manager outside of Amazon Web Services, enter EXTERNAL_KEY_STORE
.
You cannot change this property after the key store is created.
createCustomKeyStore_keyStorePassword :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Specifies the kmsuser
password for an CloudHSM key store. This
parameter is required for custom key stores with a CustomKeyStoreType
of AWS_CLOUDHSM
.
Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells KMS the kmsuser
account password; it does not
change the password in the CloudHSM cluster.
createCustomKeyStore_trustAnchorCertificate :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Specifies the certificate for an CloudHSM key store. This parameter is
required for custom key stores with a CustomKeyStoreType
of
AWS_CLOUDHSM
.
Enter the content of the trust anchor certificate for the CloudHSM
cluster. This is the content of the customerCA.crt
file that you
created when you
initialized the cluster.
createCustomKeyStore_xksProxyAuthenticationCredential :: Lens' CreateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType) Source #
Specifies an authentication credential for the external key store proxy
(XKS proxy). This parameter is required for all custom key stores with a
CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The XksProxyAuthenticationCredential
has two required elements:
RawSecretAccessKey
, a secret key, and AccessKeyId
, a unique
identifier for the RawSecretAccessKey
. For character requirements, see
XksProxyAuthenticationCredentialType.
KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.
This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.
createCustomKeyStore_xksProxyConnectivity :: Lens' CreateCustomKeyStore (Maybe XksProxyConnectivityType) Source #
Indicates how KMS communicates with the external key store proxy. This
parameter is required for custom key stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
If the external key store proxy uses a public endpoint, specify
PUBLIC_ENDPOINT
. If the external key store proxy uses a Amazon VPC
endpoint service for communication with KMS, specify
VPC_ENDPOINT_SERVICE
. For help making this choice, see
Choosing a connectivity option
in the Key Management Service Developer Guide.
An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.
createCustomKeyStore_xksProxyUriEndpoint :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Specifies the endpoint that KMS uses to send requests to the external
key store proxy (XKS proxy). This parameter is required for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The protocol must be HTTPS. KMS communicates on port 443. Do not specify
the port in the XksProxyUriEndpoint
value.
For external key stores with XksProxyConnectivity
value of
VPC_ENDPOINT_SERVICE
, specify https://
followed by the private DNS
name of the VPC endpoint service.
For external key stores with PUBLIC_ENDPOINT
connectivity, this
endpoint must be reachable before you create the custom key store. KMS
connects to the external key store proxy while creating the custom key
store. For external key stores with VPC_ENDPOINT_SERVICE
connectivity,
KMS connects when you call the ConnectCustomKeyStore operation.
The value of this parameter must begin with https://
. The remainder
can contain upper and lower case letters (A-Z and a-z), numbers (0-9),
dots (.
), and hyphens (-
). Additional slashes (/
and \
) are
not permitted.
Uniqueness requirements:
- The combined
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region. - An external key store with
PUBLIC_ENDPOINT
connectivity cannot use the sameXksProxyUriEndpoint
value as an external key store withVPC_ENDPOINT_SERVICE
connectivity in the same Amazon Web Services Region. - Each external key store with
VPC_ENDPOINT_SERVICE
connectivity must have its own private DNS name. TheXksProxyUriEndpoint
value for external key stores withVPC_ENDPOINT_SERVICE
connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.
createCustomKeyStore_xksProxyUriPath :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Specifies the base path to the proxy APIs for this external key store.
To find this value, see the documentation for your external key store
proxy. This parameter is required for all custom key stores with a
CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The value must start with /
and must end with /kms/xks/v1
where
v1
represents the version of the KMS external key store proxy API.
This path can include an optional prefix between the required elements
such as /
prefix
/kms/xks/v1
.
Uniqueness requirements:
- The combined
XksProxyUriEndpoint
andXksProxyUriPath
values must be unique in the Amazon Web Services account and Region.
createCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' CreateCustomKeyStore (Maybe Text) Source #
Specifies the name of the Amazon VPC endpoint service for interface
endpoints that is used to communicate with your external key store proxy
(XKS proxy). This parameter is required when the value of
CustomKeyStoreType
is EXTERNAL_KEY_STORE
and the value of
XksProxyConnectivity
is VPC_ENDPOINT_SERVICE
.
The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.
Uniqueness requirements:
- External key stores with
VPC_ENDPOINT_SERVICE
connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.
createCustomKeyStore_customKeyStoreName :: Lens' CreateCustomKeyStore Text Source #
Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.
createCustomKeyStoreResponse_customKeyStoreId :: Lens' CreateCustomKeyStoreResponse (Maybe Text) Source #
A unique identifier for the new custom key store.
createCustomKeyStoreResponse_httpStatus :: Lens' CreateCustomKeyStoreResponse Int Source #
The response's http status code.
CreateGrant
createGrant_constraints :: Lens' CreateGrant (Maybe GrantConstraints) Source #
Specifies a grant constraint.
KMS supports the EncryptionContextEquals
and EncryptionContextSubset
grant constraints. Each constraint value can include up to 8 encryption
context pairs. The encryption context value in each constraint cannot
exceed 384 characters. For information about grant constraints, see
Using grant constraints
in the Key Management Service Developer Guide. For more information
about encryption context, see
Encryption context
in the /Key Management Service Developer Guide/ .
The encryption context grant constraints allow the permissions in the
grant only when the encryption context in the request matches
(EncryptionContextEquals
) or includes (EncryptionContextSubset
) the
encryption context specified in this structure.
The encryption context grant constraints are supported only on
grant operations
that include an EncryptionContext
parameter, such as cryptographic
operations on symmetric encryption KMS keys. Grants with grant
constraints can include the DescribeKey and RetireGrant operations, but
the constraint doesn't apply to these operations. If a grant with a
grant constraint includes the CreateGrant
operation, the constraint
requires that any grants created with the CreateGrant
permission have
an equally strict or stricter encryption context constraint.
You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. These keys don't support an encryption context.
createGrant_grantTokens :: Lens' CreateGrant (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
createGrant_name :: Lens' CreateGrant (Maybe Text) Source #
A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant
requests result in a new
grant with a unique GrantId
even if all the supplied parameters are
identical. This can result in unintended duplicates when you retry the
CreateGrant
request.
When this value is present, you can retry a CreateGrant
request with
identical parameters; if the grant already exists, the original
GrantId
is returned without creating a new grant. Note that the
returned grant token is unique with every CreateGrant
request, even
when a duplicate GrantId
is returned. All grant tokens for the same
grant ID can be used interchangeably.
createGrant_retiringPrincipal :: Lens' CreateGrant (Maybe Text) Source #
The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
createGrant_keyId :: Lens' CreateGrant Text Source #
Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
createGrant_granteePrincipal :: Lens' CreateGrant Text Source #
The identity that gets the permissions specified in the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.
createGrant_operations :: Lens' CreateGrant [GrantOperation] Source #
A list of operations that the grant permits.
This list must include only operations that are permitted in a grant.
Also, the operation must be supported on the KMS key. For example, you
cannot create a grant for a symmetric encryption KMS key that allows the
Sign operation, or a grant for an asymmetric KMS key that allows the
GenerateDataKey operation. If you try, KMS returns a ValidationError
exception. For details, see
Grant operations
in the Key Management Service Developer Guide.
createGrantResponse_grantId :: Lens' CreateGrantResponse (Maybe Text) Source #
The unique identifier for the grant.
You can use the GrantId
in a ListGrants, RetireGrant, or RevokeGrant
operation.
createGrantResponse_grantToken :: Lens' CreateGrantResponse (Maybe Text) Source #
The grant token.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
createGrantResponse_httpStatus :: Lens' CreateGrantResponse Int Source #
The response's http status code.
CreateKey
createKey_bypassPolicyLockoutSafetyCheck :: Lens' CreateKey (Maybe Bool) Source #
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the /Key Management Service Developer Guide/ .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
createKey_customKeyStoreId :: Lens' CreateKey (Maybe Text) Source #
Creates the KMS key in the specified
custom key store.
The ConnectionState
of the custom key store must be CONNECTED
. To
find the CustomKeyStoreID and ConnectionState use the
DescribeCustomKeyStores operation.
This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.
When you create a KMS key in an CloudHSM key store, KMS generates a
non-exportable 256-bit symmetric key in its associated CloudHSM cluster
and associates it with the KMS key. When you create a KMS key in an
external key store, you must use the XksKeyId
parameter to specify an
external key that serves as key material for the KMS key.
createKey_customerMasterKeySpec :: Lens' CreateKey (Maybe CustomerMasterKeySpec) Source #
Instead, use the KeySpec
parameter.
The KeySpec
and CustomerMasterKeySpec
parameters work the same way.
Only the names differ. We recommend that you use KeySpec
parameter in
your code. However, to avoid breaking changes, KMS supports both
parameters.
createKey_description :: Lens' CreateKey (Maybe Text) Source #
A description of the KMS key.
Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).
To set or change the description after the key is created, use UpdateKeyDescription.
createKey_keySpec :: Lens' CreateKey (Maybe KeySpec) Source #
Specifies the type of KMS key to create. The default value,
SYMMETRIC_DEFAULT
, creates a KMS key with a 256-bit AES-GCM key that
is used for encryption and decryption, except in China Regions, where it
creates a 128-bit symmetric key that uses SM4 encryption. For help
choosing a key spec for your KMS key, see
Choosing a KMS key type
in the /Key Management Service Developer Guide/ .
The KeySpec
determines whether the KMS key contains a symmetric key or
an asymmetric key pair. It also determines the algorithms that the KMS
key supports. You can't change the KeySpec
after the KMS key is
created. To further restrict the algorithms that can be used with the
KMS key, use a condition key in its key policy or IAM policy. For more
information, see
kms:EncryptionAlgorithm,
kms:MacAlgorithm
or
kms:Signing Algorithm
in the /Key Management Service Developer Guide/ .
Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.
KMS supports the following key specs for KMS keys:
Symmetric encryption key (default)
SYMMETRIC_DEFAULT
HMAC keys (symmetric)
HMAC_224
HMAC_256
HMAC_384
HMAC_512
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256
(secp256r1)ECC_NIST_P384
(secp384r1)ECC_NIST_P521
(secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1
(secp256k1), commonly used for cryptocurrencies.
SM2 key pairs (China Regions only)
SM2
createKey_keyUsage :: Lens' CreateKey (Maybe KeyUsageType) Source #
Determines the
cryptographic operations
for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT
. This parameter is optional when you are creating a
symmetric encryption KMS key; otherwise, it is required. You can't
change the KeyUsage
value after the KMS key is created.
Select only one valid value.
- For symmetric encryption KMS keys, omit the parameter or specify
ENCRYPT_DECRYPT
. - For HMAC KMS keys (symmetric), specify
GENERATE_VERIFY_MAC
. - For asymmetric KMS keys with RSA key material, specify
ENCRYPT_DECRYPT
orSIGN_VERIFY
. - For asymmetric KMS keys with ECC key material, specify
SIGN_VERIFY
. - For asymmetric KMS keys with SM2 key material (China Regions only),
specify
ENCRYPT_DECRYPT
orSIGN_VERIFY
.
createKey_multiRegion :: Lens' CreateKey (Maybe Bool) Source #
Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.
For a multi-Region key, set this parameter to True
. For a
single-Region KMS key, omit this parameter or set it to False
. The
default value is False
.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
This value creates a primary key, not a replica. To create a /replica key/, use the ReplicateKey operation.
You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
createKey_origin :: Lens' CreateKey (Maybe OriginType) Source #
The source of the key material for the KMS key. You cannot change the
origin after you create the KMS key. The default is AWS_KMS
, which
means that KMS creates the key material.
To
create a KMS key with no key material
(for imported key material), set this value to EXTERNAL
. For more
information about importing key material into KMS, see
Importing Key Material
in the Key Management Service Developer Guide. The EXTERNAL
origin
value is valid only for symmetric KMS keys.
To
create a KMS key in an CloudHSM key store
and create its key material in the associated CloudHSM cluster, set this
value to AWS_CLOUDHSM
. You must also use the CustomKeyStoreId
parameter to identify the CloudHSM key store. The KeySpec
value must
be SYMMETRIC_DEFAULT
.
To
create a KMS key in an external key store,
set this value to EXTERNAL_KEY_STORE
. You must also use the
CustomKeyStoreId
parameter to identify the external key store and the
XksKeyId
parameter to identify the associated external key. The
KeySpec
value must be SYMMETRIC_DEFAULT
.
createKey_policy :: Lens' CreateKey (Maybe Text) Source #
The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
- If you don't set
BypassPolicyLockoutSafetyCheck
to true, the key policy must allow the principal that is making theCreateKey
request to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Amazon Web Services Identity and Access Management User Guide/.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default Key Policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .
createKey_tags :: Lens' CreateKey (Maybe [Tag]) Source #
Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
createKey_xksKeyId :: Lens' CreateKey (Maybe Text) Source #
Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.
This parameter is required for a KMS key with an Origin
value of
EXTERNAL_KEY_STORE
. It is not valid for KMS keys with any other
Origin
value.
The external key must be an existing 256-bit AES symmetric encryption
key hosted outside of Amazon Web Services in an external key manager
associated with the external key store specified by the
CustomKeyStoreId
parameter. This key must be enabled and configured to
perform encryption and decryption. Each KMS key in an external key store
must use a different external key. For details, see
Requirements for a KMS key in an external key store
in the Key Management Service Developer Guide.
Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as /double encryption/. For details, see Double encryption in the Key Management Service Developer Guide.
createKeyResponse_keyMetadata :: Lens' CreateKeyResponse (Maybe KeyMetadata) Source #
Metadata associated with the KMS key.
createKeyResponse_httpStatus :: Lens' CreateKeyResponse Int Source #
The response's http status code.
Decrypt
decrypt_encryptionAlgorithm :: Lens' Decrypt (Maybe EncryptionAlgorithmSpec) Source #
Specifies the encryption algorithm that will be used to decrypt the
ciphertext. Specify the same algorithm that was used to encrypt the
data. If you specify a different algorithm, the Decrypt
operation
fails.
This parameter is required only when the ciphertext was encrypted under
an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT
,
represents the only supported algorithm that is valid for symmetric
encryption KMS keys.
decrypt_encryptionContext :: Lens' Decrypt (Maybe (HashMap Text Text)) Source #
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
decrypt_grantTokens :: Lens' Decrypt (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
decrypt_keyId :: Lens' Decrypt (Maybe Text) Source #
Specifies the KMS key that KMS uses to decrypt the ciphertext.
Enter a key ID of the KMS key that was used to encrypt the ciphertext.
If you identify a different KMS key, the Decrypt
operation throws an
IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
decrypt_ciphertextBlob :: Lens' Decrypt ByteString Source #
Ciphertext to be decrypted. The blob includes metadata.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
decryptResponse_encryptionAlgorithm :: Lens' DecryptResponse (Maybe EncryptionAlgorithmSpec) Source #
The encryption algorithm that was used to decrypt the ciphertext.
decryptResponse_keyId :: Lens' DecryptResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
decryptResponse_plaintext :: Lens' DecryptResponse (Maybe ByteString) Source #
Decrypted plaintext data. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
decryptResponse_httpStatus :: Lens' DecryptResponse Int Source #
The response's http status code.
DeleteAlias
deleteAlias_aliasName :: Lens' DeleteAlias Text Source #
The alias to be deleted. The alias name must begin with alias/
followed by the alias name, such as alias/ExampleAlias
.
DeleteCustomKeyStore
deleteCustomKeyStore_customKeyStoreId :: Lens' DeleteCustomKeyStore Text Source #
Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
deleteCustomKeyStoreResponse_httpStatus :: Lens' DeleteCustomKeyStoreResponse Int Source #
The response's http status code.
DeleteImportedKeyMaterial
deleteImportedKeyMaterial_keyId :: Lens' DeleteImportedKeyMaterial Text Source #
Identifies the KMS key from which you are deleting imported key
material. The Origin
of the KMS key must be EXTERNAL
.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
DescribeCustomKeyStores
describeCustomKeyStores_customKeyStoreId :: Lens' DescribeCustomKeyStores (Maybe Text) Source #
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores
in the account and Region. To limit the output to a particular custom
key store, provide either the CustomKeyStoreId
or CustomKeyStoreName
parameter, but not both.
describeCustomKeyStores_customKeyStoreName :: Lens' DescribeCustomKeyStores (Maybe Text) Source #
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores
in the account and Region. To limit the output to a particular custom
key store, provide either the CustomKeyStoreId
or CustomKeyStoreName
parameter, but not both.
describeCustomKeyStores_limit :: Lens' DescribeCustomKeyStores (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
describeCustomKeyStores_marker :: Lens' DescribeCustomKeyStores (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
describeCustomKeyStoresResponse_customKeyStores :: Lens' DescribeCustomKeyStoresResponse (Maybe [CustomKeyStoresListEntry]) Source #
Contains metadata about each custom key store.
describeCustomKeyStoresResponse_nextMarker :: Lens' DescribeCustomKeyStoresResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
describeCustomKeyStoresResponse_truncated :: Lens' DescribeCustomKeyStoresResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
describeCustomKeyStoresResponse_httpStatus :: Lens' DescribeCustomKeyStoresResponse Int Source #
The response's http status code.
DescribeKey
describeKey_grantTokens :: Lens' DescribeKey (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
describeKey_keyId :: Lens' DescribeKey Text Source #
Describes the specified KMS key.
If you specify a predefined Amazon Web Services alias (an Amazon Web
Services alias with no key ID), KMS associates the alias with an
Amazon Web Services managed key
and returns its KeyId
and Arn
in the response.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
describeKeyResponse_keyMetadata :: Lens' DescribeKeyResponse (Maybe KeyMetadata) Source #
Metadata associated with the key.
describeKeyResponse_httpStatus :: Lens' DescribeKeyResponse Int Source #
The response's http status code.
DisableKey
disableKey_keyId :: Lens' DisableKey Text Source #
Identifies the KMS key to disable.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
DisableKeyRotation
disableKeyRotation_keyId :: Lens' DisableKeyRotation Text Source #
Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
DisconnectCustomKeyStore
disconnectCustomKeyStore_customKeyStoreId :: Lens' DisconnectCustomKeyStore Text Source #
Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
disconnectCustomKeyStoreResponse_httpStatus :: Lens' DisconnectCustomKeyStoreResponse Int Source #
The response's http status code.
EnableKey
enableKey_keyId :: Lens' EnableKey Text Source #
Identifies the KMS key to enable.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
EnableKeyRotation
enableKeyRotation_keyId :: Lens' EnableKeyRotation Text Source #
Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Encrypt
encrypt_encryptionAlgorithm :: Lens' Encrypt (Maybe EncryptionAlgorithmSpec) Source #
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default
value, SYMMETRIC_DEFAULT
, is the algorithm used for symmetric
encryption KMS keys. If you are using an asymmetric KMS key, we
recommend RSAES_OAEP_SHA_256.
The SM2PKE algorithm is only available in China Regions.
encrypt_encryptionContext :: Lens' Encrypt (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
encrypt_grantTokens :: Lens' Encrypt (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
encrypt_keyId :: Lens' Encrypt Text Source #
Identifies the KMS key to use in the encryption operation. The KMS key
must have a KeyUsage
of ENCRYPT_DECRYPT
. To find the KeyUsage
of a
KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
encrypt_plaintext :: Lens' Encrypt ByteString Source #
Data to be encrypted.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
encryptResponse_ciphertextBlob :: Lens' EncryptResponse (Maybe ByteString) Source #
The encrypted plaintext. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
encryptResponse_encryptionAlgorithm :: Lens' EncryptResponse (Maybe EncryptionAlgorithmSpec) Source #
The encryption algorithm that was used to encrypt the plaintext.
encryptResponse_keyId :: Lens' EncryptResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
encryptResponse_httpStatus :: Lens' EncryptResponse Int Source #
The response's http status code.
GenerateDataKey
generateDataKey_encryptionContext :: Lens' GenerateDataKey (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used when encrypting the data key.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
generateDataKey_grantTokens :: Lens' GenerateDataKey (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
generateDataKey_keySpec :: Lens' GenerateDataKey (Maybe DataKeySpec) Source #
Specifies the length of the data key. Use AES_128
to generate a
128-bit symmetric key, or AES_256
to generate a 256-bit symmetric key.
You must specify either the KeySpec
or the NumberOfBytes
parameter
(but not both) in every GenerateDataKey
request.
generateDataKey_numberOfBytes :: Lens' GenerateDataKey (Maybe Natural) Source #
Specifies the length of the data key in bytes. For example, use the
value 64 to generate a 512-bit data key (64 bytes is 512 bits). For
128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec
parameter.
You must specify either the KeySpec
or the NumberOfBytes
parameter
(but not both) in every GenerateDataKey
request.
generateDataKey_keyId :: Lens' GenerateDataKey Text Source #
Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
generateDataKeyResponse_httpStatus :: Lens' GenerateDataKeyResponse Int Source #
The response's http status code.
generateDataKeyResponse_keyId :: Lens' GenerateDataKeyResponse Text Source #
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
generateDataKeyResponse_plaintext :: Lens' GenerateDataKeyResponse ByteString Source #
The plaintext data key. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded. Use this data key to encrypt your data outside of KMS.
Then, remove it from memory as soon as possible.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyResponse_ciphertextBlob :: Lens' GenerateDataKeyResponse ByteString Source #
The encrypted copy of the data key. When you use the HTTP API or the
Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is
not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
GenerateDataKeyPair
generateDataKeyPair_encryptionContext :: Lens' GenerateDataKeyPair (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
generateDataKeyPair_grantTokens :: Lens' GenerateDataKeyPair (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
generateDataKeyPair_keyId :: Lens' GenerateDataKeyPair Text Source #
Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
generateDataKeyPair_keyPairSpec :: Lens' GenerateDataKeyPair DataKeyPairSpec Source #
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.
generateDataKeyPairResponse_keyId :: Lens' GenerateDataKeyPairResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
generateDataKeyPairResponse_keyPairSpec :: Lens' GenerateDataKeyPairResponse (Maybe DataKeyPairSpec) Source #
The type of data key pair that was generated.
generateDataKeyPairResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The encrypted copy of the private key. When you use the HTTP API or the
Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is
not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyPairResponse_privateKeyPlaintext :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The plaintext copy of the private key. When you use the HTTP API or the
Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is
not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyPairResponse_publicKey :: Lens' GenerateDataKeyPairResponse (Maybe ByteString) Source #
The public key (in plaintext). When you use the HTTP API or the Amazon
Web Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyPairResponse_httpStatus :: Lens' GenerateDataKeyPairResponse Int Source #
The response's http status code.
GenerateDataKeyPairWithoutPlaintext
generateDataKeyPairWithoutPlaintext_encryptionContext :: Lens' GenerateDataKeyPairWithoutPlaintext (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
generateDataKeyPairWithoutPlaintext_grantTokens :: Lens' GenerateDataKeyPairWithoutPlaintext (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
generateDataKeyPairWithoutPlaintext_keyId :: Lens' GenerateDataKeyPairWithoutPlaintext Text Source #
Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
generateDataKeyPairWithoutPlaintext_keyPairSpec :: Lens' GenerateDataKeyPairWithoutPlaintext DataKeyPairSpec Source #
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.
generateDataKeyPairWithoutPlaintextResponse_keyId :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
generateDataKeyPairWithoutPlaintextResponse_keyPairSpec :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe DataKeyPairSpec) Source #
The type of data key pair that was generated.
generateDataKeyPairWithoutPlaintextResponse_privateKeyCiphertextBlob :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe ByteString) Source #
The encrypted copy of the private key. When you use the HTTP API or the
Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is
not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyPairWithoutPlaintextResponse_publicKey :: Lens' GenerateDataKeyPairWithoutPlaintextResponse (Maybe ByteString) Source #
The public key (in plaintext). When you use the HTTP API or the Amazon
Web Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyPairWithoutPlaintextResponse_httpStatus :: Lens' GenerateDataKeyPairWithoutPlaintextResponse Int Source #
The response's http status code.
GenerateDataKeyWithoutPlaintext
generateDataKeyWithoutPlaintext_encryptionContext :: Lens' GenerateDataKeyWithoutPlaintext (Maybe (HashMap Text Text)) Source #
Specifies the encryption context that will be used when encrypting the data key.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
generateDataKeyWithoutPlaintext_grantTokens :: Lens' GenerateDataKeyWithoutPlaintext (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
generateDataKeyWithoutPlaintext_keySpec :: Lens' GenerateDataKeyWithoutPlaintext (Maybe DataKeySpec) Source #
The length of the data key. Use AES_128
to generate a 128-bit
symmetric key, or AES_256
to generate a 256-bit symmetric key.
generateDataKeyWithoutPlaintext_numberOfBytes :: Lens' GenerateDataKeyWithoutPlaintext (Maybe Natural) Source #
The length of the data key in bytes. For example, use the value 64 to
generate a 512-bit data key (64 bytes is 512 bits). For common key
lengths (128-bit and 256-bit symmetric keys), we recommend that you use
the KeySpec
field instead of this one.
generateDataKeyWithoutPlaintext_keyId :: Lens' GenerateDataKeyWithoutPlaintext Text Source #
Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
generateDataKeyWithoutPlaintextResponse_ciphertextBlob :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe ByteString) Source #
The encrypted data key. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateDataKeyWithoutPlaintextResponse_keyId :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
generateDataKeyWithoutPlaintextResponse_httpStatus :: Lens' GenerateDataKeyWithoutPlaintextResponse Int Source #
The response's http status code.
GenerateMac
generateMac_grantTokens :: Lens' GenerateMac (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
generateMac_message :: Lens' GenerateMac ByteString Source #
The message to be hashed. Specify a message of up to 4,096 bytes.
GenerateMac
and VerifyMac do not provide special handling for message
digests. If you generate an HMAC for a hash digest of a message, you
must verify the HMAC of the same hash digest.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateMac_keyId :: Lens' GenerateMac Text Source #
The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.
To identify an HMAC KMS key, use the DescribeKey operation and see the
KeySpec
field in the response.
generateMac_macAlgorithm :: Lens' GenerateMac MacAlgorithmSpec Source #
The MAC algorithm used in the operation.
The algorithm must be compatible with the HMAC KMS key that you specify.
To find the MAC algorithms that your HMAC KMS key supports, use the
DescribeKey operation and see the MacAlgorithms
field in the
DescribeKey
response.
generateMacResponse_keyId :: Lens' GenerateMacResponse (Maybe Text) Source #
The HMAC KMS key used in the operation.
generateMacResponse_mac :: Lens' GenerateMacResponse (Maybe ByteString) Source #
The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.
This is the standard, raw HMAC defined in
RFC 2104.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateMacResponse_macAlgorithm :: Lens' GenerateMacResponse (Maybe MacAlgorithmSpec) Source #
The MAC algorithm that was used to generate the HMAC.
generateMacResponse_httpStatus :: Lens' GenerateMacResponse Int Source #
The response's http status code.
GenerateRandom
generateRandom_customKeyStoreId :: Lens' GenerateRandom (Maybe Text) Source #
Generates the random byte string in the CloudHSM cluster that is associated with the specified CloudHSM key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
External key store IDs are not valid for this parameter. If you specify
the ID of an external key store, GenerateRandom
throws an
UnsupportedOperationException
.
generateRandom_numberOfBytes :: Lens' GenerateRandom (Maybe Natural) Source #
The length of the random byte string. This parameter is required.
generateRandomResponse_plaintext :: Lens' GenerateRandomResponse (Maybe ByteString) Source #
The random byte string. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
generateRandomResponse_httpStatus :: Lens' GenerateRandomResponse Int Source #
The response's http status code.
GetKeyPolicy
getKeyPolicy_keyId :: Lens' GetKeyPolicy Text Source #
Gets the key policy for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
getKeyPolicy_policyName :: Lens' GetKeyPolicy Text Source #
Specifies the name of the key policy. The only valid name is default
.
To get the names of key policies, use ListKeyPolicies.
getKeyPolicyResponse_policy :: Lens' GetKeyPolicyResponse (Maybe Text) Source #
A key policy document in JSON format.
getKeyPolicyResponse_httpStatus :: Lens' GetKeyPolicyResponse Int Source #
The response's http status code.
GetKeyRotationStatus
getKeyRotationStatus_keyId :: Lens' GetKeyRotationStatus Text Source #
Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
getKeyRotationStatusResponse_keyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool) Source #
A Boolean value that specifies whether key rotation is enabled.
getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int Source #
The response's http status code.
GetParametersForImport
getParametersForImport_keyId :: Lens' GetParametersForImport Text Source #
The identifier of the symmetric encryption KMS key into which you will
import key material. The Origin
of the KMS key must be EXTERNAL
.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
getParametersForImport_wrappingAlgorithm :: Lens' GetParametersForImport AlgorithmSpec Source #
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
getParametersForImport_wrappingKeySpec :: Lens' GetParametersForImport WrappingKeySpec Source #
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
getParametersForImportResponse_importToken :: Lens' GetParametersForImportResponse (Maybe ByteString) Source #
The import token to send in a subsequent ImportKeyMaterial request.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
getParametersForImportResponse_keyId :: Lens' GetParametersForImportResponse (Maybe Text) Source #
The Amazon Resource Name
(key ARN)
of the KMS key to use in a subsequent ImportKeyMaterial request. This is
the same KMS key specified in the GetParametersForImport
request.
getParametersForImportResponse_parametersValidTo :: Lens' GetParametersForImportResponse (Maybe UTCTime) Source #
The time at which the import token and public key are no longer valid.
After this time, you cannot use them to make an ImportKeyMaterial
request and you must send another GetParametersForImport
request to
get new ones.
getParametersForImportResponse_publicKey :: Lens' GetParametersForImportResponse (Maybe ByteString) Source #
The public key to use to encrypt the key material before importing it
with ImportKeyMaterial.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
getParametersForImportResponse_httpStatus :: Lens' GetParametersForImportResponse Int Source #
The response's http status code.
GetPublicKey
getPublicKey_grantTokens :: Lens' GetPublicKey (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
getPublicKey_keyId :: Lens' GetPublicKey Text Source #
Identifies the asymmetric KMS key that includes the public key.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
getPublicKeyResponse_customerMasterKeySpec :: Lens' GetPublicKeyResponse (Maybe CustomerMasterKeySpec) Source #
Instead, use the KeySpec
field in the GetPublicKey
response.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We
recommend that you use the KeySpec
field in your code. However, to
avoid breaking changes, KMS supports both fields.
getPublicKeyResponse_encryptionAlgorithms :: Lens' GetPublicKeyResponse (Maybe [EncryptionAlgorithmSpec]) Source #
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage
of the
public key is ENCRYPT_DECRYPT
.
getPublicKeyResponse_keyId :: Lens' GetPublicKeyResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
getPublicKeyResponse_keySpec :: Lens' GetPublicKeyResponse (Maybe KeySpec) Source #
The type of the of the public key that was downloaded.
getPublicKeyResponse_keyUsage :: Lens' GetPublicKeyResponse (Maybe KeyUsageType) Source #
The permitted use of the public key. Valid values are ENCRYPT_DECRYPT
or SIGN_VERIFY
.
This information is critical. If a public key with SIGN_VERIFY
key
usage encrypts data outside of KMS, the ciphertext cannot be decrypted.
getPublicKeyResponse_publicKey :: Lens' GetPublicKeyResponse (Maybe ByteString) Source #
The exported public key.
The value is a DER-encoded X.509 public key, also known as
SubjectPublicKeyInfo
(SPKI), as defined in
RFC 5280. When you use the HTTP
API or the Amazon Web Services CLI, the value is Base64-encoded.
Otherwise, it is not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
getPublicKeyResponse_signingAlgorithms :: Lens' GetPublicKeyResponse (Maybe [SigningAlgorithmSpec]) Source #
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage
of the
public key is SIGN_VERIFY
.
getPublicKeyResponse_httpStatus :: Lens' GetPublicKeyResponse Int Source #
The response's http status code.
ImportKeyMaterial
importKeyMaterial_expirationModel :: Lens' ImportKeyMaterial (Maybe ExpirationModelType) Source #
Specifies whether the key material expires. The default is
KEY_MATERIAL_EXPIRES
.
When the value of ExpirationModel
is KEY_MATERIAL_EXPIRES
, you must
specify a value for the ValidTo
parameter. When value is
KEY_MATERIAL_DOES_NOT_EXPIRE
, you must omit the ValidTo
parameter.
You cannot change the ExpirationModel
or ValidTo
values for the
current import after the request completes. To change either value, you
must delete (DeleteImportedKeyMaterial) and reimport the key material.
importKeyMaterial_validTo :: Lens' ImportKeyMaterial (Maybe UTCTime) Source #
The date and time when the imported key material expires. This parameter
is required when the value of the ExpirationModel
parameter is
KEY_MATERIAL_EXPIRES
. Otherwise it is not valid.
The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.
When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.
You cannot change the ExpirationModel
or ValidTo
values for the
current import after the request completes. To change either value, you
must delete (DeleteImportedKeyMaterial) and reimport the key material.
importKeyMaterial_keyId :: Lens' ImportKeyMaterial Text Source #
The identifier of the symmetric encryption KMS key that receives the
imported key material. This must be the same KMS key specified in the
KeyID
parameter of the corresponding GetParametersForImport request.
The Origin
of the KMS key must be EXTERNAL
. You cannot perform this
operation on an asymmetric KMS key, an HMAC KMS key, a KMS key in a
custom key store, or on a KMS key in a different Amazon Web Services
account
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
importKeyMaterial_importToken :: Lens' ImportKeyMaterial ByteString Source #
The import token that you received in the response to a previous
GetParametersForImport request. It must be from the same response that
contained the public key that you used to encrypt the key material.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
importKeyMaterial_encryptedKeyMaterial :: Lens' ImportKeyMaterial ByteString Source #
The encrypted key material to import. The key material must be encrypted
with the public wrapping key that GetParametersForImport returned, using
the wrapping algorithm that you specified in the same
GetParametersForImport
request.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
importKeyMaterialResponse_httpStatus :: Lens' ImportKeyMaterialResponse Int Source #
The response's http status code.
ListAliases
listAliases_keyId :: Lens' ListAliases (Maybe Text) Source #
Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases
returns all
aliases in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
listAliases_limit :: Lens' ListAliases (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
listAliases_marker :: Lens' ListAliases (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
listAliasesResponse_aliases :: Lens' ListAliasesResponse (Maybe [AliasListEntry]) Source #
A list of aliases.
listAliasesResponse_nextMarker :: Lens' ListAliasesResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listAliasesResponse_truncated :: Lens' ListAliasesResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #
The response's http status code.
ListGrants
listGrants_grantId :: Lens' ListGrants (Maybe Text) Source #
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
listGrants_granteePrincipal :: Lens' ListGrants (Maybe Text) Source #
Returns only grants where the specified principal is the grantee principal for the grant.
listGrants_limit :: Lens' ListGrants (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
listGrants_marker :: Lens' ListGrants (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
listGrants_keyId :: Lens' ListGrants Text Source #
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry]) Source #
A list of grants.
listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
ListKeyPolicies
listKeyPolicies_limit :: Lens' ListKeyPolicies (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Only one policy can be attached to a key.
listKeyPolicies_marker :: Lens' ListKeyPolicies (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
listKeyPolicies_keyId :: Lens' ListKeyPolicies Text Source #
Gets the names of key policies for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
listKeyPoliciesResponse_nextMarker :: Lens' ListKeyPoliciesResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listKeyPoliciesResponse_policyNames :: Lens' ListKeyPoliciesResponse (Maybe [Text]) Source #
A list of key policy names. The only valid value is default
.
listKeyPoliciesResponse_truncated :: Lens' ListKeyPoliciesResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
listKeyPoliciesResponse_httpStatus :: Lens' ListKeyPoliciesResponse Int Source #
The response's http status code.
ListKeys
listKeys_limit :: Lens' ListKeys (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
listKeys_marker :: Lens' ListKeys (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
listKeysResponse_keys :: Lens' ListKeysResponse (Maybe [KeyListEntry]) Source #
A list of KMS keys.
listKeysResponse_nextMarker :: Lens' ListKeysResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listKeysResponse_truncated :: Lens' ListKeysResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
listKeysResponse_httpStatus :: Lens' ListKeysResponse Int Source #
The response's http status code.
ListResourceTags
listResourceTags_limit :: Lens' ListResourceTags (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.
listResourceTags_marker :: Lens' ListResourceTags (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
Do not attempt to construct this value. Use only the value of
NextMarker
from the truncated response you just received.
listResourceTags_keyId :: Lens' ListResourceTags Text Source #
Gets tags on the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
listResourceTagsResponse_nextMarker :: Lens' ListResourceTagsResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
Do not assume or infer any information from this value.
listResourceTagsResponse_tags :: Lens' ListResourceTagsResponse (Maybe [Tag]) Source #
A list of tags. Each tag consists of a tag key and a tag value.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
listResourceTagsResponse_truncated :: Lens' ListResourceTagsResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
listResourceTagsResponse_httpStatus :: Lens' ListResourceTagsResponse Int Source #
The response's http status code.
ListRetirableGrants
listRetirableGrants_limit :: Lens' ListRetirableGrants (Maybe Natural) Source #
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
listRetirableGrants_marker :: Lens' ListRetirableGrants (Maybe Text) Source #
Use this parameter in a subsequent request after you receive a response
with truncated results. Set it to the value of NextMarker
from the
truncated response you just received.
listRetirableGrants_retiringPrincipal :: Lens' ListRetirableGrants Text Source #
The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the /Amazon Web Services General Reference/.
listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry]) Source #
A list of grants.
listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
PutKeyPolicy
putKeyPolicy_bypassPolicyLockoutSafetyCheck :: Lens' PutKeyPolicy (Maybe Bool) Source #
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is
making the request from making a subsequent PutKeyPolicy
request on
the KMS key.
The default value is false.
putKeyPolicy_keyId :: Lens' PutKeyPolicy Text Source #
Sets the key policy on the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
putKeyPolicy_policyName :: Lens' PutKeyPolicy Text Source #
The name of the key policy. The only valid value is default
.
putKeyPolicy_policy :: Lens' PutKeyPolicy Text Source #
The key policy to attach to the KMS key.
The key policy must meet the following criteria:
- If you don't set
BypassPolicyLockoutSafetyCheck
to true, the key policy must allow the principal that is making thePutKeyPolicy
request to make a subsequentPutKeyPolicy
request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide. - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Amazon Web Services Identity and Access Management User Guide/.
A key policy document can include only the following characters:
- Printable ASCII characters from the space character (
\u0020
) through the end of the ASCII character range. - Printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF
). - The tab (
\u0009
), line feed (\u000A
), and carriage return (\u000D
) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .
ReEncrypt
reEncrypt_destinationEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec) Source #
Specifies the encryption algorithm that KMS will use to reecrypt the
data after it has decrypted it. The default value, SYMMETRIC_DEFAULT
,
represents the encryption algorithm used for symmetric encryption KMS
keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
reEncrypt_destinationEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text)) Source #
Specifies that encryption context to use when the reencrypting the data.
A destination encryption context is valid only when the destination KMS key is a symmetric encryption KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
reEncrypt_grantTokens :: Lens' ReEncrypt (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
reEncrypt_sourceEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec) Source #
Specifies the encryption algorithm that KMS will use to decrypt the
ciphertext before it is reencrypted. The default value,
SYMMETRIC_DEFAULT
, represents the algorithm used for symmetric
encryption KMS keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
reEncrypt_sourceEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text)) Source #
Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.
For more information, see Encryption context in the Key Management Service Developer Guide.
reEncrypt_sourceKeyId :: Lens' ReEncrypt (Maybe Text) Source #
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.
Enter a key ID of the KMS key that was used to encrypt the ciphertext.
If you identify a different KMS key, the ReEncrypt
operation throws an
IncorrectKeyException
.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
reEncrypt_ciphertextBlob :: Lens' ReEncrypt ByteString Source #
Ciphertext of the data to reencrypt.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
reEncrypt_destinationKeyId :: Lens' ReEncrypt Text Source #
A unique identifier for the KMS key that is used to reencrypt the data.
Specify a symmetric encryption KMS key or an asymmetric KMS key with a
KeyUsage
value of ENCRYPT_DECRYPT
. To find the KeyUsage
value of a
KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
reEncryptResponse_ciphertextBlob :: Lens' ReEncryptResponse (Maybe ByteString) Source #
The reencrypted data. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not
Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
reEncryptResponse_destinationEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec) Source #
The encryption algorithm that was used to reencrypt the data.
reEncryptResponse_keyId :: Lens' ReEncryptResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.
reEncryptResponse_sourceEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec) Source #
The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.
reEncryptResponse_sourceKeyId :: Lens' ReEncryptResponse (Maybe Text) Source #
Unique identifier of the KMS key used to originally encrypt the data.
reEncryptResponse_httpStatus :: Lens' ReEncryptResponse Int Source #
The response's http status code.
ReplicateKey
replicateKey_bypassPolicyLockoutSafetyCheck :: Lens' ReplicateKey (Maybe Bool) Source #
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is
making the request from making a subsequent PutKeyPolicy
request on
the KMS key.
The default value is false.
replicateKey_description :: Lens' ReplicateKey (Maybe Text) Source #
A description of the KMS key. The default value is an empty string (no description).
The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
replicateKey_policy :: Lens' ReplicateKey (Maybe Text) Source #
The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
- If you don't set
BypassPolicyLockoutSafetyCheck
to true, the key policy must give the callerkms:PutKeyPolicy
permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the /Key Management Service Developer Guide/ . - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the /Identity and Access Management User Guide/ .
A key policy document can include only the following characters:
- Printable ASCII characters from the space character (
\u0020
) through the end of the ASCII character range. - Printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF
). - The tab (
\u0009
), line feed (\u000A
), and carriage return (\u000D
) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the /Identity and Access Management User Guide/ .
replicateKey_tags :: Lens' ReplicateKey (Maybe [Tag]) Source #
Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
replicateKey_keyId :: Lens' ReplicateKey Text Source #
Identifies the multi-Region primary key that is being replicated. To
determine whether a KMS key is a multi-Region primary key, use the
DescribeKey operation to check the value of the MultiRegionKeyType
property.
Specify the key ID or key ARN of a multi-Region primary key.
For example:
- Key ID:
mrk-1234abcd12ab34cd56ef1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
replicateKey_replicaRegion :: Lens' ReplicateKey Text Source #
The Region ID of the Amazon Web Services Region for this replica key.
Enter the Region ID, such as us-east-1
or ap-southeast-2
. For a list
of Amazon Web Services Regions in which KMS is supported, see
KMS service endpoints
in the Amazon Web Services General Reference.
HMAC KMS keys are not supported in all Amazon Web Services Regions. If
you try to replicate an HMAC KMS key in an Amazon Web Services Region in
which HMAC keys are not supported, the ReplicateKey
operation returns
an UnsupportedOperationException
. For a list of Regions in which HMAC
KMS keys are supported, see
HMAC keys in KMS
in the Key Management Service Developer Guide.
The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
replicateKeyResponse_replicaKeyMetadata :: Lens' ReplicateKeyResponse (Maybe KeyMetadata) Source #
Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
replicateKeyResponse_replicaPolicy :: Lens' ReplicateKeyResponse (Maybe Text) Source #
The key policy of the new replica key. The value is a key policy document in JSON format.
replicateKeyResponse_replicaTags :: Lens' ReplicateKeyResponse (Maybe [Tag]) Source #
The tags on the new replica key. The value is a list of tag key and tag value pairs.
replicateKeyResponse_httpStatus :: Lens' ReplicateKeyResponse Int Source #
The response's http status code.
RetireGrant
retireGrant_grantId :: Lens' RetireGrant (Maybe Text) Source #
Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
- Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
retireGrant_grantToken :: Lens' RetireGrant (Maybe Text) Source #
Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.
Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
retireGrant_keyId :: Lens' RetireGrant (Maybe Text) Source #
The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
For example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
RevokeGrant
revokeGrant_keyId :: Lens' RevokeGrant Text Source #
A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
revokeGrant_grantId :: Lens' RevokeGrant Text Source #
Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
ScheduleKeyDeletion
scheduleKeyDeletion_pendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural) Source #
The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
scheduleKeyDeletion_keyId :: Lens' ScheduleKeyDeletion Text Source #
The unique identifier of the KMS key to delete.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
scheduleKeyDeletionResponse_deletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime) Source #
The date and time after which KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.
scheduleKeyDeletionResponse_keyId :: Lens' ScheduleKeyDeletionResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
scheduleKeyDeletionResponse_keyState :: Lens' ScheduleKeyDeletionResponse (Maybe KeyState) Source #
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
scheduleKeyDeletionResponse_pendingWindowInDays :: Lens' ScheduleKeyDeletionResponse (Maybe Natural) Source #
The waiting period before the KMS key is deleted.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
scheduleKeyDeletionResponse_httpStatus :: Lens' ScheduleKeyDeletionResponse Int Source #
The response's http status code.
Sign
sign_grantTokens :: Lens' Sign (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
sign_messageType :: Lens' Sign (Maybe MessageType) Source #
Tells KMS whether the value of the Message
parameter is a message or
message digest. The default value, RAW, indicates a message. To indicate
a message digest, enter DIGEST
.
sign_keyId :: Lens' Sign Text Source #
Identifies an asymmetric KMS key. KMS uses the private key in the
asymmetric KMS key to sign the message. The KeyUsage
type of the KMS
key must be SIGN_VERIFY
. To find the KeyUsage
of a KMS key, use the
DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
sign_message :: Lens' Sign ByteString Source #
Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and
then signs it.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
sign_signingAlgorithm :: Lens' Sign SigningAlgorithmSpec Source #
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
signResponse_keyId :: Lens' SignResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
signResponse_signature :: Lens' SignResponse (Maybe ByteString) Source #
The cryptographic signature that was generated for the message.
- When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
- When used with the
ECDSA_SHA_256
,ECDSA_SHA_384
, orECDSA_SHA_512
signing algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is
Base64-encoded. Otherwise, it is not Base64-encoded.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
signResponse_signingAlgorithm :: Lens' SignResponse (Maybe SigningAlgorithmSpec) Source #
The signing algorithm that was used to sign the message.
signResponse_httpStatus :: Lens' SignResponse Int Source #
The response's http status code.
TagResource
tagResource_keyId :: Lens' TagResource Text Source #
Identifies a customer managed key in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
tagResource_tags :: Lens' TagResource [Tag] Source #
One or more tags.
Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.
You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
UntagResource
untagResource_keyId :: Lens' UntagResource Text Source #
Identifies the KMS key from which you are removing tags.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
One or more tag keys. Specify only the tag keys, not the tag values.
UpdateAlias
updateAlias_aliasName :: Lens' UpdateAlias Text Source #
Identifies the alias that is changing its KMS key. This value must begin
with alias/
followed by the alias name, such as
alias/ExampleAlias
. You cannot use UpdateAlias
to change the alias
name.
updateAlias_targetKeyId :: Lens' UpdateAlias Text Source #
Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
UpdateCustomKeyStore
updateCustomKeyStore_cloudHsmClusterId :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Associates the custom key store with a related CloudHSM cluster. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.
To change this value, the CloudHSM key store must be disconnected.
updateCustomKeyStore_keyStorePassword :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Enter the current password of the kmsuser
crypto user (CU) in the
CloudHSM cluster that is associated with the custom key store. This
parameter is valid only for custom key stores with a
CustomKeyStoreType
of AWS_CLOUDHSM
.
This parameter tells KMS the current password of the kmsuser
crypto
user (CU). It does not set or change the password of any users in the
CloudHSM cluster.
To change this value, the CloudHSM key store must be disconnected.
updateCustomKeyStore_newCustomKeyStoreName :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.
To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.
updateCustomKeyStore_xksProxyAuthenticationCredential :: Lens' UpdateCustomKeyStore (Maybe XksProxyAuthenticationCredentialType) Source #
Changes the credentials that KMS uses to sign requests to the external
key store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
You must specify both the AccessKeyId
and SecretAccessKey
value in
the authentication credential, even if you are only updating one value.
This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.
You can change this value when the external key store is connected or disconnected.
updateCustomKeyStore_xksProxyConnectivity :: Lens' UpdateCustomKeyStore (Maybe XksProxyConnectivityType) Source #
Changes the connectivity setting for the external key store. To indicate
that the external key store proxy uses a Amazon VPC endpoint service to
communicate with KMS, specify VPC_ENDPOINT_SERVICE
. Otherwise, specify
PUBLIC_ENDPOINT
.
If you change the XksProxyConnectivity
to VPC_ENDPOINT_SERVICE
, you
must also change the XksProxyUriEndpoint
and add an
XksProxyVpcEndpointServiceName
value.
If you change the XksProxyConnectivity
to PUBLIC_ENDPOINT
, you must
also change the XksProxyUriEndpoint
and specify a null or empty string
for the XksProxyVpcEndpointServiceName
value.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_xksProxyUriEndpoint :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the URI endpoint that KMS uses to connect to your external key
store proxy (XKS proxy). This parameter is valid only for custom key
stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
For external key stores with an XksProxyConnectivity
value of
PUBLIC_ENDPOINT
, the protocol must be HTTPS.
For external key stores with an XksProxyConnectivity
value of
VPC_ENDPOINT_SERVICE
, specify https://
followed by the private DNS
name associated with the VPC endpoint service. Each external key store
must use a different private DNS name.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_xksProxyUriPath :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the base path to the proxy APIs for this external key store. To
find this value, see the documentation for your external key manager and
external key store proxy (XKS proxy). This parameter is valid only for
custom key stores with a CustomKeyStoreType
of EXTERNAL_KEY_STORE
.
The value must start with /
and must end with /kms/xks/v1
, where
v1
represents the version of the KMS external key store proxy API. You
can include an optional prefix between the required elements such as
/
example
/kms/xks/v1
.
The combined XksProxyUriEndpoint
and XksProxyUriPath
values must be
unique in the Amazon Web Services account and Region.
You can change this value when the external key store is connected or disconnected.
updateCustomKeyStore_xksProxyVpcEndpointServiceName :: Lens' UpdateCustomKeyStore (Maybe Text) Source #
Changes the name that KMS uses to identify the Amazon VPC endpoint
service for your external key store proxy (XKS proxy). This parameter is
valid when the CustomKeyStoreType
is EXTERNAL_KEY_STORE
and the
XksProxyConnectivity
is VPC_ENDPOINT_SERVICE
.
To change this value, the external key store must be disconnected.
updateCustomKeyStore_customKeyStoreId :: Lens' UpdateCustomKeyStore Text Source #
Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
updateCustomKeyStoreResponse_httpStatus :: Lens' UpdateCustomKeyStoreResponse Int Source #
The response's http status code.
UpdateKeyDescription
updateKeyDescription_keyId :: Lens' UpdateKeyDescription Text Source #
Updates the description of the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
updateKeyDescription_description :: Lens' UpdateKeyDescription Text Source #
New description for the KMS key.
UpdatePrimaryRegion
updatePrimaryRegion_keyId :: Lens' UpdatePrimaryRegion Text Source #
Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
Specify the key ID or key ARN of a multi-Region primary key.
For example:
- Key ID:
mrk-1234abcd12ab34cd56ef1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
updatePrimaryRegion_primaryRegion :: Lens' UpdatePrimaryRegion Text Source #
The Amazon Web Services Region of the new primary key. Enter the Region
ID, such as us-east-1
or ap-southeast-2
. There must be an existing
replica key in this Region.
When the operation completes, the multi-Region key in this Region will be the primary key.
Verify
verify_grantTokens :: Lens' Verify (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
verify_messageType :: Lens' Verify (Maybe MessageType) Source #
Tells KMS whether the value of the Message
parameter is a message or
message digest. The default value, RAW, indicates a message. To indicate
a message digest, enter DIGEST
.
Use the DIGEST
value only when the value of the Message
parameter is
a message digest. If you use the DIGEST
value with a raw message, the
security of the verification operation can be compromised.
verify_keyId :: Lens' Verify Text Source #
Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
When using an alias name, prefix it with "alias/"
. To specify a KMS
key in a different Amazon Web Services account, you must use the key ARN
or alias ARN.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name:
alias/ExampleAlias
- Alias ARN:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
verify_message :: Lens' Verify ByteString Source #
Specifies the message that was signed. You can submit a raw message of
up to 4096 bytes, or a hash digest of the message. If you submit a
digest, use the MessageType
parameter with a value of DIGEST
.
If the message specified here is different from the message that was
signed, the signature verification fails. A message and its hash digest
are considered to be the same message.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
verify_signature :: Lens' Verify ByteString Source #
The signature that the Sign
operation generated.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
verify_signingAlgorithm :: Lens' Verify SigningAlgorithmSpec Source #
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
verifyResponse_keyId :: Lens' VerifyResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.
verifyResponse_signatureValid :: Lens' VerifyResponse (Maybe Bool) Source #
A Boolean value that indicates whether the signature was verified. A
value of True
indicates that the Signature
was produced by signing
the Message
with the specified KeyID
and SigningAlgorithm.
If the
signature is not verified, the Verify
operation fails with a
KMSInvalidSignatureException
exception.
verifyResponse_signingAlgorithm :: Lens' VerifyResponse (Maybe SigningAlgorithmSpec) Source #
The signing algorithm that was used to verify the signature.
verifyResponse_httpStatus :: Lens' VerifyResponse Int Source #
The response's http status code.
VerifyMac
verifyMac_grantTokens :: Lens' VerifyMac (Maybe [Text]) Source #
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
verifyMac_message :: Lens' VerifyMac ByteString Source #
The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
GenerateMac and VerifyMac
do not provide special handling for message
digests. If you generated an HMAC for a hash digest of a message, you
must verify the HMAC for the same hash digest.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
verifyMac_keyId :: Lens' VerifyMac Text Source #
The KMS key that will be used in the verification.
Enter a key ID of the KMS key that was used to generate the HMAC. If you
identify a different KMS key, the VerifyMac
operation fails.
verifyMac_macAlgorithm :: Lens' VerifyMac MacAlgorithmSpec Source #
The MAC algorithm that will be used in the verification. Enter the same
MAC algorithm that was used to compute the HMAC. This algorithm must be
supported by the HMAC KMS key identified by the KeyId
parameter.
verifyMac_mac :: Lens' VerifyMac ByteString Source #
The HMAC to verify. Enter the HMAC that was generated by the GenerateMac
operation when you specified the same message, HMAC KMS key, and MAC
algorithm as the values specified in this request.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
verifyMacResponse_keyId :: Lens' VerifyMacResponse (Maybe Text) Source #
The HMAC KMS key used in the verification.
verifyMacResponse_macAlgorithm :: Lens' VerifyMacResponse (Maybe MacAlgorithmSpec) Source #
The MAC algorithm used in the verification.
verifyMacResponse_macValid :: Lens' VerifyMacResponse (Maybe Bool) Source #
A Boolean value that indicates whether the HMAC was verified. A value of
True
indicates that the HMAC (Mac
) was generated with the specified
Message
, HMAC KMS key (KeyID
) and MacAlgorithm.
.
If the HMAC is not verified, the VerifyMac
operation fails with a
KMSInvalidMacException
exception. This exception indicates that one or
more of the inputs changed since the HMAC was computed.
verifyMacResponse_httpStatus :: Lens' VerifyMacResponse Int Source #
The response's http status code.
Types
AliasListEntry
aliasListEntry_aliasArn :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the key ARN.
aliasListEntry_aliasName :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the alias. This value begins with alias/
.
aliasListEntry_creationDate :: Lens' AliasListEntry (Maybe UTCTime) Source #
Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.
aliasListEntry_lastUpdatedDate :: Lens' AliasListEntry (Maybe UTCTime) Source #
Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.
aliasListEntry_targetKeyId :: Lens' AliasListEntry (Maybe Text) Source #
String that contains the key identifier of the KMS key associated with the alias.
CustomKeyStoresListEntry
customKeyStoresListEntry_cloudHsmClusterId :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
A unique identifier for the CloudHSM cluster that is associated with an
CloudHSM key store. This field appears only when the
CustomKeyStoreType
is AWS_CLOUDHSM
.
customKeyStoresListEntry_connectionErrorCode :: Lens' CustomKeyStoresListEntry (Maybe ConnectionErrorCodeType) Source #
Describes the connection error. This field appears in the response only
when the ConnectionState
is FAILED
.
Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.
All custom key stores:
INTERNAL_ERROR
— KMS could not complete the request due to an internal error. Retry the request. ForConnectCustomKeyStore
requests, disconnect the custom key store before trying to connect again.NETWORK_ERRORS
— Network errors are preventing KMS from connecting the custom key store to its backing key store.
CloudHSM key stores:
CLUSTER_NOT_FOUND
— KMS cannot find the CloudHSM cluster with the specified cluster ID.INSUFFICIENT_CLOUDHSM_HSMS
— The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET
— At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.INVALID_CREDENTIALS
— TheKeyStorePassword
for the custom key store doesn't match the current password of thekmsuser
crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuser
account password and update theKeyStorePassword
value for the custom key store.SUBNET_NOT_FOUND
— A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.USER_LOCKED_OUT
— Thekmsuser
CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change thekmsuser
account password and update the key store password value for the custom key store.USER_LOGGED_IN
— Thekmsuser
CU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating thekmsuser
account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log thekmsuser
CU out of the cluster. If you changed thekmsuser
password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.USER_NOT_FOUND
— KMS cannot find akmsuser
CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create akmsuser
CU account in the cluster, and then update the key store password value for the custom key store.
External key stores:
INVALID_CREDENTIALS
— One or both of theXksProxyAuthenticationCredential
values is not valid on the specified external key store proxy.XKS_PROXY_ACCESS_DENIED
— KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.XKS_PROXY_INVALID_CONFIGURATION
— A configuration error is preventing the external key store from connecting to its proxy. Verify the value of theXksProxyUriPath
.XKS_PROXY_INVALID_RESPONSE
— KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_PROXY_INVALID_TLS_CONFIGURATION
— KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in theXksProxyUriEndpoint
value, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.XKS_PROXY_NOT_REACHABLE
— KMS can't communicate with your external key store proxy. Verify that theXksProxyUriEndpoint
andXksProxyUriPath
are correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.XKS_PROXY_TIMED_OUT
— KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION
— The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.- The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.
- It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.
- The
Allow principals
list must include the KMS service principal for the Region,cks.kms.<region>.amazonaws.com
, such ascks.kms.us-east-1.amazonaws.com
. - It must not require acceptance of connection requests.
- It must have a private DNS name. The private DNS name for an
external key store with
VPC_ENDPOINT_SERVICE
connectivity must be unique in its Amazon Web Services Region. - The domain of the private DNS name must have a
verification status
of
verified
. - The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.
XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND
— KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that theXksProxyVpcEndpointServiceName
is correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.
customKeyStoresListEntry_connectionState :: Lens' CustomKeyStoresListEntry (Maybe ConnectionStateType) Source #
Indicates whether the custom key store is connected to its backing key
store. For an CloudHSM key store, the ConnectionState
indicates
whether it is connected to its CloudHSM cluster. For an external key
store, the ConnectionState
indicates whether it is connected to the
external key store proxy that communicates with your external key
manager.
You can create and use KMS keys in your custom key stores only when its
ConnectionState
is CONNECTED
.
The ConnectionState
value is DISCONNECTED
only if the key store has
never been connected or you use the DisconnectCustomKeyStore operation
to disconnect it. If the value is CONNECTED
but you are having trouble
using the custom key store, make sure that the backing key store is
reachable and active. For an CloudHSM key store, verify that its
associated CloudHSM cluster is active and contains at least one active
HSM. For an external key store, verify that the external key store proxy
and external key manager are connected and enabled.
A value of FAILED
indicates that an attempt to connect was
unsuccessful. The ConnectionErrorCode
field in the response indicates
the cause of the failure. For help resolving a connection failure, see
Troubleshooting a custom key store
in the Key Management Service Developer Guide.
customKeyStoresListEntry_creationDate :: Lens' CustomKeyStoresListEntry (Maybe UTCTime) Source #
The date and time when the custom key store was created.
customKeyStoresListEntry_customKeyStoreId :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
A unique identifier for the custom key store.
customKeyStoresListEntry_customKeyStoreName :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
The user-specified friendly name for the custom key store.
customKeyStoresListEntry_customKeyStoreType :: Lens' CustomKeyStoresListEntry (Maybe CustomKeyStoreType) Source #
Indicates the type of the custom key store. AWS_CLOUDHSM
indicates a
custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE
indicates a custom key store backed by an external key store proxy and
external key manager outside of Amazon Web Services.
customKeyStoresListEntry_trustAnchorCertificate :: Lens' CustomKeyStoresListEntry (Maybe Text) Source #
The trust anchor certificate of the CloudHSM cluster associated with an
CloudHSM key store. When you
initialize the cluster,
you create this certificate and save it in the customerCA.crt
file.
This field appears only when the CustomKeyStoreType
is AWS_CLOUDHSM
.
customKeyStoresListEntry_xksProxyConfiguration :: Lens' CustomKeyStoresListEntry (Maybe XksProxyConfigurationType) Source #
Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.
This field appears only when the CustomKeyStoreType
is
EXTERNAL_KEY_STORE
.
GrantConstraints
grantConstraints_encryptionContextEquals :: Lens' GrantConstraints (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.
grantConstraints_encryptionContextSubset :: Lens' GrantConstraints (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.
GrantListEntry
grantListEntry_constraints :: Lens' GrantListEntry (Maybe GrantConstraints) Source #
A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
grantListEntry_creationDate :: Lens' GrantListEntry (Maybe UTCTime) Source #
The date and time when the grant was created.
grantListEntry_grantId :: Lens' GrantListEntry (Maybe Text) Source #
The unique identifier for the grant.
grantListEntry_granteePrincipal :: Lens' GrantListEntry (Maybe Text) Source #
The identity that gets the permissions in the grant.
The GranteePrincipal
field in the ListGrants
response usually
contains the user or role designated as the grantee principal in the
grant. However, when the grantee principal in the grant is an Amazon Web
Services service, the GranteePrincipal
field contains the
service principal,
which might represent several different grantee principals.
grantListEntry_issuingAccount :: Lens' GrantListEntry (Maybe Text) Source #
The Amazon Web Services account under which the grant was issued.
grantListEntry_keyId :: Lens' GrantListEntry (Maybe Text) Source #
The unique identifier for the KMS key to which the grant applies.
grantListEntry_name :: Lens' GrantListEntry (Maybe Text) Source #
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
grantListEntry_operations :: Lens' GrantListEntry (Maybe [GrantOperation]) Source #
The list of operations permitted by the grant.
grantListEntry_retiringPrincipal :: Lens' GrantListEntry (Maybe Text) Source #
The principal that can retire the grant.
KeyListEntry
keyListEntry_keyArn :: Lens' KeyListEntry (Maybe Text) Source #
ARN of the key.
keyListEntry_keyId :: Lens' KeyListEntry (Maybe Text) Source #
Unique identifier of the key.
KeyMetadata
keyMetadata_aWSAccountId :: Lens' KeyMetadata (Maybe Text) Source #
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
keyMetadata_arn :: Lens' KeyMetadata (Maybe Text) Source #
The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the /Amazon Web Services General Reference/.
keyMetadata_cloudHsmClusterId :: Lens' KeyMetadata (Maybe Text) Source #
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in an CloudHSM custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This field is present only when the KMS key is created in an CloudHSM key store.
keyMetadata_creationDate :: Lens' KeyMetadata (Maybe UTCTime) Source #
The date and time when the KMS key was created.
keyMetadata_customKeyStoreId :: Lens' KeyMetadata (Maybe Text) Source #
A unique identifier for the custom key store that contains the KMS key. This field is present only when the KMS key is created in a custom key store.
keyMetadata_customerMasterKeySpec :: Lens' KeyMetadata (Maybe CustomerMasterKeySpec) Source #
Instead, use the KeySpec
field.
The KeySpec
and CustomerMasterKeySpec
fields have the same value. We
recommend that you use the KeySpec
field in your code. However, to
avoid breaking changes, KMS supports both fields.
keyMetadata_deletionDate :: Lens' KeyMetadata (Maybe UTCTime) Source #
The date and time after which KMS deletes this KMS key. This value is
present only when the KMS key is scheduled for deletion, that is, when
its KeyState
is PendingDeletion
.
When the primary key in a multi-Region key is scheduled for deletion but
still has replica keys, its key state is PendingReplicaDeletion
and
the length of its waiting period is displayed in the
PendingDeletionWindowInDays
field.
keyMetadata_description :: Lens' KeyMetadata (Maybe Text) Source #
The description of the KMS key.
keyMetadata_enabled :: Lens' KeyMetadata (Maybe Bool) Source #
Specifies whether the KMS key is enabled. When KeyState
is Enabled
this value is true, otherwise it is false.
keyMetadata_encryptionAlgorithms :: Lens' KeyMetadata (Maybe [EncryptionAlgorithmSpec]) Source #
The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage
of the KMS key is
ENCRYPT_DECRYPT
.
keyMetadata_expirationModel :: Lens' KeyMetadata (Maybe ExpirationModelType) Source #
Specifies whether the KMS key's key material expires. This value is
present only when Origin
is EXTERNAL
, otherwise this value is
omitted.
keyMetadata_keyManager :: Lens' KeyMetadata (Maybe KeyManagerType) Source #
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
keyMetadata_keySpec :: Lens' KeyMetadata (Maybe KeySpec) Source #
Describes the type of key material in the KMS key.
keyMetadata_keyState :: Lens' KeyMetadata (Maybe KeyState) Source #
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.
keyMetadata_keyUsage :: Lens' KeyMetadata (Maybe KeyUsageType) Source #
The cryptographic operations for which you can use the KMS key.
keyMetadata_macAlgorithms :: Lens' KeyMetadata (Maybe [MacAlgorithmSpec]) Source #
The message authentication code (MAC) algorithm that the HMAC KMS key supports.
This value is present only when the KeyUsage
of the KMS key is
GENERATE_VERIFY_MAC
.
keyMetadata_multiRegion :: Lens' KeyMetadata (Maybe Bool) Source #
Indicates whether the KMS key is a multi-Region (True
) or regional
(False
) key. This value is True
for multi-Region primary and replica
keys and False
for regional KMS keys.
For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.
keyMetadata_multiRegionConfiguration :: Lens' KeyMetadata (Maybe MultiRegionConfiguration) Source #
Lists the primary and replica keys in same multi-Region key. This field
is present only when the value of the MultiRegion
field is True
.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyType
indicates whether the KMS key is aPRIMARY
orREPLICA
key.PrimaryKey
displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.ReplicaKeys
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
keyMetadata_origin :: Lens' KeyMetadata (Maybe OriginType) Source #
The source of the key material for the KMS key. When this value is
AWS_KMS
, KMS created the key material. When this value is EXTERNAL
,
the key material was imported or the KMS key doesn't have any key
material. When this value is AWS_CLOUDHSM
, the key material was
created in the CloudHSM cluster associated with a custom key store.
keyMetadata_pendingDeletionWindowInDays :: Lens' KeyMetadata (Maybe Natural) Source #
The waiting period before the primary key in a multi-Region key is
deleted. This waiting period begins when the last of its replica keys is
deleted. This value is present only when the KeyState
of the KMS key
is PendingReplicaDeletion
. That indicates that the KMS key is the
primary key in a multi-Region key, it is scheduled for deletion, and it
still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled
for deletion, its deletion date is displayed in the DeletionDate
field. However, when the primary key in a multi-Region key is scheduled
for deletion, its waiting period doesn't begin until all of its replica
keys are deleted. This value displays that waiting period. When the last
replica key in the multi-Region key is deleted, the KeyState
of the
scheduled primary key changes from PendingReplicaDeletion
to
PendingDeletion
and the deletion date appears in the DeletionDate
field.
keyMetadata_signingAlgorithms :: Lens' KeyMetadata (Maybe [SigningAlgorithmSpec]) Source #
The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
This field appears only when the KeyUsage
of the KMS key is
SIGN_VERIFY
.
keyMetadata_validTo :: Lens' KeyMetadata (Maybe UTCTime) Source #
The time at which the imported key material expires. When the key
material expires, KMS deletes the key material and the KMS key becomes
unusable. This value is present only for KMS keys whose Origin
is
EXTERNAL
and whose ExpirationModel
is KEY_MATERIAL_EXPIRES
,
otherwise this value is omitted.
keyMetadata_xksKeyConfiguration :: Lens' KeyMetadata (Maybe XksKeyConfigurationType) Source #
Information about the external key that is associated with a KMS key in an external key store.
For more information, see External key in the Key Management Service Developer Guide.
keyMetadata_keyId :: Lens' KeyMetadata Text Source #
The globally unique identifier for the KMS key.
ListGrantsResponse
listGrantsResponse_grants :: Lens' ListGrantsResponse (Maybe [GrantListEntry]) Source #
A list of grants.
listGrantsResponse_nextMarker :: Lens' ListGrantsResponse (Maybe Text) Source #
When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
listGrantsResponse_truncated :: Lens' ListGrantsResponse (Maybe Bool) Source #
A flag that indicates whether there are more items in the list. When
this value is true, the list in this response is truncated. To get more
items, pass the value of the NextMarker
element in thisresponse to the
Marker
parameter in a subsequent request.
MultiRegionConfiguration
multiRegionConfiguration_multiRegionKeyType :: Lens' MultiRegionConfiguration (Maybe MultiRegionKeyType) Source #
Indicates whether the KMS key is a PRIMARY
or REPLICA
key.
multiRegionConfiguration_primaryKey :: Lens' MultiRegionConfiguration (Maybe MultiRegionKey) Source #
Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.
multiRegionConfiguration_replicaKeys :: Lens' MultiRegionConfiguration (Maybe [MultiRegionKey]) Source #
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
MultiRegionKey
multiRegionKey_arn :: Lens' MultiRegionKey (Maybe Text) Source #
Displays the key ARN of a primary or replica key of a multi-Region key.
multiRegionKey_region :: Lens' MultiRegionKey (Maybe Text) Source #
Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.
Tag
XksKeyConfigurationType
xksKeyConfigurationType_id :: Lens' XksKeyConfigurationType (Maybe Text) Source #
The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.
XksProxyAuthenticationCredentialType
xksProxyAuthenticationCredentialType_accessKeyId :: Lens' XksProxyAuthenticationCredentialType Text Source #
A unique identifier for the raw secret access key.
xksProxyAuthenticationCredentialType_rawSecretAccessKey :: Lens' XksProxyAuthenticationCredentialType Text Source #
A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and =.
XksProxyConfigurationType
xksProxyConfigurationType_accessKeyId :: Lens' XksProxyConfigurationType (Maybe Text) Source #
The part of the external key store proxy authentication credential that uniquely identifies the secret access key.
xksProxyConfigurationType_connectivity :: Lens' XksProxyConfigurationType (Maybe XksProxyConnectivityType) Source #
Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.
xksProxyConfigurationType_uriEndpoint :: Lens' XksProxyConfigurationType (Maybe Text) Source #
The URI endpoint for the external key store proxy.
If the external key store proxy has a public endpoint, it is displayed here.
If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.
xksProxyConfigurationType_uriPath :: Lens' XksProxyConfigurationType (Maybe Text) Source #
The path to the external key store proxy APIs.
xksProxyConfigurationType_vpcEndpointServiceName :: Lens' XksProxyConfigurationType (Maybe Text) Source #
The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.