NAME

Paws::GameLift::ListGameServers - Arguments for method ListGameServers on Paws::GameLift

DESCRIPTION

This class represents the parameters used for calling the method ListGameServers on the Amazon GameLift service. Use the attributes of this class as arguments to method ListGameServers.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListGameServers.

SYNOPSIS

    my $gamelift = Paws->service('GameLift');
    my $ListGameServersOutput = $gamelift->ListGameServers(
      GameServerGroupName => 'MyGameServerGroupNameOrArn',
      Limit               => 1,                              # OPTIONAL
      NextToken           => 'MyNonZeroAndMaxString',        # OPTIONAL
      SortOrder           => 'ASCENDING',                    # OPTIONAL
    );
    # Results:
    my $GameServers = $ListGameServersOutput->GameServers;
    my $NextToken   = $ListGameServersOutput->NextToken;
    # Returns a L<Paws::GameLift::ListGameServersOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/gamelift/ListGameServers>

ATTRIBUTES

REQUIRED GameServerGroupName => Str

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Limit => Int

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

NextToken => Str

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.

SortOrder => Str

Indicates how to sort the returned data based on game server registration timestamp. Use "ASCENDING" to retrieve oldest game servers first, or use "DESCENDING" to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

Valid values are: "ASCENDING", "DESCENDING"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>