:doc:`ManagedGrafana <../../grafana>` / Client / list_workspaces

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



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

  

  Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use `DescribeWorkspace <https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListWorkspaces>`_  


  **Request Syntax**
  ::

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

    The maximum number of workspaces to include in the results.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of workspaces to return. (You receive this token from a previous ``ListWorkspaces`` operation.)

    

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

    
    ::

      {
          'nextToken': 'string',
          'workspaces': [
              {
                  'authentication': {
                      'providers': [
                          'AWS_SSO'|'SAML',
                      ],
                      'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
                  },
                  'created': datetime(2015, 1, 1),
                  'description': 'string',
                  'endpoint': 'string',
                  'grafanaToken': 'string',
                  'grafanaVersion': 'string',
                  'id': 'string',
                  'licenseType': 'ENTERPRISE'|'ENTERPRISE_FREE_TRIAL',
                  'modified': datetime(2015, 1, 1),
                  'name': 'string',
                  'notificationDestinations': [
                      'SNS',
                  ],
                  'status': 'ACTIVE'|'CREATING'|'DELETING'|'FAILED'|'UPDATING'|'UPGRADING'|'DELETION_FAILED'|'CREATION_FAILED'|'UPDATE_FAILED'|'UPGRADE_FAILED'|'LICENSE_REMOVAL_FAILED'|'VERSION_UPDATING'|'VERSION_UPDATE_FAILED',
                  'tags': {
                      'string': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The token to use when requesting the next set of workspaces.

        
      

      - **workspaces** *(list) --* 

        An array of structures that contain some information about the workspaces in the account.

        
        

        - *(dict) --* 

          A structure that contains some information about one workspace in the account.

          
          

          - **authentication** *(dict) --* 

            A structure containing information about the authentication methods used in the workspace.

            
            

            - **providers** *(list) --* 

              Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication.

              
              

              - *(string) --* 
          
            

            - **samlConfigurationStatus** *(string) --* 

              Specifies whether the workplace's user authentication method is fully configured.

              
        
          

          - **created** *(datetime) --* 

            The date that the workspace was created.

            
          

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

            The customer-entered description of the workspace.

            
          

          - **endpoint** *(string) --* 

            The URL endpoint to use to access the Grafana console in the workspace.

            
          

          - **grafanaToken** *(string) --* 

            The token that ties this workspace to a Grafana Labs account. For more information, see `Link your account with Grafana Labs <https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise>`__.

            
          

          - **grafanaVersion** *(string) --* 

            The Grafana version that the workspace is running.

            
          

          - **id** *(string) --* 

            The unique ID of the workspace.

            
          

          - **licenseType** *(string) --* 

            Specifies whether this workspace has a full Grafana Enterprise license.

             

            .. note::

              

              Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.

              

            
          

          - **modified** *(datetime) --* 

            The most recent date that the workspace was modified.

            
          

          - **name** *(string) --* 

            The name of the workspace.

            
          

          - **notificationDestinations** *(list) --* 

            The Amazon Web Services notification channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels.

            
            

            - *(string) --* 
        
          

          - **status** *(string) --* 

            The current status of the workspace.

            
          

          - **tags** *(dict) --* 

            The list of tags associated with the workspace.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`ManagedGrafana.Client.exceptions.ThrottlingException`

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

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

  