You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GameLift::Types::ListAliasesInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::ListAliasesInput
- Defined in:
- (unknown)
Overview
When passing ListAliasesInput as input to an Aws::Client method, you can use a vanilla Hash:
{
routing_strategy_type: "SIMPLE", # accepts SIMPLE, TERMINAL
name: "NonEmptyString",
limit: 1,
next_token: "NonEmptyString",
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#limit ⇒ Integer
The maximum number of results to return.
-
#name ⇒ String
A descriptive label that is associated with an alias.
-
#next_token ⇒ String
A token that indicates the start of the next sequential page of results.
-
#routing_strategy_type ⇒ String
The routing type to filter results on.
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.
#name ⇒ String
A descriptive label that is associated with an alias. Alias names do not need to be unique.
#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.
#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.
Possible values:
- SIMPLE
- TERMINAL