Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

send-outbound-email

Описание

Отправка исходящих электронных писем для исходящих кампаний. Дополнительную информацию об исходящих кампаниях см. в разделе Настройка исходящих кампаний Amazon Connect.

Примечание

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

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

Синтаксис

  send-outbound-email
--instance-id <value>
--from-email-address <value>
--destination-email-address <value>
[--additional-recipients <value>]
--email-message <value>
--traffic-type <value>
[--source-campaign <value>]
[--client-token <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]

Параметры

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

Идентификатор экземпляра Amazon Connect. Вы можете найти идентификатор экземпляра в имени ресурса Amazon (ARN) экземпляра.

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

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

EmailAddress -> (строка)

Адрес электронной почты с экземпляром в формате [^s@]+@[^s@]+.[^s@]+.

DisplayName -> (строка)

Имя для отображения адреса электронной почты.

Краткий синтаксис:

EmailAddress=string,DisplayName=string

Синтаксис JSON:

{
  "EmailAddress": "string",
  "DisplayName": "string"
}

--destination-email-address (структура)

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

EmailAddress -> (строка)

Адрес электронной почты с экземпляром в формате [^s@]+@[^s@]+.[^s@]+.

DisplayName -> (строка)

Имя для отображения адреса электронной почты.

Краткий синтаксис:

EmailAddress=string,DisplayName=string

Синтаксис JSON:

{
  "EmailAddress": "string",
  "DisplayName": "string"
}

--additional-recipients (структура)

Дополнительные адреса получателей письма в поле Копия.

CcEmailAddresses -> (список)

Дополнительная информация о получателях по адресу Копия.

(структура)

Содержит информацию об источнике или получателе адреса электронной почты

EmailAddress -> (строка)

Адрес электронной почты с экземпляром в формате [^s@]+@[^s@]+.[^s@]+.

DisplayName -> (строка)

Имя для отображения адреса электронной почты.

Краткий синтаксис:

CcEmailAddresses=[{EmailAddress=string,DisplayName=string},{EmailAddress=string,DisplayName=string}]

Синтаксис JSON:

{
  "CcEmailAddresses": [
    {
      "EmailAddress": "string",
      "DisplayName": "string"
    }
    ...
  ]
}

--email-message (структура)

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

MessageSourceType -> (строка)

Тип источника сообщения, т.е. RAW или TEMPLATE .

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

Информация о конфигурации шаблона сообщения.

KnowledgeBaseId -> (строка)

Идентификатор базы знаний. Может быть либо идентификатором, либо ARN. URL-адреса не могут содержать ARN.

MessageTemplateId -> (строка)

Идентификатор шаблона сообщения.

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

Информация о свойствах шаблона, т.е. CustomAttributes или CustomerProfileAttributes.

CustomAttributes -> (карта)

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

key -> (строка)

value -> (строка)

CustomerProfileAttributes -> (строка)

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

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

Исходное содержимое тела сообщения электронной почты.

Subject -> (строка)

Тема электронного письма.

Body -> (строка)

Тело сообщения электронной почты.

ContentType -> (строка)

Тип содержимого, т.е. text/plain или text/html .

Краткий синтаксис:

MessageSourceType=string,TemplatedMessageConfig={KnowledgeBaseId=string,MessageTemplateId=string,TemplateAttributes={CustomAttributes={KeyName1=string,KeyName2=string},CustomerProfileAttributes=string}},RawMessage={Subject=string,Body=string,ContentType=string}

Синтаксис JSON:

{
  "MessageSourceType": "TEMPLATE"|"RAW",
  "TemplatedMessageConfig": {
    "KnowledgeBaseId": "string",
    "MessageTemplateId": "string",
    "TemplateAttributes": {
      "CustomAttributes": {"string": "string"
        ...},
      "CustomerProfileAttributes": "string"
    }
  },
  "RawMessage": {
    "Subject": "string",
    "Body": "string",
    "ContentType": "string"
  }
}

--traffic-type (строка)

Обозначает класс трафика.

Примечание

Поддерживается только тип трафика CAMPAIGN.

Возможные значения:

  • GENERAL
  • CAMPAIGN

--source-campaign (структура)

Объект Campaign, необходимый для типа трафика Campaign.

CampaignId -> (строка)

Уникальный идентификатор кампании.

OutboundRequestId -> (строка)

Уникальный идентификатор для каждой части запроса в рамках одной кампании.

Краткий синтаксис:

CampaignId=string,OutboundRequestId=string

Синтаксис JSON:

{
  "CampaignId": "string",
  "OutboundRequestId": "string"
}

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указан, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API.

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

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

Нет

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

Spec-Zone.ru

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