get_studio_member

get_studio_member(**kwargs)

Get a user's membership in a studio.

See also: AWS API Documentation

Request Syntax

response = client.get_studio_member(
    principalId='string',
    studioId='string'
)
Parameters
  • 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': 'ADMINISTRATOR',
        '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