Routes

Represents the collection of routes for an API.

URI

/v2/apis/apiId/routes

HTTP methods

GET

Operation ID: GetRoutes

Gets the Routes for an API.

Path parameters

Name	Type	Required	Description
apiId	String	True	The API identifier.

Query parameters

Name	Type	Required	Description
nextToken	String	False	The next page of elements from this collection. Not valid for the last element of the collection.
maxResults	String	False	The maximum number of elements to be returned for this resource.

Responses

Status code	Response model	Description
200	Routes	Success
400	BadRequestException	One of the parameters in the request is invalid.
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.

POST

Operation ID: CreateRoute

Creates a Route for an API.

Path parameters

Name	Type	Required	Description
apiId	String	True	The API identifier.

Responses

Status code	Response model	Description
201	Route	The request has succeeded and has resulted in the creation of a resource.
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

POST schema

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

Response bodies

Routes schema

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

Route schema

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

BadRequestException schema

{
  "message": "string"
}

NotFoundException schema

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

ConflictException schema

{
  "message": "string"
}

LimitExceededException schema

{
  "message": "string",
  "limitType": "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.

CreateRouteInput

Represents the input parameters for a CreateRoute 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 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.
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	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.

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

RouteModels

The route models.

Property	Type	Required	Description
*	string	False

RouteParameters

The route parameters.

Property	Type	Required	Description
*	object	False

Routes

Represents a collection of routes.

Property	Type	Required	Description
items	Array of type Route	False	The elements from this collection.
nextToken	string	False	The next page of elements from this collection. Not valid for the last element of the collection.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetRoutes

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

CreateRoute

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3