start-email-contact

Описание

Создаёт контакт по электронной почте для входящей корреспонденции и запускает поток для начала контакта по электронной почте для клиента. Ответ этого API предоставляет ContactId созданного контакта по электронной почте.

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

Синтаксис

  start-email-contact
--instance-id <value>
--from-email-address <value>
--destination-email-address <value>
[--description <value>]
[--references <value>]
[--name <value>]
--email-message <value>
[--additional-recipients <value>]
[--attachments <value>]
[--contact-flow-id <value>]
[--related-contact-id <value>]
[--attributes <value>]
[--segment-attributes <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 (строка)

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

Краткая синтаксическая форма:

EmailAddress=string,DisplayName=string

Синтаксис JSON:

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

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

--description (строка)

--references (массив)

Краткая синтаксическая форма:

KeyName1=Value=string,Type=string,Status=string,Arn=string,StatusReason=string,KeyName2=Value=string,Type=string,Status=string,Arn=string,StatusReason=string

Синтаксис JSON:

{"string": {
      "Value": "string",
      "Type": "URL"|"ATTACHMENT"|"CONTACT_ANALYSIS"|"NUMBER"|"STRING"|"DATE"|"EMAIL"|"EMAIL_MESSAGE",
      "Status": "AVAILABLE"|"DELETED"|"APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
      "Arn": "string",
      "StatusReason": "string"
    }
  ...}

--name (строка)

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

Краткая синтаксическая форма:

MessageSourceType=string,RawMessage={Subject=string,Body=string,ContentType=string,Headers={KeyName1=string,KeyName2=string}}

Синтаксис JSON:

{
  "MessageSourceType": "RAW",
  "RawMessage": {
    "Subject": "string",
    "Body": "string",
    "ContentType": "string",
    "Headers": {"REFERENCES"|"MESSAGE_ID"|"IN_REPLY_TO"|"X_SES_SPAM_VERDICT"|"X_SES_VIRUS_VERDICT": "string"
      ...}
  }
}

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

Краткая синтаксическая форма:

ToAddresses=[{EmailAddress=string,DisplayName=string},{EmailAddress=string,DisplayName=string}],CcAddresses=[{EmailAddress=string,DisplayName=string},{EmailAddress=string,DisplayName=string}]

Синтаксис JSON:

{
  "ToAddresses": [
    {
      "EmailAddress": "string",
      "DisplayName": "string"
    }
    ...
  ],
  "CcAddresses": [
    {
      "EmailAddress": "string",
      "DisplayName": "string"
    }
    ...
  ]
}

--attachments (список)

Краткая синтаксическая форма:

FileName=string,S3Url=string ...

Синтаксис JSON:

[
  {
    "FileName": "string",
    "S3Url": "string"
  }
  ...
]

--contact-flow-id (строка)

--related-contact-id (строка)

--attributes (массив)

Краткая синтаксическая форма:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--segment-attributes (массив)

Краткая синтаксическая форма:

KeyName1=ValueString=string,ValueMap={KeyName1={ValueString=string,( ... recursive ... ),ValueInteger=integer},KeyName2={ValueString=string,( ... recursive ... ),ValueInteger=integer}},ValueInteger=integer,KeyName2=ValueString=string,ValueMap={KeyName1={ValueString=string,( ... recursive ... ),ValueInteger=integer},KeyName2={ValueString=string,( ... recursive ... ),ValueInteger=integer}},ValueInteger=integer

Синтаксис JSON:

{"string": {
      "ValueString": "string",
      "ValueMap": {"string": {
            "ValueString": "string",
            "ValueMap": {"string": { ... recursive ... }
              ...},
            "ValueInteger": integer
          }
        ...},
      "ValueInteger": integer
    }
  ...}

--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 (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить вывод цвета.

• включено
• выключено
• автоматически

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию - 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

Отключить вывод страниц CLI.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

ContactId -> (string)