Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iot ]

start-detect-mitigation-actions-task

Description

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-detect-mitigation-actions-task
--task-id <value>
--target <value>
--actions <value>
[--violation-event-occurrence-range <value>]
[--include-only-active-violations | --no-include-only-active-violations]
[--include-suppressed-alerts | --no-include-suppressed-alerts]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--task-id (string)

The unique identifier of the task.

--target (structure)

Specifies the ML Detect findings to which the mitigation actions are applied.

violationIds -> (list)

The unique identifiers of the violations.

(string)

securityProfileName -> (string)

The name of the security profile.

behaviorName -> (string)

The name of the behavior.

Shorthand Syntax:

violationIds=string,string,securityProfileName=string,behaviorName=string

JSON Syntax:

{
  "violationIds": ["string", ...],
  "securityProfileName": "string",
  "behaviorName": "string"
}

--actions (list)

The actions to be performed when a device has unexpected behavior.

(string)

Syntax:

"string" "string" ...

--violation-event-occurrence-range (structure)

Specifies the time period of which violation events occurred between.

startTime -> (timestamp)

The start date and time of a time period in which violation events occurred.

endTime -> (timestamp)

The end date and time of a time period in which violation events occurred.

Shorthand Syntax:

startTime=timestamp,endTime=timestamp

JSON Syntax:

{
  "startTime": timestamp,
  "endTime": timestamp
}

--include-only-active-violations | --no-include-only-active-violations (boolean)

Specifies to list only active violations.

--include-suppressed-alerts | --no-include-suppressed-alerts (boolean)

Specifies to include suppressed alerts.

--client-request-token (string)

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

taskId -> (string)

The unique identifier of the task.