Amazon GameLift · Schema

ListAliasesInput

ListAliasesInput schema from Amazon GameLift API

Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Properties

Name Type Description
RoutingStrategyType object
Name object
Limit object
NextToken object
View JSON Schema on GitHub

JSON Schema

gamelift-list-aliases-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-list-aliases-input-schema.json",
  "title": "ListAliasesInput",
  "description": "ListAliasesInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "RoutingStrategyType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoutingStrategyType"
        },
        {
          "description": "<p>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html\">RoutingStrategy</a> message embedded.</p> </li> </ul>"
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "A descriptive label that is associated with an alias. Alias names do not need to be unique."
        }
      ]
    },
    "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/NonEmptyString"
        },
        {
          "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."
        }
      ]
    }
  }
}