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 one or more Capacity Reservation Fleets.
This operation returns paginated results.
Synopsis
- data DescribeCapacityReservationFleets = DescribeCapacityReservationFleets' {}
- newDescribeCapacityReservationFleets :: DescribeCapacityReservationFleets
- describeCapacityReservationFleets_capacityReservationFleetIds :: Lens' DescribeCapacityReservationFleets (Maybe [Text])
- describeCapacityReservationFleets_dryRun :: Lens' DescribeCapacityReservationFleets (Maybe Bool)
- describeCapacityReservationFleets_filters :: Lens' DescribeCapacityReservationFleets (Maybe [Filter])
- describeCapacityReservationFleets_maxResults :: Lens' DescribeCapacityReservationFleets (Maybe Natural)
- describeCapacityReservationFleets_nextToken :: Lens' DescribeCapacityReservationFleets (Maybe Text)
- data DescribeCapacityReservationFleetsResponse = DescribeCapacityReservationFleetsResponse' {}
- newDescribeCapacityReservationFleetsResponse :: Int -> DescribeCapacityReservationFleetsResponse
- describeCapacityReservationFleetsResponse_capacityReservationFleets :: Lens' DescribeCapacityReservationFleetsResponse (Maybe [CapacityReservationFleet])
- describeCapacityReservationFleetsResponse_nextToken :: Lens' DescribeCapacityReservationFleetsResponse (Maybe Text)
- describeCapacityReservationFleetsResponse_httpStatus :: Lens' DescribeCapacityReservationFleetsResponse Int
Creating a Request
data DescribeCapacityReservationFleets Source #
See: newDescribeCapacityReservationFleets
smart constructor.
DescribeCapacityReservationFleets' | |
|
Instances
newDescribeCapacityReservationFleets :: DescribeCapacityReservationFleets Source #
Create a value of DescribeCapacityReservationFleets
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:capacityReservationFleetIds:DescribeCapacityReservationFleets'
, describeCapacityReservationFleets_capacityReservationFleetIds
- The IDs of the Capacity Reservation Fleets to describe.
$sel:dryRun:DescribeCapacityReservationFleets'
, describeCapacityReservationFleets_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:DescribeCapacityReservationFleets'
, describeCapacityReservationFleets_filters
- One or more filters.
state
- The state of the Fleet (submitted
|modifying
|active
|partially_fulfilled
|expiring
|expired
|cancelling
|cancelled
|failed
).instance-match-criteria
- The instance matching criteria for the Fleet. Onlyopen
is supported.tenancy
- The tenancy of the Fleet (default
|dedicated
).allocation-strategy
- The allocation strategy used by the Fleet. Onlyprioritized
is supported.
$sel:maxResults:DescribeCapacityReservationFleets'
, describeCapacityReservationFleets_maxResults
- The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
DescribeCapacityReservationFleets
, describeCapacityReservationFleets_nextToken
- The token to use to retrieve the next page of results.
Request Lenses
describeCapacityReservationFleets_capacityReservationFleetIds :: Lens' DescribeCapacityReservationFleets (Maybe [Text]) Source #
The IDs of the Capacity Reservation Fleets to describe.
describeCapacityReservationFleets_dryRun :: Lens' DescribeCapacityReservationFleets (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
.
describeCapacityReservationFleets_filters :: Lens' DescribeCapacityReservationFleets (Maybe [Filter]) Source #
One or more filters.
state
- The state of the Fleet (submitted
|modifying
|active
|partially_fulfilled
|expiring
|expired
|cancelling
|cancelled
|failed
).instance-match-criteria
- The instance matching criteria for the Fleet. Onlyopen
is supported.tenancy
- The tenancy of the Fleet (default
|dedicated
).allocation-strategy
- The allocation strategy used by the Fleet. Onlyprioritized
is supported.
describeCapacityReservationFleets_maxResults :: Lens' DescribeCapacityReservationFleets (Maybe Natural) Source #
The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
describeCapacityReservationFleets_nextToken :: Lens' DescribeCapacityReservationFleets (Maybe Text) Source #
The token to use to retrieve the next page of results.
Destructuring the Response
data DescribeCapacityReservationFleetsResponse Source #
See: newDescribeCapacityReservationFleetsResponse
smart constructor.
DescribeCapacityReservationFleetsResponse' | |
|
Instances
newDescribeCapacityReservationFleetsResponse Source #
Create a value of DescribeCapacityReservationFleetsResponse
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:capacityReservationFleets:DescribeCapacityReservationFleetsResponse'
, describeCapacityReservationFleetsResponse_capacityReservationFleets
- Information about the Capacity Reservation Fleets.
DescribeCapacityReservationFleets
, describeCapacityReservationFleetsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:httpStatus:DescribeCapacityReservationFleetsResponse'
, describeCapacityReservationFleetsResponse_httpStatus
- The response's http status code.
Response Lenses
describeCapacityReservationFleetsResponse_capacityReservationFleets :: Lens' DescribeCapacityReservationFleetsResponse (Maybe [CapacityReservationFleet]) Source #
Information about the Capacity Reservation Fleets.
describeCapacityReservationFleetsResponse_nextToken :: Lens' DescribeCapacityReservationFleetsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeCapacityReservationFleetsResponse_httpStatus :: Lens' DescribeCapacityReservationFleetsResponse Int Source #
The response's http status code.