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

UpdateFleet

Updates a fleet.

Request Syntax


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

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

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

Required: Yes

fleetId

The fleet ID to update.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

The fleet configuration to update.

Type: FleetConfiguration object

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

Required: No

description

The description of the fleet to update.

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

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: No

maxWorkerCount

The maximum number of workers in the fleet.

Type: Integer

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

Required: No

minWorkerCount

The minimum number of workers in the fleet.

Type: Integer

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

Required: No

roleArn

The IAM role ARN that the fleet's workers assume while running jobs.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

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