IoT / Client / describe_security_profile

describe_security_profile#

IoT.Client.describe_security_profile(**kwargs)#

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Request Syntax

response = client.describe_security_profile(
    securityProfileName='string'
)

Parameters:

securityProfileName (string) –

[REQUIRED]

The name of the security profile whose information you want to get.

Return type:

dict

Returns:

Response Syntax

{
    'securityProfileName': 'string',
    'securityProfileArn': 'string',
    'securityProfileDescription': 'string',
    'behaviors': [
        {
            'name': 'string',
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'criteria': {
                'comparisonOperator': 'less-than'|'less-than-equals'|'greater-than'|'greater-than-equals'|'in-cidr-set'|'not-in-cidr-set'|'in-port-set'|'not-in-port-set'|'in-set'|'not-in-set',
                'value': {
                    'count': 123,
                    'cidrs': [
                        'string',
                    ],
                    'ports': [
                        123,
                    ],
                    'number': 123.0,
                    'numbers': [
                        123.0,
                    ],
                    'strings': [
                        'string',
                    ]
                },
                'durationSeconds': 123,
                'consecutiveDatapointsToAlarm': 123,
                'consecutiveDatapointsToClear': 123,
                'statisticalThreshold': {
                    'statistic': 'string'
                },
                'mlDetectionConfig': {
                    'confidenceLevel': 'LOW'|'MEDIUM'|'HIGH'
                }
            },
            'suppressAlerts': True|False,
            'exportMetric': True|False
        },
    ],
    'alertTargets': {
        'string': {
            'alertTargetArn': 'string',
            'roleArn': 'string'
        }
    },
    'additionalMetricsToRetain': [
        'string',
    ],
    'additionalMetricsToRetainV2': [
        {
            'metric': 'string',
            'metricDimension': {
                'dimensionName': 'string',
                'operator': 'IN'|'NOT_IN'
            },
            'exportMetric': True|False
        },
    ],
    'version': 123,
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'metricsExportConfig': {
        'mqttTopic': 'string',
        'roleArn': 'string'
    }
}

Response Structure

(dict) –
- securityProfileName (string) –
  
  The name of the security profile.
- securityProfileArn (string) –
  
  The ARN of the security profile.
- securityProfileDescription (string) –
  
  A description of the security profile (associated with the security profile when it was created or updated).
- behaviors (list) –
  
  Specifies the behaviors that, when violated by a device (thing), cause an alert.
  - (dict) –
    
    A Device Defender security profile behavior.
    - name (string) –
      
      The name you’ve given to the behavior.
    - metric (string) –
      
      What is measured by the behavior.
    - metricDimension (dict) –
      
      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.
      - dimensionName (string) –
        
        A unique identifier for the dimension.
      - operator (string) –
        
        Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn’t match any of the topic filters. The operator is optional: if it’s not provided (is null), it will be interpreted as IN.
    - criteria (dict) –
      
      The criteria that determine if a device is behaving normally in regard to the metric.
      
      Note
      In the IoT console, you can choose to be sent an alert through Amazon SNS when IoT Device Defender detects that a device is behaving anomalously.
      - comparisonOperator (string) –
        
        The operator that relates the thing measured ( metric) to the criteria (containing a value or statisticalThreshold). Valid operators include:
        
        string-list: in-set and not-in-set
        
        number-list: in-set and not-in-set
        
        ip-address-list: in-cidr-set and not-in-cidr-set
        
        number: less-than, less-than-equals, greater-than, and greater-than-equals
      - value (dict) –
        
        The value to be compared with the metric.
        
        count (integer) –
        
        If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
        
        cidrs (list) –
        
        If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
        
        (string) –
        
        ports (list) –
        
        If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
        
        (integer) –
        
        number (float) –
        
        The numeral value of a metric.
        
        numbers (list) –
        
        The numeral values of a metric.
        
        (float) –
        
        strings (list) –
        
        The string values of a metric.
        
        (string) –
      - durationSeconds (integer) –
        
        Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
      - consecutiveDatapointsToAlarm (integer) –
        
        If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
      - consecutiveDatapointsToClear (integer) –
        
        If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
      - statisticalThreshold (dict) –
        
        A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
        
        statistic (string) –
        
        The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period ( durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below ( comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
      - mlDetectionConfig (dict) –
        
        The configuration of an ML Detect
        
        confidenceLevel (string) –
        
        The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
    - suppressAlerts (boolean) –
      
      Suppresses alerts.
    - exportMetric (boolean) –
      
      Value indicates exporting metrics related to the behavior when it is true.
- alertTargets (dict) –
  
  Where the alerts are sent. (Alerts are always sent to the console.)
  - (string) –
    
    The type of alert target: one of “SNS”.
    - (dict) –
      
      A structure containing the alert target ARN and the role ARN.
      - alertTargetArn (string) –
        
        The Amazon Resource Name (ARN) of the notification target to which alerts are sent.
      - roleArn (string) –
        
        The ARN of the role that grants permission to send alerts to the notification target.
- additionalMetricsToRetain (list) –
  
  Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
  
  A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here.
  - (string) –
- additionalMetricsToRetainV2 (list) –
  
  A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors, but it is also retained for any metric specified here.
  - (dict) –
    
    The metric you want to retain. Dimensions are optional.
    - metric (string) –
      
      What is measured by the behavior.
    - metricDimension (dict) –
      
      The dimension of a metric. This can’t be used with custom metrics.
      - dimensionName (string) –
        
        A unique identifier for the dimension.
      - operator (string) –
        
        Defines how the dimensionValues of a dimension are interpreted. For example, for dimension type TOPIC_FILTER, the IN operator, a message will be counted only if its topic matches one of the topic filters. With NOT_IN operator, a message will be counted only if it doesn’t match any of the topic filters. The operator is optional: if it’s not provided (is null), it will be interpreted as IN.
    - exportMetric (boolean) –
      
      Value added in both Behavior and AdditionalMetricsToRetainV2 to indicate if Device Defender Detect should export the corresponding metrics.
- version (integer) –
  
  The version of the security profile. A new version is generated whenever the security profile is updated.
- creationDate (datetime) –
  
  The time the security profile was created.
- lastModifiedDate (datetime) –
  
  The time the security profile was last modified.
- metricsExportConfig (dict) –
  
  Specifies the MQTT topic and role ARN required for metric export.
  - mqttTopic (string) –
    
    The MQTT topic that Device Defender Detect should publish messages to for metrics export.
  - roleArn (string) –
    
    This role ARN has permission to publish MQTT messages, after which Device Defender Detect can assume the role and publish messages on your behalf.

Exceptions

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