CmdID / aws / aws iot

aws iot describe-security-profile

The IoT Device Defender detect feature will no longer be available to new customers starting August 31, 2026. AWS CLI reference

1 example 1 option Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

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 PossibleIssueIdentify

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

Its output, shortened

{
    "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
            }
        }
… 5 more lines

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

Options

1 in the AWS CLI reference

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