Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

создать-приложение

Описание

Создаёт приложение Amazon Q Business.

Примечание

Существуют новые уровни для Amazon Q Business. Не все функции Amazon Q Business Pro также доступны в Amazon Q Business Lite. Для получения информации о включённых функциях в Amazon Q Business Lite и Amazon Q Business Pro, см. уровни Amazon Q Business. Вам необходимо использовать консоль Amazon Q Business для назначения уровней подписки пользователям.

Роль со связанным сервисом Amazon Q Apps будет создана, если её нет в учётной записи Amazon Web Services при включении QAppsConfiguration в запросе. Для получения дополнительной информации, см. Использование роли со связанным сервисом для Q Apps.

При создании приложения Amazon Q Business может безопасно передавать данные для обработки из выбранной вами области Amazon Web Services, но внутри вашей географической зоны. Для получения дополнительной информации, см. Обработка в разных регионах в Amazon Q Business.

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

Синтаксис

  create-application
--display-name <value>
[--role-arn <value>]
[--identity-type <value>]
[--iam-identity-provider-arn <value>]
[--identity-center-instance-arn <value>]
[--client-ids-for-oidc <value>]
[--description <value>]
[--encryption-configuration <value>]
[--tags <value>]
[--client-token <value>]
[--attachments-configuration <value>]
[--q-apps-configuration <value>]
[--personalization-configuration <value>]
[--quick-sight-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]

Параметры

--display-name (строка)

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

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

Amazon Resource Name (ARN) роли IAM с разрешениями для доступа к вашим журналам и метрикам Amazon CloudWatch. Если этот параметр не указан, Amazon Q Business создаст роль со связанным сервисом (SLR) и будет использовать её в качестве роли приложения.

--identity-type (строка)

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

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

  • AWS_IAM_IDP_SAML
  • AWS_IAM_IDP_OIDC
  • AWS_IAM_IDC
  • AWS_QUICKSIGHT_IDP
  • ANONYMOUS

--iam-identity-provider-arn (строка)

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

--identity-center-instance-arn (строка)

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

--client-ids-for-oidc (список)

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

(строка)

Синтаксис:

"string" "string" ...

--description (строка)

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

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

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

kmsKeyId -> (строка)

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

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

kmsKeyId=string

Синтаксис JSON:

{
  "kmsKeyId": "string"
}

--tags (список)

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

(структура)

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

key -> (строка)

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

value -> (строка)

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

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

key=string,value=string ...

Синтаксис JSON:

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

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

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

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

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

attachmentsControlMode -> (строка)

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

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

attachmentsControlMode=string

Синтаксис JSON:

{
  "attachmentsControlMode": "ENABLED"|"DISABLED"
}

--q-apps-configuration (структура)

Параметр для разрешения конечным пользователям создавать и использовать Amazon Q Apps в веб-приложении.

qAppsControlMode -> (строка)

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

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

qAppsControlMode=string

Синтаксис JSON:

{
  "qAppsControlMode": "ENABLED"|"DISABLED"
}

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

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

personalizationControlMode -> (строка)

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

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

personalizationControlMode=string

Синтаксис JSON:

{
  "personalizationControlMode": "ENABLED"|"DISABLED"
}

--quick-sight-configuration (структура)

Конфигурация Amazon QuickSight для приложения Amazon Q Business, использующего QuickSight для аутентификации. Эта конфигурация требуется, если ваше приложение использует QuickSight в качестве поставщика идентификации. Для получения дополнительной информации, см. Создание приложения, интегрированного с Amazon QuickSight.

clientNamespace -> (строка)

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

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

clientNamespace=string

Синтаксис JSON:

{
  "clientNamespace": "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.

Вывод

applicationId -> (строка)

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

applicationArn -> (строка)

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

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

Spec-Zone.ru

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