POST

/audit/mitigationactions/tasks/{taskId}

http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks/{taskId}

<p>Starts a task that applies a set of mitigation actions to the specified target.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">StartAuditMitigationActionsTask</a> action.</p>

Access Token Required: API Key

Path Parameters

taskIdstringrequired

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

Body Params

targetobjectrequired

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

clientRequestTokenstringrequired

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

auditCheckToActionsMappingobjectrequired

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iot.{region}.amazonaws.com/audit/mitigationactions/tasks/{taskId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}