Skip to content

/AWS1/CL_GML=>LISTCONTAINERGROUPDEFNS()

About ListContainerGroupDefinitions

This operation is used with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves all container group definitions for the Amazon Web Services account and Amazon Web Services Region that are currently in use. You can filter the result set by the container groups' scheduling strategy. Use the pagination parameters to retrieve results in a set of sequential pages.

This operation returns the list of container group definitions in no particular order.

Learn more

Method Signature

IMPORTING

Optional arguments:

IV_SCHEDULINGSTRATEGY TYPE /AWS1/GMLCONTAINERSCHEDULING00 /AWS1/GMLCONTAINERSCHEDULING00

The type of container group definitions to retrieve.

  • DAEMON -- Daemon container groups run background processes and are deployed once per fleet instance.

  • REPLICA -- Replica container groups run your game server application and supporting software. Replica groups might be deployed multiple times per fleet instance.

IV_LIMIT TYPE /AWS1/GMLLSTCONTAINERGRDEFSLMT /AWS1/GMLLSTCONTAINERGRDEFSLMT

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_GMLLSTCONTAINERGRDE01 /AWS1/CL_GMLLSTCONTAINERGRDE01