Sign in

v1

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

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

patch/security-profiles/{securityProfileName}

Path parameters

securityProfileNamestring required

The name of the security profile you want to update.

Query parameters

expectedVersioninteger

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a <code>VersionConflictException</code> is thrown.

Request body

securityProfileDescriptionstring

A description of the security profile.

alertTargetsobject

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

additionalMetricsToRetainBehaviorMetric[]
<p> <i>Please use <a>UpdateSecurityProfileRequest$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>
deleteBehaviorsboolean

If true, delete all <code>behaviors</code> defined for this security profile. If any <code>behaviors</code> are defined in the current invocation, an exception occurs.

deleteAlertTargetsboolean

If true, delete all <code>alertTargets</code> defined for this security profile. If any <code>alertTargets</code> are defined in the current invocation, an exception occurs.

deleteAdditionalMetricsToRetainboolean

If true, delete all <code>additionalMetricsToRetain</code> defined for this security profile. If any <code>additionalMetricsToRetain</code> are defined in the current invocation, an exception occurs.

Response

Success

securityProfileNamestring

The name of the security profile that was updated.

securityProfileArnstring

The ARN of the security profile that was updated.

securityProfileDescriptionstring

The description of the security profile.

alertTargetsobject

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

additionalMetricsToRetainBehaviorMetric[]
<p> <i>Please use <a>UpdateSecurityProfileResponse$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 security profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>Use additionalMetricsToRetainV2.
versioninteger

The updated version of the security profile.

creationDatestring date-time

The time the security profile was created.

lastModifiedDatestring date-time

The time the security profile was last modified.