Amazonka.APIGateway.Types.RequestValidator

Documentation

data RequestValidator

A set of validation rules for incoming Method requests.

See: newRequestValidator smart constructor.

Constructors

RequestValidator'

Fields

• id :: Maybe Text

  The identifier of this RequestValidator.

• name :: Maybe Text

  The name of this RequestValidator

• validateRequestBody :: Maybe Bool

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

• validateRequestParameters :: Maybe Bool

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

Instances

FromJSON RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

parseJSON :: Value -> Parser RequestValidator

parseJSONList :: Value -> Parser [RequestValidator]

Generic RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Associated Types

type Rep RequestValidator :: Type -> Type

Methods

from :: RequestValidator -> Rep RequestValidator x

to :: Rep RequestValidator x -> RequestValidator

Read RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

readsPrec :: Int -> ReadS RequestValidator

readList :: ReadS [RequestValidator]

readPrec :: ReadPrec RequestValidator

readListPrec :: ReadPrec [RequestValidator]

Show RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

showsPrec :: Int -> RequestValidator -> ShowS

show :: RequestValidator -> String

showList :: [RequestValidator] -> ShowS

NFData RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

rnf :: RequestValidator -> ()

Eq RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

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

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

Hashable RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

Methods

hashWithSalt :: Int -> RequestValidator -> Int

hash :: RequestValidator -> Int

type Rep RequestValidator

Defined in Amazonka.APIGateway.Types.RequestValidator

type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newRequestValidator :: RequestValidator

Create a value of RequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator

$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

requestValidator_id :: Lens' RequestValidator (Maybe Text)

The identifier of this RequestValidator.

requestValidator_name :: Lens' RequestValidator (Maybe Text)

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool)

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

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool)

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