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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::ListAliasesInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (Integer)

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

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)

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

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)

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

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][1

  message embedded.

[1]: docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html

Returns:

• (String)

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

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