Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

list-regex-pattern-sets

Описание

Возвращает массив объектов RegexPatternSetSummary для наборов правил регулярных выражений, которые вы управляете.

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

Синтаксис

  list-regex-pattern-sets
--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 необходимо также указать регион US East (N. Virginia) следующим образом:

  • 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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Чтобы получить список наборов правил регулярных выражений

Следующий list-regex-pattern-sets получает все наборы правил регулярных выражений для учетной записи, определённые в регионе us-west-2.

aws wafv2 list-regex-pattern-sets \
--scope REGIONAL \
--region us-west-2

Вывод:

{
    "NextMarker":"regexPatterSet01",
    "RegexPatternSets":[
        {
            "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/regexpatternset/regexPatterSet01/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Description":"Test web-acl",
            "Name":"regexPatterSet01",
            "LockToken":"f17743f7-0000-0000-0000-19a8b93bfb01",
            "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        }
    ]
}

Дополнительную информацию см. в разделе «Наборы IP-адресов и наборы правил регулярных выражений» в руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

NextMarker -> (строка)

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

RegexPatternSets -> (список)

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

(структура)

Общая информация о наборе RegexPatternSet, возвращаемая операциями, такими как создание и получение списка. Предоставляет информацию, такую как идентификатор, который можно использовать для извлечения и управления RegexPatternSet, и ARN, который вы предоставляете RegexPatternSetReferenceStatement для использования набора правил в правиле.

Name -> (строка)

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

Id -> (строка)

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

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