{-# 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 -- -- 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 -- -- 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__: -- -- (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 -- -- in the /Key Management Service Developer Guide/. 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 -- -- and -- -- in the /Key Management Service Developer Guide/. 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. 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. 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. keyId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GenerateDataKeyWithoutPlaintext' with all optional fields omitted. -- -- Use or 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 -- -- 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 -- -- and -- -- 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 pKeyId_ = GenerateDataKeyWithoutPlaintext' { encryptionContext = Prelude.Nothing, grantTokens = Prelude.Nothing, keySpec = Prelude.Nothing, numberOfBytes = Prelude.Nothing, keyId = 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 -- -- in the /Key Management Service Developer Guide/. generateDataKeyWithoutPlaintext_encryptionContext :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text)) generateDataKeyWithoutPlaintext_encryptionContext = Lens.lens (\GenerateDataKeyWithoutPlaintext' {encryptionContext} -> encryptionContext) (\s@GenerateDataKeyWithoutPlaintext' {} a -> s {encryptionContext = a} :: GenerateDataKeyWithoutPlaintext) Prelude.. Lens.mapping 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 -- -- and -- -- in the /Key Management Service Developer Guide/. generateDataKeyWithoutPlaintext_grantTokens :: Lens.Lens' GenerateDataKeyWithoutPlaintext (Prelude.Maybe [Prelude.Text]) generateDataKeyWithoutPlaintext_grantTokens = Lens.lens (\GenerateDataKeyWithoutPlaintext' {grantTokens} -> grantTokens) (\s@GenerateDataKeyWithoutPlaintext' {} a -> s {grantTokens = a} :: GenerateDataKeyWithoutPlaintext) Prelude.. Lens.mapping 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.lens (\GenerateDataKeyWithoutPlaintext' {keySpec} -> keySpec) (\s@GenerateDataKeyWithoutPlaintext' {} a -> s {keySpec = 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.lens (\GenerateDataKeyWithoutPlaintext' {numberOfBytes} -> numberOfBytes) (\s@GenerateDataKeyWithoutPlaintext' {} a -> s {numberOfBytes = 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.lens (\GenerateDataKeyWithoutPlaintext' {keyId} -> keyId) (\s@GenerateDataKeyWithoutPlaintext' {} a -> s {keyId = a} :: GenerateDataKeyWithoutPlaintext) instance Core.AWSRequest GenerateDataKeyWithoutPlaintext where type AWSResponse GenerateDataKeyWithoutPlaintext = GenerateDataKeyWithoutPlaintextResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> GenerateDataKeyWithoutPlaintextResponse' Prelude.<$> (x Data..?> "CiphertextBlob") Prelude.<*> (x Data..?> "KeyId") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable GenerateDataKeyWithoutPlaintext where hashWithSalt _salt GenerateDataKeyWithoutPlaintext' {..} = _salt `Prelude.hashWithSalt` encryptionContext `Prelude.hashWithSalt` grantTokens `Prelude.hashWithSalt` keySpec `Prelude.hashWithSalt` numberOfBytes `Prelude.hashWithSalt` keyId instance Prelude.NFData GenerateDataKeyWithoutPlaintext where rnf GenerateDataKeyWithoutPlaintext' {..} = Prelude.rnf encryptionContext `Prelude.seq` Prelude.rnf grantTokens `Prelude.seq` Prelude.rnf keySpec `Prelude.seq` Prelude.rnf numberOfBytes `Prelude.seq` Prelude.rnf keyId instance Data.ToHeaders GenerateDataKeyWithoutPlaintext where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "TrentService.GenerateDataKeyWithoutPlaintext" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON GenerateDataKeyWithoutPlaintext where toJSON GenerateDataKeyWithoutPlaintext' {..} = Data.object ( Prelude.catMaybes [ ("EncryptionContext" Data..=) Prelude.<$> encryptionContext, ("GrantTokens" Data..=) Prelude.<$> grantTokens, ("KeySpec" Data..=) Prelude.<$> keySpec, ("NumberOfBytes" Data..=) Prelude.<$> numberOfBytes, Prelude.Just ("KeyId" Data..= keyId) ] ) instance Data.ToPath GenerateDataKeyWithoutPlaintext where toPath = Prelude.const "/" instance Data.ToQuery GenerateDataKeyWithoutPlaintext where toQuery = Prelude.const 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. ciphertextBlob :: Prelude.Maybe Data.Base64, -- | The Amazon Resource Name -- () -- of the KMS key that encrypted the data key. keyId :: Prelude.Maybe Prelude.Text, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GenerateDataKeyWithoutPlaintextResponse' with all optional fields omitted. -- -- Use or 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 -- () -- of the KMS key that encrypted the data key. -- -- 'httpStatus', 'generateDataKeyWithoutPlaintextResponse_httpStatus' - The response's http status code. newGenerateDataKeyWithoutPlaintextResponse :: -- | 'httpStatus' Prelude.Int -> GenerateDataKeyWithoutPlaintextResponse newGenerateDataKeyWithoutPlaintextResponse pHttpStatus_ = GenerateDataKeyWithoutPlaintextResponse' { ciphertextBlob = Prelude.Nothing, keyId = Prelude.Nothing, httpStatus = 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.lens (\GenerateDataKeyWithoutPlaintextResponse' {ciphertextBlob} -> ciphertextBlob) (\s@GenerateDataKeyWithoutPlaintextResponse' {} a -> s {ciphertextBlob = a} :: GenerateDataKeyWithoutPlaintextResponse) Prelude.. Lens.mapping Data._Base64 -- | The Amazon Resource Name -- () -- of the KMS key that encrypted the data key. generateDataKeyWithoutPlaintextResponse_keyId :: Lens.Lens' GenerateDataKeyWithoutPlaintextResponse (Prelude.Maybe Prelude.Text) generateDataKeyWithoutPlaintextResponse_keyId = Lens.lens (\GenerateDataKeyWithoutPlaintextResponse' {keyId} -> keyId) (\s@GenerateDataKeyWithoutPlaintextResponse' {} a -> s {keyId = a} :: GenerateDataKeyWithoutPlaintextResponse) -- | The response's http status code. generateDataKeyWithoutPlaintextResponse_httpStatus :: Lens.Lens' GenerateDataKeyWithoutPlaintextResponse Prelude.Int generateDataKeyWithoutPlaintextResponse_httpStatus = Lens.lens (\GenerateDataKeyWithoutPlaintextResponse' {httpStatus} -> httpStatus) (\s@GenerateDataKeyWithoutPlaintextResponse' {} a -> s {httpStatus = a} :: GenerateDataKeyWithoutPlaintextResponse) instance Prelude.NFData GenerateDataKeyWithoutPlaintextResponse where rnf GenerateDataKeyWithoutPlaintextResponse' {..} = Prelude.rnf ciphertextBlob `Prelude.seq` Prelude.rnf keyId `Prelude.seq` Prelude.rnf httpStatus