ManagedGrafana / Paginator / ListWorkspaces


class ManagedGrafana.Paginator.ListWorkspaces#
paginator = client.get_paginator('list_workspaces')

Creates an iterator that will paginate through responses from ManagedGrafana.Client.list_workspaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

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.

Return type:



Response Syntax

    'workspaces': [
            'authentication': {
                'providers': [
                'samlConfigurationStatus': 'CONFIGURED'|'NOT_CONFIGURED'
            'created': datetime(2015, 1, 1),
            'description': 'string',
            'endpoint': 'string',
            'grafanaVersion': 'string',
            'id': 'string',
            'modified': datetime(2015, 1, 1),
            'name': 'string',
            'notificationDestinations': [
            '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.

        • grafanaVersion (string) –

          The Grafana version that the workspace is running.

        • id (string) –

          The unique ID of the workspace.

        • 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.