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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a RequestValidator of a given RestApi.

Creating a Request

data GetRequestValidator Source #

Gets a RequestValidator of a given RestApi.

See: newGetRequestValidator smart constructor.

Constructors

GetRequestValidator'
Fields restApiId :: Text Required The string identifier of the associated RestApi. requestValidatorId :: Text Required The identifier of the RequestValidator to be retrieved.

Instances

Instances details

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

newGetRequestValidator Source #

Arguments

:: Text	`$sel:restApiId:GetRequestValidator'`
-> Text	`$sel:requestValidatorId:GetRequestValidator'`
-> GetRequestValidator

Create a value of GetRequestValidator 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:restApiId:GetRequestValidator', getRequestValidator_restApiId - [Required] The string identifier of the associated RestApi.

$sel:requestValidatorId:GetRequestValidator', getRequestValidator_requestValidatorId - [Required] The identifier of the RequestValidator to be retrieved.

Request Lenses

getRequestValidator_restApiId :: Lens' GetRequestValidator Text Source #

Required: The string identifier of the associated RestApi.

getRequestValidator_requestValidatorId :: Lens' GetRequestValidator Text Source #

Required: The identifier of the RequestValidator to be retrieved.

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.