{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.KMS.Encrypt
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a
-- symmetric or asymmetric KMS key with a @KeyUsage@ of @ENCRYPT_DECRYPT@.
--
-- You can use this operation to encrypt small amounts of arbitrary data,
-- such as a personal identifier or database password, or other sensitive
-- information. You don\'t need to use the @Encrypt@ operation to encrypt a
-- data key. The GenerateDataKey and GenerateDataKeyPair operations return
-- a plaintext data key and an encrypted copy of that data key.
--
-- If you use a symmetric encryption KMS key, you can use an encryption
-- context to add additional security to your encryption operation. If you
-- specify an @EncryptionContext@ when encrypting data, you must specify
-- the same encryption context (a case-sensitive exact match) when
-- decrypting the data. Otherwise, the request to decrypt fails with an
-- @InvalidCiphertextException@. For more information, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption Context>
-- in the /Key Management Service Developer Guide/.
--
-- If you specify an asymmetric KMS key, you must also specify the
-- encryption algorithm. The algorithm must be compatible with the KMS key
-- spec.
--
-- When you use an asymmetric KMS key to encrypt or reencrypt data, be sure
-- to record the KMS key and encryption algorithm that you choose. You will
-- be required to provide the same KMS key and encryption algorithm when
-- you decrypt the data. If the KMS key and algorithm do not match the
-- values used to encrypt the data, the decrypt operation fails.
--
-- You are not required to supply the key ID and encryption algorithm when
-- you decrypt with symmetric encryption KMS keys because KMS stores this
-- information in the ciphertext blob. KMS cannot store metadata in
-- ciphertext generated with asymmetric keys. The standard format for
-- asymmetric key ciphertext does not include configurable fields.
--
-- The maximum size of the data that you can encrypt varies with the type
-- of KMS key and the encryption algorithm that you choose.
--
-- -   Symmetric encryption KMS keys
--
--     -   @SYMMETRIC_DEFAULT@: 4096 bytes
--
-- -   @RSA_2048@
--
--     -   @RSAES_OAEP_SHA_1@: 214 bytes
--
--     -   @RSAES_OAEP_SHA_256@: 190 bytes
--
-- -   @RSA_3072@
--
--     -   @RSAES_OAEP_SHA_1@: 342 bytes
--
--     -   @RSAES_OAEP_SHA_256@: 318 bytes
--
-- -   @RSA_4096@
--
--     -   @RSAES_OAEP_SHA_1@: 470 bytes
--
--     -   @RSAES_OAEP_SHA_256@: 446 bytes
--
-- -   @SM2PKE@: 1024 bytes (China Regions only)
--
-- The KMS key that you use for this operation must be in a compatible key
-- state. For details, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html Key states of KMS keys>
-- in the /Key Management Service Developer Guide/.
--
-- __Cross-account use__: Yes. To perform this operation with a KMS key in
-- a different Amazon Web Services account, specify the key ARN or alias
-- ARN in the value of the @KeyId@ parameter.
--
-- __Required permissions__:
-- <https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html kms:Encrypt>
-- (key policy)
--
-- __Related operations:__
--
-- -   Decrypt
--
-- -   GenerateDataKey
--
-- -   GenerateDataKeyPair
module Amazonka.KMS.Encrypt
  ( -- * Creating a Request
    Encrypt (..),
    newEncrypt,

    -- * Request Lenses
    encrypt_encryptionAlgorithm,
    encrypt_encryptionContext,
    encrypt_grantTokens,
    encrypt_keyId,
    encrypt_plaintext,

    -- * Destructuring the Response
    EncryptResponse (..),
    newEncryptResponse,

    -- * Response Lenses
    encryptResponse_ciphertextBlob,
    encryptResponse_encryptionAlgorithm,
    encryptResponse_keyId,
    encryptResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.KMS.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newEncrypt' smart constructor.
data Encrypt = Encrypt'
  { -- | Specifies the encryption algorithm that KMS will use to encrypt the
    -- plaintext message. The algorithm must be compatible with the KMS key
    -- that you specify.
    --
    -- This parameter is required only for asymmetric KMS keys. The default
    -- value, @SYMMETRIC_DEFAULT@, is the algorithm used for symmetric
    -- encryption KMS keys. If you are using an asymmetric KMS key, we
    -- recommend RSAES_OAEP_SHA_256.
    --
    -- The SM2PKE algorithm is only available in China Regions.
    Encrypt -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm :: Prelude.Maybe EncryptionAlgorithmSpec,
    -- | Specifies the encryption context that will be used to encrypt the data.
    -- An encryption context is valid only for
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations cryptographic operations>
    -- with a symmetric encryption KMS key. The standard asymmetric encryption
    -- algorithms and HMAC algorithms that KMS uses do not support an
    -- encryption context.
    --
    -- An /encryption context/ is a collection of non-secret key-value pairs
    -- that represent additional authenticated data. When you use an encryption
    -- context to encrypt data, you must specify the same (an exact
    -- case-sensitive match) encryption context to decrypt the data. An
    -- encryption context is supported only on operations with symmetric
    -- encryption KMS keys. On operations with symmetric encryption KMS keys,
    -- an encryption context is optional, but it is strongly recommended.
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption context>
    -- in the /Key Management Service Developer Guide/.
    Encrypt -> Maybe (HashMap Text Text)
encryptionContext :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | 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
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token Grant token>
    -- and
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token Using a grant token>
    -- in the /Key Management Service Developer Guide/.
    Encrypt -> Maybe [Text]
grantTokens :: Prelude.Maybe [Prelude.Text],
    -- | Identifies the KMS key to use in the encryption operation. The KMS key
    -- must have a @KeyUsage@ of @ENCRYPT_DECRYPT@. To find the @KeyUsage@ of a
    -- KMS key, use the DescribeKey operation.
    --
    -- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
    -- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
    -- key in a different Amazon Web Services account, you must use the key ARN
    -- or alias ARN.
    --
    -- For example:
    --
    -- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
    --
    -- -   Key ARN:
    --     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
    --
    -- -   Alias name: @alias\/ExampleAlias@
    --
    -- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
    --
    -- To get the key ID and key ARN for a KMS key, use ListKeys or
    -- DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Encrypt -> Text
keyId :: Prelude.Text,
    -- | Data to be encrypted.
    Encrypt -> Sensitive Base64
plaintext :: Data.Sensitive Data.Base64
  }
  deriving (Encrypt -> Encrypt -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Encrypt -> Encrypt -> Bool
$c/= :: Encrypt -> Encrypt -> Bool
== :: Encrypt -> Encrypt -> Bool
$c== :: Encrypt -> Encrypt -> Bool
Prelude.Eq, Int -> Encrypt -> ShowS
[Encrypt] -> ShowS
Encrypt -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Encrypt] -> ShowS
$cshowList :: [Encrypt] -> ShowS
show :: Encrypt -> String
$cshow :: Encrypt -> String
showsPrec :: Int -> Encrypt -> ShowS
$cshowsPrec :: Int -> Encrypt -> ShowS
Prelude.Show, forall x. Rep Encrypt x -> Encrypt
forall x. Encrypt -> Rep Encrypt x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Encrypt x -> Encrypt
$cfrom :: forall x. Encrypt -> Rep Encrypt x
Prelude.Generic)

-- |
-- Create a value of 'Encrypt' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'encryptionAlgorithm', '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
-- encryption KMS keys. If you are using an asymmetric KMS key, we
-- recommend RSAES_OAEP_SHA_256.
--
-- The SM2PKE algorithm is only available in China Regions.
--
-- 'encryptionContext', 'encrypt_encryptionContext' - Specifies the encryption context that will be used to encrypt the data.
-- An encryption context is valid only for
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations cryptographic operations>
-- with a symmetric encryption KMS key. The standard asymmetric encryption
-- algorithms and HMAC algorithms that KMS uses do not support an
-- encryption context.
--
-- An /encryption context/ is a collection of non-secret key-value pairs
-- that represent additional authenticated data. When you use an encryption
-- context to encrypt data, you must specify the same (an exact
-- case-sensitive match) encryption context to decrypt the data. An
-- encryption context is supported only on operations with symmetric
-- encryption KMS keys. On operations with symmetric encryption KMS keys,
-- an encryption context is optional, but it is strongly recommended.
--
-- For more information, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption context>
-- in the /Key Management Service Developer Guide/.
--
-- 'grantTokens', '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
-- <https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token Grant token>
-- and
-- <https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token Using a grant token>
-- in the /Key Management Service Developer Guide/.
--
-- 'keyId', 'encrypt_keyId' - Identifies the KMS key to use in the encryption operation. The KMS key
-- must have a @KeyUsage@ of @ENCRYPT_DECRYPT@. To find the @KeyUsage@ of a
-- KMS key, use the DescribeKey operation.
--
-- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
-- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
-- key in a different Amazon Web Services account, you must use the key ARN
-- or alias ARN.
--
-- For example:
--
-- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Key ARN:
--     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Alias name: @alias\/ExampleAlias@
--
-- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
--
-- To get the key ID and key ARN for a KMS key, use ListKeys or
-- DescribeKey. To get the alias name and alias ARN, use ListAliases.
--
-- 'plaintext', '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.
newEncrypt ::
  -- | 'keyId'
  Prelude.Text ->
  -- | 'plaintext'
  Prelude.ByteString ->
  Encrypt
newEncrypt :: Text -> ByteString -> Encrypt
newEncrypt Text
pKeyId_ ByteString
pPlaintext_ =
  Encrypt'
    { $sel:encryptionAlgorithm:Encrypt' :: Maybe EncryptionAlgorithmSpec
encryptionAlgorithm = forall a. Maybe a
Prelude.Nothing,
      $sel:encryptionContext:Encrypt' :: Maybe (HashMap Text Text)
encryptionContext = forall a. Maybe a
Prelude.Nothing,
      $sel:grantTokens:Encrypt' :: Maybe [Text]
grantTokens = forall a. Maybe a
Prelude.Nothing,
      $sel:keyId:Encrypt' :: Text
keyId = Text
pKeyId_,
      $sel:plaintext:Encrypt' :: Sensitive Base64
plaintext =
        forall a. Iso' (Sensitive a) a
Data._Sensitive
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. Iso' Base64 ByteString
Data._Base64
          forall t b. AReview t b -> b -> t
Lens.# ByteString
pPlaintext_
    }

-- | Specifies the encryption algorithm that KMS will use to encrypt the
-- plaintext message. The algorithm must be compatible with the KMS key
-- that you specify.
--
-- This parameter is required only for asymmetric KMS keys. The default
-- value, @SYMMETRIC_DEFAULT@, is the algorithm used for symmetric
-- encryption KMS keys. If you are using an asymmetric KMS key, we
-- recommend RSAES_OAEP_SHA_256.
--
-- The SM2PKE algorithm is only available in China Regions.
encrypt_encryptionAlgorithm :: Lens.Lens' Encrypt (Prelude.Maybe EncryptionAlgorithmSpec)
encrypt_encryptionAlgorithm :: Lens' Encrypt (Maybe EncryptionAlgorithmSpec)
encrypt_encryptionAlgorithm = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Encrypt' {Maybe EncryptionAlgorithmSpec
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
$sel:encryptionAlgorithm:Encrypt' :: Encrypt -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm} -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm) (\s :: Encrypt
s@Encrypt' {} Maybe EncryptionAlgorithmSpec
a -> Encrypt
s {$sel:encryptionAlgorithm:Encrypt' :: Maybe EncryptionAlgorithmSpec
encryptionAlgorithm = Maybe EncryptionAlgorithmSpec
a} :: Encrypt)

-- | Specifies the encryption context that will be used to encrypt the data.
-- An encryption context is valid only for
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations cryptographic operations>
-- with a symmetric encryption KMS key. The standard asymmetric encryption
-- algorithms and HMAC algorithms that KMS uses do not support an
-- encryption context.
--
-- An /encryption context/ is a collection of non-secret key-value pairs
-- that represent additional authenticated data. When you use an encryption
-- context to encrypt data, you must specify the same (an exact
-- case-sensitive match) encryption context to decrypt the data. An
-- encryption context is supported only on operations with symmetric
-- encryption KMS keys. On operations with symmetric encryption KMS keys,
-- an encryption context is optional, but it is strongly recommended.
--
-- For more information, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption context>
-- in the /Key Management Service Developer Guide/.
encrypt_encryptionContext :: Lens.Lens' Encrypt (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
encrypt_encryptionContext :: Lens' Encrypt (Maybe (HashMap Text Text))
encrypt_encryptionContext = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Encrypt' {Maybe (HashMap Text Text)
encryptionContext :: Maybe (HashMap Text Text)
$sel:encryptionContext:Encrypt' :: Encrypt -> Maybe (HashMap Text Text)
encryptionContext} -> Maybe (HashMap Text Text)
encryptionContext) (\s :: Encrypt
s@Encrypt' {} Maybe (HashMap Text Text)
a -> Encrypt
s {$sel:encryptionContext:Encrypt' :: Maybe (HashMap Text Text)
encryptionContext = Maybe (HashMap Text Text)
a} :: Encrypt) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | 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
-- <https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token Grant token>
-- and
-- <https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token Using a grant token>
-- in the /Key Management Service Developer Guide/.
encrypt_grantTokens :: Lens.Lens' Encrypt (Prelude.Maybe [Prelude.Text])
encrypt_grantTokens :: Lens' Encrypt (Maybe [Text])
encrypt_grantTokens = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Encrypt' {Maybe [Text]
grantTokens :: Maybe [Text]
$sel:grantTokens:Encrypt' :: Encrypt -> Maybe [Text]
grantTokens} -> Maybe [Text]
grantTokens) (\s :: Encrypt
s@Encrypt' {} Maybe [Text]
a -> Encrypt
s {$sel:grantTokens:Encrypt' :: Maybe [Text]
grantTokens = Maybe [Text]
a} :: Encrypt) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Identifies the KMS key to use in the encryption operation. The KMS key
-- must have a @KeyUsage@ of @ENCRYPT_DECRYPT@. To find the @KeyUsage@ of a
-- KMS key, use the DescribeKey operation.
--
-- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
-- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
-- key in a different Amazon Web Services account, you must use the key ARN
-- or alias ARN.
--
-- For example:
--
-- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Key ARN:
--     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Alias name: @alias\/ExampleAlias@
--
-- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
--
-- To get the key ID and key ARN for a KMS key, use ListKeys or
-- DescribeKey. To get the alias name and alias ARN, use ListAliases.
encrypt_keyId :: Lens.Lens' Encrypt Prelude.Text
encrypt_keyId :: Lens' Encrypt Text
encrypt_keyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Encrypt' {Text
keyId :: Text
$sel:keyId:Encrypt' :: Encrypt -> Text
keyId} -> Text
keyId) (\s :: Encrypt
s@Encrypt' {} Text
a -> Encrypt
s {$sel:keyId:Encrypt' :: Text
keyId = Text
a} :: Encrypt)

-- | 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.
encrypt_plaintext :: Lens.Lens' Encrypt Prelude.ByteString
encrypt_plaintext :: Lens' Encrypt ByteString
encrypt_plaintext = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Encrypt' {Sensitive Base64
plaintext :: Sensitive Base64
$sel:plaintext:Encrypt' :: Encrypt -> Sensitive Base64
plaintext} -> Sensitive Base64
plaintext) (\s :: Encrypt
s@Encrypt' {} Sensitive Base64
a -> Encrypt
s {$sel:plaintext:Encrypt' :: Sensitive Base64
plaintext = Sensitive Base64
a} :: Encrypt) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. Iso' Base64 ByteString
Data._Base64

instance Core.AWSRequest Encrypt where
  type AWSResponse Encrypt = EncryptResponse
  request :: (Service -> Service) -> Encrypt -> Request Encrypt
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy Encrypt
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse Encrypt)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Base64
-> Maybe EncryptionAlgorithmSpec
-> Maybe Text
-> Int
-> EncryptResponse
EncryptResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"CiphertextBlob")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"EncryptionAlgorithm")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"KeyId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable Encrypt where
  hashWithSalt :: Int -> Encrypt -> Int
hashWithSalt Int
_salt Encrypt' {Maybe [Text]
Maybe (HashMap Text Text)
Maybe EncryptionAlgorithmSpec
Text
Sensitive Base64
plaintext :: Sensitive Base64
keyId :: Text
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
$sel:plaintext:Encrypt' :: Encrypt -> Sensitive Base64
$sel:keyId:Encrypt' :: Encrypt -> Text
$sel:grantTokens:Encrypt' :: Encrypt -> Maybe [Text]
$sel:encryptionContext:Encrypt' :: Encrypt -> Maybe (HashMap Text Text)
$sel:encryptionAlgorithm:Encrypt' :: Encrypt -> Maybe EncryptionAlgorithmSpec
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EncryptionAlgorithmSpec
encryptionAlgorithm
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
encryptionContext
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
grantTokens
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
keyId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Base64
plaintext

instance Prelude.NFData Encrypt where
  rnf :: Encrypt -> ()
rnf Encrypt' {Maybe [Text]
Maybe (HashMap Text Text)
Maybe EncryptionAlgorithmSpec
Text
Sensitive Base64
plaintext :: Sensitive Base64
keyId :: Text
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
$sel:plaintext:Encrypt' :: Encrypt -> Sensitive Base64
$sel:keyId:Encrypt' :: Encrypt -> Text
$sel:grantTokens:Encrypt' :: Encrypt -> Maybe [Text]
$sel:encryptionContext:Encrypt' :: Encrypt -> Maybe (HashMap Text Text)
$sel:encryptionAlgorithm:Encrypt' :: Encrypt -> Maybe EncryptionAlgorithmSpec
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EncryptionAlgorithmSpec
encryptionAlgorithm
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
encryptionContext
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
grantTokens
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
keyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Base64
plaintext

instance Data.ToHeaders Encrypt where
  toHeaders :: Encrypt -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"TrentService.Encrypt" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON Encrypt where
  toJSON :: Encrypt -> Value
toJSON Encrypt' {Maybe [Text]
Maybe (HashMap Text Text)
Maybe EncryptionAlgorithmSpec
Text
Sensitive Base64
plaintext :: Sensitive Base64
keyId :: Text
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
$sel:plaintext:Encrypt' :: Encrypt -> Sensitive Base64
$sel:keyId:Encrypt' :: Encrypt -> Text
$sel:grantTokens:Encrypt' :: Encrypt -> Maybe [Text]
$sel:encryptionContext:Encrypt' :: Encrypt -> Maybe (HashMap Text Text)
$sel:encryptionAlgorithm:Encrypt' :: Encrypt -> Maybe EncryptionAlgorithmSpec
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"EncryptionAlgorithm" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm,
            (Key
"EncryptionContext" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Text)
encryptionContext,
            (Key
"GrantTokens" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
grantTokens,
            forall a. a -> Maybe a
Prelude.Just (Key
"KeyId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
keyId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Plaintext" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Base64
plaintext)
          ]
      )

instance Data.ToPath Encrypt where
  toPath :: Encrypt -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery Encrypt where
  toQuery :: Encrypt -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newEncryptResponse' smart constructor.
data EncryptResponse = EncryptResponse'
  { -- | 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.
    EncryptResponse -> Maybe Base64
ciphertextBlob :: Prelude.Maybe Data.Base64,
    -- | The encryption algorithm that was used to encrypt the plaintext.
    EncryptResponse -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm :: Prelude.Maybe EncryptionAlgorithmSpec,
    -- | The Amazon Resource Name
    -- (<https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN key ARN>)
    -- of the KMS key that was used to encrypt the plaintext.
    EncryptResponse -> Maybe Text
keyId :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    EncryptResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (EncryptResponse -> EncryptResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EncryptResponse -> EncryptResponse -> Bool
$c/= :: EncryptResponse -> EncryptResponse -> Bool
== :: EncryptResponse -> EncryptResponse -> Bool
$c== :: EncryptResponse -> EncryptResponse -> Bool
Prelude.Eq, ReadPrec [EncryptResponse]
ReadPrec EncryptResponse
Int -> ReadS EncryptResponse
ReadS [EncryptResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EncryptResponse]
$creadListPrec :: ReadPrec [EncryptResponse]
readPrec :: ReadPrec EncryptResponse
$creadPrec :: ReadPrec EncryptResponse
readList :: ReadS [EncryptResponse]
$creadList :: ReadS [EncryptResponse]
readsPrec :: Int -> ReadS EncryptResponse
$creadsPrec :: Int -> ReadS EncryptResponse
Prelude.Read, Int -> EncryptResponse -> ShowS
[EncryptResponse] -> ShowS
EncryptResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EncryptResponse] -> ShowS
$cshowList :: [EncryptResponse] -> ShowS
show :: EncryptResponse -> String
$cshow :: EncryptResponse -> String
showsPrec :: Int -> EncryptResponse -> ShowS
$cshowsPrec :: Int -> EncryptResponse -> ShowS
Prelude.Show, forall x. Rep EncryptResponse x -> EncryptResponse
forall x. EncryptResponse -> Rep EncryptResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EncryptResponse x -> EncryptResponse
$cfrom :: forall x. EncryptResponse -> Rep EncryptResponse x
Prelude.Generic)

-- |
-- Create a value of 'EncryptResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'ciphertextBlob', '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.
--
-- 'encryptionAlgorithm', 'encryptResponse_encryptionAlgorithm' - The encryption algorithm that was used to encrypt the plaintext.
--
-- 'keyId', 'encryptResponse_keyId' - The Amazon Resource Name
-- (<https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN key ARN>)
-- of the KMS key that was used to encrypt the plaintext.
--
-- 'httpStatus', 'encryptResponse_httpStatus' - The response's http status code.
newEncryptResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  EncryptResponse
newEncryptResponse :: Int -> EncryptResponse
newEncryptResponse Int
pHttpStatus_ =
  EncryptResponse'
    { $sel:ciphertextBlob:EncryptResponse' :: Maybe Base64
ciphertextBlob = forall a. Maybe a
Prelude.Nothing,
      $sel:encryptionAlgorithm:EncryptResponse' :: Maybe EncryptionAlgorithmSpec
encryptionAlgorithm = forall a. Maybe a
Prelude.Nothing,
      $sel:keyId:EncryptResponse' :: Maybe Text
keyId = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:EncryptResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The encrypted plaintext. When you use the HTTP API or the Amazon Web
-- Services CLI, the value is Base64-encoded. Otherwise, it is not
-- Base64-encoded.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
encryptResponse_ciphertextBlob :: Lens.Lens' EncryptResponse (Prelude.Maybe Prelude.ByteString)
encryptResponse_ciphertextBlob :: Lens' EncryptResponse (Maybe ByteString)
encryptResponse_ciphertextBlob = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptResponse' {Maybe Base64
ciphertextBlob :: Maybe Base64
$sel:ciphertextBlob:EncryptResponse' :: EncryptResponse -> Maybe Base64
ciphertextBlob} -> Maybe Base64
ciphertextBlob) (\s :: EncryptResponse
s@EncryptResponse' {} Maybe Base64
a -> EncryptResponse
s {$sel:ciphertextBlob:EncryptResponse' :: Maybe Base64
ciphertextBlob = Maybe Base64
a} :: EncryptResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping Iso' Base64 ByteString
Data._Base64

-- | The encryption algorithm that was used to encrypt the plaintext.
encryptResponse_encryptionAlgorithm :: Lens.Lens' EncryptResponse (Prelude.Maybe EncryptionAlgorithmSpec)
encryptResponse_encryptionAlgorithm :: Lens' EncryptResponse (Maybe EncryptionAlgorithmSpec)
encryptResponse_encryptionAlgorithm = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptResponse' {Maybe EncryptionAlgorithmSpec
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
$sel:encryptionAlgorithm:EncryptResponse' :: EncryptResponse -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm} -> Maybe EncryptionAlgorithmSpec
encryptionAlgorithm) (\s :: EncryptResponse
s@EncryptResponse' {} Maybe EncryptionAlgorithmSpec
a -> EncryptResponse
s {$sel:encryptionAlgorithm:EncryptResponse' :: Maybe EncryptionAlgorithmSpec
encryptionAlgorithm = Maybe EncryptionAlgorithmSpec
a} :: EncryptResponse)

-- | The Amazon Resource Name
-- (<https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN key ARN>)
-- of the KMS key that was used to encrypt the plaintext.
encryptResponse_keyId :: Lens.Lens' EncryptResponse (Prelude.Maybe Prelude.Text)
encryptResponse_keyId :: Lens' EncryptResponse (Maybe Text)
encryptResponse_keyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptResponse' {Maybe Text
keyId :: Maybe Text
$sel:keyId:EncryptResponse' :: EncryptResponse -> Maybe Text
keyId} -> Maybe Text
keyId) (\s :: EncryptResponse
s@EncryptResponse' {} Maybe Text
a -> EncryptResponse
s {$sel:keyId:EncryptResponse' :: Maybe Text
keyId = Maybe Text
a} :: EncryptResponse)

-- | The response's http status code.
encryptResponse_httpStatus :: Lens.Lens' EncryptResponse Prelude.Int
encryptResponse_httpStatus :: Lens' EncryptResponse Int
encryptResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EncryptResponse' {Int
httpStatus :: Int
$sel:httpStatus:EncryptResponse' :: EncryptResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: EncryptResponse
s@EncryptResponse' {} Int
a -> EncryptResponse
s {$sel:httpStatus:EncryptResponse' :: Int
httpStatus = Int
a} :: EncryptResponse)

instance Prelude.NFData EncryptResponse where
  rnf :: EncryptResponse -> ()
rnf EncryptResponse' {Int
Maybe Text
Maybe Base64
Maybe EncryptionAlgorithmSpec
httpStatus :: Int
keyId :: Maybe Text
encryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
ciphertextBlob :: Maybe Base64
$sel:httpStatus:EncryptResponse' :: EncryptResponse -> Int
$sel:keyId:EncryptResponse' :: EncryptResponse -> Maybe Text
$sel:encryptionAlgorithm:EncryptResponse' :: EncryptResponse -> Maybe EncryptionAlgorithmSpec
$sel:ciphertextBlob:EncryptResponse' :: EncryptResponse -> Maybe Base64
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Base64
ciphertextBlob
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe EncryptionAlgorithmSpec
encryptionAlgorithm
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
keyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus