Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . apigatewayv2 ]

get-route-response

Description

Gets a RouteResponse.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-route-response
--api-id <value>
--route-id <value>
--route-response-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--route-id (string)

The route ID.

--route-response-id (string)

The route response ID.

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

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.