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

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

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

Overview

Note:

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

Instance Attribute Details

#limitInteger

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Returns:

  • (Integer)


3704
3705
3706
3707
3708
3709
3710
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3704

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

#nameString

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

Returns:

  • (String)


3704
3705
3706
3707
3708
3709
3710
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3704

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

#next_tokenString

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.

Returns:

  • (String)


3704
3705
3706
3707
3708
3709
3710
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3704

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

#routing_strategy_typeString

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.

Returns:

  • (String)


3704
3705
3706
3707
3708
3709
3710
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 3704

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