DescribeFleetLocationUtilization
Retrieves current usage data for a fleet location. Utilization data provides a
snapshot of current game hosting activity at the requested location. Use this operation
to retrieve utilization information for a fleet's remote location or home Region (you
can also retrieve home Region utilization by calling
DescribeFleetUtilization
).
To retrieve utilization data, identify a fleet and location.
If successful, a FleetUtilization
object is returned for the requested
fleet location.
Learn more
Setting up Amazon GameLift fleets
Amazon GameLift service locations for managed hosting
Request Syntax
{
"FleetId": "string
",
"Location": "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.
- FleetId
-
A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
^[a-z]*fleet-[a-zA-Z0-9\-]+$|^arn:.*:[a-z]*fleet\/[a-z]*fleet-[a-zA-Z0-9\-]+$
Required: Yes
- Location
-
The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Region code, such as
us-west-2
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[A-Za-z0-9\-]+
Required: Yes
Response Syntax
{
"FleetUtilization": {
"ActiveGameSessionCount": number,
"ActiveServerProcessCount": number,
"CurrentPlayerSessionCount": number,
"FleetArn": "string",
"FleetId": "string",
"Location": "string",
"MaximumPlayerSessionCount": 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.
- FleetUtilization
-
Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.
Type: FleetUtilization object
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
- UnsupportedRegionException
-
The requested operation is not supported in the Region specified.
HTTP Status Code: 400
Examples
Request utilization for a fleet location
This example retrieves usage data for the remote fleet location
sa-east-1
. The fleet's home Region is
us-west-2
.
HTTP requests are authenticated using an Amazon Signature Version 4 signature in the Authorization
header field.
Sample Request
{
"FleetId": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"Location": "sa-east-1"
}
Sample Response
{
"FleetUtilization": {
"FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"FleetArn": "arn:aws:gamelift:us-west-2::fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa",
"ActiveServerProcessCount": 100,
"ActiveGameSessionCount": 62,
"CurrentPlayerSessionCount": 329,
"MaximumPlayerSessionCount": 1000,
"Location": "sa-east-1"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: