Spec-Zone.ru › AWS CLI v2

[ aws . codeguru-security ]

get-metrics-summary

Описание

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

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

Синтаксис

  get-metrics-summary
--date <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

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

Дата, с которой требуется получить сводку метрик, округлённая до ближайшего дня. Дата должна быть в пределах последних двух лет.

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

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

Вывод

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

Сводка метрик с указанной даты.

categoriesWithMostFindings -> (список)

Список объектов CategoryWithFindingNum для 5 лучших категорий проблем с наибольшим количеством проблем.

(структура)

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

categoryName -> (строка)

Имя категории проблем. Категория проблем определяется детектором, который обнаружил проблему.

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

Количество открытых проблем в категории.

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

Дата, с которой была получена информация о сводке метрик.

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

Количество открытых проблем каждой степени важности.

critical -> (число с плавающей запятой)

Числовое значение, соответствующее критической проблеме.

high -> (число с плавающей запятой)

Числовое значение, соответствующее проблеме высокой степени важности.

info -> (число с плавающей запятой)

Числовое значение, соответствующее информационной проблеме.

low -> (число с плавающей запятой)

Числовое значение, соответствующее проблеме низкой степени важности.

medium -> (число с плавающей запятой)

Числовое значение, соответствующее проблеме средней степени важности.

scansWithMostOpenCriticalFindings -> (список)

Список объектов ScanNameWithFindingNum для 3 лучших сканирований с наибольшим количеством открытых критических проблем.

(структура)

Информация о количестве проблем, сгенерированных сканированием.

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

Количество проблем, сгенерированных сканированием.

scanName -> (строка)

Имя сканирования.

scansWithMostOpenFindings -> (список)

Список объектов ScanNameWithFindingNum для 3 лучших сканирований с наибольшим количеством открытых проблем.

(структура)

Информация о количестве проблем, сгенерированных сканированием.

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

Количество проблем, сгенерированных сканированием.

scanName -> (строка)

Имя сканирования.

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

Spec-Zone.ru

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