получить-плагин
Описание
Получает информацию об существующем плагине Amazon Q Business.
См. также: Документацию API AWS
Синтаксис
get-plugin
--application-id <value>
--plugin-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 (строка)
--plugin-id (строка)
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из вашего файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/отключение цветного вывода.
- on
- off
- auto
--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.
Вывод
applicationId -> (строка)
pluginId -> (строка)
displayName -> (строка)
type -> (строка)
serverUrl -> (строка)
authConfiguration -> (структура помеченных союзов)
Информация о настройках аутентификации для плагина Amazon Q Business.
Примечание
Это структура помеченных союзов. Только одно из следующих верхних ключей может быть установлено:basicAuthConfiguration, oAuth2ClientCredentialConfiguration, noAuthConfiguration, idcAuthConfiguration.basicAuthConfiguration -> (структура)
Информация об учетных данных базовой аутентификации, используемых для настройки плагина.
secretArn -> (строка)
roleArn -> (строка)
oAuth2ClientCredentialConfiguration -> (структура)
Информация об учетных данных/токене аутентификации OAuth 2.0, используемых для настройки плагина.
secretArn -> (строка)
roleArn -> (строка)
authorizationUrl -> (строка)
tokenUrl -> (строка)
noAuthConfiguration -> (структура)
idcAuthConfiguration -> (структура)
Информация об приложении IAM Identity Center, используемом для настройки аутентификации плагина.
idcApplicationArn -> (строка)
roleArn -> (строка)
customPluginConfiguration -> (структура)
Информация о конфигурации пользовательского плагина.
description -> (строка)
apiSchemaType -> (строка)
apiSchema -> (структура помеченных союзов)
Содержит подробности о объекте S3, содержащем схему OpenAPI для группы действий, или формате JSON или YAML, определяющем схему.
Примечание
Это структура помеченных союзов. Только один из следующих верхних ключей может быть установлен:payload, s3.payload -> (строка)
s3 -> (структура)
Содержит подробности о объекте S3, содержащем схему OpenAPI для пользовательского плагина. Схема может быть в формате JSON или YAML.
bucket -> (строка)
key -> (строка)
buildStatus -> (строка)
pluginArn -> (строка)
state -> (строка)
createdAt -> (метка времени)
updatedAt -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.