Получение быстрого ответа
Описание
Получает быстрый ответ.
См. также: Документацию API AWS
Синтаксис
get-quick-response
--quick-response-id <value>
--knowledge-base-id <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]
Параметры
--quick-response-id (строка)
--knowledge-base-id (строка)
--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.
Вывод
quickResponse -> (структура)
Быстрый ответ.
quickResponseArn -> (строка)
quickResponseId -> (строка)
knowledgeBaseArn -> (строка)
knowledgeBaseId -> (строка)
name -> (строка)
contentType -> (строка)
Тип медиаконтента быстрого ответа.
- Используйте
application/x.quickresponse;format=plainдля быстрого ответа, написанного на обычном тексте. - Используйте
application/x.quickresponse;format=markdownдля быстрого ответа, написанного с форматированием.
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 -> (строка)
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 -> (карта)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
ключ -> (строка)
значение -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.