Network.AWS.APIGateway.CreateRequestValidator

Creates a ReqeustValidator of a given RestApi .

Creating a Request

createRequestValidator

Arguments

:: Text

crvRestAPIId

-> CreateRequestValidator

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

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

• crvValidateRequestParameters - A Boolean flag to indicate whether to validate request parameters, true , or not false .
• crvName - The name of the to-be-created RequestValidator .
• crvValidateRequestBody - A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true ) or not (false ).
• crvRestAPIId - The string identifier of the associated RestApi .

data CreateRequestValidator

Creates a RequestValidator of a given RestApi .

See: createRequestValidator smart constructor.

Instances

Eq CreateRequestValidator

Methods

(==) :: CreateRequestValidator -> CreateRequestValidator -> Bool

(/=) :: CreateRequestValidator -> CreateRequestValidator -> Bool

Data CreateRequestValidator

Methods

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

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

toConstr :: CreateRequestValidator -> Constr

dataTypeOf :: CreateRequestValidator -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateRequestValidator -> CreateRequestValidator

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

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

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

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

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

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

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

Read CreateRequestValidator

Methods

readsPrec :: Int -> ReadS CreateRequestValidator

readList :: ReadS [CreateRequestValidator]

readPrec :: ReadPrec CreateRequestValidator

readListPrec :: ReadPrec [CreateRequestValidator]

Show CreateRequestValidator

Methods

showsPrec :: Int -> CreateRequestValidator -> ShowS

show :: CreateRequestValidator -> String

showList :: [CreateRequestValidator] -> ShowS

Generic CreateRequestValidator

Associated Types

type Rep CreateRequestValidator :: * -> *

Methods

from :: CreateRequestValidator -> Rep CreateRequestValidator x

to :: Rep CreateRequestValidator x -> CreateRequestValidator

Hashable CreateRequestValidator

Methods

hashWithSalt :: Int -> CreateRequestValidator -> Int

hash :: CreateRequestValidator -> Int

ToJSON CreateRequestValidator

Methods

toJSON :: CreateRequestValidator -> Value

toEncoding :: CreateRequestValidator -> Encoding

toJSONList :: [CreateRequestValidator] -> Value

toEncodingList :: [CreateRequestValidator] -> Encoding

NFData CreateRequestValidator

Methods

rnf :: CreateRequestValidator -> ()

AWSRequest CreateRequestValidator

Associated Types

type Rs CreateRequestValidator :: *

Methods

request :: CreateRequestValidator -> Request CreateRequestValidator

response :: MonadResource m => Logger -> Service -> Proxy * CreateRequestValidator -> ClientResponse -> m (Response CreateRequestValidator)

ToQuery CreateRequestValidator

Methods

toQuery :: CreateRequestValidator -> QueryString

ToPath CreateRequestValidator

Methods

toPath :: CreateRequestValidator -> ByteString

ToHeaders CreateRequestValidator

Methods

toHeaders :: CreateRequestValidator -> [Header]

type Rep CreateRequestValidator

type Rep CreateRequestValidator = D1 (MetaData "CreateRequestValidator" "Network.AWS.APIGateway.CreateRequestValidator" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "CreateRequestValidator'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_crvValidateRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_crvName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_crvValidateRequestBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_crvRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs CreateRequestValidator

type Rs CreateRequestValidator = RequestValidator

Request Lenses

crvValidateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool)

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

crvName :: Lens' CreateRequestValidator (Maybe Text)

The name of the to-be-created RequestValidator .

crvValidateRequestBody :: Lens' CreateRequestValidator (Maybe Bool)

A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true ) or not (false ).

crvRestAPIId :: Lens' CreateRequestValidator Text

The string identifier of the associated RestApi .

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

Methods

(==) :: RequestValidator -> RequestValidator -> Bool

(/=) :: RequestValidator -> RequestValidator -> Bool

Data RequestValidator

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

Methods

readsPrec :: Int -> ReadS RequestValidator

readList :: ReadS [RequestValidator]

readPrec :: ReadPrec RequestValidator

readListPrec :: ReadPrec [RequestValidator]

Show RequestValidator

Methods

showsPrec :: Int -> RequestValidator -> ShowS

show :: RequestValidator -> String

showList :: [RequestValidator] -> ShowS

Generic RequestValidator

Associated Types

type Rep RequestValidator :: * -> *

Methods

from :: RequestValidator -> Rep RequestValidator x

to :: Rep RequestValidator x -> RequestValidator

Hashable RequestValidator

Methods

hashWithSalt :: Int -> RequestValidator -> Int

hash :: RequestValidator -> Int

FromJSON RequestValidator

Methods

parseJSON :: Value -> Parser RequestValidator

parseJSONList :: Value -> Parser [RequestValidator]

NFData RequestValidator

Methods

rnf :: RequestValidator -> ()

type Rep RequestValidator

type Rep RequestValidator = D1 (MetaData "RequestValidator" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "RequestValidator'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rvValidateRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_rvName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rvValidateRequestBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_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 .