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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass DescribeInstancesInput data as a hash:

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

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#fleet_idString

Unique identifier for a fleet to retrieve instance information for.

Returns:

  • (String)


2062
2063
2064
2065
2066
2067
2068
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2062

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#instance_idString

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

Returns:

  • (String)


2062
2063
2064
2065
2066
2067
2068
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2062

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#limitInteger

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

Returns:

  • (Integer)


2062
2063
2064
2065
2066
2067
2068
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2062

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token)
  include Aws::Structure
end

#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 action. To start at the beginning of the result set, do not specify a value.

Returns:

  • (String)


2062
2063
2064
2065
2066
2067
2068
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2062

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token)
  include Aws::Structure
end