Skip to content

GetUsageRequest

Source code in docs_src/capo_api_gateway/types/get_usage_request.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
class GetUsageRequest(TypedDict, closed=True):
    usage_plan_id: "capo_api_gateway.types.string.String"
    """<p>The Id of the usage plan associated with the usage data.</p>"""
    key_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The Id of the API key associated with the resultant usage data.</p>"""
    start_date: "capo_api_gateway.types.string.String"
    """<p>The starting date (e.g., 2016-01-01) of the usage data.</p>"""
    end_date: "capo_api_gateway.types.string.String"
    """<p>The ending date (e.g., 2016-12-31) of the usage data.</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>"""

end_date instance-attribute 

end_date: String

The ending date (e.g., 2016-12-31) of the usage data.

key_id instance-attribute 

key_id: NotRequired[String]

The Id of the API key associated with the resultant usage data.

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.

position instance-attribute 

position: NotRequired[String]

The current pagination position in the paged result set.

start_date instance-attribute 

start_date: String

The starting date (e.g., 2016-01-01) of the usage data.

usage_plan_id instance-attribute 

usage_plan_id: String

The Id of the usage plan associated with the usage data.