Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

get-compliance-details-by-resource

Описание

Возвращает результаты оценки указанного ресурса Amazon Web Services. Результаты показывают, какие правила Config использовались для оценки ресурса, когда каждое правило было в последний раз вызвано и соответствует ли ресурс каждому правилу.

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

get-compliance-details-by-resource является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ постраничного вывода, аргумент --query должен извлечь данные из результатов следующих выражений запросов: EvaluationResults

Синтаксис

  get-compliance-details-by-resource
[--resource-type <value>]
[--resource-id <value>]
[--compliance-types <value>]
[--resource-evaluation-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

--resource-type (строка)

Тип ресурса Amazon Web Services, для которого требуется информация о соответствии.

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

ID ресурса Amazon Web Services, для которого требуется информация о соответствии.

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

Фильтрует результаты по соответствию.

INSUFFICIENT_DATA — это допустимое значение ComplianceType, возвращаемое, когда правило Config не может быть оценено. Однако INSUFFICIENT_DATA не может использоваться в качестве ComplianceType для фильтрации результатов.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  COMPLIANT
  NON_COMPLIANT
  NOT_APPLICABLE
  INSUFFICIENT_DATA

--resource-evaluation-id (строка)

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

Примечание

Вам необходимо указать либо ResourceEvaluationID, либо ResourceID и ResourceType .

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничного вывода. Это NextToken из ранее обрыванного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя 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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

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

Следующая команда возвращает результаты оценки для каждого правила, с которым экземпляр EC2 i-1a2b3c4d не соответствует:

aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT

Вывод:

{
    "EvaluationResults": [
        {
            "EvaluationResultIdentifier": {
                "OrderingTimestamp": 1450314635.065,
                "EvaluationResultQualifier": {
                    "ResourceType": "AWS::EC2::Instance",
                    "ResourceId": "i-1a2b3c4d",
                    "ConfigRuleName": "InstanceTypesAreT2micro"
                }
            },
            "ResultRecordedTime": 1450314643.288,
            "ConfigRuleInvokedTime": 1450314643.034,
            "ComplianceType": "NON_COMPLIANT"
        },
        {
            "EvaluationResultIdentifier": {
                "OrderingTimestamp": 1450314635.065,
                "EvaluationResultQualifier": {
                    "ResourceType": "AWS::EC2::Instance",
                    "ResourceId": "i-1a2b3c4d",
                    "ConfigRuleName": "RequiredTagForEC2Instances"
                }
            },
            "ResultRecordedTime": 1450314645.261,
            "ConfigRuleInvokedTime": 1450314642.948,
            "ComplianceType": "NON_COMPLIANT"
        }
    ]
}

Вывод

EvaluationResults -> (список)

Указывает, соответствует ли указанный ресурс Amazon Web Services каждому правилу Config.

(структура)

Подробная информация об оценке Config. Предоставляет ресурс Amazon Web Services, который был оценен, соответствие ресурса, связанные временные метки и дополнительная информация.

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

Уникально идентифицирует результат оценки.

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

Идентифицирует правило Config, используемое для оценки ресурса Amazon Web Services, и предоставляет тип и ID оцениваемого ресурса.

ConfigRuleName -> (строка)

Имя правила Config, используемого в оценке.

ResourceType -> (строка)

Тип ресурса Amazon Web Services, который был оценен.

ResourceId -> (строка)

ID оцениваемого ресурса Amazon Web Services.

EvaluationMode -> (строка)

Режим оценки. Допустимые значения — Detective или Proactive.

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

Время события, которое вызвало оценку ваших ресурсов Amazon Web Services. Время может указывать на то, когда Config передал уведомление об изменении элемента конфигурации, или на то, когда Config передал снимок конфигурации, в зависимости от события, которое вызвало оценку.

ResourceEvaluationId -> (строка)

Уникальный идентификатор результата оценки.

ComplianceType -> (строка)

Указывает, соответствует ли ресурс Amazon Web Services правилу Config, которое его оценивало.

Для типа данных EvaluationResult Config поддерживает только значения COMPLIANT, NON_COMPLIANT и NOT_APPLICABLE. Config не поддерживает значение INSUFFICIENT_DATA для типа данных EvaluationResult.

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

Время, когда Config записал результат оценки.

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

Время, когда правило Config оценивало ресурс Amazon Web Services.

Annotation -> (строка)

Дополнительная информация о том, как оценка определила соответствие.

ResultToken -> (строка)

Зашифрованный токен, который связывает оценку с правилом Config. Токен идентифицирует правило, оцениваемый ресурс Amazon Web Services и событие, которое вызвало оценку.

NextToken -> (строка)

Строка, используемая в последующем запросе для получения следующей страницы результатов в постраничном ответе.

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

Spec-Zone.ru

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