AWS IoT
API Reference

DescribeSecurityProfile

Gets information about a Device Defender security profile.

Request Syntax

GET /security-profiles/securityProfileName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

securityProfileName

The name of the security profile whose information you want to get.

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "alertTargets": { "string" : { "alertTargetArn": "string", "roleArn": "string" } }, "behaviors": [ { "criteria": { "comparisonOperator": "string", "durationSeconds": number, "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.

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.

Type: String

securityProfileDescription

A description of the security profile (associated with the security profile when it was created or updated).

Type: String

Length Constraints: Maximum length of 1000.

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

securityProfileName

The name of the security profile.

Type: String

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

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

version

The version of the security profile. A new version is generated whenever the security profile is updated.

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

See Also

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