/mitigationactions/actions/{actionName}

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Only certain types of mitigation actions can be applied to specific check names. For more information, see Mitigation actions. Each mitigation action can apply only one type of change.

Requires permission to access the CreateMitigationAction action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/mitigationactions/actions/' \ --header 'Content-Type: application/json' \ --data-raw '{ "roleArn": "stringstringstringst", "actionParams": { "updateDeviceCertificateParams": { "action": "DEACTIVATE" }, "updateCACertificateParams": { "action": "DEACTIVATE" }, "addThingsToThingGroupParams": { "thingGroupNames": [], "overrideDynamicGroups": true }, "replaceDefaultPolicyVersionParams": { "templateName": "BLANK_POLICY" }, "enableIoTLoggingParams": { "roleArnForLogging": "string", "logLevel": "INFO" }, "publishFindingToSnsParams": { "topicArn": "string" } }, "tags": [ { "Key": "string", "Value": "string" } ] }'

Request

Path Params

actionName

string

required

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

Body Params application/json

roleArn

string

required

The ARN of the IAM role that is used to apply the mitigation action.

>= 20 characters<= 2048 characters

actionParams

object

required

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

updateDeviceCertificateParams

object

optional

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

updateCACertificateParams

object

optional

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

addThingsToThingGroupParams

object

optional

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

replaceDefaultPolicyVersionParams

object

optional

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

enableIoTLoggingParams

object

optional

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

publishFindingToSnsParams

object

optional

Parameters to define a mitigation action that publishes findings to Amazon Simple Notification Service (Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

/mitigationactions/actions/{actionName}

Request

Responses