Table Of Contents

Feedback

User Guide

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

[ aws . apigatewayv2 ]

update-route

Description

Updates a Route.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-route
--api-id <value>
[--api-key-required | --no-api-key-required]
[--authorization-scopes <value>]
[--authorization-type <value>]
[--authorizer-id <value>]
[--model-selection-expression <value>]
[--operation-name <value>]
[--request-models <value>]
[--request-parameters <value>]
--route-id <value>
[--route-key <value>]
[--route-response-selection-expression <value>]
[--target <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--api-id (string)

The API identifier.

--api-key-required | --no-api-key-required (boolean)

Specifies whether an API key is required for the route.

--authorization-scopes (list)

The authorization scopes supported by this route.

Syntax:

"string" "string" ...

--authorization-type (string)

The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Possible values:

  • NONE
  • AWS_IAM
  • CUSTOM

--authorizer-id (string)

The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

--model-selection-expression (string)

The model selection expression for the route.

--operation-name (string)

The operation name for the route.

--request-models (map)

The request models for the route.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--request-parameters (map)

The request parameters for the route.

Shorthand Syntax:

KeyName1=Required=boolean,KeyName2=Required=boolean

JSON Syntax:

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

--route-id (string)

The route ID.

--route-key (string)

The route key for the route.

--route-response-selection-expression (string)

The route response selection expression for the route.

--target (string)

The target for the route.

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

ApiKeyRequired -> (boolean)

Specifies whether an API key is required for this route.

AuthorizationScopes -> (list)

A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

(string)

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

AuthorizationType -> (string)

The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer

AuthorizerId -> (string)

The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

ModelSelectionExpression -> (string)

The model selection expression for the route.

OperationName -> (string)

The operation name for the route.

RequestModels -> (map)

The request models for the route.

key -> (string)

value -> (string)

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

RequestParameters -> (map)

The request parameters for the route.

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.

RouteId -> (string)

The route ID.

RouteKey -> (string)

The route key for the route.

RouteResponseSelectionExpression -> (string)

The route response selection expression for the route.

Target -> (string)

The target for the route.