Request Parameters Response Elements Errors See Also

DescribeFleets

Describes the specified EC2 Fleet or all of your EC2 Fleets.

Important

If a fleet is of type instant, you must specify the fleet ID in the request, otherwise the fleet does not appear in the response.

For more information, see Describe your EC2 Fleet in the Amazon EC2 User Guide.

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

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

Type: Array of Filter objects

Required: No

FleetId.N

The IDs of the EC2 Fleets.

Note

If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.

Type: Array of strings

Required: No

MaxResults

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.

Type: Integer

Required: No

NextToken

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

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 to include in another request to get the next page of items. This value is null when there are no more items to return.

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 error codes.