:doc:`NovaActService <../../nova-act>` / Client / list_sessions

*************
list_sessions
*************



.. py:method:: NovaActService.Client.list_sessions(**kwargs)

  

  Lists all sessions within a specific workflow run.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListSessions>`_  


  **Request Syntax**
  ::

    response = client.list_sessions(
        workflowDefinitionName='string',
        workflowRunId='string',
        maxResults=123,
        nextToken='string',
        sortOrder='Ascending'|'Descending'
    )
    
  :type workflowDefinitionName: string
  :param workflowDefinitionName: **[REQUIRED]** 

    The name of the workflow definition containing the workflow run.

    

  
  :type workflowRunId: string
  :param workflowRunId: **[REQUIRED]** 

    The unique identifier of the workflow run to list sessions for.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of sessions to return in a single response.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for retrieving the next page of results.

    

  
  :type sortOrder: string
  :param sortOrder: 

    The sort order for the returned sessions (ascending or descending).

    

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

    
    ::

      {
          'sessionSummaries': [
              {
                  'sessionId': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A list of summary information for sessions in the workflow run.

        
        

        - *(dict) --* 

          Summary information about a session within a workflow run.

          
          

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

            The unique identifier of the session.

            
      
    
      

      - **nextToken** *(string) --* 

        The token for retrieving the next page of results, if available.

        
  
  **Exceptions**
  
  *   :py:class:`NovaActService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NovaActService.Client.exceptions.ConflictException`

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

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

  
  *   :py:class:`NovaActService.Client.exceptions.InternalServerException`

  
  *   :py:class:`NovaActService.Client.exceptions.ValidationException`

  