Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

создание-плагина

Описание

Создаёт плагин Amazon Q Business.

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

Синтаксис

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

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

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

Имя плагина.

--type (строка)

Тип плагина, который требуется создать.

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

  • SERVICE_NOW
  • SALESFORCE
  • JIRA
  • ZENDESK
  • CUSTOM
  • QUICKSIGHT
  • SERVICENOW_NOW_PLATFORM
  • JIRA_CLOUD
  • SALESFORCE_CRM
  • ZENDESK_SUITE
  • ATLASSIAN_CONFLUENCE
  • GOOGLE_CALENDAR
  • MICROSOFT_TEAMS
  • MICROSOFT_EXCHANGE
  • PAGERDUTY_ADVANCE
  • SMARTSHEET
  • ASANA

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

Информация о конфигурации аутентификации для плагина Amazon Q Business.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: 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 -> (строка)

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

tokenUrl -> (строка)

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

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

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

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

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

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"
  }
}

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

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

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

Содержит конфигурацию пользовательского плагина.

description -> (строка)

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

apiSchemaType -> (строка)

Тип OpenAPI схемы, который необходимо использовать.

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

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

Примечание

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

payload -> (строка)

JSON или YAML-форматированный запрос, определяющий 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"
    }
  }
}

--tags (список)

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

(структура)

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

key -> (строка)

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

value -> (строка)

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

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

key=string,value=string ...

Синтаксис JSON:

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

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

Токен, который вы предоставляете для идентификации запроса на создание вашего плагина 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.

Вывод

pluginId -> (строка)

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

pluginArn -> (строка)

Amazon Resource Name (ARN) плагина.

buildStatus -> (строка)

Текущий статус плагина. Плагин изменяется асинхронно.

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

Spec-Zone.ru

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