GetUsageRequest

import type { GetUsageRequest } from "https://aws-api.deno.dev/v0.3/services/apigateway.ts?docs=full";

The GET request to get the usage data of a usage plan in a specified time interval.

interface GetUsageRequest {

endDate: string;

keyId?: string | null;

limit?: number | null;

position?: string | null;

startDate: string;

usagePlanId: string;

}

§Properties

endDate: string

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

keyId?: string | null

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

limit?: number | null

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

position?: string | null

The current pagination position in the paged result set.

startDate: string

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

usagePlanId: string

[Required] The Id of the usage plan associated with the usage data.