Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint-email ]

create-email-identity

Описание

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

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

При проверке домена данная операция предоставляет набор токенов DKIM, которые можно преобразовать в токены CNAME. Эти токены CNAME добавляются в конфигурацию DNS вашего домена. Ваш домен проверяется, когда Amazon Pinpoint обнаруживает эти записи в конфигурации DNS вашего домена. Процесс проверки домена обычно занимает около 72 часов.

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

Синтаксис

  create-email-identity
--email-identity <value>
[--tags <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 (строка)

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

--tags (список)

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

(структура)

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

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

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

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

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

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

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

Сокращенный синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Вывод

IdentityType -> (строка)

Тип идентификатора электронной почты.

VerifiedForSendingStatus -> (булево)

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

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 вашего домена.

(строка)

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

Spec-Zone.ru

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