[ aws . apigateway ]

update-usage-plan

Description

Updates a usage plan of a given plan Id.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-usage-plan
--usage-plan-id <value>
[--patch-operations <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--usage-plan-id (string)

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

--patch-operations (list)

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

(structure)

A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

op -> (string)

An update operation to be performed with this PATCH request. The valid value can be add , remove , replace or copy . Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

path -> (string)

The op operation’s target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"} , the path for this property is /name . If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}} ), the path for the child/name property will be /name/child~1name . Any slash (“/”) character appearing in path names must be escaped with “~1”, as shown in the example above. Each op operation can have only one path associated with it.

value -> (string)

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., ‘{“a”: …}’. In a Windows shell, see Using JSON for Parameters .

from -> (string)

The copy update operation’s source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy" , "from":"/canarySettings/deploymentId" and "path":"/deploymentId" .

Shorthand Syntax:

op=string,path=string,value=string,from=string ...

JSON Syntax:

[
  {
    "op": "add"|"remove"|"replace"|"move"|"copy"|"test",
    "path": "string",
    "value": "string",
    "from": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To change the period defined in a Usage Plan

Command:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH"

To change the quota limit defined in a Usage Plan

Command:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500"

To change the throttle rate limit defined in a Usage Plan

Command:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10"

To change the throttle burst limit defined in a Usage Plan

Command:

aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20"

Output

id -> (string)

The identifier of a UsagePlan resource.

name -> (string)

The name of a usage plan.

description -> (string)

The description of a usage plan.

apiStages -> (list)

The associated API stages of a usage plan.

(structure)

API stage name of the associated API stage in a usage plan.

apiId -> (string)

API Id of the associated API stage in a usage plan.

stage -> (string)

API stage name of the associated API stage in a usage plan.

throttle -> (map)

Map containing method level throttling information for API stage in a usage plan.

key -> (string)

value -> (structure)

The API request rate limits.

burstLimit -> (integer)

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

rateLimit -> (double)

The API target request rate limit.

throttle -> (structure)

Map containing method level throttling information for API stage in a usage plan.

burstLimit -> (integer)

The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

rateLimit -> (double)

The API target request rate limit.

quota -> (structure)

The target maximum number of permitted requests per a given unit time interval.

limit -> (integer)

The target maximum number of requests that can be made in a given time period.

offset -> (integer)

The day that a time period starts. For example, with a time period of WEEK , an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

period -> (string)

The time period in which the limit applies. Valid values are “DAY”, “WEEK” or “MONTH”.

productCode -> (string)

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)