create-chat-token

Описание

Создаёт зашифрованный токен, который используется участником чата для установления индивидуального WebSocket-соединения с комнатой. Когда токен используется для подключения к чату, соединение действует в течение указанного в запросе периода сессии. Токен становится недействительным в момент времени истечения срока действия токена, указанном в ответе.

Используйте поле capabilities, чтобы разрешить конечному пользователю отправлять сообщения или модерировать комнату.

Поле attributes безопасно прикрепляет структурированные данные к сессии чата; данные включаются в каждое сообщение, отправленное конечным пользователем и полученное другими участниками комнаты. Общие варианты использования атрибутов включают передачу данных профиля конечного пользователя, таких как значок, имя для отображения, цвета, значки и другие отображаемые функции.

Ключи шифрования принадлежат Amazon IVS Chat и никогда не используются непосредственно вашим приложением.

См. также: AWS API Documentation

Синтаксис

  create-chat-token
--room-identifier <value>
--user-id <value>
[--capabilities <value>]
[--session-duration-in-minutes <value>]
[--attributes <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]

Параметры

--room-identifier (строка)

--user-id (строка)

--capabilities (список)

Синтаксис:

"string" "string" ...

Where valid values are:
  SEND_MESSAGE
  DISCONNECT_USER
  DELETE_MESSAGE

--session-duration-in-minutes (целое число)

--attributes (карта)

Краткая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 (логическое значение)

Включить отладку логов.

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

Файл сертификата корневого центра для проверки сертификатов 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.

Примеры

Создание токена чата

Следующий пример create-chat-token создаёт зашифрованный токен чата, который используется для установления индивидуального WebSocket-соединения с комнатой. Токен действителен в течение одной минуты, а соединение (сессия), установленное с помощью токена, действует в течение указанного периода.

aws ivschat create-chat-token \
    --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \
    --userId" "11231234" \
    --capabilities "SEND_MESSAGE", \
    --sessionDurationInMinutes" 30

Вывод:

{
    "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5",
    "sessionExpirationTime": "2022-03-16T04:44:09+00:00"
    "state": "CREATING",
    "tokenExpirationTime": "2022-03-16T03:45:09+00:00"
}

Для получения дополнительной информации, см. Шаг 3: Проверка подлинности и авторизация клиентов чата в руководстве пользователя Amazon Interactive Video Service.

Вывод

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

tokenExpirationTime -> (метка времени)

sessionExpirationTime -> (метка времени)