DeadlineCloud / Client / list_farm_members

list_farm_members

DeadlineCloud.Client.list_farm_members(**kwargs)

Lists the members of a farm.

See also: AWS API Documentation

Request Syntax

response = client.list_farm_members(
    farmId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID.

• nextToken (string) – The token for the next set of results, or null to start from the beginning.

• maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Return type:

dict

Returns:

Response Syntax

{
    'members': [
        {
            'farmId': 'string',
            'principalId': 'string',
            'principalType': 'USER'|'GROUP',
            'identityStoreId': 'string',
            'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • members (list) –

    The members on the list.

    • (dict) –

      The member of a farm.

      • farmId (string) –

        The farm ID of the farm member.

      • principalId (string) –

        The principal ID of the farm member.

      • principalType (string) –

        The principal type of the farm member.

      • identityStoreId (string) –

        The identity store ID of the farm member.

      • membershipLevel (string) –

        The farm member’s membership level.

  • nextToken (string) –

    If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn’t valid, then you receive an HTTP 400 ValidationException error.

Exceptions

• DeadlineCloud.Client.exceptions.AccessDeniedException

• DeadlineCloud.Client.exceptions.InternalServerErrorException

• DeadlineCloud.Client.exceptions.ResourceNotFoundException

• DeadlineCloud.Client.exceptions.ThrottlingException

• DeadlineCloud.Client.exceptions.ValidationException