Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

создать-веб-опыт

Описание

Создаёт веб-опыт Amazon Q Business.

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

Синтаксис

  create-web-experience
--application-id <value>
[--title <value>]
[--subtitle <value>]
[--welcome-message <value>]
[--sample-prompts-control-mode <value>]
[--origins <value>]
[--role-arn <value>]
[--tags <value>]
[--client-token <value>]
[--identity-provider-configuration <value>]
[--browser-extension-configuration <value>]
[--customization-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]

Параметры

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

Идентификатор веб-опыта Amazon Q Business.

--title (строка)

Заголовок вашего веб-опыта Amazon Q Business.

--subtitle (строка)

Подзаголовок для персонализации вашего веб-опыта Amazon Q Business.

--welcome-message (строка)

Настроенное приветственное сообщение для конечных пользователей веб-опыта Amazon Q Business.

--sample-prompts-control-mode (строка)

Определяет, включены ли примерные подсказки в веб-опыт для конечного пользователя.

Возможные значения:

  • ENABLED
  • DISABLED

--origins (список)

Устанавливает домены сайтов, которые разрешены для встраивания веб-опыта Amazon Q Business. Домен происхождения относится к базовому URL для доступа к веб-сайту, включая протокол (http/https ), имя домена и номер порта (если указан).

Примечание

Вы должны указать только базовый URL, а не полный путь. Например, https://docs.aws.amazon.com .

(строка)

Синтаксис:

"string" "string" ...

--role-arn (строка)

Amazon Resource Name (ARN) роли сервиса, прикреплённой к вашему веб-опыту.

Примечание

Вы должны указать это значение, если вы используете IAM Identity Center для управления доступом конечных пользователей к вашему приложению. Если вы используете традиционную систему управления доступом к пользователям, вам не нужно указывать это значение.

--tags (список)

Список пар ключ-значение, которые идентифицируют или категоризируют ваш веб-опыт Amazon Q Business. Вы также можете использовать теги для управления доступом к веб-опыту. Ключи и значения тегов могут состоять из букв, цифр, пробелов Unicode и следующих символов: _ . : / = + - @.

(структура)

Список пар ключ/значение, которые идентифицируют индекс, часто задаваемые вопросы или источник данных. Ключи и значения тегов могут состоять из букв, цифр, пробелов Unicode и следующих символов: _ . : / = + - @.

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

Ключ тега. Ключи не чувствительны к регистру и должны быть уникальными для приложения или источника данных Amazon Q Business.

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

Значение, связанное с тегом. Значение может быть пустой строкой, но не может быть пустым.

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

key=string,value=string ...

JSON синтаксис:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

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

Токен, который вы предоставляете для идентификации запроса на создание веб-опыта Amazon Q Business.

--identity-provider-configuration (структура помеченного союза)

Информация об поставщике идентификации (IdP), используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.

Примечание

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

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

Информация о совместимом с SAML 2.0 поставщике идентификации (IdP), используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.

authenticationUrl -> (строка)

URL, на который конечные пользователи Amazon Q Business будут перенаправлены для аутентификации.

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

Информация о совместимом с OIDC поставщике идентификации (IdP), используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.

secretsArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего секрет клиента OIDC.

secretsRole -> (строка)

Роль IAM с разрешениями для доступа к KMS для расшифровки секрета Secrets Manager, содержащего секрет клиента OIDC.

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

samlConfiguration={authenticationUrl=string},openIDConnectConfiguration={secretsArn=string,secretsRole=string}

JSON синтаксис:

{
  "samlConfiguration": {
    "authenticationUrl": "string"
  },
  "openIDConnectConfiguration": {
    "secretsArn": "string",
    "secretsRole": "string"
  }
}

--browser-extension-configuration (структура)

Настройка расширения браузера для веб-опыта Amazon Q Business.

Примечание

Для приложения Amazon Q Business, использующего внешние поставщики идентификации (IdP) на основе OIDC. Администратор IdP должен добавить URL-адреса перенаправления входа в браузерное расширение в приложение IdP. Дополнительные сведения см. в разделе Настройка внешнего поставщика идентификации OIDC для ваших расширений браузера.

enabledBrowserExtensions -> (список)

Укажите расширения браузера, разрешенные для вашего веб-опыта Amazon Q.

  • CHROME — Включает расширение для браузеров на основе Chromium (Google Chrome, Microsoft Edge, Opera и т. д.).
  • FIREFOX — Включает расширение для Mozilla Firefox.
  • CHROME и FIREFOX — Включают расширение для браузеров на основе Chromium и Mozilla Firefox.

(строка)

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

enabledBrowserExtensions=string,string

JSON синтаксис:

{
  "enabledBrowserExtensions": ["FIREFOX"|"CHROME", ...]
}

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

Устанавливает настраиваемый логотип, значок, шрифт и цвет, используемые в веб-опыте Amazon Q.

customCSSUrl -> (строка)

Предоставляет URL, где размещён настраиваемый файл CSS для веб-опыта Amazon Q.

logoUrl -> (строка)

Предоставляет URL, где размещён настраиваемый логотип для веб-опыта Amazon Q.

fontUrl -> (строка)

Предоставляет URL, где размещён настраиваемый шрифт для веб-опыта Amazon Q.

faviconUrl -> (строка)

Предоставляет URL, где размещён настраиваемый значок для веб-опыта Amazon Q.

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

customCSSUrl=string,logoUrl=string,fontUrl=string,faviconUrl=string

JSON синтаксис:

{
  "customCSSUrl": "string",
  "logoUrl": "string",
  "fontUrl": "string",
  "faviconUrl": "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-в-base64-вывод

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

Отключить кли паджинг для вывода.

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

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

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

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

Вывод

webExperienceId -> (строка)

Идентификатор веб-опыта Amazon Q Business.

webExperienceArn -> (строка)

Amazon Resource Name (ARN) веб-опыта Amazon Q Business.

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

Spec-Zone.ru

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