Amazon Kinesis Video Streams Signaling Channels API

WebRTC signaling channel management

GitHub OpenAPI

Operations 4

POST /createSignalingChannel Create Signaling Channel #
POST /deleteSignalingChannel Delete Signaling Channel #
POST /describeSignalingChannel Describe Signaling Channel #
POST /listSignalingChannels List Signaling Channels #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-kinesis-video-streams:amazon-kinesis-video-streams-signaling-channels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-kinesis-video-streams-signaling-channels-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Kinesis Video Streams Signaling Channels API
  version: '2017-09-30'
  description: Generated from AWS's published Smithy model for Amazon Kinesis Video Streams. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://kinesisvideo.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /createSignalingChannel:
    post:
      operationId: CreateSignalingChannel
      summary: Create Signaling Channel
      description: Creates a signaling channel. CreateSignalingChannel is an asynchronous operation.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSignalingChannelOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: AccountChannelLimitExceededException; ClientLimitExceededException; InvalidArgumentException; ResourceInUseException;
            TagsPerResourceExceededLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountChannelLimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSignalingChannelInput'
      tags:
      - Signaling Channels
  /deleteSignalingChannel:
    post:
      operationId: DeleteSignalingChannel
      summary: Delete Signaling Channel
      description: Deletes a specified signaling channel. DeleteSignalingChannel is an asynchronous operation. If you don't
        specify the channel's current version, the most recent version is deleted.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSignalingChannelOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException; ResourceInUseException; VersionMismatchException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSignalingChannelInput'
      tags:
      - Signaling Channels
  /describeSignalingChannel:
    post:
      operationId: DescribeSignalingChannel
      summary: Describe Signaling Channel
      description: Returns the most current information about the signaling channel. You must specify either the name or the
        Amazon Resource Name (ARN) of the channel that you want to describe.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeSignalingChannelOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeSignalingChannelInput'
      tags:
      - Signaling Channels
  /listSignalingChannels:
    post:
      operationId: ListSignalingChannels
      summary: List Signaling Channels
      description: Returns an array of ChannelInfo objects. Each object describes a signaling channel. To retrieve only those
        channels that satisfy a specific condition, you can specify a ChannelNameCondition.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSignalingChannelsOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSignalingChannelsInput'
      tags:
      - Signaling Channels
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: kinesisvideo
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
    AccountChannelLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ChannelInfo:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the signaling channel.
        ChannelARN:
          type: string
          description: The Amazon Resource Name (ARN) of the signaling channel.
        ChannelType:
          type: string
          enum:
          - SINGLE_MASTER
          - FULL_MESH
          description: The type of the signaling channel.
        ChannelStatus:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          description: Current status of the signaling channel.
        CreationTime:
          type: string
          format: date-time
          description: The time at which the signaling channel was created.
        SingleMasterConfiguration:
          $ref: '#/components/schemas/SingleMasterConfiguration'
        Version:
          type: string
          description: The current version of the signaling channel.
    ChannelNameCondition:
      type: object
      properties:
        ComparisonOperator:
          type: string
          enum:
          - BEGINS_WITH
          description: A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds signaling
            channels whose names begin with a given prefix.
        ComparisonValue:
          type: string
          description: A value to compare.
    ClientLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    CreateSignalingChannelInput:
      type: object
      properties:
        ChannelName:
          type: string
          description: A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services
            account and Amazon Web Services Region.
        ChannelType:
          type: string
          enum:
          - SINGLE_MASTER
          - FULL_MESH
          description: A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported
            channel type.
        SingleMasterConfiguration:
          $ref: '#/components/schemas/SingleMasterConfiguration'
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A set of tags (key-value pairs) that you want to associate with this channel.
      required:
      - ChannelName
    CreateSignalingChannelOutput:
      type: object
      properties:
        ChannelARN:
          type: string
          description: The Amazon Resource Name (ARN) of the created channel.
    DeleteSignalingChannelInput:
      type: object
      properties:
        ChannelARN:
          type: string
          description: The Amazon Resource Name (ARN) of the signaling channel that you want to delete.
        CurrentVersion:
          type: string
          description: The current version of the signaling channel that you want to delete. You can obtain the current version
            by invoking the DescribeSignalingChannel or ListSignalingChannels API operations.
      required:
      - ChannelARN
    DeleteSignalingChannelOutput:
      type: object
      properties: {}
    DescribeSignalingChannelInput:
      type: object
      properties:
        ChannelName:
          type: string
          description: The name of the signaling channel that you want to describe.
        ChannelARN:
          type: string
          description: The ARN of the signaling channel that you want to describe.
    DescribeSignalingChannelOutput:
      type: object
      properties:
        ChannelInfo:
          $ref: '#/components/schemas/ChannelInfo'
    ListSignalingChannelsInput:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of channels to return in the response. The default is 500.
        NextToken:
          type: string
          description: If you specify this parameter, when the result of a ListSignalingChannels operation is truncated, the
            call returns the NextToken in the response. To get another batch of channels, provide this token in your next
            request.
        ChannelNameCondition:
          $ref: '#/components/schemas/ChannelNameCondition'
    ListSignalingChannelsOutput:
      type: object
      properties:
        ChannelInfoList:
          type: array
          items:
            $ref: '#/components/schemas/ChannelInfo'
          description: An array of ChannelInfo objects.
        NextToken:
          type: string
          description: If the response is truncated, the call returns this element with a token. To get the next batch of
            streams, use this token in your next request.
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    SingleMasterConfiguration:
      type: object
      properties:
        MessageTtlSeconds:
          type: integer
          description: The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded.
            Use to update this value.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key of the tag that is associated with the specified signaling channel.
        Value:
          type: string
          description: The value of the tag that is associated with the specified signaling channel.
      required:
      - Key
      - Value
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/kinesis-video/service/2017-09-30/kinesis-video-2017-09-30.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)