Amazon API Gateway · Schema

Route

Route schema from Amazon API Gateway v2 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name Type Description
RouteId string Route identifier.
RouteKey string Route key (e.g. "GET /items" or "$connect").
Target string Integration target reference.
AuthorizationType string Authorization type for the route.
View JSON Schema on GitHub

JSON Schema

v2-route-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "RouteId": {
      "type": "string",
      "description": "Route identifier.",
      "example": "abc123"
    },
    "RouteKey": {
      "type": "string",
      "description": "Route key (e.g. \"GET /items\" or \"$connect\").",
      "example": "example-value"
    },
    "Target": {
      "type": "string",
      "description": "Integration target reference.",
      "example": "example-value"
    },
    "AuthorizationType": {
      "type": "string",
      "description": "Authorization type for the route.",
      "example": "example-value"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-schema/v2-route-schema.json",
  "title": "Route",
  "description": "Route schema from Amazon API Gateway v2 API"
}