Spec-Zone.ru › AWS CLI v2

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

ARN конвейера захвата медиа

SourceType -> (строка)

Тип источника, из которого сохраняются медиа-артефакты. Вы должны использовать ChimeMeeting .

SourceArn -> (строка)

ARN источника, из которого сохраняются медиа-артефакты.

Status -> (строка)

Статус конвейера медиа.

SinkType -> (строка)

Тип назначения, в который сохраняются медиа-артефакты. Вы должны использовать ведро S3.

SinkArn -> (строка)

ARN назначения, в который сохраняются медиа-артефакты.

CreatedTimestamp -> (временная метка)

Время создания конвейера в формате ISO 8601.

UpdatedTimestamp -> (временная метка)

Время обновления конвейера в формате ISO 8601.

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

Настройка для указанного конвейера медиа. SourceType должен быть ChimeSdkMeeting .

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

Настройка источника для указанного конвейера медиа.

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

Выбранные видеопотоки для указанного конвейера медиа. Количество видеопотоков не должно превышать 25.

AttendeeIds -> (список)

Идентификаторы участников выбранных потоков для конвейера медиа.

(строка)

ExternalUserIds -> (список)

Внешние идентификаторы пользователей выбранных потоков для конвейера медиа.

(строка)

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

Настройка артефактов в конференции Amazon Chime SDK.

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

Настройка аудио-артефактов.

MuxType -> (строка)

Тип MUX конфигурации аудио-артефакта.

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

Настройка видео-артефактов.

State -> (строка)

Указывает, включен или отключен видео-артефакт.

MuxType -> (строка)

Тип MUX конфигурации видео-артефакта.

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

Настройка контент-артефактов.

State -> (строка)

Указывает, включен или отключен контент-артефакт.

MuxType -> (строка)

Тип MUX конфигурации артефакта.

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

Включает видеокомпозицию.

Layout -> (строка)

Настройка макета, например, GridView в объекте конфигурации.

Resolution -> (строка)

Настройка разрешения видео в объекте конфигурации. По умолчанию: HD с разрешением 1280 x 720. Разрешение FHD: 1920 x 1080.

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

Настройка конфигурации GridView.

ContentShareLayout -> (строка)

Определяет макет видеоплиток при включенной совместной работе с контентом.

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

Определяет параметры конфигурации для только видеоплитки презентера.

PresenterPosition -> (строка)

Определяет позицию видеоплитки презентера. По умолчанию: TopRight .

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

Настройки конфигурации для видеоплитки ActiveSpeakerOnly.

ActiveSpeakerPosition -> (строка)

Позиция видеоплитки ActiveSpeakerOnly.

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

Настройки конфигурации для горизонтального макета.

TileOrder -> (строка)

Устанавливает автоматическую сортировку видеоплиток.

TilePosition -> (строка)

Устанавливает позицию горизонтальных плиток.

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

Максимальное количество отображаемых видеоплиток.

TileAspectRatio -> (строка)

Устанавливает соотношение сторон всех видеоплиток.

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

Настройки конфигурации для вертикального макета.

TileOrder -> (строка)

Устанавливает автоматическую сортировку видеоплиток.

TilePosition -> (строка)

Устанавливает позицию вертикальных плиток.

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

Максимальное количество отображаемых плиток.

TileAspectRatio -> (строка)

Устанавливает соотношение сторон видеоплиток, например, 16:9.

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

Строка Base64-кодированного JSON UTF-8, содержащая контекст шифрования в виде пар ключ-значение без секретности, известных как пары контекста шифрования, которые обеспечивают дополнительный уровень безопасности для ваших данных. Более подробную информацию см. в KMS Context and Asymmetric keys in KMS в Руководстве разработчика Key Management Service.

SinkIamRoleArn -> (строка)

Amazon Resource Name (ARN) роли синков, которая будет использоваться с AwsKmsKeyId в SseAwsKeyManagementParams.

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

Трубка коннектора медиа-пайплайна.

Источники -> (список)

Источники данных трубки коннектора.

(структура)

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

ТипИсточника -> (строка)

Тип источника медиа в конфигурации источника.

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

Настройки конфигурации трубки коннектора.

Arn -> (строка)

Chime SDK ARN встречи конфигурации.

ТипМультиплексирования -> (строка)

Тип мультиплексирования конфигурации.

КомпонованноеВидео -> (структура)

Компонованное видео медиа-пайплайна.

Макет -> (строка)

Настройка макета, например, GridView в объекте конфигурации.

Разрешение -> (строка)

Настройка разрешения видео в объекте конфигурации. По умолчанию: HD 1280 x 720. Разрешение FHD: 1920 x 1080.

КонфигурацияСетки -> (структура)

Настройка конфигурации GridView.

МакетОбменаСодержимым -> (строка)

Определяет макет видеоплиток при включенном обмене содержимым.

КонфигурацияТолькоПрезидента -> (структура)

Определяет параметры конфигурации для видеоплитки только президента.

ПозицияПрезидента -> (строка)

Определяет позицию видеоплитки президента. По умолчанию: TopRight.

КонфигурацияТолькоАктивногоОратора -> (структура)

Настройки конфигурации видеоплитки ActiveSpeakerOnly.

ПозицияАктивногоОратора -> (строка)

Позиция видеоплитки ActiveSpeakerOnly.

КонфигурацияГоризонтальногоМакет -> (структура)

Настройки конфигурации для горизонтального макета.

ПорядокПлиток -> (строка)

Устанавливает автоматический порядок видеоплиток.

ПозицияПлиток -> (строка)

Устанавливает позицию горизонтальных плиток.

КоличествоПлиток -> (целое число)

Максимальное количество видеоплиток для отображения.

СоотношениеСторонПлиток -> (строка)

Указывает соотношение сторон всех видеоплиток.

КонфигурацияВертикальногоМакет -> (структура)

Настройки конфигурации для вертикального макета.

ПорядокПлиток -> (строка)

Устанавливает автоматический порядок видеоплиток.

ПозицияПлиток -> (строка)

Устанавливает позицию вертикальных плиток.

КоличествоПлиток -> (целое число)

Максимальное количество плиток для отображения.

СоотношениеСторонПлиток -> (строка)

Устанавливает соотношение сторон видеоплиток, например, 16:9.

АтрибутВидео -> (структура)

Настройки атрибутов видеоплиток.

РадиусУглов -> (целое число)

Устанавливает радиус углов всех видеоплиток.

ЦветГраницы -> (строка)

Определяет цвет границы всех видеоплиток.

ЦветВыделения -> (строка)

Определяет цвет выделения активной видеоплитки.

ТолщинаГраницы -> (целое число)

Определяет толщину границы всех видеоплиток.

ОриентацияПолотнища -> (строка)

Настройка ориентации: горизонтальная или вертикальная.

КонфигурацияИсточника -> (структура)

Настройки конфигурации источника объекта конфигурации медиа-пайплайна.

ВыбранныеВидеоПотоки -> (структура)

Выбранные видеопотоки для указанного медиа-пайплайна. Количество видеопотоков не может превышать 25.

ИдентификаторыУчастников -> (список)

Идентификаторы участников выбранных потоков для медиа-пайплайна.

(строка)

ВнешниеИдентификаторыПользователей -> (список)

Внешние идентификаторы пользователей выбранных потоков для медиа-пайплайна.

(строка)

Стоки -> (список)

Стоки данных трубки коннектора.

(структура)

Настройки конфигурации стока медиа-пайплайна.

ТипСтока -> (строка)

Тип стока конфигурации.

КонфигурацияRTMP -> (структура)

Настройки конфигурации RTMP стока.

Url -> (строка)

URL конфигурации RTMP.

Аудиоканалы -> (строка)

Настроенные аудиоканалы для конфигурации RTMP.

ЧастотаДискретизацииАудио -> (строка)

Частота дискретизации аудио, настроенная для конфигурации RTMP. По умолчанию: 48000.

ИдентификаторМедиаПайплайна -> (строка)

Идентификатор трубки коннектора.

ArnМедиаПайплайна -> (строка)

ARN трубки коннектора.

Статус -> (строка)

Статус трубки коннектора.

ВремяСоздания -> (временная метка)

Время создания трубки коннектора.

ВремяОбновления -> (временная метка)

Время последнего обновления трубки коннектора.

МедиаПайплайнКонкатенации -> (структура)

Пайплайн медиа-конкатенации в медиа-пайплайне.

ИдентификаторМедиаПайплайна -> (строка)

Идентификатор медиа-пайплайна, подлежащего конкатенации.

ArnМедиаПайплайна -> (строка)

ARN медиа-пайплайна, указанного в объекте SourceConfiguration.

Источники -> (список)

Источники данных, подлежащие конкатенации.

(структура)

Тип источника и настройки конфигурации медиа-пайплайна в объекте конфигурации.

Тип -> (строка)

Тип источника конкатенации в объекте конфигурации.

КонфигурацияИсточникаМедиаЗаписи -> (структура)

Настройки конкатенации медиа-пайплайна в объекте конфигурации.

ArnМедиаПайплайна -> (строка)

ARN медиа-пайплайна в объекте конфигурации пайплайна захвата медиа.

КонфигурацияChimeSdkВстречи -> (структура)

Настройки конфигурации встречи в объекте конфигурации пайплайна захвата медиа.

КонфигурацияАртефактов -> (структура)

Конфигурация артефактов в конкатенации Amazon Chime SDK встречи.

Аудио -> (структура)

Конфигурация для конкатенации аудиоартефактов.

Состояние -> (строка)

Включает или отключает объект конфигурации.

Видео -> (структура)

Конфигурация для конкатенации видеоартефактов.

Состояние -> (строка)

Включает или отключает объект конфигурации.

Контент -> (структура)

Конфигурация для конкатенации артефактов контента.

Состояние -> (строка)

Включает или отключает объект конфигурации.

КаналДанных -> (структура)

Конфигурация для конкатенации артефактов канала данных.

Состояние -> (строка)

Включает или отключает объект конфигурации.

СообщенияТранскрипции -> (структура)

Конфигурация для конкатенации артефактов сообщений транскрипции.

Состояние -> (строка)

Включает или отключает объект конфигурации.

СобытияВстречи -> (структура)

Конфигурация для конкатенации артефактов событий встречи.

Состояние -> (строка)

Включает или отключает объект конфигурации.

КомпонованноеВидео -> (структура)

Конфигурация для конкатенации артефактов компонованного видео.

Состояние -> (строка)

Включает или отключает объект конфигурации.

Стоки -> (список)

Стоки данных пайплайна конкатенации.

(структура)

Сток данных объекта конфигурации.

Тип -> (строка)

Тип стока данных в объекте конфигурации.

КонфигурацияСтокаВедраS3 -> (структура)

Настройки конфигурации стока ведра Amazon S3.

Назначение -> (строка)

URL назначения ведра S3.

Статус -> (строка)

Статус пайплайна конкатенации.

ВремяСоздания -> (временная метка)

Время создания пайплайна конкатенации.

ВремяОбновления -> (временная метка)

Время последнего обновления пайплайна конкатенации.

ПайплайнМедиаВсведений -> (структура)

Поток обработки информации о медиа в потоке медиа.

MediaPipelineId -> (строка)

Идентификатор потока обработки информации о медиа.

MediaPipelineArn -> (строка)

ARN потока обработки информации о медиа.

MediaInsightsPipelineConfigurationArn -> (строка)

ARN конфигурации настроек потока обработки информации о медиа.

Status -> (строка)

Статус потока обработки информации о медиа.

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

Настройки конфигурации потока видеопотока Kinesis в потоке обработки информации о медиа.

Streams -> (список)

Потоки в конфигурации исходного выполнения потока видеопотока Kinesis.

(структура)

Настройки конфигурации потока.

StreamArn -> (строка)

ARN потока.

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

ARN потока записи.

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

Описание временного диапазона и временной отметки начала диапазона фрагментов в потоке видео Kinesis.

FragmentSelectorType -> (строка)

Источник временных меток для использования, Server или Producer. Дополнительную информацию см. в разделе StartSelectorType в руководстве разработчика Amazon Kinesis Video Streams.

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

Диапазон временных меток для возврата.

StartTimestamp -> (временная метка)

Начальная временная метка для указанного диапазона.

EndTimestamp -> (временная метка)

Конечная временная метка для указанного диапазона.

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

Настройки конфигурации выполнения ведра Amazon S3, которое хранит записи в потоке обработки информации о медиа.

Destination -> (строка)

URI ведра S3, используемого в качестве приемника.

RecordingFileFormat -> (строка)

Формат файла для медиафайлов, отправляемых в ведро Amazon S3.

CreatedTimestamp -> (временная метка)

Время создания потока обработки информации о медиа.

ElementStatuses -> (список)

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

(структура)

Статус элемента потока.

Type -> (строка)

Тип статуса.

Status -> (строка)

Статус элемента.

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

Определяет поток медиа как поток медиапотока.

MediaPipelineId -> (строка)

Идентификатор потока медиапотока.

MediaPipelineArn -> (строка)

ARN потока медиапотока.

CreatedTimestamp -> (временная метка)

Время создания потока медиапотока.

UpdatedTimestamp -> (временная метка)

Время обновления потока медиапотока.

Status -> (строка)

Статус потока медиапотока.

Sources -> (список)

Источники данных потока медиапотока.

(структура)

Структура, содержащая настройки источников медиапотоков.

SourceType -> (строка)

Тип источника медиапотока.

SourceArn -> (строка)

ARN совещания.

Sinks -> (список)

Приемники данных потока медиапотока.

(структура)

Структура, содержащая настройки приемника медиапотока.

SinkArn -> (строка)

ARN пула потоков Kinesis Video Stream, возвращаемого API CreateMediaPipelineKinesisVideoStreamPool.

SinkType -> (строка)

Тип приемника медиапотока.

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

Указывает количество потоков, которое может принять приемник.

MediaStreamType -> (строка)

Тип медиапотока приемника.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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