:doc:`WorkSpaces <../../workspaces>` / Client / describe_workspaces_pool_sessions

*********************************
describe_workspaces_pool_sessions
*********************************



.. py:method:: WorkSpaces.Client.describe_workspaces_pool_sessions(**kwargs)

  

  Retrieves a list that describes the streaming sessions for a specified pool.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolSessions>`_  


  **Request Syntax**
  ::

    response = client.describe_workspaces_pool_sessions(
        PoolId='string',
        UserId='string',
        Limit=123,
        NextToken='string'
    )
    
  :type PoolId: string
  :param PoolId: **[REQUIRED]** 

    The identifier of the pool.

    

  
  :type UserId: string
  :param UserId: 

    The identifier of the user.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum size of each page of results. The default value is 20 and the maximum value is 50.

    

  
  :type NextToken: string
  :param NextToken: 

    If you received a ``NextToken`` from a previous call that was paginated, provide this token to receive the next set of results.

    

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

    
    ::

      {
          'Sessions': [
              {
                  'AuthenticationType': 'SAML',
                  'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
                  'SessionId': 'string',
                  'InstanceId': 'string',
                  'PoolId': 'string',
                  'ExpirationTime': datetime(2015, 1, 1),
                  'NetworkAccessConfiguration': {
                      'EniPrivateIpAddress': 'string',
                      'EniId': 'string'
                  },
                  'StartTime': datetime(2015, 1, 1),
                  'UserId': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Sessions** *(list) --* 

        Describes the pool sessions.

        
        

        - *(dict) --* 

          Describes a pool session.

          
          

          - **AuthenticationType** *(string) --* 

            The authentication method. The user is authenticated using a WorkSpaces Pools URL (API) or SAML 2.0 federation (SAML).

            
          

          - **ConnectionState** *(string) --* 

            Specifies whether a user is connected to the pool session.

            
          

          - **SessionId** *(string) --* 

            The identifier of the session.

            
          

          - **InstanceId** *(string) --* 

            The identifier for the instance hosting the session.

            
          

          - **PoolId** *(string) --* 

            The identifier of the pool.

            
          

          - **ExpirationTime** *(datetime) --* 

            The time that the pool session ended.

            
          

          - **NetworkAccessConfiguration** *(dict) --* 

            Describes the network details of the pool.

            
            

            - **EniPrivateIpAddress** *(string) --* 

              The private IP address of the elastic network interface that is attached to instances in your VPC.

              
            

            - **EniId** *(string) --* 

              The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

              
        
          

          - **StartTime** *(datetime) --* 

            The time that the pool sission started.

            
          

          - **UserId** *(string) --* 

            The identifier of the user.

            
      
    
      

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

        If you received a ``NextToken`` from a previous call that was paginated, provide this token to receive the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`WorkSpaces.Client.exceptions.InvalidParameterValuesException`

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

  
  *   :py:class:`WorkSpaces.Client.exceptions.AccessDeniedException`

  