Network.AWS.APIGateway.GetUsagePlanKey

Gets a usage plan key of a given key identifier.

Creating a Request

getUsagePlanKey

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 - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
• gKeyId - The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

data GetUsagePlanKey

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

See: getUsagePlanKey smart constructor.

Instances

Eq GetUsagePlanKey

Methods

(==) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool

(/=) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS GetUsagePlanKey

readList :: ReadS [GetUsagePlanKey]

readPrec :: ReadPrec GetUsagePlanKey

readListPrec :: ReadPrec [GetUsagePlanKey]

Show GetUsagePlanKey

Methods

showsPrec :: Int -> GetUsagePlanKey -> ShowS

show :: GetUsagePlanKey -> String

showList :: [GetUsagePlanKey] -> ShowS

Generic GetUsagePlanKey

Associated Types

type Rep GetUsagePlanKey :: * -> *

Methods

from :: GetUsagePlanKey -> Rep GetUsagePlanKey x

to :: Rep GetUsagePlanKey x -> GetUsagePlanKey

Hashable GetUsagePlanKey

Methods

hashWithSalt :: Int -> GetUsagePlanKey -> Int

hash :: GetUsagePlanKey -> Int

NFData GetUsagePlanKey

Methods

rnf :: GetUsagePlanKey -> ()

AWSRequest GetUsagePlanKey

Associated Types

type Rs GetUsagePlanKey :: *

Methods

request :: GetUsagePlanKey -> Request GetUsagePlanKey

response :: MonadResource m => Logger -> Service -> Proxy * GetUsagePlanKey -> ClientResponse -> m (Response GetUsagePlanKey)

ToQuery GetUsagePlanKey

Methods

toQuery :: GetUsagePlanKey -> QueryString

ToPath GetUsagePlanKey

Methods

toPath :: GetUsagePlanKey -> ByteString

ToHeaders GetUsagePlanKey

Methods

toHeaders :: GetUsagePlanKey -> [Header]

type Rep GetUsagePlanKey

type Rep GetUsagePlanKey = D1 (MetaData "GetUsagePlanKey" "Network.AWS.APIGateway.GetUsagePlanKey" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GetUsagePlanKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_gKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetUsagePlanKey

type Rs GetUsagePlanKey = UsagePlanKey

Request Lenses

gUsagePlanId :: Lens' GetUsagePlanKey Text

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

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

Destructuring the Response

usagePlanKey :: UsagePlanKey

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

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

Methods

(==) :: UsagePlanKey -> UsagePlanKey -> Bool

(/=) :: UsagePlanKey -> UsagePlanKey -> Bool

Data UsagePlanKey

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

Methods

readsPrec :: Int -> ReadS UsagePlanKey

readList :: ReadS [UsagePlanKey]

readPrec :: ReadPrec UsagePlanKey

readListPrec :: ReadPrec [UsagePlanKey]

Show UsagePlanKey

Methods

showsPrec :: Int -> UsagePlanKey -> ShowS

show :: UsagePlanKey -> String

showList :: [UsagePlanKey] -> ShowS

Generic UsagePlanKey

Associated Types

type Rep UsagePlanKey :: * -> *

Methods

from :: UsagePlanKey -> Rep UsagePlanKey x

to :: Rep UsagePlanKey x -> UsagePlanKey

Hashable UsagePlanKey

Methods

hashWithSalt :: Int -> UsagePlanKey -> Int

hash :: UsagePlanKey -> Int

FromJSON UsagePlanKey

Methods

parseJSON :: Value -> Parser UsagePlanKey

parseJSONList :: Value -> Parser [UsagePlanKey]

NFData UsagePlanKey

Methods

rnf :: UsagePlanKey -> ()

type Rep UsagePlanKey

type Rep UsagePlanKey = D1 (MetaData "UsagePlanKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "UsagePlanKey'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upkValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

upkValue :: Lens' UsagePlanKey (Maybe Text)

The value of a usage plan key.

upkName :: Lens' UsagePlanKey (Maybe Text)

The name of a usage plan key.

upkId :: Lens' UsagePlanKey (Maybe Text)

The Id of a usage plan key.

upkType :: Lens' UsagePlanKey (Maybe Text)

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