:doc:`ConnectWisdomService <../../wisdom>` / Paginator / SearchSessions

**************
SearchSessions
**************



.. py:class:: ConnectWisdomService.Paginator.SearchSessions

  ::

    
    paginator = client.get_paginator('search_sessions')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ConnectWisdomService.Client.search_sessions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assistantId='string',
          searchExpression={
              'filters': [
                  {
                      'field': 'NAME',
                      'operator': 'EQUALS',
                      'value': 'string'
                  },
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assistantId: string
    :param assistantId: **[REQUIRED]** 

      The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      

    
    :type searchExpression: dict
    :param searchExpression: **[REQUIRED]** 

      The search expression to filter results.

      

    
      - **filters** *(list) --* **[REQUIRED]** 

        The search expression filters.

        

      
        - *(dict) --* 

          A search filter.

          

        
          - **field** *(string) --* **[REQUIRED]** 

            The field on which to filter.

            

          
          - **operator** *(string) --* **[REQUIRED]** 

            The operator to use for comparing the field’s value with the provided value.

            

          
          - **value** *(string) --* **[REQUIRED]** 

            The desired field value on which to filter.

            

          
        
    
    
    :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**

      
      ::

        {
            'sessionSummaries': [
                {
                    'assistantArn': 'string',
                    'assistantId': 'string',
                    'sessionArn': 'string',
                    'sessionId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **sessionSummaries** *(list) --* 

          Summary information about the sessions.

          
          

          - *(dict) --* 

            Summary information about the session.

            
            

            - **assistantArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Wisdom assistant.

              
            

            - **assistantId** *(string) --* 

              The identifier of the Wisdom assistant.

              
            

            - **sessionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the session.

              
            

            - **sessionId** *(string) --* 

              The identifier of the session.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    