Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

обновить сеанс

Описание

Обновляет сеанс. Сеанс — это контекстуальный контейнер, используемый для генерации рекомендаций. Amazon Connect обновляет существующий сеанс Amazon Q в Connect для каждого контакта, для которого включена функция Amazon Q в Connect.

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

Синтаксис

  update-session
--assistant-id <value>
--session-id <value>
[--description <value>]
[--tag-filter <value>]
[--ai-agent-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]

Параметры

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

Идентификатор помощника Amazon Q в Connect. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

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

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

--description (строка)

Описание.

--tag-filter (структура помеченного объединения)

Объект, который можно использовать для указания условий тегов.

Примечание

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

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

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

orConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(структура помеченного объединения)

Список условий, которые будут применяться вместе с условием OR.

Примечание

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

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

Синтаксис JSON:

{
  "tagCondition": {
    "key": "string",
    "value": "string"
  },
  "andConditions": [
    {
      "key": "string",
      "value": "string"
    }
    ...
  ],
  "orConditions": [
    {
      "andConditions": [
        {
          "key": "string",
          "value": "string"
        }
        ...
      ],
      "tagCondition": {
        "key": "string",
        "value": "string"
      }
    }
    ...
  ]
}

--ai-agent-configuration (отображение)

Настройка агентов ИИ (отображаемых по типу агента ИИ к версии агента ИИ), которые должны использоваться Amazon Q в Connect для этого сеанса.

key -> (строка)

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

Тип, который определяет конфигурационные данные ID агента ИИ при сопоставлении агентов ИИ, которые необходимо использовать для типа агента ИИ в сеансе или помощнике.

aiAgentId -> (строка)

Идентификатор агента ИИ, который необходимо настроить.

Краткая запись:

  KeyName1=aiAgentId=string,KeyName2=aiAgentId=string

Where valid key names are:
  MANUAL_SEARCH
  ANSWER_RECOMMENDATION
  SELF_SERVICE

Синтаксис JSON:

{"MANUAL_SEARCH"|"ANSWER_RECOMMENDATION"|"SELF_SERVICE": {
      "aiAgentId": "string"
    }
  ...}

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

Вывод

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

Информация о сеансе.

sessionArn -> (строка)

Amazon Resource Name (ARN) сеанса.

sessionId -> (строка)

Идентификатор сеанса.

name -> (строка)

Название сеанса.

description -> (строка)

Описание сеанса.

tags -> (отображение)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

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

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

topicIntegrationArn -> (строка)

Amazon Resource Name (ARN) интегрированной темы Amazon SNS, используемой для потоковой передачи сообщений чата.

tagFilter -> (структура помеченного объединения)

Объект, который можно использовать для указания условий тегов.

Примечание

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

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

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

orConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(структура помеченного объединения)

Список условий, которые будут применяться вместе с условием OR.

Примечание

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

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

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

Условие узла листа, которое можно использовать для указания условия тега.

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

aiAgentConfiguration -> (отображение)

Настройка агентов ИИ (отображаемых по типу агента ИИ к версии агента ИИ), которые должны использоваться Amazon Q в Connect для этого сеанса.

key -> (строка)

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

Тип, который определяет конфигурационные данные ID агента ИИ при сопоставлении агентов ИИ, которые необходимо использовать для типа агента ИИ в сеансе или помощнике.

aiAgentId -> (строка)

Идентификатор агента ИИ, который необходимо настроить.

origin -> (строка)

Источник сеанса для отображения. SYSTEM для сеанса по умолчанию, созданного Amazon Q в Connect, или CUSTOMER для сеанса, созданного с помощью API CreateSession.

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

Spec-Zone.ru

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