Amazon API Gateway · JSON Structure

V2 Integration Structure

Integration schema from Amazon API Gateway v2 API

Type: object Properties: 4
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

Integration 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

IntegrationId IntegrationType IntegrationUri PayloadFormatVersion

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

JSON Structure

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