openapi: 3.0.0
info:
  version: '2020-07-14'
  x-release: v4
  title: Amazon Interactive Video Service BatchGetChannel GetStreamSession API
  description: '<p> <b>Introduction</b> </p> <p>The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.</p> <p>The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/ivs.html">Amazon IVS page</a> in the <i>Amazon Web Services General Reference</i>.</p> <p> <i> <b>All API request parameters and URLs are case sensitive. </b> </i> </p> <p>For a summary of notable documentation changes in each release, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html"> Document History</a>.</p> <p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p> <b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information. </p> </li> <li> <p> <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p> <b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.</p> </li> <li> <p> <b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.</p> <p>Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html"> Access Tags</a>). </p> <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.</p> <p>At most 50 tags can be applied to a resource. </p> <p> <b>Authentication versus Authorization</b> </p> <p>Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition, authorization is needed to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for "playback authorization.")</p> </li> </ul> <p> <b>Authentication</b> </p> <p>All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.</p> <p>You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from a user account that has the <code>ivs:PutMetadata</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Amazon Resource Names (ARNs)</b> </p> <p>ARNs uniquely identify AWS resources. An ARN is required when you need to specify a resource unambiguously across all of AWS, such as in IAM policies and API calls. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General Reference</i>.</p> <p> <b>Channel Endpoints</b> </p> <ul> <li> <p> <a>CreateChannel</a> — Creates a new channel and an associated stream key to start streaming.</p> </li> <li> <p> <a>GetChannel</a> — Gets the channel configuration for the specified channel ARN.</p> </li> <li> <p> <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListChannels</a> — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).</p> </li> <li> <p> <a>UpdateChannel</a> — Updates a channel''s configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.</p> </li> <li> <p> <a>DeleteChannel</a> — Deletes the specified channel.</p> </li> </ul> <p> <b>StreamKey Endpoints</b> </p> <ul> <li> <p> <a>CreateStreamKey</a> — Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> </li> <li> <p> <a>GetStreamKey</a> — Gets stream key information for the specified ARN.</p> </li> <li> <p> <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListStreamKeys</a> — Gets summary information about stream keys for the specified channel.</p> </li> <li> <p> <a>DeleteStreamKey</a> — Deletes the stream key for the specified ARN, so it can no longer be used to stream.</p> </li> </ul> <p> <b>Stream Endpoints</b> </p> <ul> <li> <p> <a>GetStream</a> — Gets information about the active (live) stream on a specified channel.</p> </li> <li> <p> <a>GetStreamSession</a> — Gets metadata on a specified stream.</p> </li> <li> <p> <a>ListStreams</a> — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>ListStreamSessions</a> — Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.</p> </li> <li> <p> <a>StopStream</a> — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> </li> <li> <p> <a>PutMetadata</a> — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.</p> </li> </ul> <p> <b>Private Channel Endpoints</b> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p> <ul> <li> <p> <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).</p> </li> <li> <p> <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.</p> </li> <li> <p> <a>ListPlaybackKeyPairs</a> — Gets summary information about playback key pairs.</p> </li> <li> <p> <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p> </li> <li> <p> <a>StartViewerSessionRevocation</a> — Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version.</p> </li> <li> <p> <a>BatchStartViewerSessionRevocation</a> — Performs <a>StartViewerSessionRevocation</a> on multiple channel ARN and viewer ID pairs simultaneously.</p> </li> </ul> <p> <b>RecordingConfiguration Endpoints</b> </p> <ul> <li> <p> <a>CreateRecordingConfiguration</a> — Creates a new recording configuration, used to enable recording to Amazon S3.</p> </li> <li> <p> <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata for the specified ARN.</p> </li> <li> <p> <a>ListRecordingConfigurations</a> — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>DeleteRecordingConfiguration</a> — Deletes the recording configuration for the specified ARN.</p> </li> </ul> <p> <b>Amazon Web Services Tags Endpoints</b> </p> <ul> <li> <p> <a>TagResource</a> — Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> <li> <p> <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p> </li> </ul>'
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: ivs
  x-aws-signingName: ivs
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ivs-2020-07-14.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://ivs.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon IVS multi-region endpoint
- url: https://ivs.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon IVS multi-region endpoint
- url: http://ivs.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
- url: https://ivs.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: GetStreamSession
paths:
  /GetStreamSession:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: GetStreamSession
      description: Gets metadata on a specified stream.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStreamSessionResponse'
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - channelArn
              properties:
                channelArn:
                  description: ARN of the channel resource
                  type: string
                  pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$
                  minLength: 1
                  maxLength: 128
                streamId:
                  description: Unique identifier for a live or previously live stream in the specified channel. If no <code>streamId</code> is provided, this returns the most recent stream session for the channel, if it exists.
                  type: string
                  pattern: ^st-[a-zA-Z0-9]+$
                  minLength: 26
                  maxLength: 26
      summary: Amazon Interactive Video Service Get Stream Session
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - GetStreamSession
components:
  schemas:
    InsecureIngest:
      type: boolean
    RenditionConfigurationRenditionList:
      type: array
      items:
        $ref: '#/components/schemas/RenditionConfigurationRendition'
    ChannelLatencyMode:
      type: string
      enum:
      - NORMAL
      - LOW
    GetStreamSessionResponse:
      type: object
      properties:
        streamSession:
          allOf:
          - $ref: '#/components/schemas/StreamSession'
          - description: List of stream details.
    ChannelName:
      type: string
      pattern: ^[a-zA-Z0-9-_]*$
      minLength: 0
      maxLength: 128
    String:
      type: string
    StreamEvent:
      type: object
      properties:
        eventTime:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: Time when the event occurred. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
        name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Name that identifies the stream event within a <code>type</code>.
        type:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Logical group for certain events.
      description: Object specifying a stream’s events. For a list of events, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html">Using Amazon EventBridge with Amazon IVS</a>.
    Integer:
      type: integer
    ThumbnailConfigurationStorageList:
      type: array
      items:
        $ref: '#/components/schemas/ThumbnailConfigurationStorage'
    RecordingConfigurationState:
      type: string
      enum:
      - CREATING
      - CREATE_FAILED
      - ACTIVE
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    ThumbnailConfiguration:
      type: object
      properties:
        recordingMode:
          allOf:
          - $ref: '#/components/schemas/RecordingMode'
          - description: 'Thumbnail recording mode. Default: <code>INTERVAL</code>.'
        resolution:
          allOf:
          - $ref: '#/components/schemas/ThumbnailConfigurationResolution'
          - description: 'Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the selected resolution if the corresponding rendition is available during the stream; otherwise, they are recorded at source resolution. For more information about resolution values and their corresponding height and width dimensions, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>. Default: Null (source resolution is returned).'
        storage:
          allOf:
          - $ref: '#/components/schemas/ThumbnailConfigurationStorageList'
          - description: 'Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all generated thumbnails in a serial manner, to the media/thumbnails directory. <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.'
        targetIntervalSeconds:
          allOf:
          - $ref: '#/components/schemas/TargetIntervalSeconds'
          - description: '<p>The targeted thumbnail-generation interval in seconds. This is configurable (and required) only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p> <p> <b>Important:</b> For the <code>BASIC</code> channel type, setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the input video must be less than the <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming Configuration</a> for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder settings.</p>'
      description: An object representing a configuration of thumbnails for recorded video.
    RecordingConfigurationName:
      type: string
      pattern: ^[a-zA-Z0-9-_]*$
      minLength: 0
      maxLength: 128
    VideoConfiguration:
      type: object
      properties:
        avcLevel:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.
        avcProfile:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.
        codec:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Codec used for the video encoding.
        encoder:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Software or hardware used to encode the video.
        targetBitrate:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The expected ingest bitrate (bits per second). This is configured in the encoder.
        targetFramerate:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The expected ingest framerate. This is configured in the encoder.
        videoHeight:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Video-resolution height in pixels.
        videoWidth:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Video-resolution width in pixels.
      description: Object specifying a stream’s video configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfiguration</a> object and used for monitoring stream health.
    ChannelType:
      type: string
      enum:
      - BASIC
      - STANDARD
      - ADVANCED_SD
      - ADVANCED_HD
    RenditionConfiguration:
      type: object
      properties:
        renditionSelection:
          allOf:
          - $ref: '#/components/schemas/RenditionConfigurationRenditionSelection'
          - description: 'Indicates which set of renditions are recorded for a stream. For <code>BASIC</code> channels, the <code>CUSTOM</code> value has no effect. If <code>CUSTOM</code> is specified, a set of renditions must be specified in the <code>renditions</code> field. Default: <code>ALL</code>.'
        renditions:
          allOf:
          - $ref: '#/components/schemas/RenditionConfigurationRenditionList'
          - description: Indicates which renditions are recorded for a stream, if <code>renditionSelection</code> is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are recorded if they are available during the stream. If a selected rendition is unavailable, the best available rendition is recorded. For details on the resolution dimensions of each rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.
      description: Object that describes which renditions should be recorded for a stream.
    ChannelArn:
      type: string
      pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$
      minLength: 1
      maxLength: 128
    ChannelRecordingConfigurationArn:
      type: string
      pattern: ^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$
      minLength: 0
      maxLength: 128
    TargetIntervalSeconds:
      type: integer
      minimum: 1
      maximum: 60
    TranscodePreset:
      type: string
      enum:
      - HIGHER_BANDWIDTH_DELIVERY
      - CONSTRAINED_BANDWIDTH_DELIVERY
    StreamId:
      type: string
      pattern: ^st-[a-zA-Z0-9]+$
      minLength: 26
      maxLength: 26
    DestinationConfiguration:
      type: object
      properties:
        s3:
          allOf:
          - $ref: '#/components/schemas/S3DestinationConfiguration'
          - description: An S3 destination configuration where recorded videos will be stored.
      description: A complex type that describes a location where recorded videos will be stored. Each member represents a type of destination configuration. For recording, you define one and only one type of destination configuration.
    S3DestinationConfiguration:
      type: object
      required:
      - bucketName
      properties:
        bucketName:
          allOf:
          - $ref: '#/components/schemas/S3DestinationBucketName'
          - description: Location (S3 bucket name) where recorded videos will be stored.
      description: A complex type that describes an S3 location where recorded videos will be stored.
    AudioConfiguration:
      type: object
      properties:
        channels:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Number of audio channels.
        codec:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Codec used for the audio encoding.
        sampleRate:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: Number of audio samples recorded per second.
        targetBitrate:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The expected ingest bitrate (bits per second). This is configured in the encoder.
      description: Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfiguration</a> object and used for monitoring stream health.
    RenditionConfigurationRenditionSelection:
      type: string
      enum:
      - ALL
      - NONE
      - CUSTOM
    S3DestinationBucketName:
      type: string
      pattern: ^[a-z0-9-.]+$
      minLength: 3
      maxLength: 63
    RenditionConfigurationRendition:
      type: string
      enum:
      - FULL_HD
      - HD
      - SD
      - LOWEST_RESOLUTION
    RecordingReconnectWindowSeconds:
      type: integer
      minimum: 0
      maximum: 300
    RecordingMode:
      type: string
      enum:
      - DISABLED
      - INTERVAL
    ThumbnailConfigurationStorage:
      type: string
      enum:
      - SEQUENTIAL
      - LATEST
    ResourceNotFoundException: {}
    RecordingConfigurationArn:
      type: string
      pattern: ^arn:aws:ivs:[a-z0-9-]+:[0-9]+:recording-configuration/[a-zA-Z0-9-]+$
      minLength: 0
      maxLength: 128
    StreamEvents:
      type: array
      items:
        $ref: '#/components/schemas/StreamEvent'
      minItems: 0
      maxItems: 500
    Channel:
      type: object
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/ChannelArn'
          - description: Channel ARN.
        authorized:
          allOf:
          - $ref: '#/components/schemas/IsAuthorized'
          - description: 'Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.'
        ingestEndpoint:
          allOf:
          - $ref: '#/components/schemas/IngestEndpoint'
          - description: Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
        insecureIngest:
          allOf:
          - $ref: '#/components/schemas/InsecureIngest'
          - description: 'Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.'
        latencyMode:
          allOf:
          - $ref: '#/components/schemas/ChannelLatencyMode'
          - description: 'Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)'
        name:
          allOf:
          - $ref: '#/components/schemas/ChannelName'
          - description: Channel name.
        playbackUrl:
          allOf:
          - $ref: '#/components/schemas/PlaybackURL'
          - description: Channel playback URL.
        preset:
          allOf:
          - $ref: '#/components/schemas/TranscodePreset'
          - description: Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty string (<code>""</code>).
        recordingConfigurationArn:
          allOf:
          - $ref: '#/components/schemas/ChannelRecordingConfigurationArn'
          - description: 'Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).'
        tags:
          allOf:
          - $ref: '#/components/schemas/Tags'
          - description: Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
        type:
          allOf:
          - $ref: '#/components/schemas/ChannelType'
          - description: '<p>Channel type, which determines the allowable resolution and bitrate. <i>If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately.</i> Some types generate multiple qualities (renditions) from the original input; this automatically gives viewers the best experience for their devices and network conditions. Some types provide transcoded video; transcoding allows higher playback quality across a range of download speeds. Default: <code>STANDARD</code>. Valid values:</p> <ul> <li> <p> <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input quality to viewers. The viewer’s video-quality choice is limited to the original input. Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.</p> </li> <li> <p> <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Transcoding allows higher playback quality across a range of download speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only for renditions 360p and below; above that, audio is passed through. This is the default when you create a channel.</p> </li> <li> <p> <code>ADVANCED_SD</code>: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at SD quality (480p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.</p> </li> <li> <p> <code>ADVANCED_HD</code>: Video is transcoded; multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5 Mbps; output is capped at HD quality (720p). You can select an optional transcode preset (see below). Audio for all renditions is transcoded, and an audio-only rendition is available.</p> </li> </ul> <p>Optional <i>transcode presets</i> (available for the <code>ADVANCED</code> types) allow you to trade off available download bandwidth and video quality, to optimize the viewing experience. There are two presets:</p> <ul> <li> <p> <i>Constrained bandwidth delivery</i> uses a lower bitrate for each quality level. Use it if you have low download bandwidth and/or simple video content (e.g., talking heads)</p> </li> <li> <p> <i>Higher bandwidth delivery</i> uses a higher bitrate for each quality level. Use it if you have high download bandwidth and/or complex video content (e.g., flashes and quick scene changes).</p> </li> </ul>'
      description: Object specifying a channel.
    IngestEndpoint:
      type: string
    AccessDeniedException: {}
    PlaybackURL:
      type: string
    StreamSession:
      type: object
      properties:
        channel:
          allOf:
          - $ref: '#/components/schemas/Channel'
          - description: The properties of the channel at the time of going live.
        endTime:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>. For live streams, this is <code>NULL</code>.
        ingestConfiguration:
          allOf:
          - $ref: '#/components/schemas/IngestConfiguration'
          - description: The properties of the incoming RTMP stream for the stream.
        recordingConfiguration:
          allOf:
          - $ref: '#/components/schemas/RecordingConfiguration'
          - description: The properties of recording the live stream.
        startTime:
          allOf:
          - $ref: '#/components/schemas/Time'
          - description: Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
        streamId:
          allOf:
          - $ref: '#/components/schemas/StreamId'
          - description: Unique identifier for a live or previously live stream in the specified channel.
        truncatedEvents:
          allOf:
          - $ref: '#/components/schemas/StreamEvents'
          - description: List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html">Using Amazon EventBridge with Amazon IVS</a>.
      description: Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.
    RecordingConfiguration:
      type: object
      required:
      - arn
      - destinationConfiguration
      - state
      properties:
        arn:
          allOf:
          - $ref: '#/components/schemas/RecordingConfigurationArn'
          - description: Recording-configuration ARN.
        destinationConfiguration:
          allOf:
          - $ref: '#/components/schemas/DestinationConfiguration'
          - description: A complex type that contains information about where recorded video will be stored.
        name:
          allOf:
          - $ref: '#/components/schemas/RecordingConfigurationName'
          - description: Recording-configuration name. The value does not need to be unique.
        recordingReconnectWindowSeconds:
          allOf:
          - $ref: '#/components/schemas/RecordingReconnectWindowSeconds'
          - description: 'If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. Default: 0.'
        renditionConfiguration:
          allOf:
          - $ref: '#/components/schemas/RenditionConfiguration'
          - description: Object that describes which renditions should be recorded for a stream.
        state:
          allOf:
          - $ref: '#/components/schemas/RecordingConfigurationState'
          - description: Indicates the current state of the recording configuration. When the state is <code>ACTIVE</code>, the configuration is ready for recording a channel stream.
        tags:
          allOf:
          - $ref: '#/components/schemas/Tags'
          - description: Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
        thumbnailConfiguration:
          allOf:
          - $ref: '#/components/schemas/ThumbnailConfiguration'
          - description: A complex type that allows you to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
      description: An object representing a configuration to record a channel stream.
    Tags:
      type: object
      minProperties: 0
      maxProperties: 50
      additionalProperties:
        $ref: '#/components/schemas/TagValue'
    Time:
      type: string
      format: date-time
    IsAuthorized:
      type: boolean
    IngestConfiguration:
      type: object
      properties:
        audio:
          allOf:
          - $ref: '#/components/schemas/AudioConfiguration'
          - description: Encoder settings for audio.
        video:
          allOf:
          - $ref: '#/components/schemas/VideoConfiguration'
          - description: Encoder settings for video.
      description: Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.
    ValidationException: {}
    ThumbnailConfigurationResolution:
      type: string
      enum:
      - FULL_HD
      - HD
      - SD
      - LOWEST_RESOLUTION
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/ivs/
x-hasEquivalentPaths: true