Skip to content
AWS for Query.Farm

aws.gamelift.describe_fleet_location_utilization

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_fleet_location_utilization
WHERE
"fleet_id" = 'VALUE'
AND "location" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
fleet_id Required Input Column

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

VARCHAR
location Required Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
fleet_utilization

Utilization information for the requested fleet location. Utilization objects are returned only for fleets and locations that currently exist.

STRUCT(
    "fleet_id" VARCHAR,
    "fleet_arn" VARCHAR,
    "active_server_process_count" BIGINT,
    "active_game_session_count" BIGINT,
    "current_player_session_count" BIGINT,
    "maximum_player_session_count" BIGINT,
    "location" VARCHAR
)
Show child fields
fleet_utilization.active_game_session_count

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

fleet_utilization.active_server_process_count

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

fleet_utilization.current_player_session_count

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

fleet_utilization.fleet_arn

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.

fleet_utilization.fleet_id

A unique identifier for the fleet associated with the location.

fleet_utilization.location

The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as us-west-2.

fleet_utilization.maximum_player_session_count

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