GameLift / Paginator / DescribeFleetUtilization

DescribeFleetUtilization#

class GameLift.Paginator.DescribeFleetUtilization#
paginator = client.get_paginator('describe_fleet_utilization')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GameLift.Client.describe_fleet_utilization().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FleetIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • FleetIds (list) –

    A unique identifier for the fleet to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.

    • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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 (list) –

      A collection of objects containing utilization information for each requested fleet ID. Utilization objects are returned only for fleets that currently exist.

      • (dict) –

        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.

        • 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.