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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the RequestValidators collection of a given RestApi.

This operation returns paginated results.

Synopsis

data GetRequestValidators = GetRequestValidators' {
- limit :: Maybe Int
- position :: Maybe Text
- restApiId :: Text
}
newGetRequestValidators :: Text -> GetRequestValidators
getRequestValidators_limit :: Lens' GetRequestValidators (Maybe Int)
getRequestValidators_position :: Lens' GetRequestValidators (Maybe Text)
getRequestValidators_restApiId :: Lens' GetRequestValidators Text
data GetRequestValidatorsResponse = GetRequestValidatorsResponse' {
- items :: Maybe [RequestValidator]
- position :: Maybe Text
- httpStatus :: Int
}
newGetRequestValidatorsResponse :: Int -> GetRequestValidatorsResponse
getRequestValidatorsResponse_items :: Lens' GetRequestValidatorsResponse (Maybe [RequestValidator])
getRequestValidatorsResponse_position :: Lens' GetRequestValidatorsResponse (Maybe Text)
getRequestValidatorsResponse_httpStatus :: Lens' GetRequestValidatorsResponse Int

Creating a Request

data GetRequestValidators Source #

Gets the RequestValidators collection of a given RestApi.

See: newGetRequestValidators smart constructor.

Constructors

GetRequestValidators'
Fields limit :: Maybe Int The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text The current pagination position in the paged result set. restApiId :: Text Required The string identifier of the associated RestApi.

Instances

Instances details

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

newGetRequestValidators Source #

Arguments

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

Create a value of GetRequestValidators 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:limit:GetRequestValidators', getRequestValidators_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetRequestValidators', getRequestValidators_position - The current pagination position in the paged result set.

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

Request Lenses

getRequestValidators_limit :: Lens' GetRequestValidators (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getRequestValidators_position :: Lens' GetRequestValidators (Maybe Text) Source #

The current pagination position in the paged result set.

getRequestValidators_restApiId :: Lens' GetRequestValidators Text Source #

Required: The string identifier of the associated RestApi.

Destructuring the Response

data GetRequestValidatorsResponse Source #

A collection of RequestValidator resources of a given RestApi.

In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.

Enable Basic Request Validation in API Gateway

See: newGetRequestValidatorsResponse smart constructor.

Constructors

GetRequestValidatorsResponse'
Fields items :: Maybe [RequestValidator] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods (==) :: GetRequestValidatorsResponse -> GetRequestValidatorsResponse -> Bool # (/=) :: GetRequestValidatorsResponse -> GetRequestValidatorsResponse -> Bool #
Read GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods readsPrec :: Int -> ReadS GetRequestValidatorsResponse # readList :: ReadS [GetRequestValidatorsResponse] # readPrec :: ReadPrec GetRequestValidatorsResponse # readListPrec :: ReadPrec [GetRequestValidatorsResponse] #
Show GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods showsPrec :: Int -> GetRequestValidatorsResponse -> ShowS # show :: GetRequestValidatorsResponse -> String # showList :: [GetRequestValidatorsResponse] -> ShowS #
Generic GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Associated Types type Rep GetRequestValidatorsResponse :: Type -> Type # Methods from :: GetRequestValidatorsResponse -> Rep GetRequestValidatorsResponse x # to :: Rep GetRequestValidatorsResponse x -> GetRequestValidatorsResponse #
NFData GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods rnf :: GetRequestValidatorsResponse -> () #
type Rep GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators type Rep GetRequestValidatorsResponse = D1 ('MetaData "GetRequestValidatorsResponse" "Amazonka.APIGateway.GetRequestValidators" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetRequestValidatorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequestValidator])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRequestValidatorsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRequestValidatorsResponse'`
-> GetRequestValidatorsResponse

Create a value of GetRequestValidatorsResponse 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:items:GetRequestValidatorsResponse', getRequestValidatorsResponse_items - The current page of elements from this collection.

$sel:position:GetRequestValidators', getRequestValidatorsResponse_position - Undocumented member.

$sel:httpStatus:GetRequestValidatorsResponse', getRequestValidatorsResponse_httpStatus - The response's http status code.

Response Lenses

getRequestValidatorsResponse_items :: Lens' GetRequestValidatorsResponse (Maybe [RequestValidator]) Source #

The current page of elements from this collection.

getRequestValidatorsResponse_position :: Lens' GetRequestValidatorsResponse (Maybe Text) Source #

Undocumented member.

getRequestValidatorsResponse_httpStatus :: Lens' GetRequestValidatorsResponse Int Source #

The response's http status code.