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": "string", "authorizationType": enum, "authorizerId": "string", "authorizationScopes": [ "string" ], "apiKeyRequired": boolean, "requestParameters": { }, "requestModels": { }, "modelSelectionExpression": "string", "target": "string", "operationName": "string", "routeResponseSelectionExpression": "string" }
Response bodies
{ "routeId": "string", "routeKey": "string", "authorizationType": enum, "authorizerId": "string", "authorizationScopes": [ "string" ], "apiKeyRequired": boolean, "requestParameters": { }, "requestModels": { }, "modelSelectionExpression": "string", "target": "string", "operationName": "string", "routeResponseSelectionExpression": "string", "apiGatewayManaged": boolean }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
AuthorizationType
The authorization type. For WebSocket APIs, valid values are NONE
for
open access, AWS_IAM
for using AWS 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 AWS 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. |
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. |
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. |
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. |
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. |
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 |
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 |
authorizationType | False | The authorization type for the route. For WebSocket APIs, valid values are
| |
authorizerId | string | False | The identifier of the |
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 | False | The request models for the route. Supported only for WebSocket APIs. | |
requestParameters | 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 |
routeResponseSelectionExpression | string | False | The route response selection expression for the route. Supported only for WebSocket APIs. |
target | string | False | The target for the route. |
RouteModels
The route models.
Property | Type | Required | Description |
---|---|---|---|
| string | False |
RouteParameters
The route parameters.
Property | Type | Required | Description |
---|---|---|---|
| object | False |
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 | False | The authorization type for the route. For WebSocket APIs, valid values are
| |
authorizerId | string | False | The identifier of the |
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 | False | The request models for the route. Supported only for WebSocket APIs. | |
requestParameters | 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 |
routeResponseSelectionExpression | string | False | The route response selection expression for the route. Supported only for WebSocket APIs. |
target | string | False | The target for the route. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: