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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeFleetsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

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

#filtersArray<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:

#fleet_idsArray<String>

The ID of the EC2 Fleets.

Returns:

  • (Array<String>)

    The ID of the EC2 Fleets.

#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)

    The maximum number of results to return in a single call.

#next_tokenString

The token for the next set of results.

Returns:

  • (String)

    The token for the next set of results.