Skip to content

ListAliasesInput

Source code in docs_src/capo_gamelift/types/list_aliases_input.py 
13
14
15
16
17
18
19
20
21
22
23
class ListAliasesInput(TypedDict, closed=True):
    routing_strategy_type: NotRequired[
        "capo_gamelift.types.routing_strategy_type.RoutingStrategyType"
    ]
    """<p>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.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> -- 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 <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p> </li> </ul>"""
    name: NotRequired["capo_gamelift.types.non_empty_string.NonEmptyString"]
    """<p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>"""
    limit: NotRequired["capo_gamelift.types.positive_integer.PositiveInteger"]
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    next_token: NotRequired["capo_gamelift.types.non_empty_string.NonEmptyString"]
    """<p>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.</p>"""

limit instance-attribute 

limit: NotRequired[PositiveInteger]

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

name instance-attribute 

name: NotRequired[NonEmptyString]

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

next_token instance-attribute 

next_token: NotRequired[NonEmptyString]

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 instance-attribute 

routing_strategy_type: NotRequired[RoutingStrategyType]

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.