list-prefetch-schedules

Описание

Перечисляет расписания предварительной загрузки для конфигурации воспроизведения.

См. также: Документацию API AWS

list-prefetch-schedules — это операция с постраничной выборкой. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную выборку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной выборкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Items

Синтаксис

  list-prefetch-schedules
--playback-configuration-name <value>
[--schedule-type <value>]
[--stream-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--playback-configuration-name (строка)

Получает расписание(я) предварительной загрузки для определенной конфигурации воспроизведения.

--schedule-type (строка)

Тип расписаний предварительной загрузки, которые вы хотите получить. SINGLE указывает, что вы хотите получить список конфигурированных расписаний предварительной загрузки. RECURRING указывает, что вы хотите получить список конфигурированных повторяющихся расписаний предварительной загрузки. ALL указывает, что вы хотите получить список всех конфигурированных расписаний предварительной загрузки.

Возможные значения:

SINGLE
RECURRING
ALL

--stream-id (строка)

Дополнительный параметр фильтрации, с помощью которого MediaTailor фильтрует расписания предварительной загрузки, чтобы включать только определенные потоки.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, с какой позиции начать постраничную выборку. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы, получаемой в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной выборки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная выборка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение без значения или со значением input, выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, оно выведет пример YAML-ввода, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию команды предоставленным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную выборку. Если автоматическая постраничная выборка отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружаться, если этот аргумент предоставлен.

--ca-bundle (строка)

Набор сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое отображается в двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы cli.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Элементы -> (список)

Перечисляет расписания предварительной загрузки. Пустой список Items не означает, что больше нет элементов для загрузки, а только то, что страница была пустой.

(структура)

Расписание предварительной загрузки позволяет сообщить MediaTailor о необходимости загрузки и подготовки определенных рекламных объявлений перед рекламной паузой. Дополнительную информацию о предварительной загрузке рекламы см. в разделе «Использование предварительной загрузки рекламы» в Руководстве пользователя MediaTailor.

Arn -> (строка)

Идентификатор ресурса Amazon (ARN) расписания предварительной загрузки.

Потребление -> (структура)

Параметры потребления определяют, как и когда MediaTailor помещает предварительно загруженные рекламные объявления в рекламные паузы для отдельных расписаний предварительной загрузки. Потребление рекламы происходит в заданном вами временном интервале, называемом окном потребления. Вы можете указать, в какие рекламные паузы MediaTailor заполняет предварительно загруженными рекламой, установив критерии соответствия доступности.

Критерии соответствия доступности -> (список)

Если вы хотите, чтобы MediaTailor вставлял предварительно загруженные рекламные объявления только в те рекламные паузы (доступные блоки), которые соответствуют определенным динамическим переменным, таким как scte.event_id, установите критерии соответствия доступности.

(структура)

MediaTailor помещает (потребляет) предварительно загруженные рекламные объявления только в том случае, если рекламная пауза соответствует критериям, определённым динамическими переменными. Это даёт вам точный контроль над тем, в какую рекламную паузу поместить предварительно загруженные рекламные объявления.

Например, предположим, что вы установили DynamicVariable на scte.event_id и Operator на EQUALS, а ваша конфигурация воспроизведения имеет URL-адрес ADS https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. А запрос предварительной загрузки в ADS содержит эти значения https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor вставит предварительно загруженные рекламные объявления в рекламную паузу только в том случае, если в ней есть метка SCTE с идентификатором события my-awesome-event, так как она должна соответствовать идентификатору события, используемому MediaTailor для запроса к ADS.

Вы можете указать до пяти AvailMatchingCriteria. Если вы указываете несколько AvailMatchingCriteria, MediaTailor комбинирует их для соответствия, используя логическую AND. Логические OR комбинации можно смоделировать, создав несколько расписаний предварительной загрузки.

Динамическая переменная -> (строка)

Динамические переменные, которые MediaTailor должен использовать в качестве критериев соответствия доступности. MediaTailor помещает предварительно загруженные рекламные объявления в доступный блок только в том случае, если доступный блок соответствует критериям, определённым динамической переменной. Сведения о динамических переменных см. в разделе «Использование динамических переменных рекламы» в Руководстве пользователя MediaTailor.

Вы можете включить до 100 динамических переменных.

Оператор -> (строка)

Для DynamicVariable, указанного в AvailMatchingCriteria, оператор, используемый для сравнения.

Время окончания -> (метка времени)

Время, после которого MediaTailor больше не рассматривает предварительно загруженные рекламные объявления для использования в рекламной паузе. MediaTailor автоматически удаляет расписания предварительной загрузки не менее чем через семь дней после времени окончания. Если вы хотите вручную удалить расписание предварительной загрузки, вы можете вызвать DeletePrefetchSchedule.

Время начала -> (метка времени)

Время, с которого предварительно загруженные рекламные объявления рассматриваются для использования в рекламной паузе. Если вы не укажете StartTime, предварительно загруженные рекламные объявления будут доступны после того, как MediaTailor получит их с сервера принятия решений о рекламе.

Название -> (строка)

Название расписания предварительной загрузки. Название должно быть уникальным среди всех расписаний предварительной загрузки, связанных с указанной конфигурацией воспроизведения.

Имя конфигурации воспроизведения -> (строка)

Имя конфигурации воспроизведения, для которой необходимо создать расписание предварительной загрузки.

Получение -> (структура)

Сложный тип, содержащий параметры для получения предварительной загрузки с сервера принятия решений о рекламе (ADS).

Динамические переменные -> (карта)

Динамические переменные, используемые для подстановки при запросах предварительной загрузки на сервер принятия решений о рекламе (ADS).

Вы изначально настраиваете динамические переменные для URL-адреса ADS при настройке конфигурации воспроизведения. При указании DynamicVariables для получения предварительной загрузки MediaTailor включает динамические переменные в запрос к ADS.

ключ -> (строка)

значение -> (строка)

Время окончания -> (метка времени)

Время окончания предварительной загрузки для рекламной паузы. Предварительная загрузка будет выполняться для запросов манифеста, которые происходят до или в это время.

Время начала -> (метка времени)

Время, когда можно начать предварительную загрузку для этого блока. Предварительная загрузка рекламы будет выполняться для запросов манифеста, которые происходят в или после этого времени. По умолчанию — текущее время. Если не указано, предварительная загрузка начинается как можно скорее.

Тип управления трафиком -> (строка)

Указывает, использует ли эта конфигурация окно получения для управления трафиком и ограничения количества запросов к ADS одновременно.

Окно получения для управления трафиком -> (структура)

Настройка для распределения трафика ADS по заданному окну вместо отправки запросов ADS для всех сеансов одновременно.

Продолжительность окна получения в секундах -> (целое число)

Время в секундах, в течение которого MediaTailor распределяет запросы предварительной загрузки к ADS.

Тип расписания -> (строка)

Частота, с которой MediaTailor создаёт расписания предварительной загрузки. SINGLE указывает, что это расписание применяется к одному рекламному блоку. RECURRING указывает, что MediaTailor автоматически создаёт расписание для каждого доступного блока в прямом эфире.

Дополнительную информацию о типах предварительной загрузки и о том, когда использовать каждый из них, см. в разделе «Предварительная загрузка рекламы в Elemental MediaTailor».

Конфигурация повторяющейся предварительной загрузки -> (структура)

Параметры, определяющие, как и когда MediaTailor предварительно загружает рекламу и вставляет её в рекламные паузы.

Время начала -> (метка времени)

Время начала окна, в котором MediaTailor предварительно загружает и вставляет рекламу в прямом эфире.

Время окончания -> (метка времени)

Время окончания окна, в котором MediaTailor предварительно загружает и вставляет рекламу в прямом эфире.

Повторяющееся потребление -> (структура)

Параметры, определяющие, как и когда MediaTailor помещает предварительно загруженные рекламные объявления в будущие рекламные паузы для повторяющихся расписаний предварительной загрузки.

Время истечения срока действия полученной рекламы в секундах -> (целое число)

Количество секунд, в течение которых реклама доступна для вставки после предварительной загрузки.

Критерии соответствия доступности -> (список)

Настройка динамических переменных, определяющих, в какие рекламные паузы MediaTailor вставляет предварительно загруженные рекламные объявления.

(структура)

Динамическая переменная -> (строка)

Вы можете включить до 100 динамических переменных.

Оператор -> (строка)

Для DynamicVariable, указанного в AvailMatchingCriteria, оператор, используемый для сравнения.

Повторное получение -> (структура)

Конфигурация для получения предварительно загруженных рекламных объявлений с сервера ADS.

Динамические переменные -> (карта)

Динамические переменные, используемые для подстановки при запросах предварительной загрузки на сервер ADS.

ключ -> (строка)

значение -> (строка)

Задержка после окончания рекламной паузы в секундах -> (целое число)

Количество секунд, которые MediaTailor ожидает после окончания рекламной паузы перед предварительной загрузкой рекламы для следующей паузы. Если не задано, значение по умолчанию — 0 (без задержки).

Тип управления трафиком -> (строка)

Окно получения для управления трафиком -> (структура)

Продолжительность окна получения в секундах -> (целое число)

Время в секундах, в течение которого MediaTailor распределяет запросы предварительной загрузки к ADS.

Идентификатор потока -> (строка)

Необязательный идентификатор потока, который вы можете указать для предварительной загрузки для нескольких потоков, использующих одну и ту же конфигурацию воспроизведения.

Следующий токен -> (строка)

Токен постраничной навигации, возвращаемый запросом на список, когда результаты превышают максимальное значение. Используйте токен для получения следующей страницы результатов.