start-task-contact

Описание

Инициализирует поток для запуска нового контакта задачи. Дополнительную информацию о контактах задач см. в разделе «Концепции: Задачи в Amazon Connect» в руководстве администратора Amazon Connect.

При использовании параметров ввода PreviousContactId и RelatedContactId обратите внимание на следующее:

• PreviousContactId
  • Любые обновления пользовательских атрибутов контакта задачи для любого контакта, связанного через тот же PreviousContactId, повлияют на каждый контакт в цепочке.
  • Максимальное количество связанных контактов задач в цепочке может составлять 12. То есть можно создать 12 контактов задач, которые используют тот же PreviousContactId.
• RelatedContactId
  • Копирует атрибуты контакта из связанного контакта задачи в новый контакт.
  • Любые обновления атрибутов в новом контакте задачи не обновляют атрибуты предыдущего контакта.
  • Нет ограничений на количество контактов задач, которые могут быть созданы с использованием того же RelatedContactId.

Кроме того, при вызове StartTaskContact укажите только один из этих параметров: ContactFlowID, QuickConnectID или TaskTemplateID. Достаточно одного параметра, если шаблон задачи имеет настроенный для него поток. Если указано более одного параметра, или указан только параметр TaskTemplateID, но для него не настроен поток, запрос возвращает ошибку, так как Amazon Connect не может определить уникальный поток для запуска при создании задачи.

Возникает ServiceQuotaExceededException, когда количество открытых задач превышает квоту активных задач или уже существует 12 задач, ссылающихся на тот же PreviousContactId. Дополнительную информацию о квотах служб для контактов задач см. в разделе «Квоты службы Amazon Connect» в руководстве администратора Amazon Connect.

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

Синтаксис

  start-task-contact
--instance-id <value>
[--previous-contact-id <value>]
[--contact-flow-id <value>]
[--attributes <value>]
--name <value>
[--references <value>]
[--description <value>]
[--client-token <value>]
[--scheduled-time <value>]
[--task-template-id <value>]
[--quick-connect-id <value>]
[--related-contact-id <value>]
[--segment-attributes <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 (строка)

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

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

--attributes (словарь)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--name (строка)

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

--description (строка)

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

--scheduled-time (отметка времени)

--task-template-id (строка)

--quick-connect-id (строка)

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

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

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

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

• on
• off
• auto

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