Table Of Contents

Feedback

User Guide

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

[ aws . iot ]

describe-security-profile

Description

Gets information about a Device Defender security profile.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-security-profile
--security-profile-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--security-profile-name (string)

The name of the security profile whose information you want to get.

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

Examples

To get information about a security profile

The following describe-security-profile example gets information about the AWS IoT Device Defender security profile named PossibleIssue.

aws iot describe-security-profile \
    --security-profile-name PossibleIssue

Output:

{
    "securityProfileName": "PossibleIssue",
    "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue",
    "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128",
    "behaviors": [
        {
            "name": "CellularBandwidth",
            "metric": "aws:message-byte-size",
            "criteria": {
                "comparisonOperator": "greater-than",
                "value": {
                    "count": 128
                },
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        },
        {
            "name": "Authorization",
            "metric": "aws:num-authorization-failures",
            "criteria": {
                "comparisonOperator": "greater-than",
                "value": {
                    "count": 10
                },
                "durationSeconds": 300,
                "consecutiveDatapointsToAlarm": 1,
                "consecutiveDatapointsToClear": 1
            }
        }
    ],
    "version": 1,
    "creationDate": 1560278102.528,
    "lastModifiedDate": 1560278102.528
}

For more information, see Detect Commands in the AWS IoT Developer Guide.

Output

securityProfileName -> (string)

The name of the security profile.

securityProfileArn -> (string)

The ARN of the security profile.

securityProfileDescription -> (string)

A description of the security profile (associated with the security profile when it was created or updated).

behaviors -> (list)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

(structure)

A Device Defender security profile behavior.

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 (containing a value or statisticalThreshold ).

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 time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

consecutiveDatapointsToAlarm -> (integer)

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

consecutiveDatapointsToClear -> (integer)

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

statisticalThreshold -> (structure)

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

statistic -> (string)

The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

alertTargets -> (map)

Where the alerts are sent. (Alerts are always sent to the console.)

key -> (string)

The type of alert target: one of "SNS".

value -> (structure)

A structure containing the alert target ARN and the role ARN.

alertTargetArn -> (string)

The ARN of the notification target to which alerts are sent.

roleArn -> (string)

The ARN of the role that grants permission to send alerts to the notification target.

additionalMetricsToRetain -> (list)

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors , but it is also retained for any metric specified here.

(string)

version -> (long)

The version of the security profile. A new version is generated whenever the security profile is updated.

creationDate -> (timestamp)

The time the security profile was created.

lastModifiedDate -> (timestamp)

The time the security profile was last modified.