Update Usage

apigateway_update_usage

R Documentation

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key¶

Description¶

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

Usage¶

apigateway_update_usage(usagePlanId, keyId, patchOperations)

Arguments¶

usagePlanId

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

keyId

[required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

patchOperations

For more information about supported patch operations, see Patch Operations.

Value¶

A list with the following syntax:

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

Request syntax¶

svc$update_usage(
  usagePlanId = "string",
  keyId = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)