ListLocationsRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the ListLocations operation. Lists all custom and Amazon Web Services locations where Amazon GameLift Servers can host game servers.

Note that if you call this API using a location that doesn't have a service endpoint, such as one that can only be a remote location in a multi-location fleet, the API returns an error.

Consult the table of supported locations in Amazon GameLift Servers service locations to identify home Regions that support single and multi-location fleets.

Learn more

Service locations

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.ListLocationsRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

public class ListLocationsRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The ListLocationsRequest type exposes the following members

Constructors

	Name	Description
	ListLocationsRequest()

Properties

Name Type Description

Name	Type	Description
Filters	System.Collections.Generic.List<System.String>	Gets and sets the property Filters. Filters the list for `AWS` or `CUSTOM` locations. Use this parameter to narrow down results to only Amazon Web Services-managed locations (Amazon EC2 or container) or only your custom locations (such as an Amazon GameLift Servers Anywhere fleet). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Limit	System.Nullable<System.Int32>	Gets and sets the property Limit. The maximum number of results to return. Use this parameter with `NextToken` to get results as a set of sequential pages.
NextToken	System.String	Gets and sets the property NextToken. 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.

Filters

System.Collections.Generic.List<System.String>

Gets and sets the property Filters.

Filters the list for AWS or CUSTOM locations. Use this parameter to narrow down results to only Amazon Web Services-managed locations (Amazon EC2 or container) or only your custom locations (such as an Amazon GameLift Servers Anywhere fleet).

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Limit

System.Nullable<System.Int32>

Gets and sets the property Limit.

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

NextToken

System.String

Gets and sets the property NextToken.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer