Spec-Zone.ru › AWS CLI v2

[ aws . fms ]

get-compliance-detail

Описание

Возвращает подробную информацию о соответствии указанной учетной записи-члена. Подробности включают ресурсы, которые соответствуют и не соответствуют указанной политике.

Причина, по которой ресурсы считаются соответствующими, зависит от типа политики Firewall Manager.

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

Синтаксис

  get-compliance-detail
--policy-id <value>
--member-account <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]

Параметры

--policy-id (строка)

Идентификатор политики, для которой требуется получить подробности. PolicyId возвращается PutPolicy и ListPolicies.

--member-account (строка)

Учетная запись Amazon Web Services, которая владеет ресурсами, для которых требуется получить подробности.

--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
  • текст
  • таблица
  • 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.

Для получения информации о соответствии учетной записи

Следующий get-compliance-detail пример получает информацию о соответствии для указанной политики и учетной записи-члена.

aws fms get-compliance-detail \
    --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --member-account 123456789012

Вывод:

{
    "PolicyComplianceDetail": {
    "EvaluationLimitExceeded": false,
    "IssueInfoMap": {},
    "MemberAccount": "123456789012",
    "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "PolicyOwner": "123456789012",
    "Violators": []
}

Дополнительную информацию см. в разделе Просмотр соответствия ресурсов с политикой в Руководстве разработчика AWS WAF, AWS Firewall Manager и AWS Shield Advanced.

Вывод

PolicyComplianceDetail -> (структура)

Информация о ресурсах и политике, которые вы указали в запросе GetComplianceDetail.

PolicyOwner -> (строка)

Учетная запись Amazon Web Services, создавшая политику Firewall Manager.

PolicyId -> (строка)

Идентификатор политики Firewall Manager.

MemberAccount -> (строка)

Идентификатор учетной записи Amazon Web Services.

Violators -> (список)

Массив ресурсов, которые не защищены политикой WAF или Shield Advanced или не соответствуют политике группы безопасности.

(структура)

Подробности о ресурсе, который не защищен политикой.

ResourceId -> (строка)

Идентификатор ресурса.

ViolationReason -> (строка)

Причина, по которой ресурс не защищен политикой.

ResourceType -> (строка)

Тип ресурса. Он имеет формат, показанный в Справочнике типов ресурсов Amazon Web Services. Например: AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::CloudFront::Distribution или AWS::NetworkFirewall::FirewallPolicy.

Metadata -> (карта)

Метаданные о ресурсе, который не соответствует области политики.

ключ -> (строка)

значение -> (строка)

EvaluationLimitExceeded -> (булево)

Указывает, превышено ли количество ресурсов, не соответствующих политике Firewall Manager, 100.

ExpiredAt -> (временная метка)

Временная метка, указывающая, когда возвращенная информация должна считаться устаревшей.

IssueInfoMap -> (карта)

Подробности о проблемах с зависимыми службами, такими как WAF или Config, и сообщение об ошибке, полученное, которое указывает на проблему со службой.

ключ -> (строка)

значение -> (строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API