IoT / Client / get_behavior_model_training_summaries
get_behavior_model_training_summaries#
- IoT.Client.get_behavior_model_training_summaries(**kwargs)#
Returns a Device Defender’s ML Detect Security Profile training model’s status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.
See also: AWS API Documentation
Request Syntax
response = client.get_behavior_model_training_summaries( securityProfileName='string', maxResults=123, nextToken='string' )
- Parameters:
securityProfileName (string) – The name of the security profile.
maxResults (integer) – The maximum number of results to return at one time. The default is 10.
nextToken (string) – The token for the next set of results.
- Return type:
dict
- Returns:
Response Syntax
{ 'summaries': [ { 'securityProfileName': 'string', 'behaviorName': 'string', 'trainingDataCollectionStartDate': datetime(2015, 1, 1), 'modelStatus': 'PENDING_BUILD'|'ACTIVE'|'EXPIRED', 'datapointsCollectionPercentage': 123.0, 'lastModelRefreshDate': datetime(2015, 1, 1) }, ], 'nextToken': 'string' }
Response Structure
(dict) –
summaries (list) –
A list of all ML Detect behaviors and their model status for a given Security Profile.
(dict) –
The summary of an ML Detect behavior model.
securityProfileName (string) –
The name of the security profile.
behaviorName (string) –
The name of the behavior.
trainingDataCollectionStartDate (datetime) –
The date a training model started collecting data.
modelStatus (string) –
The status of the behavior model.
datapointsCollectionPercentage (float) –
The percentage of datapoints collected.
lastModelRefreshDate (datetime) –
The date the model was last refreshed.
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