Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

DescribeFleetCapacity

Retrieves the resource capacity settings for one or more fleets.

With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see DescribeFleetLocationCapacity.

This operation can be used in the following ways:

To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get capacity data for all fleets, do not provide a fleet identifier.

When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a FleetCapacity object is returned for each requested fleet ID. Each FleetCapacity object includes a Location property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.

Note

Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Setting up Amazon GameLift fleets

GameLift metrics for fleets

Request Syntax


{
   "FleetIds": [ "string" ],
   "Limit": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

FleetIds

A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.

Type: Array of strings

Array Members: Minimum number of 1 item.

Pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+

Required: No

Limit

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


{
   "FleetCapacity": [ 
      { 
         "FleetArn": "string",
         "FleetId": "string",
         "InstanceCounts": { 
            "ACTIVE": number,
            "DESIRED": number,
            "IDLE": number,
            "MAXIMUM": number,
            "MINIMUM": number,
            "PENDING": number,
            "TERMINATING": number
         },
         "InstanceType": "string",
         "Location": "string",
         "ReplicaContainerGroupCounts": { 
            "ACTIVE": number,
            "IDLE": number,
            "PENDING": number,
            "TERMINATING": number
         }
      }
   ],
   "NextToken": "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.

FleetCapacity

A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.

Type: Array of FleetCapacity objects

NextToken

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnauthorizedException

The client failed authentication. Clients should not retry such requests.

HTTP Status Code: 400

Examples

Request capacity status for a list of fleets

This example retrieves fleet capacity information for a list of one fleet. The result shows a fleet in the middle of a scale down event: instances are being terminated so that the active instances count matches the desired instances count.

HTTP requests are authenticated using an AWS Signature Version 4 signature in the Authorization header field.

Sample Request


{
    "FleetIds": [
        "arn:aws:gamelift:us-west-2::fleet/fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff"
    ]
}

Sample Response


{
    "FleetCapacity": [
        {
            "FleetId": "fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
            "FleetArn": "arn:aws:gamelift:us-east-2::fleet/fleet-1111aaaa-22bb-33cc-44dd-5555eeee66ff",
            "InstanceCounts": {
                "DESIRED": 13,
                "MINIMUM": 1,
                "MAXIMUM": 20,
                "PENDING": 0,
                "ACTIVE": 15,
                "IDLE": 2,
                "TERMINATING": 2
            }
            "InstanceType": "c5.large",
            "Location": "us-west-2"
        }
    ]
}