обновление-веб-опыта
Описание
Обновляет веб-опыт Amazon Q Business.
См. также: Документация API AWS
Синтаксис
update-web-experience
--application-id <value>
--web-experience-id <value>
[--role-arn <value>]
[--authentication-configuration <value>]
[--title <value>]
[--subtitle <value>]
[--welcome-message <value>]
[--sample-prompts-control-mode <value>]
[--identity-provider-configuration <value>]
[--origins <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 (строка)
--web-experience-id (строка)
--role-arn (строка)
--authentication-configuration (структура помеченного объединения)
Настройка аутентификации веб-опыта Amazon Q Business.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:samlConfiguration.samlConfiguration -> (структура)
Предоставляет информацию о конфигурации поставщика удостоверений (IdP) SAML 2.0, необходимую Amazon Q Business для развертывания веб-опыта Amazon Q Business.
metadataXML -> (строка)
roleArn -> (строка)
userIdAttribute -> (строка)
userGroupAttribute -> (строка)
Краткая запись:
samlConfiguration={metadataXML=string,roleArn=string,userIdAttribute=string,userGroupAttribute=string}
Синтаксис JSON:
{
"samlConfiguration": {
"metadataXML": "string",
"roleArn": "string",
"userIdAttribute": "string",
"userGroupAttribute": "string"
}
}
--title (строка)
--subtitle (строка)
--welcome-message (строка)
--sample-prompts-control-mode (строка)
Определяет, включены ли примерные запросы в веб-опыт для конечного пользователя.
Возможные значения:
ENABLEDDISABLED
--identity-provider-configuration (структура помеченного объединения)
Информация о поставщике удостоверений (IdP), используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан:samlConfiguration, openIDConnectConfiguration.samlConfiguration -> (структура)
Информация о поставщике удостоверений (IdP) SAML 2.0, используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.
authenticationUrl -> (строка)
openIDConnectConfiguration -> (структура)
Информация о поставщике удостоверений (IdP) OIDC, используемом для аутентификации конечных пользователей веб-опыта Amazon Q Business.
secretsArn -> (строка)
secretsRole -> (строка)
Краткая запись:
samlConfiguration={authenticationUrl=string},openIDConnectConfiguration={secretsArn=string,secretsRole=string}
Синтаксис JSON:
{
"samlConfiguration": {
"authenticationUrl": "string"
},
"openIDConnectConfiguration": {
"secretsArn": "string",
"secretsRole": "string"
}
}
--origins (список)
Обновляет домены веб-сайтов, разрешенные для встраивания веб-опыта Amazon Q Business. Происхождение домена относится к базовому URL для доступа к веб-сайту, включая протокол (http/https), имя домена и номер порта (если указан).
Примечание
- Любые значения, кроме
null, переданные в рамках этого обновления, заменят все предыдущие значения. - Вы должны указать только базовый URL, а не полный путь. Например,
https://docs.aws.amazon.com.
(строка)
Синтаксис:
"string" "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 -> (строка)
logoUrl -> (строка)
fontUrl -> (строка)
faviconUrl -> (строка)
Краткая запись:
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
- text
- таблица
- yaml
- yaml-потоковый
--query (строка)
Запрос JMESPath для использования в фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из файла аутентификации.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (логическое значение)
Отказ от подписи запросов. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл сертификата корневого центра для проверки 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.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.