Skip to content

AssociateMemberToFarmRequest

Source code in docs_src/capo_deadline/types/associate_member_to_farm_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class AssociateMemberToFarmRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The ID of the farm to associate with the member.</p>"""
    principal_type: "capo_deadline.types.deadline_principal_type.DeadlinePrincipalType"
    """<p>The principal type of the member to associate with the farm.</p>"""
    identity_store_id: "capo_deadline.types.identity_store_id.IdentityStoreId"
    """<p>The identity store ID of the member to associate with the farm.</p>"""
    membership_level: "capo_deadline.types.membership_level.MembershipLevel"
    """<p>The principal's membership level for the associated farm.</p>"""
    principal_id: (
        "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId"
    )
    """<p>The member's principal ID to associate with the farm.</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 ID of the farm 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 identity store ID of the member to associate with the farm.

membership_level instance-attribute 

membership_level: MembershipLevel

The principal's membership level for the associated farm.

principal_id instance-attribute 

principal_id: IdentityCenterPrincipalId

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

principal_type instance-attribute 

principal_type: DeadlinePrincipalType

The principal type of the member to associate with the farm.