UpdateFarm

Updates a farm.

Request Syntax


PATCH /2023-10-12/farms/farmId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "displayName": "string"
}

The request uses the following URI parameters.

The farm ID to update.

Pattern: ^farm-[0-9a-f]{32}$

Required: Yes

The request accepts the following data in JSON format.

The description of the farm to update.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Required: No

The display name of the farm to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No


HTTP/1.1 200

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400