create-recording-configuration
Описание
Создаёт новую конфигурацию записи, используемую для включения записи в Amazon S3.
Известная проблема: В регионе us-east-1, если вы используете командную строку Amazon Web Services для создания конфигурации записи, она возвращает успех даже если ведро S3 находится в другом регионе. В этом случае, state конфигурации записи — CREATE_FAILED (вместо ACTIVE). (В других регионах командная строка правильно возвращает ошибку, если ведро находится в другом регионе.)
Решение: Убедитесь, что ваше ведро S3 находится в том же регионе, что и конфигурация записи. Если вы создаёте конфигурацию записи в другом регионе, чем ваше ведро S3, удалите эту конфигурацию и создайте новую с ведром S3 из правильного региона.
См. также: Документация AWS API
Синтаксис
create-recording-configuration
--destination-configuration <value>
[--name <value>]
[--recording-reconnect-window-seconds <value>]
[--rendition-configuration <value>]
[--tags <value>]
[--thumbnail-configuration <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]
Параметры
--destination-configuration (структура)
Сложный тип, содержащий конфигурацию назначения, где будет храниться записанное видео.
s3 -> (структура)
Конфигурация назначения S3, где будут храниться записанные видеоролики.
bucketName -> (строка)
Сокращённый синтаксис:
s3={bucketName=string}
Синтаксис JSON:
{
"s3": {
"bucketName": "string"
}
}
--name (строка)
--recording-reconnect-window-seconds (целое число)
--rendition-configuration (структура)
Объект, описывающий, какие копии должны быть записаны для потока.
renditionSelection -> (строка)
BASIC значение CUSTOM не имеет эффекта. Если CUSTOM указан, набор копий должен быть указан в поле renditions. По умолчанию: ALL.renditions -> (список)
Указывает, какие копии записываются для потока, если renditionSelection равно CUSTOM; в противном случае это поле не имеет значения. Выбранные копии записываются, если они доступны во время потока. Если выбранная копия недоступна, записывается лучшая доступная копия. Подробную информацию о разрешении размеров каждой копии см. в разделе Автоматическая запись в Amazon S3.
(строка)
Сокращённый синтаксис:
renditionSelection=string,renditions=string,string
Синтаксис JSON:
{
"renditionSelection": "ALL"|"NONE"|"CUSTOM",
"renditions": ["SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION", ...]
}
--tags (массив)
Массив из 1–50 карт, каждая из которых имеет вид string:string (key:value). Подробную информацию, включая ограничения, которые применяются к меткам и «Пределы и требования к именованию меток», см. в разделе «Рекомендации и стратегии по применению меток к ресурсам Amazon Web Services и редактору меток»; Amazon IVS не имеет ограничений, специфичных для службы, помимо тех, которые описаны там.
key -> (строка)
value -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--thumbnail-configuration (структура)
Сложный тип, позволяющий включить/выключить запись миниатюр для сеанса прямой трансляции и изменить интервал, с которым генерируются миниатюры для сеанса прямой трансляции.
recordingMode -> (строка)
INTERVAL.resolution -> (строка)
storage -> (список)
Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры последовательно в каталог media/thumbnails. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/thumb.jpg и перезаписывает её с интервалом, заданным в targetIntervalSeconds. Вы можете включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.
(строка)
targetIntervalSeconds -> (целое число)
Целевое время интервала генерации миниатюр в секундах. Это настраиваемое (и требуется) только если recordingMode равно INTERVAL. По умолчанию: 60.
BASIC или типа канала STANDARD с входными данными multitrack установка значения targetIntervalSeconds не гарантирует, что миниатюры будут генерироваться с указанным интервалом. Для генерации миниатюр с указанным интервалом значение IDR/Keyframe для входного видео должно быть меньше значения targetIntervalSeconds. См. Настройка потоковой передачи Amazon IVS для получения информации о настройке IDR/Keyframe до рекомендуемого значения в параметрах кодировщика видео.Сокращённый синтаксис:
recordingMode=string,resolution=string,storage=string,string,targetIntervalSeconds=long
Синтаксис JSON:
{
"recordingMode": "DISABLED"|"INTERVAL",
"resolution": "SD"|"HD"|"FULL_HD"|"LOWEST_RESOLUTION",
"storage": ["SEQUENTIAL"|"LATEST", ...],
"targetIntervalSeconds": long
}
--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
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки config/env.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включить
- выключить
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки config/env.
--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».
Для создания ресурса RecordingConfiguration
В следующем create-recording-configuration примере создается ресурс RecordingConfiguration для включения записи в Amazon S3.
aws ivs create-recording-configuration \
--name "test-recording-config" \
--recording-reconnect-window-seconds 60 \
--tags "key1=value1, key2=value2" \
--rendition-configuration renditionSelection="CUSTOM",renditions="HD" \
--thumbnail-configuration recordingMode="INTERVAL",targetIntervalSeconds=1,storage="LATEST",resolution="LOWEST_RESOLUTION" \
--destination-configuration s3={bucketName=demo-recording-bucket}
Вывод:
{
"recordingConfiguration": {
"arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
"name": "test-recording-config",
"destinationConfiguration": {
"s3": {
"bucketName": "demo-recording-bucket"
}
},
"state": "CREATING",
"tags": {
"key1": "value1",
"key2": "value2"
},
"thumbnailConfiguration": {
"recordingMode": "INTERVAL",
"targetIntervalSeconds": 1,
"resolution": "LOWEST_RESOLUTION",
"storage": [
"LATEST"
]
},
"recordingReconnectWindowSeconds": 60,
"renditionConfiguration": {
"renditionSelection": "CUSTOM",
"renditions": [
"HD"
]
}
}
}
Для получения дополнительной информации см. Запись в Amazon S3 в «Руководстве пользователя Amazon Interactive Video Service».
Вывод
recordingConfiguration -> (структура)
arn -> (строка)
destinationConfiguration -> (структура)
Сложная структура, содержащая информацию о том, где будет храниться записанное видео.
s3 -> (структура)
Конфигурация назначения S3, где будут храниться записанные видео.
bucketName -> (строка)
name -> (строка)
recordingReconnectWindowSeconds -> (целое число)
renditionConfiguration -> (структура)
Объект, описывающий, какие копии должны быть записаны для потока.
renditionSelection -> (строка)
BASIC значение CUSTOM не имеет эффекта. Если указано CUSTOM, набор копий должен быть указан в поле renditions. По умолчанию: ALL.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. Сведения об установке IDR/Keyframe до рекомендуемого значения в параметрах видеокодека см. в документе Настройка потоковой передачи Amazon IVS.
© Copyright 2025, Amazon Web Services. Created using Sphinx.