Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

list-domain-deliverability-campaigns

Описание

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

См. также: Документацию 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 (отметка времени)

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

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

Последний день, в формате Unix time, для которого вы хотите получить данные о доставке. Это значение должно быть меньше или равно 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
  • текст
  • таблица
  • 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.

Вывод

DomainDeliverabilityCampaigns -> (список)

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

(структура)

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

CampaignId -> (строка)

Уникальный идентификатор кампании. Amazon Pinpoint автоматически генерирует и назначает этот идентификатор кампании. Это значение не такое же, как идентификатор кампании, который Amazon Pinpoint назначает кампаниям, которые вы создаёте и управляете с помощью API Amazon Pinpoint или консоли Amazon Pinpoint.

ImageUrl -> (строка)

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

Subject -> (строка)

Тема или заголовок письма.

FromAddress -> (строка)

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

SendingIps -> (список)

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

(строка)

Выделенный IP-адрес, связанный с вашей учётной записью Amazon Pinpoint.

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

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

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

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

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

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

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

Количество писем, доставленных в папки спама или нежелательной почты получателей.

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

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

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

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

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

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

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

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

Esps -> (список)

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

(строка)

NextToken -> (строка)

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

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

Spec-Zone.ru

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