Amazon API Gateway · Schema

Integration

Integration schema from Amazon API Gateway v2 API

API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Properties

Name Type Description
IntegrationId string Integration identifier.
IntegrationType string Type of integration (AWS_PROXY, HTTP_PROXY, etc.).
IntegrationUri string Integration target URI.
PayloadFormatVersion string Payload format version.
View JSON Schema on GitHub

JSON Schema

v2-integration-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "IntegrationId": {
      "type": "string",
      "description": "Integration identifier.",
      "example": "abc123"
    },
    "IntegrationType": {
      "type": "string",
      "description": "Type of integration (AWS_PROXY, HTTP_PROXY, etc.).",
      "example": "example-value"
    },
    "IntegrationUri": {
      "type": "string",
      "description": "Integration target URI.",
      "example": "https://example.com/resource/123"
    },
    "PayloadFormatVersion": {
      "type": "string",
      "description": "Payload format version.",
      "example": "1.0"
    }
  },
  "$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-integration-schema.json",
  "title": "Integration",
  "description": "Integration schema from Amazon API Gateway v2 API"
}