Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

list-active-violations

Description

Lists the active violations for a given Device Defender security profile.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-active-violations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: activeViolations

Synopsis

  list-active-violations
[--thing-name <value>]
[--security-profile-name <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--thing-name (string)

The name of the thing whose active violations are listed.

--security-profile-name (string)

The name of the Device Defender security profile for which violations are listed.

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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

activeViolations -> (list)

The list of active violations.

(structure)

Information about an active Device Defender security profile behavior violation.

violationId -> (string)

The ID of the active violation.

thingName -> (string)

The name of the thing responsible for the active violation.

securityProfileName -> (string)

The security profile whose behavior is in violation.

behavior -> (structure)

The behavior which is being violated.

name -> (string)

The name you have given to the behavior.

metric -> (string)

What is measured by the behavior.

criteria -> (structure)

The criteria that determine if a device is behaving normally in regard to the metric .

comparisonOperator -> (string)

The operator that relates the thing measured (metric ) to the criteria (value ).

value -> (structure)

The value to be compared with the metric .

count -> (long)

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

cidrs -> (list)

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

(string)

ports -> (list)

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

(integer)

durationSeconds -> (integer)

Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).

lastViolationValue -> (structure)

The value of the metric (the measurement) which caused the most recent violation.

count -> (long)

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

cidrs -> (list)

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

(string)

ports -> (list)

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

(integer)

lastViolationTime -> (timestamp)

The time the most recent violation occurred.

violationStartTime -> (timestamp)

The time the violation started.

nextToken -> (string)

A token that can be used to retrieve the next set of results, or null if there are no additional results.