получение-данных-об-идентификаторе-электронной-почты

Описание

Предоставляет информацию о конкретном идентификаторе, включая статус проверки идентификатора, политики отправки, статус проверки DKIM, а также пользовательские настройки Mail-From.

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

Синтаксис

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

Output

IdentityType -> (string)

Тип идентификатора электронной почты. Примечание: тип идентификатора MANAGED_DOMAIN не поддерживается.

FeedbackForwardingStatus -> (boolean)

Настройка пересылки обратной связи для идентификатора.

Если значение true, вы будете получать уведомления по электронной почте при возникновении событий возврата или жалобы. Эти уведомления отправляются по адресу, указанному в заголовке Return-Path исходного письма.

Вы должны иметь метод отслеживания возвратов и жалоб. Если вы не настроили другой механизм получения уведомлений о возвратах или жалобах (например, настроив пункт назначения событий), вы будете получать уведомления по электронной почте при возникновении этих событий (даже если эта настройка отключена).

VerifiedForSendingStatus -> (boolean)

Указывает, подтвержден ли идентификатор. Вы можете отправлять электронные письма только с подтвержденных адресов электронной почты или доменов. Для получения дополнительной информации о подтверждении идентификаторов см. Руководство пользователя Amazon Pinpoint .

DkimAttributes -> (structure)

Объект, содержащий информацию об атрибутах DKIM для идентификатора.

SigningEnabled -> (boolean)

Если значение равно true, то сообщения, которые вы отправляете с идентификатора, подписываются с использованием DKIM. Если значение равно false, то сообщения, которые вы отправляете с идентификатора, не подписываются DKIM.

Status -> (string)

Описывает, успешно ли Amazon SES нашел записи DKIM в записях DNS для домена. Статус может быть одним из следующих:

PENDING – Процесс проверки был инициирован, но Amazon SES еще не обнаружил записи DKIM в конфигурации DNS для домена.
SUCCESS – Процесс проверки завершился успешно.
FAILED – Процесс проверки завершился неудачно. Обычно это происходит, когда Amazon SES не удается найти записи DKIM в конфигурации DNS домена.
TEMPORARY_FAILURE – Временная проблема не позволяет Amazon SES определить состояние аутентификации DKIM домена.
NOT_STARTED – Процесс проверки DKIM не был инициирован для домена.

Tokens -> (list)

Если вы использовали Easy DKIM для настройки аутентификации DKIM для домена, то этот объект содержит набор уникальных строк, которые вы используете для создания набора записей CNAME, которые вы добавляете в конфигурацию DNS для своего домена. Когда Amazon SES обнаруживает эти записи в конфигурации DNS для вашего домена, процесс аутентификации DKIM завершен.

Если вы настроили аутентификацию DKIM для домена, предоставив собственную пару открытого и закрытого ключей, то этот объект содержит селектор для открытого ключа.

Независимо от того, какой метод аутентификации DKIM вы используете, Amazon SES ищет соответствующие записи в конфигурации DNS домена в течение 72 часов.

(string)

SigningAttributesOrigin -> (string)

Строка, указывающая, как DKIM был настроен для идентификатора. Возможны следующие значения:

AWS_SES – Указывает, что DKIM был настроен для идентификатора с использованием Easy DKIM.
EXTERNAL – Указывает, что DKIM был настроен для идентификатора с использованием Bring Your Own DKIM (BYODKIM).
AWS_SES_AF_SOUTH_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Африки (Кейптаун) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_NORTH_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Стокгольм) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_SOUTH_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Мумбаи) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_WEST_3 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Париж) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_WEST_2 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Лондон) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_SOUTH_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Милан) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_WEST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Ирландия) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_NORTHEAST_3 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Осака) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_NORTHEAST_2 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Сеул) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_ME_SOUTH_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Ближнего Востока (Бахрейн) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_NORTHEAST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Токио) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_IL_CENTRAL_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Израиль (Тель-Авив) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_SA_EAST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Южной Америки (Сан-Паулу) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_CA_CENTRAL_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Канада (Центральная) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_SOUTHEAST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Сингапур) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_SOUTHEAST_2 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Сидней) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_AP_SOUTHEAST_3 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Азиатско-Тихоокеанского региона (Джакарта) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_EU_CENTRAL_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Европы (Франкфурт) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_US_EAST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Восток США (Северная Вирджиния) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_US_EAST_2 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Восток США (Огайо) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_US_WEST_1 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Запад США (Северная Калифорния) с использованием Deterministic Easy-DKIM (DEED).
AWS_SES_US_WEST_2 – Указывает, что DKIM был настроен для идентификатора путем репликации атрибутов подписи из родительского идентификатора в регионе Запад США (Орегон) с использованием Deterministic Easy-DKIM (DEED).

NextSigningKeyLength -> (string)

[Easy DKIM] Длина ключа будущей пары ключей DKIM для генерации. Это можно изменить не более одного раза в день.

CurrentSigningKeyLength -> (string)

[Easy DKIM] Длина ключа используемой пары ключей DKIM.

LastKeyGenerationTimestamp -> (timestamp)

[Easy DKIM] Последнее время, когда была сгенерирована пара ключей для этого идентификатора.

MailFromAttributes -> (structure)

Объект, содержащий информацию об атрибутах Mail-From для идентификатора электронной почты.

MailFromDomain -> (string)

Имя домена, который идентификатор электронной почты использует в качестве пользовательского домена MAIL FROM.

MailFromDomainStatus -> (string)

Состояние домена MAIL FROM. Этот статус может иметь следующие значения:

PENDING – Amazon SES еще не начал поиск записи MX.
SUCCESS – Amazon SES обнаружил необходимую запись MX для домена MAIL FROM.
FAILED – Amazon SES не может найти необходимую запись MX, или запись больше не существует.
TEMPORARY_FAILURE – Возникла временная проблема, которая помешала Amazon SES определить состояние домена MAIL FROM.

BehaviorOnMxFailure -> (string)

Действие, которое необходимо предпринять, если требуемая запись MX не может быть найдена при отправке электронного письма. Когда вы устанавливаете это значение в USE_DEFAULT_VALUE, почта отправляется с использованием amazonses.com в качестве домена MAIL FROM. Когда вы устанавливаете это значение в REJECT_MESSAGE, API v2 Amazon SES возвращает ошибку MailFromDomainNotVerified и не пытается доставить электронное письмо.

Эти поведения принимаются, когда пользовательская конфигурация домена MAIL FROM находится в состояниях Pending, Failed и TemporaryFailure.

Policies -> (map)

Карта имен политик к политикам.

key -> (string)

Имя политики.

Имя политики не может превышать 64 символа и может содержать только буквенно-цифровые символы, дефисы и подчеркивания.

value -> (string)

Текст политики в формате JSON. Политика не может превышать 4 КБ.

Информацию о синтаксисе политик авторизации отправки см. в Руководстве разработчика Amazon SES.

Tags -> (list)

Массив объектов, определяющих теги (ключи и значения), связанные с идентификатором электронной почты.

(структура)

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

Каждый тег состоит из обязательного ключа тега и соответствующего значения тега, которые вы определяете. Ключ тега — это общая метка, служащая категорией для более конкретного значения тега. Значение тега выступает в качестве описателя внутри ключа тега. Ключ тега может содержать до 128 символов. Значение тега может содержать до 256 символов. Символы могут быть символами Unicode, цифрами, пробелами или одним из следующих символов: _ . : / = + -. К тегам применяются следующие дополнительные ограничения:

Ключи и значения тегов чувствительны к регистру.
Для каждого связанного ресурса каждый ключ тега должен быть уникальным и иметь только одно значение.
Префикс aws: зарезервирован для использования Amazon Web Services; вы не можете использовать его в ключах или значениях тегов, которые вы определяете. Кроме того, вы не можете редактировать или удалять ключи или значения тегов, использующие этот префикс. Теги, использующие этот префикс, не учитываются при подсчете лимита в 50 тегов на ресурс.
Вы можете связывать теги с общедоступными или совместными ресурсами, но теги доступны только для вашей учетной записи Amazon Web Services, а не для других учетных записей, которые используют этот ресурс. Кроме того, теги доступны только для ресурсов, расположенных в указанном регионе Amazon Web Services для вашей учетной записи Amazon Web Services.

Ключ -> (строка)

Одна часть пары «ключ-значение», определяющая тег. Максимальная длина ключа тега — 128 символов. Минимальная длина — 1 символ.

Значение -> (строка)

Необязательная часть пары «ключ-значение», определяющая тег. Максимальная длина значения тега — 256 символов. Минимальная длина — 0 символов. Если вы не хотите, чтобы у ресурса было определённое значение тега, не указывайте значение для этого параметра. Если вы не укажете значение, Amazon SES установит значение в пустую строку.

ConfigurationSetName -> (строка)

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

VerificationStatus -> (строка)

Статус проверки идентификатора. Статус может быть одним из следующих:

PENDING – Процесс проверки инициирован, но Amazon SES пока не смог проверить идентификатор.
SUCCESS – Проверка идентификатора успешно завершена.
FAILED – Процесс проверки завершился неудачей.
TEMPORARY_FAILURE – Временная проблема мешает Amazon SES определить статус проверки идентификатора.
NOT_STARTED – Процесс проверки для идентификатора ещё не начат.

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

Объект, содержащий дополнительную информацию о статусе проверки идентификатора.

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

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

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

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

ErrorType -> (строка)

Причина неудачи, описывающая, почему Amazon SES не смог успешно проверить идентификатор. Возможные значения:

INVALID_VALUE – Amazon SES нашел запись, но значение в ней было неверным. Убедитесь, что вы опубликовали правильные значения для записи.
TYPE_NOT_FOUND – Запрошенный хост существует, но не имеет требуемого типа записи DNS. Убедитесь, что вы опубликовали правильный тип записи DNS.
HOST_NOT_FOUND – Запрошенный хост не существует или не был доступен в момент запроса. Убедитесь, что вы опубликовали необходимые записи DNS.
SERVICE_ERROR – Временная проблема мешает Amazon SES определить статус проверки домена.
DNS_SERVER_ERROR – Сервер DNS столкнулся с проблемой и не смог выполнить запрос.
REPLICATION_ACCESS_DENIED – Проверка не удалась, так как у пользователя недостаточно прав для репликации ключа DKIM из основного региона. Убедитесь, что у вас есть необходимые права как в основном, так и в реплицированном регионах.
REPLICATION_PRIMARY_NOT_FOUND – Проверка не удалась, так как соответствующий идентификатор не был найден в указанном основном регионе. Убедитесь, что идентификатор существует в основном регионе, прежде чем пытаться выполнить репликацию.
REPLICATION_PRIMARY_BYO_DKIM_NOT_SUPPORTED – Проверка не удалась, так как идентификатор в основном регионе настроен с использованием BYODKIM. Репликация ключей DKIM поддерживается только для идентификаторов, использующих Easy DKIM.
REPLICATION_REPLICA_AS_PRIMARY_NOT_SUPPORTED – Проверка не удалась, так как указанный основной идентификатор является репликой другого идентификатора, а многоуровневая репликация не поддерживается; основной идентификатор должен быть не репликой.
REPLICATION_PRIMARY_INVALID_REGION – Проверка не удалась из-за неверного указанного основного региона. Убедитесь, что вы указали допустимый регион Amazon Web Services, в котором доступен Amazon SES, и он отличается от региона репликации.

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

Объект, содержащий информацию о записи начала авторитета (SOA), связанной с идентификатором.

PrimaryNameServer -> (строка)

Указанный в записи SOA первичный сервер имен.

AdminEmail -> (строка)

Адрес электронной почты администратора из записи SOA.

SerialNumber -> (целое число)

Серийный номер из записи SOA.