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 |
Retrieves the resource capacity settings for one or more fleets. The data returned includes the current fleet capacity (number of EC2 instances), and settings that can control how capacity scaling. For fleets with remote locations, this operation retrieves data for the fleet's home Region only.
This operation can be used in the following ways:
- To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
- To get capacity data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetCapacity
object is returned for each requested
fleet ID. Each FleetCapacity object includes a Location
property,
which is set to the fleet's home Region. When a list of fleet IDs is
provided, attribute objects are returned only for fleets that currently
exist.
Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
This operation returns paginated results.
Synopsis
- data DescribeFleetCapacity = DescribeFleetCapacity' {}
- newDescribeFleetCapacity :: DescribeFleetCapacity
- describeFleetCapacity_fleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text))
- describeFleetCapacity_limit :: Lens' DescribeFleetCapacity (Maybe Natural)
- describeFleetCapacity_nextToken :: Lens' DescribeFleetCapacity (Maybe Text)
- data DescribeFleetCapacityResponse = DescribeFleetCapacityResponse' {
- fleetCapacity :: Maybe [FleetCapacity]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeFleetCapacityResponse :: Int -> DescribeFleetCapacityResponse
- describeFleetCapacityResponse_fleetCapacity :: Lens' DescribeFleetCapacityResponse (Maybe [FleetCapacity])
- describeFleetCapacityResponse_nextToken :: Lens' DescribeFleetCapacityResponse (Maybe Text)
- describeFleetCapacityResponse_httpStatus :: Lens' DescribeFleetCapacityResponse Int
Creating a Request
data DescribeFleetCapacity Source #
See: newDescribeFleetCapacity
smart constructor.
DescribeFleetCapacity' | |
|
Instances
newDescribeFleetCapacity :: DescribeFleetCapacity Source #
Create a value of DescribeFleetCapacity
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:fleetIds:DescribeFleetCapacity'
, describeFleetCapacity_fleetIds
- A unique identifier for the fleet to retrieve capacity information for.
You can use either the fleet ID or ARN value. Leave this parameter empty
to retrieve capacity information for all fleets.
$sel:limit:DescribeFleetCapacity'
, describeFleetCapacity_limit
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages. This parameter
is ignored when the request specifies one or a list of fleet IDs.
DescribeFleetCapacity
, describeFleetCapacity_nextToken
- A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
This parameter is ignored when the request specifies one or a list of
fleet IDs.
Request Lenses
describeFleetCapacity_fleetIds :: Lens' DescribeFleetCapacity (Maybe (NonEmpty Text)) Source #
A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.
describeFleetCapacity_limit :: Lens' DescribeFleetCapacity (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages. This parameter
is ignored when the request specifies one or a list of fleet IDs.
describeFleetCapacity_nextToken :: Lens' DescribeFleetCapacity (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
Destructuring the Response
data DescribeFleetCapacityResponse Source #
See: newDescribeFleetCapacityResponse
smart constructor.
DescribeFleetCapacityResponse' | |
|
Instances
newDescribeFleetCapacityResponse Source #
Create a value of DescribeFleetCapacityResponse
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:fleetCapacity:DescribeFleetCapacityResponse'
, describeFleetCapacityResponse_fleetCapacity
- A collection of objects that contains capacity information for each
requested fleet ID. Capacity objects are returned only for fleets that
currently exist.
DescribeFleetCapacity
, describeFleetCapacityResponse_nextToken
- A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:httpStatus:DescribeFleetCapacityResponse'
, describeFleetCapacityResponse_httpStatus
- The response's http status code.
Response Lenses
describeFleetCapacityResponse_fleetCapacity :: Lens' DescribeFleetCapacityResponse (Maybe [FleetCapacity]) Source #
A collection of objects that contains capacity information for each requested fleet ID. Capacity objects are returned only for fleets that currently exist.
describeFleetCapacityResponse_nextToken :: Lens' DescribeFleetCapacityResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
describeFleetCapacityResponse_httpStatus :: Lens' DescribeFleetCapacityResponse Int Source #
The response's http status code.