NimbleStudio / Paginator / ListLaunchProfileMembers

ListLaunchProfileMembers

class NimbleStudio.Paginator.ListLaunchProfileMembers

paginator = client.get_paginator('list_launch_profile_members')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• launchProfileId (string) –

  [REQUIRED]

  The ID of the launch profile used to control access from the streaming session.

• 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': 'USER',
            'principalId': 'string',
            'sid': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • members (list) –

    A list of members.

    • (dict) –

      Studio admins can use launch profile membership to delegate launch profile access to studio users in the Nimble Studio portal without writing or maintaining complex IAM policies. A launch profile member is a user association from your studio identity source who is granted permissions to a launch profile.

      A launch profile member (type USER) provides the following permissions to that launch profile:

      • GetLaunchProfile

      • GetLaunchProfileInitialization

      • GetLaunchProfileMembers

      • GetLaunchProfileMember

      • CreateStreamingSession

      • GetLaunchProfileDetails

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