Amazon MediaTailor · JSON Structure

Mediatailor Api Create Prefetch Schedule Request Structure

CreatePrefetchScheduleRequest schema from Amazon MediaTailor API

Type: object Properties: 3 Required: 2
BroadcastingMedia ProcessingMedia

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

Properties

Consumption Retrieval StreamId

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-create-prefetch-schedule-request-structure.json",
  "name": "CreatePrefetchScheduleRequest",
  "type": "object",
  "description": "CreatePrefetchScheduleRequest schema from Amazon MediaTailor API",
  "properties": {
    "Consumption": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PrefetchConsumption"
        },
        {
          "description": "The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time."
        }
      ]
    },
    "Retrieval": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PrefetchRetrieval"
        },
        {
          "description": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break."
        }
      ]
    },
    "StreamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>."
        }
      ]
    }
  },
  "required": [
    "Consumption",
    "Retrieval"
  ]
}