Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

list-rule-groups

Описание

Возвращает массив объектов RuleGroupSummary для правил, которые вы управляете.

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

Синтаксис

  list-rule-groups
--scope <value>
[--next-marker <value>]
[--limit <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]

Параметры

--scope (строка)

Указывает, относится ли это к глобальному типу ресурса, такому как распределение Amazon CloudFront. Для приложения Amplify используйте CLOUDFRONT .

Для работы с CloudFront также необходимо указать регион США Восточный (Северная Вирджиния) следующим образом:

  • CLI — Укажите регион при использовании области CloudFront: --scope=CLOUDFRONT --region=us-east-1 .
  • API и SDK — Для всех вызовов используйте конечную точку региона us-east-1.

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

  • CLOUDFRONT
  • REGIONAL

--next-marker (строка)

При запросе списка объектов с установкой Limit, если количество объектов, которые всё ещё доступны для извлечения, превышает ограничение, WAF возвращает значение NextMarker в ответе. Для получения следующей партии объектов укажите маркер из предыдущего вызова в следующем запросе.

--limit (целое число)

Максимальное количество объектов, которые вы хотите, чтобы WAF вернул для этого запроса. Если доступно больше объектов, WAF предоставляет значение NextMarker в ответе, которое вы можете использовать в последующем вызове, чтобы получить следующую партию объектов.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, как в Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для получения списка настраиваемых групп правил

Следующий list-rule-groups извлекает все настраиваемые группы правил, определённые для учётной записи для указанной области и местоположения региона.

aws wafv2 list-rule-groups \
    --scope REGIONAL \
    --region us-west-2

Вывод:

{
    "RuleGroups":[
        {
            "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/rulegroup/TestRuleGroup/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Description":"",
            "Name":"TestRuleGroup",
            "LockToken":"1eb5ec48-0000-0000-0000-ee9b906c541e",
            "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        },
        {
            "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/rulegroup/test/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "Description":"",
            "Name":"test",
            "LockToken":"b0f4583e-998b-4880-9069-3fbe45738b43",
            "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
        }
    ],
    "NextMarker":"test"
}

Для получения дополнительной информации, см. Управление собственными группами правил в Руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

NextMarker -> (строка)

При запросе списка объектов с установкой Limit, если количество объектов, которые всё ещё доступны для извлечения, превышает ограничение, WAF возвращает значение NextMarker в ответе. Для получения следующей партии объектов укажите маркер из предыдущего вызова в следующем запросе.

RuleGroups -> (список)

Массив групп правил. Если в запросе был указан Limit, это может быть не весь список.

(структура)

Сводная информация о группе правил RuleGroup, возвращаемая операциями, такими как создание и перечисление. Она предоставляет информацию, такую как идентификатор, которую вы можете использовать для извлечения и управления RuleGroup, и ARN, который вы предоставляете в RuleGroupReferenceStatement для использования группы правил в правиле Rule.

Name -> (строка)

Имя экземпляра типа данных. Вы не можете изменить имя после создания экземпляра.

Id -> (строка)

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

Description -> (строка)

Описание группы правил, которое помогает в идентификации.

LockToken -> (строка)

Токен, используемый для оптимистической блокировки. WAF возвращает токен для ваших get и list запросов, чтобы отметить состояние сущности на момент запроса. Чтобы внести изменения в сущность, связанную с маркером, вы предоставляете маркер операциям, таким как update и delete. WAF использует маркер, чтобы убедиться, что в сущность не были внесены изменения с момента последнего извлечения. Если изменение было произведено, обновление завершается с WAFOptimisticLockException. Если это произойдёт, выполните другую get операцию и используйте новый токен, возвращённый этой операцией.

ARN -> (строка)

Amazon Resource Name (ARN) сущности.

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

Spec-Zone.ru

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