Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

получить-приложение

Описание

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

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

Синтаксис

  get-application
--application-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.

--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.

Вывод

displayName -> (строка)

Название приложения Amazon Q Business.

applicationId -> (строка)

Идентификатор приложения Amazon Q Business.

applicationArn -> (строка)

Amazon Resource Name (ARN) приложения Amazon Q Business.

identityType -> (строка)

Тип аутентификации, используемый приложением Amazon Q Business.

iamIdentityProviderArn -> (строка)

Amazon Resource Name (ARN) поставщика идентификаторов, используемого приложением Amazon Q Business.

identityCenterApplicationArn -> (строка)

Amazon Resource Name (ARN) экземпляра AWS IAM Identity Center, подключенного к вашему приложению Amazon Q Business.

roleArn -> (строка)

Amazon Resource Name (ARN) IAM с разрешениями для доступа к вашим журналам и метрикам CloudWatch.

status -> (строка)

Состояние приложения Amazon Q Business.

description -> (строка)

Описание приложения Amazon Q Business.

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

Идентификатор ключа Amazon Web Services KMS, используемого для шифрования данных. Amazon Q Business не поддерживает асимметричные ключи.

kmsKeyId -> (строка)

Идентификатор ключа KMS. Amazon Q Business не поддерживает асимметричные ключи.

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

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

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

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

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

Если поле Status установлено в ERROR , поле ErrorMessage содержит описание ошибки, которая привела к сбою синхронизации.

errorMessage -> (строка)

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

errorCode -> (строка)

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

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

Настройки для возможности загрузки файлов конечными пользователями непосредственно во время чата.

attachmentsControlMode -> (строка)

Информация о том, активирована ли функция загрузки файлов во время чата для вашего приложения.

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

Настройки для возможности создания и использования Amazon Q Apps в веб-интерфейсе.

qAppsControlMode -> (строка)

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

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

Конфигурационная информация о персонализации ответов чата. Для получения дополнительной информации см. Персонализация ответов чата.

personalizationControlMode -> (строка)

Вариант, позволяющий Amazon Q Business настраивать ответы чата с использованием пользовательских метаданных — в частности, информации о местоположении и работе — в вашем экземпляре IAM Identity Center.

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

Настройки поведения автоматической подписки для этого приложения. Это применимо только к приложениям SAML и OIDC.

autoSubscribe -> (строка)

Описание того, включены ли автоматические подписки для приложения Amazon Q Business, использующего федерацию идентичности IAM для управления пользователями.

defaultSubscriptionType -> (строка)

Описание типа подписки по умолчанию, назначенного приложению Amazon Q Business, использующему федерацию идентичности IAM для управления пользователями. Если значение для autoSubscribe установлено в ENABLED, вы должны выбрать значение для этого поля.

clientIdsForOIDC -> (список)

Идентификатор клиента OIDC для приложения Amazon Q Business.

(строка)

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

Настройка аутентификации Amazon QuickSight для приложения Amazon Q Business.

clientNamespace -> (строка)

Пространство имен Amazon QuickSight, используемое в качестве поставщика идентификаторов. Для получения дополнительной информации о пространствах имен QuickSight см. операции с пространствами имен.

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

Spec-Zone.ru

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