behavior_model_training_summaries

Creates, updates, deletes, gets or lists a behavior_model_training_summaries resource.

Overview

Name	behavior_model_training_summaries
Type	Resource
Id	aws.iot.behavior_model_training_summaries

Fields

The following fields are returned by SELECT queries:

get_behavior_model_training_summaries

Name	Datatype	Description
behavior_name	string	The name of the behavior. (pattern: <code>[a-zA-Z0-9:_-]+</code>)
datapoints_collection_percentage	number (double)	The percentage of datapoints collected.
last_model_refresh_date	string (date-time)	The date the model was last refreshed.
model_status	string	The status of the behavior model. (PENDING_BUILD, ACTIVE, EXPIRED)
security_profile_name	string	The name of the security profile. (pattern: <code>[a-zA-Z0-9:_-]+</code>)
training_data_collection_start_date	string (date-time)	The date a training model started collecting data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_behavior_model_training_summaries	select	region	securityProfileName, maxResults, nextToken	Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
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.
securityProfileName	string	The name of the security profile.

SELECT examples

get_behavior_model_training_summaries

Returns a Device Defender's ML Detect Security Profile training model's status. Requires permission to access the GetBehaviorModelTrainingSummaries action.

SELECT
behavior_name,
datapoints_collection_percentage,
last_model_refresh_date,
model_status,
security_profile_name,
training_data_collection_start_date
FROM aws.iot.behavior_model_training_summaries
WHERE region = '{{ region }}' -- required
AND securityProfileName = '{{ securityProfileName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;