/AWS1/CL_GML=>LISTFLEETS()

About ListFleets

This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

Retrieves a collection of fleet resources in an Amazon Web Services Region. You can filter the result set to find only those fleets that are deployed with a specific build or script. For fleets that have multiple locations, this operation retrieves fleets based on their home Region only.

You can use operation in the following ways:

• To get a list of all fleets in a Region, don't provide a build or script identifier.

• To get a list of all fleets where a specific game build is deployed, provide the build ID.

• To get a list of all Realtime Servers fleets with a specific configuration script, provide the script ID.

• To get a list of all fleets with a specific container group definition, provide the ContainerGroupDefinition ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, this operation returns a list of fleet IDs that match the request parameters. A NextToken value is also returned if there are more result pages to retrieve.

Fleet IDs are returned in no particular order.

Method Signature

IMPORTING

Optional arguments:

IV_BUILDID TYPE /AWS1/GMLBUILDIDORARN /AWS1/GMLBUILDIDORARN

A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a specified build. Use either the build ID or ARN value.

IV_SCRIPTID TYPE /AWS1/GMLSCRIPTIDORARN /AWS1/GMLSCRIPTIDORARN

A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a specified script. Use either the script ID or ARN value.

IV_CONTAINERGROUPDEFNNAME TYPE /AWS1/GMLCONTAINERGRDEFNAMEO00 /AWS1/GMLCONTAINERGRDEFNAMEO00

The container group definition name to request fleets for. Use this parameter to return only fleets that are deployed with the specified container group definition.

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/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

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_GMLLISTFLEETSOUTPUT /AWS1/CL_GMLLISTFLEETSOUTPUT