DeadlineCloud / Client / list_farms

list_farms#

DeadlineCloud.Client.list_farms(**kwargs)#

Lists farms.

Request Syntax

response = client.list_farms(
    maxResults=123,
    nextToken='string',
    principalId='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken (string) – The token for the next set of results, or null to start from the beginning.
principalId (string) – The principal ID of the member to list on the farm.

Return type:

dict

Returns:

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) –
  
  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.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException