2021/09/21 - AWS IoT - 1 new2 updated api methods
Changes This release adds support for verifying, viewing and filtering AWS IoT Device Defender detect violations with four verification states.
Set a verification state and provide a description of that verification state on a violation (detect alarm).
See also: AWS API Documentation
Request Syntax
client.put_verification_state_on_violation(
violationId='string',
verificationState='FALSE_POSITIVE'|'BENIGN_POSITIVE'|'TRUE_POSITIVE'|'UNKNOWN',
verificationStateDescription='string'
)
string
[REQUIRED]
The violation ID.
string
[REQUIRED]
The verification state of the violation.
string
The description of the verification state of the violation (detect alarm).
dict
Response Syntax
{}
Response Structure
(dict) --
{'verificationState': 'FALSE_POSITIVE | BENIGN_POSITIVE | TRUE_POSITIVE | '
'UNKNOWN'}
Response {'activeViolations': {'verificationState': 'FALSE_POSITIVE | BENIGN_POSITIVE | '
'TRUE_POSITIVE | UNKNOWN',
'verificationStateDescription': 'string'}}
Lists the active violations for a given Device Defender security profile.
Requires permission to access the ListActiveViolations action.
See also: AWS API Documentation
Request Syntax
client.list_active_violations(
thingName='string',
securityProfileName='string',
behaviorCriteriaType='STATIC'|'STATISTICAL'|'MACHINE_LEARNING',
listSuppressedAlerts=True|False,
verificationState='FALSE_POSITIVE'|'BENIGN_POSITIVE'|'TRUE_POSITIVE'|'UNKNOWN',
nextToken='string',
maxResults=123
)
string
The name of the thing whose active violations are listed.
string
The name of the Device Defender security profile for which violations are listed.
string
The criteria for a behavior.
boolean
A list of all suppressed alerts.
string
The verification state of the violation (detect alarm).
string
The token for the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'activeViolations': [
{
'violationId': 'string',
'thingName': 'string',
'securityProfileName': 'string',
'behavior': {
'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
},
'lastViolationValue': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
],
'number': 123.0,
'numbers': [
123.0,
],
'strings': [
'string',
]
},
'violationEventAdditionalInfo': {
'confidenceLevel': 'LOW'|'MEDIUM'|'HIGH'
},
'verificationState': 'FALSE_POSITIVE'|'BENIGN_POSITIVE'|'TRUE_POSITIVE'|'UNKNOWN',
'verificationStateDescription': 'string',
'lastViolationTime': datetime(2015, 1, 1),
'violationStartTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
activeViolations (list) --
The list of active violations.
(dict) --
Information about an active Device Defender security profile behavior violation.
violationId (string) --
The ID of the active violation.
thingName (string) --
The name of the thing responsible for the active violation.
securityProfileName (string) --
The security profile with the behavior is in violation.
behavior (dict) --
The behavior that is being violated.
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.
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.
lastViolationValue (dict) --
The value of the metric (the measurement) that caused the most recent violation.
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) --
violationEventAdditionalInfo (dict) --
The details of a violation event.
confidenceLevel (string) --
The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
verificationState (string) --
The verification state of the violation (detect alarm).
verificationStateDescription (string) --
The description of the verification state of the violation.
lastViolationTime (datetime) --
The time the most recent violation occurred.
violationStartTime (datetime) --
The time the violation started.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.
{'verificationState': 'FALSE_POSITIVE | BENIGN_POSITIVE | TRUE_POSITIVE | '
'UNKNOWN'}
Response {'violationEvents': {'verificationState': 'FALSE_POSITIVE | BENIGN_POSITIVE | '
'TRUE_POSITIVE | UNKNOWN',
'verificationStateDescription': 'string'}}
Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
Requires permission to access the ListViolationEvents action.
See also: AWS API Documentation
Request Syntax
client.list_violation_events(
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
thingName='string',
securityProfileName='string',
behaviorCriteriaType='STATIC'|'STATISTICAL'|'MACHINE_LEARNING',
listSuppressedAlerts=True|False,
verificationState='FALSE_POSITIVE'|'BENIGN_POSITIVE'|'TRUE_POSITIVE'|'UNKNOWN',
nextToken='string',
maxResults=123
)
datetime
[REQUIRED]
The start time for the alerts to be listed.
datetime
[REQUIRED]
The end time for the alerts to be listed.
string
A filter to limit results to those alerts caused by the specified thing.
string
A filter to limit results to those alerts generated by the specified security profile.
string
The criteria for a behavior.
boolean
A list of all suppressed alerts.
string
The verification state of the violation (detect alarm).
string
The token for the next set of results.
integer
The maximum number of results to return at one time.
dict
Response Syntax
{
'violationEvents': [
{
'violationId': 'string',
'thingName': 'string',
'securityProfileName': 'string',
'behavior': {
'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
},
'metricValue': {
'count': 123,
'cidrs': [
'string',
],
'ports': [
123,
],
'number': 123.0,
'numbers': [
123.0,
],
'strings': [
'string',
]
},
'violationEventAdditionalInfo': {
'confidenceLevel': 'LOW'|'MEDIUM'|'HIGH'
},
'violationEventType': 'in-alarm'|'alarm-cleared'|'alarm-invalidated',
'verificationState': 'FALSE_POSITIVE'|'BENIGN_POSITIVE'|'TRUE_POSITIVE'|'UNKNOWN',
'verificationStateDescription': 'string',
'violationEventTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
violationEvents (list) --
The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
(dict) --
Information about a Device Defender security profile behavior violation.
violationId (string) --
The ID of the violation event.
thingName (string) --
The name of the thing responsible for the violation event.
securityProfileName (string) --
The name of the security profile whose behavior was violated.
behavior (dict) --
The behavior that was violated.
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.
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.
metricValue (dict) --
The value of the metric (the measurement).
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) --
violationEventAdditionalInfo (dict) --
The details of a violation event.
confidenceLevel (string) --
The sensitivity of anomalous behavior evaluation. Can be Low, Medium, or High.
violationEventType (string) --
The type of violation event.
verificationState (string) --
The verification state of the violation (detect alarm).
verificationStateDescription (string) --
The description of the verification state of the violation.
violationEventTime (datetime) --
The time the violation event occurred.
nextToken (string) --
A token that can be used to retrieve the next set of results, or null if there are no additional results.