DeadlineCloud / Client / associate_member_to_job

associate_member_to_job#

DeadlineCloud.Client.associate_member_to_job(**kwargs)#

Assigns a job membership level to a member

See also: AWS API Documentation

Request Syntax

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

  • farmId (string) –

    [REQUIRED]

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

  • queueId (string) –

    [REQUIRED]

    The queue ID to associate to the member.

  • jobId (string) –

    [REQUIRED]

    The job ID to associate with the member.

  • principalId (string) –

    [REQUIRED]

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

  • principalType (string) –

    [REQUIRED]

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

  • identityStoreId (string) –

    [REQUIRED]

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

  • membershipLevel (string) –

    [REQUIRED]

    The principal’s membership level for the associated job.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions