CreateMitigationAction - AWS IoT


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.

Request Syntax

POST /mitigationactions/actions/actionName HTTP/1.1 Content-type: application/json { "actionParams": { "addThingsToThingGroupParams": { "overrideDynamicGroups": boolean, "thingGroupNames": [ "string" ] }, "enableIoTLoggingParams": { "logLevel": "string", "roleArnForLogging": "string" }, "publishFindingToSnsParams": { "topicArn": "string" }, "replaceDefaultPolicyVersionParams": { "templateName": "string" }, "updateCACertificateParams": { "action": "string" }, "updateDeviceCertificateParams": { "action": "string" } }, "roleArn": "string", "tags": [ { "Key": "string", "Value": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.


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

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.


Defines the type of action and the parameters for that action.

Type: MitigationActionParams object

Required: Yes


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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes


Metadata that can be used to manage the mitigation action.

Type: Array of Tag objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "actionArn": "string", "actionId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The ARN for the new mitigation action.

Type: String


A unique identifier for the new mitigation action.

Type: String



An unexpected error has occurred.

HTTP Status Code: 500


The request is not valid.

HTTP Status Code: 400


A limit has been exceeded.

HTTP Status Code: 410


The resource already exists.

HTTP Status Code: 409


The rate exceeds the limit.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: