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.GenerateRandom

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a random byte string that is cryptographically secure.

For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.

Creating a Request

generateRandom :: GenerateRandom Source #

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

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

grNumberOfBytes - The length of the byte string.

data GenerateRandom Source #

See: generateRandom smart constructor.

Instances

Eq GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods (==) :: GenerateRandom -> GenerateRandom -> Bool # (/=) :: GenerateRandom -> GenerateRandom -> Bool #
Data GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateRandom -> c GenerateRandom # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateRandom # toConstr :: GenerateRandom -> Constr # dataTypeOf :: GenerateRandom -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenerateRandom) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateRandom) # gmapT :: (forall b. Data b => b -> b) -> GenerateRandom -> GenerateRandom # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateRandom -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateRandom -> r # gmapQ :: (forall d. Data d => d -> u) -> GenerateRandom -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateRandom -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateRandom -> m GenerateRandom # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateRandom -> m GenerateRandom # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateRandom -> m GenerateRandom #
Read GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods readsPrec :: Int -> ReadS GenerateRandom # readList :: ReadS [GenerateRandom] # readPrec :: ReadPrec GenerateRandom # readListPrec :: ReadPrec [GenerateRandom] #
Show GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods showsPrec :: Int -> GenerateRandom -> ShowS # show :: GenerateRandom -> String # showList :: [GenerateRandom] -> ShowS #
Generic GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Associated Types type Rep GenerateRandom :: Type -> Type # Methods from :: GenerateRandom -> Rep GenerateRandom x # to :: Rep GenerateRandom x -> GenerateRandom #
Hashable GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods hashWithSalt :: Int -> GenerateRandom -> Int # hash :: GenerateRandom -> Int #
ToJSON GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods toJSON :: GenerateRandom -> Value # toEncoding :: GenerateRandom -> Encoding # toJSONList :: [GenerateRandom] -> Value # toEncodingList :: [GenerateRandom] -> Encoding #
AWSRequest GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Associated Types type Rs GenerateRandom :: Type # Methods request :: GenerateRandom -> Request GenerateRandom # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GenerateRandom -> ClientResponse -> m (Response GenerateRandom) #
ToHeaders GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods toHeaders :: GenerateRandom -> [Header] #
ToPath GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods toPath :: GenerateRandom -> ByteString #
ToQuery GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods toQuery :: GenerateRandom -> QueryString #
NFData GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods rnf :: GenerateRandom -> () #
type Rep GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom type Rep GenerateRandom = D1 (MetaData "GenerateRandom" "Network.AWS.KMS.GenerateRandom" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" True) (C1 (MetaCons "GenerateRandom'" PrefixI True) (S1 (MetaSel (Just "_grNumberOfBytes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Nat))))
type Rs GenerateRandom Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom type Rs GenerateRandom = GenerateRandomResponse

Request Lenses

grNumberOfBytes :: Lens' GenerateRandom (Maybe Natural) Source #

The length of the byte string.

Destructuring the Response

generateRandomResponse Source #

Arguments

:: Int	`grrsResponseStatus`
-> GenerateRandomResponse

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

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

grrsPlaintext - The random byte string. 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.
grrsResponseStatus - -- | The response status code.

data GenerateRandomResponse Source #

See: generateRandomResponse smart constructor.

Instances

Eq GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods (==) :: GenerateRandomResponse -> GenerateRandomResponse -> Bool # (/=) :: GenerateRandomResponse -> GenerateRandomResponse -> Bool #
Data GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenerateRandomResponse -> c GenerateRandomResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenerateRandomResponse # toConstr :: GenerateRandomResponse -> Constr # dataTypeOf :: GenerateRandomResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenerateRandomResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenerateRandomResponse) # gmapT :: (forall b. Data b => b -> b) -> GenerateRandomResponse -> GenerateRandomResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenerateRandomResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenerateRandomResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GenerateRandomResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GenerateRandomResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenerateRandomResponse -> m GenerateRandomResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateRandomResponse -> m GenerateRandomResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenerateRandomResponse -> m GenerateRandomResponse #
Show GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods showsPrec :: Int -> GenerateRandomResponse -> ShowS # show :: GenerateRandomResponse -> String # showList :: [GenerateRandomResponse] -> ShowS #
Generic GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Associated Types type Rep GenerateRandomResponse :: Type -> Type # Methods from :: GenerateRandomResponse -> Rep GenerateRandomResponse x # to :: Rep GenerateRandomResponse x -> GenerateRandomResponse #
NFData GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom Methods rnf :: GenerateRandomResponse -> () #
type Rep GenerateRandomResponse Source #
Instance details Defined in Network.AWS.KMS.GenerateRandom type Rep GenerateRandomResponse = D1 (MetaData "GenerateRandomResponse" "Network.AWS.KMS.GenerateRandom" "amazonka-kms-1.6.1-1UDljZYfeha1jjHbbMax4v" False) (C1 (MetaCons "GenerateRandomResponse'" PrefixI True) (S1 (MetaSel (Just "_grrsPlaintext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Base64))) :*: S1 (MetaSel (Just "_grrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

grrsPlaintext :: Lens' GenerateRandomResponse (Maybe ByteString) Source #

The random byte string. 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.

grrsResponseStatus :: Lens' GenerateRandomResponse Int Source #

- | The response status code.