Spec-Zone.ru › AWS CLI v2

[ aws . chime-sdk-messaging ]

list-channel-messages

Описание

Список всех сообщений в канале. Возвращает постраничный список ChannelMessages. По умолчанию, отсортировано по времени создания в порядке убывания.

Примечание

Заблокированные сообщения отображаются в результатах как пустые, так как они только заблокированы, а не удалены. Удаленные сообщения не отображаются в результатах. Этот действия всегда возвращает последнюю версию отредактированного сообщения.

Также заголовок запроса x-amz-chime-bearer является обязательным. Используйте ARN AppInstanceUser или AppInstanceBot, выполняющего API-вызов, в качестве значения в заголовке.

См. также: Документация AWS API

Синтаксис

  list-channel-messages
--channel-arn <value>
[--sort-order <value>]
[--not-before <value>]
[--not-after <value>]
[--max-results <value>]
[--next-token <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 (строка)

ARN канала.

--sort-order (строка)

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

Возможные значения:

  • ASCENDING
  • DESCENDING

--not-before (отметка времени)

Начальная отметка времени для запрошенных сообщений.

--not-after (отметка времени)

Конечная отметка времени для запрошенных сообщений.

--max-results (целое число)

Максимальное количество возвращаемых сообщений.

--next-token (строка)

Токен, переданный предыдущими API-вызовами, до тех пор, пока все запрошенные сообщения не будут возвращены.

--chime-bearer (строка)

ARN AppInstanceUser или AppInstanceBot, выполняющего API-вызов.

--sub-channel-id (строка)

Идентификатор SubChannel в запросе.

Примечание

Только требуется при перечислении сообщений в SubChannel, к которому принадлежит пользователь.

--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 (булево)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров CLI.

Вывод

ChannelArn -> (строка)

ARN канала, содержащего запрошенные сообщения.

NextToken -> (строка)

Токен, переданный предыдущими API-вызовами, до тех пор, пока все запрошенные сообщения не будут возвращены.

ChannelMessages -> (список)

Информация о каждом запрошенном сообщении и его содержание.

(структура)

Сводка сообщений в Channel.

MessageId -> (строка)

Идентификатор сообщения.

Content -> (строка)

Содержимое сообщения канала. Для ответов бота Amazon Lex V2 это поле содержит список сообщений, отправленных ботом. Для получения дополнительной информации обратитесь к Обработке ответов от AppInstanceBot в Руководстве разработчика Amazon Chime SDK Messaging.

Metadata -> (строка)

Метаданные сообщения.

Type -> (строка)

Тип сообщения.

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

Время создания сводки сообщения.

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

Время последнего обновления сообщения.

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

Время последнего редактирования сообщения.

Sender -> (структура)

Отправитель сообщения.

Arn -> (строка)

ARN в идентификаторе.

Name -> (строка)

Имя в идентификаторе.

Redacted -> (булево)

Указывает, было ли сообщение заблокировано.

Status -> (структура)

Статус сообщения. Значение статуса SENT для сообщений, отправленных в канал без потока канала. Для каналов, связанных с потоком канала, значение определяет этап обработки.

Value -> (строка)

Значение статуса сообщения.

Detail -> (строка)

Содержит более подробную информацию о статусе сообщения.

MessageAttributes -> (карта)

Атрибуты сообщения канала. Для ответов бота Amazon Lex V2 атрибуты отображаются в определенных полях бота. Для получения дополнительной информации обратитесь к Обработке ответов от AppInstanceBot в Руководстве разработчика Amazon Chime SDK Messaging.

key -> (строка)

value -> (структура)

Список значений атрибутов сообщения.

StringValues -> (список)

Строки в значении атрибута сообщения.

(строка)

ContentType -> (строка)

Тип содержимого сообщения канала, указанного в сводке. Для ответов бота Amazon Lex V2 тип содержимого равен application/amz-chime-lex-msgs для ответов об успехе и application/amz-chime-lex-error для ответов об ошибках. Для получения дополнительной информации обратитесь к Обработке ответов от AppInstanceBot в Руководстве разработчика Amazon Chime SDK Messaging.

Target -> (список)

Целевая аудитория сообщения, отправитель, пользователь или бот. Только целевая аудитория и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут просматривать целевые сообщения, могут выполнять действия над ними. Однако администраторы могут удалять целевые сообщения, которые они не могут видеть.

(структура)

Целевая аудитория сообщения, отправитель, пользователь или бот. Только целевая аудитория и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут просматривать целевые сообщения, могут выполнять действия над ними. Однако администраторы могут удалять целевые сообщения, которые они не могут видеть.

MemberArn -> (строка)

ARN целевого участника канала.

SubChannelId -> (строка)

Идентификатор SubChannel в ответе.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API