Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

получение-опыта-работы-в-сети

Описание

Получает информацию об имеющемся веб-опыте работы в Amazon Q Business.

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

Синтаксис

  get-web-experience
--application-id <value>
--web-experience-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]

Параметры

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

Идентификатор приложения Amazon Q Business, связанного с веб-опытом.

--web-experience-id (строка)

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

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

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

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

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

Вывод

applicationId -> (строка)

Идентификатор приложения Amazon Q Business, связанного с веб-опытом.

webExperienceId -> (строка)

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

webExperienceArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли с разрешениями на доступ к веб-опыту работы в Amazon Q Business и необходимым ресурсам.

defaultEndpoint -> (строка)

Адрес конечной точки вашего веб-опыта работы в Amazon Q Business.

status -> (строка)

Текущий статус веб-опыта работы в Amazon Q Business. Когда значение поля Status равно FAILED , поле ErrorMessage содержит описание ошибки, которая привела к отказу подключения к источнику данных.

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

Временная метка Unix, когда веб-опыт работы в Amazon Q Business был последний создан.

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

Временная метка Unix, когда веб-опыт работы в Amazon Q Business был последний обновлён.

title -> (строка)

Название вашего веб-опыта работы в Amazon Q Business.

subtitle -> (строка)

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

welcomeMessage -> (строка)

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

samplePromptsControlMode -> (строка)

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

origins -> (список)

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

(строка)

roleArn -> (строка)

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

identityProviderConfiguration -> (структура сортированной объединения)

Информация об поставщике идентификаторов (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 (ARN) секрета Secrets Manager, содержащего секрет клиента OIDC.

secretsRole -> (строка)

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

authenticationConfiguration -> (структура сортированной объединения)

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

Примечание

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

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

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

metadataXML -> (строка)

XML-метаданные, сгенерированные вашим IdP.

roleArn -> (строка)

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

userIdAttribute -> (строка)

Имя атрибута пользователя в вашем IdP, соответствующее электронному адресу пользователя.

userGroupAttribute -> (строка)

Имя атрибута группы в вашем IdP, соответствующее группам пользователей.

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

Когда значение поля Status равно FAILED , поле ErrorMessage содержит описание ошибки, которая привела к отказу подключения к источнику данных.

errorMessage -> (строка)

Сообщение, объясняющее ошибку запроса Amazon Q Business.

errorCode -> (строка)

Код, связанный с ошибкой запроса Amazon Q Business.

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

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

enabledBrowserExtensions -> (список)

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

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

(строка)

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

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

customCSSUrl -> (строка)

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

logoUrl -> (строка)

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

fontUrl -> (строка)

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

faviconUrl -> (строка)

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

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

Spec-Zone.ru

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