apigateway_get_usage: Gets the usage data of a usage plan in a specified time...

In paws.networking: 'Amazon Web Services' Networking & Content Delivery Services

Description

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

Usage

apigateway_get_usage(usagePlanId, keyId, startDate, endDate, position,
  limit)

Arguments

usagePlanId	[required] [Required] The Id of the usage plan associated with the usage data.
keyId	The Id of the API key associated with the resultant usage data.
startDate	[required] [Required] The starting date (e.g., 2016-01-01) of the usage data.
endDate	[required] [Required] The ending date (e.g., 2016-12-31) of the usage data.
position	The current pagination position in the paged result set.
limit	The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value

A list with the following syntax:

list(
  usagePlanId = "string",
  startDate = "string",
  endDate = "string",
  position = "string",
  items = list(
    list(
      list(
        123
      )
    )
  )
)

Request syntax

svc$get_usage(
  usagePlanId = "string",
  keyId = "string",
  startDate = "string",
  endDate = "string",
  position = "string",
  limit = 123
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.