Update Usage Plan

apigateway_update_usage_plan

R Documentation

Updates a usage plan of a given plan Id¶

Description¶

Updates a usage plan of a given plan Id.

Usage¶

apigateway_update_usage_plan(usagePlanId, patchOperations)

Arguments¶

usagePlanId: [required] The Id of the to-be-updated usage plan.
patchOperations: For more information about supported patch operations, see Patch Operations.

Value¶

A list with the following syntax:

list(
  id = "string",
  name = "string",
  description = "string",
  apiStages = list(
    list(
      apiId = "string",
      stage = "string",
      throttle = list(
        list(
          burstLimit = 123,
          rateLimit = 123.0
        )
      )
    )
  ),
  throttle = list(
    burstLimit = 123,
    rateLimit = 123.0
  ),
  quota = list(
    limit = 123,
    offset = 123,
    period = "DAY"|"WEEK"|"MONTH"
  ),
  productCode = "string",
  tags = list(
    "string"
  )
)

Request syntax¶

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