apigateway_update_usage_plan: Updates a usage plan of a given plan Id

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Updates a usage plan of a given plan Id.

Usage

1
apigateway_update_usage_plan(usagePlanId, patchOperations)

Arguments

usagePlanId

[required] [Required] The Id of the to-be-updated usage plan.

patchOperations

A list of update operations to be applied to the specified resource and in the order specified in this list.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
svc$update_usage_plan(
  usagePlanId = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)

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