Skip to content

AssociateMemberToJobRequest

Source code in docs_src/capo_deadline/types/associate_member_to_job_request.py
class AssociateMemberToJobRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the job to associate with the member.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID to associate to the member.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID to associate with the member.</p>"""
    principal_type: "capo_deadline.types.deadline_principal_type.DeadlinePrincipalType"
    """<p>The member's principal type to associate with the job.</p>"""
    identity_store_id: "capo_deadline.types.identity_store_id.IdentityStoreId"
    """<p>The member's identity store ID to associate with the job.</p>"""
    membership_level: "capo_deadline.types.membership_level.MembershipLevel"
    """<p>The principal's membership level for the associated job.</p>"""
    principal_id: (
        "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId"
    )
    """<p>The member's principal ID to associate with the job.</p>"""
    identity_center_region: NotRequired["capo_deadline.types.region.Region"]
    """<p>The Region of the IAM Identity Center instance. If not provided, the service defaults to the Region of the farm.</p>"""

farm_id instance-attribute

farm_id: FarmId

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

identity_center_region instance-attribute

identity_center_region: NotRequired[Region]

The Region of the IAM Identity Center instance. If not provided, the service defaults to the Region of the farm.

identity_store_id instance-attribute

identity_store_id: IdentityStoreId

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

job_id instance-attribute

job_id: JobId

The job ID to associate with the member.

membership_level instance-attribute

membership_level: MembershipLevel

The principal's membership level for the associated job.

principal_id instance-attribute

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

principal_type instance-attribute

principal_type: DeadlinePrincipalType

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

queue_id instance-attribute

queue_id: QueueId

The queue ID to associate to the member.