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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Creating a Request

getUsagePlanKeys #

Arguments

:: Text	`gupkUsagePlanId`
-> 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 - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
gupkPosition - The current pagination position in the paged result set.
gupkUsagePlanId - [Required] 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 #
Methods (==) :: GetUsagePlanKeys -> GetUsagePlanKeys -> Bool # (/=) :: GetUsagePlanKeys -> GetUsagePlanKeys -> Bool #
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 #
Methods readsPrec :: Int -> ReadS GetUsagePlanKeys # readList :: ReadS [GetUsagePlanKeys] # readPrec :: ReadPrec GetUsagePlanKeys # readListPrec :: ReadPrec [GetUsagePlanKeys] #
Show GetUsagePlanKeys #
Methods showsPrec :: Int -> GetUsagePlanKeys -> ShowS # show :: GetUsagePlanKeys -> String # showList :: [GetUsagePlanKeys] -> ShowS #
Generic GetUsagePlanKeys #
Associated Types type Rep GetUsagePlanKeys :: * -> * # Methods from :: GetUsagePlanKeys -> Rep GetUsagePlanKeys x # to :: Rep GetUsagePlanKeys x -> GetUsagePlanKeys #
Hashable GetUsagePlanKeys #
Methods hashWithSalt :: Int -> GetUsagePlanKeys -> Int # hash :: GetUsagePlanKeys -> Int #
NFData GetUsagePlanKeys #
Methods rnf :: GetUsagePlanKeys -> () #
AWSPager GetUsagePlanKeys #
Methods page :: GetUsagePlanKeys -> Rs GetUsagePlanKeys -> Maybe GetUsagePlanKeys #
AWSRequest GetUsagePlanKeys #
Associated Types type Rs GetUsagePlanKeys :: * # Methods request :: GetUsagePlanKeys -> Request GetUsagePlanKeys # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetUsagePlanKeys -> ClientResponse -> m (Response GetUsagePlanKeys) #
ToHeaders GetUsagePlanKeys #
Methods toHeaders :: GetUsagePlanKeys -> [Header] #
ToPath GetUsagePlanKeys #
Methods toPath :: GetUsagePlanKeys -> ByteString #
ToQuery GetUsagePlanKeys #
Methods toQuery :: GetUsagePlanKeys -> QueryString #
type Rep GetUsagePlanKeys #
type Rep GetUsagePlanKeys = D1 * (MetaData "GetUsagePlanKeys" "Network.AWS.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" 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 #
type Rs GetUsagePlanKeys = GetUsagePlanKeysResponse

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) #

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

gupkPosition :: Lens' GetUsagePlanKeys (Maybe Text) #

The current pagination position in the paged result set.

gupkUsagePlanId :: Lens' GetUsagePlanKeys Text #

Required: 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 #

Arguments

:: Int	`gupkrsResponseStatus`
-> 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:

gupkrsItems - The current page of elements from this collection.
gupkrsPosition - Undocumented member.
gupkrsResponseStatus - -- | The response status code.

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 #
Methods (==) :: GetUsagePlanKeysResponse -> GetUsagePlanKeysResponse -> Bool # (/=) :: GetUsagePlanKeysResponse -> GetUsagePlanKeysResponse -> Bool #
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 #
Methods readsPrec :: Int -> ReadS GetUsagePlanKeysResponse # readList :: ReadS [GetUsagePlanKeysResponse] # readPrec :: ReadPrec GetUsagePlanKeysResponse # readListPrec :: ReadPrec [GetUsagePlanKeysResponse] #
Show GetUsagePlanKeysResponse #
Methods showsPrec :: Int -> GetUsagePlanKeysResponse -> ShowS # show :: GetUsagePlanKeysResponse -> String # showList :: [GetUsagePlanKeysResponse] -> ShowS #
Generic GetUsagePlanKeysResponse #
Associated Types type Rep GetUsagePlanKeysResponse :: * -> * # Methods from :: GetUsagePlanKeysResponse -> Rep GetUsagePlanKeysResponse x # to :: Rep GetUsagePlanKeysResponse x -> GetUsagePlanKeysResponse #
NFData GetUsagePlanKeysResponse #
Methods rnf :: GetUsagePlanKeysResponse -> () #
type Rep GetUsagePlanKeysResponse #
type Rep GetUsagePlanKeysResponse = D1 * (MetaData "GetUsagePlanKeysResponse" "Network.AWS.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-1.6.0-6sEXF2HuGsL3K99fRnfViy" 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 DecidedStrict) (Rec0 * Int)))))

Response Lenses

gupkrsItems :: Lens' GetUsagePlanKeysResponse [UsagePlanKey] #

The current page of elements from this collection.

gupkrsPosition :: Lens' GetUsagePlanKeysResponse (Maybe Text) #

Undocumented member.

gupkrsResponseStatus :: Lens' GetUsagePlanKeysResponse Int #

- | The response status code.