Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

получить-данные-доставки-кампании

Описание

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

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

Синтаксис

  get-domain-deliverability-campaign
--campaign-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]

Параметры

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

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

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

Вывод

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

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

CampaignId -> (строка)

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

ImageUrl -> (строка)

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

Subject -> (строка)

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

FromAddress -> (строка)

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

SendingIps -> (список)

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

(строка)

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

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

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

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

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

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

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

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

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

ReadRate -> (дробное число)

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

DeleteRate -> (дробное число)

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

ReadDeleteRate -> (дробное число)

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

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

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

Esps -> (список)

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

(строка)

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

Spec-Zone.ru

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