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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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"],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

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) 


10690
10691
10692
10693
10694
10695
10696
10697
 
# File 'lib/aws-sdk-ec2/types.rb', line 10690

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

#filters ⇒ Array<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:



10690
10691
10692
10693
10694
10695
10696
10697
 
# File 'lib/aws-sdk-ec2/types.rb', line 10690

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

#fleet_ids ⇒ Array<String>

The ID of the EC2 Fleets.

Returns:

  • (Array<String>) 


10690
10691
10692
10693
10694
10695
10696
10697
 
# File 'lib/aws-sdk-ec2/types.rb', line 10690

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

#max_results ⇒ Integer

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) 


10690
10691
10692
10693
10694
10695
10696
10697
 
# File 'lib/aws-sdk-ec2/types.rb', line 10690

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

#next_token ⇒ String

The token for the next set of results.

Returns:

  • (String) 


10690
10691
10692
10693
10694
10695
10696
10697
 
# File 'lib/aws-sdk-ec2/types.rb', line 10690

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