GetWorker - AWS Deadline Cloud
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetWorker

Gets a worker.

Request Syntax

GET /2023-10-12/farms/farmId/fleets/fleetId/workers/workerId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID for the worker.

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

Required: Yes

fleetId

The fleet ID of the worker.

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

Required: Yes

workerId

The worker ID.

Pattern: ^worker-[0-9a-f]{32}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "farmId": "string",
   "fleetId": "string",
   "hostProperties": { 
      "ec2InstanceArn": "string",
      "ec2InstanceType": "string",
      "hostName": "string",
      "ipAddresses": { 
         "ipV4Addresses": [ "string" ],
         "ipV6Addresses": [ "string" ]
      }
   },
   "log": { 
      "error": "string",
      "logDriver": "string",
      "options": { 
         "string" : "string" 
      },
      "parameters": { 
         "string" : "string" 
      }
   },
   "status": "string",
   "updatedAt": "string",
   "updatedBy": "string",
   "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.

createdAt

The date and time the resource was created.

Type: Timestamp

createdBy

The user or system that created this resource.

Type: String

farmId

The farm ID.

Type: String

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

fleetId

The fleet ID.

Type: String

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

hostProperties

The host properties for the worker.

Type: HostPropertiesResponse object

log

The logs for the associated worker.

Type: LogConfiguration object

status

The status of the worker.

Type: String

Valid Values: CREATED | STARTED | STOPPING | STOPPED | NOT_RESPONDING | NOT_COMPATIBLE | RUNNING | IDLE

updatedAt

The date and time the resource was updated.

Type: Timestamp

updatedBy

The user or system that updated this resource.

Type: String

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

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: