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-mediaconnect:amazon-mediaconnect-mediastreams-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: AWS MediaConnect Mediastreams API
  version: '2018-11-14'
  description: Generated from AWS's published Smithy model for AWS MediaConnect. 3 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://mediaconnect.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Mediastreams
paths:
  /v1/flows/{FlowArn}/mediaStreams:
    post:
      operationId: AddFlowMediaStreams
      summary: Add Flow Media Streams
      description: Adds media streams to an existing flow. After you add a media stream to a flow, you can associate it with a source and/or an output that uses the ST 2110 JPEG XS or CDI protocol.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddFlowMediaStreamsResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddFlowMediaStreamsRequest'
      tags:
      - Mediastreams
  /v1/flows/{FlowArn}/mediaStreams/{MediaStreamName}:
    delete:
      operationId: RemoveFlowMediaStream
      summary: Remove Flow Media Stream
      description: Removes a media stream from a flow. This action is only available if the media stream is not associated with a source or output.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveFlowMediaStreamResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveFlowMediaStreamRequest'
      tags:
      - Mediastreams
    put:
      operationId: UpdateFlowMediaStream
      summary: Update Flow Media Stream
      description: Updates an existing media stream.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFlowMediaStreamResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenException'
        '500':
          description: InternalServerErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
        '429':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFlowMediaStreamRequest'
      tags:
      - Mediastreams
components:
  schemas:
    ForbiddenException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    TooManyRequestsException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    FmtpRequest:
      type: object
      properties:
        ChannelOrder:
          type: string
          description: The format of the audio channel.
        Colorimetry:
          type: string
          enum:
          - BT601
          - BT709
          - BT2020
          - BT2100
          - ST2065-1
          - ST2065-3
          - XYZ
          description: The format that is used for the representation of color.
        ExactFramerate:
          type: string
          description: 'The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.'
        Par:
          type: string
          description: The pixel aspect ratio (PAR) of the video.
        Range:
          type: string
          enum:
          - NARROW
          - FULL
          - FULLPROTECT
          description: The encoding range of the video.
        ScanMode:
          type: string
          enum:
          - progressive
          - interlace
          - progressive-segmented-frame
          description: The type of compression that was used to smooth the video’s appearance.
        Tcs:
          type: string
          enum:
          - SDR
          - PQ
          - HLG
          - LINEAR
          - BT2100LINPQ
          - BT2100LINHLG
          - ST2065-1
          - ST428-1
          - DENSITY
          description: The transfer characteristic system (TCS) that is used in the video.
    MediaStream:
      type: object
      properties:
        Attributes:
          $ref: '#/components/schemas/MediaStreamAttributes'
        ClockRate:
          type: integer
          description: The sample rate for the stream. This value is measured in Hz.
        Description:
          type: string
          description: A description that can help you quickly identify what your media stream is used for.
        Fmt:
          type: integer
          description: The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
        MediaStreamId:
          type: integer
          description: A unique identifier for the media stream.
        MediaStreamName:
          type: string
          description: A name that helps you distinguish one media stream from another.
        MediaStreamType:
          type: string
          enum:
          - video
          - audio
          - ancillary-data
          description: The type of media stream.
        VideoFormat:
          type: string
          description: The resolution of the video.
      required:
      - Fmt
      - MediaStreamId
      - MediaStreamName
      - MediaStreamType
    UpdateFlowMediaStreamRequest:
      type: object
      properties:
        Attributes:
          $ref: '#/components/schemas/MediaStreamAttributesRequest'
        ClockRate:
          type: integer
          description: The sample rate for the stream. This value in measured in kHz.
        Description:
          type: string
          description: A description that can help you quickly identify what your media stream is used for.
        FlowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow that is associated with the media stream that you updated.
        MediaStreamName:
          type: string
          description: The media stream that you updated.
        MediaStreamType:
          type: string
          enum:
          - video
          - audio
          - ancillary-data
          description: The type of media stream.
        VideoFormat:
          type: string
          description: The resolution of the video.
      required:
      - FlowArn
      - MediaStreamName
    AddFlowMediaStreamsResponse:
      type: object
      properties:
        FlowArn:
          type: string
          description: The ARN of the flow that you added media streams to.
        MediaStreams:
          type: array
          items:
            $ref: '#/components/schemas/MediaStream'
          description: The media streams that you added to the flow.
    InternalServerErrorException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    Fmtp:
      type: object
      properties:
        ChannelOrder:
          type: string
          description: The format of the audio channel.
        Colorimetry:
          type: string
          enum:
          - BT601
          - BT709
          - BT2020
          - BT2100
          - ST2065-1
          - ST2065-3
          - XYZ
          description: The format used for the representation of color.
        ExactFramerate:
          type: string
          description: 'The frame rate for the video stream, in frames/second. For example: 60000/1001.'
        Par:
          type: string
          description: The pixel aspect ratio (PAR) of the video.
        Range:
          type: string
          enum:
          - NARROW
          - FULL
          - FULLPROTECT
          description: The encoding range of the video.
        ScanMode:
          type: string
          enum:
          - progressive
          - interlace
          - progressive-segmented-frame
          description: The type of compression that was used to smooth the video’s appearance.
        Tcs:
          type: string
          enum:
          - SDR
          - PQ
          - HLG
          - LINEAR
          - BT2100LINPQ
          - BT2100LINHLG
          - ST2065-1
          - ST428-1
          - DENSITY
          description: The transfer characteristic system (TCS) that is used in the video.
    MediaStreamAttributes:
      type: object
      properties:
        Fmtp:
          $ref: '#/components/schemas/Fmtp'
        Lang:
          type: string
          description: The audio language, in a format that is recognized by the receiver.
      required:
      - Fmtp
    AddFlowMediaStreamsRequest:
      type: object
      properties:
        FlowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        MediaStreams:
          type: array
          items:
            $ref: '#/components/schemas/AddMediaStreamRequest'
          description: The media streams that you want to add to the flow.
      required:
      - FlowArn
      - MediaStreams
    UpdateFlowMediaStreamResponse:
      type: object
      properties:
        FlowArn:
          type: string
          description: The ARN of the flow that is associated with the media stream that you updated.
        MediaStream:
          $ref: '#/components/schemas/MediaStream'
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    MediaStreamAttributesRequest:
      type: object
      properties:
        Fmtp:
          $ref: '#/components/schemas/FmtpRequest'
        Lang:
          type: string
          description: The audio language, in a format that is recognized by the receiver.
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    RemoveFlowMediaStreamResponse:
      type: object
      properties:
        FlowArn:
          type: string
          description: The ARN of the flow that was updated.
        MediaStreamName:
          type: string
          description: The name of the media stream that was removed.
    ServiceUnavailableException:
      type: object
      properties:
        Message:
          type: string
      required:
      - Message
    AddMediaStreamRequest:
      type: object
      properties:
        Attributes:
          $ref: '#/components/schemas/MediaStreamAttributesRequest'
        ClockRate:
          type: integer
          description: The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
        Description:
          type: string
          description: A description that can help you quickly identify what your media stream is used for.
        MediaStreamId:
          type: integer
          description: A unique identifier for the media stream.
        MediaStreamName:
          type: string
          description: A name that helps you distinguish one media stream from another.
        MediaStreamType:
          type: string
          enum:
          - video
          - audio
          - ancillary-data
          description: The type of media stream.
        VideoFormat:
          type: string
          description: The resolution of the video.
        MediaStreamTags:
          type: object
          additionalProperties:
            type: string
          description: The key-value pairs that can be used to tag and organize the media stream.
      required:
      - MediaStreamId
      - MediaStreamName
      - MediaStreamType
    RemoveFlowMediaStreamRequest:
      type: object
      properties:
        FlowArn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow that you want to update.
        MediaStreamName:
          type: string
          description: The name of the media stream that you want to remove.
      required:
      - FlowArn
      - MediaStreamName
  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: mediaconnect
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/mediaconnect/service/2018-11-14/mediaconnect-2018-11-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)