Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

list-violation-events

Описание

Перечисляет нарушения профилей безопасности Device Defender, обнаруженные в указанный период времени. Вы можете использовать фильтры, чтобы ограничить результаты теми оповещениями, которые были выпущены для определённого профиля безопасности, поведения или вещи (устройства).

Требуется разрешение на доступ к действию ListViolationEvents.

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

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

Синтаксис

  list-violation-events
--start-time <value>
--end-time <value>
[--thing-name <value>]
[--security-profile-name <value>]
[--behavior-criteria-type <value>]
[--list-suppressed-alerts | --no-list-suppressed-alerts]
[--verification-state <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]

Параметры

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

Начальное время для перечисления оповещений.

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

Конечное время для перечисления оповещений.

--thing-name (строка)

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

--security-profile-name (строка)

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

--behavior-criteria-type (строка)

Критерии для поведения.

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

  • STATIC
  • STATISTICAL
  • MACHINE_LEARNING

--list-suppressed-alerts | --no-list-suppressed-alerts (логическое значение)

Список всех подавленных оповещений.

--verification-state (строка)

Состояние проверки нарушения (сигнал тревоги обнаружения).

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

  • FALSE_POSITIVE
  • BENIGN_POSITIVE
  • TRUE_POSITIVE
  • UNKNOWN

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла ключей.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Чтобы перечислить нарушения профиля безопасности за определённый период времени

Следующий пример list-violation-events перечисляет нарушения, произошедшие между 5 июня 2019 г. и 12 июня 2019 г. для всех профилей безопасности AWS IoT Device Defender для текущей учётной записи AWS и региона AWS.

aws iot list-violation-events \
    --start-time 1559747125 \
    --end-time 1560351925

Вывод:

{
    "violationEvents": [
        {
            "violationId": "174db59167fa474c80a652ad1583fd44",
            "thingName": "iotconsole-1560269126751-1",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560279000.0
        },
        {
            "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "CellularBandwidth",
                "metric": "aws:message-byte-size",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 128
                    },
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 110
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        },
        {
            "violationId": "74aa393adea02e6648f3ac362beed55e",
            "thingName": "iotconsole-1560269232412-2",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        },
        {
            "violationId": "1e6ab5f7cf39a1466fcd154e1377e406",
            "thingName": "TvnQoEoU",
            "securityProfileName": "Testprofile",
            "behavior": {
                "name": "Authorization",
                "metric": "aws:num-authorization-failures",
                "criteria": {
                    "comparisonOperator": "greater-than",
                    "value": {
                        "count": 10
                    },
                    "durationSeconds": 300,
                    "consecutiveDatapointsToAlarm": 1,
                    "consecutiveDatapointsToClear": 1
                }
            },
            "metricValue": {
                "count": 0
            },
            "violationEventType": "in-alarm",
            "violationEventTime": 1560276600.0
        }
    ]
}

Дополнительную информацию см. в разделе Команды обнаружения в Руководстве разработчика AWS IoT.

Вывод

violationEvents -> (список)

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

(структура)

Информация о нарушении поведения профиля безопасности Защитника устройств.

violationId -> (строка)

Идентификатор события нарушения.

thingName -> (строка)

Имя объекта, ответственного за событие нарушения.

securityProfileName -> (строка)

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

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

Нарушенное поведение.

name -> (строка)

Имя, присвоенное поведению.

metric -> (строка)

Измеряемая характеристика поведения.

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

Измерение для характеристики поведения. Например, используя измерение TOPIC_FILTER, можно сузить область применения характеристики только до MQTT-тем, где имя соответствует указанному в измерении шаблону. Это нельзя использовать с настраиваемыми характеристиками.

dimensionName -> (строка)

Уникальный идентификатор измерения.

operator -> (строка)

Определяет, как интерпретируются значения dimensionValues измерения. Например, для измерения типа TOPIC_FILTER оператор IN, сообщение будет учитываться только в том случае, если его тема совпадает с одним из фильтров тем. С оператором NOT_IN сообщение будет учитываться только в том случае, если оно не совпадает ни с одним из фильтров тем. Оператор является необязательным: если он не указан (null), он будет интерпретирован как IN.

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

Критерии, определяющие, ведет ли себя устройство нормально относительно metric.

Примечание

В консоли IoT вы можете выбрать получение предупреждения через Amazon SNS, когда IoT Device Defender обнаруживает, что устройство ведет себя аномально.

comparisonOperator -> (строка)

Оператор, который связывает измеряемый объект (metric) с критериями (содержащими value или statisticalThreshold). Допустимые операторы включают:

  • string-list : in-set и not-in-set
  • number-list : in-set и not-in-set
  • ip-address-list : in-cidr-set и not-in-cidr-set
  • number : less-than , less-than-equals , greater-than и greater-than-equals

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

Значение для сравнения с metric.

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

Если comparisonOperator требует числового значения, используйте это для указания числового значения для сравнения с metric.

cidrs -> (список)

Если comparisonOperator требует набора CIDR, используйте это для указания этого набора для сравнения с metric.

(строка)

ports -> (список)

Если comparisonOperator требует набора портов, используйте это для указания этого набора для сравнения с metric.

(целое число)

number -> (двойное)

Числовое значение характеристики.

numbers -> (список)

Числовые значения характеристики.

(двойное)

strings -> (список)

Строковые значения характеристики.

(строка)

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

Используйте это для указания временного интервала, в течение которого оценивается поведение, для тех критериев, которые имеют временное измерение (например, NUM_MESSAGES_SENT). Для сравнения метрики statisticalThreshhold измерения со всех устройств накапливаются в течение этого интервала времени перед использованием для расчета процентилей, а затем измерения от отдельного устройства также накапливаются в течение этого интервала времени перед предоставлением ранга процентиля. Нельзя использовать с типами данных метрик на основе списков.

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

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

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

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

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

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

statistic -> (строка)

Процентиль, который определяет пороговое значение, по которому определяется соответствие поведению. Метрики собираются в течение указанного периода (durationSeconds) со всех устройств, отправляющих отчеты, в вашей учетной записи, и рассчитываются статистические ранги. Затем измерения с устройства собираются в течение того же периода. Если накопленные измерения с устройства попадают выше или ниже (comparisonOperator) значения, связанного с указанным процентилем, то устройство считается соответствующим поведению, в противном случае возникает нарушение.

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

Настройка обнаружения ML

confidenceLevel -> (строка)

Чувствительность оценки аномального поведения. Может быть Low, Medium или High.

suppressAlerts -> (булево)

Отключает уведомления.

exportMetric -> (булево)

Значение указывает, экспортируются ли метрики, связанные с поведением, если оно истинно.

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

Значение метрики (измерение).

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

Если comparisonOperator требует числового значения, используйте это для указания числового значения для сравнения с metric.

cidrs -> (список)

Если comparisonOperator требует набора CIDR, используйте это для указания этого набора для сравнения с metric.

(строка)

ports -> (список)

Если comparisonOperator требует набора портов, используйте это для указания этого набора для сравнения с metric.

(целое число)

number -> (двойное)

Числовое значение метрики.

numbers -> (список)

Числовые значения метрики.

(двойное)

strings -> (список)

Строковые значения метрики.

(строка)

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

Подробности события нарушения.

confidenceLevel -> (строка)

Чувствительность оценки аномального поведения. Может быть Low, Medium или High.

violationEventType -> (строка)

Тип события нарушения.

verificationState -> (строка)

Состояние проверки нарушения (тревога обнаружения).

verificationStateDescription -> (строка)

Описание состояния проверки нарушения.

violationEventTime -> (временная метка)

Время наступления события нарушения.

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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