Amazon Chime SDK Chime Sdk Media Capture Pipelines API

The Chime Sdk Media Capture Pipelines API from Amazon Chime SDK — 2 operation(s) for chime sdk media capture pipelines.

GitHub OpenAPI

Operations 4

POST /sdk-media-capture-pipelines Create Media Capture Pipeline #
GET /sdk-media-capture-pipelines List Media Capture Pipelines #
DELETE /sdk-media-capture-pipelines/{MediaPipelineId} Delete Media Capture Pipeline #
GET /sdk-media-capture-pipelines/{MediaPipelineId} Get Media Capture Pipeline #

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-sdk-media-capture-pipelines-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-sdk-media-capture-pipelines-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Sdk Media Capture Pipelines API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 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://media-pipelines-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /sdk-media-capture-pipelines:
    post:
      operationId: CreateMediaCapturePipeline
      summary: Create Media Capture Pipeline
      description: Creates a media pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMediaCapturePipelineResponse'
        '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/CreateMediaCapturePipelineRequest'
      tags:
      - Sdk Media Capture Pipelines
    get:
      operationId: ListMediaCapturePipelines
      summary: List Media Capture Pipelines
      description: Returns a list of media pipelines.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMediaCapturePipelinesResponse'
        '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/ListMediaCapturePipelinesRequest'
      tags:
      - Sdk Media Capture Pipelines
  /sdk-media-capture-pipelines/{MediaPipelineId}:
    delete:
      operationId: DeleteMediaCapturePipeline
      summary: Delete Media Capture Pipeline
      description: Deletes the media pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteMediaCapturePipelineRequest'
      tags:
      - Sdk Media Capture Pipelines
    get:
      operationId: GetMediaCapturePipeline
      summary: Get Media Capture Pipeline
      description: Gets an existing media pipeline.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMediaCapturePipelineResponse'
        '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/GetMediaCapturePipelineRequest'
      tags:
      - Sdk Media Capture Pipelines
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:
    ActiveSpeakerOnlyConfiguration:
      type: object
      properties:
        ActiveSpeakerPosition:
          type: string
          enum:
          - TopLeft
          - TopRight
          - BottomLeft
          - BottomRight
          description: The position of the ActiveSpeakerOnly video tile.
    ArtifactsConfiguration:
      type: object
      properties:
        Audio:
          $ref: '#/components/schemas/AudioArtifactsConfiguration'
        Video:
          $ref: '#/components/schemas/VideoArtifactsConfiguration'
        Content:
          $ref: '#/components/schemas/ContentArtifactsConfiguration'
        CompositedVideo:
          $ref: '#/components/schemas/CompositedVideoArtifactsConfiguration'
      required:
      - Audio
      - Video
      - Content
    AudioArtifactsConfiguration:
      type: object
      properties:
        MuxType:
          type: string
          enum:
          - AudioOnly
          - AudioWithActiveSpeakerVideo
          - AudioWithCompositedVideo
          description: The MUX type of the audio artifact configuration object.
      required:
      - MuxType
    ChimeSdkMeetingConfiguration:
      type: object
      properties:
        SourceConfiguration:
          $ref: '#/components/schemas/SourceConfiguration'
        ArtifactsConfiguration:
          $ref: '#/components/schemas/ArtifactsConfiguration'
    CompositedVideoArtifactsConfiguration:
      type: object
      properties:
        Layout:
          type: string
          enum:
          - GridView
          description: The layout setting, such as GridView in the configuration object.
        Resolution:
          type: string
          enum:
          - HD
          - FHD
          description: 'The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution:
            1920 x 1080.'
        GridViewConfiguration:
          $ref: '#/components/schemas/GridViewConfiguration'
      required:
      - GridViewConfiguration
    ContentArtifactsConfiguration:
      type: object
      properties:
        State:
          type: string
          enum:
          - Enabled
          - Disabled
          description: Indicates whether the content artifact is enabled or disabled.
        MuxType:
          type: string
          enum:
          - ContentOnly
          description: The MUX type of the artifact configuration.
      required:
      - State
    CreateMediaCapturePipelineRequest:
      type: object
      properties:
        SourceType:
          type: string
          enum:
          - ChimeSdkMeeting
          description: Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported
            source.
        SourceArn:
          type: string
          description: ARN of the source from which the media artifacts are captured.
        SinkType:
          type: string
          enum:
          - S3Bucket
          description: Destination type to which the media artifacts are saved. You must use an S3 bucket.
        SinkArn:
          type: string
          description: The ARN of the sink type.
        ClientRequestToken:
          type: string
          description: The unique identifier for the client request. The token makes the API request idempotent. Use a unique
            token for each media pipeline request.
        ChimeSdkMeetingConfiguration:
          $ref: '#/components/schemas/ChimeSdkMeetingConfiguration'
        SseAwsKeyManagementParams:
          $ref: '#/components/schemas/SseAwsKeyManagementParams'
        SinkIamRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.
            Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on
            behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform
            sink-related actions are the same for SinkIamRoleArn. Additionally, the role must have permission to kms:GenerateDataKey
            using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later,
            the role must also have permission t
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/MediaPipelinesChimeTag'
          description: The tag key-value pairs.
      required:
      - SourceType
      - SourceArn
      - SinkType
      - SinkArn
    CreateMediaCapturePipelineResponse:
      type: object
      properties:
        MediaCapturePipeline:
          $ref: '#/components/schemas/MediaCapturePipeline'
    DeleteMediaCapturePipelineRequest:
      type: object
      properties:
        MediaPipelineId:
          type: string
          description: The ID of the media pipeline being deleted.
      required:
      - MediaPipelineId
    GetMediaCapturePipelineRequest:
      type: object
      properties:
        MediaPipelineId:
          type: string
          description: The ID of the pipeline that you want to get.
      required:
      - MediaPipelineId
    GetMediaCapturePipelineResponse:
      type: object
      properties:
        MediaCapturePipeline:
          $ref: '#/components/schemas/MediaCapturePipeline'
    GridViewConfiguration:
      type: object
      properties:
        ContentShareLayout:
          type: string
          enum:
          - PresenterOnly
          - Horizontal
          - Vertical
          - ActiveSpeakerOnly
          description: Defines the layout of the video tiles when content sharing is enabled.
        PresenterOnlyConfiguration:
          $ref: '#/components/schemas/PresenterOnlyConfiguration'
        ActiveSpeakerOnlyConfiguration:
          $ref: '#/components/schemas/ActiveSpeakerOnlyConfiguration'
        HorizontalLayoutConfiguration:
          $ref: '#/components/schemas/HorizontalLayoutConfiguration'
        VerticalLayoutConfiguration:
          $ref: '#/components/schemas/VerticalLayoutConfiguration'
        VideoAttribute:
          $ref: '#/components/schemas/VideoAttribute'
        CanvasOrientation:
          type: string
          enum:
          - Landscape
          - Portrait
          description: The orientation setting, horizontal or vertical.
      required:
      - ContentShareLayout
    HorizontalLayoutConfiguration:
      type: object
      properties:
        TileOrder:
          type: string
          enum:
          - JoinSequence
          - SpeakerSequence
          description: Sets the automatic ordering of the video tiles.
        TilePosition:
          type: string
          enum:
          - Top
          - Bottom
          description: Sets the position of horizontal tiles.
        TileCount:
          type: integer
          description: The maximum number of video tiles to display.
        TileAspectRatio:
          type: string
          description: Specifies the aspect ratio of all video tiles.
    ListMediaCapturePipelinesRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: The token used to retrieve the next page of results.
        MaxResults:
          type: integer
          description: 'The maximum number of results to return in a single call. Valid Range: 1 - 99.'
    ListMediaCapturePipelinesResponse:
      type: object
      properties:
        MediaCapturePipelines:
          type: array
          items:
            $ref: '#/components/schemas/MediaCapturePipelineSummary'
          description: The media pipeline objects in the list.
        NextToken:
          type: string
          description: The token used to retrieve the next page of results.
    MediaCapturePipeline:
      type: object
      properties:
        MediaPipelineId:
          type: string
          description: The ID of a media pipeline.
        MediaPipelineArn:
          type: string
          description: The ARN of the media capture pipeline
        SourceType:
          type: string
          enum:
          - ChimeSdkMeeting
          description: Source type from which media artifacts are saved. You must use ChimeMeeting.
        SourceArn:
          type: string
          description: ARN of the source from which the media artifacts are saved.
        Status:
          type: string
          enum:
          - Initializing
          - InProgress
          - Failed
          - Stopping
          - Stopped
          - Paused
          - NotStarted
          description: The status of the media pipeline.
        SinkType:
          type: string
          enum:
          - S3Bucket
          description: Destination type to which the media artifacts are saved. You must use an S3 Bucket.
        SinkArn:
          type: string
          description: ARN of the destination to which the media artifacts are saved.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the pipeline was created, in ISO 8601 format.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the pipeline was updated, in ISO 8601 format.
        ChimeSdkMeetingConfiguration:
          $ref: '#/components/schemas/ChimeSdkMeetingConfiguration'
        SseAwsKeyManagementParams:
          $ref: '#/components/schemas/SseAwsKeyManagementParams'
        SinkIamRoleArn:
          type: string
          description: The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.
    MediaCapturePipelineSummary:
      type: object
      properties:
        MediaPipelineId:
          type: string
          description: The ID of the media pipeline in the summary.
        MediaPipelineArn:
          type: string
          description: The ARN of the media pipeline in the summary.
    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.
    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.
    PresenterOnlyConfiguration:
      type: object
      properties:
        PresenterPosition:
          type: string
          enum:
          - TopLeft
          - TopRight
          - BottomLeft
          - BottomRight
          description: 'Defines the position of the presenter video tile. Default: TopRight.'
    SelectedVideoStreams:
      type: object
      properties:
        AttendeeIds:
          type: array
          items:
            type: string
          description: The attendee IDs of the streams selected for a media pipeline.
        ExternalUserIds:
          type: array
          items:
            type: string
          description: The external user IDs of the streams selected for a media pipeline.
    SourceConfiguration:
      type: object
      properties:
        SelectedVideoStreams:
          $ref: '#/components/schemas/SelectedVideoStreams'
    SseAwsKeyManagementParams:
      type: object
      properties:
        AwsKmsKeyId:
          type: string
          description: 'The KMS key you want to use to encrypt your media pipeline output. Decryption is required for concatenation
            pipeline. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one
            of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the
            KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example,
            arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For
            example, arn:aws:kms:region:account-ID:ali'
        AwsKmsEncryptionContext:
          type: string
          description: Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as non-secret
            key-value pair known as encryption context pairs, that provides an added layer of security for your data. For
            more information, see KMS encryption context and Asymmetric keys in KMS in the Key Management Service Developer
            Guide.
      required:
      - AwsKmsKeyId
    VerticalLayoutConfiguration:
      type: object
      properties:
        TileOrder:
          type: string
          enum:
          - JoinSequence
          - SpeakerSequence
          description: Sets the automatic ordering of the video tiles.
        TilePosition:
          type: string
          enum:
          - Left
          - Right
          description: Sets the position of vertical tiles.
        TileCount:
          type: integer
          description: The maximum number of tiles to display.
        TileAspectRatio:
          type: string
          description: Sets the aspect ratio of the video tiles, such as 16:9.
    VideoArtifactsConfiguration:
      type: object
      properties:
        State:
          type: string
          enum:
          - Enabled
          - Disabled
          description: Indicates whether the video artifact is enabled or disabled.
        MuxType:
          type: string
          enum:
          - VideoOnly
          description: The MUX type of the video artifact configuration object.
      required:
      - State
    VideoAttribute:
      type: object
      properties:
        CornerRadius:
          type: integer
          description: Sets the corner radius of all video tiles.
        BorderColor:
          type: string
          enum:
          - Black
          - Blue
          - Red
          - Green
          - White
          - Yellow
          description: Defines the border color of all video tiles.
        HighlightColor:
          type: string
          enum:
          - Black
          - Blue
          - Red
          - Green
          - White
          - Yellow
          description: Defines the highlight color for the active video tile.
        BorderThickness:
          type: integer
          description: Defines the border thickness for all video tiles.
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)