IoT / Client / list_security_profiles

list_security_profiles#

IoT.Client.list_security_profiles(**kwargs)#

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

Requires permission to access the ListSecurityProfiles action.

Note

dimensionName and metricName cannot be used in the same request.

Request Syntax

response = client.list_security_profiles(
    nextToken='string',
    maxResults=123,
    dimensionName='string',
    metricName='string'
)

Parameters:

nextToken (string) – The token for the next set of results.
maxResults (integer) – The maximum number of results to return at one time.
dimensionName (string) – A filter to limit results to the security profiles that use the defined dimension. Cannot be used with metricName
metricName (string) – The name of the custom metric. Cannot be used with dimensionName.

Return type:

dict

Returns:

Response Syntax

{
    'securityProfileIdentifiers': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- securityProfileIdentifiers (list) –
  
  A list of security profile identifiers (names and ARNs).
  - (dict) –
    
    Identifying information for a Device Defender security profile.
    - name (string) –
      
      The name you’ve given to the security profile.
    - arn (string) –
      
      The ARN of the security profile.
- nextToken (string) –
  
  A token that can be used to retrieve the next set of results, or null if there are no additional results.

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.InternalFailureException
IoT.Client.exceptions.ResourceNotFoundException