start-outbound-email-contact
Описание
Инициализирует поток для отправки ответа агента или исходящего электронного письма (созданного с помощью API CreateContact) клиенту.
См. также: Документацию AWS API
Синтаксис
start-outbound-email-contact
--instance-id <value>
--contact-id <value>
[--from-email-address <value>]
--destination-email-address <value>
[--additional-recipients <value>]
--email-message <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 (строка)
--contact-id (строка)
--from-email-address (структура)
Адрес электронной почты, связанный с экземпляром.
EmailAddress -> (строка)
DisplayName -> (строка)
Краткая форма:
EmailAddress=string,DisplayName=string
Синтаксис JSON:
{
"EmailAddress": "string",
"DisplayName": "string"
}
--destination-email-address (структура)
Адрес электронной почты клиента.
EmailAddress -> (строка)
DisplayName -> (строка)
Краткая форма:
EmailAddress=string,DisplayName=string
Синтаксис JSON:
{
"EmailAddress": "string",
"DisplayName": "string"
}
--additional-recipients (структура)
Дополнительные адреса получателей электронной почты (CC).
CcEmailAddresses -> (список)
Дополнительная информация о получателях CC электронной почты.
(структура)
Содержит информацию об источнике или получателе адреса электронной почты
EmailAddress -> (строка)
DisplayName -> (строка)
Краткая форма:
CcEmailAddresses=[{EmailAddress=string,DisplayName=string},{EmailAddress=string,DisplayName=string}]
Синтаксис JSON:
{
"CcEmailAddresses": [
{
"EmailAddress": "string",
"DisplayName": "string"
}
...
]
}
--email-message (структура)
Тело сообщения электронной почты, которое будет отправлено новому созданному письму.
MessageSourceType -> (строка)
RAW или TEMPLATE.TemplatedMessageConfig -> (структура)
Информация о настройках шаблона сообщения.
KnowledgeBaseId -> (строка)
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"
}
}
--client-token (строка)
--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.
Вывод
ContactId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.