Amazonka.APIGateway.GetUsagePlanKey

Gets a usage plan key of a given key identifier.

Creating a Request

data GetUsagePlanKey

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

See: newGetUsagePlanKey smart constructor.

Constructors

GetUsagePlanKey'

Fields

• usagePlanId :: Text

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

• keyId :: Text

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

Instances

ToHeaders GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

toHeaders :: GetUsagePlanKey -> [Header]

ToPath GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

toPath :: GetUsagePlanKey -> ByteString

ToQuery GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

toQuery :: GetUsagePlanKey -> QueryString

AWSRequest GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Associated Types

type AWSResponse GetUsagePlanKey

Methods

request :: (Service -> Service) -> GetUsagePlanKey -> Request GetUsagePlanKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsagePlanKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlanKey)))

Generic GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Associated Types

type Rep GetUsagePlanKey :: Type -> Type

Methods

from :: GetUsagePlanKey -> Rep GetUsagePlanKey x

to :: Rep GetUsagePlanKey x -> GetUsagePlanKey

Read GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

readsPrec :: Int -> ReadS GetUsagePlanKey

readList :: ReadS [GetUsagePlanKey]

readPrec :: ReadPrec GetUsagePlanKey

readListPrec :: ReadPrec [GetUsagePlanKey]

Show GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

showsPrec :: Int -> GetUsagePlanKey -> ShowS

show :: GetUsagePlanKey -> String

showList :: [GetUsagePlanKey] -> ShowS

NFData GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

rnf :: GetUsagePlanKey -> ()

Eq GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

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

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

Hashable GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

Methods

hashWithSalt :: Int -> GetUsagePlanKey -> Int

hash :: GetUsagePlanKey -> Int

type AWSResponse GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

type AWSResponse GetUsagePlanKey = UsagePlanKey

type Rep GetUsagePlanKey

Defined in Amazonka.APIGateway.GetUsagePlanKey

type Rep GetUsagePlanKey = D1 ('MetaData "GetUsagePlanKey" "Amazonka.APIGateway.GetUsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlanKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetUsagePlanKey

Arguments

:: Text

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:

GetUsagePlanKey, getUsagePlanKey_usagePlanId - 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 - The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Request Lenses

getUsagePlanKey_usagePlanId :: Lens' GetUsagePlanKey Text

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

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

Destructuring the Response

data UsagePlanKey

Represents a usage plan key to identify a plan customer.

See: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey'

Fields

• id :: Maybe Text

  The Id of a usage plan key.

• name :: Maybe Text

  The name of a usage plan key.

• type' :: Maybe Text

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

• value :: Maybe Text

  The value of a usage plan key.

Instances

FromJSON UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

parseJSON :: Value -> Parser UsagePlanKey

parseJSONList :: Value -> Parser [UsagePlanKey]

Generic UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Associated Types

type Rep UsagePlanKey :: Type -> Type

Methods

from :: UsagePlanKey -> Rep UsagePlanKey x

to :: Rep UsagePlanKey x -> UsagePlanKey

Read UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

readsPrec :: Int -> ReadS UsagePlanKey

readList :: ReadS [UsagePlanKey]

readPrec :: ReadPrec UsagePlanKey

readListPrec :: ReadPrec [UsagePlanKey]

Show UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

showsPrec :: Int -> UsagePlanKey -> ShowS

show :: UsagePlanKey -> String

showList :: [UsagePlanKey] -> ShowS

NFData UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

rnf :: UsagePlanKey -> ()

Eq UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

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

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

Hashable UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

Methods

hashWithSalt :: Int -> UsagePlanKey -> Int

hash :: UsagePlanKey -> Int

type Rep UsagePlanKey

Defined in Amazonka.APIGateway.Types.UsagePlanKey

type Rep UsagePlanKey = D1 ('MetaData "UsagePlanKey" "Amazonka.APIGateway.Types.UsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlanKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUsagePlanKey :: UsagePlanKey

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:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name 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.

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

Response Lenses

usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text)

The Id of a usage plan key.

usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text)

The name of a usage plan key.

usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text)

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

usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text)

The value of a usage plan key.