Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

обновить-быстрый-ответ

Описание

Обновляет существующий быстрый ответ Amazon Q в Connect.

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

Синтаксис

  update-quick-response
--knowledge-base-id <value>
--quick-response-id <value>
[--name <value>]
[--content <value>]
[--content-type <value>]
[--grouping-configuration <value>]
[--remove-grouping-configuration | --no-remove-grouping-configuration]
[--description <value>]
[--remove-description | --no-remove-description]
[--shortcut-key <value>]
[--remove-shortcut-key | --no-remove-shortcut-key]
[--is-active | --no-is-active]
[--channels <value>]
[--language <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]

Параметры

--knowledge-base-id (строка)

Идентификатор базы знаний. Может быть либо идентификатором, либо ARN. URL не может содержать ARN.

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

Идентификатор быстрого ответа.

--name (строка)

Имя быстрого ответа.

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

Обновленное содержимое быстрого ответа.

Примечание

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

content -> (строка)

Содержимое быстрого ответа.

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

content=string

Синтаксис JSON:

{
  "content": "string"
}

--content-type (строка)

Тип медиа быстрого ответа.

  • Используйте application/x.quickresponse;format=plain для быстрого ответа, написанного в формате простого текста.
  • Используйте application/x.quickresponse;format=markdown для быстрого ответа, написанного в формате richtext.

--grouping-configuration (структура)

Обновленная конфигурация группировки быстрого ответа.

criteria -> (строка)

Критерии, используемые для группировки пользователей Amazon Q в Connect.

Ниже приведен список поддерживаемых значений критериев.

  • RoutingProfileArn : Группировка пользователей по их ARN профиля маршрутизации Amazon Connect. Пользователь должен иметь разрешения SearchRoutingProfile и DescribeRoutingProfile при установке критерия на это значение.

values -> (список)

Список значений, определяющих различные группы пользователей Amazon Q в Connect.

  • При установке criteria на RoutingProfileArn, необходимо предоставить список ARN профилей маршрутизации Amazon Connect в качестве значений этого параметра.

(строка)

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

criteria=string,values=string,string

Синтаксис JSON:

{
  "criteria": "string",
  "values": ["string", ...]
}

--remove-grouping-configuration | --no-remove-grouping-configuration (логическое значение)

Удалить ли конфигурацию группировки быстрого ответа.

--description (строка)

Обновленное описание быстрого ответа.

--remove-description | --no-remove-description (логическое значение)

Удалить ли описание из быстрого ответа.

--shortcut-key (строка)

Ярлык быстрого ответа. Значение должно быть уникальным в пределах базы знаний.

--remove-shortcut-key | --no-remove-shortcut-key (логическое значение)

Удалить ли ярлык быстрого ответа.

--is-active | --no-is-active (логическое значение)

Активен ли быстрый ответ.

--channels (список)

Каналы контактов Amazon Connect, к которым относится этот быстрый ответ. Поддерживаемые типы каналов контактов включают Chat.

(строка)

Синтаксис:

"string" "string" ...

--language (строка)

Код языка для языка, на котором написан быстрый ответ. Поддерживаемые языковые коды включают de_DE , en_US , es_ES , fr_FR , id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

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

Вывод

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

Быстрый ответ.

quickResponseArn -> (строка)

Amazon Resource Name (ARN) быстрого ответа.

quickResponseId -> (строка)

Идентификатор быстрого ответа.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний. Может быть либо ID, либо ARN. В URL нельзя использовать ARN.

name -> (строка)

Название быстрого ответа.

contentType -> (строка)

Тип содержимого быстрого ответа.

  • Используйте application/x.quickresponse;format=plain для быстрого ответа, написанного на обычном тексте.
  • Используйте application/x.quickresponse;format=markdown для быстрого ответа, написанного в формате richtext.

status -> (строка)

Статус данных быстрого ответа.

createdTime -> (метка времени)

Метка времени создания быстрого ответа.

lastModifiedTime -> (метка времени)

Метка времени последнего изменения данных быстрого ответа.

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

Содержимое быстрого ответа.

plainText -> (структура помеченного союза)

Контейнер содержимого быстрого ответа.

Примечание

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

content -> (строка)

Содержимое быстрого ответа.

markdown -> (структура помеченного союза)

Контейнер содержимого быстрого ответа.

Примечание

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

content -> (строка)

Содержимое быстрого ответа.

description -> (строка)

Описание быстрого ответа.

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

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

criteria -> (строка)

Критерии, используемые для группировки пользователей Amazon Q в Connect.

Следующий список поддерживаемых значений критериев.

  • RoutingProfileArn: Группировка пользователей по ARN профиля маршрутизации Amazon Connect. Пользователь должен иметь разрешения SearchRoutingProfile и DescribeRoutingProfile при установке критерия на это значение.

values -> (список)

Список значений, определяющих различные группы пользователей Amazon Q в Connect.

  • При установке criteria на значение RoutingProfileArn, необходимо указать список ARN профилей маршрутизации Amazon Connect в качестве значений этого параметра.

(строка)

shortcutKey -> (строка)

Короткая клавиша быстрого ответа. Значение должно быть уникальным в рамках базы знаний.

lastModifiedBy -> (строка)

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

isActive -> (булево)

Является ли быстрый ответ активным.

channels -> (список)

Каналы контактов Amazon Connect, к которым относится этот быстрый ответ. Поддерживаемые типы каналов контактов включают Chat.

(строка)

language -> (строка)

Код языка для языка, на котором написан быстрый ответ. Поддерживаемые коды языков включают de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW.

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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