You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::ListGameServersInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListGameServersInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  game_server_group_name: "GameServerGroupNameOrArn", # required
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#game_server_group_name ⇒ String

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Returns:

  • (String) —

    An identifier for the game server group to retrieve a list of game servers from.

#limit ⇒ Integer

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential segments.

Returns:

  • (Integer) —

    The maximum number of results to return.

#next_token ⇒ String

A token that indicates the start of the next sequential segment of results. Use the token returned with the previous call to this operation. To start at the beginning of the result set, do not specify a value.

Returns:

  • (String) —

    A token that indicates the start of the next sequential segment of results.

#sort_order ⇒ String

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String) —

    Indicates how to sort the returned data based on game server registration timestamp.