Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

create-mitigation-action

Описание

Определяет действие, которое может быть применено к результатам аудита с помощью StartAuditMitigationActionsTask. Только определённые типы действий по смягчению последствий могут быть применены к определённым именам проверок. Дополнительную информацию см. в разделе Действия по смягчению последствий . Каждое действие по смягчению последствий может применить только один тип изменения.

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

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

Синтаксис

  create-mitigation-action
--action-name <value>
--role-arn <value>
--action-params <value>
[--tags <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]

Параметры

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

Дружественное имя для действия. Выберите дружественное имя, которое точно описывает действие (например, EnableLoggingAction ).

--role-arn (строка)

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

--action-params (структура)

Определяет тип действия и параметры этого действия.

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

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

action -> (строка)

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

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

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

action -> (строка)

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

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

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

thingGroupNames -> (список)

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

(строка)

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

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

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

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

templateName -> (строка)

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

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

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

roleArnForLogging -> (строка)

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

logLevel -> (строка)

Определяет тип информации, которая должна быть залогирована.

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

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

topicArn -> (строка)

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

Краткая запись синтаксиса:

updateDeviceCertificateParams={action=string},updateCACertificateParams={action=string},addThingsToThingGroupParams={thingGroupNames=[string,string],overrideDynamicGroups=boolean},replaceDefaultPolicyVersionParams={templateName=string},enableIoTLoggingParams={roleArnForLogging=string,logLevel=string},publishFindingToSnsParams={topicArn=string}

Синтаксис JSON:

{
  "updateDeviceCertificateParams": {
    "action": "DEACTIVATE"
  },
  "updateCACertificateParams": {
    "action": "DEACTIVATE"
  },
  "addThingsToThingGroupParams": {
    "thingGroupNames": ["string", ...],
    "overrideDynamicGroups": true|false
  },
  "replaceDefaultPolicyVersionParams": {
    "templateName": "BLANK_POLICY"
  },
  "enableIoTLoggingParams": {
    "roleArnForLogging": "string",
    "logLevel": "DEBUG"|"INFO"|"ERROR"|"WARN"|"DISABLED"
  },
  "publishFindingToSnsParams": {
    "topicArn": "string"
  }
}

--tags (список)

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

(структура)

Набор пар «ключ-значение», которые используются для управления ресурсом.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Краткая запись синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--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
  • таблица
  • 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.

Примеры

Примечание

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

За исключением случаев, когда указано иное, все примеры используют правила цитирования, аналогичные правилам UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для создания действия по смягчению последствий

Следующий create-mitigation-action пример определяет действие по смягчению последствий под названием AddThingsToQuarantineGroup1Action, которое при применении перемещает вещи в группу вещей под названием QuarantineGroup1. Это действие переопределяет динамические группы вещей.

aws iot create-mitigation-action --cli-input-json file::params.json

Содержимое params.json:

{
    "actionName": "AddThingsToQuarantineGroup1Action",
    "actionParams": {
        "addThingsToThingGroupParams": {
            "thingGroupNames": [
                "QuarantineGroup1"
            ],
            "overrideDynamicGroups": true
        }
    },
    "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole"
}

Вывод:

{
    "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action",
    "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1"
}

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

Вывод

actionArn -> (строка)

ARN нового действия по смягчению последствий.

actionId -> (строка)

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

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

Spec-Zone.ru

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