CreateWorker
Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
Request Syntax
POST /2023-10-12/farms/farmId/fleets/fleetId/workers HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"hostProperties": {
"hostName": "string",
"ipAddresses": {
"ipV4Addresses": [ "string" ],
"ipV6Addresses": [ "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 worker.
Pattern:
farm-[0-9a-f]{32}Required: Yes
- fleetId
-
The fleet ID to connect to the worker.
Pattern:
fleet-[0-9a-f]{32}Required: Yes
Request Body
The request accepts the following data in JSON format.
- hostProperties
-
The IP address and host name of the worker.
Type: HostPropertiesRequest object
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"workerId": "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.
- workerId
-
The worker ID.
Type: String
Pattern:
worker-[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
- ConflictException
-
Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
HTTP Status Code: 409
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
