amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

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

Network.AWS.APIGateway.GetUsagePlanKeys

Contents

Description

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Synopsis

Creating a Request

getUsagePlanKeys #

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

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

  • gupkNameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.
  • gupkLimit - A query parameter specifying the maximum number usage plan keys returned by the GET request.
  • gupkPosition - A query parameter specifying the zero-based index specifying the position of a usage plan key.
  • gupkUsagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

data GetUsagePlanKeys #

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

See: getUsagePlanKeys smart constructor.

Instances

Eq GetUsagePlanKeys # 
Data GetUsagePlanKeys # 

Methods

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

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

toConstr :: GetUsagePlanKeys -> Constr #

dataTypeOf :: GetUsagePlanKeys -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetUsagePlanKeys # 
Show GetUsagePlanKeys # 
Generic GetUsagePlanKeys # 
Hashable GetUsagePlanKeys # 
NFData GetUsagePlanKeys # 

Methods

rnf :: GetUsagePlanKeys -> () #

AWSRequest GetUsagePlanKeys # 
ToQuery GetUsagePlanKeys # 
ToPath GetUsagePlanKeys # 
ToHeaders GetUsagePlanKeys # 
type Rep GetUsagePlanKeys # 
type Rep GetUsagePlanKeys = D1 (MetaData "GetUsagePlanKeys" "Network.AWS.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetUsagePlanKeys'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gupkNameQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gupkLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_gupkPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gupkUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetUsagePlanKeys # 

Request Lenses

gupkNameQuery :: Lens' GetUsagePlanKeys (Maybe Text) #

A query parameter specifying the name of the to-be-returned usage plan keys.

gupkLimit :: Lens' GetUsagePlanKeys (Maybe Int) #

A query parameter specifying the maximum number usage plan keys returned by the GET request.

gupkPosition :: Lens' GetUsagePlanKeys (Maybe Text) #

A query parameter specifying the zero-based index specifying the position of a usage plan key.

gupkUsagePlanId :: Lens' GetUsagePlanKeys Text #

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Destructuring the Response

getUsagePlanKeysResponse #

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

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

data GetUsagePlanKeysResponse #

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

Create and Use Usage Plans

See: getUsagePlanKeysResponse smart constructor.

Instances

Eq GetUsagePlanKeysResponse # 
Data GetUsagePlanKeysResponse # 

Methods

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

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

toConstr :: GetUsagePlanKeysResponse -> Constr #

dataTypeOf :: GetUsagePlanKeysResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read GetUsagePlanKeysResponse # 
Show GetUsagePlanKeysResponse # 
Generic GetUsagePlanKeysResponse # 
NFData GetUsagePlanKeysResponse # 
type Rep GetUsagePlanKeysResponse # 
type Rep GetUsagePlanKeysResponse = D1 (MetaData "GetUsagePlanKeysResponse" "Network.AWS.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "GetUsagePlanKeysResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gupkrsItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [UsagePlanKey]))) ((:*:) (S1 (MetaSel (Just Symbol "_gupkrsPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gupkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

gupkrsItems :: Lens' GetUsagePlanKeysResponse [UsagePlanKey] #

Gets the current item of the usage plan keys collection.

gupkrsResponseStatus :: Lens' GetUsagePlanKeysResponse Int #

  • - | The response status code.