DeadlineCloud / Client / associate_member_to_farm

associate_member_to_farm

DeadlineCloud.Client.associate_member_to_farm(**kwargs)

Assigns a farm membership level to a member.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• farmId (string) –

  [REQUIRED]

  The ID of the farm to associate with the member.

• identityStoreId (string) –

  [REQUIRED]

  The identity store ID of the member to associate with the farm.

• membershipLevel (string) –

  [REQUIRED]

  The principal’s membership level for the associated farm.

• principalId (string) –

  [REQUIRED]

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

• principalType (string) –

  [REQUIRED]

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

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