Spec-Zone.ru › AWS CLI v2

[ aws . ivs ]

get-recording-configuration

Описание

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

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

Синтаксис

  get-recording-configuration
--arn <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]

Параметры

--arn (строка)

ARN конфигурации записи, которую нужно получить.

--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 (строка)

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

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

Для получения информации о ресурсе RecordingConfiguration

Следующий пример get-recording-configuration получает информацию о ресурсе RecordingConfiguration для указанного ARN.

aws ivs get-recording-configuration \
    --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ"

Вывод:

{
    "recordingConfiguration": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ",
        "destinationConfiguration": {
            "s3": {
                "bucketName": "demo-recording-bucket"
            }
        },
        "name": "test-recording-config",
        "recordingReconnectWindowSeconds": 60,
        "state": "ACTIVE",
        "tags": {
            "key1" : "value1",
            "key2" : "value2"
        },
        "thumbnailConfiguration": {
            "recordingMode": "INTERVAL",
            "targetIntervalSeconds": 1,
            "resolution": "LOWEST_RESOLUTION",
            "storage": [
                "LATEST"
            ]
        },
        "renditionConfiguration": {
            "renditionSelection": "CUSTOM",
            "renditions": [
                "HD"
            ]
        }
    }
}

Для получения дополнительной информации, см. Запись в Amazon S3 в Руководстве пользователя Amazon Interactive Video Service.

Вывод

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

arn -> (строка)

ARN конфигурации записи.

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

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

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

Конфигурация назначения S3, где будут храниться записанные видео.

bucketName -> (строка)

Расположение (имя S3-бакета), где будут храниться записанные видео.

name -> (строка)

Имя конфигурации записи. Значение не обязательно должно быть уникальным.

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

Если трансляция прерывается и затем возобновляется в течение указанного интервала, несколько потоков будут считаться одной трансляцией и объединены. По умолчанию: 0.

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 -> (строка)

Указывает желаемое разрешение записанных миниатюр. Миниатюры записываются в выбранном разрешении, если соответствующий поток доступен во время трансляции; в противном случае они записываются в исходном разрешении. Дополнительную информацию о значениях разрешения и соответствующих размерах высоты и ширины см. в Автозапись в Amazon S3. По умолчанию: Null (возвращается исходное разрешение).

storage -> (список)

Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры последовательно в каталог media/thumbnails. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/thumb.jpg и перезаписывает ее с интервалом, указанным в targetIntervalSeconds. Вы можете включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.

(строка)

targetIntervalSeconds -> (длинное целое число)

Целевой интервал генерации миниатюр в секундах. Это настраиваемый (и обязательный) параметр только если recordingMode равен INTERVAL. По умолчанию: 60.

Важно: Для типа канала BASIC или типа канала STANDARD с входными данными multitrack установка значения targetIntervalSeconds не гарантирует, что миниатюры генерируются с указанным интервалом. Для генерации миниатюр с интервалом targetIntervalSeconds значение IDR/Keyframe для входного видео должно быть меньше значения targetIntervalSeconds. Смотрите Конфигурация потоковой передачи Amazon IVS для получения информации о настройке IDR/Keyframe до рекомендуемого значения в параметрах видеокодера.

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

Spec-Zone.ru

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