FleetUtilization - Amazon GameLift

FleetUtilization

Current resource utilization statistics in a specified fleet or location. The location value might refer to a fleet's remote location or its home region.

Contents

Note

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

ActiveGameSessionCount

The number of active game sessions that are currently being hosted across all instances in the fleet location.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

ActiveServerProcessCount

The number of server processes in ACTIVE status that are currently running across all instances in the fleet location.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

CurrentPlayerSessionCount

The number of active player sessions that are currently being hosted across all instances in the fleet location.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

FleetArn

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.

Type: String

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

Required: No

FleetId

A unique identifier for the fleet associated with the location.

Type: String

Pattern: ^fleet-\S+

Required: No

Location

The fleet location for the fleet utilization information, expressed as an AWS 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: No

MaximumPlayerSessionCount

The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: