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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a usage plan key of a given key identifier.

Synopsis

getUsagePlanKey :: Text -> Text -> GetUsagePlanKey
data GetUsagePlanKey
gUsagePlanId :: Lens' GetUsagePlanKey Text
gKeyId :: Lens' GetUsagePlanKey Text
usagePlanKey :: UsagePlanKey
data UsagePlanKey
upkValue :: Lens' UsagePlanKey (Maybe Text)
upkName :: Lens' UsagePlanKey (Maybe Text)
upkId :: Lens' UsagePlanKey (Maybe Text)
upkType :: Lens' UsagePlanKey (Maybe Text)

Creating a Request

getUsagePlanKey Source #

Arguments

:: Text	`gUsagePlanId`
-> Text	`gKeyId`
-> GetUsagePlanKey

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

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

gUsagePlanId - [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
gKeyId - [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

data GetUsagePlanKey Source #

The GET request to get a usage plan key of a given key identifier.

See: getUsagePlanKey smart constructor.

Instances

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

Request Lenses

gUsagePlanId :: Lens' GetUsagePlanKey Text Source #

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

gKeyId :: Lens' GetUsagePlanKey Text Source #

Required: The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Destructuring the Response

usagePlanKey :: UsagePlanKey Source #

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

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

upkValue - The value of a usage plan key.
upkName - The name of a usage plan key.
upkId - The Id of a usage plan key.
upkType - The type of a usage plan key. Currently, the valid key type is API_KEY .

data UsagePlanKey Source #

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey .

" Create and Use Usage Plans

See: usagePlanKey smart constructor.

Instances

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

Response Lenses

upkValue :: Lens' UsagePlanKey (Maybe Text) Source #

The value of a usage plan key.

upkName :: Lens' UsagePlanKey (Maybe Text) Source #

The name of a usage plan key.

upkId :: Lens' UsagePlanKey (Maybe Text) Source #

The Id of a usage plan key.

upkType :: Lens' UsagePlanKey (Maybe Text) Source #

The type of a usage plan key. Currently, the valid key type is API_KEY .