/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::GameLift::DescribeGameServerInstances

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $gamelift = Paws->service('GameLift');
my $DescribeGameServerInstancesOutput =
  $gamelift->DescribeGameServerInstances(
  GameServerGroupName => 'MyGameServerGroupNameOrArn',
  InstanceIds         => [
    'MyGameServerInstanceId', ...    # min: 19, max: 19
  ],    # OPTIONAL
  Limit     => 1,                          # OPTIONAL
  NextToken => 'MyNonZeroAndMaxString',    # OPTIONAL
  );

# Results:
my $GameServerInstances =
  $DescribeGameServerInstancesOutput->GameServerInstances;
my $NextToken = $DescribeGameServerInstancesOutput->NextToken;

# Returns a L<Paws::GameLift::DescribeGameServerInstancesOutput> 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/DescribeGameServerInstances

ATTRIBUTES

REQUIRED GameServerGroupName => Str

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

InstanceIds => ArrayRef[Str|Undef]

The EC2 instance IDs that you want to retrieve status on. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeGameServerInstances in Paws::GameLift

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