Amazon GameLift · JSON Structure

Gamelift Describe Scaling Policies Input Structure

DescribeScalingPoliciesInput schema from Amazon GameLift API

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

DescribeScalingPoliciesInput 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 StatusFilter 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-scaling-policies-input-structure.json",
  "name": "DescribeScalingPoliciesInput",
  "description": "DescribeScalingPoliciesInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetIdOrArn"
        },
        {
          "description": "A unique identifier for the fleet for which to retrieve scaling policies. You can use either the fleet ID or ARN value."
        }
      ]
    },
    "StatusFilter": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ScalingStatusType"
        },
        {
          "description": "<p>Scaling policy status to filter results on. A scaling policy is only in force when in an <code>ACTIVE</code> status.</p> <ul> <li> <p> <b>ACTIVE</b> -- The scaling policy is currently in force.</p> </li> <li> <p> <b>UPDATEREQUESTED</b> -- A request to update the scaling policy has been received.</p> </li> <li> <p> <b>UPDATING</b> -- A change is being made to the scaling policy.</p> </li> <li> <p> <b>DELETEREQUESTED</b> -- A request to delete the scaling policy has been received.</p> </li> <li> <p> <b>DELETING</b> -- The scaling policy is being deleted.</p> </li> <li> <p> <b>DELETED</b> -- The scaling policy has been deleted.</p> </li> <li> <p> <b>ERROR</b> -- An error occurred in creating the policy. It should be removed and recreated.</p> </li> </ul>"
        }
      ]
    },
    "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 fleet location. If you don't specify this value, the response contains the scaling policies of every location in the fleet. "
        }
      ]
    }
  },
  "required": [
    "FleetId"
  ]
}