AWS IoT
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

StartAuditMitigationActionsTask

Starts a task that applies a set of mitigation actions to the specified target.

Request Syntax

POST /audit/mitigationactions/tasks/taskId HTTP/1.1 Content-type: application/json { "auditCheckToActionsMapping": { "string" : [ "string" ] }, "clientRequestToken": "string", "target": { "auditCheckToReasonCodeFilter": { "string" : [ "string" ] }, "auditTaskId": "string", "findingIds": [ "string" ] } }

URI Request Parameters

The request requires the following URI parameters.

taskId

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

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Request Body

The request accepts the following data in JSON format.

auditCheckToActionsMapping

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

Type: String to array of strings map

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Maximum length of 128.

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

Required: Yes

clientRequestToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: Yes

target

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.

Type: AuditMitigationActionsTaskTarget object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "taskId": "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.

taskId

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

A limit has been exceeded.

HTTP Status Code: 410

TaskAlreadyExistsException

This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

See Also

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