Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . apigatewayv2 ]

get-stage

Description

Gets a Stage.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-stage
--api-id <value>
--stage-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--stage-name (string)

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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.

Output

AccessLogSettings -> (structure)

Settings for logging access in this stage.

DestinationArn -> (string)

The ARN of the CloudWatch Logs log group to receive access logs.

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.

ApiGatewayManaged -> (boolean)

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

AutoDeploy -> (boolean)

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

ClientCertificateId -> (string)

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

CreatedDate -> (timestamp)

The timestamp when the stage was created.

DefaultRouteSettings -> (structure)

Default route settings for the stage.

DataTraceEnabled -> (boolean)

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit. Supported only for WebSocket APIs.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit. Supported only for WebSocket APIs.

DeploymentId -> (string)

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Description -> (string)

The description of the stage.

LastDeploymentStatusMessage -> (string)

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

LastUpdatedDate -> (timestamp)

The timestamp when the stage was last updated.

RouteSettings -> (map)

Route settings for the stage, by routeKey.

key -> (string)

value -> (structure)

Represents a collection of route settings.

DataTraceEnabled -> (boolean)

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit. Supported only for WebSocket APIs.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit. Supported only for WebSocket APIs.

StageName -> (string)

The name of the stage.

StageVariables -> (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-._~:/?#=,]+. Supported only for WebSocket APIs.

key -> (string)

value -> (string)

A string with a length between [0-2048].

Tags -> (map)

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

key -> (string)

value -> (string)

A string with a length between [0-1600].