Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFarm

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

Request Syntax


POST /2023-10-12/farms HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json

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

URI Request Parameters

The request uses the following URI parameters.

clientToken

The unique token which the server uses to recognize retries of the same request.

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

Request Body

The request accepts the following data in JSON format.

description

The description of the farm.

Important

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.

Type: String

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

Required: No

displayName

The display name of the farm.

Important

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.

Type: String

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

Required: Yes

kmsKeyArn

The ARN of the KMS key to use on the farm.

Type: String

Pattern: arn:(aws[a-zA-Z-]*):kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:key/[\w-]{1,120}

Required: No

tags

The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "farmId": "string"
}

Response Elements

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

The following data is returned in JSON format by the service.

farmId

The farm ID.

Type: String

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

Errors

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

ServiceQuotaExceededException

You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your AWS account.

HTTP Status Code: 402

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