amazonka-apigateway-1.6.0: 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.GetRestAPIs

Contents

Description

Lists the RestApis resources for your collection.

This operation returns paginated results.

Synopsis

Creating a Request

getRestAPIs :: GetRestAPIs Source #

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

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

  • graLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
  • graPosition - The current pagination position in the paged result set.

data GetRestAPIs Source #

The GET request to list existing RestApis defined for your collection.

See: getRestAPIs smart constructor.

Instances

Eq GetRestAPIs Source # 
Data GetRestAPIs Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRestAPIs -> c GetRestAPIs #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRestAPIs #

toConstr :: GetRestAPIs -> Constr #

dataTypeOf :: GetRestAPIs -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRestAPIs) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRestAPIs) #

gmapT :: (forall b. Data b => b -> b) -> GetRestAPIs -> GetRestAPIs #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRestAPIs -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRestAPIs -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetRestAPIs -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRestAPIs -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRestAPIs -> m GetRestAPIs #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRestAPIs -> m GetRestAPIs #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRestAPIs -> m GetRestAPIs #

Read GetRestAPIs Source # 
Show GetRestAPIs Source # 
Generic GetRestAPIs Source # 

Associated Types

type Rep GetRestAPIs :: * -> * #

Hashable GetRestAPIs Source # 
NFData GetRestAPIs Source # 

Methods

rnf :: GetRestAPIs -> () #

AWSPager GetRestAPIs Source # 
AWSRequest GetRestAPIs Source # 
ToHeaders GetRestAPIs Source # 

Methods

toHeaders :: GetRestAPIs -> [Header] #

ToPath GetRestAPIs Source # 
ToQuery GetRestAPIs Source # 
type Rep GetRestAPIs Source # 
type Rep GetRestAPIs = D1 * (MetaData "GetRestAPIs" "Network.AWS.APIGateway.GetRestAPIs" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetRestAPIs'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_graLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_graPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))))
type Rs GetRestAPIs Source # 

Request Lenses

graLimit :: Lens' GetRestAPIs (Maybe Int) Source #

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

graPosition :: Lens' GetRestAPIs (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

getRestAPIsResponse Source #

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

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

data GetRestAPIsResponse Source #

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

Create an API

See: getRestAPIsResponse smart constructor.

Instances

Eq GetRestAPIsResponse Source # 
Data GetRestAPIsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetRestAPIsResponse -> c GetRestAPIsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetRestAPIsResponse #

toConstr :: GetRestAPIsResponse -> Constr #

dataTypeOf :: GetRestAPIsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetRestAPIsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetRestAPIsResponse) #

gmapT :: (forall b. Data b => b -> b) -> GetRestAPIsResponse -> GetRestAPIsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetRestAPIsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetRestAPIsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GetRestAPIsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetRestAPIsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetRestAPIsResponse -> m GetRestAPIsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRestAPIsResponse -> m GetRestAPIsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetRestAPIsResponse -> m GetRestAPIsResponse #

Read GetRestAPIsResponse Source # 
Show GetRestAPIsResponse Source # 
Generic GetRestAPIsResponse Source # 
NFData GetRestAPIsResponse Source # 

Methods

rnf :: GetRestAPIsResponse -> () #

type Rep GetRestAPIsResponse Source # 
type Rep GetRestAPIsResponse = D1 * (MetaData "GetRestAPIsResponse" "Network.AWS.APIGateway.GetRestAPIs" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "GetRestAPIsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_grarsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [RestAPI]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_grarsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_grarsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

grarsItems :: Lens' GetRestAPIsResponse [RestAPI] Source #

The current page of elements from this collection.

grarsResponseStatus :: Lens' GetRestAPIsResponse Int Source #

  • - | The response status code.