Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

Получение сводного отчета о соответствии требованиям по типу ресурса

Описание

Возвращает количество ресурсов, соответствующих и не соответствующих требованиям. Можно указать один или несколько типов ресурсов, чтобы получить эти значения для каждого типа. Максимальное количество возвращаемых значений — 100.

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

Синтаксис

  get-compliance-summary-by-resource-type
[--resource-types <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]

Параметры

--resource-types (список)

Укажите один или несколько типов ресурсов, чтобы получить количество ресурсов, соответствующих и не соответствующих требованиям для каждого типа.

Для этого запроса можно указать тип ресурса Amazon Web Services, такой как AWS::EC2::Instance. Можно указать, что тип ресурса — учетная запись Amazon Web Services, указав AWS::::Account.

(строка)

Синтаксис:

"string" "string" ...

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

Получение сводного отчета о соответствии требованиям для всех типов ресурсов

Следующая команда возвращает количество ресурсов AWS, не соответствующих и соответствующих требованиям:

aws configservice get-compliance-summary-by-resource-type

В выводе значение для каждого атрибута CappedCount указывает, сколько ресурсов соответствует или не соответствует требованиям.

Вывод:

{
    "ComplianceSummariesByResourceType": [
        {
            "ComplianceSummary": {
                "NonCompliantResourceCount": {
                    "CappedCount": 16,
                    "CapExceeded": false
                },
                "ComplianceSummaryTimestamp": 1453237464.543,
                "CompliantResourceCount": {
                    "CappedCount": 10,
                    "CapExceeded": false
                }
            }
        }
    ]
}

Получение сводного отчета о соответствии требованиям для определенного типа ресурсов

Следующая команда возвращает количество экземпляров EC2, не соответствующих и соответствующих требованиям:

aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance

В выводе значение для каждого атрибута CappedCount указывает, сколько ресурсов соответствует или не соответствует требованиям.

Вывод:

{
    "ComplianceSummariesByResourceType": [
        {
            "ResourceType": "AWS::EC2::Instance",
            "ComplianceSummary": {
                "NonCompliantResourceCount": {
                    "CappedCount": 3,
                    "CapExceeded": false
                },
                "ComplianceSummaryTimestamp": 1452204923.518,
                "CompliantResourceCount": {
                    "CappedCount": 7,
                    "CapExceeded": false
                }
            }
        }
    ]
}

Вывод

ComplianceSummariesByResourceType -> (список)

Количество ресурсов, соответствующих и не соответствующих требованиям. Если в запросе были указаны один или несколько типов ресурсов, то значения возвращаются для каждого типа. Максимальное количество возвращаемых значений — 100.

(структура)

Количество ресурсов Amazon Web Services определенного типа, соответствующих или не соответствующих требованиям, не более 100 для каждого.

ResourceType -> (строка)

Тип ресурса Amazon Web Services.

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

Количество ресурсов Amazon Web Services, которые соответствуют или не соответствуют требованиям, не более 100 для каждого.

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

Количество правил Config или ресурсов Amazon Web Services, соответствующих требованиям, до 25 для правил и 100 для ресурсов.

CappedCount -> (целое число)

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

CapExceeded -> (булево)

Указывает, достигнуто ли максимальное количество.

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

Количество правил Config или ресурсов Amazon Web Services, не соответствующих требованиям, до 25 для правил и 100 для ресурсов.

CappedCount -> (целое число)

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

CapExceeded -> (булево)

Указывает, достигнуто ли максимальное количество.

ComplianceSummaryTimestamp -> (метка времени)

Время создания сводного отчета о соответствии требованиям Config.

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

Spec-Zone.ru

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