Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

get-deliverability-dashboard-options

Описание

Получение информации о состоянии панели управления Доставкой для вашей учетной записи Amazon Pinpoint. При активации панели управления Доставкой вы получаете доступ к репутации, показателям доставки и другим метрикам для доменов, которые вы используете для отправки электронных писем с помощью Amazon Pinpoint. Вы также получаете возможность выполнять прогнозирующие тесты размещения в папке «Входящие».

При использовании панели управления Доставкой вы оплачиваете ежемесячную подписку, помимо любых других сборов, которые вы производите, используя Amazon Pinpoint. Более подробную информацию о функциях и стоимости подписки на панель управления Доставкой см. в документе Amazon Pinpoint Pricing.

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

Синтаксис

  get-deliverability-dashboard-options
[--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]

Параметры

--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 (строка)

Включение/отключение цветного вывода.

  • on
  • off
  • auto

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

Вывод

DashboardEnabled -> (булево)

Указывает, включена ли панель управления Доставкой для вашей учетной записи Amazon Pinpoint. Если это значение true, панель управления включена.

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

Дата в формате времени Unix, когда запланировано истечение вашей текущей подписки на панель управления Доставкой, если ваша подписка запланирована на конец текущего календарного месяца. Это значение равно null, если у вас активная подписка, которая не должна истечь в конце месяца.

AccountStatus -> (строка)

Текущее состояние вашей подписки на панель управления Доставкой. Если это значение PENDING_EXPIRATION, ваша подписка запланирована на истечение в конце текущего календарного месяца.

ActiveSubscribedDomains -> (список)

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

(структура)

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

Domain -> (строка)

Проверенный домен, связанный с вашей учетной записью AWS, который в настоящее время имеет активную подписку на панель управления Доставкой.

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

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

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

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

Global -> (булево)

Указывает, отслеживаются ли данные размещения в папке «Входящие» для домена.

TrackedIsps -> (список)

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

(строка)

Название поставщика электронной почты.

PendingExpirationSubscribedDomains -> (список)

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

(структура)

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

Domain -> (строка)

Проверенный домен, связанный с вашей учетной записью AWS, который в настоящее время имеет активную подписку на панель управления Доставкой.

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

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

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

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

Global -> (булево)

Указывает, отслеживаются ли данные размещения в папке «Входящие» для домена.

TrackedIsps -> (список)

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

(строка)

Название поставщика электронной почты.

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

Spec-Zone.ru

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