Skip to content

GetUsagePlanKeysRequest

Source code in docs_src/capo_api_gateway/types/get_usage_plan_keys_request.py 
12
13
14
15
16
17
18
19
20
class GetUsagePlanKeysRequest(TypedDict, closed=True):
    usage_plan_id: "capo_api_gateway.types.string.String"
    """<p>The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.</p>"""
    position: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The current pagination position in the paged result set.</p>"""
    limit: NotRequired["capo_api_gateway.types.nullable_integer.NullableInteger"]
    """<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>"""
    name_query: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>"""

limit instance-attribute 

limit: NotRequired[NullableInteger]

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

name_query instance-attribute 

name_query: NotRequired[String]

A query parameter specifying the name of the to-be-returned usage plan keys.

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.

usage_plan_id instance-attribute 

usage_plan_id: String

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