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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a RequestValidator of a given RestApi.

Synopsis

data UpdateRequestValidator = UpdateRequestValidator' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- requestValidatorId :: Text
}
newUpdateRequestValidator :: Text -> Text -> UpdateRequestValidator
updateRequestValidator_patchOperations :: Lens' UpdateRequestValidator (Maybe [PatchOperation])
updateRequestValidator_restApiId :: Lens' UpdateRequestValidator Text
updateRequestValidator_requestValidatorId :: Lens' UpdateRequestValidator 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 UpdateRequestValidator Source #

Updates a RequestValidator of a given RestApi.

See: newUpdateRequestValidator smart constructor.

Constructors

UpdateRequestValidator'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. restApiId :: Text Required The string identifier of the associated RestApi. requestValidatorId :: Text Required The identifier of RequestValidator to be updated.

Instances

Instances details

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

newUpdateRequestValidator Source #

Arguments

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

Create a value of UpdateRequestValidator 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:patchOperations:UpdateRequestValidator', updateRequestValidator_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

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

$sel:requestValidatorId:UpdateRequestValidator', updateRequestValidator_requestValidatorId - [Required] The identifier of RequestValidator to be updated.

Request Lenses

updateRequestValidator_patchOperations :: Lens' UpdateRequestValidator (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateRequestValidator_restApiId :: Lens' UpdateRequestValidator Text Source #

Required: The string identifier of the associated RestApi.

updateRequestValidator_requestValidatorId :: Lens' UpdateRequestValidator Text Source #

Required: The identifier of RequestValidator to be updated.

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.