/security-profiles/{securityProfileName}

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

curl --location -g --request PATCH 'https://api.iotwireless.{region}.amazonaws.com/security-profiles/' \ --header 'Content-Type: application/json' \ --data-raw '{ "securityProfileDescription": "string", "behaviors": [ { "name": "string", "metric": "string", "metricDimension": { "dimensionName": "string", "operator": "IN" }, "criteria": { "comparisonOperator": "less-than", "value": { "count": 0, "cidrs": [], "ports": [], "number": 0, "numbers": [], "strings": [] }, "durationSeconds": 0, "consecutiveDatapointsToAlarm": 0, "consecutiveDatapointsToClear": 0, "statisticalThreshold": { "statistic": "string" }, "mlDetectionConfig": { "confidenceLevel": "LOW" } }, "suppressAlerts": true } ], "alertTargets": { "property1": { "alertTargetArn": "string", "roleArn": "string" } }, "additionalMetricsToRetain": [ "string" ], "additionalMetricsToRetainV2": [ { "metric": "string", "metricDimension": {} } ], "deleteBehaviors": true, "deleteAlertTargets": true, "deleteAdditionalMetricsToRetain": true }'

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

Request

Path Params

securityProfileName

string

required

The name of the security profile you want to update.

Query Params

expectedVersion

integer

optional

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 VersionConflictException is thrown.

Body Params application/json

securityProfileDescription

string

optional

A description of the security profile.

<= 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.)

Additional properties

object (AlertTarget)

optional

A structure containing the alert target ARN and the role ARN.

additionalMetricsToRetain

array[string]

optional

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

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

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.

deleteBehaviors

boolean

optional

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

deleteAlertTargets

boolean

optional

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

deleteAdditionalMetricsToRetain

boolean

optional

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

Examples

Responses

🟢200Success

application/json

Body

securityProfileName

string

optional

The name of the security profile that was updated.

>= 1 characters<= 128 characters

Match pattern:

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

securityProfileArn

string

optional

The ARN of the security profile that was updated.

securityProfileDescription

string

optional

The description of the security profile.

<= 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

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 UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Use additionalMetricsToRetainV2.

additionalMetricsToRetainV2

array[object (MetricToRetain) {2}]

optional

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 updated version of the security profile.

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

🟠482VersionConflictException

🟠483ThrottlingException

🟠484InternalFailureException