/security-profile-behaviors/validate

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

POST

Validates a Device Defender security profile behaviors specification.

Requires permission to access the ValidateSecurityProfileBehaviors action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/security-profile-behaviors/validate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
        }
    ]
}'

Response Example

200 - Example 1

{
    "valid": true,
    "validationErrors": []
}

Request

Body Params application/json

behaviors

array[object (Behavior) {5}]

required

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.

Examples

Responses

🟢200Success

application/json

Body

valid

boolean

optional

True if the behaviors were valid.

validationErrors

array[object (ValidationError) {1}]

optional

The list of any errors found in the behaviors.

errorMessage

string

optional

The description of an error found in the behaviors.

<= 2048 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException

Modified at 2022-09-10 23:12:18

/thing-groups/updateThingGroupsForThing