Skip to content
AWS for Query.Farm

aws.gamelift.describe_fleet_location_capacity

Example SQL Queries

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

Description

Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. For a container fleet, this operation also returns counts for replica container groups.

Use this operation to retrieve capacity information for a fleet's remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).

To retrieve capacity data, identify a fleet and location.

If successful, a FleetCapacity 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 capacity for. You can use either the fleet ID or ARN value.

VARCHAR
location Required Input Column

The fleet location to retrieve capacity 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_capacity

Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist. Changes in desired instance value can take up to 1 minute to be reflected.

STRUCT(
    "fleet_id" VARCHAR,
    "fleet_arn" VARCHAR,
    "instance_type" VARCHAR,
    "instance_counts" STRUCT(
        "desired" BIGINT,
        "minimum" BIGINT,
        "maximum" BIGINT,
        "pending" BIGINT,
        "active" BIGINT,
        "idle" BIGINT,
        "terminating" BIGINT
    ),
    "location" VARCHAR,
    "replica_container_group_counts" STRUCT(
        "pending" BIGINT,
        "active" BIGINT,
        "idle" BIGINT,
        "terminating" BIGINT
    )
)
Show child fields
fleet_capacity.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_capacity.fleet_id

A unique identifier for the fleet associated with the location.

fleet_capacity.instance_counts

The current number of instances in the fleet, listed by instance status. Counts for pending and terminating instances might be non-zero if the fleet is adjusting to a scaling event or if access to resources is temporarily affected.

Show child fields
fleet_capacity.instance_counts.active

Actual number of instances that are ready to host game sessions.

fleet_capacity.instance_counts.desired

Requested number of active instances. Amazon GameLift takes action as needed to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. A change in the desired instances value can take up to 1 minute to be reflected when viewing a fleet's capacity settings.

fleet_capacity.instance_counts.idle

Number of active instances that are not currently hosting a game session.

fleet_capacity.instance_counts.maximum

The maximum instance count value allowed.

fleet_capacity.instance_counts.minimum

The minimum instance count value allowed.

fleet_capacity.instance_counts.pending

Number of instances that are starting but not yet active.

fleet_capacity.instance_counts.terminating

Number of instances that are no longer active but haven't yet been terminated.

fleet_capacity.instance_type

The Amazon EC2 instance type that is used for instances in a fleet. Instance type determines the computing resources in use, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.

fleet_capacity.location

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

fleet_capacity.replica_container_group_counts

This property is used with the Amazon GameLift containers feature, which is currently in public preview. The number and status of replica container groups in a container fleet.

Show child fields
fleet_capacity.replica_container_group_counts.active

The number of container groups that have active game sessions.

fleet_capacity.replica_container_group_counts.idle

The number of container groups that have no active game sessions.

fleet_capacity.replica_container_group_counts.pending

The number of container groups that are starting up but have not yet registered.

fleet_capacity.replica_container_group_counts.terminating

The number of container groups that are in the process of shutting down.