Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

DescribeFleets

Describes one or more of your EC2 Fleet.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

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 (request | maintain).

Type: Array of Filter objects

Required: No

FleetId.N

The ID of the EC2 Fleets.

Type: Array of strings

Required: No

MaxResults

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.

Type: Integer

Required: No

NextToken

The token for the next set of results.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

fleetSet

Information about the EC2 Fleets.

Type: Array of FleetData objects

nextToken

The token for the next set of results.

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common Client Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: