Amazon Interactive Video Service GetStream API

openapi: 3.1.0
info:
  title: Amazon Interactive Video Service Getstream API
  version: '2020-07-14'
  description: Generated from AWS's published Smithy model for Amazon Interactive Video Service. 1 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://ivs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /GetStream:
    post:
      operationId: GetStream
      summary: Get Stream
      description: Gets information about the active (live) stream on a specified channel.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStreamResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '404':
          description: ChannelNotBroadcasting; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelNotBroadcasting'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetStreamRequest'
      tags:
      - Getstream
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: ivs
  schemas:
    AccessDeniedException:
      type: object
      properties:
        accessControlAllowOrigin:
          type: string
        accessControlExposeHeaders:
          type: string
        cacheControl:
          type: string
        contentSecurityPolicy:
          type: string
        strictTransportSecurity:
          type: string
        xContentTypeOptions:
          type: string
        xFrameOptions:
          type: string
        xAmznErrorType:
          type: string
        exceptionMessage:
          type: string
          description: User does not have sufficient access to perform this action.
    ChannelNotBroadcasting:
      type: object
      properties:
        accessControlAllowOrigin:
          type: string
        accessControlExposeHeaders:
          type: string
        cacheControl:
          type: string
        contentSecurityPolicy:
          type: string
        strictTransportSecurity:
          type: string
        xContentTypeOptions:
          type: string
        xFrameOptions:
          type: string
        xAmznErrorType:
          type: string
        exceptionMessage:
          type: string
          description: The stream is offline for the given channel ARN.
    GetStreamRequest:
      type: object
      properties:
        channelArn:
          type: string
          description: Channel ARN for stream to be accessed.
      required:
      - channelArn
    GetStreamResponse:
      type: object
      properties:
        stream:
          $ref: '#/components/schemas/Stream'
    Stream:
      type: object
      properties:
        channelArn:
          type: string
          description: Channel ARN for the stream.
        streamId:
          type: string
          description: Unique identifier for a live or previously live stream in the specified channel.
        playbackUrl:
          type: string
          description: URL of the master playlist, required by the video player to play the HLS stream.
        startTime:
          type: string
          format: date-time
          description: Time of the stream’s start. This is an ISO 8601 timestamp; note that this is returned as a string.
        state:
          type: string
          description: The stream’s state. Do not rely on the OFFLINE state, as the API may not return it; instead, a "NotBroadcasting"
            error will indicate that the stream is not live.
        health:
          type: string
          description: The stream’s health.
        viewerCount:
          type: integer
          description: A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds
            of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends.
            A value of -1 indicates that the request timed out; in this case, retry.
    ValidationException:
      type: object
      properties:
        accessControlAllowOrigin:
          type: string
        accessControlExposeHeaders:
          type: string
        cacheControl:
          type: string
        contentSecurityPolicy:
          type: string
        strictTransportSecurity:
          type: string
        xContentTypeOptions:
          type: string
        xFrameOptions:
          type: string
        xAmznErrorType:
          type: string
        exceptionMessage:
          type: string
          description: The input fails to satisfy the constraints specified by an Amazon Web Services service.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/ivs/service/2020-07-14/ivs-2020-07-14.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)