Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- InvalidMarkerException
- KMSInvalidStateException
- InvalidKeyUsageException
- MalformedPolicyDocumentException
- CustomKeyStoreNameInUseException
- UnsupportedOperationException
- DisabledException
- KeyUnavailableException
- IncorrectKeyMaterialException
- KMSInternalException
- TagException
- CustomKeyStoreHasCMKsException
- InvalidImportTokenException
- CloudHsmClusterNotRelatedException
- IncorrectTrustAnchorException
- CloudHsmClusterInvalidConfigurationException
- CloudHsmClusterNotActiveException
- CloudHsmClusterNotFoundException
- NotFoundException
- KMSInvalidSignatureException
- InvalidAliasNameException
- CustomKeyStoreNotFoundException
- CustomKeyStoreInvalidStateException
- InvalidGrantIdException
- InvalidGrantTokenException
- InvalidArnException
- DependencyTimeoutException
- ExpiredImportTokenException
- InvalidCiphertextException
- CloudHsmClusterInUseException
- IncorrectKeyException
- AlreadyExistsException
- LimitExceededException
- Waiters
- Operations
- Encrypt
- CreateCustomKeyStore
- ListGrants (Paginated)
- DisableKeyRotation
- Verify
- GenerateDataKeyWithoutPlaintext
- UpdateCustomKeyStore
- GetParametersForImport
- EnableKeyRotation
- DeleteCustomKeyStore
- CreateAlias
- CreateGrant
- ListAliases (Paginated)
- UpdatePrimaryRegion
- ConnectCustomKeyStore
- ListRetirableGrants
- GetPublicKey
- GenerateRandom
- CreateKey
- DisableKey
- DisconnectCustomKeyStore
- RetireGrant
- ListKeys (Paginated)
- ListResourceTags
- GetKeyRotationStatus
- GenerateDataKey
- DeleteAlias
- UpdateAlias
- DescribeKey
- DescribeCustomKeyStores
- CancelKeyDeletion
- Decrypt
- GenerateDataKeyPairWithoutPlaintext
- UpdateKeyDescription
- ReEncrypt
- TagResource
- ListKeyPolicies (Paginated)
- UntagResource
- Sign
- ScheduleKeyDeletion
- GenerateDataKeyPair
- ReplicateKey
- PutKeyPolicy
- EnableKey
- RevokeGrant
- GetKeyPolicy
- ImportKeyMaterial
- DeleteImportedKeyMaterial
- Types
- AlgorithmSpec
- ConnectionErrorCodeType
- ConnectionStateType
- CustomerMasterKeySpec
- DataKeyPairSpec
- DataKeySpec
- EncryptionAlgorithmSpec
- ExpirationModelType
- GrantOperation
- KeyManagerType
- KeySpec
- KeyState
- KeyUsageType
- MessageType
- MultiRegionKeyType
- OriginType
- SigningAlgorithmSpec
- WrappingKeySpec
- AliasListEntry
- CustomKeyStoresListEntry
- GrantConstraints
- GrantListEntry
- KeyListEntry
- KeyMetadata
- ListGrantsResponse
- MultiRegionConfiguration
- MultiRegionKey
- Tag
Derived from API version 2014-11-01
of the AWS service descriptions, licensed under Apache 2.0.
Key Management Service
Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS operations that you can call programmatically. For general information about KMS, see the Key Management Service Developer Guide .
KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.
Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to KMS and other Amazon Web Services services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your Amazon Web Services account (root) access key ID and secret key for everyday work with KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary security credentials that you can use to sign requests.
All KMS operations require Signature Version 4.
Logging API Requests
KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
- Amazon Web Services Security Credentials
- This topic provides general information about the types of credentials used to access Amazon Web Services.
- Temporary Security Credentials
- This section of the IAM User Guide describes how to create and use temporary security credentials.
- Signature Version 4 Signing Process
- This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
- Encrypt
- Decrypt
- GenerateDataKey
- GenerateDataKeyWithoutPlaintext
Synopsis
- defaultService :: Service
- _InvalidMarkerException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKeyUsageException :: AsError a => Getting (First ServiceError) a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomKeyStoreNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _KeyUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncorrectKeyMaterialException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSInternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomKeyStoreHasCMKsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHsmClusterNotRelatedException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncorrectTrustAnchorException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHsmClusterInvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHsmClusterNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHsmClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSInvalidSignatureException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAliasNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomKeyStoreNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomKeyStoreInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidGrantIdException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidGrantTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArnException :: AsError a => Getting (First ServiceError) a ServiceError
- _DependencyTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError
- _ExpiredImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCiphertextException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudHsmClusterInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _IncorrectKeyException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data Encrypt = Encrypt' (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) Text (Sensitive Base64)
- newEncrypt :: Text -> ByteString -> Encrypt
- data EncryptResponse = EncryptResponse' (Maybe Text) (Maybe EncryptionAlgorithmSpec) (Maybe Base64) Int
- newEncryptResponse :: Int -> EncryptResponse
- data CreateCustomKeyStore = CreateCustomKeyStore' Text Text Text (Sensitive Text)
- newCreateCustomKeyStore :: Text -> Text -> Text -> Text -> CreateCustomKeyStore
- data CreateCustomKeyStoreResponse = CreateCustomKeyStoreResponse' (Maybe Text) Int
- newCreateCustomKeyStoreResponse :: Int -> CreateCustomKeyStoreResponse
- data ListGrants = ListGrants' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListGrants :: Text -> ListGrants
- data ListGrantsResponse = ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text)
- newListGrantsResponse :: ListGrantsResponse
- data DisableKeyRotation = DisableKeyRotation' Text
- newDisableKeyRotation :: Text -> DisableKeyRotation
- data DisableKeyRotationResponse = DisableKeyRotationResponse' {
- newDisableKeyRotationResponse :: DisableKeyRotationResponse
- data Verify = Verify' (Maybe MessageType) (Maybe [Text]) Text (Sensitive Base64) Base64 SigningAlgorithmSpec
- newVerify :: Text -> ByteString -> ByteString -> SigningAlgorithmSpec -> Verify
- data VerifyResponse = VerifyResponse' (Maybe SigningAlgorithmSpec) (Maybe Bool) (Maybe Text) Int
- newVerifyResponse :: Int -> VerifyResponse
- data GenerateDataKeyWithoutPlaintext = GenerateDataKeyWithoutPlaintext' (Maybe DataKeySpec) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe [Text]) Text
- newGenerateDataKeyWithoutPlaintext :: Text -> GenerateDataKeyWithoutPlaintext
- data GenerateDataKeyWithoutPlaintextResponse = GenerateDataKeyWithoutPlaintextResponse' (Maybe Text) (Maybe Base64) Int
- newGenerateDataKeyWithoutPlaintextResponse :: Int -> GenerateDataKeyWithoutPlaintextResponse
- data UpdateCustomKeyStore = UpdateCustomKeyStore' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) Text
- newUpdateCustomKeyStore :: Text -> UpdateCustomKeyStore
- data UpdateCustomKeyStoreResponse = UpdateCustomKeyStoreResponse' Int
- newUpdateCustomKeyStoreResponse :: Int -> UpdateCustomKeyStoreResponse
- data GetParametersForImport = GetParametersForImport' Text AlgorithmSpec WrappingKeySpec
- newGetParametersForImport :: Text -> AlgorithmSpec -> WrappingKeySpec -> GetParametersForImport
- data GetParametersForImportResponse = GetParametersForImportResponse' (Maybe Text) (Maybe (Sensitive Base64)) (Maybe POSIX) (Maybe Base64) Int
- newGetParametersForImportResponse :: Int -> GetParametersForImportResponse
- data EnableKeyRotation = EnableKeyRotation' Text
- newEnableKeyRotation :: Text -> EnableKeyRotation
- data EnableKeyRotationResponse = EnableKeyRotationResponse' {
- newEnableKeyRotationResponse :: EnableKeyRotationResponse
- data DeleteCustomKeyStore = DeleteCustomKeyStore' Text
- newDeleteCustomKeyStore :: Text -> DeleteCustomKeyStore
- data DeleteCustomKeyStoreResponse = DeleteCustomKeyStoreResponse' Int
- newDeleteCustomKeyStoreResponse :: Int -> DeleteCustomKeyStoreResponse
- data CreateAlias = CreateAlias' Text Text
- newCreateAlias :: Text -> Text -> CreateAlias
- data CreateAliasResponse = CreateAliasResponse' {
- newCreateAliasResponse :: CreateAliasResponse
- data CreateGrant = CreateGrant' (Maybe Text) (Maybe [Text]) (Maybe GrantConstraints) (Maybe Text) Text Text [GrantOperation]
- newCreateGrant :: Text -> Text -> CreateGrant
- data CreateGrantResponse = CreateGrantResponse' (Maybe Text) (Maybe Text) Int
- newCreateGrantResponse :: Int -> CreateGrantResponse
- data ListAliases = ListAliases' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListAliases :: ListAliases
- data ListAliasesResponse = ListAliasesResponse' (Maybe Bool) (Maybe [AliasListEntry]) (Maybe Text) Int
- newListAliasesResponse :: Int -> ListAliasesResponse
- data UpdatePrimaryRegion = UpdatePrimaryRegion' Text Text
- newUpdatePrimaryRegion :: Text -> Text -> UpdatePrimaryRegion
- data UpdatePrimaryRegionResponse = UpdatePrimaryRegionResponse' {
- newUpdatePrimaryRegionResponse :: UpdatePrimaryRegionResponse
- data ConnectCustomKeyStore = ConnectCustomKeyStore' Text
- newConnectCustomKeyStore :: Text -> ConnectCustomKeyStore
- data ConnectCustomKeyStoreResponse = ConnectCustomKeyStoreResponse' Int
- newConnectCustomKeyStoreResponse :: Int -> ConnectCustomKeyStoreResponse
- data ListRetirableGrants = ListRetirableGrants' (Maybe Text) (Maybe Natural) Text
- newListRetirableGrants :: Text -> ListRetirableGrants
- data ListGrantsResponse = ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text)
- newListGrantsResponse :: ListGrantsResponse
- data GetPublicKey = GetPublicKey' (Maybe [Text]) Text
- newGetPublicKey :: Text -> GetPublicKey
- data GetPublicKeyResponse = GetPublicKeyResponse' (Maybe KeySpec) (Maybe Text) (Maybe CustomerMasterKeySpec) (Maybe [EncryptionAlgorithmSpec]) (Maybe Base64) (Maybe [SigningAlgorithmSpec]) (Maybe KeyUsageType) Int
- newGetPublicKeyResponse :: Int -> GetPublicKeyResponse
- data GenerateRandom = GenerateRandom' (Maybe Natural) (Maybe Text)
- newGenerateRandom :: GenerateRandom
- data GenerateRandomResponse = GenerateRandomResponse' (Maybe (Sensitive Base64)) Int
- newGenerateRandomResponse :: Int -> GenerateRandomResponse
- data CreateKey = CreateKey' (Maybe OriginType) (Maybe KeySpec) (Maybe CustomerMasterKeySpec) (Maybe KeyUsageType) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Bool)
- newCreateKey :: CreateKey
- data CreateKeyResponse = CreateKeyResponse' (Maybe KeyMetadata) Int
- newCreateKeyResponse :: Int -> CreateKeyResponse
- data DisableKey = DisableKey' Text
- newDisableKey :: Text -> DisableKey
- data DisableKeyResponse = DisableKeyResponse' {
- newDisableKeyResponse :: DisableKeyResponse
- data DisconnectCustomKeyStore = DisconnectCustomKeyStore' Text
- newDisconnectCustomKeyStore :: Text -> DisconnectCustomKeyStore
- data DisconnectCustomKeyStoreResponse = DisconnectCustomKeyStoreResponse' Int
- newDisconnectCustomKeyStoreResponse :: Int -> DisconnectCustomKeyStoreResponse
- data RetireGrant = RetireGrant' (Maybe Text) (Maybe Text) (Maybe Text)
- newRetireGrant :: RetireGrant
- data RetireGrantResponse = RetireGrantResponse' {
- newRetireGrantResponse :: RetireGrantResponse
- data ListKeys = ListKeys' (Maybe Text) (Maybe Natural)
- newListKeys :: ListKeys
- data ListKeysResponse = ListKeysResponse' (Maybe Bool) (Maybe [KeyListEntry]) (Maybe Text) Int
- newListKeysResponse :: Int -> ListKeysResponse
- data ListResourceTags = ListResourceTags' (Maybe Text) (Maybe Natural) Text
- newListResourceTags :: Text -> ListResourceTags
- data ListResourceTagsResponse = ListResourceTagsResponse' (Maybe Bool) (Maybe Text) (Maybe [Tag]) Int
- newListResourceTagsResponse :: Int -> ListResourceTagsResponse
- data GetKeyRotationStatus = GetKeyRotationStatus' Text
- newGetKeyRotationStatus :: Text -> GetKeyRotationStatus
- data GetKeyRotationStatusResponse = GetKeyRotationStatusResponse' (Maybe Bool) Int
- newGetKeyRotationStatusResponse :: Int -> GetKeyRotationStatusResponse
- data GenerateDataKey = GenerateDataKey' (Maybe DataKeySpec) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe [Text]) Text
- newGenerateDataKey :: Text -> GenerateDataKey
- data GenerateDataKeyResponse = GenerateDataKeyResponse' Int Text (Sensitive Base64) Base64
- newGenerateDataKeyResponse :: Int -> Text -> ByteString -> ByteString -> GenerateDataKeyResponse
- data DeleteAlias = DeleteAlias' Text
- newDeleteAlias :: Text -> DeleteAlias
- data DeleteAliasResponse = DeleteAliasResponse' {
- newDeleteAliasResponse :: DeleteAliasResponse
- data UpdateAlias = UpdateAlias' Text Text
- newUpdateAlias :: Text -> Text -> UpdateAlias
- data UpdateAliasResponse = UpdateAliasResponse' {
- newUpdateAliasResponse :: UpdateAliasResponse
- data DescribeKey = DescribeKey' (Maybe [Text]) Text
- newDescribeKey :: Text -> DescribeKey
- data DescribeKeyResponse = DescribeKeyResponse' (Maybe KeyMetadata) Int
- newDescribeKeyResponse :: Int -> DescribeKeyResponse
- data DescribeCustomKeyStores = DescribeCustomKeyStores' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeCustomKeyStores :: DescribeCustomKeyStores
- data DescribeCustomKeyStoresResponse = DescribeCustomKeyStoresResponse' (Maybe Bool) (Maybe Text) (Maybe [CustomKeyStoresListEntry]) Int
- newDescribeCustomKeyStoresResponse :: Int -> DescribeCustomKeyStoresResponse
- data CancelKeyDeletion = CancelKeyDeletion' Text
- newCancelKeyDeletion :: Text -> CancelKeyDeletion
- data CancelKeyDeletionResponse = CancelKeyDeletionResponse' (Maybe Text) Int
- newCancelKeyDeletionResponse :: Int -> CancelKeyDeletionResponse
- data Decrypt = Decrypt' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) Base64
- newDecrypt :: ByteString -> Decrypt
- data DecryptResponse = DecryptResponse' (Maybe Text) (Maybe (Sensitive Base64)) (Maybe EncryptionAlgorithmSpec) Int
- newDecryptResponse :: Int -> DecryptResponse
- data GenerateDataKeyPairWithoutPlaintext = GenerateDataKeyPairWithoutPlaintext' (Maybe (HashMap Text Text)) (Maybe [Text]) Text DataKeyPairSpec
- newGenerateDataKeyPairWithoutPlaintext :: Text -> DataKeyPairSpec -> GenerateDataKeyPairWithoutPlaintext
- data GenerateDataKeyPairWithoutPlaintextResponse = GenerateDataKeyPairWithoutPlaintextResponse' (Maybe Text) (Maybe Base64) (Maybe DataKeyPairSpec) (Maybe Base64) Int
- newGenerateDataKeyPairWithoutPlaintextResponse :: Int -> GenerateDataKeyPairWithoutPlaintextResponse
- data UpdateKeyDescription = UpdateKeyDescription' Text Text
- newUpdateKeyDescription :: Text -> Text -> UpdateKeyDescription
- data UpdateKeyDescriptionResponse = UpdateKeyDescriptionResponse' {
- newUpdateKeyDescriptionResponse :: UpdateKeyDescriptionResponse
- data ReEncrypt = ReEncrypt' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) (Maybe EncryptionAlgorithmSpec) Base64 Text
- newReEncrypt :: ByteString -> Text -> ReEncrypt
- data ReEncryptResponse = ReEncryptResponse' (Maybe Text) (Maybe Text) (Maybe EncryptionAlgorithmSpec) (Maybe EncryptionAlgorithmSpec) (Maybe Base64) Int
- newReEncryptResponse :: Int -> ReEncryptResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data ListKeyPolicies = ListKeyPolicies' (Maybe Text) (Maybe Natural) Text
- newListKeyPolicies :: Text -> ListKeyPolicies
- data ListKeyPoliciesResponse = ListKeyPoliciesResponse' (Maybe [Text]) (Maybe Bool) (Maybe Text) Int
- newListKeyPoliciesResponse :: Int -> ListKeyPoliciesResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data Sign = Sign' (Maybe MessageType) (Maybe [Text]) Text (Sensitive Base64) SigningAlgorithmSpec
- newSign :: Text -> ByteString -> SigningAlgorithmSpec -> Sign
- data SignResponse = SignResponse' (Maybe SigningAlgorithmSpec) (Maybe Base64) (Maybe Text) Int
- newSignResponse :: Int -> SignResponse
- data ScheduleKeyDeletion = ScheduleKeyDeletion' (Maybe Natural) Text
- newScheduleKeyDeletion :: Text -> ScheduleKeyDeletion
- data ScheduleKeyDeletionResponse = ScheduleKeyDeletionResponse' (Maybe Text) (Maybe KeyState) (Maybe POSIX) (Maybe Natural) Int
- newScheduleKeyDeletionResponse :: Int -> ScheduleKeyDeletionResponse
- data GenerateDataKeyPair = GenerateDataKeyPair' (Maybe (HashMap Text Text)) (Maybe [Text]) Text DataKeyPairSpec
- newGenerateDataKeyPair :: Text -> DataKeyPairSpec -> GenerateDataKeyPair
- data GenerateDataKeyPairResponse = GenerateDataKeyPairResponse' (Maybe Text) (Maybe Base64) (Maybe (Sensitive Base64)) (Maybe DataKeyPairSpec) (Maybe Base64) Int
- newGenerateDataKeyPairResponse :: Int -> GenerateDataKeyPairResponse
- data ReplicateKey = ReplicateKey' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newReplicateKey :: Text -> Text -> ReplicateKey
- data ReplicateKeyResponse = ReplicateKeyResponse' (Maybe KeyMetadata) (Maybe Text) (Maybe [Tag]) Int
- newReplicateKeyResponse :: Int -> ReplicateKeyResponse
- data PutKeyPolicy = PutKeyPolicy' (Maybe Bool) Text Text Text
- newPutKeyPolicy :: Text -> Text -> Text -> PutKeyPolicy
- data PutKeyPolicyResponse = PutKeyPolicyResponse' {
- newPutKeyPolicyResponse :: PutKeyPolicyResponse
- data EnableKey = EnableKey' Text
- newEnableKey :: Text -> EnableKey
- data EnableKeyResponse = EnableKeyResponse' {
- newEnableKeyResponse :: EnableKeyResponse
- data RevokeGrant = RevokeGrant' Text Text
- newRevokeGrant :: Text -> Text -> RevokeGrant
- data RevokeGrantResponse = RevokeGrantResponse' {
- newRevokeGrantResponse :: RevokeGrantResponse
- data GetKeyPolicy = GetKeyPolicy' Text Text
- newGetKeyPolicy :: Text -> Text -> GetKeyPolicy
- data GetKeyPolicyResponse = GetKeyPolicyResponse' (Maybe Text) Int
- newGetKeyPolicyResponse :: Int -> GetKeyPolicyResponse
- data ImportKeyMaterial = ImportKeyMaterial' (Maybe ExpirationModelType) (Maybe POSIX) Text Base64 Base64
- newImportKeyMaterial :: Text -> ByteString -> ByteString -> ImportKeyMaterial
- data ImportKeyMaterialResponse = ImportKeyMaterialResponse' Int
- newImportKeyMaterialResponse :: Int -> ImportKeyMaterialResponse
- data DeleteImportedKeyMaterial = DeleteImportedKeyMaterial' Text
- newDeleteImportedKeyMaterial :: Text -> DeleteImportedKeyMaterial
- data DeleteImportedKeyMaterialResponse = DeleteImportedKeyMaterialResponse' {
- newDeleteImportedKeyMaterialResponse :: DeleteImportedKeyMaterialResponse
- newtype AlgorithmSpec where
- AlgorithmSpec' { }
- pattern AlgorithmSpec_RSAES_OAEP_SHA_1 :: AlgorithmSpec
- pattern AlgorithmSpec_RSAES_OAEP_SHA_256 :: AlgorithmSpec
- pattern AlgorithmSpec_RSAES_PKCS1_V1_5 :: AlgorithmSpec
- newtype ConnectionErrorCodeType where
- ConnectionErrorCodeType' { }
- pattern ConnectionErrorCodeType_CLUSTER_NOT_FOUND :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INSUFFICIENT_CLOUDHSM_HSMS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INTERNAL_ERROR :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_INVALID_CREDENTIALS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_NETWORK_ERRORS :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_SUBNET_NOT_FOUND :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_LOCKED_OUT :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_LOGGED_IN :: ConnectionErrorCodeType
- pattern ConnectionErrorCodeType_USER_NOT_FOUND :: ConnectionErrorCodeType
- newtype ConnectionStateType where
- ConnectionStateType' { }
- pattern ConnectionStateType_CONNECTED :: ConnectionStateType
- pattern ConnectionStateType_CONNECTING :: ConnectionStateType
- pattern ConnectionStateType_DISCONNECTED :: ConnectionStateType
- pattern ConnectionStateType_DISCONNECTING :: ConnectionStateType
- pattern ConnectionStateType_FAILED :: ConnectionStateType
- newtype CustomerMasterKeySpec where
- CustomerMasterKeySpec' { }
- pattern CustomerMasterKeySpec_ECC_NIST_P256 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_NIST_P384 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_NIST_P521 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_ECC_SECG_P256K1 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_2048 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_3072 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_RSA_4096 :: CustomerMasterKeySpec
- pattern CustomerMasterKeySpec_SYMMETRIC_DEFAULT :: CustomerMasterKeySpec
- newtype DataKeyPairSpec where
- DataKeyPairSpec' { }
- pattern DataKeyPairSpec_ECC_NIST_P256 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_NIST_P384 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_NIST_P521 :: DataKeyPairSpec
- pattern DataKeyPairSpec_ECC_SECG_P256K1 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_2048 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_3072 :: DataKeyPairSpec
- pattern DataKeyPairSpec_RSA_4096 :: DataKeyPairSpec
- newtype DataKeySpec where
- DataKeySpec' { }
- pattern DataKeySpec_AES_128 :: DataKeySpec
- pattern DataKeySpec_AES_256 :: DataKeySpec
- newtype EncryptionAlgorithmSpec where
- newtype ExpirationModelType where
- newtype GrantOperation where
- GrantOperation' { }
- pattern GrantOperation_CreateGrant :: GrantOperation
- pattern GrantOperation_Decrypt :: GrantOperation
- pattern GrantOperation_DescribeKey :: GrantOperation
- pattern GrantOperation_Encrypt :: GrantOperation
- pattern GrantOperation_GenerateDataKey :: GrantOperation
- pattern GrantOperation_GenerateDataKeyPair :: GrantOperation
- pattern GrantOperation_GenerateDataKeyPairWithoutPlaintext :: GrantOperation
- pattern GrantOperation_GenerateDataKeyWithoutPlaintext :: GrantOperation
- pattern GrantOperation_GetPublicKey :: GrantOperation
- pattern GrantOperation_ReEncryptFrom :: GrantOperation
- pattern GrantOperation_ReEncryptTo :: GrantOperation
- pattern GrantOperation_RetireGrant :: GrantOperation
- pattern GrantOperation_Sign :: GrantOperation
- pattern GrantOperation_Verify :: GrantOperation
- newtype KeyManagerType where
- KeyManagerType' { }
- pattern KeyManagerType_AWS :: KeyManagerType
- pattern KeyManagerType_CUSTOMER :: KeyManagerType
- newtype KeySpec where
- KeySpec' {
- fromKeySpec :: Text
- pattern KeySpec_ECC_NIST_P256 :: KeySpec
- pattern KeySpec_ECC_NIST_P384 :: KeySpec
- pattern KeySpec_ECC_NIST_P521 :: KeySpec
- pattern KeySpec_ECC_SECG_P256K1 :: KeySpec
- pattern KeySpec_RSA_2048 :: KeySpec
- pattern KeySpec_RSA_3072 :: KeySpec
- pattern KeySpec_RSA_4096 :: KeySpec
- pattern KeySpec_SYMMETRIC_DEFAULT :: KeySpec
- KeySpec' {
- newtype KeyState where
- KeyState' {
- fromKeyState :: Text
- pattern KeyState_Creating :: KeyState
- pattern KeyState_Disabled :: KeyState
- pattern KeyState_Enabled :: KeyState
- pattern KeyState_PendingDeletion :: KeyState
- pattern KeyState_PendingImport :: KeyState
- pattern KeyState_PendingReplicaDeletion :: KeyState
- pattern KeyState_Unavailable :: KeyState
- pattern KeyState_Updating :: KeyState
- KeyState' {
- newtype KeyUsageType where
- KeyUsageType' { }
- pattern KeyUsageType_ENCRYPT_DECRYPT :: KeyUsageType
- pattern KeyUsageType_SIGN_VERIFY :: KeyUsageType
- newtype MessageType where
- MessageType' { }
- pattern MessageType_DIGEST :: MessageType
- pattern MessageType_RAW :: MessageType
- newtype MultiRegionKeyType where
- newtype OriginType where
- OriginType' { }
- pattern OriginType_AWS_CLOUDHSM :: OriginType
- pattern OriginType_AWS_KMS :: OriginType
- pattern OriginType_EXTERNAL :: OriginType
- newtype SigningAlgorithmSpec where
- SigningAlgorithmSpec' { }
- pattern SigningAlgorithmSpec_ECDSA_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_ECDSA_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_ECDSA_SHA_512 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PKCS1_V1_5_SHA_512 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_256 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_384 :: SigningAlgorithmSpec
- pattern SigningAlgorithmSpec_RSASSA_PSS_SHA_512 :: SigningAlgorithmSpec
- newtype WrappingKeySpec where
- WrappingKeySpec' { }
- pattern WrappingKeySpec_RSA_2048 :: WrappingKeySpec
- data AliasListEntry = AliasListEntry' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newAliasListEntry :: AliasListEntry
- data CustomKeyStoresListEntry = CustomKeyStoresListEntry' (Maybe Text) (Maybe Text) (Maybe ConnectionErrorCodeType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ConnectionStateType)
- newCustomKeyStoresListEntry :: CustomKeyStoresListEntry
- data GrantConstraints = GrantConstraints' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))
- newGrantConstraints :: GrantConstraints
- data GrantListEntry = GrantListEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe GrantConstraints) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [GrantOperation])
- newGrantListEntry :: GrantListEntry
- data KeyListEntry = KeyListEntry' (Maybe Text) (Maybe Text)
- newKeyListEntry :: KeyListEntry
- data KeyMetadata = KeyMetadata' (Maybe OriginType) (Maybe ExpirationModelType) (Maybe KeyManagerType) (Maybe KeySpec) (Maybe CustomerMasterKeySpec) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe KeyState) (Maybe [EncryptionAlgorithmSpec]) (Maybe Text) (Maybe [SigningAlgorithmSpec]) (Maybe Natural) (Maybe KeyUsageType) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe MultiRegionConfiguration) Text
- newKeyMetadata :: Text -> KeyMetadata
- data ListGrantsResponse = ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text)
- newListGrantsResponse :: ListGrantsResponse
- data MultiRegionConfiguration = MultiRegionConfiguration' (Maybe MultiRegionKey) (Maybe [MultiRegionKey]) (Maybe MultiRegionKeyType)
- newMultiRegionConfiguration :: MultiRegionConfiguration
- data MultiRegionKey = MultiRegionKey' (Maybe Text) (Maybe Text)
- newMultiRegionKey :: MultiRegionKey
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2014-11-01
of the Amazon Key Management Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by KMS
.
InvalidMarkerException
_InvalidMarkerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the marker that specifies where pagination should next begin is not valid.
KMSInvalidStateException
_KMSInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the /Key Management Service Developer Guide/ .
InvalidKeyUsageException
_InvalidKeyUsageException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected for one of the following reasons:
- The
KeyUsage
value of the KMS key is incompatible with the API operation. - The encryption algorithm or signing algorithm specified for the
operation is incompatible with the type of key material in the KMS
key
(KeySpec
).
For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage
must be ENCRYPT_DECRYPT
. For signing and verifying, the
KeyUsage
must be SIGN_VERIFY
. To find the KeyUsage
of a KMS key,
use the DescribeKey operation.
To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.
MalformedPolicyDocumentException
_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified policy is not syntactically or semantically correct.
CustomKeyStoreNameInUseException
_CustomKeyStoreNameInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.
UnsupportedOperationException
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
DisabledException
_DisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified KMS key is not enabled.
KeyUnavailableException
_KeyUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified KMS key was not available. You can retry the request.
IncorrectKeyMaterialException
_IncorrectKeyMaterialException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this KMS key.
KMSInternalException
_KMSInternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because an internal exception occurred. The request can be retried.
TagException
_TagException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because one or more tags are not valid.
CustomKeyStoreHasCMKsException
_CustomKeyStoreHasCMKsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion operation to delete the KMS keys. After they are deleted, you can delete the custom key store.
InvalidImportTokenException
_InvalidImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the provided import token is invalid or is associated with a different KMS key.
CloudHsmClusterNotRelatedException
_CloudHsmClusterNotRelatedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.
Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
IncorrectTrustAnchorException
_IncorrectTrustAnchorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified CloudHSM cluster.
When you
initialize the cluster,
you create the trust anchor certificate and save it in the
customerCA.crt
file.
CloudHsmClusterInvalidConfigurationException
_CloudHsmClusterInvalidConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the associated CloudHSM cluster did not meet the configuration requirements for a custom key store.
- The cluster must be configured with private subnets in at least two different Availability Zones in the Region.
- The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the CloudHSM CreateHsm operation.
For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the CloudHSM must contain at least one active HSM.
For information about the requirements for an CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster, see Create a Private Subnet in the CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the /CloudHSM User Guide/ .
CloudHsmClusterNotActiveException
_CloudHsmClusterNotActiveException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the CloudHSM User Guide.
CloudHsmClusterNotFoundException
_CloudHsmClusterNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because KMS cannot find the CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified entity or resource could not be found.
KMSInvalidSignatureException
_KMSInvalidSignatureException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified KMS key and signing algorithm.
InvalidAliasNameException
_InvalidAliasNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified alias name is not valid.
CustomKeyStoreNotFoundException
_CustomKeyStoreNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because KMS cannot find a custom key store with the specified key store name or ID.
CustomKeyStoreInvalidStateException
_CustomKeyStoreInvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because of the ConnectionState
of the custom
key store. To get the ConnectionState
of a custom key store, use the
DescribeCustomKeyStores operation.
This exception is thrown under the following conditions:
- You requested the CreateKey or GenerateRandom operation in a custom
key store that is not connected. These operations are valid only
when the custom key store
ConnectionState
isCONNECTED
. - You requested the UpdateCustomKeyStore or DeleteCustomKeyStore
operation on a custom key store that is not disconnected. This
operation is valid only when the custom key store
ConnectionState
isDISCONNECTED
. - You requested the ConnectCustomKeyStore operation on a custom key
store with a
ConnectionState
ofDISCONNECTING
orFAILED
. This operation is valid for all otherConnectionState
values.
InvalidGrantIdException
_InvalidGrantIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified GrantId
is not valid.
InvalidGrantTokenException
_InvalidGrantTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified grant token is not valid.
InvalidArnException
_InvalidArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.
DependencyTimeoutException
_DependencyTimeoutException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The system timed out while trying to fulfill the request. The request can be retried.
ExpiredImportTokenException
_ExpiredImportTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
InvalidCiphertextException
_InvalidCiphertextException :: AsError a => Getting (First ServiceError) a ServiceError Source #
From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
From the ImportKeyMaterial operation, the request was rejected because KMS could not decrypt the encrypted (wrapped) key material.
CloudHsmClusterInUseException
_CloudHsmClusterInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different CloudHSM cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
IncorrectKeyException
_IncorrectKeyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because the specified KMS key cannot decrypt
the data. The KeyId
in a Decrypt request and the SourceKeyId
in a
ReEncrypt request must identify the same KMS key that was used to
encrypt the ciphertext.
AlreadyExistsException
_AlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because it attempted to create a resource that already exists.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because a quota was exceeded. For more information, see Quotas in the Key Management Service Developer Guide.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
Encrypt
See: newEncrypt
smart constructor.
Encrypt' (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) Text (Sensitive Base64) |
Instances
Create a value of Encrypt
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionContext:Encrypt'
, encrypt_encryptionContext
- Specifies the encryption context that will be used to encrypt the data.
An encryption context is valid only for
cryptographic operations
with a symmetric KMS key. The standard asymmetric encryption algorithms
that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:grantTokens:Encrypt'
, encrypt_grantTokens
- 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.
$sel:encryptionAlgorithm:Encrypt'
, encrypt_encryptionAlgorithm
- 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 KMS
keys. If you are using an asymmetric KMS key, we recommend
RSAES_OAEP_SHA_256.
$sel:keyId:Encrypt'
, encrypt_keyId
- Identifies the KMS key to use in the encryption 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.
$sel:plaintext:Encrypt'
, encrypt_plaintext
- 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.
data EncryptResponse Source #
See: newEncryptResponse
smart constructor.
Instances
Create a value of EncryptResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:Encrypt'
, encryptResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that was used to encrypt the plaintext.
$sel:encryptionAlgorithm:Encrypt'
, encryptResponse_encryptionAlgorithm
- The encryption algorithm that was used to encrypt the plaintext.
$sel:ciphertextBlob:EncryptResponse'
, encryptResponse_ciphertextBlob
- 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.
$sel:httpStatus:EncryptResponse'
, encryptResponse_httpStatus
- The response's http status code.
CreateCustomKeyStore
data CreateCustomKeyStore Source #
See: newCreateCustomKeyStore
smart constructor.
Instances
newCreateCustomKeyStore Source #
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateCustomKeyStore |
Create a value of CreateCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreName:CreateCustomKeyStore'
, createCustomKeyStore_customKeyStoreName
- Specifies a friendly name for the custom key store. The name must be
unique in your Amazon Web Services account.
$sel:cloudHsmClusterId:CreateCustomKeyStore'
, createCustomKeyStore_cloudHsmClusterId
- Identifies the CloudHSM cluster for the custom key store. 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.
$sel:trustAnchorCertificate:CreateCustomKeyStore'
, createCustomKeyStore_trustAnchorCertificate
- Enter the content of the trust anchor certificate for the cluster. This
is the content of the customerCA.crt
file that you created when you
initialized the cluster.
$sel:keyStorePassword:CreateCustomKeyStore'
, createCustomKeyStore_keyStorePassword
- 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.
data CreateCustomKeyStoreResponse Source #
See: newCreateCustomKeyStoreResponse
smart constructor.
Instances
newCreateCustomKeyStoreResponse Source #
Create a value of CreateCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreId:CreateCustomKeyStoreResponse'
, createCustomKeyStoreResponse_customKeyStoreId
- A unique identifier for the new custom key store.
$sel:httpStatus:CreateCustomKeyStoreResponse'
, createCustomKeyStoreResponse_httpStatus
- The response's http status code.
ListGrants (Paginated)
data ListGrants Source #
See: newListGrants
smart constructor.
Instances
Create a value of ListGrants
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantId:ListGrants'
, listGrants_grantId
- Returns only the grant with the specified grant ID. The grant ID
uniquely identifies the grant.
$sel:granteePrincipal:ListGrants'
, listGrants_granteePrincipal
- Returns only grants where the specified principal is the grantee
principal for the grant.
$sel:marker:ListGrants'
, listGrants_marker
- 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.
$sel:limit:ListGrants'
, listGrants_limit
- 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.
$sel:keyId:ListGrants'
, listGrants_keyId
- 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.
data ListGrantsResponse Source #
See: newListGrantsResponse
smart constructor.
ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text) |
Instances
newListGrantsResponse :: ListGrantsResponse Source #
Create a value of ListGrantsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListGrantsResponse'
, listGrantsResponse_truncated
- 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.
$sel:grants:ListGrantsResponse'
, listGrantsResponse_grants
- A list of grants.
$sel:nextMarker:ListGrantsResponse'
, listGrantsResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
DisableKeyRotation
data DisableKeyRotation Source #
See: newDisableKeyRotation
smart constructor.
Instances
newDisableKeyRotation Source #
Create a value of DisableKeyRotation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:DisableKeyRotation'
, disableKeyRotation_keyId
- Identifies a symmetric KMS key. You cannot enable or disable automatic
rotation of
asymmetric 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.
data DisableKeyRotationResponse Source #
See: newDisableKeyRotationResponse
smart constructor.
Instances
newDisableKeyRotationResponse :: DisableKeyRotationResponse Source #
Create a value of DisableKeyRotationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Verify
See: newVerify
smart constructor.
Instances
:: Text | |
-> ByteString | |
-> ByteString | |
-> SigningAlgorithmSpec | |
-> Verify |
Create a value of Verify
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageType:Verify'
, verify_messageType
- 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.
$sel:grantTokens:Verify'
, verify_grantTokens
- 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.
$sel:keyId:Verify'
, verify_keyId
- 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.
$sel:message:Verify'
, verify_message
- 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.
$sel:signature:Verify'
, verify_signature
- 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.
$sel:signingAlgorithm:Verify'
, verify_signingAlgorithm
- The signing algorithm that was used to sign the message. If you submit a
different algorithm, the signature verification fails.
data VerifyResponse Source #
See: newVerifyResponse
smart constructor.
Instances
Create a value of VerifyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signingAlgorithm:Verify'
, verifyResponse_signingAlgorithm
- The signing algorithm that was used to verify the signature.
$sel:signatureValid:VerifyResponse'
, verifyResponse_signatureValid
- 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.
$sel:keyId:Verify'
, verifyResponse_keyId
- The Amazon Resource Name
(key ARN)
of the asymmetric KMS key that was used to verify the signature.
$sel:httpStatus:VerifyResponse'
, verifyResponse_httpStatus
- The response's http status code.
GenerateDataKeyWithoutPlaintext
data GenerateDataKeyWithoutPlaintext Source #
See: newGenerateDataKeyWithoutPlaintext
smart constructor.
GenerateDataKeyWithoutPlaintext' (Maybe DataKeySpec) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe [Text]) Text |
Instances
newGenerateDataKeyWithoutPlaintext Source #
Create a value of GenerateDataKeyWithoutPlaintext
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keySpec:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintext_keySpec
- 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.
$sel:encryptionContext:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintext_encryptionContext
- 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintext_numberOfBytes
- 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.
$sel:grantTokens:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintext_grantTokens
- 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.
$sel:keyId:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintext_keyId
- The identifier of the symmetric KMS key that encrypts the data 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.
data GenerateDataKeyWithoutPlaintextResponse Source #
See: newGenerateDataKeyWithoutPlaintextResponse
smart constructor.
Instances
newGenerateDataKeyWithoutPlaintextResponse Source #
Create a value of GenerateDataKeyWithoutPlaintextResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GenerateDataKeyWithoutPlaintext'
, generateDataKeyWithoutPlaintextResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that encrypted the data key.
$sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse'
, generateDataKeyWithoutPlaintextResponse_ciphertextBlob
- 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.
$sel:httpStatus:GenerateDataKeyWithoutPlaintextResponse'
, generateDataKeyWithoutPlaintextResponse_httpStatus
- The response's http status code.
UpdateCustomKeyStore
data UpdateCustomKeyStore Source #
See: newUpdateCustomKeyStore
smart constructor.
Instances
newUpdateCustomKeyStore Source #
Create a value of UpdateCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyStorePassword:UpdateCustomKeyStore'
, updateCustomKeyStore_keyStorePassword
- Enter the current password of the kmsuser
crypto user (CU) in the
CloudHSM cluster that is associated with the custom key store.
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.
$sel:cloudHsmClusterId:UpdateCustomKeyStore'
, updateCustomKeyStore_cloudHsmClusterId
- Associates the custom key store with a related CloudHSM cluster.
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.
$sel:newCustomKeyStoreName':UpdateCustomKeyStore'
, updateCustomKeyStore_newCustomKeyStoreName
- 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.
$sel:customKeyStoreId:UpdateCustomKeyStore'
, updateCustomKeyStore_customKeyStoreId
- 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.
data UpdateCustomKeyStoreResponse Source #
See: newUpdateCustomKeyStoreResponse
smart constructor.
Instances
newUpdateCustomKeyStoreResponse Source #
Create a value of UpdateCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateCustomKeyStoreResponse'
, updateCustomKeyStoreResponse_httpStatus
- The response's http status code.
GetParametersForImport
data GetParametersForImport Source #
See: newGetParametersForImport
smart constructor.
Instances
newGetParametersForImport Source #
Create a value of GetParametersForImport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GetParametersForImport'
, getParametersForImport_keyId
- The identifier of the symmetric 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.
$sel:wrappingAlgorithm:GetParametersForImport'
, getParametersForImport_wrappingAlgorithm
- 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.
$sel:wrappingKeySpec:GetParametersForImport'
, getParametersForImport_wrappingKeySpec
- The type of wrapping key (public key) to return in the response. Only
2048-bit RSA public keys are supported.
data GetParametersForImportResponse Source #
See: newGetParametersForImportResponse
smart constructor.
GetParametersForImportResponse' (Maybe Text) (Maybe (Sensitive Base64)) (Maybe POSIX) (Maybe Base64) Int |
Instances
newGetParametersForImportResponse Source #
Create a value of GetParametersForImportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GetParametersForImport'
, getParametersForImportResponse_keyId
- 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.
$sel:publicKey:GetParametersForImportResponse'
, getParametersForImportResponse_publicKey
- 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.
$sel:parametersValidTo:GetParametersForImportResponse'
, getParametersForImportResponse_parametersValidTo
- 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.
$sel:importToken:GetParametersForImportResponse'
, getParametersForImportResponse_importToken
- 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.
$sel:httpStatus:GetParametersForImportResponse'
, getParametersForImportResponse_httpStatus
- The response's http status code.
EnableKeyRotation
data EnableKeyRotation Source #
See: newEnableKeyRotation
smart constructor.
Instances
Create a value of EnableKeyRotation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:EnableKeyRotation'
, enableKeyRotation_keyId
- Identifies a symmetric KMS key. You cannot enable automatic rotation of
asymmetric 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.
data EnableKeyRotationResponse Source #
See: newEnableKeyRotationResponse
smart constructor.
Instances
Eq EnableKeyRotationResponse Source # | |
Defined in Amazonka.KMS.EnableKeyRotation | |
Read EnableKeyRotationResponse Source # | |
Show EnableKeyRotationResponse Source # | |
Defined in Amazonka.KMS.EnableKeyRotation showsPrec :: Int -> EnableKeyRotationResponse -> ShowS # show :: EnableKeyRotationResponse -> String # showList :: [EnableKeyRotationResponse] -> ShowS # | |
Generic EnableKeyRotationResponse Source # | |
Defined in Amazonka.KMS.EnableKeyRotation type Rep EnableKeyRotationResponse :: Type -> Type # | |
NFData EnableKeyRotationResponse Source # | |
Defined in Amazonka.KMS.EnableKeyRotation rnf :: EnableKeyRotationResponse -> () # | |
type Rep EnableKeyRotationResponse Source # | |
newEnableKeyRotationResponse :: EnableKeyRotationResponse Source #
Create a value of EnableKeyRotationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCustomKeyStore
data DeleteCustomKeyStore Source #
See: newDeleteCustomKeyStore
smart constructor.
Instances
newDeleteCustomKeyStore Source #
Create a value of DeleteCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreId:DeleteCustomKeyStore'
, deleteCustomKeyStore_customKeyStoreId
- 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.
data DeleteCustomKeyStoreResponse Source #
See: newDeleteCustomKeyStoreResponse
smart constructor.
Instances
newDeleteCustomKeyStoreResponse Source #
Create a value of DeleteCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteCustomKeyStoreResponse'
, deleteCustomKeyStoreResponse_httpStatus
- The response's http status code.
CreateAlias
data CreateAlias Source #
See: newCreateAlias
smart constructor.
Instances
Create a value of CreateAlias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliasName:CreateAlias'
, createAlias_aliasName
- 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.
$sel:targetKeyId:CreateAlias'
, createAlias_targetKeyId
- 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.
data CreateAliasResponse Source #
See: newCreateAliasResponse
smart constructor.
Instances
Eq CreateAliasResponse Source # | |
Defined in Amazonka.KMS.CreateAlias (==) :: CreateAliasResponse -> CreateAliasResponse -> Bool # (/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool # | |
Read CreateAliasResponse Source # | |
Defined in Amazonka.KMS.CreateAlias | |
Show CreateAliasResponse Source # | |
Defined in Amazonka.KMS.CreateAlias showsPrec :: Int -> CreateAliasResponse -> ShowS # show :: CreateAliasResponse -> String # showList :: [CreateAliasResponse] -> ShowS # | |
Generic CreateAliasResponse Source # | |
Defined in Amazonka.KMS.CreateAlias type Rep CreateAliasResponse :: Type -> Type # from :: CreateAliasResponse -> Rep CreateAliasResponse x # to :: Rep CreateAliasResponse x -> CreateAliasResponse # | |
NFData CreateAliasResponse Source # | |
Defined in Amazonka.KMS.CreateAlias rnf :: CreateAliasResponse -> () # | |
type Rep CreateAliasResponse Source # | |
newCreateAliasResponse :: CreateAliasResponse Source #
Create a value of CreateAliasResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateGrant
data CreateGrant Source #
See: newCreateGrant
smart constructor.
CreateGrant' (Maybe Text) (Maybe [Text]) (Maybe GrantConstraints) (Maybe Text) Text Text [GrantOperation] |
Instances
Create a value of CreateGrant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:retiringPrincipal:CreateGrant'
, createGrant_retiringPrincipal
- 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.
$sel:grantTokens:CreateGrant'
, createGrant_grantTokens
- 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.
$sel:constraints:CreateGrant'
, createGrant_constraints
- 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.
These 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. 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 are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.
$sel:name:CreateGrant'
, createGrant_name
- 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.
$sel:keyId:CreateGrant'
, createGrant_keyId
- 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.
$sel:granteePrincipal:CreateGrant'
, createGrant_granteePrincipal
- 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/.
$sel:operations:CreateGrant'
, createGrant_operations
- A list of operations that the grant permits.
The operation must be supported on the KMS key. For example, you cannot
create a grant for a symmetric 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.
data CreateGrantResponse Source #
See: newCreateGrantResponse
smart constructor.
Instances
newCreateGrantResponse Source #
Create a value of CreateGrantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantId:CreateGrantResponse'
, createGrantResponse_grantId
- The unique identifier for the grant.
You can use the GrantId
in a ListGrants, RetireGrant, or RevokeGrant
operation.
$sel:grantToken:CreateGrantResponse'
, createGrantResponse_grantToken
- 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.
$sel:httpStatus:CreateGrantResponse'
, createGrantResponse_httpStatus
- The response's http status code.
ListAliases (Paginated)
data ListAliases Source #
See: newListAliases
smart constructor.
Instances
newListAliases :: ListAliases Source #
Create a value of ListAliases
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:ListAliases'
, listAliases_keyId
- 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.
$sel:marker:ListAliases'
, listAliases_marker
- 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.
$sel:limit:ListAliases'
, listAliases_limit
- 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.
data ListAliasesResponse Source #
See: newListAliasesResponse
smart constructor.
ListAliasesResponse' (Maybe Bool) (Maybe [AliasListEntry]) (Maybe Text) Int |
Instances
newListAliasesResponse Source #
Create a value of ListAliasesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListAliasesResponse'
, listAliasesResponse_truncated
- 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.
$sel:aliases:ListAliasesResponse'
, listAliasesResponse_aliases
- A list of aliases.
$sel:nextMarker:ListAliasesResponse'
, listAliasesResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
$sel:httpStatus:ListAliasesResponse'
, listAliasesResponse_httpStatus
- The response's http status code.
UpdatePrimaryRegion
data UpdatePrimaryRegion Source #
See: newUpdatePrimaryRegion
smart constructor.
Instances
newUpdatePrimaryRegion Source #
:: Text | |
-> Text | |
-> UpdatePrimaryRegion |
Create a value of UpdatePrimaryRegion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:UpdatePrimaryRegion'
, updatePrimaryRegion_keyId
- 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.
$sel:primaryRegion:UpdatePrimaryRegion'
, updatePrimaryRegion_primaryRegion
- 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.
data UpdatePrimaryRegionResponse Source #
See: newUpdatePrimaryRegionResponse
smart constructor.
Instances
newUpdatePrimaryRegionResponse :: UpdatePrimaryRegionResponse Source #
Create a value of UpdatePrimaryRegionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ConnectCustomKeyStore
data ConnectCustomKeyStore Source #
See: newConnectCustomKeyStore
smart constructor.
Instances
newConnectCustomKeyStore Source #
Create a value of ConnectCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreId:ConnectCustomKeyStore'
, connectCustomKeyStore_customKeyStoreId
- 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.
data ConnectCustomKeyStoreResponse Source #
See: newConnectCustomKeyStoreResponse
smart constructor.
Instances
newConnectCustomKeyStoreResponse Source #
Create a value of ConnectCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ConnectCustomKeyStoreResponse'
, connectCustomKeyStoreResponse_httpStatus
- The response's http status code.
ListRetirableGrants
data ListRetirableGrants Source #
See: newListRetirableGrants
smart constructor.
Instances
newListRetirableGrants Source #
Create a value of ListRetirableGrants
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListRetirableGrants'
, listRetirableGrants_marker
- 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.
$sel:limit:ListRetirableGrants'
, listRetirableGrants_limit
- 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.
$sel:retiringPrincipal:ListRetirableGrants'
, listRetirableGrants_retiringPrincipal
- 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/.
data ListGrantsResponse Source #
See: newListGrantsResponse
smart constructor.
ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text) |
Instances
newListGrantsResponse :: ListGrantsResponse Source #
Create a value of ListGrantsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListGrantsResponse'
, listGrantsResponse_truncated
- 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.
$sel:grants:ListGrantsResponse'
, listGrantsResponse_grants
- A list of grants.
$sel:nextMarker:ListGrantsResponse'
, listGrantsResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
GetPublicKey
data GetPublicKey Source #
See: newGetPublicKey
smart constructor.
GetPublicKey' (Maybe [Text]) Text |
Instances
Create a value of GetPublicKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantTokens:GetPublicKey'
, getPublicKey_grantTokens
- 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.
$sel:keyId:GetPublicKey'
, getPublicKey_keyId
- 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.
data GetPublicKeyResponse Source #
See: newGetPublicKeyResponse
smart constructor.
GetPublicKeyResponse' (Maybe KeySpec) (Maybe Text) (Maybe CustomerMasterKeySpec) (Maybe [EncryptionAlgorithmSpec]) (Maybe Base64) (Maybe [SigningAlgorithmSpec]) (Maybe KeyUsageType) Int |
Instances
newGetPublicKeyResponse Source #
Create a value of GetPublicKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keySpec:GetPublicKeyResponse'
, getPublicKeyResponse_keySpec
- The type of the of the public key that was downloaded.
$sel:keyId:GetPublicKey'
, getPublicKeyResponse_keyId
- The Amazon Resource Name
(key ARN)
of the asymmetric KMS key from which the public key was downloaded.
$sel:customerMasterKeySpec:GetPublicKeyResponse'
, getPublicKeyResponse_customerMasterKeySpec
- 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 will support both fields.
$sel:encryptionAlgorithms:GetPublicKeyResponse'
, getPublicKeyResponse_encryptionAlgorithms
- 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
.
$sel:publicKey:GetPublicKeyResponse'
, getPublicKeyResponse_publicKey
- 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.
$sel:signingAlgorithms:GetPublicKeyResponse'
, getPublicKeyResponse_signingAlgorithms
- 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
.
$sel:keyUsage:GetPublicKeyResponse'
, getPublicKeyResponse_keyUsage
- 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.
$sel:httpStatus:GetPublicKeyResponse'
, getPublicKeyResponse_httpStatus
- The response's http status code.
GenerateRandom
data GenerateRandom Source #
See: newGenerateRandom
smart constructor.
Instances
newGenerateRandom :: GenerateRandom Source #
Create a value of GenerateRandom
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:numberOfBytes:GenerateRandom'
, generateRandom_numberOfBytes
- The length of the byte string.
$sel:customKeyStoreId:GenerateRandom'
, generateRandom_customKeyStoreId
- Generates the random byte string in the CloudHSM cluster that is
associated with the specified
custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores
operation.
data GenerateRandomResponse Source #
See: newGenerateRandomResponse
smart constructor.
Instances
newGenerateRandomResponse Source #
Create a value of GenerateRandomResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:plaintext:GenerateRandomResponse'
, generateRandomResponse_plaintext
- 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.
$sel:httpStatus:GenerateRandomResponse'
, generateRandomResponse_httpStatus
- The response's http status code.
CreateKey
See: newCreateKey
smart constructor.
CreateKey' (Maybe OriginType) (Maybe KeySpec) (Maybe CustomerMasterKeySpec) (Maybe KeyUsageType) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Bool) |
Instances
newCreateKey :: CreateKey Source #
Create a value of CreateKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:origin:CreateKey'
, createKey_origin
- 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 the value to EXTERNAL
. For more information about importing key
material into KMS, see
Importing Key Material
in the Key Management Service Developer Guide. This value is valid
only for symmetric KMS keys.
To create a KMS key in an KMS
custom 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 custom key store. This value is valid only for
symmetric KMS keys.
$sel:keySpec:CreateKey'
, createKey_keySpec
- Specifies the type of KMS key to create. The default value,
SYMMETRIC_DEFAULT
, creates a KMS key with a 256-bit symmetric key for
encryption and decryption. For help choosing a key spec for your KMS
key, see
How to Choose Your KMS key Configuration
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 encryption algorithms or
signing 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
or
kms:Signing Algorithm
in the /Key Management Service Developer Guide/ .
Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
KMS supports the following key specs for KMS keys:
Symmetric key (default)
SYMMETRIC_DEFAULT
(AES-256-GCM)
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.
$sel:customerMasterKeySpec:CreateKey'
, createKey_customerMasterKeySpec
- 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 will support both
parameters.
$sel:keyUsage:CreateKey'
, createKey_keyUsage
- Determines the
cryptographic operations
for which you can use the KMS key. The default value is
ENCRYPT_DECRYPT
. This parameter is required only for asymmetric KMS
keys. You can't change the KeyUsage
value after the KMS key is
created.
Select only one valid value.
- For symmetric KMS keys, omit the parameter or specify
ENCRYPT_DECRYPT
. - For asymmetric KMS keys with RSA key material, specify
ENCRYPT_DECRYPT
orSIGN_VERIFY
. - For asymmetric KMS keys with ECC key material, specify
SIGN_VERIFY
.
$sel:bypassPolicyLockoutSafetyCheck:CreateKey'
, createKey_bypassPolicyLockoutSafetyCheck
- 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.
$sel:policy:CreateKey'
, createKey_policy
- 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/ .
$sel:description:CreateKey'
, createKey_description
- 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.
$sel:customKeyStoreId:CreateKey'
, createKey_customKeyStoreId
- Creates the KMS key in the specified
custom key store
and the key material in its associated CloudHSM cluster. To create a KMS
key in a custom key store, you must also specify the Origin
parameter
with a value of AWS_CLOUDHSM
. The CloudHSM cluster that is associated
with the custom key store must have at least two active HSMs, each in a
different Availability Zone in the Region.
This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
$sel:tags:CreateKey'
, createKey_tags
- 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 Using ABAC in 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.
$sel:multiRegion:CreateKey'
, createKey_multiRegion
- 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 Using multi-Region keys 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.
data CreateKeyResponse Source #
See: newCreateKeyResponse
smart constructor.
Instances
Create a value of CreateKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyMetadata:CreateKeyResponse'
, createKeyResponse_keyMetadata
- Metadata associated with the KMS key.
$sel:httpStatus:CreateKeyResponse'
, createKeyResponse_httpStatus
- The response's http status code.
DisableKey
data DisableKey Source #
See: newDisableKey
smart constructor.
Instances
Create a value of DisableKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:DisableKey'
, disableKey_keyId
- 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.
data DisableKeyResponse Source #
See: newDisableKeyResponse
smart constructor.
Instances
Eq DisableKeyResponse Source # | |
Defined in Amazonka.KMS.DisableKey (==) :: DisableKeyResponse -> DisableKeyResponse -> Bool # (/=) :: DisableKeyResponse -> DisableKeyResponse -> Bool # | |
Read DisableKeyResponse Source # | |
Defined in Amazonka.KMS.DisableKey | |
Show DisableKeyResponse Source # | |
Defined in Amazonka.KMS.DisableKey showsPrec :: Int -> DisableKeyResponse -> ShowS # show :: DisableKeyResponse -> String # showList :: [DisableKeyResponse] -> ShowS # | |
Generic DisableKeyResponse Source # | |
Defined in Amazonka.KMS.DisableKey type Rep DisableKeyResponse :: Type -> Type # from :: DisableKeyResponse -> Rep DisableKeyResponse x # to :: Rep DisableKeyResponse x -> DisableKeyResponse # | |
NFData DisableKeyResponse Source # | |
Defined in Amazonka.KMS.DisableKey rnf :: DisableKeyResponse -> () # | |
type Rep DisableKeyResponse Source # | |
newDisableKeyResponse :: DisableKeyResponse Source #
Create a value of DisableKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisconnectCustomKeyStore
data DisconnectCustomKeyStore Source #
See: newDisconnectCustomKeyStore
smart constructor.
Instances
newDisconnectCustomKeyStore Source #
Create a value of DisconnectCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreId:DisconnectCustomKeyStore'
, disconnectCustomKeyStore_customKeyStoreId
- 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.
data DisconnectCustomKeyStoreResponse Source #
See: newDisconnectCustomKeyStoreResponse
smart constructor.
Instances
Eq DisconnectCustomKeyStoreResponse Source # | |
Read DisconnectCustomKeyStoreResponse Source # | |
Show DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore | |
Generic DisconnectCustomKeyStoreResponse Source # | |
NFData DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore rnf :: DisconnectCustomKeyStoreResponse -> () # | |
type Rep DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore type Rep DisconnectCustomKeyStoreResponse = D1 ('MetaData "DisconnectCustomKeyStoreResponse" "Amazonka.KMS.DisconnectCustomKeyStore" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "DisconnectCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisconnectCustomKeyStoreResponse Source #
Create a value of DisconnectCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisconnectCustomKeyStoreResponse'
, disconnectCustomKeyStoreResponse_httpStatus
- The response's http status code.
RetireGrant
data RetireGrant Source #
See: newRetireGrant
smart constructor.
Instances
newRetireGrant :: RetireGrant Source #
Create a value of RetireGrant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:RetireGrant'
, retireGrant_keyId
- 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
$sel:grantId:RetireGrant'
, retireGrant_grantId
- Identifies the grant to retire. To get the grant ID, use CreateGrant,
ListGrants, or ListRetirableGrants.
- Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
$sel:grantToken:RetireGrant'
, retireGrant_grantToken
- 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.
data RetireGrantResponse Source #
See: newRetireGrantResponse
smart constructor.
Instances
Eq RetireGrantResponse Source # | |
Defined in Amazonka.KMS.RetireGrant (==) :: RetireGrantResponse -> RetireGrantResponse -> Bool # (/=) :: RetireGrantResponse -> RetireGrantResponse -> Bool # | |
Read RetireGrantResponse Source # | |
Defined in Amazonka.KMS.RetireGrant | |
Show RetireGrantResponse Source # | |
Defined in Amazonka.KMS.RetireGrant showsPrec :: Int -> RetireGrantResponse -> ShowS # show :: RetireGrantResponse -> String # showList :: [RetireGrantResponse] -> ShowS # | |
Generic RetireGrantResponse Source # | |
Defined in Amazonka.KMS.RetireGrant type Rep RetireGrantResponse :: Type -> Type # from :: RetireGrantResponse -> Rep RetireGrantResponse x # to :: Rep RetireGrantResponse x -> RetireGrantResponse # | |
NFData RetireGrantResponse Source # | |
Defined in Amazonka.KMS.RetireGrant rnf :: RetireGrantResponse -> () # | |
type Rep RetireGrantResponse Source # | |
newRetireGrantResponse :: RetireGrantResponse Source #
Create a value of RetireGrantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListKeys (Paginated)
See: newListKeys
smart constructor.
Instances
newListKeys :: ListKeys Source #
Create a value of ListKeys
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListKeys'
, listKeys_marker
- 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.
$sel:limit:ListKeys'
, listKeys_limit
- 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.
data ListKeysResponse Source #
See: newListKeysResponse
smart constructor.
ListKeysResponse' (Maybe Bool) (Maybe [KeyListEntry]) (Maybe Text) Int |
Instances
Create a value of ListKeysResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListKeysResponse'
, listKeysResponse_truncated
- 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.
$sel:keys:ListKeysResponse'
, listKeysResponse_keys
- A list of KMS keys.
$sel:nextMarker:ListKeysResponse'
, listKeysResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
$sel:httpStatus:ListKeysResponse'
, listKeysResponse_httpStatus
- The response's http status code.
ListResourceTags
data ListResourceTags Source #
See: newListResourceTags
smart constructor.
Instances
Create a value of ListResourceTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListResourceTags'
, listResourceTags_marker
- 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.
$sel:limit:ListResourceTags'
, listResourceTags_limit
- 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.
$sel:keyId:ListResourceTags'
, listResourceTags_keyId
- 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.
data ListResourceTagsResponse Source #
See: newListResourceTagsResponse
smart constructor.
Instances
newListResourceTagsResponse Source #
Create a value of ListResourceTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListResourceTagsResponse'
, listResourceTagsResponse_truncated
- 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.
$sel:nextMarker:ListResourceTagsResponse'
, listResourceTagsResponse_nextMarker
- 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.
$sel:tags:ListResourceTagsResponse'
, listResourceTagsResponse_tags
- 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 Using ABAC in KMS in the Key Management Service Developer Guide.
$sel:httpStatus:ListResourceTagsResponse'
, listResourceTagsResponse_httpStatus
- The response's http status code.
GetKeyRotationStatus
data GetKeyRotationStatus Source #
See: newGetKeyRotationStatus
smart constructor.
Instances
newGetKeyRotationStatus Source #
Create a value of GetKeyRotationStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GetKeyRotationStatus'
, getKeyRotationStatus_keyId
- 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.
data GetKeyRotationStatusResponse Source #
See: newGetKeyRotationStatusResponse
smart constructor.
Instances
newGetKeyRotationStatusResponse Source #
Create a value of GetKeyRotationStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyRotationEnabled:GetKeyRotationStatusResponse'
, getKeyRotationStatusResponse_keyRotationEnabled
- A Boolean value that specifies whether key rotation is enabled.
$sel:httpStatus:GetKeyRotationStatusResponse'
, getKeyRotationStatusResponse_httpStatus
- The response's http status code.
GenerateDataKey
data GenerateDataKey Source #
See: newGenerateDataKey
smart constructor.
GenerateDataKey' (Maybe DataKeySpec) (Maybe (HashMap Text Text)) (Maybe Natural) (Maybe [Text]) Text |
Instances
Create a value of GenerateDataKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keySpec:GenerateDataKey'
, generateDataKey_keySpec
- 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.
$sel:encryptionContext:GenerateDataKey'
, generateDataKey_encryptionContext
- 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:numberOfBytes:GenerateDataKey'
, generateDataKey_numberOfBytes
- 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.
$sel:grantTokens:GenerateDataKey'
, generateDataKey_grantTokens
- 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.
$sel:keyId:GenerateDataKey'
, generateDataKey_keyId
- Identifies the symmetric KMS key that encrypts the data 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.
data GenerateDataKeyResponse Source #
See: newGenerateDataKeyResponse
smart constructor.
Instances
newGenerateDataKeyResponse Source #
:: Int | |
-> Text | |
-> ByteString | |
-> ByteString | |
-> GenerateDataKeyResponse |
Create a value of GenerateDataKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GenerateDataKeyResponse'
, generateDataKeyResponse_httpStatus
- The response's http status code.
$sel:keyId:GenerateDataKey'
, generateDataKeyResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that encrypted the data key.
$sel:plaintext:GenerateDataKeyResponse'
, generateDataKeyResponse_plaintext
- 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.
$sel:ciphertextBlob:GenerateDataKeyResponse'
, generateDataKeyResponse_ciphertextBlob
- 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.
DeleteAlias
data DeleteAlias Source #
See: newDeleteAlias
smart constructor.
Instances
Create a value of DeleteAlias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliasName:DeleteAlias'
, deleteAlias_aliasName
- The alias to be deleted. The alias name must begin with alias/
followed by the alias name, such as alias/ExampleAlias
.
data DeleteAliasResponse Source #
See: newDeleteAliasResponse
smart constructor.
Instances
Eq DeleteAliasResponse Source # | |
Defined in Amazonka.KMS.DeleteAlias (==) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool # (/=) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool # | |
Read DeleteAliasResponse Source # | |
Defined in Amazonka.KMS.DeleteAlias | |
Show DeleteAliasResponse Source # | |
Defined in Amazonka.KMS.DeleteAlias showsPrec :: Int -> DeleteAliasResponse -> ShowS # show :: DeleteAliasResponse -> String # showList :: [DeleteAliasResponse] -> ShowS # | |
Generic DeleteAliasResponse Source # | |
Defined in Amazonka.KMS.DeleteAlias type Rep DeleteAliasResponse :: Type -> Type # from :: DeleteAliasResponse -> Rep DeleteAliasResponse x # to :: Rep DeleteAliasResponse x -> DeleteAliasResponse # | |
NFData DeleteAliasResponse Source # | |
Defined in Amazonka.KMS.DeleteAlias rnf :: DeleteAliasResponse -> () # | |
type Rep DeleteAliasResponse Source # | |
newDeleteAliasResponse :: DeleteAliasResponse Source #
Create a value of DeleteAliasResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateAlias
data UpdateAlias Source #
See: newUpdateAlias
smart constructor.
Instances
Create a value of UpdateAlias
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aliasName:UpdateAlias'
, updateAlias_aliasName
- 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.
$sel:targetKeyId:UpdateAlias'
, updateAlias_targetKeyId
- 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) 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.
data UpdateAliasResponse Source #
See: newUpdateAliasResponse
smart constructor.
Instances
Eq UpdateAliasResponse Source # | |
Defined in Amazonka.KMS.UpdateAlias (==) :: UpdateAliasResponse -> UpdateAliasResponse -> Bool # (/=) :: UpdateAliasResponse -> UpdateAliasResponse -> Bool # | |
Read UpdateAliasResponse Source # | |
Defined in Amazonka.KMS.UpdateAlias | |
Show UpdateAliasResponse Source # | |
Defined in Amazonka.KMS.UpdateAlias showsPrec :: Int -> UpdateAliasResponse -> ShowS # show :: UpdateAliasResponse -> String # showList :: [UpdateAliasResponse] -> ShowS # | |
Generic UpdateAliasResponse Source # | |
Defined in Amazonka.KMS.UpdateAlias type Rep UpdateAliasResponse :: Type -> Type # from :: UpdateAliasResponse -> Rep UpdateAliasResponse x # to :: Rep UpdateAliasResponse x -> UpdateAliasResponse # | |
NFData UpdateAliasResponse Source # | |
Defined in Amazonka.KMS.UpdateAlias rnf :: UpdateAliasResponse -> () # | |
type Rep UpdateAliasResponse Source # | |
newUpdateAliasResponse :: UpdateAliasResponse Source #
Create a value of UpdateAliasResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeKey
data DescribeKey Source #
See: newDescribeKey
smart constructor.
DescribeKey' (Maybe [Text]) Text |
Instances
Create a value of DescribeKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:grantTokens:DescribeKey'
, describeKey_grantTokens
- 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.
$sel:keyId:DescribeKey'
, describeKey_keyId
- 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.
data DescribeKeyResponse Source #
See: newDescribeKeyResponse
smart constructor.
Instances
newDescribeKeyResponse Source #
Create a value of DescribeKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyMetadata:DescribeKeyResponse'
, describeKeyResponse_keyMetadata
- Metadata associated with the key.
$sel:httpStatus:DescribeKeyResponse'
, describeKeyResponse_httpStatus
- The response's http status code.
DescribeCustomKeyStores
data DescribeCustomKeyStores Source #
See: newDescribeCustomKeyStores
smart constructor.
Instances
newDescribeCustomKeyStores :: DescribeCustomKeyStores Source #
Create a value of DescribeCustomKeyStores
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreName:DescribeCustomKeyStores'
, describeCustomKeyStores_customKeyStoreName
- 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, you can use either the CustomKeyStoreId
or
CustomKeyStoreName
parameter, but not both.
$sel:marker:DescribeCustomKeyStores'
, describeCustomKeyStores_marker
- 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.
$sel:limit:DescribeCustomKeyStores'
, describeCustomKeyStores_limit
- 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.
$sel:customKeyStoreId:DescribeCustomKeyStores'
, describeCustomKeyStores_customKeyStoreId
- 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, you can use either the CustomKeyStoreId
or
CustomKeyStoreName
parameter, but not both.
data DescribeCustomKeyStoresResponse Source #
See: newDescribeCustomKeyStoresResponse
smart constructor.
Instances
newDescribeCustomKeyStoresResponse Source #
Create a value of DescribeCustomKeyStoresResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:DescribeCustomKeyStoresResponse'
, describeCustomKeyStoresResponse_truncated
- 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.
$sel:nextMarker:DescribeCustomKeyStoresResponse'
, describeCustomKeyStoresResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
$sel:customKeyStores:DescribeCustomKeyStoresResponse'
, describeCustomKeyStoresResponse_customKeyStores
- Contains metadata about each custom key store.
$sel:httpStatus:DescribeCustomKeyStoresResponse'
, describeCustomKeyStoresResponse_httpStatus
- The response's http status code.
CancelKeyDeletion
data CancelKeyDeletion Source #
See: newCancelKeyDeletion
smart constructor.
Instances
Create a value of CancelKeyDeletion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:CancelKeyDeletion'
, cancelKeyDeletion_keyId
- 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.
data CancelKeyDeletionResponse Source #
See: newCancelKeyDeletionResponse
smart constructor.
Instances
newCancelKeyDeletionResponse Source #
Create a value of CancelKeyDeletionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:CancelKeyDeletion'
, cancelKeyDeletionResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key whose deletion is canceled.
$sel:httpStatus:CancelKeyDeletionResponse'
, cancelKeyDeletionResponse_httpStatus
- The response's http status code.
Decrypt
See: newDecrypt
smart constructor.
Decrypt' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) Base64 |
Instances
Create a value of Decrypt
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:Decrypt'
, decrypt_keyId
- 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.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric 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.
$sel:encryptionContext:Decrypt'
, decrypt_encryptionContext
- Specifies the encryption context to use when decrypting the data. An
encryption context is valid only for
cryptographic operations
with a symmetric KMS key. The standard asymmetric encryption algorithms
that KMS uses do not support an encryption context.
An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:grantTokens:Decrypt'
, decrypt_grantTokens
- 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.
$sel:encryptionAlgorithm:Decrypt'
, decrypt_encryptionAlgorithm
- 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 KMS
keys.
$sel:ciphertextBlob:Decrypt'
, decrypt_ciphertextBlob
- 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.
data DecryptResponse Source #
See: newDecryptResponse
smart constructor.
Instances
Create a value of DecryptResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:Decrypt'
, decryptResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that was used to decrypt the ciphertext.
$sel:plaintext:DecryptResponse'
, decryptResponse_plaintext
- 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.
$sel:encryptionAlgorithm:Decrypt'
, decryptResponse_encryptionAlgorithm
- The encryption algorithm that was used to decrypt the ciphertext.
$sel:httpStatus:DecryptResponse'
, decryptResponse_httpStatus
- The response's http status code.
GenerateDataKeyPairWithoutPlaintext
data GenerateDataKeyPairWithoutPlaintext Source #
See: newGenerateDataKeyPairWithoutPlaintext
smart constructor.
GenerateDataKeyPairWithoutPlaintext' (Maybe (HashMap Text Text)) (Maybe [Text]) Text DataKeyPairSpec |
Instances
newGenerateDataKeyPairWithoutPlaintext Source #
Create a value of GenerateDataKeyPairWithoutPlaintext
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionContext:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintext_encryptionContext
- 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:grantTokens:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintext_grantTokens
- 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.
$sel:keyId:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintext_keyId
- Specifies the KMS key that encrypts the private key in the data key
pair. You must specify a symmetric KMS key. You cannot use 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.
$sel:keyPairSpec:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintext_keyPairSpec
- Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA 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.
data GenerateDataKeyPairWithoutPlaintextResponse Source #
See: newGenerateDataKeyPairWithoutPlaintextResponse
smart constructor.
GenerateDataKeyPairWithoutPlaintextResponse' (Maybe Text) (Maybe Base64) (Maybe DataKeyPairSpec) (Maybe Base64) Int |
Instances
newGenerateDataKeyPairWithoutPlaintextResponse Source #
:: Int |
|
-> GenerateDataKeyPairWithoutPlaintextResponse |
Create a value of GenerateDataKeyPairWithoutPlaintextResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintextResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that encrypted the private key.
$sel:publicKey:GenerateDataKeyPairWithoutPlaintextResponse'
, generateDataKeyPairWithoutPlaintextResponse_publicKey
- The public key (in plaintext).--
-- 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.
$sel:keyPairSpec:GenerateDataKeyPairWithoutPlaintext'
, generateDataKeyPairWithoutPlaintextResponse_keyPairSpec
- The type of data key pair that was generated.
$sel:privateKeyCiphertextBlob:GenerateDataKeyPairWithoutPlaintextResponse'
, generateDataKeyPairWithoutPlaintextResponse_privateKeyCiphertextBlob
- 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.
$sel:httpStatus:GenerateDataKeyPairWithoutPlaintextResponse'
, generateDataKeyPairWithoutPlaintextResponse_httpStatus
- The response's http status code.
UpdateKeyDescription
data UpdateKeyDescription Source #
See: newUpdateKeyDescription
smart constructor.
Instances
newUpdateKeyDescription Source #
:: Text | |
-> Text | |
-> UpdateKeyDescription |
Create a value of UpdateKeyDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:UpdateKeyDescription'
, updateKeyDescription_keyId
- 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.
$sel:description:UpdateKeyDescription'
, updateKeyDescription_description
- New description for the KMS key.
data UpdateKeyDescriptionResponse Source #
See: newUpdateKeyDescriptionResponse
smart constructor.
Instances
newUpdateKeyDescriptionResponse :: UpdateKeyDescriptionResponse Source #
Create a value of UpdateKeyDescriptionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ReEncrypt
See: newReEncrypt
smart constructor.
ReEncrypt' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text]) (Maybe EncryptionAlgorithmSpec) (Maybe EncryptionAlgorithmSpec) Base64 Text |
Instances
Create a value of ReEncrypt
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationEncryptionContext:ReEncrypt'
, reEncrypt_destinationEncryptionContext
- 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 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:sourceKeyId:ReEncrypt'
, reEncrypt_sourceKeyId
- 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.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric 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.
$sel:sourceEncryptionContext:ReEncrypt'
, reEncrypt_sourceEncryptionContext
- 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:grantTokens:ReEncrypt'
, reEncrypt_grantTokens
- 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.
$sel:destinationEncryptionAlgorithm:ReEncrypt'
, reEncrypt_destinationEncryptionAlgorithm
- 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 KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
$sel:sourceEncryptionAlgorithm:ReEncrypt'
, reEncrypt_sourceEncryptionAlgorithm
- 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 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.
$sel:ciphertextBlob:ReEncrypt'
, reEncrypt_ciphertextBlob
- 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.
$sel:destinationKeyId:ReEncrypt'
, reEncrypt_destinationKeyId
- A unique identifier for the KMS key that is used to reencrypt the data.
Specify a symmetric or 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.
data ReEncryptResponse Source #
See: newReEncryptResponse
smart constructor.
ReEncryptResponse' (Maybe Text) (Maybe Text) (Maybe EncryptionAlgorithmSpec) (Maybe EncryptionAlgorithmSpec) (Maybe Base64) Int |
Instances
Create a value of ReEncryptResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:sourceKeyId:ReEncrypt'
, reEncryptResponse_sourceKeyId
- Unique identifier of the KMS key used to originally encrypt the data.
$sel:keyId:ReEncryptResponse'
, reEncryptResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that was used to reencrypt the data.
$sel:destinationEncryptionAlgorithm:ReEncrypt'
, reEncryptResponse_destinationEncryptionAlgorithm
- The encryption algorithm that was used to reencrypt the data.
$sel:sourceEncryptionAlgorithm:ReEncrypt'
, reEncryptResponse_sourceEncryptionAlgorithm
- The encryption algorithm that was used to decrypt the ciphertext before
it was reencrypted.
$sel:ciphertextBlob:ReEncrypt'
, reEncryptResponse_ciphertextBlob
- 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.
$sel:httpStatus:ReEncryptResponse'
, reEncryptResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:TagResource'
, tagResource_keyId
- 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.
$sel:tags:TagResource'
, tagResource_tags
- 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.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Eq TagResourceResponse Source # | |
Defined in Amazonka.KMS.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
Read TagResourceResponse Source # | |
Defined in Amazonka.KMS.TagResource | |
Show TagResourceResponse Source # | |
Defined in Amazonka.KMS.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
Generic TagResourceResponse Source # | |
Defined in Amazonka.KMS.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.KMS.TagResource rnf :: TagResourceResponse -> () # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListKeyPolicies (Paginated)
data ListKeyPolicies Source #
See: newListKeyPolicies
smart constructor.
Instances
Create a value of ListKeyPolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:marker:ListKeyPolicies'
, listKeyPolicies_marker
- 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.
$sel:limit:ListKeyPolicies'
, listKeyPolicies_limit
- 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.
$sel:keyId:ListKeyPolicies'
, listKeyPolicies_keyId
- 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.
data ListKeyPoliciesResponse Source #
See: newListKeyPoliciesResponse
smart constructor.
Instances
newListKeyPoliciesResponse Source #
Create a value of ListKeyPoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyNames:ListKeyPoliciesResponse'
, listKeyPoliciesResponse_policyNames
- A list of key policy names. The only valid value is default
.
$sel:truncated:ListKeyPoliciesResponse'
, listKeyPoliciesResponse_truncated
- 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.
$sel:nextMarker:ListKeyPoliciesResponse'
, listKeyPoliciesResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
$sel:httpStatus:ListKeyPoliciesResponse'
, listKeyPoliciesResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:UntagResource'
, untagResource_keyId
- 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.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- One or more tag keys. Specify only the tag keys, not the tag values.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Eq UntagResourceResponse Source # | |
Defined in Amazonka.KMS.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.KMS.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
Generic UntagResourceResponse Source # | |
Defined in Amazonka.KMS.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.KMS.UntagResource rnf :: UntagResourceResponse -> () # | |
type Rep UntagResourceResponse Source # | |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Sign
See: newSign
smart constructor.
Instances
:: Text | |
-> ByteString | |
-> SigningAlgorithmSpec | |
-> Sign |
Create a value of Sign
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:messageType:Sign'
, sign_messageType
- 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
.
$sel:grantTokens:Sign'
, sign_grantTokens
- 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.
$sel:keyId:Sign'
, sign_keyId
- 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.
$sel:message:Sign'
, sign_message
- 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.
$sel:signingAlgorithm:Sign'
, sign_signingAlgorithm
- 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.
data SignResponse Source #
See: newSignResponse
smart constructor.
Instances
Create a value of SignResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:signingAlgorithm:Sign'
, signResponse_signingAlgorithm
- The signing algorithm that was used to sign the message.
$sel:signature:SignResponse'
, signResponse_signature
- 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.
$sel:keyId:Sign'
, signResponse_keyId
- The Amazon Resource Name
(key ARN)
of the asymmetric KMS key that was used to sign the message.
$sel:httpStatus:SignResponse'
, signResponse_httpStatus
- The response's http status code.
ScheduleKeyDeletion
data ScheduleKeyDeletion Source #
See: newScheduleKeyDeletion
smart constructor.
Instances
newScheduleKeyDeletion Source #
Create a value of ScheduleKeyDeletion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:pendingWindowInDays:ScheduleKeyDeletion'
, scheduleKeyDeletion_pendingWindowInDays
- 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 replicas, 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.
$sel:keyId:ScheduleKeyDeletion'
, scheduleKeyDeletion_keyId
- 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.
data ScheduleKeyDeletionResponse Source #
See: newScheduleKeyDeletionResponse
smart constructor.
Instances
newScheduleKeyDeletionResponse Source #
Create a value of ScheduleKeyDeletionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:ScheduleKeyDeletion'
, scheduleKeyDeletionResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key whose deletion is scheduled.
$sel:keyState:ScheduleKeyDeletionResponse'
, scheduleKeyDeletionResponse_keyState
- The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
$sel:deletionDate:ScheduleKeyDeletionResponse'
, scheduleKeyDeletionResponse_deletionDate
- 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.
$sel:pendingWindowInDays:ScheduleKeyDeletion'
, scheduleKeyDeletionResponse_pendingWindowInDays
- 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.
$sel:httpStatus:ScheduleKeyDeletionResponse'
, scheduleKeyDeletionResponse_httpStatus
- The response's http status code.
GenerateDataKeyPair
data GenerateDataKeyPair Source #
See: newGenerateDataKeyPair
smart constructor.
Instances
newGenerateDataKeyPair Source #
Create a value of GenerateDataKeyPair
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionContext:GenerateDataKeyPair'
, generateDataKeyPair_encryptionContext
- 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 represents 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 optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
$sel:grantTokens:GenerateDataKeyPair'
, generateDataKeyPair_grantTokens
- 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.
$sel:keyId:GenerateDataKeyPair'
, generateDataKeyPair_keyId
- Specifies the symmetric 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.
$sel:keyPairSpec:GenerateDataKeyPair'
, generateDataKeyPair_keyPairSpec
- Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA 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.
data GenerateDataKeyPairResponse Source #
See: newGenerateDataKeyPairResponse
smart constructor.
GenerateDataKeyPairResponse' (Maybe Text) (Maybe Base64) (Maybe (Sensitive Base64)) (Maybe DataKeyPairSpec) (Maybe Base64) Int |
Instances
newGenerateDataKeyPairResponse Source #
Create a value of GenerateDataKeyPairResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GenerateDataKeyPair'
, generateDataKeyPairResponse_keyId
- The Amazon Resource Name
(key ARN)
of the KMS key that encrypted the private key.
$sel:publicKey:GenerateDataKeyPairResponse'
, generateDataKeyPairResponse_publicKey
- The public key (in plaintext).--
-- 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.
$sel:privateKeyPlaintext:GenerateDataKeyPairResponse'
, generateDataKeyPairResponse_privateKeyPlaintext
- 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.
$sel:keyPairSpec:GenerateDataKeyPair'
, generateDataKeyPairResponse_keyPairSpec
- The type of data key pair that was generated.
$sel:privateKeyCiphertextBlob:GenerateDataKeyPairResponse'
, generateDataKeyPairResponse_privateKeyCiphertextBlob
- 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.
$sel:httpStatus:GenerateDataKeyPairResponse'
, generateDataKeyPairResponse_httpStatus
- The response's http status code.
ReplicateKey
data ReplicateKey Source #
See: newReplicateKey
smart constructor.
Instances
Create a value of ReplicateKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassPolicyLockoutSafetyCheck:ReplicateKey'
, replicateKey_bypassPolicyLockoutSafetyCheck
- 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.
$sel:policy:ReplicateKey'
, replicateKey_policy
- 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/ .
- The key policy size quota is 32 kilobytes (32768 bytes).
$sel:description:ReplicateKey'
, replicateKey_description
- 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.
$sel:tags:ReplicateKey'
, replicateKey_tags
- 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 Using ABAC in 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.
$sel:keyId:ReplicateKey'
, replicateKey_keyId
- 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.
$sel:replicaRegion:ReplicateKey'
, replicateKey_replicaRegion
- 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.
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.
data ReplicateKeyResponse Source #
See: newReplicateKeyResponse
smart constructor.
ReplicateKeyResponse' (Maybe KeyMetadata) (Maybe Text) (Maybe [Tag]) Int |
Instances
newReplicateKeyResponse Source #
Create a value of ReplicateKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicaKeyMetadata:ReplicateKeyResponse'
, replicateKeyResponse_replicaKeyMetadata
- Displays details about the new replica key, including its Amazon
Resource Name
(key ARN)
and
key state.
It also includes the ARN and Amazon Web Services Region of its primary
key and other replica keys.
$sel:replicaPolicy:ReplicateKeyResponse'
, replicateKeyResponse_replicaPolicy
- The key policy of the new replica key. The value is a key policy
document in JSON format.
$sel:replicaTags:ReplicateKeyResponse'
, replicateKeyResponse_replicaTags
- The tags on the new replica key. The value is a list of tag key and tag
value pairs.
$sel:httpStatus:ReplicateKeyResponse'
, replicateKeyResponse_httpStatus
- The response's http status code.
PutKeyPolicy
data PutKeyPolicy Source #
See: newPutKeyPolicy
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> PutKeyPolicy |
Create a value of PutKeyPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bypassPolicyLockoutSafetyCheck:PutKeyPolicy'
, putKeyPolicy_bypassPolicyLockoutSafetyCheck
- 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.
$sel:keyId:PutKeyPolicy'
, putKeyPolicy_keyId
- 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.
$sel:policyName:PutKeyPolicy'
, putKeyPolicy_policyName
- The name of the key policy. The only valid value is default
.
$sel:policy:PutKeyPolicy'
, putKeyPolicy_policy
- 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/.
The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the Key Management Service Developer Guide.
data PutKeyPolicyResponse Source #
See: newPutKeyPolicyResponse
smart constructor.
Instances
Eq PutKeyPolicyResponse Source # | |
Defined in Amazonka.KMS.PutKeyPolicy (==) :: PutKeyPolicyResponse -> PutKeyPolicyResponse -> Bool # (/=) :: PutKeyPolicyResponse -> PutKeyPolicyResponse -> Bool # | |
Read PutKeyPolicyResponse Source # | |
Defined in Amazonka.KMS.PutKeyPolicy | |
Show PutKeyPolicyResponse Source # | |
Defined in Amazonka.KMS.PutKeyPolicy showsPrec :: Int -> PutKeyPolicyResponse -> ShowS # show :: PutKeyPolicyResponse -> String # showList :: [PutKeyPolicyResponse] -> ShowS # | |
Generic PutKeyPolicyResponse Source # | |
Defined in Amazonka.KMS.PutKeyPolicy type Rep PutKeyPolicyResponse :: Type -> Type # from :: PutKeyPolicyResponse -> Rep PutKeyPolicyResponse x # to :: Rep PutKeyPolicyResponse x -> PutKeyPolicyResponse # | |
NFData PutKeyPolicyResponse Source # | |
Defined in Amazonka.KMS.PutKeyPolicy rnf :: PutKeyPolicyResponse -> () # | |
type Rep PutKeyPolicyResponse Source # | |
newPutKeyPolicyResponse :: PutKeyPolicyResponse Source #
Create a value of PutKeyPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
EnableKey
See: newEnableKey
smart constructor.
Instances
Eq EnableKey Source # | |
Read EnableKey Source # | |
Show EnableKey Source # | |
Generic EnableKey Source # | |
NFData EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey | |
Hashable EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey | |
ToJSON EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey | |
AWSRequest EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey type AWSResponse EnableKey # request :: EnableKey -> Request EnableKey # response :: MonadResource m => Logger -> Service -> Proxy EnableKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnableKey))) # | |
ToHeaders EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey | |
ToPath EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey toPath :: EnableKey -> ByteString # | |
ToQuery EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey toQuery :: EnableKey -> QueryString # | |
type Rep EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey | |
type AWSResponse EnableKey Source # | |
Defined in Amazonka.KMS.EnableKey |
Create a value of EnableKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:EnableKey'
, enableKey_keyId
- 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.
data EnableKeyResponse Source #
See: newEnableKeyResponse
smart constructor.
Instances
Eq EnableKeyResponse Source # | |
Defined in Amazonka.KMS.EnableKey (==) :: EnableKeyResponse -> EnableKeyResponse -> Bool # (/=) :: EnableKeyResponse -> EnableKeyResponse -> Bool # | |
Read EnableKeyResponse Source # | |
Defined in Amazonka.KMS.EnableKey | |
Show EnableKeyResponse Source # | |
Defined in Amazonka.KMS.EnableKey showsPrec :: Int -> EnableKeyResponse -> ShowS # show :: EnableKeyResponse -> String # showList :: [EnableKeyResponse] -> ShowS # | |
Generic EnableKeyResponse Source # | |
Defined in Amazonka.KMS.EnableKey type Rep EnableKeyResponse :: Type -> Type # from :: EnableKeyResponse -> Rep EnableKeyResponse x # to :: Rep EnableKeyResponse x -> EnableKeyResponse # | |
NFData EnableKeyResponse Source # | |
Defined in Amazonka.KMS.EnableKey rnf :: EnableKeyResponse -> () # | |
type Rep EnableKeyResponse Source # | |
newEnableKeyResponse :: EnableKeyResponse Source #
Create a value of EnableKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RevokeGrant
data RevokeGrant Source #
See: newRevokeGrant
smart constructor.
Instances
Create a value of RevokeGrant
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:RevokeGrant'
, revokeGrant_keyId
- 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.
$sel:grantId:RevokeGrant'
, revokeGrant_grantId
- Identifies the grant to revoke. To get the grant ID, use CreateGrant,
ListGrants, or ListRetirableGrants.
data RevokeGrantResponse Source #
See: newRevokeGrantResponse
smart constructor.
Instances
Eq RevokeGrantResponse Source # | |
Defined in Amazonka.KMS.RevokeGrant (==) :: RevokeGrantResponse -> RevokeGrantResponse -> Bool # (/=) :: RevokeGrantResponse -> RevokeGrantResponse -> Bool # | |
Read RevokeGrantResponse Source # | |
Defined in Amazonka.KMS.RevokeGrant | |
Show RevokeGrantResponse Source # | |
Defined in Amazonka.KMS.RevokeGrant showsPrec :: Int -> RevokeGrantResponse -> ShowS # show :: RevokeGrantResponse -> String # showList :: [RevokeGrantResponse] -> ShowS # | |
Generic RevokeGrantResponse Source # | |
Defined in Amazonka.KMS.RevokeGrant type Rep RevokeGrantResponse :: Type -> Type # from :: RevokeGrantResponse -> Rep RevokeGrantResponse x # to :: Rep RevokeGrantResponse x -> RevokeGrantResponse # | |
NFData RevokeGrantResponse Source # | |
Defined in Amazonka.KMS.RevokeGrant rnf :: RevokeGrantResponse -> () # | |
type Rep RevokeGrantResponse Source # | |
newRevokeGrantResponse :: RevokeGrantResponse Source #
Create a value of RevokeGrantResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetKeyPolicy
data GetKeyPolicy Source #
See: newGetKeyPolicy
smart constructor.
Instances
Create a value of GetKeyPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GetKeyPolicy'
, getKeyPolicy_keyId
- 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.
$sel:policyName:GetKeyPolicy'
, getKeyPolicy_policyName
- Specifies the name of the key policy. The only valid name is default
.
To get the names of key policies, use ListKeyPolicies.
data GetKeyPolicyResponse Source #
See: newGetKeyPolicyResponse
smart constructor.
Instances
newGetKeyPolicyResponse Source #
Create a value of GetKeyPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:GetKeyPolicyResponse'
, getKeyPolicyResponse_policy
- A key policy document in JSON format.
$sel:httpStatus:GetKeyPolicyResponse'
, getKeyPolicyResponse_httpStatus
- The response's http status code.
ImportKeyMaterial
data ImportKeyMaterial Source #
See: newImportKeyMaterial
smart constructor.
Instances
:: Text | |
-> ByteString | |
-> ByteString | |
-> ImportKeyMaterial |
Create a value of ImportKeyMaterial
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:expirationModel:ImportKeyMaterial'
, importKeyMaterial_expirationModel
- Specifies whether the key material expires. The default is
KEY_MATERIAL_EXPIRES
, in which case you must include the ValidTo
parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE
,
you must omit the ValidTo
parameter.
$sel:validTo:ImportKeyMaterial'
, importKeyMaterial_validTo
- 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. You must omit this parameter when the ExpirationModel
parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE
. Otherwise it is
required.
$sel:keyId:ImportKeyMaterial'
, importKeyMaterial_keyId
- The identifier of the symmetric KMS key that receives the imported key
material. The KMS key's Origin
must be EXTERNAL
. This must be the
same KMS key specified in the KeyID
parameter of the corresponding
GetParametersForImport request.
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.
$sel:importToken:ImportKeyMaterial'
, importKeyMaterial_importToken
- 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.
$sel:encryptedKeyMaterial:ImportKeyMaterial'
, importKeyMaterial_encryptedKeyMaterial
- 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.
data ImportKeyMaterialResponse Source #
See: newImportKeyMaterialResponse
smart constructor.
Instances
newImportKeyMaterialResponse Source #
Create a value of ImportKeyMaterialResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:ImportKeyMaterialResponse'
, importKeyMaterialResponse_httpStatus
- The response's http status code.
DeleteImportedKeyMaterial
data DeleteImportedKeyMaterial Source #
See: newDeleteImportedKeyMaterial
smart constructor.
Instances
newDeleteImportedKeyMaterial Source #
Create a value of DeleteImportedKeyMaterial
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:DeleteImportedKeyMaterial'
, deleteImportedKeyMaterial_keyId
- 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.
data DeleteImportedKeyMaterialResponse Source #
See: newDeleteImportedKeyMaterialResponse
smart constructor.
Instances
newDeleteImportedKeyMaterialResponse :: DeleteImportedKeyMaterialResponse Source #
Create a value of DeleteImportedKeyMaterialResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
AlgorithmSpec
newtype AlgorithmSpec Source #
pattern AlgorithmSpec_RSAES_OAEP_SHA_1 :: AlgorithmSpec | |
pattern AlgorithmSpec_RSAES_OAEP_SHA_256 :: AlgorithmSpec | |
pattern AlgorithmSpec_RSAES_PKCS1_V1_5 :: AlgorithmSpec |
Instances
ConnectionErrorCodeType
newtype ConnectionErrorCodeType Source #
Instances
ConnectionStateType
newtype ConnectionStateType Source #
pattern ConnectionStateType_CONNECTED :: ConnectionStateType | |
pattern ConnectionStateType_CONNECTING :: ConnectionStateType | |
pattern ConnectionStateType_DISCONNECTED :: ConnectionStateType | |
pattern ConnectionStateType_DISCONNECTING :: ConnectionStateType | |
pattern ConnectionStateType_FAILED :: ConnectionStateType |
Instances
CustomerMasterKeySpec
newtype CustomerMasterKeySpec Source #
Instances
DataKeyPairSpec
newtype DataKeyPairSpec Source #
pattern DataKeyPairSpec_ECC_NIST_P256 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_ECC_NIST_P384 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_ECC_NIST_P521 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_ECC_SECG_P256K1 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_RSA_2048 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_RSA_3072 :: DataKeyPairSpec | |
pattern DataKeyPairSpec_RSA_4096 :: DataKeyPairSpec |
Instances
DataKeySpec
newtype DataKeySpec Source #
pattern DataKeySpec_AES_128 :: DataKeySpec | |
pattern DataKeySpec_AES_256 :: DataKeySpec |
Instances
EncryptionAlgorithmSpec
newtype EncryptionAlgorithmSpec Source #
Instances
ExpirationModelType
newtype ExpirationModelType Source #
pattern ExpirationModelType_KEY_MATERIAL_DOES_NOT_EXPIRE :: ExpirationModelType | |
pattern ExpirationModelType_KEY_MATERIAL_EXPIRES :: ExpirationModelType |
Instances
GrantOperation
newtype GrantOperation Source #
pattern GrantOperation_CreateGrant :: GrantOperation | |
pattern GrantOperation_Decrypt :: GrantOperation | |
pattern GrantOperation_DescribeKey :: GrantOperation | |
pattern GrantOperation_Encrypt :: GrantOperation | |
pattern GrantOperation_GenerateDataKey :: GrantOperation | |
pattern GrantOperation_GenerateDataKeyPair :: GrantOperation | |
pattern GrantOperation_GenerateDataKeyPairWithoutPlaintext :: GrantOperation | |
pattern GrantOperation_GenerateDataKeyWithoutPlaintext :: GrantOperation | |
pattern GrantOperation_GetPublicKey :: GrantOperation | |
pattern GrantOperation_ReEncryptFrom :: GrantOperation | |
pattern GrantOperation_ReEncryptTo :: GrantOperation | |
pattern GrantOperation_RetireGrant :: GrantOperation | |
pattern GrantOperation_Sign :: GrantOperation | |
pattern GrantOperation_Verify :: GrantOperation |
Instances
KeyManagerType
newtype KeyManagerType Source #
pattern KeyManagerType_AWS :: KeyManagerType | |
pattern KeyManagerType_CUSTOMER :: KeyManagerType |
Instances
KeySpec
pattern KeySpec_ECC_NIST_P256 :: KeySpec | |
pattern KeySpec_ECC_NIST_P384 :: KeySpec | |
pattern KeySpec_ECC_NIST_P521 :: KeySpec | |
pattern KeySpec_ECC_SECG_P256K1 :: KeySpec | |
pattern KeySpec_RSA_2048 :: KeySpec | |
pattern KeySpec_RSA_3072 :: KeySpec | |
pattern KeySpec_RSA_4096 :: KeySpec | |
pattern KeySpec_SYMMETRIC_DEFAULT :: KeySpec |
Instances
KeyState
pattern KeyState_Creating :: KeyState | |
pattern KeyState_Disabled :: KeyState | |
pattern KeyState_Enabled :: KeyState | |
pattern KeyState_PendingDeletion :: KeyState | |
pattern KeyState_PendingImport :: KeyState | |
pattern KeyState_PendingReplicaDeletion :: KeyState | |
pattern KeyState_Unavailable :: KeyState | |
pattern KeyState_Updating :: KeyState |
Instances
KeyUsageType
newtype KeyUsageType Source #
pattern KeyUsageType_ENCRYPT_DECRYPT :: KeyUsageType | |
pattern KeyUsageType_SIGN_VERIFY :: KeyUsageType |
Instances
MessageType
newtype MessageType Source #
pattern MessageType_DIGEST :: MessageType | |
pattern MessageType_RAW :: MessageType |
Instances
MultiRegionKeyType
newtype MultiRegionKeyType Source #
pattern MultiRegionKeyType_PRIMARY :: MultiRegionKeyType | |
pattern MultiRegionKeyType_REPLICA :: MultiRegionKeyType |
Instances
OriginType
newtype OriginType Source #
pattern OriginType_AWS_CLOUDHSM :: OriginType | |
pattern OriginType_AWS_KMS :: OriginType | |
pattern OriginType_EXTERNAL :: OriginType |
Instances
SigningAlgorithmSpec
newtype SigningAlgorithmSpec Source #
Instances
WrappingKeySpec
newtype WrappingKeySpec Source #
pattern WrappingKeySpec_RSA_2048 :: WrappingKeySpec |
Instances
AliasListEntry
data AliasListEntry Source #
Contains information about an alias.
See: newAliasListEntry
smart constructor.
Instances
newAliasListEntry :: AliasListEntry Source #
Create a value of AliasListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetKeyId:AliasListEntry'
, aliasListEntry_targetKeyId
- String that contains the key identifier of the KMS key associated with
the alias.
$sel:aliasName:AliasListEntry'
, aliasListEntry_aliasName
- String that contains the alias. This value begins with alias/
.
$sel:creationDate:AliasListEntry'
, aliasListEntry_creationDate
- Date and time that the alias was most recently created in the account
and Region. Formatted as Unix time.
$sel:lastUpdatedDate:AliasListEntry'
, aliasListEntry_lastUpdatedDate
- Date and time that the alias was most recently associated with a KMS key
in the account and Region. Formatted as Unix time.
$sel:aliasArn:AliasListEntry'
, aliasListEntry_aliasArn
- String that contains the key ARN.
CustomKeyStoresListEntry
data CustomKeyStoresListEntry Source #
Contains information about each custom key store in the custom key store list.
See: newCustomKeyStoresListEntry
smart constructor.
CustomKeyStoresListEntry' (Maybe Text) (Maybe Text) (Maybe ConnectionErrorCodeType) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe ConnectionStateType) |
Instances
newCustomKeyStoresListEntry :: CustomKeyStoresListEntry Source #
Create a value of CustomKeyStoresListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:customKeyStoreName:CustomKeyStoresListEntry'
, customKeyStoresListEntry_customKeyStoreName
- The user-specified friendly name for the custom key store.
$sel:trustAnchorCertificate:CustomKeyStoresListEntry'
, customKeyStoresListEntry_trustAnchorCertificate
- The trust anchor certificate of the associated CloudHSM cluster. When
you
initialize the cluster,
you create this certificate and save it in the customerCA.crt
file.
$sel:connectionErrorCode:CustomKeyStoresListEntry'
, customKeyStoresListEntry_connectionErrorCode
- Describes the connection error. This field appears in the response only
when the ConnectionState
is FAILED
. For help resolving these errors,
see
How to Fix a Connection Failure
in Key Management Service Developer Guide.
Valid values are:
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.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.INVALID_CREDENTIALS
- KMS does not have the correct password for 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 the key store password value for the custom key store.NETWORK_ERRORS
- Network errors are preventing KMS from connecting to 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 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.
$sel:creationDate:CustomKeyStoresListEntry'
, customKeyStoresListEntry_creationDate
- The date and time when the custom key store was created.
$sel:cloudHsmClusterId:CustomKeyStoresListEntry'
, customKeyStoresListEntry_cloudHsmClusterId
- A unique identifier for the CloudHSM cluster that is associated with the
custom key store.
$sel:customKeyStoreId:CustomKeyStoresListEntry'
, customKeyStoresListEntry_customKeyStoreId
- A unique identifier for the custom key store.
$sel:connectionState:CustomKeyStoresListEntry'
, customKeyStoresListEntry_connectionState
- Indicates whether the custom key store is connected to its CloudHSM
cluster.
You can create and use KMS keys in your custom key stores only when its
connection state is CONNECTED
.
The value is DISCONNECTED
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 its associated CloudHSM cluster is active and
contains at least one active HSM.
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.
GrantConstraints
data GrantConstraints Source #
Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.
KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.
In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.
However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.
To avoid confusion, do not use multiple encryption context pairs that
differ only by case. To require a fully case-sensitive encryption
context, use the kms:EncryptionContext:
and
kms:EncryptionContextKeys
conditions in an IAM or key policy. For
details, see
kms:EncryptionContext:
in the /Key Management Service Developer Guide/ .
See: newGrantConstraints
smart constructor.
Instances
newGrantConstraints :: GrantConstraints Source #
Create a value of GrantConstraints
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encryptionContextEquals:GrantConstraints'
, grantConstraints_encryptionContextEquals
- 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.
$sel:encryptionContextSubset:GrantConstraints'
, grantConstraints_encryptionContextSubset
- 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
data GrantListEntry Source #
Contains information about a grant.
See: newGrantListEntry
smart constructor.
GrantListEntry' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe GrantConstraints) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [GrantOperation]) |
Instances
newGrantListEntry :: GrantListEntry Source #
Create a value of GrantListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:GrantListEntry'
, grantListEntry_keyId
- The unique identifier for the KMS key to which the grant applies.
$sel:retiringPrincipal:GrantListEntry'
, grantListEntry_retiringPrincipal
- The principal that can retire the grant.
$sel:issuingAccount:GrantListEntry'
, grantListEntry_issuingAccount
- The Amazon Web Services account under which the grant was issued.
$sel:grantId:GrantListEntry'
, grantListEntry_grantId
- The unique identifier for the grant.
$sel:constraints:GrantListEntry'
, grantListEntry_constraints
- A list of key-value pairs that must be present in the encryption context
of certain subsequent operations that the grant allows.
$sel:granteePrincipal:GrantListEntry'
, grantListEntry_granteePrincipal
- 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.
$sel:name:GrantListEntry'
, grantListEntry_name
- 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.
$sel:creationDate:GrantListEntry'
, grantListEntry_creationDate
- The date and time when the grant was created.
$sel:operations:GrantListEntry'
, grantListEntry_operations
- The list of operations permitted by the grant.
KeyListEntry
data KeyListEntry Source #
Contains information about each entry in the key list.
See: newKeyListEntry
smart constructor.
KeyListEntry' (Maybe Text) (Maybe Text) |
Instances
newKeyListEntry :: KeyListEntry Source #
Create a value of KeyListEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:keyId:KeyListEntry'
, keyListEntry_keyId
- Unique identifier of the key.
$sel:keyArn:KeyListEntry'
, keyListEntry_keyArn
- ARN of the key.
KeyMetadata
data KeyMetadata Source #
Contains metadata about a KMS key.
This data type is used as a response element for the CreateKey and DescribeKey operations.
See: newKeyMetadata
smart constructor.
KeyMetadata' (Maybe OriginType) (Maybe ExpirationModelType) (Maybe KeyManagerType) (Maybe KeySpec) (Maybe CustomerMasterKeySpec) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe KeyState) (Maybe [EncryptionAlgorithmSpec]) (Maybe Text) (Maybe [SigningAlgorithmSpec]) (Maybe Natural) (Maybe KeyUsageType) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe MultiRegionConfiguration) Text |
Instances
Create a value of KeyMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:origin:KeyMetadata'
, keyMetadata_origin
- 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.
$sel:expirationModel:KeyMetadata'
, keyMetadata_expirationModel
- Specifies whether the KMS key's key material expires. This value is
present only when Origin
is EXTERNAL
, otherwise this value is
omitted.
$sel:keyManager:KeyMetadata'
, keyMetadata_keyManager
- 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.
$sel:keySpec:KeyMetadata'
, keyMetadata_keySpec
- Describes the type of key material in the KMS key.
$sel:customerMasterKeySpec:KeyMetadata'
, keyMetadata_customerMasterKeySpec
- 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 will support both fields.
$sel:enabled:KeyMetadata'
, keyMetadata_enabled
- Specifies whether the KMS key is enabled. When KeyState
is Enabled
this value is true, otherwise it is false.
$sel:validTo:KeyMetadata'
, keyMetadata_validTo
- 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.
$sel:arn:KeyMetadata'
, keyMetadata_arn
- 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/.
$sel:keyState:KeyMetadata'
, keyMetadata_keyState
- The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
$sel:encryptionAlgorithms:KeyMetadata'
, keyMetadata_encryptionAlgorithms
- 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
.
$sel:aWSAccountId:KeyMetadata'
, keyMetadata_aWSAccountId
- The twelve-digit account ID of the Amazon Web Services account that owns
the KMS key.
$sel:signingAlgorithms:KeyMetadata'
, keyMetadata_signingAlgorithms
- 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
.
$sel:pendingDeletionWindowInDays:KeyMetadata'
, keyMetadata_pendingDeletionWindowInDays
- 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.
$sel:keyUsage:KeyMetadata'
, keyMetadata_keyUsage
- The
cryptographic operations
for which you can use the KMS key.
$sel:creationDate:KeyMetadata'
, keyMetadata_creationDate
- The date and time when the KMS key was created.
$sel:deletionDate:KeyMetadata'
, keyMetadata_deletionDate
- 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.
$sel:cloudHsmClusterId:KeyMetadata'
, keyMetadata_cloudHsmClusterId
- The cluster ID of the CloudHSM cluster that contains the key material
for the KMS key. When you create a KMS key in a
custom key store,
KMS creates the key material for the KMS key in the associated CloudHSM
cluster. This value is present only when the KMS key is created in a
custom key store.
$sel:description:KeyMetadata'
, keyMetadata_description
- The description of the KMS key.
$sel:customKeyStoreId:KeyMetadata'
, keyMetadata_customKeyStoreId
- A unique identifier for the
custom key store
that contains the KMS key. This value is present only when the KMS key
is created in a custom key store.
$sel:multiRegion:KeyMetadata'
, keyMetadata_multiRegion
- 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 Using multi-Region keys in the Key Management Service Developer Guide.
$sel:multiRegionConfiguration:KeyMetadata'
, keyMetadata_multiRegionConfiguration
- 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.
$sel:keyId:KeyMetadata'
, keyMetadata_keyId
- The globally unique identifier for the KMS key.
ListGrantsResponse
data ListGrantsResponse Source #
See: newListGrantsResponse
smart constructor.
ListGrantsResponse' (Maybe Bool) (Maybe [GrantListEntry]) (Maybe Text) |
Instances
newListGrantsResponse :: ListGrantsResponse Source #
Create a value of ListGrantsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truncated:ListGrantsResponse'
, listGrantsResponse_truncated
- 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.
$sel:grants:ListGrantsResponse'
, listGrantsResponse_grants
- A list of grants.
$sel:nextMarker:ListGrantsResponse'
, listGrantsResponse_nextMarker
- When Truncated
is true, this element is present and contains the value
to use for the Marker
parameter in a subsequent request.
MultiRegionConfiguration
data MultiRegionConfiguration Source #
Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.
For more information about any listed KMS key, use the DescribeKey operation.
See: newMultiRegionConfiguration
smart constructor.
MultiRegionConfiguration' (Maybe MultiRegionKey) (Maybe [MultiRegionKey]) (Maybe MultiRegionKeyType) |
Instances
newMultiRegionConfiguration :: MultiRegionConfiguration Source #
Create a value of MultiRegionConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:primaryKey:MultiRegionConfiguration'
, multiRegionConfiguration_primaryKey
- Displays the key ARN and Region of the primary key. This field includes
the current KMS key if it is the primary key.
$sel:replicaKeys:MultiRegionConfiguration'
, multiRegionConfiguration_replicaKeys
- displays the key ARNs and Regions of all replica keys. This field
includes the current KMS key if it is a replica key.
$sel:multiRegionKeyType:MultiRegionConfiguration'
, multiRegionConfiguration_multiRegionKeyType
- Indicates whether the KMS key is a PRIMARY
or REPLICA
key.
MultiRegionKey
data MultiRegionKey Source #
Describes the primary or replica key in a multi-Region key.
See: newMultiRegionKey
smart constructor.
Instances
newMultiRegionKey :: MultiRegionKey Source #
Create a value of MultiRegionKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:MultiRegionKey'
, multiRegionKey_arn
- Displays the key ARN of a primary or replica key of a multi-Region key.
$sel:region:MultiRegionKey'
, multiRegionKey_region
- Displays the Amazon Web Services Region of a primary or replica key in a
multi-Region key.
Tag
A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User Guide.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.KMS.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.KMS.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.KMS.Types.Tag" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tagKey:Tag'
, tag_tagKey
- The key of the tag.
$sel:tagValue:Tag'
, tag_tagValue
- The value of the tag.