Amazon API Gateway · JSON Structure

V2 Create Integration Request Structure

CreateIntegrationRequest schema from Amazon API Gateway v2 API

Type: object Properties: 3 Required: 1
API GatewayCloudRESTHTTPWebSocketServerlessMCPAgentCoreDeveloper Portal

CreateIntegrationRequest is a JSON Structure definition published by Amazon API Gateway, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

IntegrationType IntegrationUri PayloadFormatVersion

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "IntegrationType": {
      "type": "string",
      "enum": [
        "AWS",
        "AWS_PROXY",
        "HTTP",
        "HTTP_PROXY",
        "MOCK"
      ],
      "description": "Type of integration.",
      "example": "AWS"
    },
    "IntegrationUri": {
      "type": "string",
      "description": "Integration target URI.",
      "example": "https://example.com/resource/123"
    },
    "PayloadFormatVersion": {
      "type": "string",
      "description": "Payload format version.",
      "example": "1.0"
    }
  },
  "required": [
    "IntegrationType"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-api-gateway/refs/heads/main/json-structure/v2-create-integration-request-structure.json",
  "name": "CreateIntegrationRequest",
  "description": "CreateIntegrationRequest schema from Amazon API Gateway v2 API"
}