Amazon Interactive Video Service · JSON Structure

Ivs List Stream Keys Request Structure

ListStreamKeysRequest schema

Type: object Properties: 3 Required: 1
Live StreamingMediaVideoReal-Time

ListStreamKeysRequest is a JSON Structure definition published by Amazon Interactive Video Service, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

channelArn maxResults nextToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-structure/ivs-list-stream-keys-request-structure.json",
  "name": "ListStreamKeysRequest",
  "description": "ListStreamKeysRequest schema",
  "type": "object",
  "properties": {
    "channelArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelArn"
        },
        {
          "description": "Channel ARN used to filter the list."
        }
      ]
    },
    "maxResults": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxStreamKeyResults"
        },
        {
          "description": "Maximum number of streamKeys to return. Default: 1."
        }
      ]
    },
    "nextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationToken"
        },
        {
          "description": "The first stream key to retrieve. This is used for pagination; see the <code>nextToken</code> response field."
        }
      ]
    }
  },
  "required": [
    "channelArn"
  ]
}