/audit/mitigationactions/tasks/{taskId}

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

Requires permission to access the StartAuditMitigationActionsTask action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/audit/mitigationactions/tasks/' \ --header 'Content-Type: application/json' \ --data-raw '{ "target": { "auditTaskId": "string", "findingIds": [], "auditCheckToReasonCodeFilter": { "property1": [ "string" ], "property2": [ "string" ] } }, "auditCheckToActionsMapping": { "property1": [ "string" ], "property2": [ "string" ] }, "clientRequestToken": "string" }'

Request

Path Params

taskId

string

required

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

Body Params application/json

target

object

required

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

auditTaskId

string

optional

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

>= 1 characters<= 40 characters

Match pattern:

[a-zA-Z0-9\-]+

findingIds

array[string]

optional

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

>= 1 items<= 25 items

auditCheckToReasonCodeFilter

object

optional

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

auditCheckToActionsMapping

object

required

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

Additional properties

array[string]

optional

>= 1 items<= 5 items

clientRequestToken

string

required

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.

>= 1 characters<= 64 characters

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

taskId

string

optional

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

>= 1 characters<= 128 characters

Match pattern:

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

🟠480InvalidRequestException

🟠481TaskAlreadyExistsException

🟠482LimitExceededException

🟠483ThrottlingException

🟠484InternalFailureException