Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
This operation returns paginated results.
Synopsis
- data DescribeFleets = DescribeFleets' {}
- newDescribeFleets :: DescribeFleets
- describeFleets_dryRun :: Lens' DescribeFleets (Maybe Bool)
- describeFleets_filters :: Lens' DescribeFleets (Maybe [Filter])
- describeFleets_fleetIds :: Lens' DescribeFleets (Maybe [Text])
- describeFleets_maxResults :: Lens' DescribeFleets (Maybe Int)
- describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text)
- data DescribeFleetsResponse = DescribeFleetsResponse' {}
- newDescribeFleetsResponse :: Int -> DescribeFleetsResponse
- describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [FleetData])
- describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text)
- describeFleetsResponse_httpStatus :: Lens' DescribeFleetsResponse Int
Creating a Request
data DescribeFleets Source #
See: newDescribeFleets
smart constructor.
DescribeFleets' | |
|
Instances
newDescribeFleets :: DescribeFleets Source #
Create a value of DescribeFleets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DescribeFleets'
, describeFleets_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
.
$sel:filters:DescribeFleets'
, describeFleets_filters
- 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
).
$sel:fleetIds:DescribeFleets'
, describeFleets_fleetIds
- The IDs of the EC2 Fleets.
If a fleet is of type instant
, you must specify the fleet ID,
otherwise it does not appear in the response.
$sel:maxResults:DescribeFleets'
, describeFleets_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.
DescribeFleets
, describeFleets_nextToken
- The token for the next set of results.
Request Lenses
describeFleets_dryRun :: Lens' DescribeFleets (Maybe Bool) Source #
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
.
describeFleets_filters :: Lens' DescribeFleets (Maybe [Filter]) Source #
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
).
describeFleets_fleetIds :: Lens' DescribeFleets (Maybe [Text]) Source #
The IDs of the EC2 Fleets.
If a fleet is of type instant
, you must specify the fleet ID,
otherwise it does not appear in the response.
describeFleets_maxResults :: Lens' DescribeFleets (Maybe Int) Source #
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.
describeFleets_nextToken :: Lens' DescribeFleets (Maybe Text) Source #
The token for the next set of results.
Destructuring the Response
data DescribeFleetsResponse Source #
See: newDescribeFleetsResponse
smart constructor.
Instances
newDescribeFleetsResponse Source #
Create a value of DescribeFleetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fleets:DescribeFleetsResponse'
, describeFleetsResponse_fleets
- Information about the EC2 Fleets.
DescribeFleets
, describeFleetsResponse_nextToken
- The token for the next set of results.
$sel:httpStatus:DescribeFleetsResponse'
, describeFleetsResponse_httpStatus
- The response's http status code.
Response Lenses
describeFleetsResponse_fleets :: Lens' DescribeFleetsResponse (Maybe [FleetData]) Source #
Information about the EC2 Fleets.
describeFleetsResponse_nextToken :: Lens' DescribeFleetsResponse (Maybe Text) Source #
The token for the next set of results.
describeFleetsResponse_httpStatus :: Lens' DescribeFleetsResponse Int Source #
The response's http status code.