GameLift / Client / describe_fleet_location_utilization

describe_fleet_location_utilization#

GameLift.Client.describe_fleet_location_utilization(**kwargs)#

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

GameLift metrics for fleets

Request Syntax

response = client.describe_fleet_location_utilization(
    FleetId='string',
    Location='string'
)

Parameters:

FleetId (string) –
[REQUIRED]

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.
Location (string) –
[REQUIRED]

The fleet location to retrieve utilization information for. Specify a location in the form of an Amazon Web Services Region code, such as us-west-2.

Return type:

dict

Returns:

Response Syntax

{
    'FleetUtilization': {
        'FleetId': 'string',
        'FleetArn': 'string',
        'ActiveServerProcessCount': 123,
        'ActiveGameSessionCount': 123,
        'CurrentPlayerSessionCount': 123,
        'MaximumPlayerSessionCount': 123,
        'Location': 'string'
    }
}

Response Structure

(dict) –
- FleetUtilization (dict) –
  
  Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.
  - FleetId (string) –
    
    A unique identifier for the fleet associated with the location.
  - FleetArn (string) –
    
    The Amazon Resource Name ( ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
  - ActiveServerProcessCount (integer) –
    
    The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.
  - ActiveGameSessionCount (integer) –
    
    The number of active game sessions that are currently being hosted across all instances in the fleet location.
  - CurrentPlayerSessionCount (integer) –
    
    The number of active player sessions that are currently being hosted across all instances in the fleet location.
  - MaximumPlayerSessionCount (integer) –
    
    The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.
  - Location (string) –
    
    The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.

Exceptions

GameLift.Client.exceptions.InternalServiceException
GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.UnauthorizedException
GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.UnsupportedRegionException