Amazon GameLift · JSON Structure

Gamelift Describe Game Sessions Input Structure

DescribeGameSessionsInput schema from Amazon GameLift API

Type: object Properties: 7
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

DescribeGameSessionsInput 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 GameSessionId AliasId Location StatusFilter Limit NextToken

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-describe-game-sessions-input-structure.json",
  "name": "DescribeGameSessionsInput",
  "description": "DescribeGameSessionsInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetIdOrArn"
        },
        {
          "description": "A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value. "
        }
      ]
    },
    "GameSessionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnStringModel"
        },
        {
          "description": "A unique identifier for the game session to retrieve. "
        }
      ]
    },
    "AliasId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AliasIdOrArn"
        },
        {
          "description": "A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value."
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationStringModel"
        },
        {
          "description": "A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>. "
        }
      ]
    },
    "StatusFilter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "Game session status to filter results on. You can filter on the following states: <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code>, and <code>TERMINATING</code>. The last two are transitory and used for only very brief periods of time. "
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveInteger"
        },
        {
          "description": "The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value."
        }
      ]
    }
  }
}