Skip to content

get_usage_plan_key

Operation

get_usage_plan_key

get_usage_plan_key(request: GetUsagePlanKeyInput | GetUsagePlanKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlanKeyInputDict]) -> GetUsagePlanKeyOutput

Gets a usage plan key of a given key identifier.

Parameters:

Name Type Description Default
request GetUsagePlanKeyInput | GetUsagePlanKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetUsagePlanKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetUsagePlanKeyOutput

An instance of GetUsagePlanKeyOutput.

get_usage_plan_key async

get_usage_plan_key(request: GetUsagePlanKeyInput | GetUsagePlanKeyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUsagePlanKeyInputDict]) -> GetUsagePlanKeyOutput

Gets a usage plan key of a given key identifier.

Parameters:

Name Type Description Default
request GetUsagePlanKeyInput | GetUsagePlanKeyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetUsagePlanKeyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetUsagePlanKeyOutput

An instance of GetUsagePlanKeyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetUsagePlanKeyInputDict

Bases: TypedDict

Dictionary form of GetUsagePlanKeyInput.

Attributes

key_id instance-attribute
key_id: Required[str]

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

usage_plan_id instance-attribute
usage_plan_id: Required[str]

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

GetUsagePlanKeyInput dataclass

Bases: _SerdeShape

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

Attributes

key_id class-attribute instance-attribute
key_id: str | None = ...

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

usage_plan_id class-attribute instance-attribute
usage_plan_id: str | None = ...

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

Output

GetUsagePlanKeyOutput dataclass

Bases: _SerdeShape

Represents a usage plan key to identify a plan customer.

Attributes

id class-attribute instance-attribute
id: str | None = ...

The Id of a usage plan key.

name class-attribute instance-attribute
name: str | None = ...

The name of a usage plan key.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

type class-attribute instance-attribute
type: str | None = ...

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

value class-attribute instance-attribute
value: str | None = ...

The value of a usage plan key.