IoT / Paginator / GetBehaviorModelTrainingSummaries


class IoT.Paginator.GetBehaviorModelTrainingSummaries#
paginator = client.get_paginator('get_behavior_model_training_summaries')

Creates an iterator that will paginate through responses from IoT.Client.get_behavior_model_training_summaries().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • securityProfileName (string) – The name of the security profile.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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 to resume pagination.