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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::DescribeFleetsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #filters ⇒ Array<Types::Filter>

  The filters.

• #fleet_ids ⇒ Array<String>

  The IDs of the EC2 Fleets.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

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)

# File 'lib/aws-sdk-ec2/types.rb', line 18822

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

#filters ⇒ Array<Types::Filter>

The 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:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-ec2/types.rb', line 18822

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

#fleet_ids ⇒ Array<String>

The IDs of the EC2 Fleets.

<note markdown=“1”> If a fleet is of type ‘instant`, you must specify the fleet ID, otherwise it does not appear in the response.

</note>

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 18822

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

#max_results ⇒ Integer

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 18822

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

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 18822

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