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

Class: Aws::EC2::Types::DescribeFleetInstancesRequest

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

Overview

Note:

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

{
  dry_run: false,
  max_results: 1,
  next_token: "String",
  fleet_id: "FleetIdentifier", # required
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


10610
10611
10612
10613
10614
10615
10616
10617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10610

class DescribeFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :fleet_id,
  :filters)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • instance-type - The instance type.

^

Returns:



10610
10611
10612
10613
10614
10615
10616
10617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10610

class DescribeFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :fleet_id,
  :filters)
  include Aws::Structure
end

#fleet_idString

The ID of the EC2 Fleet.

Returns:

  • (String)


10610
10611
10612
10613
10614
10615
10616
10617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10610

class DescribeFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :fleet_id,
  :filters)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

  • (Integer)


10610
10611
10612
10613
10614
10615
10616
10617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10610

class DescribeFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :fleet_id,
  :filters)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


10610
10611
10612
10613
10614
10615
10616
10617
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10610

class DescribeFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :fleet_id,
  :filters)
  include Aws::Structure
end