Table Of Contents

Feedback

User Guide

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

[ aws . apigatewayv2 ]

get-stages

Description

Gets the Stages for an API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

get-stages is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Items

Synopsis

  get-stages
--api-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (string)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (string)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Items -> (list)

The elements from this collection.

(structure)

Represents an API stage.

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.

ClientCertificateId -> (string)

The identifier of a client certificate for a Stage.

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.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit.

DeploymentId -> (string)

The identifier of the Deployment that the Stage is associated with.

Description -> (string)

The description of the stage.

LastUpdatedDate -> (timestamp)

The timestamp when the stage was last updated.

RouteSettings -> (map)

Route settings for the stage.

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.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit.

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-._~:/?#&=,]+.

key -> (string)

value -> (string)

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

Tags -> (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

key -> (string)

value -> (string)

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

NextToken -> (string)

The next page of elements from this collection. Not valid for the last element of the collection.