Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

получение_отчета_о_тесте_доставки

Описание

Получение результатов прогнозируемого теста размещения в папке «Входящие».

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

Синтаксис

  get-deliverability-test-report
--report-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]

Параметры

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

Вывод

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

Объект, содержащий результаты прогнозируемого теста размещения в папке «Входящие».

ReportId -> (строка)

Уникальная строка, идентифицирующая прогнозируемый тест размещения в папке «Входящие».

ReportName -> (строка)

Имя, помогающее идентифицировать отчет о прогнозируемом тесте размещения в папке «Входящие».

Subject -> (строка)

Тема письма, которое вы отправили в прогнозируемом тесте размещения в папке «Входящие».

FromEmailAddress -> (строка)

Адрес отправителя, указанный вами для прогнозируемого теста размещения в папке «Входящие».

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

Дата и время создания прогнозируемого теста размещения в папке «Входящие».

DeliverabilityTestStatus -> (строка)

Статус прогнозируемого теста размещения в папке «Входящие». Если статус IN_PROGRESS, то прогнозируемый тест размещения в папке «Входящие» в настоящее время выполняется. Прогнозируемые тесты размещения в папке «Входящие» обычно завершаются в течение 24 часов после создания теста. Если статус COMPLETE, тест завершен, и вы можете использовать GetDeliverabilityTestReport для просмотра результатов теста.

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

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

InboxPercentage -> (двойное)

Процент электронных писем, которые поступили в папки «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

SpamPercentage -> (двойное)

Процент электронных писем, которые поступили в папки «Спам» или «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

MissingPercentage -> (двойное)

Процент электронных писем, которые вообще не поступили в папки «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

SpfPercentage -> (двойное)

Процент электронных писем, которые были проверены с использованием Sender Policy Framework (SPF) во время прогнозируемого теста размещения в папке «Входящие».

DkimPercentage -> (двойное)

Процент электронных писем, которые были проверены с использованием DomainKeys Identified Mail (DKIM) во время прогнозируемого теста размещения в папке «Входящие».

IspPlacements -> (список)

Объект, описывающий, как тестовое электронное письмо обрабатывалось несколькими поставщиками электронной почты, включая Gmail, Hotmail, Yahoo, AOL и другими.

(структура)

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

IspName -> (строка)

Имя поставщика электронной почты, к которому относятся данные о размещении в папке «Входящие».

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

Объект, содержащий метрики размещения в папке «Входящие» для определенного поставщика электронной почты.

InboxPercentage -> (двойное)

Процент электронных писем, которые поступили в папки «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

SpamPercentage -> (двойное)

Процент электронных писем, которые поступили в папки «Спам» или «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

MissingPercentage -> (двойное)

Процент электронных писем, которые вообще не поступили в папки «Входящие» получателей во время прогнозируемого теста размещения в папке «Входящие».

SpfPercentage -> (двойное)

Процент электронных писем, которые были проверены с использованием Sender Policy Framework (SPF) во время прогнозируемого теста размещения в папке «Входящие».

DkimPercentage -> (двойное)

Процент электронных писем, которые были проверены с использованием DomainKeys Identified Mail (DKIM) во время прогнозируемого теста размещения в папке «Входящие».

Message -> (строка)

Объект, содержащий сообщение, которое вы отправили при выполнении этого прогнозируемого теста размещения в папке «Входящие».

Tags -> (список)

Массив объектов, определяющих метки (ключи и значения), связанные с прогнозируемым тестом размещения в папке «Входящие».

(структура)

Объект, определяющий метки, связанные с ресурсом. Метка — это метка, которую вы необязательно определяете и связываете с ресурсом. Метки могут помочь вам категоризировать и управлять ресурсами различными способами, например, по назначению, владельцу, среде или другим критериям. Ресурс может иметь до 50 меток.

Каждая метка состоит из требуемого ключа метки и связанного с ним значения метки, оба из которых вы определяете. Ключ метки — это общая метка, которая действует как категория для более конкретного значения метки. Значение метки выступает в роли описателя в рамках ключа метки. Ключ метки может содержать до 128 символов. Значение метки может содержать до 256 символов. Символы могут быть буквами, цифрами, пробелами Unicode или одним из следующих символов: _ . : / = + -. Следующие дополнительные ограничения относятся к меткам:

  • Ключи и значения меток регистрозависимы.
  • Для каждого связанного ресурса каждый ключ метки должен быть уникальным и может иметь только одно значение.
  • Префикс aws: зарезервирован для использования Amazon Web Services; вы не можете использовать его в ключах или значениях меток, которые вы определяете. Кроме того, вы не можете редактировать или удалять ключи или значения меток, которые используют этот префикс. Метки, использующие этот префикс, не учитываются в пределе 50 меток на ресурс.
  • Вы можете связать метки с общедоступными или общими ресурсами, но метки доступны только для вашей учетной записи Amazon Web Services, а не для других учетных записей, которые используют этот ресурс. Кроме того, метки доступны только для ресурсов, которые находятся в указанном регионе Amazon Web Services для вашей учетной записи Amazon Web Services.

Key -> (строка)

Часть пары «ключ-значение», которая определяет метку. Максимальная длина ключа метки — 128 символов. Минимальная длина — 1 символ.

Value -> (строка)

Необязательная часть пары «ключ-значение», которая определяет метку. Максимальная длина значения метки — 256 символов. Минимальная длина — 0 символов. Если вы не хотите, чтобы у ресурса было определенное значение метки, не указывайте значение для этого параметра. Если вы не указываете значение, Amazon SES задает значение пустой строкой.

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

Spec-Zone.ru

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