list-protections
Описание
Возвращает объекты защиты для учетной записи. Вы можете получить все защиты или предоставить критерии фильтрации и получить только подмножество защит, соответствующих критериям.
См. также: Документацию API AWS
list-protections является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Protections
Синтаксис
list-protections
[--inclusion-filters <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]
Параметры
--inclusion-filters (структура)
Сужает набор защит, которые вызывается запрос. Вы можете получить одну защиту, указав ее имя или ARN (Amazon Resource Name) защищаемого ресурса. Вы также можете получить все защиты для определенного типа ресурса. Вы можете указать до одного критерия на тип фильтра. Shield Advanced возвращает защиты, которые точно соответствуют всем критериям фильтрации, которые вы предоставили.
ResourceArns -> (список)
ARN (Amazon Resource Name) ресурса, защиту которого вы хотите получить.
(строка)
ProtectionNames -> (список)
Имя защиты, которую вы хотите получить.
(строка)
ResourceTypes -> (список)
Тип защищаемого ресурса, защиты которого вы хотите получить.
(строка)
Сокращенный синтаксис:
ResourceArns=string,string,ProtectionNames=string,string,ResourceTypes=string,string
Синтаксис JSON:
{
"ResourceArns": ["string", ...],
"ProtectionNames": ["string", ...],
"ResourceTypes": ["CLOUDFRONT_DISTRIBUTION"|"ROUTE_53_HOSTED_ZONE"|"ELASTIC_IP_ALLOCATION"|"CLASSIC_LOAD_BALANCER"|"APPLICATION_LOAD_BALANCER"|"GLOBAL_ACCELERATOR", ...]
}
--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
- text
- таблица
- 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.
Получение сводок защит из AWS Shield Advanced
В следующем примере list-protections примере извлекаются сводки защит, включенных для учетной записи.
aws shield list-protections
Вывод:
{
"Protections": [
{
"Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Name": "Protection for CloudFront distribution",
"ResourceArn": "arn:aws:cloudfront::123456789012:distribution/E198WC25FXOWY8"
}
]
}
Дополнительную информацию см. в разделе Укажите свои защищаемые ресурсы в Руководстве разработчика AWS Shield Advanced.
Вывод
Protections -> (список)
Массив включенных объектов защиты.
(структура)
Объект, представляющий ресурс, защищенный от DDoS-атак.
Id -> (строка)
Name -> (строка)
My CloudFront distributions.ResourceArn -> (строка)
HealthCheckIds -> (список)
Уникальный идентификатор (ID) проверки работоспособности Route 53, связанной с защитой.
(строка)
ProtectionArn -> (строка)
ApplicationLayerAutomaticResponseConfiguration -> (структура)
Параметры автоматической защиты от DDoS-атак прикладного уровня для защиты. Эта конфигурация определяет, управляет ли Shield Advanced автоматически правилами в веб-ACL для реагирования на события прикладного уровня, которые Shield Advanced определяет как DDoS-атаки.
Status -> (строка)
Action -> (структура)
Определяет параметр действия, который Shield Advanced должен использовать в правилах WAF, которые он создает от имени защищаемого ресурса в ответ на DDoS-атаки. Вы указываете это в качестве части конфигурации функции автоматической защиты от DDoS-атак прикладного уровня при включении или обновлении автоматического реагирования. Shield Advanced создает правила WAF в управляемой Shield Advanced группе правил внутри веб-ACL, которую вы связали с ресурсом.
Block -> (структура)
Указывает, что Shield Advanced должен настроить свои правила WAF с действием WAF Block.
Вы должны указать ровно одно действие: Block или Count.
Count -> (структура)
Указывает, что Shield Advanced должен настроить свои правила WAF с действием WAF Count.
Вы должны указать ровно одно действие: Block или Count.
NextToken -> (строка)
При запросе списка объектов от Shield Advanced, если ответ не содержит все оставшиеся доступные объекты, Shield Advanced включает значение NextToken в ответ. Вы можете получить следующую партию объектов, повторно запросив список и предоставив токен, возвращенный предыдущим вызовом в вашем запросе.
Вы можете указать максимальное количество объектов, которые вы хотите, чтобы Shield Advanced вернул для одного вызова с помощью параметра MaxResults. Shield Advanced не вернет более MaxResults объектов, но может вернуть меньше, даже если больше объектов все еще доступны.
Всякий раз, когда остаются объекты, которые Shield Advanced еще не вернул вам, ответ будет включать значение NextToken.
© Copyright 2025, Amazon Web Services. Created using Sphinx.