Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

list-domain-deliverability-campaigns

Описание

Получение данных о доставке для всех кампаний, которые использовали определённый домен для отправки электронных писем в указанный период времени. Эти данные доступны для домена только если вы включили панель управления Доставкой для этого домена.

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

Синтаксис

  list-domain-deliverability-campaigns
--start-date <value>
--end-date <value>
--subscribed-domain <value>
[--next-token <value>]
[--page-size <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]

Параметры

--start-date (отметка времени)

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

--end-date (отметка времени)

Последний день, для которого необходимо получить данные о доставке. Это значение должно быть меньше или равно 30 дням после значения параметра StartDate.

--subscribed-domain (строка)

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

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

Токен, возвращаемый по результатам предыдущего вызова операции ListDomainDeliverabilityCampaigns. Этот токен указывает позицию кампании в списке кампаний.

--page-size (целое число)

Максимальное количество результатов, которые должны быть включены в ответ на один вызов операции ListDomainDeliverabilityCampaigns. Если количество результатов больше, чем указанное в этом параметре, ответ включает элемент NextToken, который можно использовать для получения дополнительных результатов.

--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
  • таблица
  • 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.

Вывод

DomainDeliverabilityCampaigns -> (список)

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

(структура)

Объект, содержащий данные о доставке для конкретной кампании. Эти данные доступны для кампании только если кампания отправила электронные письма, используя домен, для которого включена панель управления Доставкой (операция PutDeliverabilityDashboardOption).

CampaignId -> (строка)

Уникальный идентификатор кампании. Панель управления Доставкой автоматически генерирует и назначает этот идентификатор кампании.

ImageUrl -> (строка)

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

Subject -> (строка)

Тема или заголовок электронного письма.

FromAddress -> (строка)

Верифицированный адрес электронной почты, с которого было отправлено электронное письмо.

SendingIps -> (список)

IP-адреса, которые использовались для отправки электронного письма.

(строка)

IPv4-адрес.

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

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

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

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

InboxCount -> (длинное целое число)

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

SpamCount -> (длинное целое число)

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

ReadRate -> (двойное число)

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

DeleteRate -> (двойное число)

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

ReadDeleteRate -> (двойное число)

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

ProjectedVolume -> (длинное целое число)

Прогнозируемое количество получателей, которым было отправлено электронное письмо.

Esps -> (список)

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

(строка)

NextToken -> (строка)

Токен, возвращаемый по результатам предыдущего вызова операции ListDomainDeliverabilityCampaigns. Этот токен указывает позицию кампании в списке кампаний.

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

Spec-Zone.ru

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