v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

get/security-profiles/{securityProfileName}

Path parameters

securityProfileNamestring required

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

Response

Success

securityProfileNamestring

The name of the security profile.

securityProfileArnstring

The ARN of the security profile.

securityProfileDescriptionstring

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

alertTargetsobject

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

additionalMetricsToRetainBehaviorMetric[]
<p> <i>Please use <a>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</a> instead.</i> </p> <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>Use additionalMetricsToRetainV2.
versioninteger

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

creationDatestring date-time

The time the security profile was created.

lastModifiedDatestring date-time

The time the security profile was last modified.