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

*************************************
describe_workspaces_connection_status
*************************************



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

  

  Describes the connection status of the specified WorkSpaces.

  

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


  **Request Syntax**
  ::

    response = client.describe_workspaces_connection_status(
        WorkspaceIds=[
            'string',
        ],
        NextToken='string'
    )
    
  :type WorkspaceIds: list
  :param WorkspaceIds: 

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'WorkspacesConnectionStatus': [
              {
                  'WorkspaceId': 'string',
                  'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
                  'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
                  'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **WorkspacesConnectionStatus** *(list) --* 

        Information about the connection status of the WorkSpace.

        
        

        - *(dict) --* 

          Describes the connection status of a WorkSpace.

          
          

          - **WorkspaceId** *(string) --* 

            The identifier of the WorkSpace.

            
          

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

            The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

            
          

          - **ConnectionStateCheckTimestamp** *(datetime) --* 

            The timestamp of the connection status check.

            
          

          - **LastKnownUserConnectionTimestamp** *(datetime) --* 

            The timestamp of the last known user connection.

            
      
    
      

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

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

  