:doc:`IoTTwinMaker <../../iottwinmaker>` / Client / list_workspaces

***************
list_workspaces
***************



.. py:method:: IoTTwinMaker.Client.list_workspaces(**kwargs)

  

  Retrieves information about workspaces in the current account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/ListWorkspaces>`_  


  **Request Syntax**
  ::

    response = client.list_workspaces(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at one time. The default is 25.

     

    Valid Range: Minimum value of 1. Maximum value of 250.

    

  
  :type nextToken: string
  :param nextToken: 

    The string that specifies the next page of results.

    

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

    
    ::

      {
          'workspaceSummaries': [
              {
                  'workspaceId': 'string',
                  'arn': 'string',
                  'description': 'string',
                  'linkedServices': [
                      'string',
                  ],
                  'creationDateTime': datetime(2015, 1, 1),
                  'updateDateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **workspaceSummaries** *(list) --* 

        A list of objects that contain information about the workspaces.

        
        

        - *(dict) --* 

          An object that contains information about a workspace.

          
          

          - **workspaceId** *(string) --* 

            The ID of the workspace.

            
          

          - **arn** *(string) --* 

            The ARN of the workspace.

            
          

          - **description** *(string) --* 

            The description of the workspace.

            
          

          - **linkedServices** *(list) --* 

            A list of services that are linked to the workspace.

            
            

            - *(string) --* 
        
          

          - **creationDateTime** *(datetime) --* 

            The date and time when the workspace was created.

            
          

          - **updateDateTime** *(datetime) --* 

            The date and time when the workspace was last updated.

            
      
    
      

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

        The string that specifies the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`IoTTwinMaker.Client.exceptions.InternalServerException`

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

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException`

  