Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

update-participant-role-config

Описание

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

  • Тайм-аут бездействия клиента
  • Тайм-аут автоматического отключения клиента
  • Тайм-аут бездействия агента
  • Тайм-аут автоматического отключения агента

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

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

Синтаксис

  update-participant-role-config
--instance-id <value>
--contact-id <value>
--channel-configuration <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) экземпляра.

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

Идентификатор контакта в данном экземпляре Amazon Connect.

--channel-configuration (структура помеченных объединений)

Канал Amazon Connect, который вы хотите настроить.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: Chat.

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

Конфигурационная информация для роли участника чата.

ParticipantTimerConfigList -> (список)

Список таймеров участников. Можно указать любую уникальную комбинацию роли и типа таймера. Дублирующие записи приводят к ошибке запроса с кодом 400.

(структура)

Конфигурационная информация для таймера. После установки конфигурации таймера она сохраняется на время чата. Она сохраняется для новых контактов в цепочке, например, для перенаправляемых контактов.

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

ParticipantRole -> (строка)

Роль участника в чате.

TimerType -> (строка)

Тип таймера. IDLE указывает, что таймер применяется для определения бездействия участника-человека в чате. DISCONNECT_NONCUSTOMER указывает, что таймер применяется для автоматического отключения участника чата из-за бездействия.

TimerValue -> (структура помеченных объединений)

Значение таймера. Либо действие таймера (Unset для удаления таймера), либо продолжительность таймера в минутах. Можно установить только одно значение.

Примечание

Это структура помеченных объединений. Можно установить только один из следующих ключей верхнего уровня: ParticipantTimerAction, ParticipantTimerDurationInMinutes.

ParticipantTimerAction -> (строка)

Действие таймера. В настоящее время разрешено только одно значение: Unset. Оно удаляет таймер.

ParticipantTimerDurationInMinutes -> (целое число)

Продолжительность таймера в минутах.

Синтаксис JSON:

{
  "Chat": {
    "ParticipantTimerConfigList": [
      {
        "ParticipantRole": "CUSTOMER"|"AGENT",
        "TimerType": "IDLE"|"DISCONNECT_NONCUSTOMER",
        "TimerValue": {
          "ParticipantTimerAction": "Unset",
          "ParticipantTimerDurationInMinutes": 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 (логическое значение)

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

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