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

Class: Aws::EC2::Types::DescribeSpotFleetInstancesRequest

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 DescribeSpotFleetInstancesRequest data as a hash:

{
  dry_run: false,
  max_results: 1,
  next_token: "String",
  spot_fleet_request_id: "String", # required
}

Contains the parameters for DescribeSpotFleetInstances.

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)


11184
11185
11186
11187
11188
11189
11190
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11184

class DescribeSpotFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :spot_fleet_request_id)
  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)


11184
11185
11186
11187
11188
11189
11190
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11184

class DescribeSpotFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :spot_fleet_request_id)
  include Aws::Structure
end

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


11184
11185
11186
11187
11188
11189
11190
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11184

class DescribeSpotFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :spot_fleet_request_id)
  include Aws::Structure
end

#spot_fleet_request_idString

The ID of the Spot Fleet request.

Returns:

  • (String)


11184
11185
11186
11187
11188
11189
11190
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 11184

class DescribeSpotFleetInstancesRequest < Struct.new(
  :dry_run,
  :max_results,
  :next_token,
  :spot_fleet_request_id)
  include Aws::Structure
end