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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::DescribeInstancesInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #fleet_id ⇒ String

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

• #instance_id ⇒ String

  A unique identifier for an instance to retrieve.

• #limit ⇒ Integer

  The maximum number of results to return.

• #location ⇒ String

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

• #next_token ⇒ String

  A token that indicates the start of the next sequential page of results.

Instance Attribute Details

#fleet_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4390

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4390

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 4390

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4390

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 4390

class DescribeInstancesInput < Struct.new(
  :fleet_id,
  :instance_id,
  :limit,
  :next_token,
  :location)
  SENSITIVE = []
  include Aws::Structure
end