[ aws . apigatewayv2 ]

get-route-responses

Description

Gets the RouteResponses for a Route.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-route-responses 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-route-responses
--api-id <value>
--route-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--api-id (string)

The API identifier.

--route-id (string)

The route ID.

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

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Items -> (list)

The elements from this collection.

(structure)

Represents a route response.

ModelSelectionExpression -> (string)

Represents the model selection expression of a route response. Supported only for WebSocket APIs.

ResponseModels -> (map)

Represents the response models of a route response.

key -> (string)

value -> (string)

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

ResponseParameters -> (map)

Represents the response parameters of a route response.

key -> (string)

value -> (structure)

Validation constraints imposed on parameters of a request (path, query string, headers).

Required -> (boolean)

Whether or not the parameter is required.

RouteResponseId -> (string)

Represents the identifier of a route response.

RouteResponseKey -> (string)

Represents the route response key of a route response.

NextToken -> (string)

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