Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

describe-config-rule-evaluation-status

Описание

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

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

describe-config-rule-evaluation-status является постраничной операцией. Для получения всего набора результатов могут быть отправлены несколько вызовов API. Вы можете отключить постраничную загрузку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ с постраничной загрузкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ConfigRulesEvaluationStatus

Синтаксис

  describe-config-rule-evaluation-status
[--config-rule-names <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-names (список)

Имя управляемых правил Config, для которых требуется информация о состоянии. Если вы не указываете имена, Config возвращает информацию о состоянии всех управляемых правил Config, которые вы используете.

(строка)

Синтаксис:

"string" "string" ...

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

Следующая команда возвращает информацию о состоянии правила AWS Config с именем MyConfigRule:

aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule

Вывод:

{
    "ConfigRulesEvaluationStatus": [
        {
            "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef",
            "FirstActivatedTime": 1450311703.844,
            "ConfigRuleId": "config-rule-abcdef",
            "LastSuccessfulInvocationTime": 1450314643.156,
            "ConfigRuleName": "MyConfigRule"
        }
    ]
}

Вывод

ConfigRulesEvaluationStatus -> (список)

Информация о состоянии ваших управляемых правил Config.

(структура)

Информация о состоянии ваших управляемых правил Config и пользовательских правил Config. Статус включает информацию, например, о последнем времени выполнения правила, последнем времени его сбоя и связанной ошибке последнего сбоя.

Эта операция не возвращает информацию о состоянии пользовательских правилах Config Lambda.

ConfigRuleName -> (строка)

Имя правила Config.

ConfigRuleArn -> (строка)

Amazon Resource Name (ARN) правила Config.

ConfigRuleId -> (строка)

ID правила Config.

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

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

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

Время последнего неудачного вызова правила Config для оценки ваших ресурсов Amazon Web Services.

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

Время последней успешной оценки ваших ресурсов Amazon Web Services по отношению к правилу.

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

Время последнего неудачного оценивания ваших ресурсов Amazon Web Services по отношению к правилу.

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

Время первого активации правила Config.

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

Время последнего отключения правила Config.

LastErrorCode -> (строка)

Код ошибки, возвращенный Config при последнем сбое.

LastErrorMessage -> (строка)

Сообщение об ошибке, возвращенное Config при последнем сбое.

FirstEvaluationStarted -> (булево)

Указывает, оценивал ли Config ваши ресурсы по отношению к правилу хотя бы один раз.

  • true - Config оценил ваши ресурсы Amazon Web Services по отношению к правилу хотя бы один раз.
  • false - Config не завершил оценивание ваших ресурсов Amazon Web Services по отношению к правилу хотя бы один раз.

LastDebugLogDeliveryStatus -> (строка)

Статус последней попытки доставки журнала отладки для ваших пользовательских правил Config. Либо Successful или Failed.

LastDebugLogDeliveryStatusReason -> (строка)

Причина, по которой Config не смог доставить журнал отладки. Это для последней неудачной попытки получения журнала отладки для ваших пользовательских правил Config.

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

Время последней попытки доставки журнала отладки для ваших пользовательских правил Config.

NextToken -> (строка)

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

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

Spec-Zone.ru

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