ivschat

Описание

API управления чатом Amazon IVS позволяет создавать и управлять ресурсами Amazon IVS Chat. Также необходимо интегрироваться с API обмена сообщениями Amazon IVS Chat, чтобы пользователи могли взаимодействовать с чатами в реальном времени.

API является региональной службой AWS. Список поддерживаемых регионов и HTTPS-служб Amazon IVS Chat см. в разделе Amazon IVS Chat на странице Amazon IVS в AWS General Reference.

В этом документе описаны HTTP-операции. Отдельный API обмена сообщениями предназначен для управления ресурсами чата; см. Справочник по API обмена сообщениями Amazon IVS Chat.

• Сервисные приложения создаются с помощью API Amazon IVS Chat. Мы будем называть их приложениями.
• Клиентские приложения для браузеров и приложений для Android/iOS создаются с помощью API обмена сообщениями Amazon IVS Chat. Мы будем называть их клиентами.

Следующие ресурсы являются частью Amazon IVS Chat:

• LoggingConfiguration — Конфигурация, позволяющая клиентам сохранять и записывать отправленные сообщения в чате. Дополнительную информацию см. в разделе Конечные точки конфигурации ведения журнала.
• Room — Центральный ресурс Amazon IVS Chat, через который клиенты подключаются и обмениваются сообщениями в чате. Дополнительную информацию см. в разделе Конечные точки комнаты.

Тег — это метка метаданных, которую вы назначаете ресурсу AWS. Тег состоит из ключа и значения, оба задаются вами. Например, вы можете использовать тег topic:nature для маркировки определённой категории видео. Подробную информацию, включая ограничения, которые применяются к тегам, и «Пределы и требования к именам тегов», см. в разделе «Рекомендации и стратегии по тегированию ресурсов Amazon Web Services и Редактор тегов» в AWS General Reference. Amazon IVS Chat не имеет ограничений, специфичных для сервиса, помимо тех, которые документированы там.

Теги могут помочь вам идентифицировать и организовать ваши ресурсы AWS. Например, вы можете использовать один и тот же тег для разных ресурсов, чтобы указать, что они связаны. Вы также можете использовать теги для управления доступом (см. Доступные теги).

API Amazon IVS Chat имеет следующие операции, связанные с тегами: TagResource, UntagResource и ListTagsForResource. Следующий ресурс поддерживает тегирование: Room.

К ресурсу можно применить не более 50 тегов.

Ваши приложения Amazon IVS Chat (сервисные приложения и клиенты) должны быть авторизованы и уполномочены для доступа к ресурсам Amazon IVS Chat. Обратите внимание на разницу между этими понятиями:

• Авторизация — это проверка подлинности. Запросы к API Amazon IVS Chat должны быть подписаны для проверки вашей подлинности.
• Разрешение — это предоставление разрешений. Вашим IAM-ролям необходимы разрешения для запросов к API Amazon IVS Chat.

Пользователи (зрители) подключаются к комнате с помощью безопасных токенов доступа, которые вы создаете с помощью операции CreateChatToken через AWS SDK. Вы вызываете CreateChatToken для каждой сессии чата пользователя, передавая информацию об идентификации и авторизации пользователя.

HTTP-запросы API должны быть подписаны с помощью подписи AWS SigV4 с использованием ваших учетных данных безопасности AWS. AWS CLI и AWS SDK выполняют подписание базовых API-вызовов за вас. Однако, если ваше приложение вызывает HTTP-API Amazon IVS Chat напрямую, вы сами несете ответственность за подписание запросов.

Вы генерируете подпись с использованием действительных учетных данных AWS для IAM-роли, имеющей разрешение на выполнение запрошенного действия. Например, запросы DeleteMessage должны выполняться с использованием IAM-роли, имеющей разрешение ivschat:DeleteMessage.

Дополнительную информацию см.:

• Авторизация и создание подписей — см. Авторизация запросов (Amazon Web Services Signature Version 4) в AWS General Reference.
• Управление разрешениями Amazon IVS — см. раздел «Идентификация и управление доступом» на странице «Безопасность» руководства пользователя Amazon IVS.

ARN уникально идентифицируют ресурсы AWS. ARN необходим, когда вам нужно однозначно указать ресурс во всей экосистеме AWS, например, в политиках IAM и API-вызовах. Дополнительную информацию см. в разделе Имена ресурсов Amazon (ARN) в AWS General Reference.

Доступные команды