:doc:`IoT <../../iot>` / Client / get_behavior_model_training_summaries

*************************************
get_behavior_model_training_summaries
*************************************



.. py:method:: 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 <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/GetBehaviorModelTrainingSummaries>`_  


  **Request Syntax**
  ::

    response = client.get_behavior_model_training_summaries(
        securityProfileName='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type securityProfileName: string
  :param securityProfileName: 

    The name of the security profile.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at one time. The default is 10.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results.

    

  
  
  :rtype: 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**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoT.Client.exceptions.ResourceNotFoundException`

  