AWS Kinesis · Schema

UpdateStreamInput

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
StreamName object
StreamARN object
CurrentVersion object
DeviceName object
MediaType object
View JSON Schema on GitHub

JSON Schema

kinesis-updatestreaminput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateStreamInput",
  "title": "UpdateStreamInput",
  "type": "object",
  "required": [
    "CurrentVersion"
  ],
  "properties": {
    "StreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamName"
        },
        {
          "description": "<p>The name of the stream whose metadata you want to update.</p> <p>The stream name is an identifier for the stream, and must be unique for each account and region.</p>"
        }
      ]
    },
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceARN"
        },
        {
          "description": "The ARN of the stream whose metadata you want to update."
        }
      ]
    },
    "CurrentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Version"
        },
        {
          "description": "The version of the stream whose metadata you want to update."
        }
      ]
    },
    "DeviceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceName"
        },
        {
          "description": "<p>The name of the device that is writing to the stream. </p> <note> <p> In the current implementation, Kinesis Video Streams does not use this name. </p> </note>"
        }
      ]
    },
    "MediaType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MediaType"
        },
        {
          "description": "<p>The stream's media type. Use <code>MediaType</code> to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see <a href=\"http://www.iana.org/assignments/media-types/media-types.xhtml\">Media Types</a>. If you choose to specify the <code>MediaType</code>, see <a href=\"https://tools.ietf.org/html/rfc6838#section-4.2\">Naming Requirements</a>.</p> <p>To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify <code>video/h264</code> as the <code>MediaType</code>.</p>"
        }
      ]
    }
  }
}