ListSecurityProfiles - AWS IoT

ListSecurityProfiles

Lists the Device Defender security profiles you've created. You can filter security profiles by dimension or custom metric.

Note

dimensionName and metricName cannot be used in the same request.

Request Syntax

GET /security-profiles?dimensionName=dimensionName&maxResults=maxResults&metricName=metricName&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

dimensionName

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

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

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

maxResults

The maximum number of results to return at one time.

Valid Range: Minimum value of 1. Maximum value of 250.

metricName

The name of the custom metric. Cannot be used with dimensionName.

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

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

nextToken

The token for the next set of results.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "securityProfileIdentifiers": [ { "arn": "string", "name": "string" } ] }

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.

nextToken

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Type: String

securityProfileIdentifiers

A list of security profile identifiers (names and ARNs).

Type: Array of SecurityProfileIdentifier objects

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: