Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

list-resource-compliance-summaries

Описание

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

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

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

Синтаксис

  list-resource-compliance-summaries
[--filters <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]

Параметры

--filters (список)

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

(структура)

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

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

Имя фильтра.

Значения -> (список)

Значение для поиска.

(строка)

Тип -> (строка)

Тип сравнения, который должен быть выполнен для значения: Equal, NotEqual, BeginWith, LessThan или GreaterThan.

Краткая форма синтаксиса:

Key=string,Values=string,string,Type=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...],
    "Type": "EQUAL"|"NOT_EQUAL"|"BEGIN_WITH"|"LESS_THAN"|"GREATER_THAN"
  }
  ...
]

--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 (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 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 ssm list-resource-compliance-summaries

Вывод:

{
  "ResourceComplianceSummaryItems": [
      {
          "ComplianceType": "Association",
          "ResourceType": "ManagedInstance",
          "ResourceId": "i-1234567890abcdef0",
          "Status": "COMPLIANT",
          "OverallSeverity": "UNSPECIFIED",
          "ExecutionSummary": {
              "ExecutionTime": 1550509273.0
          },
          "CompliantSummary": {
              "CompliantCount": 2,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 2
              }
          },
          "NonCompliantSummary": {
              "NonCompliantCount": 0,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 0
              }
          }
      },
      {
          "ComplianceType": "Patch",
          "ResourceType": "ManagedInstance",
          "ResourceId": "i-9876543210abcdef0",
          "Status": "COMPLIANT",
          "OverallSeverity": "UNSPECIFIED",
          "ExecutionSummary": {
              "ExecutionTime": 1550248550.0,
              "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab",
              "ExecutionType": "Command"
          },
          "CompliantSummary": {
              "CompliantCount": 397,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 397
              }
          },
          "NonCompliantSummary": {
              "NonCompliantCount": 0,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 0
              }
          }
      }
  ],
  "NextToken": "--token string truncated--"
}

Для перечисления сводок соответствия ресурсов для определённого типа соответствия

В этом примере перечисляются сводки соответствия ресурсов для типа соответствия "Обновление патчей".

Команда:

aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL"

Вывод

ResourceComplianceSummaryItems -> (список)

Сводный подсчёт для указанных или целевых управляемых узлов. Сводный подсчёт включает информацию о соблюдении и несоблюдении ассоциаций State Manager, статусе исправления или пользовательских элементах в соответствии с заданными критериями фильтра.

(структура)

Информация о сводном соблюдении для конкресного ресурса.

ComplianceType -> (строка)

Тип соблюдения.

ResourceType -> (строка)

Тип ресурса.

ResourceId -> (строка)

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

Status -> (строка)

Статус соблюдения для ресурса.

OverallSeverity -> (строка)

Самый высокий уровень серьёзности, обнаруженный для ресурса. Ресурс соответствует этому элементу.

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

Информация об исполнении.

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

Время выполнения в виде объекта даты и времени, сохранённого в следующем формате: yyyy-MM-dd'T'HH:mm:ss'Z'

ExecutionId -> (строка)

Идентификатор, созданный системой при вызове PutComplianceItems. Например, CommandID — допустимый идентификатор выполнения. Вы можете использовать этот идентификатор в последующих вызовах.

ExecutionType -> (строка)

Тип выполнения. Например, Command — допустимый тип выполнения.

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

Список элементов, которые соответствуют ресурсу.

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

Общее число ресурсов, которые соответствуют требованиям.

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

Сводка уровня серьёзности соблюдения по типу соблюдения.

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности Critical. Критическая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности высокий. Высокая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

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

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности низкий. Низкая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

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

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности неопределённый. Неопределённая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

Список элементов, которые не соответствуют ресурсу.

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

Общее число элементов соблюдения, которые не соответствуют требованиям.

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

Сводка уровня серьёзности несоблюдения по типу соблюдения

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности Critical. Критическая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности высокий. Высокая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

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

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности низкий. Низкая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

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

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

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

Общее число ресурсов или элементов соблюдения, имеющих уровень серьёзности неопределённый. Неопределённая серьёзность определяется организацией, опубликовавшей элементы соблюдения.

NextToken -> (строка)

Токен для следующего набора элементов для возврата. Используйте этот токен для получения следующего набора результатов.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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