AWS CLI Command Reference

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

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

taskId -> (string)

The unique identifier of the task.