NimbleStudio / Client / update_launch_profile_member

update_launch_profile_member

NimbleStudio.Client.update_launch_profile_member(**kwargs)

Update a user persona in launch profile membership.

See also: AWS API Documentation

Request Syntax

response = client.update_launch_profile_member(
    clientToken='string',
    launchProfileId='string',
    persona='USER',
    principalId='string',
    studioId='string'
)

Parameters:

• clientToken (string) –

  Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.

  This field is autopopulated if not provided.

• launchProfileId (string) –

  [REQUIRED]

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

• persona (string) –

  [REQUIRED]

  The persona.

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