DeadlineCloud / Client / get_farm

get_farm#

DeadlineCloud.Client.get_farm(**kwargs)#

Get a farm.

Request Syntax

response = client.get_farm(
    farmId='string'
)

Parameters:

farmId (string) –

[REQUIRED]

The farm ID of the farm.

Return type:

dict

Returns:

Response Syntax

{
    'farmId': 'string',
    'displayName': 'string',
    'description': 'string',
    'kmsKeyArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

(dict) –
- farmId (string) –
  
  The farm ID of the farm to get.
- displayName (string) –
  
  The display name of the farm.
  
  Warning
  This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
- description (string) –
  
  The description of the farm.
  
  Warning
  This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
- kmsKeyArn (string) –
  
  The ARN of the KMS key used on the farm.
- createdAt (datetime) –
  
  The date and time the resource was created.
- createdBy (string) –
  
  The user or system that created this resource.
- updatedAt (datetime) –
  
  The date and time the resource was updated.
- updatedBy (string) –
  
  The user or system that updated this resource.

Exceptions

DeadlineCloud.Client.exceptions.AccessDeniedException
DeadlineCloud.Client.exceptions.InternalServerErrorException
DeadlineCloud.Client.exceptions.ResourceNotFoundException
DeadlineCloud.Client.exceptions.ThrottlingException
DeadlineCloud.Client.exceptions.ValidationException