Copyright	(c) 2013-2021 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

Amazonka.APIGateway.CreateRequestValidator

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a ReqeustValidator of a given RestApi.

Synopsis

data CreateRequestValidator = CreateRequestValidator' {
- validateRequestParameters :: Maybe Bool
- name :: Maybe Text
- validateRequestBody :: Maybe Bool
- restApiId :: Text
}
newCreateRequestValidator :: Text -> CreateRequestValidator
createRequestValidator_validateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool)
createRequestValidator_name :: Lens' CreateRequestValidator (Maybe Text)
createRequestValidator_validateRequestBody :: Lens' CreateRequestValidator (Maybe Bool)
createRequestValidator_restApiId :: Lens' CreateRequestValidator Text
data RequestValidator = RequestValidator' {
- validateRequestParameters :: Maybe Bool
- name :: Maybe Text
- validateRequestBody :: Maybe Bool
- id :: Maybe Text
}
newRequestValidator :: RequestValidator
requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool)
requestValidator_name :: Lens' RequestValidator (Maybe Text)
requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool)
requestValidator_id :: Lens' RequestValidator (Maybe Text)

Creating a Request

data CreateRequestValidator Source #

Creates a RequestValidator of a given RestApi.

See: newCreateRequestValidator smart constructor.

Constructors

CreateRequestValidator'

Fields

validateRequestParameters :: Maybe Bool
A Boolean flag to indicate whether to validate request parameters, true, or not false.
name :: Maybe Text
The name of the to-be-created RequestValidator.
validateRequestBody :: 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).
restApiId :: Text
Required
The string identifier of the associated RestApi.

Instances

Instances details

Eq CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods (==) :: CreateRequestValidator -> CreateRequestValidator -> Bool # (/=) :: CreateRequestValidator -> CreateRequestValidator -> Bool #
Read CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods readsPrec :: Int -> ReadS CreateRequestValidator # readList :: ReadS [CreateRequestValidator] # readPrec :: ReadPrec CreateRequestValidator # readListPrec :: ReadPrec [CreateRequestValidator] #
Show CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods showsPrec :: Int -> CreateRequestValidator -> ShowS # show :: CreateRequestValidator -> String # showList :: [CreateRequestValidator] -> ShowS #
Generic CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Associated Types type Rep CreateRequestValidator :: Type -> Type # Methods from :: CreateRequestValidator -> Rep CreateRequestValidator x # to :: Rep CreateRequestValidator x -> CreateRequestValidator #
NFData CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods rnf :: CreateRequestValidator -> () #
Hashable CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods hashWithSalt :: Int -> CreateRequestValidator -> Int # hash :: CreateRequestValidator -> Int #
ToJSON CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toJSON :: CreateRequestValidator -> Value # toEncoding :: CreateRequestValidator -> Encoding # toJSONList :: [CreateRequestValidator] -> Value # toEncodingList :: [CreateRequestValidator] -> Encoding #
AWSRequest CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Associated Types type AWSResponse CreateRequestValidator # Methods request :: CreateRequestValidator -> Request CreateRequestValidator # response :: MonadResource m => Logger -> Service -> Proxy CreateRequestValidator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRequestValidator))) #
ToHeaders CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toHeaders :: CreateRequestValidator -> [Header] #
ToPath CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toPath :: CreateRequestValidator -> ByteString #
ToQuery CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toQuery :: CreateRequestValidator -> QueryString #
type Rep CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator type Rep CreateRequestValidator = D1 ('MetaData "CreateRequestValidator" "Amazonka.APIGateway.CreateRequestValidator" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "CreateRequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator type AWSResponse CreateRequestValidator = RequestValidator

newCreateRequestValidator Source #

Arguments

:: Text	`$sel:restApiId:CreateRequestValidator'`
-> CreateRequestValidator

Create a value of CreateRequestValidator 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:validateRequestParameters:CreateRequestValidator', createRequestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters, true, or not false.

$sel:name:CreateRequestValidator', createRequestValidator_name - The name of the to-be-created RequestValidator.

$sel:validateRequestBody:CreateRequestValidator', createRequestValidator_validateRequestBody - A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

$sel:restApiId:CreateRequestValidator', createRequestValidator_restApiId - [Required] The string identifier of the associated RestApi.

Request Lenses

createRequestValidator_validateRequestParameters :: Lens' CreateRequestValidator (Maybe Bool) Source #

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

createRequestValidator_name :: Lens' CreateRequestValidator (Maybe Text) Source #

The name of the to-be-created RequestValidator.

createRequestValidator_validateRequestBody :: Lens' CreateRequestValidator (Maybe Bool) Source #

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

createRequestValidator_restApiId :: Lens' CreateRequestValidator Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data RequestValidator Source #

A set of validation rules for incoming Method requests.

In OpenAPI, 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: newRequestValidator smart constructor.

Constructors

RequestValidator'
Fields validateRequestParameters :: Maybe Bool A Boolean flag to indicate whether to validate request parameters (`true`) or not (`false`). 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. id :: Maybe Text The identifier of this RequestValidator.

Instances

Instances details

Eq RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Read RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
Generic RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Associated Types type Rep RequestValidator :: Type -> Type # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
NFData RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods rnf :: RequestValidator -> () #
Hashable RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
FromJSON RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
type Rep RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newRequestValidator :: RequestValidator Source #

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:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

$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:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

Response Lenses

requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #

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

requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #

The name of this RequestValidator

requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #

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

requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #

The identifier of this RequestValidator.