ManagedGrafana / Paginator / ListWorkspaceServiceAccounts

ListWorkspaceServiceAccounts#

class ManagedGrafana.Paginator.ListWorkspaceServiceAccounts#
paginator = client.get_paginator('list_workspace_service_accounts')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workspaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • workspaceId (string) –

    [REQUIRED]

    The workspace for which to list service accounts.

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

dict

Returns:

Response Syntax

{
    'serviceAccounts': [
        {
            'grafanaRole': 'ADMIN'|'EDITOR'|'VIEWER',
            'id': 'string',
            'isDisabled': 'string',
            'name': 'string'
        },
    ],
    'workspaceId': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • serviceAccounts (list) –

      An array of structures containing information about the service accounts.

      • (dict) –

        A structure that contains the information about one service account.

        • grafanaRole (string) –

          The role of the service account, which sets the permission level used when calling Grafana APIs.

        • id (string) –

          The unique ID of the service account.

        • isDisabled (string) –

          Returns true if the service account is disabled. Service accounts can be disabled and enabled in the Amazon Managed Grafana console.

        • name (string) –

          The name of the service account.

    • workspaceId (string) –

      The workspace to which the service accounts are associated.

    • NextToken (string) –

      A token to resume pagination.