get-stream-session
Описание
Получает метаданные о заданном потоке.
См. также: Документацию API AWS
Синтаксис
get-stream-session
--channel-arn <value>
[--stream-id <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
Параметры
--channel-arn (строка)
--stream-id (строка)
streamId не указан, возвращается последняя сессия потока для канала, если она существует.--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--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
- таблица
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- включить
- выключить
- автоматически
--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.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Получение метаданных для заданного потока
Следующий пример get-stream-session получает конфигурацию метаданных для указанного ARN канала (имя ресурса Amazon) и указанного потока; если streamId не предоставлен, выбирается последний поток для канала.
aws ivs get-stream-session \
--channel-arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \
--stream-id 'mystream'
Вывод:
{
"streamSession": {
"streamId": "mystream1",
"startTime": "2023-06-26T19:09:28+00:00",
"channel": {
"arn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh",
"name": "mychannel",
"latencyMode": "LOW",
"type": "STANDARD",
"recordingConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"ingestEndpoint": "a1b2c3d4e5f6.global-contribute.live-video.net",
"playbackUrl": "url-string",
"authorized": false,
"insecureIngest": false,
"preset": ""
},
"ingestConfiguration": {
"audio": {
"channels": 2,
"codec": "mp4a.40.2",
"sampleRate": 8000,
"targetBitrate": 46875,
"track": "Track0"
},
"video": {
"avcProfile": "Baseline",
"avcLevel": "4.2",
"codec": "avc1.42C02A",
"encoder": "Lavf58.45.100",
"level": "4.2",
"profile": "Baseline",
"targetBitrate": 8789062,
"targetFramerate": 60,
"track": "Track0",
"videoHeight": 1080,
"videoWidth": 1920
}
},
"ingestConfigurations": {
"audioConfigurations": [
{
"channels": 2,
"codec": "mp4a.40.2",
"sampleRate": 8000,
"targetBitrate": 46875,
"track": "Track0"
}
],
"videoConfigurations": [
{
"codec": "avc1.42C02A",
"encoder": "Lavf58.45.100",
"level": "4.2",
"profile": "Baseline",
"targetBitrate": 8789062,
"targetFramerate": 60,
"track": "Track0",
"videoHeight": 1080,
"videoWidth": 1920
}
]
},
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"state": "ACTIVE",
"tags": {
"key1": "value1",
"key2": "value2"
},
"thumbnailConfiguration": {
"recordingMode": "INTERVAL",
"targetIntervalSeconds": 1,
"resolution": "LOWEST_RESOLUTION",
"storage": [
"LATEST"
]
},
"recordingReconnectWindowSeconds": 60,
"renditionConfiguration": {
"renditionSelection": "CUSTOM",
"renditions": [
"HD"
]
}
},
"truncatedEvents": [
{
"code": "StreamTakeoverInvalidPriority",
"name": "Stream Takeover Failure",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:48+00:00"
},
{
"name": "Stream Takeover",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:47+00:00"
},
{
"name": "Recording Start",
"type": "IVS Recording State Change",
"eventTime": "2023-06-26T19:09:35+00:00"
},
{
"name": "Stream Start",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:34+00:00"
},
{
"name": "Session Created",
"type": "IVS Stream State Change",
"eventTime": "2023-06-26T19:09:28+00:00"
}
]
}
}
Дополнительную информацию см. в разделе Создание канала в Руководстве пользователя IVS с низкой задержкой.
Вывод
streamSession -> (структура)
Список данных о потоке.
channel -> (структура)
Свойства канала на момент начала трансляции.
arn -> (строка)
authorized -> (логическое значение)
false .containerFormat -> (строка)
multitrackInputConfiguration и enabled является true , то containerFormat является обязательным и должен быть установлен в FRAGMENTED_MP4 . В противном случае, containerFormat может быть установлен в TS или FRAGMENTED_MP4 . По умолчанию: TS .ingestEndpoint -> (строка)
insecureIngest -> (логическое значение)
false .latencyMode -> (строка)
NORMAL для трансляции и доставки видео в формате Full HD. Используйте LOW для взаимодействия с зрителями в режиме реального времени. По умолчанию: LOW .multitrackInputConfiguration -> (структура)
Объект, определяющий конфигурацию ввода с несколькими потоками. По умолчанию: конфигурация ввода с несколькими потоками не указана.
enabled -> (логическое значение)
true только в том случае, если тип канала является STANDARD . Установка enabled в true с любым другим типом канала приведет к возникновению исключения. Если true , то policy , maximumResolution и containerFormat являются обязательными, и containerFormat должен быть установлен в FRAGMENTED_MP4 . По умолчанию: false .maximumResolution -> (строка)
enabled равно true .policy -> (строка)
enabled равно true .name -> (строка)
playbackRestrictionPolicyArn -> (строка)
playbackUrl -> (строка)
preset -> (строка)
ADVANCED_HD и ADVANCED_SD. Для этих типов каналов по умолчанию preset является HIGHER_BANDWIDTH_DELIVERY . Для других типов каналов (BASIC и STANDARD ), preset является пустой строкой ("" ).recordingConfigurationArn -> (строка)
srt -> (структура)
Определяет конечную точку и необязательный пароль для потоковой передачи с использованием протокола SRT.
endpoint -> (строка)
passphrase -> (строка)
insecureIngest для канала.tags -> (массив)
Теги, прикрепленные к ресурсу. Массив из 1-50 карт, каждая из которых имеет вид string:string (key:value) . Подробности, включая ограничения, которые применяются к тегам, и «Пределы и требования к именованию тегов», см. в разделе «Рекомендации и стратегии по тегированию ресурсов Amazon Web Services и редактору тегов»; Amazon IVS не имеет ограничений, специфичных для службы, помимо тех, которые там документированы.
ключ -> (строка)
значение -> (строка)
type -> (строка)
STANDARD . Подробности см. в разделе Типы каналов.endTime -> (временная метка)
NULL .ingestConfiguration -> (структура)
Свойства входящего потока RTMP.
ingestConfiguration устарело и заменено на ingestConfigurations, но сохранено для обеспечения обратной совместимости. Если многопоточность не включена, ingestConfiguration и ingestConfigurations содержат одинаковые данные, а именно информацию о треке 0 (единственном треке). Если многопоточность включена, ingestConfiguration содержит данные только для первого трека (трека 0), а ingestConfigurations содержит данные для всех треков.audio -> (структура)
Настройки кодека для аудио.
channels -> (целое число)
codec -> (строка)
sampleRate -> (целое число)
targetBitrate -> (целое число)
track -> (строка)
video -> (структура)
Настройки кодека для видео.
avcLevel -> (строка)
avcProfile -> (строка)
codec -> (строка)
encoder -> (строка)
level -> (строка)
avcLevel .profile -> (строка)
avcProfile .targetBitrate -> (целое число)
targetFramerate -> (целое число)
track -> (строка)
videoHeight -> (целое число)
videoWidth -> (целое число)
ingestConfigurations -> (структура)
Свойства входящего потока RTMP. Если многопоточность включена, ingestConfigurations содержит данные для всех потоков; в противном случае — только для трека 0 (единственного потока).
audioConfigurations -> (список)
Настройки кодека для аудио.
(структура)
Объект, определяющий аудиоконфигурацию потока, настроенную вещателем (обычно в кодере). Эта часть объекта IngestConfigurations и устаревшего объекта IngestConfiguration. Используется для мониторинга состояния потока.
channels -> (целое число)
codec -> (строка)
sampleRate -> (целое число)
targetBitrate -> (целое число)
track -> (строка)
videoConfigurations -> (список)
Настройки кодека для видео
(структура)
Объект, определяющий видеоконфигурацию потока, настроенную вещателем (обычно в кодере). Эта часть объекта IngestConfigurations и устаревшего объекта IngestConfiguration. Используется для мониторинга состояния потока.
avcLevel -> (строка)
avcProfile -> (строка)
codec -> (строка)
encoder -> (строка)
level -> (строка)
avcLevel .profile -> (строка)
avcProfile .targetBitrate -> (целое число)
targetFramerate -> (целое число)
track -> (строка)
videoHeight -> (целое число)
videoWidth -> (целое число)
recordingConfiguration -> (структура)
Свойства записи прямых трансляций.
arn -> (строка)
destinationConfiguration -> (структура)
Сложный тип, содержащий информацию о месте хранения записанного видео.
s3 -> (структура)
Конфигурация назначения S3 для хранения записанного видео.
bucketName -> (строка)
name -> (строка)
recordingReconnectWindowSeconds -> (целое число)
renditionConfiguration -> (структура)
Объект, описывающий, какие копии (renditions) нужно записывать для потока.
renditionSelection -> (строка)
BASIC, значение CUSTOM не оказывает влияния. Если указано CUSTOM, набор копий должен быть указан в поле renditions. По умолчанию: ALL.renditions -> (список)
Указывает, какие копии (renditions) записываются для потока, если renditionSelection равно CUSTOM; в противном случае это поле неактуально. Выбранные копии записываются, если они доступны во время трансляции. Если выбранная копия недоступна, записывается лучшая доступная копия. Подробнее о разрешении каждого копии см. в разделе Автоматическая запись в Amazon S3.
(строка)
state -> (строка)
ACTIVE, конфигурация готова к записи потока канала.tags -> (карта)
Теги, прикрепленные к ресурсу. Массив из 1-50 карт, каждая из которых имеет вид string:string (key:value). Подробнее см. в разделе «Рекомендации и стратегии по маркировке ресурсов Amazon Web Services и Редактор тегов», включая ограничения, которые применяются к тегам и «Ограничения и требования к именованию тегов». Amazon IVS не имеет никаких специфических ограничений по сервису, кроме указанных в документе.
key -> (строка)
value -> (строка)
thumbnailConfiguration -> (структура)
Сложный тип, который позволяет включать/отключать запись миниатюр для сеанса прямой трансляции и изменять интервал, с которым генерируются миниатюры для сеанса прямой трансляции.
recordingMode -> (строка)
INTERVAL.resolution -> (строка)
storage -> (список)
Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры последовательно в каталог media/thumbnails. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/thumb.jpg и перезаписывает её с интервалом, указанным в targetIntervalSeconds. Вы можете включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.
(строка)
targetIntervalSeconds -> (длинное целое число)
Целевой интервал генерации миниатюр в секундах. Этот параметр настраивается (и требуется) только если recordingMode равно INTERVAL. По умолчанию: 60.
BASIC или типа канала STANDARD с многоканальным входом установка значения для targetIntervalSeconds не гарантирует, что миниатюры будут генерироваться с указанным интервалом. Чтобы миниатюры генерировались с интервалом targetIntervalSeconds, значение IDR/Keyframe для входного видео должно быть меньше значения targetIntervalSeconds. Смотрите Конфигурация потоковой трансляции Amazon IVS для получения информации о настройке IDR/Keyframe на рекомендуемое значение в настройках видеокодека.startTime -> (временная метка)
streamId -> (строка)
truncatedEvents -> (список)
Список событий Amazon IVS, с которыми столкнулся поток. Список отсортирован по последним событиям и содержит не более 500 событий. Для событий Amazon IVS см. Использование Amazon EventBridge с Amazon IVS.
(структура)
Объект, определяющий события потока. Список событий см. в разделе Использование Amazon EventBridge с Amazon IVS.
code -> (строка)
Предоставляет дополнительные сведения о событии потока. Существует несколько значений; подробные описания приведены в консоли IVS, но не передаются через API IVS или EventBridge. Многоканальные коды используются только для определенных событий «Сеанс завершен».
-
MultitrackInputNotAllowed— Клиент трансляции пытался подключиться с многоканальным входом, но многоканальный вход не был включен на канале. Проверьте настройки вашего программного обеспечения для трансляции или установитеMultitrackInputConfiguration.PolicyвALLOWилиREQUIRE. -
MultitrackInputRequired— Клиент трансляции пытался подключиться с одноканальным видео, но на этом канале требуется многоканальный вход. Включите многоканальное видео в программном обеспечении для трансляции или настройтеMultitrackInputConfiguration.PolicyнаALLOW. -
InvalidGetClientConfigurationStreamKey— Клиент трансляции пытался подключиться с недействительным, истекшим или поврежденным ключом потока. -
GetClientConfigurationStreamKeyRequired— Клиент трансляции пытался передать многоканальное видео без предоставления аутентифицированного ключа потока из GetClientConfiguration. -
InvalidMultitrackInputTrackCount— Поток многоканального входа содержал неверное количество треков. -
InvalidMultitrackInputVideoTrackMediaProperties— Поток многоканального входа содержал один или несколько треков с неверным кодеком, разрешением, битрейтом или частотой кадров. -
StreamTakeoverMediaMismatch— Клиент трансляции пытался принять на себя с различными свойствами медиа (например, кодек, разрешение или тип видеотрека) от исходного потока. -
StreamTakeoverInvalidPriority— Клиент трансляции пытался принять на себя с целым значением приоритета, равным или меньше значения исходного потока, или значением вне допустимого диапазона от 1 до 2 147 483 647.StreamTakeoverLimitBreached— Клиент трансляции достиг максимального допустимого количества попыток принятия на себя для этого потока.
eventTime -> (временная метка)
name -> (строка)
type.type -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.