[ aws . chime-sdk-messaging ]
получение-сообщения-канала
Описание
Получает полные данные сообщения канала.
Примечание
Заголовок запросаx-amz-chime-bearer является обязательным. Используйте ARN AppInstanceUser или AppInstanceBot, выполняющего API-вызов, в качестве значения в заголовке.См. также: AWS API Documentation
Синтаксис
get-channel-message
--channel-arn <value>
--message-id <value>
--chime-bearer <value>
[--sub-channel-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]
Параметры
--channel-arn (строка)
--message-id (строка)
--chime-bearer (строка)
AppInstanceUser или AppInstanceBot, выполняющего API-вызов.--sub-channel-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
- текст
- таблица
- 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 для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода cli.
--no-cli-auto-prompt (булево)
Отключить автоматическую запрос параметров ввода cli.
Вывод
ChannelMessage -> (структура)
Подробности и содержимое сообщения.
ChannelArn -> (строка)
MessageId -> (строка)
Content -> (строка)
Metadata -> (строка)
Type -> (строка)
CreatedTimestamp -> (отметка времени)
LastEditedTimestamp -> (отметка времени)
LastUpdatedTimestamp -> (отметка времени)
Sender -> (структура)
Отправитель сообщения.
Arn -> (строка)
Name -> (строка)
Redacted -> (булево)
Persistence -> (строка)
Status -> (структура)
Статус сообщения канала.
Value -> (строка)
Detail -> (строка)
MessageAttributes -> (карта)
Атрибуты сообщения канала. Для ответов бота Amazon Lex V2 атрибуты отображаются в определенных полях бота. Дополнительную информацию см. в разделе Обработка ответов от AppInstanceBot в Руководстве разработчика Amazon Chime SDK Messaging.
key -> (строка)
value -> (структура)
Список значений атрибутов сообщения.
StringValues -> (список)
Строки в значении атрибута сообщения.
(строка)
SubChannelId -> (строка)
ContentType -> (строка)
application/amz-chime-lex-msgs для успешных ответов и application/amz-chime-lex-error для ответов с ошибками. Дополнительную информацию см. в разделе Обработка ответов от AppInstanceBot в Руководстве разработчика Amazon Chime SDK Messaging.Target -> (список)
Целевая аудитория сообщения - отправитель, пользователь или бот. Только целевая аудитория и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут видеть целевые сообщения, могут выполнять действия с ними. Однако администраторы могут удалять целевые сообщения, которые они не могут видеть.
(структура)
Целевая аудитория сообщения - отправитель, пользователь или бот. Только целевая аудитория и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут видеть целевые сообщения, могут выполнять действия с ними. Однако администраторы могут удалять целевые сообщения, которые они не могут видеть.
MemberArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|