[ aws . chime-sdk-media-pipelines ]
get-media-pipeline
Описание
Получает существующую медиа-трансляцию.
См. также: Документация AWS API
Синтаксис
get-media-pipeline
--media-pipeline-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]
Параметры
--media-pipeline-id (строка)
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--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.
Вывод
MediaPipeline -> (структура)
Объект конвейера медиа.
MediaCapturePipeline -> (структура)
Конвейер, позволяющий пользователям записывать аудио и видео.
MediaPipelineId -> (строка)
MediaPipelineArn -> (строка)
SourceType -> (строка)
ChimeMeeting .SourceArn -> (строка)
Status -> (строка)
SinkType -> (строка)
SinkArn -> (строка)
CreatedTimestamp -> (временная метка)
UpdatedTimestamp -> (временная метка)
ChimeSdkMeetingConfiguration -> (структура)
Настройка для указанного конвейера медиа. SourceType должен быть ChimeSdkMeeting .
SourceConfiguration -> (структура)
Настройка источника для указанного конвейера медиа.
SelectedVideoStreams -> (структура)
Выбранные видеопотоки для указанного конвейера медиа. Количество видеопотоков не должно превышать 25.
AttendeeIds -> (список)
Идентификаторы участников выбранных потоков для конвейера медиа.
(строка)
ExternalUserIds -> (список)
Внешние идентификаторы пользователей выбранных потоков для конвейера медиа.
(строка)
ArtifactsConfiguration -> (структура)
Настройка артефактов в конференции Amazon Chime SDK.
Audio -> (структура)
Настройка аудио-артефактов.
MuxType -> (строка)
Video -> (структура)
Настройка видео-артефактов.
State -> (строка)
MuxType -> (строка)
Content -> (структура)
Настройка контент-артефактов.
State -> (строка)
MuxType -> (строка)
CompositedVideo -> (структура)
Включает видеокомпозицию.
Layout -> (строка)
GridView в объекте конфигурации.Resolution -> (строка)
GridViewConfiguration -> (структура)
Настройка конфигурации GridView.
ContentShareLayout -> (строка)
PresenterOnlyConfiguration -> (структура)
Определяет параметры конфигурации для только видеоплитки презентера.
PresenterPosition -> (строка)
TopRight .ActiveSpeakerOnlyConfiguration -> (структура)
Настройки конфигурации для видеоплитки ActiveSpeakerOnly.
ActiveSpeakerPosition -> (строка)
ActiveSpeakerOnly.HorizontalLayoutConfiguration -> (структура)
Настройки конфигурации для горизонтального макета.
TileOrder -> (строка)
TilePosition -> (строка)
TileCount -> (целое число)
TileAspectRatio -> (строка)
VerticalLayoutConfiguration -> (структура)
Настройки конфигурации для вертикального макета.
TileOrder -> (строка)
TilePosition -> (строка)
TileCount -> (целое число)
TileAspectRatio -> (строка)
VideoAttribute -> (структура)
Настройки атрибутов видеоплиток.
CornerRadius -> (целое число)
BorderColor -> (строка)
HighlightColor -> (строка)
BorderThickness -> (целое число)
CanvasOrientation -> (строка)
SseAwsKeyManagementParams -> (структура)
Объект, содержащий параметры шифрования на стороне сервера, которые будут использоваться конвейером захвата медиа. Параметры также могут использоваться конвейером конкатенации медиа, принимающим конвейер захвата медиа в качестве источника медиа.
AwsKmsKeyId -> (строка)
Ключ KMS, который вы хотите использовать для шифрования выходных данных вашего конвейера медиа. Расшифровка требуется для конвейера конкатенации. Если вы используете ключ, расположенный в текущей учетной записи Amazon Web Services, вы можете указать свой ключ KMS четырьмя способами:
- Используйте сам идентификатор ключа KMS. Например,
1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте псевдоним для идентификатора ключа KMS. Например,
alias/ExampleAlias. - Используйте Amazon Resource Name (ARN) для идентификатора ключа KMS. Например,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте ARN для псевдонима ключа KMS. Например,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
Если вы используете ключ, расположенный в другой учетной записи Amazon Web Services, отличной от текущей, вы можете указать свой ключ KMS двумя способами:
- Используйте ARN для идентификатора ключа KMS. Например,
arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. - Используйте ARN для псевдонима ключа KMS. Например,
arn:aws:kms:region:account-ID:alias/ExampleAlias.
Если вы не укажете ключ шифрования, ваши выходные данные будут зашифрованы с помощью стандартного ключа Amazon S3 (SSE-S3).
Обратите внимание, что роль, указанная в параметре SinkIamRoleArn запроса, должна иметь разрешения на использование указанного ключа KMS.
AwsKmsEncryptionContext -> (строка)
SinkIamRoleArn -> (строка)
AwsKmsKeyId в SseAwsKeyManagementParams.MediaLiveConnectorPipeline -> (структура)
Трубка коннектора медиа-пайплайна.
Источники -> (список)
Источники данных трубки коннектора.
(структура)
Объект конфигурации источника данных потокового медиа-пайплайна.
ТипИсточника -> (строка)
ChimeSdkMeetingLiveConnectorConfiguration -> (структура)
Настройки конфигурации трубки коннектора.
Arn -> (строка)
ТипМультиплексирования -> (строка)
КомпонованноеВидео -> (структура)
Компонованное видео медиа-пайплайна.
Макет -> (строка)
GridView в объекте конфигурации.Разрешение -> (строка)
КонфигурацияСетки -> (структура)
Настройка конфигурации GridView.
МакетОбменаСодержимым -> (строка)
КонфигурацияТолькоПрезидента -> (структура)
Определяет параметры конфигурации для видеоплитки только президента.
ПозицияПрезидента -> (строка)
TopRight.КонфигурацияТолькоАктивногоОратора -> (структура)
Настройки конфигурации видеоплитки ActiveSpeakerOnly.
ПозицияАктивногоОратора -> (строка)
ActiveSpeakerOnly.КонфигурацияГоризонтальногоМакет -> (структура)
Настройки конфигурации для горизонтального макета.
ПорядокПлиток -> (строка)
ПозицияПлиток -> (строка)
КоличествоПлиток -> (целое число)
СоотношениеСторонПлиток -> (строка)
КонфигурацияВертикальногоМакет -> (структура)
Настройки конфигурации для вертикального макета.
ПорядокПлиток -> (строка)
ПозицияПлиток -> (строка)
КоличествоПлиток -> (целое число)
СоотношениеСторонПлиток -> (строка)
АтрибутВидео -> (структура)
Настройки атрибутов видеоплиток.
РадиусУглов -> (целое число)
ЦветГраницы -> (строка)
ЦветВыделения -> (строка)
ТолщинаГраницы -> (целое число)
ОриентацияПолотнища -> (строка)
КонфигурацияИсточника -> (структура)
Настройки конфигурации источника объекта конфигурации медиа-пайплайна.
ВыбранныеВидеоПотоки -> (структура)
Выбранные видеопотоки для указанного медиа-пайплайна. Количество видеопотоков не может превышать 25.
ИдентификаторыУчастников -> (список)
Идентификаторы участников выбранных потоков для медиа-пайплайна.
(строка)
ВнешниеИдентификаторыПользователей -> (список)
Внешние идентификаторы пользователей выбранных потоков для медиа-пайплайна.
(строка)
Стоки -> (список)
Стоки данных трубки коннектора.
(структура)
Настройки конфигурации стока медиа-пайплайна.
ТипСтока -> (строка)
КонфигурацияRTMP -> (структура)
Настройки конфигурации RTMP стока.
Url -> (строка)
Аудиоканалы -> (строка)
ЧастотаДискретизацииАудио -> (строка)
ИдентификаторМедиаПайплайна -> (строка)
ArnМедиаПайплайна -> (строка)
Статус -> (строка)
ВремяСоздания -> (временная метка)
ВремяОбновления -> (временная метка)
МедиаПайплайнКонкатенации -> (структура)
Пайплайн медиа-конкатенации в медиа-пайплайне.
ИдентификаторМедиаПайплайна -> (строка)
ArnМедиаПайплайна -> (строка)
SourceConfiguration.Источники -> (список)
Источники данных, подлежащие конкатенации.
(структура)
Тип источника и настройки конфигурации медиа-пайплайна в объекте конфигурации.
Тип -> (строка)
КонфигурацияИсточникаМедиаЗаписи -> (структура)
Настройки конкатенации медиа-пайплайна в объекте конфигурации.
ArnМедиаПайплайна -> (строка)
КонфигурацияChimeSdkВстречи -> (структура)
Настройки конфигурации встречи в объекте конфигурации пайплайна захвата медиа.
КонфигурацияАртефактов -> (структура)
Конфигурация артефактов в конкатенации Amazon Chime SDK встречи.
Аудио -> (структура)
Конфигурация для конкатенации аудиоартефактов.
Состояние -> (строка)
Видео -> (структура)
Конфигурация для конкатенации видеоартефактов.
Состояние -> (строка)
Контент -> (структура)
Конфигурация для конкатенации артефактов контента.
Состояние -> (строка)
КаналДанных -> (структура)
Конфигурация для конкатенации артефактов канала данных.
Состояние -> (строка)
СообщенияТранскрипции -> (структура)
Конфигурация для конкатенации артефактов сообщений транскрипции.
Состояние -> (строка)
СобытияВстречи -> (структура)
Конфигурация для конкатенации артефактов событий встречи.
Состояние -> (строка)
КомпонованноеВидео -> (структура)
Конфигурация для конкатенации артефактов компонованного видео.
Состояние -> (строка)
Стоки -> (список)
Стоки данных пайплайна конкатенации.
(структура)
Сток данных объекта конфигурации.
Тип -> (строка)
КонфигурацияСтокаВедраS3 -> (структура)
Настройки конфигурации стока ведра Amazon S3.
Назначение -> (строка)
Статус -> (строка)
ВремяСоздания -> (временная метка)
ВремяОбновления -> (временная метка)
ПайплайнМедиаВсведений -> (структура)
Поток обработки информации о медиа в потоке медиа.
MediaPipelineId -> (строка)
MediaPipelineArn -> (строка)
MediaInsightsPipelineConfigurationArn -> (строка)
Status -> (строка)
KinesisVideoStreamSourceRuntimeConfiguration -> (структура)
Настройки конфигурации потока видеопотока Kinesis в потоке обработки информации о медиа.
Streams -> (список)
Потоки в конфигурации исходного выполнения потока видеопотока Kinesis.
(структура)
Настройки конфигурации потока.
StreamArn -> (строка)
FragmentNumber -> (строка)
StreamChannelDefinition -> (структура)
Определение потоковой канальной структуры в конфигурации потока.
NumberOfChannels -> (целое число)
ChannelDefinitions -> (список)
Определения каналов в потоковой канальной структуре.
(структура)
Определяет аудиоканал в потоке видео Kinesis.
ChannelId -> (целое число)
ParticipantRole -> (строка)
AGENT или CUSTOMER.MediaEncoding -> (строка)
Указывает кодирование входного аудио. Поддерживается формат: PCM (только подписанные 16-битные аудиоформаты с малым порядком байтов, которые не включают WAV).
Дополнительную информацию см. в разделе Форматы медиа в руководстве разработчика Amazon Transcribe.
MediaSampleRate -> (целое число)
Частота дискретизации входного аудио (в герцах). Аудио низкого качества, например, аудиотелефонных разговоров, обычно составляет около 8000 Гц. Аудио высокого качества обычно находится в диапазоне от 16000 Гц до 48000 Гц. Обратите внимание, что указанная частота дискретизации должна соответствовать частоте дискретизации вашего аудио.
Допустимый диапазон: минимальное значение 8000. Максимальное значение 48000.
MediaInsightsRuntimeMetadata -> (карта)
Метаданные о выполнении потока обработки информации о медиа.
key -> (строка)
value -> (строка)
KinesisVideoStreamRecordingSourceRuntimeConfiguration -> (структура)
Настройки конфигурации выполнения потока записи видеопотока Kinesis в потоке обработки информации о медиа.
Streams -> (список)
Потоки, которые необходимо записать.
(структура)
Структура, содержащая настройки для записи медиа.
StreamArn -> (строка)
FragmentSelector -> (структура)
Описание временного диапазона и временной отметки начала диапазона фрагментов в потоке видео Kinesis.
FragmentSelectorType -> (строка)
Server или Producer. Дополнительную информацию см. в разделе StartSelectorType в руководстве разработчика Amazon Kinesis Video Streams.TimestampRange -> (структура)
Диапазон временных меток для возврата.
StartTimestamp -> (временная метка)
EndTimestamp -> (временная метка)
S3RecordingSinkRuntimeConfiguration -> (структура)
Настройки конфигурации выполнения ведра Amazon S3, которое хранит записи в потоке обработки информации о медиа.
Destination -> (строка)
RecordingFileFormat -> (строка)
CreatedTimestamp -> (временная метка)
ElementStatuses -> (список)
Статусы, которые элементы в потоке обработки информации о медиа могут иметь во время обработки данных.
(структура)
Статус элемента потока.
Type -> (строка)
Status -> (строка)
MediaStreamPipeline -> (структура)
Определяет поток медиа как поток медиапотока.
MediaPipelineId -> (строка)
MediaPipelineArn -> (строка)
CreatedTimestamp -> (временная метка)
UpdatedTimestamp -> (временная метка)
Status -> (строка)
Sources -> (список)
Источники данных потока медиапотока.
(структура)
Структура, содержащая настройки источников медиапотоков.
SourceType -> (строка)
SourceArn -> (строка)
Sinks -> (список)
Приемники данных потока медиапотока.
(структура)
Структура, содержащая настройки приемника медиапотока.
SinkArn -> (строка)
SinkType -> (строка)
ReservedStreamCapacity -> (целое число)
MediaStreamType -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.