Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

list-compliance-items

Описание

Для указанного идентификатора ресурса данная операция API возвращает список статусов соответствия для различных типов ресурсов. В настоящее время вы можете указать только один идентификатор ресурса за один вызов. Результаты списка зависят от критериев, указанных в фильтре.

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

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

Синтаксис

  list-compliance-items
[--filters <value>]
[--resource-ids <value>]
[--resource-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]

Параметры

--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"
  }
  ...
]

--resource-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

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

(строка)

Синтаксис:

"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
  • text
  • таблица
  • 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-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance"

Вывод:

{
  "ComplianceItems": [
      {
          "ComplianceType": "Association",
          "ResourceType": "ManagedInstance",
          "ResourceId": "i-1234567890abcdef0",
          "Id": "8dfe3659-4309-493a-8755-0123456789ab",
          "Title": "",
          "Status": "COMPLIANT",
          "Severity": "UNSPECIFIED",
          "ExecutionSummary": {
              "ExecutionTime": 1550408470.0
          },
          "Details": {
              "DocumentName": "AWS-GatherSoftwareInventory",
              "DocumentVersion": "1"
          }
      },
      {
          "ComplianceType": "Association",
          "ResourceType": "ManagedInstance",
          "ResourceId": "i-1234567890abcdef0",
          "Id": "e4c2ed6d-516f-41aa-aa2a-0123456789ab",
          "Title": "",
          "Status": "COMPLIANT",
          "Severity": "UNSPECIFIED",
          "ExecutionSummary": {
              "ExecutionTime": 1550508475.0
          },
          "Details": {
              "DocumentName": "AWS-UpdateSSMAgent",
              "DocumentVersion": "1"
          }
      },
              ...
  ],
  "NextToken": "--token string truncated--"
}

Для отображения элементов соответствия для определённой инстанции и идентификатора ассоциации

В этом примере выводятся все элементы соответствия для указанной инстанции и идентификатора ассоциации.

Команда:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ComplianceType,Values=Association,Type=EQUAL" "Key=Id,Values=e4c2ed6d-516f-41aa-aa2a-0123456789ab,Type=EQUAL"

Для отображения элементов соответствия для инстанции после определенной даты и времени

В этом примере выводятся все элементы соответствия для инстанции после указанной даты и времени.

Команда:

aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN"

Вывод

ComplianceItems -> (список)

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

(структура)

Информация о соответствии, определённая типом ресурса. Например, для типа ресурса исправления Items включает информацию о PatchSeverity, Classification и так далее.

ComplianceType -> (строка)

Тип соответствия. Например, Association (для ассоциации State Manager), Patch или Custom:string являются допустимыми типами соответствия.

ResourceType -> (строка)

Тип ресурса. ManagedInstance в настоящее время является единственным поддерживаемым типом ресурса.

ResourceId -> (строка)

Идентификатор ресурса. Для управляемого узла это идентификатор узла.

Id -> (строка)

Идентификатор элемента соответствия. Например, если элемент соответствия — это исправление для Windows, идентификатор может быть номером статьи KB; например: KB4010320.

Title -> (строка)

Заголовок элемента соответствия. Например, если элемент соответствия — это исправление для Windows, заголовок может быть заголовком статьи KB для исправления; например: Обновление системы безопасности для Active Directory Federation Services.

Status -> (строка)

Статус элемента соответствия. Элемент может быть COMPLIANT, NON_COMPLIANT или пустой строкой (для исправлений Windows, которые не применимы).

Severity -> (строка)

Степень серьезности статуса соответствия. Степень серьезности может быть одной из следующих: Critical, High, Medium, Low, Informational, Unspecified.

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

Резюме для элемента соответствия. Резюме включает идентификатор выполнения, тип выполнения (например, команда) и время выполнения.

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

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

ExecutionId -> (строка)

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

ExecutionType -> (строка)

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

Details -> (карта)

Комбинация тегов "Ключ": "Значение" для элемента соответствия.

key -> (строка)

value -> (строка)

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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