:doc:`ManagedGrafana <../../grafana>` / Paginator / ListWorkspaces

**************
ListWorkspaces
**************



.. py:class:: ManagedGrafana.Paginator.ListWorkspaces

  ::

    
    paginator = client.get_paginator('list_workspaces')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ManagedGrafana.Client.list_workspaces`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            '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'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

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

          A token to resume pagination.

          
    