Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-media-pipelines ]

получить-поток-захвата-аудиовидео

Описание

Получает существующий медиа-поток.

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

Синтаксис

  get-media-capture-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
  • таблица
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

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

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

ActiveSpeakerPosition -> (строка)

Позиция видео-плитки активного спикера.

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, чем текущая учетная запись 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 и асимметричные ключи в KMS в руководстве разработчика Key Management Service.

SinkIamRoleArn -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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