Own AWS? Customize your docs with AI search, analytics, and more.

PATCH

/security-profiles/{securityProfileName}

http://iot.{region}.amazonaws.com/security-profiles/{securityProfileName}

Updates a Device Defender security profile. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateSecurityProfile</a> action.

Access Token Required: API Key

Path Parameters

securityProfileNamestringrequired

The name of the security profile you want to update.

Query Params

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.

Body Params

behaviorsarray

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

alertTargetsobject

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

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.

additionalMetricsToRetainarray

Please use <a>UpdateSecurityProfileRequest$additionalMetricsToRetainV2</a> instead. 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.

securityProfileDescriptionstring

A description of the security profile.

additionalMetricsToRetainV2array

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. Can be used with custom metrics; cannot be used with dimensions.

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://iot.{region}.amazonaws.com/security-profiles/{securityProfileName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}