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

GetFleet

Get a fleet.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID of the farm in the fleet.

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

Required: Yes

fleetId

The fleet ID of the fleet to get.

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

{
   "autoScalingStatus": "string",
   "capabilities": { 
      "amounts": [ 
         { 
            "max": number,
            "min": number,
            "name": "string"
         }
      ],
      "attributes": [ 
         { 
            "name": "string",
            "values": [ "string" ]
         }
      ]
   },
   "configuration": { ... },
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "displayName": "string",
   "farmId": "string",
   "fleetId": "string",
   "hostConfiguration": { 
      "scriptBody": "string",
      "scriptTimeoutSeconds": number
   },
   "maxWorkerCount": number,
   "minWorkerCount": number,
   "roleArn": "string",
   "status": "string",
   "statusMessage": "string",
   "targetWorkerCount": number,
   "updatedAt": "string",
   "updatedBy": "string",
   "workerCount": number
}

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.

autoScalingStatus

The AWS Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.

Type: String

Valid Values: GROWING | STEADY | SHRINKING

capabilities

Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.

Type: FleetCapabilities object

configuration

The configuration setting for the fleet.

Type: FleetConfiguration object

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

createdAt

The date and time the resource was created.

Type: Timestamp

createdBy

The user or system that created this resource.

Type: String

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.

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.

farmId

The farm ID of the farm in the fleet.

Type: String

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

fleetId

The fleet ID.

Type: String

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

hostConfiguration

The script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

Type: HostConfiguration object

maxWorkerCount

The maximum number of workers specified in the fleet.

Type: Integer

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

minWorkerCount

The minimum number of workers specified in the fleet.

Type: Integer

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

roleArn

The IAM role ARN.

Type: String

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

status

The status of the fleet.

Type: String

statusMessage

A message that communicates a suspended status of the fleet.

Type: String

targetWorkerCount

The number of target workers in the fleet.

Type: Integer

updatedAt

The date and time the resource was updated.

Type: Timestamp

updatedBy

The user or system that updated this resource.

Type: String

workerCount

The number of workers in the fleet.

Type: Integer

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.

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

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