list-compliance-status
Описание
Возвращает массив объектов PolicyComplianceStatus. Используйте PolicyComplianceStatus, чтобы получить сводку о том, какие учётные записи участников защищены указанной политикой.
См. также: Документацию API AWS
list-compliance-status — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: PolicyComplianceStatusList
Синтаксис
list-compliance-status
--policy-id <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]
Параметры
--policy-id (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставляемому --generate-cli-skeleton. Если другие аргументы указаны в командной строке, значения этих аргументов переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретироваться буквально. Это значение не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничной обработки. Это NextToken из ранее усечённого ответа.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в руководстве пользователя AWS CLI.
--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 для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическую запрос параметров CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, аналогичные unix-подобным. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в руководстве пользователя AWS CLI.
Для получения информации о соответствии политики для учётных записей участников
Следующий пример list-compliance-status извлекает информацию о соответствии учётных записей участников для указанной политики.
aws fms list-compliance-status \
--policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Вывод:
{
"PolicyComplianceStatusList": [
{
"PolicyOwner": "123456789012",
"PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"PolicyName": "test",
"MemberAccount": "123456789012",
"EvaluationResults": [
{
"ComplianceStatus": "COMPLIANT",
"ViolatorCount": 0,
"EvaluationLimitExceeded": false
},
{
"ComplianceStatus": "NON_COMPLIANT",
"ViolatorCount": 2,
"EvaluationLimitExceeded": false
}
],
"LastUpdated": 1576283774.0,
"IssueInfoMap": {}
}
]
}
Дополнительная информация см. в разделе Просмотр соответствия ресурсов с помощью политики в руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.
Вывод
PolicyComplianceStatusList -> (список)
Массив объектов PolicyComplianceStatus.
(структура)
Указывает, соответствует ли учётная запись указанной политике. Учётная запись считается несоответствующей, если она включает ресурсы, которые не защищены политикой (для политик WAF и Shield Advanced) или не соответствуют политике (для политик групп безопасности).
PolicyOwner -> (строка)
PolicyId -> (строка)
PolicyName -> (строка)
MemberAccount -> (строка)
EvaluationResults -> (список)
Массив объектов EvaluationResult.
(структура)
Описывает состояние соответствия для учётной записи. Учётная запись считается несоответствующей, если она включает ресурсы, которые не защищены указанной политикой или не соответствуют политике.
ComplianceStatus -> (строка)
ViolatorCount -> (длинное целое число)
EvaluationLimitExceeded -> (логическое значение)
LastUpdated -> (временная метка)
EvaluationResult.IssueInfoMap -> (карта)
Подробная информация о проблемах с зависимыми службами, такими как WAF или Config, и сообщение об ошибке, которое указывает на проблему с данной службой.
ключ -> (строка)
значение -> (строка)
NextToken -> (строка)
PolicyComplianceStatus, чем число, указанное вами для MaxResults в запросе, ответ включает значение NextToken. Чтобы перечислить больше объектов PolicyComplianceStatus, отправьте ещё один запрос ListComplianceStatus и укажите значение NextToken из ответа в значение NextToken в следующем запросе.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|