fleet_utilizations
Creates, updates, deletes, gets or lists a fleet_utilizations resource.
Overview
| Name | fleet_utilizations |
| Type | Resource |
| Id | aws.gamelift.fleet_utilizations |
Fields
The following fields are returned by SELECT queries:
- describe_fleet_utilization
| Name | Datatype | Description |
|---|---|---|
active_game_session_count | integer | The number of active game sessions that are currently being hosted across all instances in the fleet location. |
active_server_process_count | integer | The number of server processes in ACTIVE status that are currently running across all instances in the fleet location. |
current_player_session_count | integer | The number of active player sessions that are currently being hosted across all instances in the fleet location. |
fleet_arn | string | The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers 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. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
fleet_id | string | A unique identifier for the fleet associated with the location. (pattern: <code>^[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
location | string | The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2. (pattern: <code>^[A-Za-z0-9-]+$</code>) |
maximum_player_session_count | integer | The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_fleet_utilization | select | region | This API works with the following fleet types: EC2 Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations. This operation can be used in the following ways: To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get utilization 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 FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region. Some API operations may limit the number of fleet IDs 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 Servers Fleets GameLift Metrics for Fleets |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_fleet_utilization
This API works with the following fleet types: EC2 Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations. This operation can be used in the following ways: To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs. To get utilization 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 FleetUtilization object is returned for each requested fleet ID, unless the fleet identifier is not found. Each fleet utilization object includes a Location property, which is set to the fleet's home Region. Some API operations may limit the number of fleet IDs 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 Servers Fleets GameLift Metrics for Fleets
SELECT
active_game_session_count,
active_server_process_count,
current_player_session_count,
fleet_arn,
fleet_id,
location,
maximum_player_session_count
FROM aws.gamelift.fleet_utilizations
WHERE region = '{{ region }}' -- required
;