Spec-Zone.ru › AWS CLI v2

[ aws . bedrock ]

list-guardrails

Описание

Выводит информацию обо всех правилах безопасности (guardrails) в аккаунте. Чтобы вывести информацию о всех версиях ваших правил безопасности, не указывайте поле guardrailIdentifier. Чтобы вывести все версии правила безопасности, укажите ARN правила безопасности в поле guardrailIdentifier.

Вы можете задать максимальное количество результатов в ответе в поле maxResults. Если результатов больше, чем указанное число, ответ возвращает nextToken, которое можно использовать в другом запросе ListGuardrails, чтобы получить следующую партию результатов.

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

Данная операция является постраничной (paginated). Для получения всех результатов может потребоваться несколько вызовов API. Вы можете отключить постраничность, задав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе, аргумент --query должен извлекать данные из результатов следующих выражений запроса: guardrails

Синтаксис

  list-guardrails
[--guardrail-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--guardrail-identifier (строка)

Уникальный идентификатор правила безопасности. Может быть ID или ARN.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, значения из командной строки переопределят значения, заданные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретирована буквально. Данный параметр не может быть указан вместе с --cli-input-yaml.

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

Маркер для указания точки начала постраничной обработки. Это значение NextToken из ранее обрезаемого ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для вызова AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, возвращая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-сервисных вызовов.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возвращения в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды будет предоставлено NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--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.

Вывод

guardrails -> (список)

Список объектов, каждый из которых содержит подробную информацию о правиле безопасности.

(структура)

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

Этот тип данных используется в следующих операциях API:

  • Ответ тела ListGuardrails

id -> (строка)

Уникальный идентификатор правила безопасности.

arn -> (строка)

ARN правила безопасности.

status -> (строка)

Состояние правила безопасности.

name -> (строка)

Имя правила безопасности.

description -> (строка)

Описание правила безопасности.

version -> (строка)

Версия правила безопасности.

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

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

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

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

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

Подробная информация о профиле системы-определенного правила безопасности, который вы используете со своим правилом безопасности, включая идентификатор профиля правила безопасности и Amazon Resource Name (ARN).

guardrailProfileId -> (строка)

Идентификатор профиля правила безопасности, используемого вашим правилом безопасности. Доступность профиля зависит от вашего текущего региона Amazon Web Services. Более подробную информацию см. в Руководстве пользователя Amazon Bedrock.

guardrailProfileArn -> (строка)

Amazon Resource Name (ARN) профиля правила безопасности, который вы используете со своим правилом безопасности.

nextToken -> (строка)

Если результатов больше, чем возвращено в ответе, ответ возвращает nextToken, которое можно использовать в другом запросе ListGuardrails, чтобы получить следующую партию результатов.

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

Spec-Zone.ru

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