Amazon GameLift · JSON Structure

Gamelift Describe Instances Input Structure

DescribeInstancesInput schema from Amazon GameLift API

Type: object Properties: 5 Required: 1
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

DescribeInstancesInput is a JSON Structure definition published by Amazon GameLift, describing 5 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

FleetId InstanceId Limit NextToken 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-describe-instances-input-structure.json",
  "name": "DescribeInstancesInput",
  "description": "DescribeInstancesInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetIdOrArn"
        },
        {
          "description": "A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value."
        }
      ]
    },
    "InstanceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceId"
        },
        {
          "description": "A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet."
        }
      ]
    },
    "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."
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationStringModel"
        },
        {
          "description": "The name of a location to retrieve instance information for, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. "
        }
      ]
    }
  },
  "required": [
    "FleetId"
  ]
}