NimbleStudio / Paginator / ListStudioMembers

ListStudioMembers

class NimbleStudio.Paginator.ListStudioMembers

paginator = client.get_paginator('list_studio_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NimbleStudio.Client.list_studio_members().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• studioId (string) –

  [REQUIRED]

  The studio ID.

• 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

{
    'members': [
        {
            'identityStoreId': 'string',
            'persona': 'ADMINISTRATOR',
            'principalId': 'string',
            'sid': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • members (list) –

    A list of admin members.

    • (dict) –

      A studio member is an association of a user from your studio identity source to elevated permissions that they are granted in the studio.

      When you add a user to your studio using the Nimble Studio console, they are given access to the studio’s IAM Identity Center application and are given access to log in to the Nimble Studio portal. These users have the permissions provided by the studio’s user IAM role and do not appear in the studio membership collection. Only studio admins appear in studio membership.

      When you add a user to studio membership with the ADMIN persona, upon logging in to the Nimble Studio portal, they are granted permissions specified by the Studio’s Admin IAM role.

      • identityStoreId (string) –

        The ID of the identity store.

      • persona (string) –

        The persona.

      • principalId (string) –

        The principal ID.

      • sid (string) –

        The Active Directory Security Identifier for this user, if available.

  • NextToken (string) –

    A token to resume pagination.