[ aws . chime-sdk-media-pipelines ]
create-media-capture-pipeline
Описание
Создаёт медиа-поток.
См. также: Документацию API AWS
Синтаксис
create-media-capture-pipeline
--source-type <value>
--source-arn <value>
--sink-type <value>
--sink-arn <value>
[--client-request-token <value>]
[--chime-sdk-meeting-configuration <value>]
[--sse-aws-key-management-params <value>]
[--sink-iam-role-arn <value>]
[--tags <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]
Параметры
--source-type (строка)
Тип источника, из которого захватываются медиа-артефакты. Поддерживается только встреча Chime SDK.
Возможные значения:
ChimeSdkMeeting
--source-arn (строка)
--sink-type (строка)
Тип назначения, в который сохраняются медиа-артефакты. Необходимо использовать объём S3.
Возможные значения:
S3Bucket
--sink-arn (строка)
--client-request-token (строка)
--chime-sdk-meeting-configuration (структура)
Настройка указанного медиа-потока. 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 -> (строка)
Синтаксис JSON:
{
"SourceConfiguration": {
"SelectedVideoStreams": {
"AttendeeIds": ["string", ...],
"ExternalUserIds": ["string", ...]
}
},
"ArtifactsConfiguration": {
"Audio": {
"MuxType": "AudioOnly"|"AudioWithActiveSpeakerVideo"|"AudioWithCompositedVideo"
},
"Video": {
"State": "Enabled"|"Disabled",
"MuxType": "VideoOnly"
},
"Content": {
"State": "Enabled"|"Disabled",
"MuxType": "ContentOnly"
},
"CompositedVideo": {
"Layout": "GridView",
"Resolution": "HD"|"FHD",
"GridViewConfiguration": {
"ContentShareLayout": "PresenterOnly"|"Horizontal"|"Vertical"|"ActiveSpeakerOnly",
"PresenterOnlyConfiguration": {
"PresenterPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
},
"ActiveSpeakerOnlyConfiguration": {
"ActiveSpeakerPosition": "TopLeft"|"TopRight"|"BottomLeft"|"BottomRight"
},
"HorizontalLayoutConfiguration": {
"TileOrder": "JoinSequence"|"SpeakerSequence",
"TilePosition": "Top"|"Bottom",
"TileCount": integer,
"TileAspectRatio": "string"
},
"VerticalLayoutConfiguration": {
"TileOrder": "JoinSequence"|"SpeakerSequence",
"TilePosition": "Left"|"Right",
"TileCount": integer,
"TileAspectRatio": "string"
},
"VideoAttribute": {
"CornerRadius": integer,
"BorderColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
"HighlightColor": "Black"|"Blue"|"Red"|"Green"|"White"|"Yellow",
"BorderThickness": integer
},
"CanvasOrientation": "Landscape"|"Portrait"
}
}
}
}
--sse-aws-key-management-params (структура)
Объект, содержащий параметры шифрования на стороне сервера, которые будут использоваться медиа-потоком захвата. Эти параметры также могут использоваться медиа-потоком конкатенации, принимающим медиа-поток захвата в качестве медиа-источника.
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 -> (строка)
Сокращённый синтаксис:
AwsKmsKeyId=string,AwsKmsEncryptionContext=string
Синтаксис JSON:
{
"AwsKmsKeyId": "string",
"AwsKmsEncryptionContext": "string"
}
--sink-iam-role-arn (строка)
Amazon Resource Name (ARN) роли приемника, которая будет использоваться с AwsKmsKeyId в SseAwsKeyManagementParams . Может взаимодействовать только с типом приемника S3Bucket. Роль должна принадлежать учётной записи вызывающего и должна иметь возможность действовать от имени вызывающего во время вызова API. Все минимальные требования к разрешениям политики для вызывающего лица для выполнения действий, связанных с приемником, одинаковы для SinkIamRoleArn .
Кроме того, роль должна иметь разрешение на kms:GenerateDataKey с использованием предоставленного ключа KMS в качестве AwsKmsKeyId в SseAwsKeyManagementParams . Если позже потребуется медиа-конкатенация, роль также должна иметь разрешение на kms:Decrypt для того же ключа KMS.
--tags (список)
Пары тегов ключ-значение.
(структура)
Пара ключ/значение, предоставляющая пользователям доступ к ресурсам совещаний.
Key -> (строка)
Value -> (строка)
Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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 (boolean)
Включить отладку логирования.
--endpoint-url (string)
Переопределить значение URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла аутентификации.
--region (string)
Регион для использования. Переопределяет параметры конфигурации/среды.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот параметр предоставлен.
--ca-bundle (string)
Файл с пакетом сертификатов CA для проверки SSL-сертификатов. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения к сокету в секундах. Если значение равно 0, подключение к сокету будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
MediaCapturePipeline -> (структура)
Объект медиа-пайплайна, ID, тип источника, ARN источника, тип приемника и ARN приемника объекта медиа-пайплайна.
MediaPipelineId -> (строка)
MediaPipelineArn -> (строка)
SourceType -> (строка)
ChimeMeeting .SourceArn -> (строка)
Status -> (строка)
SinkType -> (строка)
SinkArn -> (строка)
CreatedTimestamp -> (метка времени)
UpdatedTimestamp -> (метка времени)
ChimeSdkMeetingConfiguration -> (структура)
Настройки для указанного медиа-пайплайна. SourceType должен быть ChimeSdkMeeting .
SourceConfiguration -> (структура)
Настройки источника для указанного медиа-пайплайна.
SelectedVideoStreams -> (структура)
Выбранные видеопотоки для указанного медиа-пайплайна. Количество видеопотоков не может превышать 25.
AttendeeIds -> (список)
ID участников выбранных потоков для медиа-пайплайна.
(строка)
ExternalUserIds -> (список)
Внешние идентификаторы пользователей выбранных потоков для медиа-пайплайна.
(строка)
ArtifactsConfiguration -> (структура)
Настройки артефактов в заседании Amazon Chime SDK.
Audio -> (структура)
Настройки для аудио артефактов.
MuxType -> (строка)
Video -> (структура)
Настройки для видео артефактов.
State -> (строка)
MuxType -> (строка)
Content -> (структура)
Настройки для контент артефактов.
State -> (строка)
MuxType -> (строка)
CompositedVideo -> (структура)
Включает композицию видео.
Layout -> (строка)
GridView в конфигурационном объекте.Resolution -> (строка)
GridViewConfiguration -> (структура)
Настройка GridView.
ContentShareLayout -> (строка)
PresenterOnlyConfiguration -> (структура)
Определяет параметры конфигурации для видеоплитки только для ведущего.
PresenterPosition -> (строка)
TopRight .ActiveSpeakerOnlyConfiguration -> (структура)
Настройки конфигурации для видеоплитки только активного спикера.
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, чем текущая учетная запись 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 .
© Copyright 2025, Amazon Web Services. Created using Sphinx.