[ aws . pinpoint-email ]
get-email-identity
Описание
Предоставляет информацию о конкретном идентификаторе, связанном с вашей учетной записью Amazon Pinpoint, включая статус проверки идентификатора, статус аутентификации DKIM и настройки пользовательских параметров Mail-From.
См. также: Документация API AWS
Синтаксис
get-email-identity
--email-identity <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]
Параметры
--email-identity (строка)
--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.
Вывод
IdentityType -> (строка)
FeedbackForwardingStatus -> (логическое значение)
Настройка переадресации отзывов для идентификатора.
Если значение равно true, Amazon Pinpoint отправляет вам уведомления по электронной почте при возникновении событий отказа или жалобы. Amazon Pinpoint отправляет это уведомление на адрес, указанный в заголовке Return-Path исходного электронного письма.
При установке этого значения в false Amazon Pinpoint отправляет уведомления через другие механизмы, такие как уведомление темы Amazon SNS или другого пункта назначения событий. Вам необходимо иметь способ отслеживания отказов и жалоб. Если вы не настроили другой механизм для получения уведомлений об отказах или жалобах, Amazon Pinpoint отправляет уведомление по электронной почте при возникновении этих событий (даже если эта настройка отключена).
VerifiedForSendingStatus -> (логическое значение)
DkimAttributes -> (структура)
Объект, содержащий информацию об атрибутах DKIM для идентификатора. Этот объект включает токены, которые вы используете для создания записей CNAME, необходимых для завершения процесса проверки DKIM.
SigningEnabled -> (логическое значение)
true, то сообщения, отправляемые Amazon Pinpoint от идентификатора, подписываются DKIM. Если значение равно false, то сообщения, отправляемые Amazon Pinpoint от идентификатора, не подписываются DKIM.Status -> (строка)
Описывает, успешно ли Amazon Pinpoint обнаружил записи DKIM в записях DNS для домена. Статус может быть одним из следующих:
-
PENDING– Amazon Pinpoint еще не обнаружил записи DKIM в конфигурации DNS для домена, но продолжит попытки их найти. -
SUCCESS– Amazon Pinpoint обнаружил записи DKIM в конфигурации DNS для домена и определил, что они корректны. Amazon Pinpoint теперь может отправлять электронные письма, подписанные DKIM, от идентификатора. -
FAILED– Amazon Pinpoint не смог найти записи DKIM в настройках DNS для домена и больше не будет их искать. -
TEMPORARY_FAILURE– Возникла временная проблема, которая помешала Amazon Pinpoint определить статус DKIM для домена. -
NOT_STARTED– Amazon Pinpoint еще не начал поиск записей DKIM в записях DKIM для домена.
Tokens -> (список)
Набор уникальных строк, которые вы используете для создания набора записей CNAME, которые вы добавляете в конфигурацию DNS для своего домена. Когда Amazon Pinpoint обнаруживает эти записи в конфигурации DNS для вашего домена, процесс аутентификации DKIM завершен. Amazon Pinpoint обычно обнаруживает эти записи в течение примерно 72 часов после их добавления в конфигурацию DNS вашего домена.
(строка)
MailFromAttributes -> (структура)
Объект, содержащий информацию об атрибутах Mail-From для идентификатора электронной почты.
MailFromDomain -> (строка)
MailFromDomainStatus -> (строка)
Статус домена MAIL FROM. Этот статус может иметь следующие значения:
-
PENDING– Amazon Pinpoint еще не начал поиск записи MX. -
SUCCESS– Amazon Pinpoint обнаружил необходимую запись MX для домена MAIL FROM. -
FAILED– Amazon Pinpoint не может найти необходимую запись MX или запись больше не существует. -
TEMPORARY_FAILURE– Возникла временная проблема, которая помешала Amazon Pinpoint определить статус домена MAIL FROM.
BehaviorOnMxFailure -> (строка)
Действие, которое Amazon Pinpoint выполняет, если не может прочитать необходимую запись MX для пользовательского домена MAIL FROM. При установке этого значения в UseDefaultValue Amazon Pinpoint использует amazonses.com в качестве домена MAIL FROM. При установке этого значения в RejectMessage Amazon Pinpoint возвращает ошибку MailFromDomainNotVerified и не пытается доставить электронное письмо.
Эти действия выполняются, когда настройка пользовательского домена MAIL FROM находится в состояниях Pending, Failed и TemporaryFailure.
Tags -> (список)
Массив объектов, определяющих теги (ключи и значения), связанные с идентификатором электронной почты.
(структура)
Объект, определяющий теги, связанные с ресурсом. Тег — это метка, которую вы необязательно определяете и связываете с ресурсом в Amazon Pinpoint. Теги могут помочь вам классифицировать и управлять ресурсами различными способами, например, по назначению, владельцу, среде или другим критериям. Ресурс может иметь до 50 тегов.
Каждый тег состоит из обязательного ключа тега и связанного значения тега, оба из которых вы определяете. Ключ тега — это общая метка, которая служит категорией для более конкретного значения тега. Значение тега служит описателем в рамках ключа тега. Ключ тега может содержать до 128 символов. Значение тега может содержать до 256 символов. Символы могут быть буквами, цифрами, пробелами Unicode или одним из следующих символов: _ . : / = + -. К тегам применяются следующие дополнительные ограничения:
- Ключи и значения тегов чувствительны к регистру.
- Для каждого связанного ресурса каждый ключ тега должен быть уникальным и может иметь только одно значение.
- Префикс
aws:зарезервирован для использования AWS; вы не можете использовать его в ключах или значениях тегов, которые вы определяете. Кроме того, вы не можете редактировать или удалять ключи или значения тегов, использующие этот префикс. Теги, использующие этот префикс, не учитываются в лимите в 50 тегов на ресурс. - Вы можете связать теги с общедоступными или общими ресурсами, но теги доступны только для вашей учетной записи AWS, а не для других учетных записей, которые делят ресурс. Кроме того, теги доступны только для ресурсов, которые находятся в указанном регионе AWS для вашей учетной записи AWS.
Key -> (строка)
Value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.