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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::ListGameServersInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #game_server_group_name ⇒ 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.

• #next_token ⇒ String

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

• #sort_order ⇒ String

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

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 name or ARN value.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 6146

class ListGameServersInput < Struct.new(
  :game_server_group_name,
  :sort_order,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 6146

class ListGameServersInput < Struct.new(
  :game_server_group_name,
  :sort_order,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 6146

class ListGameServersInput < Struct.new(
  :game_server_group_name,
  :sort_order,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 6146

class ListGameServersInput < Struct.new(
  :game_server_group_name,
  :sort_order,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end