[ aws . ivs-realtime ]
создание-токен-участника
Описание
Создает дополнительный токен для указанной стадии. Это можно сделать после создания стадии или при истечении срока действия токенов. Токены всегда привязаны к стадии, для которой они созданы.
Ключи шифрования принадлежат Amazon IVS и никогда не используются напрямую вашим приложением.
См. также: Документацию API AWS
Синтаксис
create-participant-token
--stage-arn <value>
[--duration <value>]
[--user-id <value>]
[--attributes <value>]
[--capabilities <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]
Параметры
--stage-arn (строка)
--duration (целое число)
--user-id (строка)
--attributes (словарь)
Атрибуты, предоставляемые приложением, для кодирования в токен и привязки к стадии. Ключи и значения словаря могут содержать текст в кодировке UTF-8. Максимальная длина этого поля составляет 1 КБ в общей сложности. Это поле доступно для всех участников стадии и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--capabilities (список)
Набор возможностей, которые пользователю разрешено выполнять на стадии. По умолчанию: PUBLISH, SUBSCRIBE .
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
PUBLISH
SUBSCRIBE
--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-auto-prompt (булево)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода командной строки.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования типа Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной программы. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для создания токена участника стадии
Следующий create-participant-token пример создает токен участника для указанной стадии.
aws ivs-realtime create-participant-token \
--stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
--user-id bob
Вывод:
{
"participantToken": {
"expirationTime": "2023-03-07T09:47:43+00:00",
"participantId": "ABCDEfghij01234KLMN6789",
"token": "abcd1234defg5678"
}
}
Дополнительную информацию см. в разделе Включение нескольких хостов в потоке Amazon IVS в Руководстве пользователя Amazon Interactive Video Service.
Вывод
токенУчастника -> (структура)
Созданный токен участника.
idУчастника -> (строка)
токен -> (строка)
idПользователя -> (строка)
атрибуты -> (словарь)
Атрибуты, предоставляемые приложением, для кодирования в токен и привязки к стадии. Это поле доступно для всех участников стадии и не должно использоваться для идентификации личности, конфиденциальной или чувствительной информации.
ключ -> (строка)
значение -> (строка)
срокДействия -> (целое число)
возможности -> (список)
Набор возможностей, которые пользователю разрешено выполнять на стадии.
(строка)
времяИстечения -> (меткаВремени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.