Network.AWS.KMS.GenerateDataKey

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec . To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

We recommend that you use the following pattern to encrypt data locally in your application:

• Use this operation (GenerateDataKey ) to get a data encryption key.
• Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
• Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

• Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
• Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext . To return a random byte string that is cryptographically secure, use GenerateRandom .

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide .

Creating a Request

generateDataKey

Arguments

:: Text

gdkKeyId

-> GenerateDataKey

Creates a value of GenerateDataKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdkKeySpec - The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
• gdkEncryptionContext - A set of key-value pairs that represents additional authenticated data. For more information, see Encryption Context in the AWS Key Management Service Developer Guide .
• gdkNumberOfBytes - The length of the data encryption 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.
• gdkGrantTokens - A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .
• gdkKeyId - The identifier of the CMK under which to generate and encrypt the data encryption key. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias". To specify a CMK in a different AWS 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:key1234abcd-12ab-34cd-56ef-1234567890ab * Alias name: aliasExampleAlias * Alias ARN: arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey . To get the alias name and alias ARN, use ListAliases .

data GenerateDataKey

See: generateDataKey smart constructor.

Instances

Eq GenerateDataKey

Methods

(==) :: GenerateDataKey -> GenerateDataKey -> Bool

(/=) :: GenerateDataKey -> GenerateDataKey -> Bool

Data GenerateDataKey

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateDataKey -> c GenerateDataKey

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateDataKey

toConstr :: GenerateDataKey -> Constr

dataTypeOf :: GenerateDataKey -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GenerateDataKey)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateDataKey)

gmapT :: (forall b. Data b => b -> b) -> GenerateDataKey -> GenerateDataKey

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataKey -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataKey -> r

gmapQ :: (forall d. Data d => d -> u) -> GenerateDataKey -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateDataKey -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateDataKey -> m GenerateDataKey

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataKey -> m GenerateDataKey

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataKey -> m GenerateDataKey

Read GenerateDataKey

Methods

readsPrec :: Int -> ReadS GenerateDataKey

readList :: ReadS [GenerateDataKey]

readPrec :: ReadPrec GenerateDataKey

readListPrec :: ReadPrec [GenerateDataKey]

Show GenerateDataKey

Methods

showsPrec :: Int -> GenerateDataKey -> ShowS

show :: GenerateDataKey -> String

showList :: [GenerateDataKey] -> ShowS

Generic GenerateDataKey

Associated Types

type Rep GenerateDataKey :: * -> *

Methods

from :: GenerateDataKey -> Rep GenerateDataKey x

to :: Rep GenerateDataKey x -> GenerateDataKey

Hashable GenerateDataKey

Methods

hashWithSalt :: Int -> GenerateDataKey -> Int

hash :: GenerateDataKey -> Int

ToJSON GenerateDataKey

Methods

toJSON :: GenerateDataKey -> Value

toEncoding :: GenerateDataKey -> Encoding

toJSONList :: [GenerateDataKey] -> Value

toEncodingList :: [GenerateDataKey] -> Encoding

NFData GenerateDataKey

Methods

rnf :: GenerateDataKey -> ()

AWSRequest GenerateDataKey

Associated Types

type Rs GenerateDataKey :: *

Methods

request :: GenerateDataKey -> Request GenerateDataKey

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GenerateDataKey -> ClientResponse -> m (Response GenerateDataKey)

ToHeaders GenerateDataKey

Methods

toHeaders :: GenerateDataKey -> [Header]

ToPath GenerateDataKey

Methods

toPath :: GenerateDataKey -> ByteString

ToQuery GenerateDataKey

Methods

toQuery :: GenerateDataKey -> QueryString

type Rep GenerateDataKey

type Rep GenerateDataKey = D1 * (MetaData "GenerateDataKey" "Network.AWS.KMS.GenerateDataKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "GenerateDataKey'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdkKeySpec") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DataKeySpec))) (S1 * (MetaSel (Just Symbol "_gdkEncryptionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdkNumberOfBytes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdkGrantTokens") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_gdkKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs GenerateDataKey

type Rs GenerateDataKey = GenerateDataKeyResponse

Request Lenses

gdkKeySpec :: Lens' GenerateDataKey (Maybe DataKeySpec)

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

gdkEncryptionContext :: Lens' GenerateDataKey (HashMap Text Text)

A set of key-value pairs that represents additional authenticated data. For more information, see Encryption Context in the AWS Key Management Service Developer Guide .

gdkNumberOfBytes :: Lens' GenerateDataKey (Maybe Natural)

The length of the data encryption 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.

gdkGrantTokens :: Lens' GenerateDataKey [Text]

A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .

gdkKeyId :: Lens' GenerateDataKey Text

The identifier of the CMK under which to generate and encrypt the data encryption key. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias". To specify a CMK in a different AWS 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:key1234abcd-12ab-34cd-56ef-1234567890ab * Alias name: aliasExampleAlias * Alias ARN: arn:aws:kms:us-east-2:111122223333:aliasExampleAlias@ To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey . To get the alias name and alias ARN, use ListAliases .

Destructuring the Response

generateDataKeyResponse

Arguments

:: Int

gdkrsResponseStatus

-> Text

gdkrsKeyId

-> ByteString

gdkrsPlaintext

-> ByteString

gdkrsCiphertextBlob

-> GenerateDataKeyResponse

Creates a value of GenerateDataKeyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gdkrsResponseStatus - -- | The response status code.
• gdkrsKeyId - The identifier of the CMK under which the data encryption key was generated and encrypted.
• gdkrsPlaintext - The data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. Use this data key for local encryption and decryption, 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.
• gdkrsCiphertextBlob - The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not 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.

data GenerateDataKeyResponse

See: generateDataKeyResponse smart constructor.

Instances

Eq GenerateDataKeyResponse

Methods

(==) :: GenerateDataKeyResponse -> GenerateDataKeyResponse -> Bool

(/=) :: GenerateDataKeyResponse -> GenerateDataKeyResponse -> Bool

Data GenerateDataKeyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateDataKeyResponse -> c GenerateDataKeyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateDataKeyResponse

toConstr :: GenerateDataKeyResponse -> Constr

dataTypeOf :: GenerateDataKeyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GenerateDataKeyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateDataKeyResponse)

gmapT :: (forall b. Data b => b -> b) -> GenerateDataKeyResponse -> GenerateDataKeyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataKeyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateDataKeyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GenerateDataKeyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateDataKeyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateDataKeyResponse -> m GenerateDataKeyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataKeyResponse -> m GenerateDataKeyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateDataKeyResponse -> m GenerateDataKeyResponse

Show GenerateDataKeyResponse

Methods

showsPrec :: Int -> GenerateDataKeyResponse -> ShowS

show :: GenerateDataKeyResponse -> String

showList :: [GenerateDataKeyResponse] -> ShowS

Generic GenerateDataKeyResponse

Associated Types

type Rep GenerateDataKeyResponse :: * -> *

Methods

from :: GenerateDataKeyResponse -> Rep GenerateDataKeyResponse x

to :: Rep GenerateDataKeyResponse x -> GenerateDataKeyResponse

NFData GenerateDataKeyResponse

Methods

rnf :: GenerateDataKeyResponse -> ()

type Rep GenerateDataKeyResponse

type Rep GenerateDataKeyResponse = D1 * (MetaData "GenerateDataKeyResponse" "Network.AWS.KMS.GenerateDataKey" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "GenerateDataKeyResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_gdkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_gdkrsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_gdkrsPlaintext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Base64))) (S1 * (MetaSel (Just Symbol "_gdkrsCiphertextBlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Base64)))))

Response Lenses

gdkrsResponseStatus :: Lens' GenerateDataKeyResponse Int

• - | The response status code.

gdkrsKeyId :: Lens' GenerateDataKeyResponse Text

The identifier of the CMK under which the data encryption key was generated and encrypted.

gdkrsPlaintext :: Lens' GenerateDataKeyResponse ByteString

The data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. Use this data key for local encryption and decryption, 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.

gdkrsCiphertextBlob :: Lens' GenerateDataKeyResponse ByteString

The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not 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.