{-# 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.GenerateDataKeyWithoutPlaintext
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a unique symmetric data key for use outside of KMS. This
-- operation returns a data key that is encrypted under a symmetric
-- encryption KMS key that you specify. The bytes in the key are random;
-- they are not related to the caller or to the KMS key.
--
-- @GenerateDataKeyWithoutPlaintext@ is identical to the GenerateDataKey
-- operation except that it does not return a plaintext copy of the data
-- key.
--
-- This operation is useful for systems that need to encrypt data at some
-- point, but not immediately. When you need to encrypt the data, you call
-- the Decrypt operation on the encrypted copy of the key.
--
-- It\'s also useful in distributed systems with different levels of trust.
-- For example, you might store encrypted data in containers. One component
-- of your system creates new containers and stores an encrypted data key
-- with each container. Then, a different component puts the data into the
-- containers. That component first decrypts the data key, uses the
-- plaintext data key to encrypt data, puts the encrypted data into the
-- container, and then destroys the plaintext data key. In this system, the
-- component that creates the containers never sees the plaintext data key.
--
-- To request an asymmetric data key pair, use the GenerateDataKeyPair or
-- GenerateDataKeyPairWithoutPlaintext operations.
--
-- To generate a data key, you must specify the symmetric encryption KMS
-- key that is used to encrypt the data key. You cannot use an asymmetric
-- KMS key or a key in a custom key store to generate a data key. To get
-- the type of your KMS key, use the DescribeKey operation.
--
-- You must also specify the length of the data key. Use either the
-- @KeySpec@ or @NumberOfBytes@ parameters (but not both). For 128-bit and
-- 256-bit data keys, use the @KeySpec@ parameter.
--
-- To generate an SM4 data key (China Regions only), specify a @KeySpec@
-- value of @AES_128@ or @NumberOfBytes@ value of @128@. The symmetric
-- encryption key used in China Regions to encrypt your data key is an SM4
-- encryption key.
--
-- If the operation succeeds, you will find the encrypted copy of the data
-- key in the @CiphertextBlob@ field.
--
-- You can use an optional encryption context to add additional security to
-- the encryption operation. If you specify an @EncryptionContext@, you
-- must specify the same encryption context (a case-sensitive exact match)
-- when decrypting the encrypted data key. 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/.
--
-- 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:GenerateDataKeyWithoutPlaintext>
-- (key policy)
--
-- __Related operations:__
--
-- -   Decrypt
--
-- -   Encrypt
--
-- -   GenerateDataKey
--
-- -   GenerateDataKeyPair
--
-- -   GenerateDataKeyPairWithoutPlaintext
module Amazonka.KMS.GenerateDataKeyWithoutPlaintext
  ( -- * Creating a Request
    GenerateDataKeyWithoutPlaintext (..),
    newGenerateDataKeyWithoutPlaintext,

    -- * Request Lenses
    generateDataKeyWithoutPlaintext_encryptionContext,
    generateDataKeyWithoutPlaintext_grantTokens,
    generateDataKeyWithoutPlaintext_keySpec,
    generateDataKeyWithoutPlaintext_numberOfBytes,
    generateDataKeyWithoutPlaintext_keyId,

    -- * Destructuring the Response
    GenerateDataKeyWithoutPlaintextResponse (..),
    newGenerateDataKeyWithoutPlaintextResponse,

    -- * Response Lenses
    generateDataKeyWithoutPlaintextResponse_ciphertextBlob,
    generateDataKeyWithoutPlaintextResponse_keyId,
    generateDataKeyWithoutPlaintextResponse_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:/ 'newGenerateDataKeyWithoutPlaintext' smart constructor.
data GenerateDataKeyWithoutPlaintext = GenerateDataKeyWithoutPlaintext'
  { -- | Specifies the encryption context that will be used when encrypting the
    -- data key.
    --
    -- An /encryption context/ is a collection of non-secret key-value pairs
    -- that represent additional authenticated data. When you use an encryption
    -- context to encrypt data, you must specify the same (an exact
    -- case-sensitive match) encryption context to decrypt the data. An
    -- encryption context is supported only on operations with symmetric
    -- encryption KMS keys. On operations with symmetric encryption KMS keys,
    -- an encryption context is optional, but it is strongly recommended.
    --
    -- For more information, see
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption context>
    -- in the /Key Management Service Developer Guide/.
    GenerateDataKeyWithoutPlaintext -> 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/.
    GenerateDataKeyWithoutPlaintext -> Maybe [Text]
grantTokens :: Prelude.Maybe [Prelude.Text],
    -- | The length of the data key. Use @AES_128@ to generate a 128-bit
    -- symmetric key, or @AES_256@ to generate a 256-bit symmetric key.
    GenerateDataKeyWithoutPlaintext -> Maybe DataKeySpec
keySpec :: Prelude.Maybe DataKeySpec,
    -- | The length of the data key in bytes. For example, use the value 64 to
    -- generate a 512-bit data key (64 bytes is 512 bits). For common key
    -- lengths (128-bit and 256-bit symmetric keys), we recommend that you use
    -- the @KeySpec@ field instead of this one.
    GenerateDataKeyWithoutPlaintext -> Maybe Natural
numberOfBytes :: Prelude.Maybe Prelude.Natural,
    -- | Specifies the symmetric encryption KMS key that encrypts the data key.
    -- You cannot specify an asymmetric KMS key or a KMS key in a custom key
    -- store. To get the type and origin of your KMS key, use the DescribeKey
    -- operation.
    --
    -- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
    -- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
    -- key in a different Amazon Web Services account, you must use the key ARN
    -- or alias ARN.
    --
    -- For example:
    --
    -- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
    --
    -- -   Key ARN:
    --     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
    --
    -- -   Alias name: @alias\/ExampleAlias@
    --
    -- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
    --
    -- To get the key ID and key ARN for a KMS key, use ListKeys or
    -- DescribeKey. To get the alias name and alias ARN, use ListAliases.
    GenerateDataKeyWithoutPlaintext -> Text
keyId :: Prelude.Text
  }
  deriving (GenerateDataKeyWithoutPlaintext
-> GenerateDataKeyWithoutPlaintext -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GenerateDataKeyWithoutPlaintext
-> GenerateDataKeyWithoutPlaintext -> Bool
$c/= :: GenerateDataKeyWithoutPlaintext
-> GenerateDataKeyWithoutPlaintext -> Bool
== :: GenerateDataKeyWithoutPlaintext
-> GenerateDataKeyWithoutPlaintext -> Bool
$c== :: GenerateDataKeyWithoutPlaintext
-> GenerateDataKeyWithoutPlaintext -> Bool
Prelude.Eq, ReadPrec [GenerateDataKeyWithoutPlaintext]
ReadPrec GenerateDataKeyWithoutPlaintext
Int -> ReadS GenerateDataKeyWithoutPlaintext
ReadS [GenerateDataKeyWithoutPlaintext]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintext]
$creadListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintext]
readPrec :: ReadPrec GenerateDataKeyWithoutPlaintext
$creadPrec :: ReadPrec GenerateDataKeyWithoutPlaintext
readList :: ReadS [GenerateDataKeyWithoutPlaintext]
$creadList :: ReadS [GenerateDataKeyWithoutPlaintext]
readsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintext
$creadsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintext
Prelude.Read, Int -> GenerateDataKeyWithoutPlaintext -> ShowS
[GenerateDataKeyWithoutPlaintext] -> ShowS
GenerateDataKeyWithoutPlaintext -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GenerateDataKeyWithoutPlaintext] -> ShowS
$cshowList :: [GenerateDataKeyWithoutPlaintext] -> ShowS
show :: GenerateDataKeyWithoutPlaintext -> String
$cshow :: GenerateDataKeyWithoutPlaintext -> String
showsPrec :: Int -> GenerateDataKeyWithoutPlaintext -> ShowS
$cshowsPrec :: Int -> GenerateDataKeyWithoutPlaintext -> ShowS
Prelude.Show, forall x.
Rep GenerateDataKeyWithoutPlaintext x
-> GenerateDataKeyWithoutPlaintext
forall x.
GenerateDataKeyWithoutPlaintext
-> Rep GenerateDataKeyWithoutPlaintext x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GenerateDataKeyWithoutPlaintext x
-> GenerateDataKeyWithoutPlaintext
$cfrom :: forall x.
GenerateDataKeyWithoutPlaintext
-> Rep GenerateDataKeyWithoutPlaintext x
Prelude.Generic)

-- |
-- Create a value of 'GenerateDataKeyWithoutPlaintext' 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:
--
-- 'encryptionContext', '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 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', '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
-- <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/.
--
-- 'keySpec', '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.
--
-- 'numberOfBytes', '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.
--
-- 'keyId', 'generateDataKeyWithoutPlaintext_keyId' - Specifies the symmetric encryption KMS key that encrypts the data key.
-- You cannot specify an asymmetric KMS key or a KMS key in a custom key
-- store. To get the type and origin of your KMS key, use the DescribeKey
-- operation.
--
-- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
-- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
-- key in a different Amazon Web Services account, you must use the key ARN
-- or alias ARN.
--
-- For example:
--
-- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Key ARN:
--     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Alias name: @alias\/ExampleAlias@
--
-- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
--
-- To get the key ID and key ARN for a KMS key, use ListKeys or
-- DescribeKey. To get the alias name and alias ARN, use ListAliases.
newGenerateDataKeyWithoutPlaintext ::
  -- | 'keyId'
  Prelude.Text ->
  GenerateDataKeyWithoutPlaintext
newGenerateDataKeyWithoutPlaintext :: Text -> GenerateDataKeyWithoutPlaintext
newGenerateDataKeyWithoutPlaintext Text
pKeyId_ =
  GenerateDataKeyWithoutPlaintext'
    { $sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: Maybe (HashMap Text Text)
encryptionContext =
        forall a. Maybe a
Prelude.Nothing,
      $sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: Maybe [Text]
grantTokens = forall a. Maybe a
Prelude.Nothing,
      $sel:keySpec:GenerateDataKeyWithoutPlaintext' :: Maybe DataKeySpec
keySpec = forall a. Maybe a
Prelude.Nothing,
      $sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: Maybe Natural
numberOfBytes = forall a. Maybe a
Prelude.Nothing,
      $sel:keyId:GenerateDataKeyWithoutPlaintext' :: Text
keyId = Text
pKeyId_
    }

-- | Specifies the encryption context that will be used when encrypting the
-- data key.
--
-- An /encryption context/ is a collection of non-secret key-value pairs
-- that represent additional authenticated data. When you use an encryption
-- context to encrypt data, you must specify the same (an exact
-- case-sensitive match) encryption context to decrypt the data. An
-- encryption context is supported only on operations with symmetric
-- encryption KMS keys. On operations with symmetric encryption KMS keys,
-- an encryption context is optional, but it is strongly recommended.
--
-- For more information, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context Encryption context>
-- in the /Key Management Service Developer Guide/.
generateDataKeyWithoutPlaintext_encryptionContext :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
generateDataKeyWithoutPlaintext_encryptionContext :: Lens' GenerateDataKeyWithoutPlaintext (Maybe (HashMap Text Text))
generateDataKeyWithoutPlaintext_encryptionContext = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintext' {Maybe (HashMap Text Text)
encryptionContext :: Maybe (HashMap Text Text)
$sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe (HashMap Text Text)
encryptionContext} -> Maybe (HashMap Text Text)
encryptionContext) (\s :: GenerateDataKeyWithoutPlaintext
s@GenerateDataKeyWithoutPlaintext' {} Maybe (HashMap Text Text)
a -> GenerateDataKeyWithoutPlaintext
s {$sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: Maybe (HashMap Text Text)
encryptionContext = Maybe (HashMap Text Text)
a} :: GenerateDataKeyWithoutPlaintext) 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/.
generateDataKeyWithoutPlaintext_grantTokens :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe [Prelude.Text])
generateDataKeyWithoutPlaintext_grantTokens :: Lens' GenerateDataKeyWithoutPlaintext (Maybe [Text])
generateDataKeyWithoutPlaintext_grantTokens = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintext' {Maybe [Text]
grantTokens :: Maybe [Text]
$sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe [Text]
grantTokens} -> Maybe [Text]
grantTokens) (\s :: GenerateDataKeyWithoutPlaintext
s@GenerateDataKeyWithoutPlaintext' {} Maybe [Text]
a -> GenerateDataKeyWithoutPlaintext
s {$sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: Maybe [Text]
grantTokens = Maybe [Text]
a} :: GenerateDataKeyWithoutPlaintext) 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

-- | The length of the data key. Use @AES_128@ to generate a 128-bit
-- symmetric key, or @AES_256@ to generate a 256-bit symmetric key.
generateDataKeyWithoutPlaintext_keySpec :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe DataKeySpec)
generateDataKeyWithoutPlaintext_keySpec :: Lens' GenerateDataKeyWithoutPlaintext (Maybe DataKeySpec)
generateDataKeyWithoutPlaintext_keySpec = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintext' {Maybe DataKeySpec
keySpec :: Maybe DataKeySpec
$sel:keySpec:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe DataKeySpec
keySpec} -> Maybe DataKeySpec
keySpec) (\s :: GenerateDataKeyWithoutPlaintext
s@GenerateDataKeyWithoutPlaintext' {} Maybe DataKeySpec
a -> GenerateDataKeyWithoutPlaintext
s {$sel:keySpec:GenerateDataKeyWithoutPlaintext' :: Maybe DataKeySpec
keySpec = Maybe DataKeySpec
a} :: GenerateDataKeyWithoutPlaintext)

-- | The length of the data key in bytes. For example, use the value 64 to
-- generate a 512-bit data key (64 bytes is 512 bits). For common key
-- lengths (128-bit and 256-bit symmetric keys), we recommend that you use
-- the @KeySpec@ field instead of this one.
generateDataKeyWithoutPlaintext_numberOfBytes :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe Prelude.Natural)
generateDataKeyWithoutPlaintext_numberOfBytes :: Lens' GenerateDataKeyWithoutPlaintext (Maybe Natural)
generateDataKeyWithoutPlaintext_numberOfBytes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintext' {Maybe Natural
numberOfBytes :: Maybe Natural
$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe Natural
numberOfBytes} -> Maybe Natural
numberOfBytes) (\s :: GenerateDataKeyWithoutPlaintext
s@GenerateDataKeyWithoutPlaintext' {} Maybe Natural
a -> GenerateDataKeyWithoutPlaintext
s {$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: Maybe Natural
numberOfBytes = Maybe Natural
a} :: GenerateDataKeyWithoutPlaintext)

-- | Specifies the symmetric encryption KMS key that encrypts the data key.
-- You cannot specify an asymmetric KMS key or a KMS key in a custom key
-- store. To get the type and origin of your KMS key, use the DescribeKey
-- operation.
--
-- To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN.
-- When using an alias name, prefix it with @\"alias\/\"@. To specify a KMS
-- key in a different Amazon Web Services account, you must use the key ARN
-- or alias ARN.
--
-- For example:
--
-- -   Key ID: @1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Key ARN:
--     @arn:aws:kms:us-east-2:111122223333:key\/1234abcd-12ab-34cd-56ef-1234567890ab@
--
-- -   Alias name: @alias\/ExampleAlias@
--
-- -   Alias ARN: @arn:aws:kms:us-east-2:111122223333:alias\/ExampleAlias@
--
-- To get the key ID and key ARN for a KMS key, use ListKeys or
-- DescribeKey. To get the alias name and alias ARN, use ListAliases.
generateDataKeyWithoutPlaintext_keyId :: Lens.Lens' GenerateDataKeyWithoutPlaintext Prelude.Text
generateDataKeyWithoutPlaintext_keyId :: Lens' GenerateDataKeyWithoutPlaintext Text
generateDataKeyWithoutPlaintext_keyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintext' {Text
keyId :: Text
$sel:keyId:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Text
keyId} -> Text
keyId) (\s :: GenerateDataKeyWithoutPlaintext
s@GenerateDataKeyWithoutPlaintext' {} Text
a -> GenerateDataKeyWithoutPlaintext
s {$sel:keyId:GenerateDataKeyWithoutPlaintext' :: Text
keyId = Text
a} :: GenerateDataKeyWithoutPlaintext)

instance
  Core.AWSRequest
    GenerateDataKeyWithoutPlaintext
  where
  type
    AWSResponse GenerateDataKeyWithoutPlaintext =
      GenerateDataKeyWithoutPlaintextResponse
  request :: (Service -> Service)
-> GenerateDataKeyWithoutPlaintext
-> Request GenerateDataKeyWithoutPlaintext
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 GenerateDataKeyWithoutPlaintext
-> ClientResponse ClientBody
-> m (Either
        Error
        (ClientResponse (AWSResponse GenerateDataKeyWithoutPlaintext)))
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 Text -> Int -> GenerateDataKeyWithoutPlaintextResponse
GenerateDataKeyWithoutPlaintextResponse'
            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
"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
    GenerateDataKeyWithoutPlaintext
  where
  hashWithSalt :: Int -> GenerateDataKeyWithoutPlaintext -> Int
hashWithSalt
    Int
_salt
    GenerateDataKeyWithoutPlaintext' {Maybe Natural
Maybe [Text]
Maybe (HashMap Text Text)
Maybe DataKeySpec
Text
keyId :: Text
numberOfBytes :: Maybe Natural
keySpec :: Maybe DataKeySpec
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
$sel:keyId:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Text
$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe Natural
$sel:keySpec:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe DataKeySpec
$sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe [Text]
$sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe (HashMap Text Text)
..} =
      Int
_salt
        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` Maybe DataKeySpec
keySpec
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
numberOfBytes
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
keyId

instance
  Prelude.NFData
    GenerateDataKeyWithoutPlaintext
  where
  rnf :: GenerateDataKeyWithoutPlaintext -> ()
rnf GenerateDataKeyWithoutPlaintext' {Maybe Natural
Maybe [Text]
Maybe (HashMap Text Text)
Maybe DataKeySpec
Text
keyId :: Text
numberOfBytes :: Maybe Natural
keySpec :: Maybe DataKeySpec
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
$sel:keyId:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Text
$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe Natural
$sel:keySpec:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe DataKeySpec
$sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe [Text]
$sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe (HashMap Text Text)
..} =
    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 Maybe DataKeySpec
keySpec
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
numberOfBytes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
keyId

instance
  Data.ToHeaders
    GenerateDataKeyWithoutPlaintext
  where
  toHeaders :: GenerateDataKeyWithoutPlaintext -> 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.GenerateDataKeyWithoutPlaintext" ::
                          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 GenerateDataKeyWithoutPlaintext where
  toJSON :: GenerateDataKeyWithoutPlaintext -> Value
toJSON GenerateDataKeyWithoutPlaintext' {Maybe Natural
Maybe [Text]
Maybe (HashMap Text Text)
Maybe DataKeySpec
Text
keyId :: Text
numberOfBytes :: Maybe Natural
keySpec :: Maybe DataKeySpec
grantTokens :: Maybe [Text]
encryptionContext :: Maybe (HashMap Text Text)
$sel:keyId:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Text
$sel:numberOfBytes:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe Natural
$sel:keySpec:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe DataKeySpec
$sel:grantTokens:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe [Text]
$sel:encryptionContext:GenerateDataKeyWithoutPlaintext' :: GenerateDataKeyWithoutPlaintext -> Maybe (HashMap Text Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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,
            (Key
"KeySpec" 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 DataKeySpec
keySpec,
            (Key
"NumberOfBytes" 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 Natural
numberOfBytes,
            forall a. a -> Maybe a
Prelude.Just (Key
"KeyId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
keyId)
          ]
      )

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

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

-- | /See:/ 'newGenerateDataKeyWithoutPlaintextResponse' smart constructor.
data GenerateDataKeyWithoutPlaintextResponse = GenerateDataKeyWithoutPlaintextResponse'
  { -- | 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.
    GenerateDataKeyWithoutPlaintextResponse -> Maybe Base64
ciphertextBlob :: Prelude.Maybe Data.Base64,
    -- | 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 encrypted the data key.
    GenerateDataKeyWithoutPlaintextResponse -> Maybe Text
keyId :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GenerateDataKeyWithoutPlaintextResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GenerateDataKeyWithoutPlaintextResponse
-> GenerateDataKeyWithoutPlaintextResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GenerateDataKeyWithoutPlaintextResponse
-> GenerateDataKeyWithoutPlaintextResponse -> Bool
$c/= :: GenerateDataKeyWithoutPlaintextResponse
-> GenerateDataKeyWithoutPlaintextResponse -> Bool
== :: GenerateDataKeyWithoutPlaintextResponse
-> GenerateDataKeyWithoutPlaintextResponse -> Bool
$c== :: GenerateDataKeyWithoutPlaintextResponse
-> GenerateDataKeyWithoutPlaintextResponse -> Bool
Prelude.Eq, ReadPrec [GenerateDataKeyWithoutPlaintextResponse]
ReadPrec GenerateDataKeyWithoutPlaintextResponse
Int -> ReadS GenerateDataKeyWithoutPlaintextResponse
ReadS [GenerateDataKeyWithoutPlaintextResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintextResponse]
$creadListPrec :: ReadPrec [GenerateDataKeyWithoutPlaintextResponse]
readPrec :: ReadPrec GenerateDataKeyWithoutPlaintextResponse
$creadPrec :: ReadPrec GenerateDataKeyWithoutPlaintextResponse
readList :: ReadS [GenerateDataKeyWithoutPlaintextResponse]
$creadList :: ReadS [GenerateDataKeyWithoutPlaintextResponse]
readsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintextResponse
$creadsPrec :: Int -> ReadS GenerateDataKeyWithoutPlaintextResponse
Prelude.Read, Int -> GenerateDataKeyWithoutPlaintextResponse -> ShowS
[GenerateDataKeyWithoutPlaintextResponse] -> ShowS
GenerateDataKeyWithoutPlaintextResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GenerateDataKeyWithoutPlaintextResponse] -> ShowS
$cshowList :: [GenerateDataKeyWithoutPlaintextResponse] -> ShowS
show :: GenerateDataKeyWithoutPlaintextResponse -> String
$cshow :: GenerateDataKeyWithoutPlaintextResponse -> String
showsPrec :: Int -> GenerateDataKeyWithoutPlaintextResponse -> ShowS
$cshowsPrec :: Int -> GenerateDataKeyWithoutPlaintextResponse -> ShowS
Prelude.Show, forall x.
Rep GenerateDataKeyWithoutPlaintextResponse x
-> GenerateDataKeyWithoutPlaintextResponse
forall x.
GenerateDataKeyWithoutPlaintextResponse
-> Rep GenerateDataKeyWithoutPlaintextResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GenerateDataKeyWithoutPlaintextResponse x
-> GenerateDataKeyWithoutPlaintextResponse
$cfrom :: forall x.
GenerateDataKeyWithoutPlaintextResponse
-> Rep GenerateDataKeyWithoutPlaintextResponse x
Prelude.Generic)

-- |
-- Create a value of 'GenerateDataKeyWithoutPlaintextResponse' 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', '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.
--
-- 'keyId', 'generateDataKeyWithoutPlaintextResponse_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 encrypted the data key.
--
-- 'httpStatus', 'generateDataKeyWithoutPlaintextResponse_httpStatus' - The response's http status code.
newGenerateDataKeyWithoutPlaintextResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GenerateDataKeyWithoutPlaintextResponse
newGenerateDataKeyWithoutPlaintextResponse :: Int -> GenerateDataKeyWithoutPlaintextResponse
newGenerateDataKeyWithoutPlaintextResponse
  Int
pHttpStatus_ =
    GenerateDataKeyWithoutPlaintextResponse'
      { $sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse' :: Maybe Base64
ciphertextBlob =
          forall a. Maybe a
Prelude.Nothing,
        $sel:keyId:GenerateDataKeyWithoutPlaintextResponse' :: Maybe Text
keyId = forall a. Maybe a
Prelude.Nothing,
        $sel:httpStatus:GenerateDataKeyWithoutPlaintextResponse' :: Int
httpStatus = Int
pHttpStatus_
      }

-- | The encrypted data key. When you use the HTTP API or the Amazon Web
-- Services CLI, the value is Base64-encoded. Otherwise, it is not
-- Base64-encoded.--
-- -- /Note:/ This 'Lens' automatically encodes and decodes Base64 data.
-- -- The underlying isomorphism will encode to Base64 representation during
-- -- serialisation, and decode from Base64 representation during deserialisation.
-- -- This 'Lens' accepts and returns only raw unencoded data.
generateDataKeyWithoutPlaintextResponse_ciphertextBlob :: Lens.Lens' GenerateDataKeyWithoutPlaintextResponse (Prelude.Maybe Prelude.ByteString)
generateDataKeyWithoutPlaintextResponse_ciphertextBlob :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe ByteString)
generateDataKeyWithoutPlaintextResponse_ciphertextBlob = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintextResponse' {Maybe Base64
ciphertextBlob :: Maybe Base64
$sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse' :: GenerateDataKeyWithoutPlaintextResponse -> Maybe Base64
ciphertextBlob} -> Maybe Base64
ciphertextBlob) (\s :: GenerateDataKeyWithoutPlaintextResponse
s@GenerateDataKeyWithoutPlaintextResponse' {} Maybe Base64
a -> GenerateDataKeyWithoutPlaintextResponse
s {$sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse' :: Maybe Base64
ciphertextBlob = Maybe Base64
a} :: GenerateDataKeyWithoutPlaintextResponse) 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 Amazon Resource Name
-- (<https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN key ARN>)
-- of the KMS key that encrypted the data key.
generateDataKeyWithoutPlaintextResponse_keyId :: Lens.Lens' GenerateDataKeyWithoutPlaintextResponse (Prelude.Maybe Prelude.Text)
generateDataKeyWithoutPlaintextResponse_keyId :: Lens' GenerateDataKeyWithoutPlaintextResponse (Maybe Text)
generateDataKeyWithoutPlaintextResponse_keyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GenerateDataKeyWithoutPlaintextResponse' {Maybe Text
keyId :: Maybe Text
$sel:keyId:GenerateDataKeyWithoutPlaintextResponse' :: GenerateDataKeyWithoutPlaintextResponse -> Maybe Text
keyId} -> Maybe Text
keyId) (\s :: GenerateDataKeyWithoutPlaintextResponse
s@GenerateDataKeyWithoutPlaintextResponse' {} Maybe Text
a -> GenerateDataKeyWithoutPlaintextResponse
s {$sel:keyId:GenerateDataKeyWithoutPlaintextResponse' :: Maybe Text
keyId = Maybe Text
a} :: GenerateDataKeyWithoutPlaintextResponse)

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

instance
  Prelude.NFData
    GenerateDataKeyWithoutPlaintextResponse
  where
  rnf :: GenerateDataKeyWithoutPlaintextResponse -> ()
rnf GenerateDataKeyWithoutPlaintextResponse' {Int
Maybe Text
Maybe Base64
httpStatus :: Int
keyId :: Maybe Text
ciphertextBlob :: Maybe Base64
$sel:httpStatus:GenerateDataKeyWithoutPlaintextResponse' :: GenerateDataKeyWithoutPlaintextResponse -> Int
$sel:keyId:GenerateDataKeyWithoutPlaintextResponse' :: GenerateDataKeyWithoutPlaintextResponse -> Maybe Text
$sel:ciphertextBlob:GenerateDataKeyWithoutPlaintextResponse' :: GenerateDataKeyWithoutPlaintextResponse -> 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 Text
keyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus