DeadlineCloud / Client / update_farm

update_farm#

DeadlineCloud.Client.update_farm(**kwargs)#

Updates a farm.

See also: AWS API Documentation

Request Syntax

response = client.update_farm(
    farmId='string',
    displayName='string',
    description='string'
)
Parameters:
  • farmId (string) –

    [REQUIRED]

    The farm ID to update.

  • displayName (string) –

    The display name of the farm to update.

    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 to update.

    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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DeadlineCloud.Client.exceptions.AccessDeniedException

  • DeadlineCloud.Client.exceptions.InternalServerErrorException

  • DeadlineCloud.Client.exceptions.ResourceNotFoundException

  • DeadlineCloud.Client.exceptions.ThrottlingException

  • DeadlineCloud.Client.exceptions.ValidationException