Amazon Kinesis Video Streams API

Video stream management

GitHub OpenAPI

Operations 5

POST /createStream Create Stream #
POST /deleteStream Delete Stream #
POST /describeStream Describe Stream #
POST /listStreams List Streams #
POST /updateStream Update Stream #

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-streams-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-streams-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Kinesis Video Streams Streams API
  version: '2017-09-30'
  description: Generated from AWS's published Smithy model for Amazon Kinesis Video Streams. 5 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:
  /createStream:
    post:
      operationId: CreateStream
      summary: Create Stream
      description: Creates a new Kinesis video stream. When you create a new stream, Kinesis Video Streams assigns it a version
        number. When you change the stream's metadata, Kinesis Video Streams updates the version. CreateStream is an asynchronous
        operation. For information about how the service works, see How it Works. You must have permissions for the KinesisVideo:CreateStream
        action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateStreamOutput'
        '400':
          description: AccountStreamLimitExceededException; ClientLimitExceededException; DeviceStreamLimitExceededException;
            InvalidArgumentException; InvalidDeviceException; ResourceInUseException; TagsPerResourceExceededLimitException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountStreamLimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStreamInput'
      tags:
      - Streams
  /deleteStream:
    post:
      operationId: DeleteStream
      summary: Delete Stream
      description: Deletes a Kinesis video stream and the data contained in the stream. This method marks the stream for deletion,
        and makes the data in the stream inaccessible immediately. To ensure that you have the latest version of the stream
        before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When
        you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the
        DescribeStream API. This operation requires permission for the KinesisVideo:DeleteStream action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteStreamOutput'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException; ResourceInUseException; VersionMismatchException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
        '401':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteStreamInput'
      tags:
      - Streams
  /describeStream:
    post:
      operationId: DescribeStream
      summary: Describe Stream
      description: Returns the most current information about the specified stream. You must specify either the StreamName
        or the StreamARN.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeStreamOutput'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
        '401':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeStreamInput'
      tags:
      - Streams
  /listStreams:
    post:
      operationId: ListStreams
      summary: List Streams
      description: Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy
        a specific condition, you can specify a StreamNameCondition.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListStreamsOutput'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListStreamsInput'
      tags:
      - Streams
  /updateStream:
    post:
      operationId: UpdateStream
      summary: Update Stream
      description: Updates stream metadata, such as the device name and media type. You must provide the stream name or the
        Amazon Resource Name (ARN) of the stream. To make sure that you have the latest version of the stream before updating
        it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a
        stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream
        API. UpdateStream is an asynchronous operation, and takes time to complete.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateStreamOutput'
        '400':
          description: ClientLimitExceededException; InvalidArgumentException; ResourceInUseException; VersionMismatchException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientLimitExceededException'
        '401':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStreamInput'
      tags:
      - Streams
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:
    AccountStreamLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ClientLimitExceededException:
      type: object
      properties:
        Message:
          type: string
    CreateStreamInput:
      type: object
      properties:
        DeviceName:
          type: string
          description: The name of the device that is writing to the stream. In the current implementation, Kinesis Video
            Streams doesn't use this name.
        StreamName:
          type: string
          description: A name for the stream that you are creating. The stream name is an identifier for the stream, and must
            be unique for each account and region.
        MediaType:
          type: string
          description: The media type of the stream. Consumers of the stream can use this information when processing the
            stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming
            Requirements for guidelines. Example valid values include "video/h264" and "video/h264,audio/aac". This parameter
            is optional; the default value is null (or empty in JSON).
        KmsKeyId:
          type: string
          description: The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt
            stream data. If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used. For
            more information, see DescribeKey.
        DataRetentionInHours:
          type: integer
          description: The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the
            data in a data store that is associated with the stream. The default value is 0, indicating that the stream does
            not persist data. The minimum is 1 hour. When the DataRetentionInHours value is 0, consumers can still consume
            the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention
            memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
        StreamStorageConfiguration:
          $ref: '#/components/schemas/StreamStorageConfiguration'
      required:
      - StreamName
    CreateStreamOutput:
      type: object
      properties:
        StreamARN:
          type: string
          description: The Amazon Resource Name (ARN) of the stream.
    DeleteStreamInput:
      type: object
      properties:
        StreamARN:
          type: string
          description: The Amazon Resource Name (ARN) of the stream that you want to delete.
        CurrentVersion:
          type: string
          description: 'Optional: The version of the stream that you want to delete. Specify the version as a safeguard to
            ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API. If not
            specified, only the CreationTime is checked before deleting the stream.'
      required:
      - StreamARN
    DeleteStreamOutput:
      type: object
      properties: {}
    DescribeStreamInput:
      type: object
      properties:
        StreamName:
          type: string
          description: The name of the stream.
        StreamARN:
          type: string
          description: The Amazon Resource Name (ARN) of the stream.
    DescribeStreamOutput:
      type: object
      properties:
        StreamInfo:
          $ref: '#/components/schemas/StreamInfo'
    ListStreamsInput:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of streams to return in the response. The default is 10,000.
        NextToken:
          type: string
          description: If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns
            the NextToken in the response. To get another batch of streams, provide this token in your next request.
        StreamNameCondition:
          $ref: '#/components/schemas/StreamNameCondition'
    ListStreamsOutput:
      type: object
      properties:
        StreamInfoList:
          type: array
          items:
            $ref: '#/components/schemas/StreamInfo'
          description: An array of StreamInfo 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.
    NotAuthorizedException:
      type: object
      properties:
        Message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
    StreamInfo:
      type: object
      properties:
        DeviceName:
          type: string
          description: The name of the device that is associated with the stream.
        StreamName:
          type: string
          description: The name of the stream.
        StreamARN:
          type: string
          description: The Amazon Resource Name (ARN) of the stream.
        MediaType:
          type: string
          description: The MediaType of the stream.
        KmsKeyId:
          type: string
          description: The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the
            stream.
        Version:
          type: string
          description: The version of the stream.
        Status:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          description: The status of the stream.
        CreationTime:
          type: string
          format: date-time
          description: A time stamp that indicates when the stream was created.
        DataRetentionInHours:
          type: integer
          description: How long the stream retains data, in hours.
    StreamNameCondition:
      type: object
      properties:
        ComparisonOperator:
          type: string
          enum:
          - BEGINS_WITH
          description: A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams
            whose names start with a given prefix.
        ComparisonValue:
          type: string
          description: A value to compare.
    StreamStorageConfiguration:
      type: object
      properties:
        DefaultStorageTier:
          type: string
          enum:
          - HOT
          - WARM
          description: 'The default storage tier for the stream data. This setting determines the storage class used for stream
            data, affecting both performance characteristics and storage costs. Available storage tiers: HOT - Optimized for
            frequent access with the lowest latency and highest performance. Ideal for real-time applications and frequently
            accessed data. WARM - Balanced performance and cost for moderately accessed data. Suitable for data that is accessed
            regularly but not continuously.'
      required:
      - DefaultStorageTier
    UpdateStreamInput:
      type: object
      properties:
        StreamName:
          type: string
          description: The name of the stream whose metadata you want to update. The stream name is an identifier for the
            stream, and must be unique for each account and region.
        StreamARN:
          type: string
          description: The ARN of the stream whose metadata you want to update.
        CurrentVersion:
          type: string
          description: The version of the stream whose metadata you want to update.
        DeviceName:
          type: string
          description: The name of the device that is writing to the stream. In the current implementation, Kinesis Video
            Streams does not use this name.
        MediaType:
          type: string
          description: The stream's media type. Use MediaType to specify the type of content that the stream contains to the
            consumers of the stream. For more information about media types, see Media Types. If you choose to specify the
            MediaType, see Naming Requirements. To play video on the console, you must specify the correct video type. For
            example, if the video in the stream is H.264, specify video/h264 as the MediaType.
      required:
      - CurrentVersion
    UpdateStreamOutput:
      type: object
      properties: {}
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)