v1

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

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

post/security-profiles/{securityProfileName}

Path parameters

securityProfileNamestring required

The name you are giving to the security profile.

Request body

securityProfileDescriptionstring

A description of the security profile.

alertTargetsobject

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

additionalMetricsToRetainBehaviorMetric[]
<p> <i>Please use <a>CreateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.</p>

Response

Success

securityProfileNamestring

The name you gave to the security profile.

securityProfileArnstring

The ARN of the security profile.