GetUsageCommand

Suggest an Edit

Gets the usage data of a usage plan in a specified time interval.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { APIGatewayClient, GetUsageCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetUsageCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // GetUsageRequest
  usagePlanId: "STRING_VALUE", // required
  keyId: "STRING_VALUE",
  startDate: "STRING_VALUE", // required
  endDate: "STRING_VALUE", // required
  position: "STRING_VALUE",
  limit: Number("int"),
};
const command = new GetUsageCommand(input);
const response = await client.send(command);
// { // Usage
//   usagePlanId: "STRING_VALUE",
//   startDate: "STRING_VALUE",
//   endDate: "STRING_VALUE",
//   items: { // MapOfKeyUsages
//     "<keys>": [ // ListOfUsage
//       [ // ListOfLong
//         Number("long"),
//       ],
//     ],
//   },
//   position: "STRING_VALUE",
// };

GetUsageCommand Input

See GetUsageCommandInput for more details

Parameter
Type
Description
endDate
Required
string | undefined

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

startDate
Required
string | undefined

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

usagePlanId
Required
string | undefined

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

keyId
string | undefined

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

limit
number | undefined

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

position
string | undefined

The current pagination position in the paged result set.

GetUsageCommand Output

See GetUsageCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
endDate
string | undefined

The ending date of the usage data.

items
Record<string, number[][]> | undefined

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

position
string | undefined

The current pagination position in the paged result set.

startDate
string | undefined

The starting date of the usage data.

usagePlanId
string | undefined

The plan Id associated with this usage data.

Throws

Name
Fault
Details
BadRequestException
client

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

NotFoundException
client

The requested resource is not found. Make sure that the request URI is correct.

TooManyRequestsException
client

The request has reached its throttling limit. Retry after the specified time period.

UnauthorizedException
client

The request is denied because the caller has insufficient permissions.

APIGatewayServiceException
Base exception class for all service exceptions from APIGateway service.