# CreateFleet
<a name="API_CreateFleet"></a>

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
<a name="API_CreateFleet_RequestSyntax"></a>

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

{
   "configuration": { ... },
   "description": "string",
   "displayName": "string",
   "hostConfiguration": { 
      "scriptBody": "string",
      "scriptTimeoutSeconds": number
   },
   "maxWorkerCount": number,
   "minWorkerCount": number,
   "roleArn": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateFleet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [clientToken](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-clientToken"></a>
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](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-uri-farmId"></a>
The farm ID of the farm to connect to the fleet.  
Pattern: `farm-[0-9a-f]{32}`   
Required: Yes

## Request Body
<a name="API_CreateFleet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configuration](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-configuration"></a>
The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.  
Type: [FleetConfiguration](API_FleetConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [description](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-description"></a>
The description of the fleet.  
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](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-displayName"></a>
The display name of the fleet.  
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

 ** [hostConfiguration](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-hostConfiguration"></a>
Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.  
Type: [HostConfiguration](API_HostConfiguration.md) object  
Required: No

 ** [maxWorkerCount](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-maxWorkerCount"></a>
The maximum number of workers for the fleet.  
 Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to `CreateWorker` before the field updates, you might exceed your fleet's maximum worker count. For example, if your `maxWorkerCount` is 10 and you currently have 9 workers, making two quick `CreateWorker` calls might successfully create 2 workers instead of 1, resulting in 11 total workers.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: Yes

 ** [minWorkerCount](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-minWorkerCount"></a>
The minimum number of workers for the fleet.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

 ** [roleArn](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-roleArn"></a>
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](#API_CreateFleet_RequestSyntax) **   <a name="deadlinecloud-CreateFleet-request-tags"></a>
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
<a name="API_CreateFleet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fleetId": "string"
}
```

## Response Elements
<a name="API_CreateFleet_ResponseElements"></a>

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](#API_CreateFleet_ResponseSyntax) **   <a name="deadlinecloud-CreateFleet-response-fleetId"></a>
The fleet ID.  
Type: String  
Pattern: `fleet-[0-9a-f]{32}` 

## Errors
<a name="API_CreateFleet_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have permission to perform the action.    
 ** context **   
Information about the resources in use when the exception was thrown.
HTTP Status Code: 403

 ** InternalServerErrorException **   
Deadline Cloud can't process your request right now. Try again later.    
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource can't be found.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** resourceId **   
The identifier of the resource that couldn't be found.  
 ** resourceType **   
The type of the resource that couldn'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.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** quotaCode **   
Identifies the quota that has been exceeded.  
 ** reason **   
A string that describes the reason the quota was exceeded.  
 ** resourceId **   
The identifier of the affected resource.  
 ** resourceType **   
The type of the affected resource  
 ** serviceCode **   
Identifies the service that exceeded the quota.
HTTP Status Code: 402

 ** ThrottlingException **   
Your request exceeded a request rate quota.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** quotaCode **   
Identifies the quota that is being throttled.  
 ** retryAfterSeconds **   
The number of seconds a client should wait before retrying the request.  
 ** serviceCode **   
Identifies the service that is being throttled.
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.    
 ** context **   
Information about the resources in use when the exception was thrown.  
 ** fieldList **   
A list of fields that failed validation.  
 ** reason **   
The reason that the request failed validation.
HTTP Status Code: 400

## See Also
<a name="API_CreateFleet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/deadline-2023-10-12/CreateFleet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/deadline-2023-10-12/CreateFleet)