:doc:`CustomerProfiles <../../customer-profiles>` / Paginator / ListRecommenders

****************
ListRecommenders
****************



.. py:class:: CustomerProfiles.Paginator.ListRecommenders

  ::

    
    paginator = client.get_paginator('list_recommenders')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CustomerProfiles.Client.list_recommenders`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenders>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DomainName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DomainName: string
    :param DomainName: **[REQUIRED]** 

      The unique name of the domain.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Recommenders': [
                {
                    'RecommenderName': 'string',
                    'RecipeName': 'recommended-for-you'|'similar-items'|'frequently-paired-items'|'popular-items'|'trending-now',
                    'RecommenderConfig': {
                        'EventsConfig': {
                            'EventParametersList': [
                                {
                                    'EventType': 'string',
                                    'EventValueThreshold': 123.0
                                },
                            ]
                        },
                        'TrainingFrequency': 123
                    },
                    'CreatedAt': datetime(2015, 1, 1),
                    'Description': 'string',
                    'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
                    'LastUpdatedAt': datetime(2015, 1, 1),
                    'Tags': {
                        'string': 'string'
                    },
                    'FailureReason': 'string',
                    'LatestRecommenderUpdate': {
                        'RecommenderConfig': {
                            'EventsConfig': {
                                'EventParametersList': [
                                    {
                                        'EventType': 'string',
                                        'EventValueThreshold': 123.0
                                    },
                                ]
                            },
                            'TrainingFrequency': 123
                        },
                        'Status': 'PENDING'|'IN_PROGRESS'|'ACTIVE'|'FAILED'|'STOPPING'|'INACTIVE'|'STARTING'|'DELETING',
                        'CreatedAt': datetime(2015, 1, 1),
                        'LastUpdatedAt': datetime(2015, 1, 1),
                        'FailureReason': 'string'
                    }
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Recommenders** *(list) --* 

          A list of recommenders and their properties in the specified domain.

          
          

          - *(dict) --* 

            Provides a summary of a recommender's configuration and current state.

            
            

            - **RecommenderName** *(string) --* 

              The name of the recommender.

              
            

            - **RecipeName** *(string) --* 

              The name of the recipe used by this recommender.

              
            

            - **RecommenderConfig** *(dict) --* 

              The configuration settings applied to this recommender.

              
              

              - **EventsConfig** *(dict) --* 

                Configuration settings for how the recommender processes and uses events.

                
                

                - **EventParametersList** *(list) --* 

                  A list of event parameters configurations that specify how different event types should be handled.

                  
                  

                  - *(dict) --* 

                    Configuration parameters for events in the personalization system.

                    
                    

                    - **EventType** *(string) --* 

                      The type of event being tracked (e.g., 'click', 'purchase', 'view').

                      
                    

                    - **EventValueThreshold** *(float) --* 

                      The minimum value threshold that an event must meet to be considered valid.

                      
                
              
            
              

              - **TrainingFrequency** *(integer) --* 

                How often the recommender should retrain its model with new data.

                
          
            

            - **CreatedAt** *(datetime) --* 

              The timestamp when the recommender was created.

              
            

            - **Description** *(string) --* 

              A description of the recommender's purpose and characteristics.

              
            

            - **Status** *(string) --* 

              The current operational status of the recommender.

              
            

            - **LastUpdatedAt** *(datetime) --* 

              The timestamp of when the recommender was edited.

              
            

            - **Tags** *(dict) --* 

              The tags used to organize, track, or control access for this resource.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
            

            - **FailureReason** *(string) --* 

              If the recommender is in a failed state, provides the reason for the failure.

              
            

            - **LatestRecommenderUpdate** *(dict) --* 

              Information about the most recent update performed on the recommender, including its status and timing.

              
              

              - **RecommenderConfig** *(dict) --* 

                The updated configuration settings applied to the recommender during this update.

                
                

                - **EventsConfig** *(dict) --* 

                  Configuration settings for how the recommender processes and uses events.

                  
                  

                  - **EventParametersList** *(list) --* 

                    A list of event parameters configurations that specify how different event types should be handled.

                    
                    

                    - *(dict) --* 

                      Configuration parameters for events in the personalization system.

                      
                      

                      - **EventType** *(string) --* 

                        The type of event being tracked (e.g., 'click', 'purchase', 'view').

                        
                      

                      - **EventValueThreshold** *(float) --* 

                        The minimum value threshold that an event must meet to be considered valid.

                        
                  
                
              
                

                - **TrainingFrequency** *(integer) --* 

                  How often the recommender should retrain its model with new data.

                  
            
              

              - **Status** *(string) --* 

                The current status of the recommender update operation.

                
              

              - **CreatedAt** *(datetime) --* 

                The timestamp when this recommender update was initiated.

                
              

              - **LastUpdatedAt** *(datetime) --* 

                The timestamp of when the recommender was edited.

                
              

              - **FailureReason** *(string) --* 

                If the update operation failed, provides the reason for the failure.

                
          
        
      
    