[ aws . apigatewayv2 ]

create-route-response

Description

Creates a RouteResponse for a Route.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-route-response
--api-id <value>
[--model-selection-expression <value>]
[--response-models <value>]
[--response-parameters <value>]
--route-id <value>
--route-response-key <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--model-selection-expression (string)

The model selection expression for the route response. Supported only for WebSocket APIs.

--response-models (map)

The response models for the route response.

key -> (string)

value -> (string)

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

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--response-parameters (map)

The route response parameters.

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.

Shorthand Syntax:

KeyName1=Required=boolean,KeyName2=Required=boolean

JSON Syntax:

{"string": {
      "Required": true|false
    }
  ...}

--route-id (string)

The route ID.

--route-response-key (string)

The route response key.

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

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.