Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

получить-имя-агента

Описание

Получает информацию об имени агента.

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

Синтаксис

  get-agent-alias
--agent-alias-id <value>
--agent-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]

Параметры

--agent-alias-id (строка)

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

--agent-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 (строка)

Переопределить адрес по умолчанию команды предоставленным адресом.

--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 для вывода.

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

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

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

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

Вывод

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

Содержит информацию об имени агента.

agentAliasArn -> (строка)

Amazon Resource Name (ARN) имени агента.

agentAliasHistoryEvents -> (список)

Содержит информацию о истории имени агента.

(структура)

Содержит информацию о истории имени агента.

endDate -> (отметка времени)

Дата, когда имя агента перестало быть ассоциировано с версией в объекте routingConfiguration

routingConfiguration -> (список)

Содержит информацию о версии агента, с которой ассоциировано имя агента.

(структура)

Содержит информацию о конфигурации маршрутизации имени агента.

agentVersion -> (строка)

Версия агента, с которой ассоциировано имя агента.

provisionedThroughput -> (строка)

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

startDate -> (отметка времени)

Дата, когда имя агента стало ассоциированным с версией в объекте routingConfiguration.

agentAliasId -> (строка)

Уникальный идентификатор имени агента.

agentAliasName -> (строка)

Имя имени агента.

agentAliasStatus -> (строка)

Статус имени агента и готов ли он к использованию. Возможны следующие статусы:

  • CREATING – Имя агента создается.
  • PREPARED – Имя агента завершено создание или обновление и готово к вызову.
  • FAILED – Операция API имени агента завершилась неудачно.
  • UPDATING – Имя агента обновляется.
  • DELETING – Имя агента удаляется.
  • DISSOCIATED - Имя агента не имеет связанной версии.

agentId -> (строка)

Уникальный идентификатор агента.

clientToken -> (строка)

Уникальный, чувствительный к регистру идентификатор для обеспечения того, что запрос API завершится не более одного раза. Если этот токен соответствует предыдущему запросу, Amazon Bedrock игнорирует запрос, но не возвращает ошибку. Дополнительную информацию см. в разделе Обеспечение идемпотентности .

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

Время создания имени агента.

description -> (строка)

Описание имени агента.

failureReasons -> (список)

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

(строка)

routingConfiguration -> (список)

Содержит информацию о конфигурации маршрутизации имени агента.

(структура)

Содержит информацию о конфигурации маршрутизации имени агента.

agentVersion -> (строка)

Версия агента, с которой ассоциировано имя агента.

provisionedThroughput -> (строка)

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

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

Время последнего обновления имени агента.

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

Spec-Zone.ru

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