Spec-Zone.ru › AWS CLI v2

[ aws . wafv2 ]

list-ip-sets

Описание

Получает массив объектов IPSetSummary для наборов IP, которые вы управляете.

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

Синтаксис

  list-ip-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, необходимо также указать регион США Восточный (Северная Вирджиния) следующим образом:

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

Для получения списка наборов IP

Следующий пример list-ip-sets извлекает все наборы IP для учетной записи, имеющие региональную область видимости.

aws wafv2 list-ip-sets \
    --scope REGIONAL

Вывод:

{
    "IPSets":[
        {
            "ARN":"arn:aws:wafv2:us-west-2:123456789012:regional/ipset/testip/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Description":"",
            "Name":"testip",
            "LockToken":"0674c84b-0304-47fe-8728-c6bff46af8fc",
            "Id":"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111  "
        }
    ],
    "NextMarker":"testip"
}

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

Вывод

NextMarker -> (строка)

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

IPSets -> (список)

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

(структура)

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

Name -> (строка)

Имя набора IP. Вы не можете изменить имя IPSet после его создания.

Id -> (строка)

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

Description -> (строка)

Описание набора IP, помогающее в идентификации.

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