Spec-Zone.ru › AWS CLI v2

[ aws . mediatailor ]

list-playback-configurations

Описание

Возвращает существующие конфигурации воспроизведения. Сведения о конфигурациях MediaTailor см. в разделе Работа с конфигурациями в AWS Elemental MediaTailor .

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

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

Синтаксис

  list-playback-configurations
[--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]

Параметры

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы с AWS CLI User Guide.

Если не указано иное, все примеры используют правила цитирования, аналогичные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы перечислить все конфигурации

Следующий list-playback-configurations отображает все подробности конфигурации в текущей учетной записи AWS.

aws mediatailor list-playback-configurations

Вывод:

{
    "Items": [
        {
            "AdDecisionServerUrl": "http://your.ads.url",
            "CdnConfiguration": {},
            "DashConfiguration": {
                "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/",
                "MpdLocation": "EMT_DEFAULT",
                "OriginManifestType": "MULTI_PERIOD"
            },
            "HlsConfiguration": {
                "ManifestEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/"
            },
            "Name": "west_campaign",
            "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/west_campaign",
            "PlaybackEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com",
            "SessionInitializationEndpointPrefix": "https://170c14299689462897d0cc45fc2000bb.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/west_campaign/",
            "Tags": {},
            "VideoContentSourceUrl": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/683f0f2ff7cd43a48902e6dcd5e16dcf/index.m3u8"
        },
        {
            "AdDecisionServerUrl": "http://your.ads.url",
            "CdnConfiguration": {},
            "DashConfiguration": {
                "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/dash/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/",
                "MpdLocation": "DISABLED",
                "OriginManifestType": "MULTI_PERIOD"
            },
            "HlsConfiguration": {
                "ManifestEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/master/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/"
            },
            "Name": "sports_campaign",
            "PlaybackConfigurationArn": "arn:aws:mediatailor:us-west-2:123456789012:playbackConfiguration/sports_campaign",
            "PlaybackEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com",
            "SessionInitializationEndpointPrefix": "https://73511f91d6a24ca2b93f3cf1d7cedd67.mediatailor.us-west-2.amazonaws.com/v1/session/1cbfeaaecb69778e0c167d0505a2bc57da2b1754/sports_campaign/",
            "SlateAdUrl": "http://s3.bucket/slate_ad.mp4",
            "Tags": {},
            "VideoContentSourceUrl": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/sports_endpoint/index.m3u8"
        }
    ]
}

Для получения дополнительной информации см. `Просмотр конфигурации<https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-view.html>`__ в Руководстве пользователя AWS Elemental MediaTailor.

Вывод

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

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

(структура)

Конфигурация воспроизведения. Для получения информации о конфигурациях MediaTailor см. раздел Работа с конфигурациями в AWS Elemental MediaTailor.

AdDecisionServerUrl -> (строка)

URL сервера принятия решений по рекламе (ADS). Он включает указание статических параметров и заглушек для динамических параметров. AWS Elemental MediaTailor подставляет параметры, специфичные для плеера и сессии, по мере необходимости при обращении к ADS. В качестве альтернативы для тестирования вы можете указать статический URL VAST. Максимальная длина составляет 25 000 символов.

AvailSuppression -> (структура)

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

Mode -> (строка)

Устанавливает режим подавления рекламы. По умолчанию подавление рекламы выключено, и все рекламные блоки заполняются рекламой или заглушкой. Когда Mode установлен в BEHIND_LIVE_EDGE, подавление рекламы активное, и MediaTailor не будет заполнять рекламные блоки в пределах или позади времени подавления рекламы Value в окне просмотра манифеста. Когда Mode установлен в AFTER_LIVE_EDGE, подавление рекламы активное, и MediaTailor не будет заполнять рекламные блоки, которые находятся в пределах живого края плюс значение подавления доступности.

Value -> (строка)

Время смещения живого края в формате ЧЧ:ММ:СС. MediaTailor не будет заполнять рекламные блоки в пределах или позади этого времени в окне просмотра манифеста. Если Value установлен в 00:00:00, он синхронизирован с живым краем, и MediaTailor не будет заполнять никакие рекламные блоки в пределах или позади живого края. Если вы задаёте значение Value, MediaTailor не будет заполнять рекламные блоки в пределах или позади этого времени в окне просмотра манифеста. Например, если вы задаёте 00:45:00, то MediaTailor будет заполнять рекламные блоки, которые происходят в течение 45 минут позади живого края, но не будет заполнять рекламные блоки в пределах или позади 45 минут позади живого края.

FillPolicy -> (строка)

Определяет политику, применяемую к режиму подавления доступности. BEHIND_LIVE_EDGE всегда будет использовать полную политику подавления доступности. Режим AFTER_LIVE_EDGE может использоваться для вызова частичного заполнения рекламных блоков, когда сессия начинается в середине блока.

Bumper -> (структура)

Настройка для буферов. Буферы — это короткие аудио- или видеоклипы, которые воспроизводятся в начале или перед окончанием рекламной паузы. Чтобы узнать больше о буферах, см. Буферы.

EndUrl -> (строка)

URL конечного буфера актива.

StartUrl -> (строка)

URL начального буфера актива.

CdnConfiguration -> (структура)

Настройка использования сети доставки контента (CDN), например Amazon CloudFront, для управления сегментами контента и рекламы.

AdSegmentUrlPrefix -> (строка)

Альтернативная сеть доставки контента (CDN) для предоставления рекламных сегментов. По умолчанию AWS Elemental MediaTailor использует Amazon CloudFront с настройками кэша по умолчанию в качестве своей CDN для рекламных сегментов. Чтобы настроить альтернативную CDN, создайте правило в своей CDN для источника рекламы ads.mediatailor.*<region>* .amazonaws.com. Затем укажите имя правила в этой AdSegmentUrlPrefix . При предоставлении AWS Elemental MediaTailor манифеста он указывает вашу CDN как источник рекламных сегментов.

ContentSegmentUrlPrefix -> (строка)

Сеть доставки контента (CDN) для кэширования сегментов контента, чтобы запросы контента не всегда приходили на сервер источника. Сначала создайте правило в вашей CDN для сервера источника сегмента контента. Затем укажите имя правила в этой ContentSegmentUrlPrefix . При предоставлении AWS Elemental MediaTailor манифеста он указывает вашу CDN как источник сегментов контента.

ConfigurationAliases -> (карта)

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

key -> (строка)

Динамическая переменная, имеющая псевдонимы.

value -> (карта)

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

key -> (строка)

value -> (строка)

DashConfiguration -> (структура)

Настройка источника DASH.

ManifestEndpointPrefix -> (строка)

URL, сгенерированный MediaTailor, для запуска сессии воспроизведения. Сессия использует отчётность на стороне сервера. Эта настройка игнорируется в операциях PUT.

MpdLocation -> (строка)

Настройка, контролирующая включение тега Location в манифесты DASH. MediaTailor заполняет тег Location URL для запросов обновления манифеста, который используется плеерами, не поддерживающими постоянные перенаправления. Отключите эту настройку, если у вас настроены правила маршрутизации CDN для доступа к манифестам MediaTailor, и вы используете отчётность на стороне клиента или ваши плееры поддерживают постоянные HTTP-перенаправления. Допустимые значения — DISABLED и EMT_DEFAULT . Настройка EMT_DEFAULT включает включение тега и является значением по умолчанию.

OriginManifestType -> (строка)

Настройка, контролирующая, как MediaTailor обрабатывает манифесты с сервера источника — как многопериодные манифесты или однопериодные манифесты. Если ваш сервер источника создаёт однопериодные манифесты, установите это значение в SINGLE_PERIOD. Значение по умолчанию — MULTI_PERIOD. Для многопериодных манифестов опустите эту настройку или установите её в MULTI_PERIOD.

HlsConfiguration -> (структура)

Настройка контента HLS.

ManifestEndpointPrefix -> (строка)

URL, используемый для запуска сессии воспроизведения для устройств, поддерживающих Apple HLS. Сессия использует отчётность на стороне сервера.

InsertionMode -> (строка)

Настройка, контролирующая, могут ли плееры использовать склеенные или направляемые вставки рекламы. По умолчанию, STITCHED_ONLY, принуждает все сессии плееров использовать склеенные (на стороне сервера) вставки рекламы. Выбор PLAYER_SELECT позволяет плеерам выбрать либо склеенные, либо направляемые вставки рекламы во время инициализации сессии. По умолчанию для плееров, которые не указывают режим вставки, используется склеенный режим.

LivePreRollConfiguration -> (структура)

Настройка для вставки преролловой рекламы.

AdDecisionServerUrl -> (строка)

URL сервера принятия решений по рекламе (ADS) для преролловой рекламы. Он включает указание статических параметров и заглушек для динамических параметров. AWS Elemental MediaTailor подставляет параметры, специфичные для плеера и сессии, по мере необходимости при обращении к ADS. В качестве альтернативы для тестирования можно указать статический URL VAST. Максимальная длина составляет 25 000 символов.

MaxDurationSeconds -> (целое число)

Максимальная разрешённая продолжительность преролловой рекламы. AWS Elemental MediaTailor не будет воспроизводить преролловую рекламу с длительностью, превышающей это значение, независимо от общей продолжительности рекламы, возвращаемой ADS.

LogConfiguration -> (структура)

Определяет, куда AWS Elemental MediaTailor отправляет журналы для конфигурации воспроизведения.

PercentEnabled -> (целое число)

Процент журналов сессии, которые MediaTailor отправляет в указанное место назначения. Например, если у вашей конфигурации воспроизведения 1000 сессий и percentEnabled установлено в 60, MediaTailor отправит журналы для 600 сессий в CloudWatch Logs. MediaTailor случайным образом определяет, для каких сессий конфигурации воспроизведения будут отправлены журналы. Если вы хотите просмотреть журналы для определённой сессии, вы можете использовать режим отладки журнала.

Допустимые значения: 0 - 100

EnabledLoggingStrategies -> (список)

Способ сбора журналов из AWS Elemental MediaTailor. LEGACY_CLOUDWATCH указывает, что MediaTailor отправляет журналы напрямую в Amazon CloudWatch Logs. VENDED_LOGS указывает, что MediaTailor отправляет журналы в CloudWatch, который затем передаёт журналы в место назначения по вашему выбору. Поддерживаемые места назначения — группа журналов CloudWatch Logs, ведро Amazon S3 и поток Amazon Data Firehose.

(строка)

AdsInteractionLog -> (структура)

Настройки для настройки событий, включаемых в журналы для взаимодействия с сервером принятия решений по рекламе (ADS).

PublishOptInEventTypes -> (список)

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

(строка)

ExcludeEventTypes -> (список)

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

(строка)

ManifestServiceInteractionLog -> (структура)

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

ExcludeEventTypes -> (список)

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

(строка)

ManifestProcessingRules -> (структура)

Настройка правил обработки манифестов. Правила обработки манифестов позволяют настроить персонализированные манифесты, созданные MediaTailor.

AdMarkerPassthrough -> (структура)

Для HLS, если установлено значение true, MediaTailor пропускает EXT-X-CUE-IN, EXT-X-CUE-OUT и EXT-X-SPLICEPOINT-SCTE35 метки рекламы из исходного манифеста в персонализированный манифест MediaTailor.

Никакая логика к этим меткам рекламы не применяется. Например, если у EXT-X-CUE-OUT есть значение 60, но реклама не заполняется для этого рекламного блока, MediaTailor не установит значение в 0.

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

Включает пропуск меток рекламы для вашей конфигурации.

Name -> (строка)

Идентификатор конфигурации воспроизведения.

PersonalizationThresholdSeconds -> (целое число)

Определяет максимальное время незаполненной рекламы (в секундах) в рекламном блоке. Если продолжительность незаполненной рекламы превышает порог персонализации, то персонализация рекламных блоков прекращается, и отображается базовый контент. Эта функция относится к *замене рекламы* в потоках реального времени и VOD, а не к вставке рекламы, поскольку она опирается на базовый поток контента. Для получения дополнительной информации о поведении рекламных блоков, включая замену и вставку рекламы, см. Поведение рекламы в AWS Elemental MediaTailor.

PlaybackConfigurationArn -> (строка)

Amazon Resource Name (ARN) конфигурации воспроизведения.

PlaybackEndpointPrefix -> (строка)

URL, к которому плеер обращается, чтобы получить манифест от AWS Elemental MediaTailor.

SessionInitializationEndpointPrefix -> (строка)

URL, используемый плеером для инициализации сессии, использующей отчётность на стороне клиента.

SlateAdUrl -> (строка)

URL видеоактива для транскодирования и использования для заполнения времени, не используемого рекламой. AWS Elemental MediaTailor отображает заглушку, чтобы заполнить пробелы в медиаконтенте. Настройка заглушки является необязательной для конфигураций воспроизведения без VPAID. Для VPAID заглушка необходима, поскольку MediaTailor предоставляет её в слотах, предназначенных для динамического контента рекламы. Заглушка должна быть активом высокого качества, содержащим как аудио, так и видео.

Tags -> (карта)

Теги для назначения воспроизводящей конфигурации. Теги — это пары «ключ-значение», которые вы можете связать с ресурсами Amazon для организации, контроля доступа и отслеживания затрат. Дополнительную информацию см. в разделе Маркировка ресурсов AWS Elemental MediaTailor.

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

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

TranscodeProfileName -> (строка)

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

VideoContentSourceUrl -> (строка)

Префикс URL-адреса родительского манифеста для потока, за вычетом идентификатора ресурса. Максимальная длина составляет 512 символов.

AdConditioningConfiguration -> (структура)

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

StreamingMediaFileConditioning -> (строка)

Для рекламы, имеющей медиафайлы со стриминговой доставкой и поддерживаемыми расширениями файлов, указывает, какое действие по транскодированию MediaTailor выполняет при первом получении этой рекламы от ADS. TRANSCODE указывает, что MediaTailor должен транскодировать рекламу. NONE указывает, что вы уже транскодировали рекламу вне MediaTailor и не нуждаетесь в ее транскодировании в рамках процесса вставки рекламы. Дополнительную информацию о подготовке рекламы см. в руководстве пользователя AWS Elemental MediaTailor в разделе Использование предварительно подготовленной рекламы.

NextToken -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API