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.
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",
"maxWorkerCount": number,
"minWorkerCount": number,
"roleArn": "string",
"status": "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, orSHRINKING.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} - 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 AWS Auto Scaling status of the fleet.
Type: String
Valid Values:
ACTIVE | CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | CREATE_FAILED | UPDATE_FAILED - 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.
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:
