DeadlineCloud / Paginator / ListFarmMembers


class DeadlineCloud.Paginator.ListFarmMembers#
paginator = client.get_paginator('list_farm_members')

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_farm_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'members': [
            'farmId': 'string',
            'identityStoreId': 'string',
            'membershipLevel': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'MANAGER',
            'principalId': 'string',
            'principalType': 'USER'|'GROUP'
    '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.

        • identityStoreId (string) –

          The identity store ID of the farm member.

        • membershipLevel (string) –

          The farm member’s membership level.

        • principalId (string) –

          The principal ID of the farm member.

        • principalType (string) –

          The principal type of the farm member.

    • NextToken (string) –

      A token to resume pagination.