Amazon Chime SDK Chime Media Pipeline Kinesis Video Stream Pools API

The Chime Media Pipeline Kinesis Video Stream Pools API from Amazon Chime SDK — 2 operation(s) for chime media pipeline kinesis video stream pools.

GitHub OpenAPI

Operations 5

POST /media-pipeline-kinesis-video-stream-pools Create Media Pipeline Kinesis Video Stream Pool #
GET /media-pipeline-kinesis-video-stream-pools List Media Pipeline Kinesis Video Stream Pools #
DELETE /media-pipeline-kinesis-video-stream-pools/{Identifier} Delete Media Pipeline Kinesis Video Stream Pool #
GET /media-pipeline-kinesis-video-stream-pools/{Identifier} Get Media Pipeline Kinesis Video Stream Pool #
PUT /media-pipeline-kinesis-video-stream-pools/{Identifier} Update Media Pipeline Kinesis Video Stream Pool #

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-chime:amazon-chime-media-pipeline-kinesis-video-stream-pools-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-chime-media-pipeline-kinesis-video-stream-pools-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Media Pipeline Kinesis Video Stream Pools API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 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://media-pipelines-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /media-pipeline-kinesis-video-stream-pools:
    post:
      operationId: CreateMediaPipelineKinesisVideoStreamPool
      summary: Create Media Pipeline Kinesis Video Stream Pool
      description: Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines. If a meeting uses an opt-in
        Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1
        Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default,
        the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1,
        the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.
        To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.
        For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and
        Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMediaPipelineKinesisVideoStreamPoolResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMediaPipelineKinesisVideoStreamPoolRequest'
      tags:
      - Media Pipeline Kinesis Video Stream Pools
    get:
      operationId: ListMediaPipelineKinesisVideoStreamPools
      summary: List Media Pipeline Kinesis Video Stream Pools
      description: Lists the video stream pools in the media pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMediaPipelineKinesisVideoStreamPoolsResponse'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMediaPipelineKinesisVideoStreamPoolsRequest'
      tags:
      - Media Pipeline Kinesis Video Stream Pools
  /media-pipeline-kinesis-video-stream-pools/{Identifier}:
    delete:
      operationId: DeleteMediaPipelineKinesisVideoStreamPool
      summary: Delete Media Pipeline Kinesis Video Stream Pool
      description: Deletes an Amazon Kinesis Video Stream pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteMediaPipelineKinesisVideoStreamPoolRequest'
      tags:
      - Media Pipeline Kinesis Video Stream Pools
    get:
      operationId: GetMediaPipelineKinesisVideoStreamPool
      summary: Get Media Pipeline Kinesis Video Stream Pool
      description: Gets an Kinesis video stream pool.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMediaPipelineKinesisVideoStreamPoolResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMediaPipelineKinesisVideoStreamPoolRequest'
      tags:
      - Media Pipeline Kinesis Video Stream Pools
    put:
      operationId: UpdateMediaPipelineKinesisVideoStreamPool
      summary: Update Media Pipeline Kinesis Video Stream Pool
      description: Updates an Amazon Kinesis Video Stream pool in a media pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMediaPipelineKinesisVideoStreamPoolResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMediaPipelineKinesisVideoStreamPoolRequest'
      tags:
      - Media Pipeline Kinesis Video Stream Pools
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: chime
  schemas:
    CreateMediaPipelineKinesisVideoStreamPoolRequest:
      type: object
      properties:
        StreamConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamConfiguration'
        PoolName:
          type: string
          description: The name of the pool.
        ClientRequestToken:
          type: string
          description: The token assigned to the client making the request.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/MediaPipelinesChimeTag'
          description: The tags assigned to the stream pool.
      required:
      - StreamConfiguration
      - PoolName
    CreateMediaPipelineKinesisVideoStreamPoolResponse:
      type: object
      properties:
        KinesisVideoStreamPoolConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamPoolConfiguration'
    DeleteMediaPipelineKinesisVideoStreamPoolRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the requested resource. Valid values include the name and ARN of the media
            pipeline Kinesis Video Stream pool.
      required:
      - Identifier
    GetMediaPipelineKinesisVideoStreamPoolRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the requested resource. Valid values include the name and ARN of the media
            pipeline Kinesis Video Stream pool.
      required:
      - Identifier
    GetMediaPipelineKinesisVideoStreamPoolResponse:
      type: object
      properties:
        KinesisVideoStreamPoolConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamPoolConfiguration'
    KinesisVideoStreamConfiguration:
      type: object
      properties:
        Region:
          type: string
          description: The Amazon Web Services Region of the video stream.
        DataRetentionInHours:
          type: integer
          description: The amount of time that data is retained.
      required:
      - Region
    KinesisVideoStreamConfigurationUpdate:
      type: object
      properties:
        DataRetentionInHours:
          type: integer
          description: The updated time that data is retained.
    KinesisVideoStreamPoolConfiguration:
      type: object
      properties:
        PoolArn:
          type: string
          description: The ARN of the video stream pool configuration.
        PoolName:
          type: string
          description: The name of the video stream pool configuration.
        PoolId:
          type: string
          description: The ID of the video stream pool in the configuration.
        PoolStatus:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - FAILED
          description: The status of the video stream pool in the configuration.
        PoolSize:
          type: integer
          description: The size of the video stream pool in the configuration.
        StreamConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamConfiguration'
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the configuration was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the configuration was updated.
    KinesisVideoStreamPoolSummary:
      type: object
      properties:
        PoolName:
          type: string
          description: The name of the video stream pool.
        PoolId:
          type: string
          description: The ID of the video stream pool.
        PoolArn:
          type: string
          description: The ARN of the video stream pool.
    ListMediaPipelineKinesisVideoStreamPoolsRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token used to return the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results to return in a single call.
    ListMediaPipelineKinesisVideoStreamPoolsResponse:
      type: object
      properties:
        KinesisVideoStreamPools:
          type: array
          items:
            $ref: '#/components/schemas/KinesisVideoStreamPoolSummary'
          description: The list of video stream pools.
        NextToken:
          type: string
          description: The token used to return the next page of results.
    MediaPipelinesChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeForbiddenException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
    MediaPipelinesChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeTag:
      type: object
      properties:
        Key:
          type: string
          description: The key half of a tag.
        Value:
          type: string
          description: The value half of a tag.
      required:
      - Key
      - Value
    MediaPipelinesChimeThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeUnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    UpdateMediaPipelineKinesisVideoStreamPoolRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the requested resource. Valid values include the name and ARN of the media
            pipeline Kinesis Video Stream pool.
        StreamConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamConfigurationUpdate'
      required:
      - Identifier
    UpdateMediaPipelineKinesisVideoStreamPoolResponse:
      type: object
      properties:
        KinesisVideoStreamPoolConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamPoolConfiguration'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)