Spec-Zone.ru › AWS CLI v2

[ aws . ses ]

send-bulk-templated-email

Описание

Составление сообщения электронной почты для нескольких получателей. Тело сообщения создается с использованием шаблона электронной почты.

Для отправки электронного письма с помощью этой операции ваш вызов должен соответствовать следующим требованиям:

  • Вызов должен ссылаться на существующий шаблон электронной почты. Вы можете создавать шаблоны электронной почты с помощью операции CreateTemplate.
  • Сообщение должно быть отправлено с проверенного адреса или домена электронной почты.
  • Если ваша учетная запись все еще находится в песочнице Amazon SES, вы можете отправлять только проверенным адресам или доменам, или адресам электронной почты, связанным с Amazon SES Mailbox Simulator. Дополнительную информацию см. в разделе Проверка адресов и доменов электронной почты в руководстве разработчика Amazon SES.
  • Максимальный размер сообщения составляет 10 МБ.
  • Каждый Destination параметр должен включать хотя бы один адрес электронной почты получателя. Адрес получателя может быть адресом «Кому:», «Копия:», или «Скрытая копия:». Если адрес электронной почты получателя некорректен (то есть он не имеет формат ИмяПользователя@[СубДомен.]Домен.ДоменВерхнегоУровня), все сообщение отклоняется, даже если сообщение содержит других получателей, которые действительны.
  • Сообщение не может включать более 50 получателей в полях «Кому:», «Копия:», и «Скрытая копия:». Если вам нужно отправить электронное письмо более широкой аудитории, вы можете разделить список получателей на группы по 50 или меньше человек, и затем несколько раз вызвать операцию SendBulkTemplatedEmail для отправки сообщения каждой группе.
  • Количество получателей, с которыми вы можете связаться в одном вызове, может быть ограничено максимальной скоростью отправки вашей учетной записи.

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

Синтаксис

  send-bulk-templated-email
--source <value>
[--source-arn <value>]
[--reply-to-addresses <value>]
[--return-path <value>]
[--return-path-arn <value>]
[--configuration-set-name <value>]
[--default-tags <value>]
--template <value>
[--template-arn <value>]
--default-template-data <value>
--destinations <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]

Параметры

--source (строка)

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

Если вы отправляете от имени другого пользователя и имеете разрешение согласно политике отправки, необходимо также указать параметр SourceArn. Дополнительную информацию об авторизации отправки см. в руководстве разработчика Amazon SES.

Примечание

Amazon SES не поддерживает расширение SMTPUTF8, как описано в RFC6531. По этой причине строка адреса электронной почты должна быть в формате 7-битного ASCII. Если вы хотите отправлять или получать электронные письма с адресами, содержащими символы Unicode в доменной части адреса, необходимо закодировать домен с помощью Punycode. Punycode не разрешен в локальной части адреса электронной почты (части перед знаком @) или в имени «дружественного отправителя». Если вы хотите использовать символы Unicode в имени «дружественного отправителя», необходимо закодировать имя «дружественного отправителя» с помощью синтаксиса MIME encoded-word, как описано в разделе Отправка необработанного электронного письма с помощью API Amazon SES. Дополнительную информацию о Punycode см. в RFC 3492.

--source-arn (строка)

Этот параметр используется только для авторизации отправки. Это ARN идентификатора, связанного с политикой авторизации отправки, которая разрешает вам отправлять от имени адреса электронной почты, указанного в параметре Source.

Например, если владелец example.com (с ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) прикрепит к нему политику, разрешающую вам отправлять от имени user@example.com, то вы укажете SourceArn как arn:aws:ses:us-east-1:123456789012:identity/example.com, а Source как user@example.com.

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

--reply-to-addresses (список)

Адрес(а) электронной почты для ответа на сообщение. Если получатель отвечает на сообщение, каждый адрес ответа получает ответ.

(строка)

Синтаксис:

"string" "string" ...

--return-path (строка)

Адрес электронной почты, на который будут пересылаться сообщения об ошибках и жалобах при включенном реле сообщения обратной связи. Если сообщение не может быть доставлено получателю, от интернет-провайдера получателя возвращается сообщение об ошибке; это сообщение пересылается на адрес электронной почты, указанный в параметре ReturnPath. Параметр ReturnPath никогда не перезаписывается. Этот адрес электронной почты должен быть либо индивидуально проверен с Amazon SES, либо принадлежать домену, проверенному в Amazon SES.

--return-path-arn (строка)

Этот параметр используется только для авторизации отправки. Это ARN идентификатора, связанного с политикой авторизации отправки, которая разрешает вам использовать адрес электронной почты, указанный в параметре ReturnPath.

Например, если владелец example.com (с ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) прикрепит к нему политику, разрешающую вам использовать feedback@example.com, то вы укажете ReturnPathArn как arn:aws:ses:us-east-1:123456789012:identity/example.com, а ReturnPath как feedback@example.com.

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

--configuration-set-name (строка)

Название набора конфигурации для использования при отправке электронного письма с помощью SendBulkTemplatedEmail.

--default-tags (список)

Список тегов в виде пар имя/значение, применяемых к отправляемому электронному письму в пункт назначения с помощью SendBulkTemplatedEmail.

(структура)

Содержит имя и значение тега, который вы можете предоставить для SendEmail или SendRawEmail, чтобы применить к электронному письму.

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

Имя -> (строка)

Имя тега. Имя должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

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

Значение тега. Значение должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

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

Name=string,Value=string ...

Синтаксис JSON:

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

--template (строка)

Шаблон для использования при отправке этого электронного письма.

--template-arn (строка)

ARN шаблона для использования при отправке этого электронного письма.

--default-template-data (строка)

Список значений замены для применения к шаблону, когда данные замены не указаны в объекте Destination. Эти значения действуют как значения по умолчанию или резервные варианты, когда нет других данных.

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

--destinations (список)

Один или несколько объектов Destination. Все получатели в Destination получают одинаковую версию электронного письма. Вы можете указать до 50 объектов Destination в массиве Destinations.

(структура)

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

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

Представляет пункт назначения сообщения, состоящий из полей To:, CC: и BCC:.

Примечание

Amazon SES не поддерживает расширение SMTPUTF8, как описано в RFC6531. По этой причине строка адреса электронной почты должна быть в формате 7-битного ASCII. Если вы хотите отправлять или получать электронные письма с адресами, содержащими символы Unicode в доменной части адреса, необходимо закодировать домен с помощью Punycode. Punycode не разрешен в локальной части адреса электронной почты (части перед знаком @) или в имени «дружественного отправителя». Если вы хотите использовать символы Unicode в имени «дружественного отправителя», необходимо закодировать имя «дружественного отправителя» с помощью синтаксиса MIME encoded-word, как описано в разделе Отправка необработанного электронного письма с помощью API Amazon SES. Дополнительную информацию о Punycode см. в RFC 3492.

ToAddresses -> (список)

Получатели, которые будут помещены в строку To:

(строка)

CcAddresses -> (список)

Получатели, которые будут помещены в строку CC:

(строка)

BccAddresses -> (список)

Получатели, которые будут помещены в строку BCC:

(строка)

ReplacementTags -> (список)

Список тегов в виде пар имя/значение, применяемых к отправляемому электронному письму с помощью SendBulkTemplatedEmail. Теги соответствуют характеристикам электронного письма, которые вы определяете, чтобы вы могли публиковать события отправки электронных писем.

(структура)

Содержит имя и значение тега, который вы можете предоставить для SendEmail или SendRawEmail, чтобы применить к электронному письму.

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

Имя -> (строка)

Имя тега. Имя должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

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

Значение тега. Значение должно соответствовать следующим требованиям:

  • Содержать только латинские буквы (a-z, A-Z), цифры (0-9), символы подчеркивания (_) или дефисы (-).
  • Содержать не более 256 символов.

ReplacementTemplateData -> (строка)

Список значений замены для применения к шаблону. Этот параметр представляет собой JSON-объект, обычно состоящий из пар ключ-значение, где ключи соответствуют тегам замены в шаблоне электронного письма.

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

Destination={ToAddresses=[string,string],CcAddresses=[string,string],BccAddresses=[string,string]},ReplacementTags=[{Name=string,Value=string},{Name=string,Value=string}],ReplacementTemplateData=string ...

Синтаксис JSON:

[
  {
    "Destination": {
      "ToAddresses": ["string", ...],
      "CcAddresses": ["string", ...],
      "BccAddresses": ["string", ...]
    },
    "ReplacementTags": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "ReplacementTemplateData": "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
  • 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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку 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.

Вывод

Status -> (список)

Один объект на предполагаемого получателя. Проверьте каждый объект ответа и повторите любые сообщения со статусом ошибки. (Обратите внимание, что порядок ответов будет соответствовать порядку назначения в запросе.) Правила получения позволяют указать, какие действия

(структура)

Объект, содержащий ответ на операцию SendBulkTemplatedEmail.

Status -> (строка)

Статус сообщения, отправленного с помощью операции SendBulkTemplatedEmail.

Возможные значения для этого параметра:

  • Success : Amazon SES принял сообщение и пытается доставить его получателям.
  • MessageRejected : Сообщение отклонено, так как оно содержит вирус.
  • MailFromDomainNotVerified : Электронный адрес отправителя или домен не были проверены.
  • ConfigurationSetDoesNotExist : Указанный вами набор конфигурации не существует.
  • TemplateDoesNotExist : Указанный вами шаблон не существует.
  • AccountSuspended : Ваш аккаунт закрыт из-за проблем, связанных с практикой отправки электронных писем.
  • AccountThrottled : Количество электронных писем, которые вы можете отправить, уменьшено, так как ваш аккаунт превысил выделенный лимит отправки.
  • AccountDailyQuotaExceeded : Вы достигли или превысили максимальное количество электронных писем, которые вы можете отправить с вашего аккаунта за 24 часа.
  • InvalidSendingPoolName : Указанный вами набор конфигурации относится к пулу IP, которого не существует.
  • AccountSendingPaused : Отправка электронных писем для учетной записи Amazon SES была отключена с помощью операции UpdateAccountSendingEnabled.
  • ConfigurationSetSendingPaused : Отправка электронных писем для этого набора конфигурации была отключена с помощью операции UpdateConfigurationSetSendingEnabled.
  • InvalidParameterValue : Один или несколько параметров, указанных вами при вызове этой операции, были неверны. Дополнительная информация содержится в сообщении об ошибке.
  • TransientFailure : Amazon SES не смог обработать ваш запрос из-за временной проблемы.
  • Failed : Amazon SES не смог обработать ваш запрос. Дополнительная информация содержится в сообщении об ошибке.

Error -> (строка)

Описание ошибки, которая помешала отправке сообщения с помощью операции SendBulkTemplatedEmail.

MessageId -> (строка)

Уникальный идентификатор сообщения, возвращённый операцией SendBulkTemplatedEmail.

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

Spec-Zone.ru

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