amazonka-apigateway-1.6.1: Amazon API Gateway SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.GetModels

Contents

Description

Describes existing Models defined for a RestApi resource.

This operation returns paginated results.

Synopsis

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

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

Show GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

Generic GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

Associated Types

type Rep GetModels :: Type -> Type #

Hashable GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

AWSPager GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

AWSRequest GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

Associated Types

type Rs GetModels :: Type #

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

ToQuery GetModels Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

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

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 #

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:

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

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

Show GetModelsResponse Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

Generic GetModelsResponse Source # 
Instance details

Defined in Network.AWS.APIGateway.GetModels

Associated Types

type Rep GetModelsResponse :: Type -> Type #

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.

gmrsResponseStatus :: Lens' GetModelsResponse Int Source #

  • - | The response status code.