Class: Aws::GameLift::Types::ListAliasesInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5762

class ListAliasesInput < Struct.new(
  :routing_strategy_type,
  :name,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A descriptive label that is associated with an alias. Alias names do not need to be unique.

Returns:

  • (String) 


5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5762

class ListAliasesInput < Struct.new(
  :routing_strategy_type,
  :name,
  :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) 


5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5762

class ListAliasesInput < Struct.new(
  :routing_strategy_type,
  :name,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#routing_strategy_type ⇒ String

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.

Possible routing types include the following:

  • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL -- 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 RoutingStrategy message embedded.

Returns:

  • (String) 


5762
5763
5764
5765
5766
5767
5768
5769
 
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5762

class ListAliasesInput < Struct.new(
  :routing_strategy_type,
  :name,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end