/security-profiles/{securityProfileName}

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

{ "securityProfileName": "string", "securityProfileArn": "string", "securityProfileDescription": "string", "behaviors": [], "alertTargets": { "property1": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [], "additionalMetricsToRetainV2": [], "version": 0, "creationDate": "string", "lastModifiedDate": "string" }

Responses

🟢200Success

application/json

Body

securityProfileName

string

optional

The name of the security profile.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

securityProfileArn

string

optional

The ARN of the security profile.

securityProfileDescription

string

optional

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

<= 1000 characters

Match pattern:

[\p{Graph}\x20]*

behaviors

array[object (Behavior) {5}]

optional

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

<= 100 items

name

string

required

The name you've given to the behavior.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

metric

string

optional

What is measured by the behavior.

metricDimension

object

optional

The dimension for a metric in your behavior. For example, using a TOPIC_FILTER dimension, you can narrow down the scope of the metric to only MQTT topics where the name matches the pattern specified in the dimension. This can't be used with custom metrics.

criteria

object

optional

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

suppressAlerts

boolean

optional

Suppresses alerts.

alertTargets

object

optional

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

additionalMetricsToRetain

array[string]

deprecated

Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.

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.

Use additionalMetricsToRetainV2.

additionalMetricsToRetainV2

array[object (MetricToRetain) {2}]

optional

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.

metric

string

required

What is measured by the behavior.

metricDimension

object

optional

The dimension of a metric. This can't be used with custom metrics.

version

integer

optional

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

creationDate

string <date-time>

optional

The time the security profile was created.

lastModifiedDate

string <date-time>

optional

The time the security profile was last modified.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException