Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting all fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
- describeFleetAttributes :: DescribeFleetAttributes
- data DescribeFleetAttributes
- dfaNextToken :: Lens' DescribeFleetAttributes (Maybe Text)
- dfaLimit :: Lens' DescribeFleetAttributes (Maybe Natural)
- dfaFleetIds :: Lens' DescribeFleetAttributes (Maybe (NonEmpty Text))
- describeFleetAttributesResponse :: Int -> DescribeFleetAttributesResponse
- data DescribeFleetAttributesResponse
- dfarsNextToken :: Lens' DescribeFleetAttributesResponse (Maybe Text)
- dfarsFleetAttributes :: Lens' DescribeFleetAttributesResponse [FleetAttributes]
- dfarsResponseStatus :: Lens' DescribeFleetAttributesResponse Int
Creating a Request
describeFleetAttributes :: DescribeFleetAttributes Source
Creates a value of DescribeFleetAttributes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeFleetAttributes Source
Represents the input for a request action.
See: describeFleetAttributes
smart constructor.
Request Lenses
dfaNextToken :: Lens' DescribeFleetAttributes (Maybe Text) Source
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
dfaLimit :: Lens' DescribeFleetAttributes (Maybe Natural) Source
Maximum number of results to return. You can 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.
dfaFleetIds :: Lens' DescribeFleetAttributes (Maybe (NonEmpty Text)) Source
Unique identifiers for the fleet(s) that you want to retrieve attributes for. Leave this parameter empty to retrieve attributes for all fleets.
Destructuring the Response
describeFleetAttributesResponse Source
Creates a value of DescribeFleetAttributesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeFleetAttributesResponse Source
Represents the returned data in response to a request action.
See: describeFleetAttributesResponse
smart constructor.
Response Lenses
dfarsNextToken :: Lens' DescribeFleetAttributesResponse (Maybe Text) Source
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
dfarsFleetAttributes :: Lens' DescribeFleetAttributesResponse [FleetAttributes] Source
Collection of objects containing attribute metadata for each requested fleet ID.
dfarsResponseStatus :: Lens' DescribeFleetAttributesResponse Int Source
The response status code.