Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

create-quick-response

Описание

Создаёт быстрый ответ Amazon Q в Connect.

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

Синтаксис

  create-quick-response
--knowledge-base-id <value>
--name <value>
--content <value>
[--content-type <value>]
[--grouping-configuration <value>]
[--description <value>]
[--shortcut-key <value>]
[--is-active | --no-is-active]
[--channels <value>]
[--language <value>]
[--client-token <value>]
[--tags <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 (строка)

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

--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", ...]
}

--description (строка)

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

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

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

--is-active | --no-is-active (булево)

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

--channels (список)

Каналы Amazon Connect, к которым применяется этот быстрый ответ.

(строка)

Синтаксис:

"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

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указан, Amazon Web Services SDK заполняет это поле. Дополнительная информация об идемпотентности см. в статье Защита повторений с помощью идемпотентных API.

--tags (карта)

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

ключ -> (строка)

значение -> (строка)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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 версии 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.

Вывод

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

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

quickResponseArn -> (строка)

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

quickResponseId -> (строка)

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

knowledgeBaseArn -> (строка)

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

knowledgeBaseId -> (строка)

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

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