Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

list-web-acls

Описание

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

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

Синтаксис

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

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

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

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

Примеры

Примечание

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

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

Чтобы получить веб-правила доступа для области

Следующий list-web-acls извлекает все веб-правила доступа, определенные для учетной записи для указанной области.

aws wafv2 list-web-acls \
    --scope REGIONAL

Вывод:

{
    "NextMarker":"Testt",
    "WebACLs":[
        {
            "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/webacl/Testt/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Description":"sssss",
            "Name":"Testt",
            "LockToken":"7f36cb30-74ef-4cff-8cd4-a77e1aba1746",
            "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
        }
    ]
}

Дополнительную информацию см. в разделе Управление и использование списка веб-контроля доступа (Web ACL) в руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

NextMarker -> (строка)

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

WebACLs -> (список)

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

(структура)

Общие сведения о WebACL, возвращаемые операциями, такими как create и list. Это предоставляет информацию, такую как ID, которую можно использовать для извлечения и управления WebACL, и ARN, который вы предоставляете для операций, таких как AssociateWebACL.

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