update-stage¶

Description¶

Changes information about a Stage resource.

Synopsis¶

  update-stage
--rest-api-id <value>
--stage-name <value>
[--patch-operations <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--rest-api-id (string)

The string identifier of the associated RestApi.

--stage-name (string)

The name of the Stage resource to change information about.

--patch-operations (list)

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

(structure)

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

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”: …}’.

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 override the stage settings and disable full request/response logging for a specific resource and method in an API’s stage

Command:

aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false

To enable full request/response logging for all resources/methods in an API’s stage

Command:

aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/*/*/logging/dataTrace,value=true

Output¶

deploymentId -> (string)

The identifier of the Deployment that the stage points to.

clientCertificateId -> (string)

The identifier of a client certificate for an API stage.

stageName -> (string)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

description -> (string)

The stage’s description.

cacheClusterEnabled -> (boolean)

Specifies whether a cache cluster is enabled for the stage.

cacheClusterSize -> (string)

The size of the cache cluster for the stage, if enabled.

cacheClusterStatus -> (string)

The status of the cache cluster for the stage, if enabled.

methodSettings -> (map)

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

key -> (string)

value -> (structure)

Specifies the method setting properties.

metricsEnabled -> (boolean)

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled , and the value is a Boolean.

loggingLevel -> (string)

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel , and the available levels are OFF , ERROR , and INFO . Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

dataTraceEnabled -> (boolean)

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace , and the value is a Boolean.

throttlingBurstLimit -> (integer)

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit , and the value is an integer.

throttlingRateLimit -> (double)

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit , and the value is a double.

cachingEnabled -> (boolean)

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled , and the value is a Boolean.

cacheTtlInSeconds -> (integer)

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds , and the value is an integer.

cacheDataEncrypted -> (boolean)

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted , and the value is a Boolean.

requireAuthorizationForCacheControl -> (boolean)

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl , and the value is a Boolean.

unauthorizedCacheControlHeaderStrategy -> (string)

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy , and the available values are FAIL_WITH_403 , SUCCEED_WITH_RESPONSE_HEADER , SUCCEED_WITHOUT_RESPONSE_HEADER .

variables -> (map)

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .

key -> (string)

value -> (string)

documentationVersion -> (string)

The version of the associated API documentation.

accessLogSettings -> (structure)

Settings for logging access in this stage.

format -> (string)

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId .

destinationArn -> (string)

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway- .

canarySettings -> (structure)

Settings for the canary deployment in this stage.

percentTraffic -> (double)

The percent (0-100) of traffic diverted to a canary deployment.

deploymentId -> (string)

The ID of the canary deployment.

stageVariableOverrides -> (map)

Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

key -> (string)

value -> (string)

useStageCache -> (boolean)

A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

tracingEnabled -> (boolean)

Specifies whether active tracing with X-ray is enabled for the Stage.

webAclArn -> (string)

The ARN of the WebAcl associated with the Stage.

tags -> (map)

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

key -> (string)

value -> (string)

createdDate -> (timestamp)

The timestamp when the stage was created.

lastUpdatedDate -> (timestamp)

The timestamp when the stage last updated.

Table of Contents

Feedback

User Guide