NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $gamelift = Paws->service('GameLift');
    my $DescribeInstancesOutput = $gamelift->DescribeInstances(
      FleetId    => 'MyFleetIdOrArn',
      InstanceId => 'MyInstanceId',             # OPTIONAL
      Limit      => 1,                          # OPTIONAL
      Location   => 'MyLocationStringModel',    # OPTIONAL
      NextToken  => 'MyNonZeroAndMaxString',    # OPTIONAL
    );

    # Results:
    my $Instances = $DescribeInstancesOutput->Instances;
    my $NextToken = $DescribeInstancesOutput->NextToken;

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

ATTRIBUTES

REQUIRED FleetId => Str

A unique identifier for the fleet to retrieve instance information for. You can use either the fleet ID or ARN value.

InstanceId => Str

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

Limit => Int

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

Location => Str

The name of a location to retrieve instance information for, in the form of an AWS Region code such as us-west-2.

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 DescribeInstances 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