Spec-Zone.ru › AWS CLI v2

[ aws . sesv2 ]

send-bulk-email

Описание

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

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

Синтаксис

  send-bulk-email
[--from-email-address <value>]
[--from-email-address-identity-arn <value>]
[--reply-to-addresses <value>]
[--feedback-forwarding-email-address <value>]
[--feedback-forwarding-email-address-identity-arn <value>]
[--default-email-tags <value>]
--default-content <value>
--bulk-email-entries <value>
[--configuration-set-name <value>]
[--endpoint-id <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]

Параметры

--from-email-address (строка)

Электронный адрес, который будет использоваться в качестве адреса «От» для отправляемого письма. Указанный адрес должен быть подтверждён.

--from-email-address-identity-arn (строка)

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

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

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

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

Электронные адреса «Ответ» для сообщения. При ответе на сообщение каждый адрес «Ответ» получит ответ.

(строка)

Синтаксис:

"string" "string" ...

--feedback-forwarding-email-address (строка)

Адрес, по которому будут отправляться уведомления о возврате и жалобах.

--feedback-forwarding-email-address-identity-arn (строка)

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

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

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

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

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

(структура)

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

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

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

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

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

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

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

Краткая запись синтаксиса:

Name=string,Value=string ...

Синтаксис JSON:

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

--default-content (структура)

Объект, содержащий тело сообщения. Вы можете указать шаблон сообщения.

Шаблон -> (структура)

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

ИмяШаблона -> (строка)

Имя шаблона. Вы будете ссылаться на это имя при отправке электронных писем с помощью операций SendTemplatedEmail или SendBulkTemplatedEmail.

ArnШаблона -> (строка)

Amazon Resource Name (ARN) шаблона.

СодержаниеШаблона -> (структура)

Содержание шаблона.

Примечание

Amazon SES поддерживает только простые подстановки при отправке писем с помощью операций SendEmail или SendBulkEmail и при предоставлении полного содержимого шаблона в запросе.

Тема -> (строка)

Тема письма.

Текст -> (строка)

Тело письма, которое будет видно получателям, у которых почтовые клиенты не отображают HTML.

Html -> (строка)

HTML-тело письма.

ДанныеШаблона -> (строка)

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

Заголовки -> (список)

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

(структура)

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

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

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

  • Может содержать любые печатные символы ASCII (33-126) за исключением двоеточия (:).
  • Может содержать не более 126 символов.

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

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

  • Может содержать любые печатные символы ASCII.
  • Может содержать не более 870 символов.

Вложения -> (список)

Список вложений для включения в ваше электронное письмо. Все получатели получат одинаковые вложения.

(структура)

Содержит метаданные и исходное содержимое вложения.

ИсходноеСодержимое -> (бинарный)

Исходные данные вложения. Они должны быть закодированы в base64, если вы напрямую обращаетесь к Amazon SES через интерфейс HTTPS. Если вы обращаетесь к Amazon SES с помощью Amazon Web Services SDK, SDK позаботится о кодировании в base64 за вас.

РасположениеСодержимого -> (строка)

Стандартное описание, указывающее, как вложение должно быть отображено в письме. Поддерживаемые значения: ATTACHMENT или INLINE.

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

Имя файла для вложения, как оно будет отображаться в письме. Amazon SES ограничивает определённые расширения файлов. Чтобы убедиться, что вложения приняты, проверьте недопустимые типы вложений в руководстве разработчика Amazon SES.

ОписаниеСодержимого -> (строка)

Краткое описание содержимого вложения.

ИдентификаторСодержимого -> (строка)

Уникальный идентификатор вложения, используемый для ссылки на вложения с расположением INLINE в HTML-содержимом.

КодировкаПередачиСодержимого -> (строка)

Указывает, как закодировано вложение. Поддерживаемые значения: BASE64 , QUOTED_PRINTABLE , SEVEN_BIT.

ТипСодержимого -> (строка)

MIME-тип вложения.

Примечание

Пример: application/pdf , image/jpeg

Синтаксис JSON:

{
  "Template": {
    "TemplateName": "string",
    "TemplateArn": "string",
    "TemplateContent": {
      "Subject": "string",
      "Text": "string",
      "Html": "string"
    },
    "TemplateData": "string",
    "Headers": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "Attachments": [
      {
        "RawContent": blob,
        "ContentDisposition": "ATTACHMENT"|"INLINE",
        "FileName": "string",
        "ContentDescription": "string",
        "ContentId": "string",
        "ContentTransferEncoding": "BASE64"|"QUOTED_PRINTABLE"|"SEVEN_BIT",
        "ContentType": "string"
      }
      ...
    ]
  }
}

--bulk-email-entries (список)

Список объектов отправки массовых электронных писем.

(структура)

Получатель -> (структура)

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

Примечание

Amazon SES не поддерживает расширение SMTPUTF8, как описано в RFC6531. По этой причине локальная часть адреса электронной почты получателя (часть адреса электронной почты, предшествующая знаку @) может содержать только символы 7-битной ASCII. Если доменная часть адреса (часть после знака @) содержит не-ASCII символы, они должны быть закодированы с помощью Punycode, как описано в RFC3492.

ToAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «Кому» для электронного письма.

(строка)

CcAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «КК» (копия) для электронного письма.

(строка)

BccAddresses -> (список)

Массив, содержащий адреса электронной почты получателей «Скрытая копия» для электронного письма.

(строка)

ReplacementTags -> (список)

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

(структура)

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

Name -> (строка)

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

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

Value -> (строка)

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

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

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

ReplacementEmailContent, связанный с BulkEmailEntry.

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

ReplacementTemplate, связанный с ReplacementEmailContent.

ReplacementTemplateData -> (строка)

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

ReplacementHeaders -> (список)

Список заголовков сообщений, связанных с типом данных BulkEmailEntry.

  • Отсутствующие заголовки в BulkEmailEntry : Если заголовок указан в ` Template https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html`__, но отсутствует в BulkEmailEntry, заголовок из Template будет добавлен в исходящее электронное письмо.
  • Наличие заголовков в BulkEmailEntry : Если заголовок указан в BulkEmailEntry, он имеет приоритет над любым заголовком с тем же именем, указанным в ` Template https://docs.aws.amazon.com/ses/latest/APIReference-V2/API_Template.html`__ :
    • Если заголовок также определен в Template, значение из BulkEmailEntry заменит значение заголовка в электронном письме.
    • Если заголовок не определен в Template, он просто будет добавлен в электронное письмо, как указано в BulkEmailEntry.

(структура)

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

Name -> (строка)

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

  • Может содержать любые печатные ASCII-символы (33 - 126) за исключением двоеточия (:).
  • Может содержать не более 126 символов.

Value -> (строка)

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

  • Может содержать любые печатные ASCII-символы.
  • Может содержать не более 870 символов.

Краткая синтаксическая запись:

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

Синтаксис JSON:

[
  {
    "Destination": {
      "ToAddresses": ["string", ...],
      "CcAddresses": ["string", ...],
      "BccAddresses": ["string", ...]
    },
    "ReplacementTags": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "ReplacementEmailContent": {
      "ReplacementTemplate": {
        "ReplacementTemplateData": "string"
      }
    },
    "ReplacementHeaders": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ]
  }
  ...
]

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

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

--endpoint-id (строка)

Идентификатор многорегионального конечного узла (глобальный конечный узел).

--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
  • таблица
  • 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.

Вывод

BulkEmailEntryResults -> (список)

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

(структура)

Результат операции SendBulkEmail для каждого указанного BulkEmailEntry.

Status -> (строка)

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

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

  • SUCCESS: Amazon SES приняла сообщение и попытается доставить его получателям.
  • MESSAGE_REJECTED: Сообщение было отклонено из-за наличия вируса.
  • MAIL_FROM_DOMAIN_NOT_VERIFIED: Адрес электронной почты или домен отправителя не были проверены.
  • CONFIGURATION_SET_DOES_NOT_EXIST: Указанный вами набор конфигурации не существует.
  • TEMPLATE_DOES_NOT_EXIST: Указанный вами шаблон не существует.
  • ACCOUNT_SUSPENDED: Ваш аккаунт был приостановлен из-за проблем, связанных с практикой отправки электронных писем.
  • ACCOUNT_THROTTLED: Количество электронных писем, которые вы можете отправить, было уменьшено, так как ваш аккаунт превысил выделенный лимит отправки.
  • ACCOUNT_DAILY_QUOTA_EXCEEDED: Вы достигли или превысили максимальное количество электронных писем, которые вы можете отправить с вашего аккаунта в течение 24 часов.
  • INVALID_SENDING_POOL_NAME: Указанный вами набор конфигурации относится к IP-пулу, которого не существует.
  • ACCOUNT_SENDING_PAUSED: Отправка электронных писем для аккаунта Amazon SES была отключена с помощью операции UpdateAccountSendingEnabled.
  • CONFIGURATION_SET_SENDING_PAUSED: Отправка электронных писем для этого набора конфигурации была отключена с помощью операции UpdateConfigurationSetSendingEnabled.
  • INVALID_PARAMETER_VALUE: Одно или несколько указанных вами параметров при вызове этой операции были недействительны. Дополнительную информацию см. в сообщении об ошибке.
  • TRANSIENT_FAILURE: Amazon SES не смогла обработать ваш запрос из-за временной проблемы.
  • FAILED: Amazon SES не смогла обработать ваш запрос. Дополнительную информацию см. в сообщении об ошибке.

Error -> (строка)

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

MessageId -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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