Amazon API Gateway
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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

Example PATCH

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

Response Bodies

Example Route

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

Example BadRequestException

{ "message": "string" }

Example NotFoundException

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

Example ConflictException

{ "message": "string" }

Example LimitExceededException

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

Properties

AuthorizationType

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

  • NONE

  • AWS_IAM

  • CUSTOM

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
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

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
routeId

string

False

The route ID.

routeKey

string

True

The route key for the route.

authorizationType

AuthorizationType

False

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

False

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.

authorizationScopes

Array of type string

False

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.

apiKeyRequired

boolean

False

Specifies whether an API key is required for this route.

requestParameters

RouteParameters

False

The request parameters for the route.

requestModels

RouteModels

False

The request models for the route.

modelSelectionExpression

string

False

The model selection expression for the route.

target

string

False

The target for the route.

operationName

string

False

The operation name for the route.

routeResponseSelectionExpression

string

False

The route response selection expression 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
routeKey

string

False

The route key for the route.

authorizationType

AuthorizationType

False

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

False

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.

authorizationScopes

Array of type string

False

The authorization scopes supported by this route.

apiKeyRequired

boolean

False

Specifies whether an API key is required for the route.

requestParameters

RouteParameters

False

The request parameters for the route.

requestModels

RouteModels

False

The request models for the route.

modelSelectionExpression

string

False

The model selection expression for the route.

target

string

False

The target for the route.

operationName

string

False

The operation name for the route.

routeResponseSelectionExpression

string

False

The route response selection expression 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:

GetRoute

DeleteRoute

UpdateRoute