Skip to content

/AWS1/CL_GML=>LISTALIASES()

About ListAliases

Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

Related actions

All APIs by task

Method Signature

IMPORTING

Optional arguments:

IV_ROUTINGSTRATEGYTYPE TYPE /AWS1/GMLROUTINGSTRATEGYTYPE /AWS1/GMLROUTINGSTRATEGYTYPE

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.

IV_NAME TYPE /AWS1/GMLNONEMPTYSTRING /AWS1/GMLNONEMPTYSTRING

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

IV_LIMIT TYPE /AWS1/GMLPOSITIVEINTEGER /AWS1/GMLPOSITIVEINTEGER

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

IV_NEXTTOKEN TYPE /AWS1/GMLNONEMPTYSTRING /AWS1/GMLNONEMPTYSTRING

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_GMLLISTALIASESOUTPUT /AWS1/CL_GMLLISTALIASESOUTPUT