Copyright	(c) 2013-2018 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
Language	Haskell2010

Network.AWS.APIGateway.GetModels

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes existing Models defined for a RestApi resource.

This operation returns paginated results.

Synopsis

getModels :: Text -> GetModels
data GetModels
gmsLimit :: Lens' GetModels (Maybe Int)
gmsPosition :: Lens' GetModels (Maybe Text)
gmsRestAPIId :: Lens' GetModels Text
getModelsResponse :: Int -> GetModelsResponse
data GetModelsResponse
gmrsItems :: Lens' GetModelsResponse [Model]
gmrsPosition :: Lens' GetModelsResponse (Maybe Text)
gmrsResponseStatus :: Lens' GetModelsResponse Int

Creating a Request

getModels Source #

Arguments

:: Text	`gmsRestAPIId`
-> GetModels

Creates a value of GetModels with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gmsLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
gmsPosition - The current pagination position in the paged result set.
gmsRestAPIId - [Required] The string identifier of the associated RestApi .

data GetModels Source #

Request to list existing Models defined for a RestApi resource.

See: getModels smart constructor.

Instances

Eq GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods (==) :: GetModels -> GetModels -> Bool # (/=) :: GetModels -> GetModels -> Bool #
Data GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetModels -> c GetModels # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetModels # toConstr :: GetModels -> Constr # dataTypeOf :: GetModels -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetModels) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetModels) # gmapT :: (forall b. Data b => b -> b) -> GetModels -> GetModels # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetModels -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetModels -> r # gmapQ :: (forall d. Data d => d -> u) -> GetModels -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetModels -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetModels -> m GetModels # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModels -> m GetModels # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModels -> m GetModels #
Read GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods readsPrec :: Int -> ReadS GetModels # readList :: ReadS [GetModels] # readPrec :: ReadPrec GetModels # readListPrec :: ReadPrec [GetModels] #
Show GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods showsPrec :: Int -> GetModels -> ShowS # show :: GetModels -> String # showList :: [GetModels] -> ShowS #
Generic GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Associated Types type Rep GetModels :: Type -> Type # Methods from :: GetModels -> Rep GetModels x # to :: Rep GetModels x -> GetModels #
Hashable GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods hashWithSalt :: Int -> GetModels -> Int # hash :: GetModels -> Int #
AWSPager GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods page :: GetModels -> Rs GetModels -> Maybe GetModels #
AWSRequest GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Associated Types type Rs GetModels :: Type # Methods request :: GetModels -> Request GetModels # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetModels -> ClientResponse -> m (Response GetModels) #
ToHeaders GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods toHeaders :: GetModels -> [Header] #
ToPath GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods toPath :: GetModels -> ByteString #
ToQuery GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods toQuery :: GetModels -> QueryString #
NFData GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods rnf :: GetModels -> () #
type Rep GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels type Rep GetModels = D1 (MetaData "GetModels" "Network.AWS.APIGateway.GetModels" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetModels'" PrefixI True) (S1 (MetaSel (Just "_gmsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)) :: (S1 (MetaSel (Just "_gmsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gmsRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs GetModels Source #
Instance details Defined in Network.AWS.APIGateway.GetModels type Rs GetModels = GetModelsResponse

Request Lenses

gmsLimit :: Lens' GetModels (Maybe Int) Source #

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

gmsPosition :: Lens' GetModels (Maybe Text) Source #

The current pagination position in the paged result set.

gmsRestAPIId :: Lens' GetModels Text Source #

Required: The string identifier of the associated RestApi .

Destructuring the Response

getModelsResponse Source #

Arguments

:: Int	`gmrsResponseStatus`
-> GetModelsResponse

Creates a value of GetModelsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gmrsItems - The current page of elements from this collection.
gmrsPosition - Undocumented member.
gmrsResponseStatus - -- | The response status code.

data GetModelsResponse Source #

Represents a collection of Model resources.

Method , MethodResponse , Models and Mappings

See: getModelsResponse smart constructor.

Instances

Eq GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods (==) :: GetModelsResponse -> GetModelsResponse -> Bool # (/=) :: GetModelsResponse -> GetModelsResponse -> Bool #
Data GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetModelsResponse -> c GetModelsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetModelsResponse # toConstr :: GetModelsResponse -> Constr # dataTypeOf :: GetModelsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetModelsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetModelsResponse) # gmapT :: (forall b. Data b => b -> b) -> GetModelsResponse -> GetModelsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetModelsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetModelsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetModelsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetModelsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetModelsResponse -> m GetModelsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModelsResponse -> m GetModelsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetModelsResponse -> m GetModelsResponse #
Read GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods readsPrec :: Int -> ReadS GetModelsResponse # readList :: ReadS [GetModelsResponse] # readPrec :: ReadPrec GetModelsResponse # readListPrec :: ReadPrec [GetModelsResponse] #
Show GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods showsPrec :: Int -> GetModelsResponse -> ShowS # show :: GetModelsResponse -> String # showList :: [GetModelsResponse] -> ShowS #
Generic GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Associated Types type Rep GetModelsResponse :: Type -> Type # Methods from :: GetModelsResponse -> Rep GetModelsResponse x # to :: Rep GetModelsResponse x -> GetModelsResponse #
NFData GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels Methods rnf :: GetModelsResponse -> () #
type Rep GetModelsResponse Source #
Instance details Defined in Network.AWS.APIGateway.GetModels type Rep GetModelsResponse = D1 (MetaData "GetModelsResponse" "Network.AWS.APIGateway.GetModels" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetModelsResponse'" PrefixI True) (S1 (MetaSel (Just "_gmrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Model])) :: (S1 (MetaSel (Just "_gmrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_gmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gmrsItems :: Lens' GetModelsResponse [Model] Source #

The current page of elements from this collection.

gmrsPosition :: Lens' GetModelsResponse (Maybe Text) Source #

Undocumented member.

gmrsResponseStatus :: Lens' GetModelsResponse Int Source #

- | The response status code.