Class: Aws::GameLift::Types::ListAliasesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::ListAliasesInput
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-gamelift/types.rb
Overview
When making an API call, you may pass ListAliasesInput data as a hash:
{
routing_strategy_type: "SIMPLE", # accepts SIMPLE, TERMINAL
name: "NonEmptyString",
limit: 1,
next_token: "NonEmptyString",
}
Represents the input for a request action.
Instance Attribute Summary collapse
-
#limit ⇒ Integer
Maximum number of results to return.
-
#name ⇒ String
Descriptive label that is associated with an alias.
-
#next_token ⇒ String
Token that indicates the start of the next sequential page of results.
-
#routing_strategy_type ⇒ String
Type of routing to filter results on.
Instance Attribute Details
#limit ⇒ Integer
Maximum number of results to return. Use this parameter with ‘NextToken` to get results as a set of sequential pages.
4024 4025 4026 4027 4028 4029 4030 |
# File 'lib/aws-sdk-gamelift/types.rb', line 4024 class ListAliasesInput < Struct.new( :routing_strategy_type, :name, :limit, :next_token) include Aws::Structure end |
#name ⇒ String
Descriptive label that is associated with an alias. Alias names do not need to be unique.
4024 4025 4026 4027 4028 4029 4030 |
# File 'lib/aws-sdk-gamelift/types.rb', line 4024 class ListAliasesInput < Struct.new( :routing_strategy_type, :name, :limit, :next_token) include Aws::Structure end |
#next_token ⇒ String
Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
4024 4025 4026 4027 4028 4029 4030 |
# File 'lib/aws-sdk-gamelift/types.rb', line 4024 class ListAliasesInput < Struct.new( :routing_strategy_type, :name, :limit, :next_token) include Aws::Structure end |
#routing_strategy_type ⇒ String
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain 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.
4024 4025 4026 4027 4028 4029 4030 |
# File 'lib/aws-sdk-gamelift/types.rb', line 4024 class ListAliasesInput < Struct.new( :routing_strategy_type, :name, :limit, :next_token) include Aws::Structure end |