Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

получение-данных-о-сообщениях

Описание

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

Вы можете выполнить эту операцию не более одного раза в секунду.

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

Синтаксис

  get-message-insights
--message-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]

Параметры

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

Уникальный идентификатор сообщения, возвращаемый при отправке писем через Amazon SES.

--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.

Вывод

ИдентификаторСообщения -> (строка)

Уникальный идентификатор сообщения.

АдресОтправителя -> (строка)

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

Тема -> (строка)

Тема сообщения.

МеткиЭлектроннойПочты -> (список)

Список меток в виде пар имя/значение, которые были применены к отправленному вами электронному сообщению, а также автоматические метки Amazon SES.

(структура)

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

Имя -> (строка)

Имя метки сообщения. Имя метки сообщения должно соответствовать следующим критериям:

  • Может содержать только ASCII-буквы (a–z, A–Z), цифры (0–9), подчеркивания (_) или дефисы (-).
  • Не может содержать более 256 символов.

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

Значение метки сообщения. Значение метки сообщения должно соответствовать следующим критериям:

  • Может содержать только ASCII-буквы (a–z, A–Z), цифры (0–9), подчеркивания (_) или дефисы (-).
  • Не может содержать более 256 символов.

Данные -> (список)

Набор данных, связанных с сообщением.

(структура)

Данные электронной почты содержат метаданные и информацию о доставке конкретного электронного письма.

Получатель -> (строка)

Получатель электронного письма.

ISP -> (строка)

ISP получателя (например, Gmail, Yahoo и т. д.).

События -> (список)

Список событий, связанных с отправленным электронным письмом.

(структура)

Объект, содержащий подробности о конкретном событии.

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

Отметка времени события.

Тип -> (строка)

Тип события:

  • SEND - Запрос на отправку был успешным, и SES попытается доставить сообщение на почтовый сервер получателя. (Если используется подавление на уровне учетной записи или глобальное подавление, SES всё ещё будет считать это отправкой, но доставка будет подавлена.)
  • DELIVERY - SES успешно доставил электронное письмо на почтовый сервер получателя. Не включает доставку в симуляторе почтового ящика и те, которые адресованы более чем одному получателю.
  • BOUNCE - Обратная связь о неудачах доставки. Дополнительные сведения о возврате предоставлены в объекте Details. Не включает возвраты из симулятора почтового ящика и те, которые адресованы более чем одному получателю.
  • COMPLAINT - Получена жалоба на электронное письмо. Дополнительные сведения о жалобе предоставлены в объекте Details. Не включает жалобы из симулятора почтового ящика, из вашего списка подавления на уровне учетной записи (если он включен) и те, которые адресованы более чем одному получателю.
  • OPEN - Событие открытия для электронных писем, включающих трекеры открытия. Не включает открытия для электронных писем, адресованных более чем одному получателю.
  • CLICK - Событие щелчка для электронных писем, включающих связанные ссылки. Не включает щелчки для электронных писем, адресованных более чем одному получателю.

Подробности -> (структура)

Подробности о событиях возврата или жалобы.

Возврат -> (структура)

Информация об событии возврата.

ТипВозврата -> (строка)

Тип возврата, определяемый SES. Может быть одним из UNDETERMINED, TRANSIENT или PERMANENT

ПодтипВозврата -> (строка)

Подтип возврата, определяемый SES.

КодДиагностики -> (строка)

Код состояния, выданный отчитывающейся организацией передачи сообщений (MTA). Это поле появляется только в том случае, если уведомление о состоянии доставки (DSN) было прикреплено к возврату и Diagnostic-Code был предоставлен в DSN.

Жалоба -> (структура)

Информация о событии жалобы.

ПодтипЖалобы -> (строка)

Может быть null или OnAccountSuppressionList. Если значение OnAccountSuppressionList, SES принял сообщение, но не пытался его отправить, поскольку оно было в списке подавления на уровне учетной записи.

ТипОбратнойСвязиЖалобы -> (строка)

Значение поля Feedback-Type из отчета об обратной связи, полученного от ISP.

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

Spec-Zone.ru

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