Copyright	(c) 2013-2021 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

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

data GetUsagePlanKey = GetUsagePlanKey' {
- usagePlanId :: Text
- keyId :: Text
}
newGetUsagePlanKey :: Text -> Text -> GetUsagePlanKey
getUsagePlanKey_usagePlanId :: Lens' GetUsagePlanKey Text
getUsagePlanKey_keyId :: Lens' GetUsagePlanKey Text
data UsagePlanKey = UsagePlanKey' {
- value :: Maybe Text
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe Text
}
newUsagePlanKey :: UsagePlanKey
usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text)
usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text)

Creating a Request

data GetUsagePlanKey Source #

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

See: newGetUsagePlanKey smart constructor.

Constructors

GetUsagePlanKey'
Fields usagePlanId :: Text Required The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer. keyId :: Text Required The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Instances

Instances details

Eq GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods (==) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool # (/=) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool #
Read GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods readsPrec :: Int -> ReadS GetUsagePlanKey # readList :: ReadS [GetUsagePlanKey] # readPrec :: ReadPrec GetUsagePlanKey # readListPrec :: ReadPrec [GetUsagePlanKey] #
Show GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods showsPrec :: Int -> GetUsagePlanKey -> ShowS # show :: GetUsagePlanKey -> String # showList :: [GetUsagePlanKey] -> ShowS #
Generic GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Associated Types type Rep GetUsagePlanKey :: Type -> Type # Methods from :: GetUsagePlanKey -> Rep GetUsagePlanKey x # to :: Rep GetUsagePlanKey x -> GetUsagePlanKey #
NFData GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods rnf :: GetUsagePlanKey -> () #
Hashable GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods hashWithSalt :: Int -> GetUsagePlanKey -> Int # hash :: GetUsagePlanKey -> Int #
AWSRequest GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Associated Types type AWSResponse GetUsagePlanKey # Methods request :: GetUsagePlanKey -> Request GetUsagePlanKey # response :: MonadResource m => Logger -> Service -> Proxy GetUsagePlanKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlanKey))) #
ToHeaders GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toHeaders :: GetUsagePlanKey -> [Header] #
ToPath GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toPath :: GetUsagePlanKey -> ByteString #
ToQuery GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toQuery :: GetUsagePlanKey -> QueryString #
type Rep GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey type Rep GetUsagePlanKey = D1 ('MetaData "GetUsagePlanKey" "Amazonka.APIGateway.GetUsagePlanKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetUsagePlanKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey type AWSResponse GetUsagePlanKey = UsagePlanKey

newGetUsagePlanKey Source #

Arguments

:: Text	`$sel:usagePlanId:GetUsagePlanKey'`
-> Text	`$sel:keyId:GetUsagePlanKey'`
-> GetUsagePlanKey

Create a value of GetUsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:usagePlanId:GetUsagePlanKey', getUsagePlanKey_usagePlanId - [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

$sel:keyId:GetUsagePlanKey', getUsagePlanKey_keyId - [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Request Lenses

getUsagePlanKey_usagePlanId :: 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.

getUsagePlanKey_keyId :: Lens' GetUsagePlanKey Text Source #

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

Destructuring the Response

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: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey'
Fields value :: Maybe Text The value of a usage plan key. name :: Maybe Text The name of a usage plan key. id :: Maybe Text The Id of a usage plan key. type' :: Maybe Text The type of a usage plan key. Currently, the valid key type is `API_KEY`.

Instances

Instances details

Eq UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods (==) :: UsagePlanKey -> UsagePlanKey -> Bool # (/=) :: UsagePlanKey -> UsagePlanKey -> Bool #
Read UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods readsPrec :: Int -> ReadS UsagePlanKey # readList :: ReadS [UsagePlanKey] # readPrec :: ReadPrec UsagePlanKey # readListPrec :: ReadPrec [UsagePlanKey] #
Show UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods showsPrec :: Int -> UsagePlanKey -> ShowS # show :: UsagePlanKey -> String # showList :: [UsagePlanKey] -> ShowS #
Generic UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Associated Types type Rep UsagePlanKey :: Type -> Type # Methods from :: UsagePlanKey -> Rep UsagePlanKey x # to :: Rep UsagePlanKey x -> UsagePlanKey #
NFData UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods rnf :: UsagePlanKey -> () #
Hashable UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods hashWithSalt :: Int -> UsagePlanKey -> Int # hash :: UsagePlanKey -> Int #
FromJSON UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods parseJSON :: Value -> Parser UsagePlanKey # parseJSONList :: Value -> Parser [UsagePlanKey] #
type Rep UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey type Rep UsagePlanKey = D1 ('MetaData "UsagePlanKey" "Amazonka.APIGateway.Types.UsagePlanKey" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UsagePlanKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUsagePlanKey :: UsagePlanKey Source #

Create a value of UsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.

$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is API_KEY.

Response Lenses

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

The value of a usage plan key.

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

The name of a usage plan key.

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

The Id of a usage plan key.

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

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