NimbleStudio / Client / list_launch_profile_members

list_launch_profile_members#

NimbleStudio.Client.list_launch_profile_members(**kwargs)#

Get all users in a given launch profile membership.

See also: AWS API Documentation

Request Syntax

response = client.list_launch_profile_members(
    launchProfileId='string',
    maxResults=123,
    nextToken='string',
    studioId='string'
)
Parameters:

  • launchProfileId (string) –

    [REQUIRED]

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

  • maxResults (integer) – The max number of results to return in the response.

  • nextToken (string) – The token for the next set of results, or null if there are no more results.

  • studioId (string) –

    [REQUIRED]

    The studio ID.

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) –

      The token for the next set of results, or null if there are no more results.

Exceptions

  • NimbleStudio.Client.exceptions.ResourceNotFoundException

  • NimbleStudio.Client.exceptions.ConflictException

  • NimbleStudio.Client.exceptions.ThrottlingException

  • NimbleStudio.Client.exceptions.ValidationException

  • NimbleStudio.Client.exceptions.AccessDeniedException

  • NimbleStudio.Client.exceptions.InternalServerErrorException

  • NimbleStudio.Client.exceptions.ServiceQuotaExceededException