Spec-Zone.ru › AWS CLI v2

[ aws . guardduty ]

get-findings-statistics

Описание

Выводит статистику выявленных угроз GuardDuty для указанного идентификатора детектора.

Вы должны указать либо параметр findingStatisticTypes, либо параметр groupBy, но не оба одновременно. Параметры maxResults и orderBy можно использовать только при использовании groupBy.

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

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

Синтаксис

  get-findings-statistics
--detector-id <value>
[--finding-statistic-types <value>]
[--finding-criteria <value>]
[--group-by <value>]
[--order-by <value>]
[--max-results <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]

Параметры

--detector-id (строка)

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

Чтобы найти идентификатор детектора в текущем регионе, см. страницу Настройки в консоли GuardDuty или запустите API ListDetectors.

--finding-statistic-types (список)

Типы статистики выявленных угроз, которые требуется получить.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  COUNT_BY_SEVERITY

--finding-criteria (структура)

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

Criterion -> (карта)

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

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

значение -> (структура)

Содержит информацию об условии.

Eq -> (список)

Представляет условие равно, которое применяется к одному полю при поиске данных о выявленных угрозах.

(строка)

Neq -> (список)

Представляет условие не равно, которое применяется к одному полю при поиске данных о выявленных угрозах.

(строка)

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

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

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

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

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

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

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

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

Equals -> (список)

Представляет условие равно, которое применяется к одному полю при поиске данных о выявленных угрозах.

(строка)

NotEquals -> (список)

Представляет условие не равно, которое применяется к одному полю при поиске данных о выявленных угрозах.

(строка)

GreaterThan -> (длинное целое число)

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

GreaterThanOrEqual -> (длинное целое число)

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

LessThan -> (длинное целое число)

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

LessThanOrEqual -> (длинное целое число)

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

Сокращенный синтаксис:

Criterion={KeyName1={Eq=[string,string],Neq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Equals=[string,string],NotEquals=[string,string],GreaterThan=long,GreaterThanOrEqual=long,LessThan=long,LessThanOrEqual=long},KeyName2={Eq=[string,string],Neq=[string,string],Gt=integer,Gte=integer,Lt=integer,Lte=integer,Equals=[string,string],NotEquals=[string,string],GreaterThan=long,GreaterThanOrEqual=long,LessThan=long,LessThanOrEqual=long}}

Синтаксис JSON:

{
  "Criterion": {"string": {
        "Eq": ["string", ...],
        "Neq": ["string", ...],
        "Gt": integer,
        "Gte": integer,
        "Lt": integer,
        "Lte": integer,
        "Equals": ["string", ...],
        "NotEquals": ["string", ...],
        "GreaterThan": long,
        "GreaterThanOrEqual": long,
        "LessThan": long,
        "LessThanOrEqual": long
      }
    ...}
}

--group-by (строка)

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

Возможные значения:

  • ACCOUNT
  • DATE
  • FINDING_TYPE
  • RESOURCE
  • SEVERITY

--order-by (строка)

Отображает отсортированные данные о выявленных угрозах в указанном порядке. По умолчанию для параметра orderBy установлено значение DESC.

Этот параметр можно использовать только с параметром groupBy.

Возможные значения:

  • ASC
  • DESC

--max-results (целое число)

Максимальное количество результатов, возвращаемых в ответе. Значение по умолчанию составляет 25.

Этот параметр можно использовать только с параметром groupBy.

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

Вывод

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

Объект статистики выявленных проблем.

CountBySeverity -> (карта)

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

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

значение -> (целое число)

GroupedByAccount -> (список)

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

(структура)

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

AccountId -> (строка)

Идентификатор учётной записи Amazon Web Services.

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

Метка времени последнего создания выявленной проблемы для этой учётной записи.

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

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

GroupedByDate -> (список)

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

(структура)

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

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

Метка времени, когда наблюдается общее количество выявленных проблем.

Например, Date будет выглядеть как "2024-09-05T17:00:00-07:00", а LastGeneratedAt будет выглядеть как "2024-09-05T17:12:29-07:00".

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

Метка времени последнего создания выявленной проблемы в количестве выявленных проблем.

Severity -> (двойное число)

Уровень критичности выявленных проблем, созданных в каждый день.

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

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

GroupedByFindingType -> (список)

Представляет список карт, сопоставляющих типы выявленных проблем с количеством общих выявленных проблем, созданных для каждого типа.

В зависимости от параметра orderBy, этот запрос возвращает либо наиболее часто встречающиеся типы выявленных проблем, либо наименее часто встречающиеся типы. Если параметр orderBy равен ASC, это будут наименее часто встречающиеся типы выявленных проблем в вашей учётной записи; в противном случае это будут наиболее часто встречающиеся типы выявленных проблем. Значение по умолчанию для orderBy равно DESC.

(структура)

Информация о каждом типе выявленной проблемы, связанной со статистикой groupedByFindingType.

FindingType -> (строка)

Название типа выявленной проблемы.

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

Метка времени последнего создания этого типа выявленной проблемы в вашей среде.

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

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

GroupedByResource -> (список)

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

(структура)

Информация о каждом типе ресурса, связанном со статистикой groupedByResource.

AccountId -> (строка)

Идентификатор учётной записи Amazon Web Services.

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

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

ResourceId -> (строка)

Идентификатор, связанный с каждым ресурсом. Следующий список предоставляет сопоставление типа ресурса и идентификатора ресурса.

Сопоставление ресурса и идентификатора ресурса
  • AccessKey - resource.accessKeyDetails.accessKeyId
  • Container - resource.containerDetails.id
  • ECSCluster - resource.ecsClusterDetails.name
  • EKSCluster - resource.eksClusterDetails.name
  • Instance - resource.instanceDetails.instanceId
  • KubernetesCluster - resource.kubernetesDetails.kubernetesWorkloadDetails.name
  • Lambda - resource.lambdaDetails.functionName
  • RDSDBInstance - resource.rdsDbInstanceDetails.dbInstanceIdentifier
  • S3Bucket - resource.s3BucketDetails.name
  • S3Object - resource.s3BucketDetails.name

ResourceType -> (строка)

Тип ресурса.

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

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

GroupedBySeverity -> (список)

Представляет список карт, сопоставляющих общее количество выявленных проблем для каждого уровня критичности.

(структура)

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

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

Метка времени последнего создания типа выявленной проблемы для определённого уровня критичности.

Severity -> (двойное число)

Уровень критичности, связанный с каждым типом выявленной проблемы.

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

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

NextToken -> (строка)

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

Этот параметр в настоящее время не поддерживается.

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

Spec-Zone.ru

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