Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

get-quick-response

Описание

Получает быстрый ответ.

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

Синтаксис

  get-quick-response
--knowledge-base-id <value>
--quick-response-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]

Параметры

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

Идентификатор базы знаний. Должна быть база знаний типа QUICK_RESPONSES.

--quick-response-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
  • 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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

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

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

channels -> (список)

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

(строка)

contentType -> (строка)

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

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

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

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

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

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

Примечание

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

content -> (строка)

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

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

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

Примечание

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

content -> (строка)

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

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

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

description -> (строка)

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

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

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

criteria -> (строка)

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

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

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

values -> (список)

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

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

(строка)

isActive -> (булево)

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

knowledgeBaseArn -> (строка)

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

knowledgeBaseId -> (строка)

Идентификатор базы знаний. Это не должно быть базой знаний типа QUICK_RESPONSES, если вы храните ресурс Wisdom Content в ней. Может быть либо ID, либо ARN. URL не могут содержать ARN.

language -> (строка)

Код языка, на котором написан быстрый ответ.

lastModifiedBy -> (строка)

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

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

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

name -> (строка)

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

quickResponseArn -> (строка)

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

quickResponseId -> (строка)

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

shortcutKey -> (строка)

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

status -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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