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

CreateFleet

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

Request Syntax


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

{
   "configuration": { ... },
   "description": "string",
   "displayName": "string",
   "maxWorkerCount": number,
   "minWorkerCount": number,
   "roleArn": "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.

farmId

The farm ID of the farm to connect to the fleet.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

Type: FleetConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

description

The description of the fleet.

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 fleet.

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

maxWorkerCount

The maximum number of workers for the fleet.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: Yes

minWorkerCount

The minimum number of workers for the fleet.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: No

roleArn

The IAM role ARN for the role that the fleet's workers will use.

Type: String

Pattern: arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+

Required: Yes

tags

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

{
   "fleetId": "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.

fleetId

The fleet ID.

Type: String

Pattern: fleet-[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