AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::DescribeInstancesInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeInstancesInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  fleet_id: "FleetIdOrArn", # required
  instance_id: "InstanceId",
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request operation.

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

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

Returns:

  • (String)

    A unique identifier for a fleet to retrieve instance information for.

#instance_idString

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

Returns:

  • (String)

    A unique identifier for an instance to retrieve.

#limitInteger

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

Returns:

  • (Integer)

    The maximum number of results to return.

#next_tokenString

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.

Returns:

  • (String)

    Token that indicates the start of the next sequential page of results.