Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

list-compliance-summaries

Описание

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

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

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

Синтаксис

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

--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
  • text
  • таблица
  • 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-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила кавычек для Unix-подобных систем. Эти примеры потребуется адаптировать к правилам кавычек вашей терминальной оболочки. Подробности см. в разделе «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Для получения сводных данных соответствия для всех типов соответствия

Этот пример отображает сводные данные соответствия для всех типов соответствия в вашей учетной записи.

Команда:

aws ssm list-compliance-summaries

Вывод:

{
  "ComplianceSummaryItems": [
      {
          "ComplianceType": "Association",
          "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",
          "CompliantSummary": {
              "CompliantCount": 1,
              "SeveritySummary": {
                  "CriticalCount": 0,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 1
              }
          },
          "NonCompliantSummary": {
              "NonCompliantCount": 1,
              "SeveritySummary": {
                  "CriticalCount": 1,
                  "HighCount": 0,
                  "MediumCount": 0,
                  "LowCount": 0,
                  "InformationalCount": 0,
                  "UnspecifiedCount": 0
              }
          }
      },
              ...
  ],
  "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}

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

Этот пример отображает сводные данные соответствия для типа соответствия Исправление.

Команда:

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

Вывод

ComplianceSummaryItems -> (список)

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

(структура)

Сводка информации о соответствии по типу соответствия.

ComplianceType -> (строка)

Тип элемента соответствия. Например, тип соответствия может быть Association, Patch или Custom:string.

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