ManagedGrafana / Client / list_workspace_service_accounts

list_workspace_service_accounts#

ManagedGrafana.Client.list_workspace_service_accounts(**kwargs)#

Returns a list of service accounts for a workspace.

Service accounts are only available for workspaces that are compatible with Grafana version 9 and above.

See also: AWS API Documentation

Request Syntax

response = client.list_workspace_service_accounts(
    maxResults=123,
    nextToken='string',
    workspaceId='string'
)
Parameters:

  • maxResults (integer) – The maximum number of service accounts to include in the results.

  • nextToken (string) – The token for the next set of service accounts to return. (You receive this token from a previous ListWorkspaceServiceAccounts operation.)

  • workspaceId (string) –

    [REQUIRED]

    The workspace for which to list service accounts.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      The token to use when requesting the next set of service accounts.

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

Exceptions

  • ManagedGrafana.Client.exceptions.ResourceNotFoundException

  • ManagedGrafana.Client.exceptions.ThrottlingException

  • ManagedGrafana.Client.exceptions.ConflictException

  • ManagedGrafana.Client.exceptions.ValidationException

  • ManagedGrafana.Client.exceptions.AccessDeniedException

  • ManagedGrafana.Client.exceptions.InternalServerException