ManagedGrafana / Paginator / ListPermissions

ListPermissions

class ManagedGrafana.Paginator.ListPermissions

paginator = client.get_paginator('list_permissions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    groupId='string',
    userId='string',
    userType='SSO_USER'|'SSO_GROUP',
    workspaceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• groupId (string) – (Optional) Limits the results to only the group that matches this ID.

• userId (string) – (Optional) Limits the results to only the user that matches this ID.

• userType (string) – (Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

• workspaceId (string) –

  [REQUIRED]

  The ID of the workspace to list permissions for. This parameter is required.

• 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

{
    'permissions': [
        {
            'role': 'ADMIN'|'EDITOR'|'VIEWER',
            'user': {
                'id': 'string',
                'type': 'SSO_USER'|'SSO_GROUP'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • permissions (list) –

    The permissions returned by the operation.

    • (dict) –

      A structure containing the identity of one user or group and the Admin, Editor, or Viewer role that they have.

      • role (string) –

        Specifies whether the user or group has the Admin, Editor, or Viewer role.

      • user (dict) –

        A structure with the ID of the user or group with this role.

        • id (string) –

          The ID of the user or group.

          Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

        • type (string) –

          Specifies whether this is a single user or a group.

  • NextToken (string) –

    A token to resume pagination.