Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_launch_profile_member

get_launch_profile_member(**kwargs)

Get a user persona in launch profile membership.

See also: AWS API Documentation

Request Syntax

response = client.get_launch_profile_member(
    launchProfileId='string',
    principalId='string',
    studioId='string'
)
Parameters
  • launchProfileId (string) --

    [REQUIRED]

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

  • principalId (string) --

    [REQUIRED]

    The principal ID. This currently supports a IAM Identity Center UserId.

  • studioId (string) --

    [REQUIRED]

    The studio ID.

Return type

dict

Returns

Response Syntax

{
    'member': {
        'identityStoreId': 'string',
        'persona': 'USER',
        'principalId': 'string',
        'sid': 'string'
    }
}

Response Structure

  • (dict) --

    • member (dict) --

      The member.

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

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