GET

/security-profiles

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

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListSecurityProfiles</a> action. <note> <code>dimensionName</code> and <code>metricName</code> cannot be used in the same request. </note>

Access Token Required: API Key

Query Params

nextTokenstring

The token for the next set of results.

maxResultsinteger

The maximum number of results to return at one time.

dimensionNamestring

A filter to limit results to the security profiles that use the defined dimension. Cannot be used with <code>metricName</code>

metricNamestring

The name of the custom metric. Cannot be used with <code>dimensionName</code>.

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 GET \
2     --url 'http://iot.{region}.amazonaws.com/security-profiles' \
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}