Get a fleet.
get/2023-10-12/farms/{farmId}/fleets/{fleetId}
Path parameters
farmIdstring required
The farm ID of the farm in the fleet.
fleetIdstring required
The fleet ID of the fleet to get.
Response
Success
fleetIdstring required
The fleet ID.
farmIdstring required
The farm ID of the farm in the fleet.
displayNamestring required
<p>The display name of the fleet.</p> <important> <p>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.</p> </important>
status'ACTIVE' | 'CREATE_IN_PROGRESS' | 'UPDATE_IN_PROGRESS' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'SUSPENDED' required
The status of the fleet.
statusMessagestring
A message that communicates a suspended status of the fleet.
autoScalingStatus'GROWING' | 'STEADY' | 'SHRINKING'
The Auto Scaling status of the fleet. Either <code>GROWING</code>, <code>STEADY</code>, or <code>SHRINKING</code>.
targetWorkerCountinteger
The number of target workers in the fleet.
workerCountinteger required
The number of workers in the fleet.
minWorkerCountinteger required
The minimum number of workers specified in the fleet.
maxWorkerCountinteger required
The maximum number of workers specified in the fleet.
createdAtstring date-time required
The date and time the resource was created.
createdBystring required
The user or system that created this resource.
updatedAtstring date-time
The date and time the resource was updated.
updatedBystring
The user or system that updated this resource.
descriptionstring password
<p>The description of the fleet.</p> <important> <p>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.</p> </important>
roleArnstring required
The IAM role ARN.