| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.KMS.Decrypt
Description
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
Synopsis
- decrypt :: ByteString -> Decrypt
- data Decrypt
- decEncryptionContext :: Lens' Decrypt (HashMap Text Text)
- decGrantTokens :: Lens' Decrypt [Text]
- decCiphertextBlob :: Lens' Decrypt ByteString
- decryptResponse :: Int -> DecryptResponse
- data DecryptResponse
- drsKeyId :: Lens' DecryptResponse (Maybe Text)
- drsPlaintext :: Lens' DecryptResponse (Maybe ByteString)
- drsResponseStatus :: Lens' DecryptResponse Int
Creating a Request
Arguments
| :: ByteString | |
| -> Decrypt |
Creates a value of Decrypt with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
decEncryptionContext- The encryption context. If this was specified in theEncryptfunction, it must be specified here or the decryption operation will fail. For more information, see Encryption Context .decGrantTokens- A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .decCiphertextBlob- Ciphertext to be decrypted. The blob includes metadata.-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.
See: decrypt smart constructor.
Instances
| Eq Decrypt # | |
| Data Decrypt # | |
Defined in Network.AWS.KMS.Decrypt Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Decrypt -> c Decrypt # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Decrypt # toConstr :: Decrypt -> Constr # dataTypeOf :: Decrypt -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Decrypt) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Decrypt) # gmapT :: (forall b. Data b => b -> b) -> Decrypt -> Decrypt # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Decrypt -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Decrypt -> r # gmapQ :: (forall d. Data d => d -> u) -> Decrypt -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Decrypt -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Decrypt -> m Decrypt # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Decrypt -> m Decrypt # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Decrypt -> m Decrypt # | |
| Read Decrypt # | |
| Show Decrypt # | |
| Generic Decrypt # | |
| Hashable Decrypt # | |
Defined in Network.AWS.KMS.Decrypt | |
| ToJSON Decrypt # | |
Defined in Network.AWS.KMS.Decrypt | |
| AWSRequest Decrypt # | |
| ToHeaders Decrypt # | |
Defined in Network.AWS.KMS.Decrypt | |
| ToPath Decrypt # | |
Defined in Network.AWS.KMS.Decrypt Methods toPath :: Decrypt -> ByteString # | |
| ToQuery Decrypt # | |
Defined in Network.AWS.KMS.Decrypt Methods toQuery :: Decrypt -> QueryString # | |
| NFData Decrypt # | |
Defined in Network.AWS.KMS.Decrypt | |
| type Rep Decrypt # | |
Defined in Network.AWS.KMS.Decrypt type Rep Decrypt = D1 (MetaData "Decrypt" "Network.AWS.KMS.Decrypt" "amazonka-kms-1.6.0-J0DpkKKCQ2By8yYSyE2w7" False) (C1 (MetaCons "Decrypt'" PrefixI True) (S1 (MetaSel (Just "_decEncryptionContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: (S1 (MetaSel (Just "_decGrantTokens") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_decCiphertextBlob") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Base64)))) | |
| type Rs Decrypt # | |
Defined in Network.AWS.KMS.Decrypt | |
Request Lenses
decEncryptionContext :: Lens' Decrypt (HashMap Text Text) #
The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context .
decGrantTokens :: Lens' Decrypt [Text] #
A list of grant tokens. For more information, see Grant Tokens in the AWS Key Management Service Developer Guide .
decCiphertextBlob :: Lens' Decrypt ByteString #
Ciphertext to be decrypted. The blob includes metadata.-- 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
Arguments
| :: Int | |
| -> DecryptResponse |
Creates a value of DecryptResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsKeyId- ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.drsPlaintext- Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.-- Note: ThisLensautomatically encodes and decodes Base64 data. The underlying isomorphism will encode to Base64 representation during serialisation, and decode from Base64 representation during deserialisation. ThisLensaccepts and returns only raw unencoded data.drsResponseStatus- -- | The response status code.
data DecryptResponse #
See: decryptResponse smart constructor.
Instances
Response Lenses
drsKeyId :: Lens' DecryptResponse (Maybe Text) #
ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
drsPlaintext :: Lens' DecryptResponse (Maybe ByteString) #
Decrypted plaintext data. 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.
drsResponseStatus :: Lens' DecryptResponse Int #
- - | The response status code.