Amazon MediaTailor · JSON Structure

Mediatailor Api Channel Structure

The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Type: object Properties: 11 Required: 7
BroadcastingMedia ProcessingMedia

Channel is a JSON Structure definition published by Amazon MediaTailor, describing 11 properties, of which 7 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Arn ChannelName ChannelState CreationTime FillerSlate LastModifiedTime LogConfiguration Outputs PlaybackMode Tags Tier

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-mediatailor/refs/heads/main/json-structure/mediatailor-api-channel-structure.json",
  "name": "Channel",
  "type": "object",
  "description": "The configuration parameters for a channel. For information about MediaTailor channels, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html\">Working with channels</a> in the <i>MediaTailor User Guide</i>.",
  "properties": {
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The ARN of the channel."
        }
      ]
    },
    "ChannelName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The name of the channel."
        }
      ]
    },
    "ChannelState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "Returns the state whether the channel is running or not."
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__timestampUnix"
        },
        {
          "description": "The timestamp of when the channel was created."
        }
      ]
    },
    "FillerSlate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SlateSource"
        },
        {
          "description": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>."
        }
      ]
    },
    "LastModifiedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__timestampUnix"
        },
        {
          "description": "The timestamp of when the channel was last modified."
        }
      ]
    },
    "LogConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LogConfigurationForChannel"
        },
        {
          "description": "The log configuration."
        }
      ]
    },
    "Outputs": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResponseOutputs"
        },
        {
          "description": "The channel's output properties."
        }
      ]
    },
    "PlaybackMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "<p>The type of playback mode for this channel.</p> <p> <code>LINEAR</code> - Programs play back-to-back only once.</p> <p> <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>"
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__mapOf__string"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html\">Tagging AWS Elemental MediaTailor Resources</a>."
        }
      ]
    },
    "Tier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The tier for this channel. STANDARD tier channels can contain live programs."
        }
      ]
    }
  },
  "required": [
    "Arn",
    "ChannelName",
    "ChannelState",
    "LogConfiguration",
    "Outputs",
    "PlaybackMode",
    "Tier"
  ]
}