Amazon GameLift · JSON Structure

Gamelift Fleet Utilization Structure

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.

Related actions

Type: object Properties: 7
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

FleetUtilization is a JSON Structure definition published by Amazon GameLift, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

FleetId FleetArn ActiveServerProcessCount ActiveGameSessionCount CurrentPlayerSessionCount MaximumPlayerSessionCount Location

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-fleet-utilization-structure.json",
  "name": "FleetUtilization",
  "description": "<p>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.</p> <p> <b>Related actions</b> </p>",
  "type": "object",
  "properties": {
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetId"
        },
        {
          "description": "A unique identifier for the fleet associated with the location."
        }
      ]
    },
    "FleetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetArn"
        },
        {
          "description": "The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>."
        }
      ]
    },
    "ActiveServerProcessCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The number of server processes in <code>ACTIVE</code> status that are currently running across all instances in the fleet location. "
        }
      ]
    },
    "ActiveGameSessionCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The number of active game sessions that are currently being hosted across all instances in the fleet location."
        }
      ]
    },
    "CurrentPlayerSessionCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The number of active player sessions that are currently being hosted across all instances in the fleet location."
        }
      ]
    },
    "MaximumPlayerSessionCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The maximum number of players allowed across all game sessions that are currently being hosted across all instances in the fleet location."
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationStringModel"
        },
        {
          "description": "The fleet location for the fleet utilization information, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. "
        }
      ]
    }
  }
}