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.APIGateway.GetRequestValidator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a RequestValidator of a given RestApi .

Creating a Request

getRequestValidator #

Arguments

:: Text	`grvrRestAPIId`
-> Text	`grvrRequestValidatorId`
-> GetRequestValidator

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

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

grvrRestAPIId - [Required] The string identifier of the associated RestApi .
grvrRequestValidatorId - [Required] The identifier of the RequestValidator to be retrieved.

data GetRequestValidator #

Gets a RequestValidator of a given RestApi .

See: getRequestValidator smart constructor.

Instances

Eq GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods (==) :: GetRequestValidator -> GetRequestValidator -> Bool # (/=) :: GetRequestValidator -> GetRequestValidator -> Bool #
Data GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRequestValidator -> c GetRequestValidator # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRequestValidator # toConstr :: GetRequestValidator -> Constr # dataTypeOf :: GetRequestValidator -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetRequestValidator) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRequestValidator) # gmapT :: (forall b. Data b => b -> b) -> GetRequestValidator -> GetRequestValidator # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRequestValidator -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRequestValidator -> r # gmapQ :: (forall d. Data d => d -> u) -> GetRequestValidator -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRequestValidator -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRequestValidator -> m GetRequestValidator # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRequestValidator -> m GetRequestValidator # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRequestValidator -> m GetRequestValidator #
Read GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods readsPrec :: Int -> ReadS GetRequestValidator # readList :: ReadS [GetRequestValidator] # readPrec :: ReadPrec GetRequestValidator # readListPrec :: ReadPrec [GetRequestValidator] #
Show GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods showsPrec :: Int -> GetRequestValidator -> ShowS # show :: GetRequestValidator -> String # showList :: [GetRequestValidator] -> ShowS #
Generic GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Associated Types type Rep GetRequestValidator :: * -> * # Methods from :: GetRequestValidator -> Rep GetRequestValidator x # to :: Rep GetRequestValidator x -> GetRequestValidator #
Hashable GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods hashWithSalt :: Int -> GetRequestValidator -> Int # hash :: GetRequestValidator -> Int #
AWSRequest GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Associated Types type Rs GetRequestValidator :: * # Methods request :: GetRequestValidator -> Request GetRequestValidator # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetRequestValidator -> ClientResponse -> m (Response GetRequestValidator) #
ToHeaders GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods toHeaders :: GetRequestValidator -> [Header] #
ToPath GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods toPath :: GetRequestValidator -> ByteString #
ToQuery GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods toQuery :: GetRequestValidator -> QueryString #
NFData GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator Methods rnf :: GetRequestValidator -> () #
type Rep GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator type Rep GetRequestValidator = D1 (MetaData "GetRequestValidator" "Network.AWS.APIGateway.GetRequestValidator" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "GetRequestValidator'" PrefixI True) (S1 (MetaSel (Just "_grvrRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_grvrRequestValidatorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs GetRequestValidator #
Instance details Defined in Network.AWS.APIGateway.GetRequestValidator type Rs GetRequestValidator = RequestValidator

Request Lenses

grvrRestAPIId :: Lens' GetRequestValidator Text #

Required: The string identifier of the associated RestApi .

grvrRequestValidatorId :: Lens' GetRequestValidator Text #

Required: The identifier of the RequestValidator to be retrieved.

Destructuring the Response

requestValidator :: RequestValidator #

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

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

rvValidateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true ) or not (false ).
rvName - The name of this RequestValidator
rvValidateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
rvId - The identifier of this RequestValidator .

data RequestValidator #

A set of validation rules for incoming Method requests.

In Swagger, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.

Enable Basic Request Validation in API Gateway

See: requestValidator smart constructor.

Instances

Eq RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Data RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestValidator -> c RequestValidator # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestValidator # toConstr :: RequestValidator -> Constr # dataTypeOf :: RequestValidator -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RequestValidator) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestValidator) # gmapT :: (forall b. Data b => b -> b) -> RequestValidator -> RequestValidator # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestValidator -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestValidator -> r # gmapQ :: (forall d. Data d => d -> u) -> RequestValidator -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestValidator -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestValidator -> m RequestValidator # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestValidator -> m RequestValidator # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestValidator -> m RequestValidator #
Read RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
Generic RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Associated Types type Rep RequestValidator :: * -> * # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
Hashable RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
FromJSON RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
NFData RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product Methods rnf :: RequestValidator -> () #
type Rep RequestValidator #
Instance details Defined in Network.AWS.APIGateway.Types.Product type Rep RequestValidator = D1 (MetaData "RequestValidator" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-AZknipQenWKIkkS1rcDzK1" False) (C1 (MetaCons "RequestValidator'" PrefixI True) ((S1 (MetaSel (Just "_rvValidateRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_rvName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_rvValidateRequestBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_rvId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

Response Lenses

rvValidateRequestParameters :: Lens' RequestValidator (Maybe Bool) #

A Boolean flag to indicate whether to validate request parameters (true ) or not (false ).

rvName :: Lens' RequestValidator (Maybe Text) #

The name of this RequestValidator

rvValidateRequestBody :: Lens' RequestValidator (Maybe Bool) #

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

rvId :: Lens' RequestValidator (Maybe Text) #

The identifier of this RequestValidator .