Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

обновить-плагин

Описание

Обновляет плагин Amazon Q Business.

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

Синтаксис

  update-plugin
--application-id <value>
--plugin-id <value>
[--display-name <value>]
[--state <value>]
[--server-url <value>]
[--custom-plugin-configuration <value>]
[--auth-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 (строка)

Идентификатор приложения, к которому прикреплен плагин.

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

Идентификатор плагина.

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

Имя плагина.

--state (строка)

Состояние плагина.

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

  • ENABLED
  • DISABLED

--server-url (строка)

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

--custom-plugin-configuration (структура)

Конфигурация пользовательского плагина.

description -> (строка)

Описание конфигурации пользовательского плагина.

apiSchemaType -> (строка)

Тип схемы OpenAPI для использования.

apiSchema -> (структура помеченного объединения)

Содержит подробности о объекте S3, содержащем схему OpenAPI для группы действий, или JSON или YAML-форматированный payload, определяющий схему.

Примечание

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

payload -> (строка)

JSON или YAML-форматированный payload, определяющий схему OpenAPI для пользовательского плагина.

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

Содержит подробности об объекте S3, содержащем схему OpenAPI для пользовательского плагина. Схема может быть в формате JSON или YAML.

bucket -> (строка)

Имя ведра S3, содержащего файл.

key -> (строка)

Имя файла.

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

description=string,apiSchemaType=string,apiSchema={payload=string,s3={bucket=string,key=string}}

Синтаксис JSON:

{
  "description": "string",
  "apiSchemaType": "OPEN_API_V3",
  "apiSchema": {
    "payload": "string",
    "s3": {
      "bucket": "string",
      "key": "string"
    }
  }
}

--auth-configuration (структура помеченного объединения)

Конфигурация аутентификации, используемая плагином.

Примечание

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

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

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

secretArn -> (строка)

ARN секрета Secrets Manager, хранящего учетные данные базовой аутентификации, используемые для конфигурации плагина.

roleArn -> (строка)

ARN роли IAM, используемой Amazon Q Business для доступа к учетным данным базовой аутентификации, хранящимся в секрете Secrets Manager.

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

Информация об учетных данных/токене аутентификации OAuth 2.0, используемых для настройки плагина.

secretArn -> (строка)

ARN секрета Secrets Manager, хранящего учетные данные/токен OAuth 2.0, используемые для конфигурации плагина.

roleArn -> (строка)

ARN роли IAM, используемой Amazon Q Business для доступа к учетным данным аутентификации OAuth 2.0, хранящимся в секрете Secrets Manager.

authorizationUrl -> (строка)

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

tokenUrl -> (строка)

URL, необходимый протоколом OAuth 2.0 для обмена кодом авторизации конечного пользователя на токен доступа.

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

Информация об вызове пользовательского плагина без аутентификации.

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

Информация об приложении IAM Identity Center, используемом для настройки аутентификации плагина.

idcApplicationArn -> (строка)

Amazon Resource Name (ARN) приложения IAM Identity Center, используемого для настройки аутентификации.

roleArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями для выполнения действий на сервисах Amazon Web Services от вашего имени.

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

basicAuthConfiguration={secretArn=string,roleArn=string},oAuth2ClientCredentialConfiguration={secretArn=string,roleArn=string,authorizationUrl=string,tokenUrl=string},noAuthConfiguration={},idcAuthConfiguration={idcApplicationArn=string,roleArn=string}

Синтаксис JSON:

{
  "basicAuthConfiguration": {
    "secretArn": "string",
    "roleArn": "string"
  },
  "oAuth2ClientCredentialConfiguration": {
    "secretArn": "string",
    "roleArn": "string",
    "authorizationUrl": "string",
    "tokenUrl": "string"
  },
  "noAuthConfiguration": {

  },
  "idcAuthConfiguration": {
    "idcApplicationArn": "string",
    "roleArn": "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 (строка)

Файл с пакетом сертификатов 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 для вывода.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

Нет

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

Spec-Zone.ru

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