POST

/security-profiles/{securityProfileName}

http://iot.{region}.amazonaws.com/security-profiles/{securityProfileName}

Creates a Device Defender security profile. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateSecurityProfile</a> action.

Access Token Required: API Key

Path Parameters

securityProfileNamestringrequired

The name you are giving to the security profile.

Body Params

tagsarray

Metadata that can be used to manage the security profile.

behaviorsarray

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

alertTargetsobject

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

additionalMetricsToRetainarray

Please use <a>CreateSecurityProfileRequest$additionalMetricsToRetainV2</a> instead. A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

securityProfileDescriptionstring

A description of the security profile.

additionalMetricsToRetainV2array

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://iot.{region}.amazonaws.com/security-profiles/{securityProfileName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}