Spec-Zone.ru › AWS CLI v2

[ aws . ivs-realtime ]

get-stage

Описание

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

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

Синтаксис

  get-stage
--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
  • text
  • таблица
  • 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Получение конфигурации стадии

Следующий get-stage пример получает конфигурацию стадии для указанного ARN стадии (Amazon Resource Name).

aws ivs-realtime get-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

Вывод:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
            "storageConfigurationArn": "",
            "mediaTypes": [
                "AUDIO_VIDEO"
            ],
            "thumbnailConfiguration": {
                "targetIntervalSeconds": 60,
                "storage": [
                    "SEQUENTIAL"
                ],
                "recordingMode": "DISABLED",
            },
            "recordingReconnectWindowSeconds": 0,
            "hlsConfiguration": {
                "targetSegmentDurationSeconds": 6
            }
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "rtmp": "rtmp://9x0y8z7s6t5u.global-contribute-staging.live-video.net/app/",
            "rtmps": "rtmps://9x0y8z7s6t5u.global-contribute-staging.live-video.net:443/app/",
            "whip": "https://9x0y8z7s6t5u.global-bm.whip.live-video.net"
        },
        "name": "test",
        "tags": {}
    }
}

Для получения дополнительной информации, см. Включение нескольких хостов в потоке Amazon IVS в Руководстве пользователя по потоковой передаче с низкой задержкой Amazon IVS.

Вывод

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

Возвращаемая стадия.

arn -> (строка)

ARN стадии.

name -> (строка)

Имя стадии.

activeSessionId -> (строка)

Идентификатор активной сессии в стадии.

tags -> (отображение)

Теги, прикрепленные к ресурсу. Массив отображений, каждый из которых имеет вид string:string (key:value). См. Практические рекомендации и стратегии в Тегирование ресурсов AWS и редактор тегов для получения подробной информации, включая ограничения, которые применяются к тегам и «Пределы и требования к именованию тегов»; Amazon IVS не имеет ограничений на теги, кроме тех, которые описаны там.

key -> (строка)

value -> (строка)

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

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

storageConfigurationArn -> (строка)

ARN ресурса StorageConfiguration, используемого для записи отдельных участников. По умолчанию: "" (пустая строка, конфигурация хранения не указана). Запись отдельных участников не может быть начата, если не указана конфигурация хранения, когда стадия создается или обновляется. Для отключения записи отдельных участников установите значение ""; другие поля в этом объекте будут сброшены до значений по умолчанию при отправке "".

mediaTypes -> (список)

Типы медиа, которые будут записываться. По умолчанию: AUDIO_VIDEO.

(строка)

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

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

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

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

storage -> (список)

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

(строка)

recordingMode -> (строка)

Режим записи миниатюр. По умолчанию: DISABLED.

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

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

Значение по умолчанию равно 0, что отключает слияние.

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

Объект конфигурации HLS для записи отдельных участников.

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

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

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

Сводная информация о различных конечных точках для стадии.

events -> (строка)

Конечная точка событий.

whip -> (строка)

Конечная точка, используемая для потоковой передачи в реальном времени IVS с помощью протокола WHIP.

rtmp -> (строка)

Конечная точка, используемая для потоковой передачи в реальном времени IVS с помощью протокола RTMP.

rtmps -> (строка)

Конечная точка, используемая для потоковой передачи в реальном времени IVS с помощью протокола RTMPS.

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

Spec-Zone.ru

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