Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

describe-audit-mitigation-actions-task

Описание

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

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

Синтаксис

  describe-audit-mitigation-actions-task
--task-id <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]

Параметры

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

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

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

Для отображения деталей задачи устранения действий аудита

Следующий describe-audit-mitigation-actions-task пример демонстрирует детали для указанной задачи, где ResetPolicyVersionAction была применена к обнаружению. Результаты включают время начала и окончания задачи, количество обработанных обнаружений (и результат), а также определение действия, применяемого в рамках этой задачи.

aws iot describe-audit-mitigation-actions-task \
    --task-id ResetPolicyTask01

Вывод:

{
    "taskStatus": "COMPLETED",
    "startTime": "2019-12-10T15:13:19.457000-08:00",
    "endTime": "2019-12-10T15:13:19.947000-08:00",
    "taskStatistics": {
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": {
            "totalFindingsCount": 1,
            "failedFindingsCount": 0,
            "succeededFindingsCount": 1,
            "skippedFindingsCount": 0,
            "canceledFindingsCount": 0
        }
    },
    "target": {
        "findingIds": [
            "ef4826b8-e55a-44b9-b460-5c485355371b"
        ]
    },
    "auditCheckToActionsMapping": {
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": [
            "ResetPolicyVersionAction"
        ]
    },
    "actionsDefinition": [
        {
            "name": "ResetPolicyVersionAction",
            "id": "1ea0b415-bef1-4a01-bd13-72fb63c59afb",
            "roleArn": "arn:aws:iam::123456789012:role/service-role/ReplacePolicyVersionRole",
            "actionParams": {
                "replaceDefaultPolicyVersionParams": {
                    "templateName": "BLANK_POLICY"
                }
            }
        }
    ]
}

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

Вывод

taskStatus -> (строка)

Текущий статус задачи.

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

Дата и время начала задачи.

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

Дата и время завершения или отмены задачи.

taskStatistics -> (карта)

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

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

Название проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая те, которые включены, или используйте UpdateAccountAuditConfiguration, чтобы выбрать, какие проверки включить.)

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

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

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

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

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

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

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

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

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

Количество результатов проверки, пропущенных из-за условий фильтра, указанных в параметрах команды.

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

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

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

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

auditTaskId -> (строка)

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

findingIds -> (список)

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

(строка)

auditCheckToReasonCodeFilter -> (карта)

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

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

Название проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая те, которые включены, или используйте UpdateAccountAuditConfiguration, чтобы выбрать, какие проверки включить.)

значение -> (список)

(строка)

auditCheckToActionsMapping -> (карта)

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

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

Название проверки аудита. Проверки должны быть включены для вашей учетной записи. (Используйте DescribeAccountAuditConfiguration, чтобы увидеть список всех проверок, включая те, которые включены, или используйте UpdateAccountAuditConfiguration, чтобы выбрать, какие проверки включить.)

значение -> (список)

(строка)

actionsDefinition -> (список)

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

(структура)

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

name -> (строка)

Наглядное имя для действия по устранению уязвимостей.

id -> (строка)

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

roleArn -> (строка)

ARN роли IAM, используемой для применения этого действия по устранению уязвимостей.

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

Набор параметров для этого действия по устранению уязвимостей. Параметры различаются в зависимости от типа применяемого вами действия.

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

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

action -> (строка)

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

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

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

action -> (строка)

Действие, которое вы хотите применить к сертификату CA. Поддерживается только значение DEACTIVATE.

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

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

thingGroupNames -> (список)

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

(строка)

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

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

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

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

templateName -> (строка)

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

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

Параметры для определения действия по устранению уязвимостей, которое включает протоколирование Amazon Web Services IoT Core на указанном уровне детализации.

roleArnForLogging -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM, используемой для протоколирования.

logLevel -> (строка)

Указывает тип информации, подлежащей протоколированию.

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

Параметры для определения действия по устранению уязвимостей, которое публикует результаты проверки в Amazon Simple Notification Service (Amazon SNS). Вы можете реализовать свои собственные пользовательские действия в ответ на сообщения Amazon SNS.

topicArn -> (строка)

ARN темы, в которую вы хотите опубликовать результаты проверки.

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

Spec-Zone.ru

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