[ aws . configservice ]
get-compliance-details-by-config-rule
Описание
Возвращает результаты оценки для указанного правила Config. Результаты показывают, какие ресурсы Amazon Web Services были оценены правилом, когда каждый ресурс был в последний раз оценен и соответствует ли каждый ресурс правилу.
См. также: Документацию API AWS
get-compliance-details-by-config-rule является постраничной операцией. Для получения всего набора результатов могут быть выпущены несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: EvaluationResults
Синтаксис
get-compliance-details-by-config-rule
--config-rule-name <value>
[--compliance-types <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]
Параметры
--config-rule-name (строка)
--compliance-types (список)
Фильтрует результаты по соответствию.
INSUFFICIENT_DATA — это допустимое значение ComplianceType, возвращаемое, когда правило Config не может быть оценено. Однако INSUFFICIENT_DATA нельзя использовать в качестве ComplianceType для фильтрации результатов.(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
COMPLIANT
NON_COMPLIANT
NOT_APPLICABLE
INSUFFICIENT_DATA
--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
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- вкл
- выкл
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл пакета сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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 Config
Следующая команда возвращает результаты оценки для всех ресурсов, которые не соответствуют правилу AWS Config с именем InstanceTypesAreT2micro:
aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT
Вывод:
{
"EvaluationResults": [
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.261,
"ConfigRuleInvokedTime": 1450314642.948,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314645.18,
"ConfigRuleInvokedTime": 1450314642.902,
"ComplianceType": "NON_COMPLIANT"
},
{
"EvaluationResultIdentifier": {
"OrderingTimestamp": 1450314635.065,
"EvaluationResultQualifier": {
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-3a2b3c4d",
"ConfigRuleName": "InstanceTypesAreT2micro"
}
},
"ResultRecordedTime": 1450314643.346,
"ConfigRuleInvokedTime": 1450314643.124,
"ComplianceType": "NON_COMPLIANT"
}
]
}
Вывод
EvaluationResults -> (список)
Указывает, соответствует ли ресурс Amazon Web Services указанному правилу Config.
(структура)
Подробная информация об оценке Config. Предоставляет ресурс Amazon Web Services, который был оценен, соответствие ресурса, связанные временные метки и дополнительная информация.
EvaluationResultIdentifier -> (структура)
Уникально идентифицирует результат оценки.
EvaluationResultQualifier -> (структура)
Идентифицирует правило Config, используемое для оценки ресурса Amazon Web Services, и предоставляет тип и идентификатор оцениваемого ресурса.
ConfigRuleName -> (строка)
ResourceType -> (строка)
ResourceId -> (строка)
EvaluationMode -> (строка)
OrderingTimestamp -> (временная метка)
ResourceEvaluationId -> (строка)
ComplianceType -> (строка)
Указывает, соответствует ли ресурс Amazon Web Services правилу Config, которое его оценило.
Для типа данных EvaluationResult Config поддерживает только значения COMPLIANT, NON_COMPLIANT и NOT_APPLICABLE. Config не поддерживает значение INSUFFICIENT_DATA для типа данных EvaluationResult.
ResultRecordedTime -> (временная метка)
ConfigRuleInvokedTime -> (временная метка)
Annotation -> (строка)
ResultToken -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|