Spec-Zone.ru › AWS CLI v2

[ aws . mailmanager ]

get-archive-search-results

Описание

Возвращает результаты завершённого задания поиска в архиве электронной почты.

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

Синтаксис

  get-archive-search-results
--search-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]

Параметры

--search-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
  • text
  • table
  • yaml
  • yaml-stream

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

Вывод

Строки -> (список)

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

(структура)

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

ArchivedMessageId -> (строка)

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

Cc -> (строка)

Электронные адреса в поле CC.

Дата -> (строка)

Дата отправки письма.

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

Информация о конверте SMTP для письма.

От -> (строка)

RCPT FROM, указанный хостом, с которого было получено письмо.

Helo -> (строка)

HELO, используемый хостом, с которого было получено письмо.

Кому -> (список)

Все записи SMTP TO, указанные хостом, с которого было получено письмо.

(строка)

От -> (строка)

Адрес электронной почты отправителя.

ЕстьВложения -> (булево)

Флаг, указывающий, содержит ли письмо вложения.

ВОтвЕтНа -> (строка)

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

IngressPointId -> (строка)

Идентификатор точки входа, через которую было получено письмо.

MessageId -> (строка)

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

ReceivedHeaders -> (список)

Заголовки приема из пути доставки письма.

(строка)

ReceivedTimestamp -> (временная метка)

Временная метка получения письма.

SenderHostname -> (строка)

Имя хоста, с которого было получено письмо.

SenderIpAddress -> (строка)

  • Почта заархивирована с помощью Mail Manager: IP-адрес клиента, подключившегося к точке входа.
  • Почта отправлена через набор конфигурации с включённым опцией архивирования: IP-адрес клиента, который выполнил вызов API SendEmail.

SourceArn -> (строка)

Указывает источник заархивированной электронной почты, идентифицируемый либо ARN набора правил с действием «Архивировать», либо ARN набора конфигурации «Архивировать».

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

Значение заголовка темы письма.

Кому -> (строка)

Электронные адреса в поле «Кому».

XMailer -> (строка)

Пользовательский агент, отправивший письмо.

XOriginalMailer -> (строка)

Оригинальный пользовательский агент, отправивший письмо.

XPriority -> (строка)

Уровень приоритета письма.

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

Spec-Zone.ru

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