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

Class: Aws::EC2::Types::DescribeFleetsRequest

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

{
  dry_run: false,
  max_results: 1,
  next_token: "String",
  fleet_ids: ["FleetIdentifier"],
  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)


10738
10739
10740
10741
10742
10743
10744
10745
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10738

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

#filtersArray<Types::Filter>

One or more filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

  • type - The type of request (instant | request | maintain).

Returns:



10738
10739
10740
10741
10742
10743
10744
10745
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10738

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

#fleet_idsArray<String>

The ID of the EC2 Fleets.

Returns:

  • (Array<String>)


10738
10739
10740
10741
10742
10743
10744
10745
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10738

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


10738
10739
10740
10741
10742
10743
10744
10745
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10738

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

#next_tokenString

The token for the next set of results.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 10738

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