AWS IoT
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateSecurityProfile

Updates a Device Defender security profile.

Request Syntax

PATCH /security-profiles/securityProfileName?expectedVersion=expectedVersion HTTP/1.1 Content-type: application/json { "additionalMetricsToRetain": [ "string" ], "alertTargets": { "string" : { "alertTargetArn": "string", "roleArn": "string" } }, "behaviors": [ { "criteria": { "comparisonOperator": "string", "consecutiveDatapointsToAlarm": number, "consecutiveDatapointsToClear": number, "durationSeconds": number, "statisticalThreshold": { "statistic": "string" }, "value": { "cidrs": [ "string" ], "count": number, "ports": [ number ] } }, "metric": "string", "name": "string" } ], "deleteAdditionalMetricsToRetain": boolean, "deleteAlertTargets": boolean, "deleteBehaviors": boolean, "securityProfileDescription": "string" }

URI Request Parameters

The request requires the following URI parameters.

expectedVersion

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.

securityProfileName

The name of the security profile you want to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

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

Request Body

The request accepts the following data in JSON format.

additionalMetricsToRetain

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.

Type: Array of strings

Required: No

alertTargets

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

Type: String to AlertTarget object map

Valid Keys: SNS

Required: No

behaviors

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

Type: Array of Behavior objects

Array Members: Maximum number of 100 items.

Required: No

deleteAdditionalMetricsToRetain

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

Type: Boolean

Required: No

deleteAlertTargets

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

Type: Boolean

Required: No

deleteBehaviors

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

Type: Boolean

Required: No

securityProfileDescription

A description of the security profile.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{Graph}\x20]*

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "additionalMetricsToRetain": [ "string" ], "alertTargets": { "string" : { "alertTargetArn": "string", "roleArn": "string" } }, "behaviors": [ { "criteria": { "comparisonOperator": "string", "consecutiveDatapointsToAlarm": number, "consecutiveDatapointsToClear": number, "durationSeconds": number, "statisticalThreshold": { "statistic": "string" }, "value": { "cidrs": [ "string" ], "count": number, "ports": [ number ] } }, "metric": "string", "name": "string" } ], "creationDate": number, "lastModifiedDate": number, "securityProfileArn": "string", "securityProfileDescription": "string", "securityProfileName": "string", "version": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

additionalMetricsToRetain

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.

Type: Array of strings

alertTargets

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

Type: String to AlertTarget object map

Valid Keys: SNS

behaviors

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

Type: Array of Behavior objects

Array Members: Maximum number of 100 items.

creationDate

The time the security profile was created.

Type: Timestamp

lastModifiedDate

The time the security profile was last modified.

Type: Timestamp

securityProfileArn

The ARN of the security profile that was updated.

Type: String

securityProfileDescription

The description of the security profile.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: [\p{Graph}\x20]*

securityProfileName

The name of the security profile that was updated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

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

version

The updated version of the security profile.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

VersionConflictException

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

HTTP Status Code: 409

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: