list-audit-findings

Описание

Выводит результаты (находки) аудита Device Defender или аудитов, выполненных в указанный период времени. (Результаты хранятся в течение 90 дней.)

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

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

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

Синтаксис

  list-audit-findings
[--task-id <value>]
[--check-name <value>]
[--resource-identifier <value>]
[--start-time <value>]
[--end-time <value>]
[--list-suppressed-findings | --no-list-suppressed-findings]
[--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]

Параметры

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

Фильтр для ограничения результатов аудитом с указанным идентификатором. Вы должны указать либо taskId, либо startTime и endTime, но не оба.

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

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

--resource-identifier (структура)

Информация, определяющая несоответствующий ресурс.

deviceCertificateId -> (строка)

Идентификатор сертификата, прикрепленного к ресурсу.

caCertificateId -> (строка)

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

cognitoIdentityPoolId -> (строка)

Идентификатор пула идентификаторов Amazon Cognito.

clientId -> (строка)

Идентификатор клиента.

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

Версия политики, связанной с ресурсом.

policyName -> (строка)

Название политики.

policyVersionId -> (строка)

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

account -> (строка)

Аккаунт, с которым связан ресурс.

iamRoleArn -> (строка)

ARN роли IAM, имеющей чрезмерно разрешительные действия.

roleAliasArn -> (строка)

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

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

Идентификатор сертификата издателя.

issuerCertificateSubject -> (строка)

Подпись сертификата издателя.

issuerId -> (строка)

Идентификатор издателя.

issuerCertificateSerialNumber -> (строка)

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

deviceCertificateArn -> (строка)

ARN идентифицированного сертификата устройства.

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

deviceCertificateId=string,caCertificateId=string,cognitoIdentityPoolId=string,clientId=string,policyVersionIdentifier={policyName=string,policyVersionId=string},account=string,iamRoleArn=string,roleAliasArn=string,issuerCertificateIdentifier={issuerCertificateSubject=string,issuerId=string,issuerCertificateSerialNumber=string},deviceCertificateArn=string

Синтаксис JSON:

{
  "deviceCertificateId": "string",
  "caCertificateId": "string",
  "cognitoIdentityPoolId": "string",
  "clientId": "string",
  "policyVersionIdentifier": {
    "policyName": "string",
    "policyVersionId": "string"
  },
  "account": "string",
  "iamRoleArn": "string",
  "roleAliasArn": "string",
  "issuerCertificateIdentifier": {
    "issuerCertificateSubject": "string",
    "issuerId": "string",
    "issuerCertificateSerialNumber": "string"
  },
  "deviceCertificateArn": "string"
}

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

Фильтр для ограничения результатов находками, найденными после указанного времени. Вы должны указать либо startTime и endTime, либо taskId, но не оба.

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

Фильтр для ограничения результатов находками, найденными до указанного времени. Вы должны указать либо startTime и endTime, либо taskId, но не оба.

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

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

--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 (строка)

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

включено
выключено
автоматически

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

Пример 1: Чтобы перечислить все находки из аудита

Следующий пример list-audit-findings перечисляет все находки из аудита AWS IoT Device Defender с указанным идентификатором задачи.

aws iot list-audit-findings \
    --task-id a3aea009955e501a31b764abe1bebd3d

Вывод:

{
    "findings": []
}

Пример 2: Чтобы перечислить находки для типа проверки аудита

Следующий пример list-audit-findings показывает находки из аудитов AWS IoT Device Defender, которые выполнялись с 5 по 19 июня 2019 года, в которых устройства используют один сертификат устройства. При указании имени проверки необходимо указать время начала и окончания.

aws iot list-audit-findings \
    --check-name DEVICE_CERTIFICATE_SHARED_CHECK \
    --start-time 1559747125 \
    --end-time 1560962028

Вывод:

{
    "findings": [
        {
            "taskId": "eeef61068b0eb03c456d746c5a26ee04",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1560161017.172,
            "findingTime": 1560161017.592,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1560086374068"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1560081552187",
                        "DISCONNECTION_TIME": "1560086371552"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "ZipxgAIl"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559289863631",
                        "DISCONNECTION_TIME": "1560081532716"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        },
        {
            "taskId": "bade6b5efd2e1b1569822f6021b39cf5",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1559988217.27,
            "findingTime": 1559988217.655,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "xShGENLW"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559972350825"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "xShGENLW"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559255062002",
                        "DISCONNECTION_TIME": "1559972350616"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        },
        {
            "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6",
            "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK",
            "taskStartTime": 1559901817.31,
            "findingTime": 1559901817.767,
            "severity": "CRITICAL",
            "nonCompliantResource": {
                "resourceType": "DEVICE_CERTIFICATE",
                "resourceIdentifier": {
                    "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b"
                }
            },
            "relatedResources": [
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "TvnQoEoU"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559826729768"
                    }
                },
                {
                    "resourceType": "CLIENT_ID",
                    "resourceIdentifier": {
                        "clientId": "TvnQoEoU"
                    },
                    "additionalInfo": {
                        "CONNECTION_TIME": "1559345920964",
                        "DISCONNECTION_TIME": "1559826728402"
                    }
                }
            ],
            "reasonForNonCompliance": "Certificate shared by one or more devices.",
            "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES"
        }
    ]
}

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

Вывод

findings -> (список)

Результаты аудита.

(структура)

Результаты аудита.

findingId -> (строка)

Уникальный идентификатор набора результатов аудита. Этот идентификатор используется для применения мер по устранению проблем к одному или нескольким наборам результатов.

taskId -> (строка)

Идентификатор аудита, который сгенерировал этот результат (нахождение).

checkName -> (строка)

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

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

Время начала аудита.

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

Время обнаружения результата (нахождения).

severity -> (строка)

Степень серьезности результата (нахождения).

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

Ресурс, который не соответствует требованиям проверки аудита.

resourceType -> (строка)

Тип несоответствующего ресурса.

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

Информация, идентифицирующая несоответствующий ресурс.

deviceCertificateId -> (строка)

Идентификатор сертификата, прикрепленного к ресурсу.

caCertificateId -> (строка)

Идентификатор сертификата УЦ, используемого для авторизации сертификата.

cognitoIdentityPoolId -> (строка)

Идентификатор пула идентификаторов Amazon Cognito.

clientId -> (строка)

Идентификатор клиента.

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

Версия политики, связанной с ресурсом.

policyName -> (строка)

Имя политики.

policyVersionId -> (строка)

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

account -> (строка)

Аккаунт, с которым связан ресурс.

iamRoleArn -> (строка)

ARN роли IAM, имеющей избыточно разрешительные действия.

roleAliasArn -> (строка)

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

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

Идентификатор сертификата издателя.

issuerCertificateSubject -> (строка)

Подпись сертификата издателя.

issuerId -> (строка)

Идентификатор издателя.

issuerCertificateSerialNumber -> (строка)

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

deviceCertificateArn -> (строка)

ARN идентифицированного сертификата устройства.

additionalInfo -> (массив)

Дополнительная информация о несоответствующем ресурсе.

key -> (строка)

value -> (строка)

relatedResources -> (список)

Список связанных ресурсов.

(структура)

Информация о связанном ресурсе.

resourceType -> (строка)

Тип ресурса.

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

Информация, идентифицирующая ресурс.

deviceCertificateId -> (строка)

Идентификатор сертификата, прикрепленного к ресурсу.

caCertificateId -> (строка)

Идентификатор сертификата УЦ, используемого для авторизации сертификата.

cognitoIdentityPoolId -> (строка)

Идентификатор пула идентификаторов Amazon Cognito.

clientId -> (строка)

Идентификатор клиента.

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

Версия политики, связанной с ресурсом.

policyName -> (строка)

Имя политики.

policyVersionId -> (строка)

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

account -> (строка)

Аккаунт, с которым связан ресурс.

iamRoleArn -> (строка)

ARN роли IAM, имеющей избыточно разрешительные действия.

roleAliasArn -> (строка)

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

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

Идентификатор сертификата издателя.

issuerCertificateSubject -> (строка)

Подпись сертификата издателя.

issuerId -> (строка)

Идентификатор издателя.

issuerCertificateSerialNumber -> (строка)

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

deviceCertificateArn -> (строка)

ARN идентифицированного сертификата устройства.

additionalInfo -> (массив)

Дополнительная информация о ресурсе.

key -> (строка)

value -> (строка)

reasonForNonCompliance -> (строка)

Причина несоответствия ресурса.

reasonForNonComplianceCode -> (строка)

Код, указывающий причину несоответствия ресурса.

isSuppressed -> (логическое значение)

Указывает, был ли результат аудита подавлен при отчете.

nextToken -> (строка)

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