DeadlineCloud / Paginator / ListFarms


class DeadlineCloud.Paginator.ListFarms#
paginator = client.get_paginator('list_farms')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • principalId (string) – The principal ID of the member to list on the farm.

  • 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

    'farms': [
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'displayName': 'string',
            'farmId': 'string',
            'kmsKeyArn': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • farms (list) –

      Farms on the list.

      • (dict) –

        The summary of details for a farm.

        • createdAt (datetime) –

          The date and time the resource was created.

        • createdBy (string) –

          The user or system that created this resource.

        • displayName (string) –

          The display name of the farm.

        • farmId (string) –

          The farm ID.

        • kmsKeyArn (string) –

          The ARN for the KMS key.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

    • NextToken (string) –

      A token to resume pagination.