amazonka-kms-1.4.5: Amazon Key Management Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.KMS.Encrypt

Contents

Description

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

  • You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
  • If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt .

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

Synopsis

Creating a Request

encrypt #

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

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

  • eEncryptionContext - Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context .
  • eGrantTokens - A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .
  • eKeyId - A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias". * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 * Alias Name Example - aliasMyAliasName
  • ePlaintext - Data to be encrypted.-- Note: This Lens automatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. This Lens accepts and returns only raw unencoded data.

data Encrypt #

See: encrypt smart constructor.

Instances

Eq Encrypt # 

Methods

(==) :: Encrypt -> Encrypt -> Bool #

(/=) :: Encrypt -> Encrypt -> Bool #

Data Encrypt # 

Methods

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

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

toConstr :: Encrypt -> Constr #

dataTypeOf :: Encrypt -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> Encrypt -> Encrypt #

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

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

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

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

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

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

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

Read Encrypt # 
Show Encrypt # 
Generic Encrypt # 

Associated Types

type Rep Encrypt :: * -> * #

Methods

from :: Encrypt -> Rep Encrypt x #

to :: Rep Encrypt x -> Encrypt #

Hashable Encrypt # 

Methods

hashWithSalt :: Int -> Encrypt -> Int #

hash :: Encrypt -> Int #

ToJSON Encrypt # 
NFData Encrypt # 

Methods

rnf :: Encrypt -> () #

AWSRequest Encrypt # 

Associated Types

type Rs Encrypt :: * #

ToQuery Encrypt # 
ToPath Encrypt # 

Methods

toPath :: Encrypt -> ByteString #

ToHeaders Encrypt # 

Methods

toHeaders :: Encrypt -> [Header] #

type Rep Encrypt # 
type Rep Encrypt = D1 (MetaData "Encrypt" "Network.AWS.KMS.Encrypt" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "Encrypt'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eEncryptionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_eGrantTokens") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_eKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ePlaintext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Base64))))))
type Rs Encrypt # 

Request Lenses

eEncryptionContext :: Lens' Encrypt (HashMap Text Text) #

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context .

eGrantTokens :: Lens' Encrypt [Text] #

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

eKeyId :: Lens' Encrypt Text #

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias". * Key ARN Example - arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * Alias ARN Example - arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 * Alias Name Example - aliasMyAliasName

ePlaintext :: Lens' Encrypt ByteString #

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.

Destructuring the Response

encryptResponse #

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

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

  • ersKeyId - The ID of the key used during encryption.
  • ersCiphertextBlob - The encrypted plaintext. If you are using the 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.
  • ersResponseStatus - -- | The response status code.

data EncryptResponse #

See: encryptResponse smart constructor.

Instances

Eq EncryptResponse # 
Data EncryptResponse # 

Methods

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

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

toConstr :: EncryptResponse -> Constr #

dataTypeOf :: EncryptResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> EncryptResponse -> EncryptResponse #

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

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

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

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

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

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

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

Read EncryptResponse # 
Show EncryptResponse # 
Generic EncryptResponse # 
NFData EncryptResponse # 

Methods

rnf :: EncryptResponse -> () #

type Rep EncryptResponse # 
type Rep EncryptResponse = D1 (MetaData "EncryptResponse" "Network.AWS.KMS.Encrypt" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "EncryptResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ersKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ersCiphertextBlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Base64))) (S1 (MetaSel (Just Symbol "_ersResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ersKeyId :: Lens' EncryptResponse (Maybe Text) #

The ID of the key used during encryption.

ersCiphertextBlob :: Lens' EncryptResponse (Maybe ByteString) #

The encrypted plaintext. If you are using the 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.

ersResponseStatus :: Lens' EncryptResponse Int #

  • - | The response status code.