DeadlineCloud / Client / associate_member_to_queue

associate_member_to_queue

DeadlineCloud.Client.associate_member_to_queue(**kwargs)

Assigns a queue membership level to a member

See also: AWS API Documentation

Request Syntax

response = client.associate_member_to_queue(
    farmId='string',
    queueId='string',
    principalId='string',
    principalType='USER'|'GROUP',
    identityStoreId='string',
    membershipLevel='VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the queue to associate with the member.

• queueId (string) –

  [REQUIRED]

  The ID of the queue to associate to the member.

• principalId (string) –

  [REQUIRED]

  The member’s principal ID to associate with the queue.

• principalType (string) –

  [REQUIRED]

  The member’s principal type to associate with the queue.

• identityStoreId (string) –

  [REQUIRED]

  The member’s identity store ID to associate with the queue.

• membershipLevel (string) –

  [REQUIRED]

  The principal’s membership level for the associated queue.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException

• DeadlineCloud.Client.exceptions.ServiceQuotaExceededException