Amazon API Gateway · JSON Structure

V2 Route Structure

Route schema from Amazon API Gateway v2 API

Type: object Properties: 4
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Route is a JSON Structure definition published by Amazon API Gateway, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

RouteId RouteKey Target AuthorizationType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

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-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v2-route-structure.json",
  "name": "Route",
  "description": "Route schema from Amazon API Gateway v2 API"
}