{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kontaktio/main/json-schema/kontaktio-stream-patch-kinesis-channel-schema.json",
  "title": "Kinesis channel PATCH",
  "description": "Updates a AWS Kinesis stream channel\n\n**IMPORTANT:** when updating channel object, all properties are required.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kontaktio-stream-api-openapi.yml#/components/schemas/Stream-patch-kinesis-channel",
  "type": "object",
  "x-internal": false,
  "properties": {
    "status": {
      "type": "string",
      "description": "The configuration status.",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "name": {
      "type": "string",
      "description": "User-defined name to identify the channel."
    },
    "channel": {
      "type": "object",
      "description": "Configuration specific to the AWS Kinesis stream. When updating a channel property, all channel property values must be provided.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Set to kinesis. Type of channel; identifies the third-party streaming service.",
          "enum": [
            "kinesis",
            "eventHub",
            "watson"
          ]
        },
        "endpoint": {
          "type": "string",
          "description": "Kinesis “endpoint“ parameter is constant based on the “region“ value.\nExample: region is us-east-2, the endpoint is kinesis.us-east-2.amazonaws.com\nAWS article with region endpoints: https://docs.aws.amazon.com/general/latest/gr/ak.html"
        },
        "streamName": {
          "type": "string",
          "description": "kinesis stream name."
        },
        "accessKey": {
          "type": "string",
          "description": "AWS kinesis access key."
        },
        "secretKey": {
          "type": "string",
          "description": "AWS kinesis secret access key."
        },
        "region": {
          "type": "string",
          "description": "kinesis stream AWS region"
        }
      }
    }
  }
}