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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all the usage plans of the caller's account.

This operation returns paginated results.

Synopsis

Creating a Request

getUsagePlans :: GetUsagePlans Source #

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

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

gupKeyId - The identifier of the API key associated with the usage plans.
gupLimit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
gupPosition - The current pagination position in the paged result set.

data GetUsagePlans Source #

The GET request to get all the usage plans of the caller's account.

See: getUsagePlans smart constructor.

Instances

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

Request Lenses

gupKeyId :: Lens' GetUsagePlans (Maybe Text) Source #

The identifier of the API key associated with the usage plans.

gupLimit :: Lens' GetUsagePlans (Maybe Int) Source #

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

gupPosition :: Lens' GetUsagePlans (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

getUsagePlansResponse Source #

Arguments

:: Int	`guprsResponseStatus`
-> GetUsagePlansResponse

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

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

guprsItems - The current page of elements from this collection.
guprsPosition - Undocumented member.
guprsResponseStatus - -- | The response status code.

data GetUsagePlansResponse Source #

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans

See: getUsagePlansResponse smart constructor.

Instances

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

Response Lenses

guprsItems :: Lens' GetUsagePlansResponse [UsagePlan] Source #

The current page of elements from this collection.

guprsPosition :: Lens' GetUsagePlansResponse (Maybe Text) Source #

Undocumented member.

guprsResponseStatus :: Lens' GetUsagePlansResponse Int Source #

- | The response status code.