DescribeSecurityProfile
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
Request Syntax
GET /security-profiles/securityProfileName HTTP/1.1
URI Request Parameters
The request uses 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:_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"additionalMetricsToRetain": [ "string" ],
"additionalMetricsToRetainV2": [
{
"exportMetric": boolean,
"metric": "string",
"metricDimension": {
"dimensionName": "string",
"operator": "string"
}
}
],
"alertTargets": {
"string" : {
"alertTargetArn": "string",
"roleArn": "string"
}
},
"behaviors": [
{
"criteria": {
"comparisonOperator": "string",
"consecutiveDatapointsToAlarm": number,
"consecutiveDatapointsToClear": number,
"durationSeconds": number,
"mlDetectionConfig": {
"confidenceLevel": "string"
},
"statisticalThreshold": {
"statistic": "string"
},
"value": {
"cidrs": [ "string" ],
"count": number,
"number": number,
"numbers": [ number ],
"ports": [ number ],
"strings": [ "string" ]
}
},
"exportMetric": boolean,
"metric": "string",
"metricDimension": {
"dimensionName": "string",
"operator": "string"
},
"name": "string",
"suppressAlerts": boolean
}
],
"creationDate": number,
"lastModifiedDate": number,
"metricsExportConfig": {
"mqttTopic": "string",
"roleArn": "string"
},
"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
-
This parameter has been deprecated.
Please use DescribeSecurityProfile: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.Type: Array of strings
- additionalMetricsToRetainV2
-
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 MetricToRetain objects
- 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
- metricsExportConfig
-
Specifies the MQTT topic and role ARN required for metric export.
Type: MetricsExportConfig object
- 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: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
