Route

Represents a route for an API.

URI

/v2/apis/apiId/routes/routeId

HTTP methods

GET

Operation ID: GetRoute

Gets a Route.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`200`	`Route`	Success
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeleteRoute

Deletes a Route.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdateRoute

Updates a Route.

Path parameters
Name	Type	Required	Description
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`200`	`Route`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "routeKey routeKey": "string",
  "authorizationType authorizationType": enum,
  "authorizerId authorizerId": "string",
  "authorizationScopes authorizationScopes": [
    "string"
  ],
  "apiKeyRequired apiKeyRequired": boolean,
  "requestParameters requestParameters": {
  },
  "requestModels requestModels": {
  },
  "modelSelectionExpression modelSelectionExpression": "string",
  "target target": "string",
  "operationName operationName": "string",
  "routeResponseSelectionExpression routeResponseSelectionExpression": "string"
}

Response bodies


{
  "routeId routeId": "string",
  "routeKey routeKey": "string",
  "authorizationType authorizationType": enum,
  "authorizerId authorizerId": "string",
  "authorizationScopes authorizationScopes": [
    "string"
  ],
  "apiKeyRequired apiKeyRequired": boolean,
  "requestParameters requestParameters": {
  },
  "requestModels requestModels": {
  },
  "modelSelectionExpression modelSelectionExpression": "string",
  "target target": "string",
  "operationName operationName": "string",
  "routeResponseSelectionExpression routeResponseSelectionExpression": "string",
  "apiGatewayManaged apiGatewayManaged": boolean
}


{
  "message message": "string"
}


{
  "message message": "string",
  "resourceType resourceType": "string"
}


{
  "message message": "string"
}


{
  "message message": "string",
  "limitType limitType": "string"
}

Properties

AuthorizationType

The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using Amazon IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using Amazon IAM permissions, and CUSTOM for using a Lambda authorizer.

NONE
AWS_IAM
CUSTOM
JWT

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

message

Describes the error encountered.

Type: string
Required: False

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

message

Describes the error encountered.

Type: string
Required: False

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property	Type	Required	Description
`limitType`	string	False	The limit type.
`message`	string	False	Describes the error encountered.

message

Describes the error encountered.

Type: string
Required: False

limitType

The limit type.

Type: string
Required: False

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.
`resourceType`	string	False	The resource type.

message

Describes the error encountered.

Type: string
Required: False

resourceType

The resource type.

Type: string
Required: False

ParameterConstraints

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

Property	Type	Required	Description
`required`	boolean	False	Whether or not the parameter is required.

required

Whether or not the parameter is required.

Type: boolean
Required: False

Route

Represents a route.

Property	Type	Required	Description
`apiGatewayManaged`	boolean	False	Specifies whether a route is managed by API Gateway. If you created an API using quick create, the `$default` route is managed by API Gateway. You can't modify the `$default` route key.
`apiKeyRequired`	boolean	False	Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
`authorizationScopes`	Array of type string	False	A list of authorization scopes configured on a route. The scopes are used with a `JWT` 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.
`authorizationType`	AuthorizationType	False	The authorization type for the route. For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using Amazon IAM permissions, and `CUSTOM` for using a Lambda authorizer. For HTTP APIs, valid values are `NONE` for open access, `JWT` for using JSON Web Tokens, `AWS_IAM` for using Amazon IAM permissions, and `CUSTOM` for using a Lambda authorizer.
`authorizerId`	string	False	The identifier of the `Authorizer` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
`modelSelectionExpression`	string	False	The model selection expression for the route. Supported only for WebSocket APIs.
`operationName`	string	False	The operation name for the route.
`requestModels`	RouteModels	False	The request models for the route. Supported only for WebSocket APIs.
`requestParameters`	RouteParameters	False	The request parameters for the route. Supported only for WebSocket APIs.
`routeId`	string	False	The route ID.
`routeKey`	string	True	The route key for the route. For HTTP APIs, the route key can be either `$default`, or a combination of an HTTP method and resource path, for example, `GET /pets`.
`routeResponseSelectionExpression`	string	False	The route response selection expression for the route. Supported only for WebSocket APIs.
`target`	string	False	The target for the route.

routeId

The route ID.

Type: string
Required: False

routeKey

The route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.

Type: string
Required: True

authorizationType

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using Amazon IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using Amazon IAM permissions, and CUSTOM for using a Lambda authorizer.

Type: AuthorizationType
Required: False

authorizerId

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

Type: string
Required: False

authorizationScopes

A list of authorization scopes configured on a route. The scopes are used with a JWT 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.

Type: Array of type string
Required: False

apiKeyRequired

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

Type: boolean
Required: False

requestParameters

The request parameters for the route. Supported only for WebSocket APIs.

Type: RouteParameters
Required: False

requestModels

The request models for the route. Supported only for WebSocket APIs.

Type: RouteModels
Required: False

modelSelectionExpression

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

Type: string
Required: False

target

The target for the route.

Type: string
Required: False

operationName

The operation name for the route.

Type: string
Required: False

routeResponseSelectionExpression

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

Type: string
Required: False

apiGatewayManaged

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

Type: boolean
Required: False

RouteModels

The route models.

Property	Type	Required	Description
`*`	string	False

key-value pairs

Type: string

RouteParameters

The route parameters.

Property	Type	Required	Description
`*`	object	False

key-value pairs

Type: object

UpdateRouteInput

Represents the input parameters for an UpdateRoute request.

Property	Type	Required	Description
`apiKeyRequired`	boolean	False	Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
`authorizationScopes`	Array of type string	False	The authorization scopes supported by this route.
`authorizationType`	AuthorizationType	False	The authorization type for the route. For WebSocket APIs, valid values are `NONE` for open access, `AWS_IAM` for using Amazon IAM permissions, and `CUSTOM` for using a Lambda authorizer. For HTTP APIs, valid values are `NONE` for open access, `JWT` for using JSON Web Tokens, `AWS_IAM` for using Amazon IAM permissions, and `CUSTOM` for using a Lambda authorizer.
`authorizerId`	string	False	The identifier of the `Authorizer` resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
`modelSelectionExpression`	string	False	The model selection expression for the route. Supported only for WebSocket APIs.
`operationName`	string	False	The operation name for the route.
`requestModels`	RouteModels	False	The request models for the route. Supported only for WebSocket APIs.
`requestParameters`	RouteParameters	False	The request parameters for the route. Supported only for WebSocket APIs.
`routeKey`	string	False	The route key for the route. For HTTP APIs, the route key can be either `$default`, or a combination of an HTTP method and resource path, for example, `GET /pets`.
`routeResponseSelectionExpression`	string	False	The route response selection expression for the route. Supported only for WebSocket APIs.
`target`	string	False	The target for the route.

routeKey

The route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.

Type: string
Required: False

authorizationType

Type: AuthorizationType
Required: False

authorizerId

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

Type: string
Required: False

authorizationScopes

The authorization scopes supported by this route.

Type: Array of type string
Required: False

apiKeyRequired

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Type: boolean
Required: False

requestParameters

The request parameters for the route. Supported only for WebSocket APIs.

Type: RouteParameters
Required: False

requestModels

The request models for the route. Supported only for WebSocket APIs.

Type: RouteModels
Required: False

modelSelectionExpression

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

Type: string
Required: False

target

The target for the route.

Type: string
Required: False

operationName

The operation name for the route.

Type: string
Required: False

routeResponseSelectionExpression

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

Type: string
Required: False

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Publish

RouteRequestParameter