[ aws . ivs-realtime ]
получить-состав
Описание
Получение информации о заданном ресурсе Composition.
См. также: Документация API AWS
Синтаксис
get-composition
--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 (строка)
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров CLI.
Примеры
Примечание
Для использования следующих примеров вам необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Пример 1: Получение состава с настройками макета по умолчанию
Следующий get-composition пример получает состав для указанного ARN (имени ресурса Amazon).
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
Вывод:
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"videoAspectRatio": "VIDEO",
"videoFillMode": ""
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
Дополнительная информация приведена в разделе Композиционное запись IVS | Потоковая передача в реальном времени в Руководстве пользователя Amazon IVS Потоковая передача в реальном времени.
Пример 2: Получение состава с макетом PiP
Следующий get-composition пример получает состав для указанного ARN (имени ресурса Amazon), использующий макет PiP.
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"
Вывод:
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"pip": {
"featuredParticipantAttribute": "abcdefg",
"gridGap": 0,
"omitStoppedVideo": false,
"pipBehavior": "STATIC",
"pipOffset": 0,
"pipParticipantAttribute": "",
"pipPosition": "BOTTOM_RIGHT",
"videoFillMode": "COVER"
}
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
Дополнительная информация приведена в разделе Композиционное запись IVS | Потоковая передача в реальном времени в Руководстве пользователя Amazon IVS Потоковая передача в реальном времени.
Пример 3: Получение состава с включённой записью миниатюр
Следующий get-composition пример получает состав для указанного ARN (имени ресурса Amazon), у которого включена запись миниатюр с настройками по умолчанию.
aws ivs-realtime get-composition \
--arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"
Вывод:
{
"composition": {
"arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
"destinations": [
{
"configuration": {
"channel": {
"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
"encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
},
"name": ""
},
"id": "AabBCcdDEefF",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "ACTIVE"
},
{
"configuration": {
"name": "",
"s3": {
"encoderConfigurationArns": [
"arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
],
"recordingConfiguration": {
"format": "HLS",
"hlsConfiguration": {
"targetSegmentDurationSeconds": 2
}
},
"storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE",
"thumbnailConfigurations": [
{
"targetIntervalSeconds": 60,
"storage": [
"SEQUENTIAL"
],
}
]
}
},
"detail": {
"s3": {
"recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
}
},
"id": "GHFabcgefABC",
"startTime": "2023-10-16T23:26:00+00:00",
"state": "STARTING"
}
],
"layout": {
"grid": {
"featuredParticipantAttribute": ""
"gridGap": 2,
"omitStoppedVideo": false,
"videoAspectRatio": "VIDEO",
"videoFillMode": "" }
},
"stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
"startTime": "2023-10-16T23:24:00+00:00",
"state": "ACTIVE",
"tags": {}
}
}
Дополнительная информация приведена в разделе Композиционное запись IVS | Потоковая передача в реальном времени в Руководстве пользователя Amazon IVS Потоковая передача в реальном времени.
Вывод
состав -> (структура)
Возвращённый состав.
arn -> (строка)
stageArn -> (строка)
состояние -> (строка)
макет -> (структура)
Объект макета для настройки параметров композиции.
сетка -> (структура)
Настройки, связанные с макетом сетки. По умолчанию: макет сетки.
featuredParticipantAttribute -> (строка)
"true" (как строковое значение) в ParticipantTokenConfiguration, размещается в выделенном слоте. По умолчанию: "" (нет выделенного участника).omitStoppedVideo -> (булево)
false.videoAspectRatio -> (строка)
VIDEO — 16:9, SQUARE — 1:1, и PORTRAIT — 3:4. По умолчанию: VIDEO.videoFillMode -> (строка)
FILL (растянуто), COVER (обрезано) или CONTAIN (заливка по горизонтали). Если не указано, videoFillMode по умолчанию имеет режим заливки COVER для участников в сетке и режим заливки CONTAIN для выделенных участников.gridGap -> (целое)
2.pip -> (структура)
Настройки, связанные с макетом PiP.
featuredParticipantAttribute -> (строка)
"true" (как строковое значение) в ParticipantTokenConfiguration, размещается в выделенном слоте. По умолчанию: "" (нет выделенного участника).omitStoppedVideo -> (булево)
false.videoFillMode -> (строка)
FILL (растянуто), COVER (обрезано) или CONTAIN (заливка по горизонтали). По умолчанию: COVER.gridGap -> (целое)
0.pipParticipantAttribute -> (строка)
"true" (как строковое значение) в ParticipantTokenConfiguration, размещается в слоте PiP. По умолчанию: "" (нет участника PiP).pipBehavior -> (строка)
STATIC (сохраняет исходное положение/размер) или DYNAMIC (расширяется до всей композиции). По умолчанию: STATIC.pipOffset -> (целое)
PipPosition . По умолчанию: 0.pipPosition -> (строка)
BOTTOM_RIGHT.pipWidth -> (целое)
pipWidth будет основано на размере композиции и соотношении сторон видео участника.pipHeight -> (целое)
pipHeight будет основано на размере композиции и соотношении сторон видео участника.destinations -> (список)
Массив объектов Destination. Состав может содержать один пункт назначения (channel или s3 ) или два (один channel и один s3 ).
(структура)
Объект, определяющий статус пункта назначения.
id -> (строка)
состояние -> (строка)
startTime -> (временная метка)
endTime -> (временная метка)
configuration -> (структура)
Настройки, используемые для создания этого пункта назначения.
name -> (строка)
канал -> (структура)
Канал IVS, используемый для трансляции, для композиции на стороне сервера. Должен быть указан либо channel, либо s3.
channelArn -> (строка)
encoderConfigurationArn -> (строка)
s3 -> (структура)
Настройка хранения S3, используемая для записи данных видео. Должен быть указан либо channel, либо s3.
storageConfigurationArn -> (строка)
encoderConfigurationArns -> (список)
ARN ресурсов EncoderConfiguration. Ресурсы конфигурации кодера и стадии должны находиться в одной учётной записи AWS и одной области.
(строка)
recordingConfiguration -> (структура)
Массив карт, каждая из которых имеет вид string:string (key:value) . Это необязательное указание пользователя, в настоящее время используемое только для указания формата записи для хранения записи в Amazon S3.
hlsConfiguration -> (структура)
Объект конфигурации HLS для возвращения информации о настройке записи.
targetSegmentDurationSeconds -> (целое)
формат -> (строка)
thumbnailConfigurations -> (список)
Сложный тип, позволяющий включить/выключить запись миниатюр для состава и изменить интервал, с которым генерируются миниатюры для сеанса прямой трансляции.
(структура)
Объект, представляющий конфигурацию миниатюр для записанного видео для состава.
targetIntervalSeconds -> (целое)
storage -> (список)
Указывает формат, в котором записываются миниатюры. SEQUENTIAL записывает все сгенерированные миниатюры последовательно в каталог media/thumbnails/(width)x(height), где (width) и (height) — ширина и высота миниатюры. LATEST сохраняет последнюю миниатюру в media/latest_thumbnail/(width)x(height)/thumb.jpg и перезаписывает её с интервалом, указанным в targetIntervalSeconds. Вы можете включить как SEQUENTIAL, так и LATEST. По умолчанию: SEQUENTIAL.
(строка)
подробности -> (структура)
Необязательные подробности о состоянии пункта назначения.
s3 -> (структура)
Объект деталей S3 для возвращения информации о пункте назначения S3.
recordingPrefix -> (строка)
метки -> (карта)
Метки, присоединённые к ресурсу. Массив карт, каждая из которых имеет вид string:string (key:value) . См. Рекомендации и стратегии в Тегировании ресурсов AWS и Редакторе тегов для получения подробной информации, включая ограничения, которые применяются к меткам и «Пределы и требования к именованию тегов»; Amazon IVS не имеет ограничений на теги, кроме тех, которые там описаны.
ключ -> (строка)
значение -> (строка)
startTime -> (временная метка)
endTime -> (временная метка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
