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
show all
Defined in:
(unknown)

Overview

Note:

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

    Maximum number of results to return.

#nameString

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

Returns:

  • (String)

    Descriptive label that is associated with an alias.

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

    Token that indicates the start of the next sequential page of results.

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

    Possible values:

    • SIMPLE
    • TERMINAL

Returns:

  • (String)

    Type of routing to filter results on.