Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet-related operations include:
CreateFleet
ListFleets
DeleteFleet
- Describe fleets:
DescribeFleetAttributes
DescribeFleetCapacity
DescribeFleetPortSettings
DescribeFleetUtilization
DescribeRuntimeConfiguration
DescribeEC2InstanceLimits
DescribeFleetEvents
- Update fleets:
UpdateFleetAttributes
UpdateFleetCapacity
UpdateFleetPortSettings
UpdateRuntimeConfiguration
- Manage fleet actions:
StartFleetActions
StopFleetActions
Synopsis
- listFleets :: ListFleets
- data ListFleets
- lfBuildId :: Lens' ListFleets (Maybe Text)
- lfNextToken :: Lens' ListFleets (Maybe Text)
- lfLimit :: Lens' ListFleets (Maybe Natural)
- listFleetsResponse :: Int -> ListFleetsResponse
- data ListFleetsResponse
- lfrsNextToken :: Lens' ListFleetsResponse (Maybe Text)
- lfrsFleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text))
- lfrsResponseStatus :: Lens' ListFleetsResponse Int
Creating a Request
listFleets :: ListFleets Source #
Creates a value of ListFleets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfBuildId
- Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.lfNextToken
- Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.lfLimit
- Maximum number of results to return. Use this parameter withNextToken
to get results as a set of sequential pages.
data ListFleets Source #
Represents the input for a request action.
See: listFleets
smart constructor.
Instances
Request Lenses
lfBuildId :: Lens' ListFleets (Maybe Text) Source #
Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.
lfNextToken :: Lens' ListFleets (Maybe Text) Source #
Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
lfLimit :: Lens' ListFleets (Maybe Natural) Source #
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
Destructuring the Response
Creates a value of ListFleetsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lfrsNextToken
- Token that indicates 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.lfrsFleetIds
- Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call toDescribeFleetAttributes
,DescribeFleetCapacity
, orDescribeFleetUtilization
.lfrsResponseStatus
- -- | The response status code.
data ListFleetsResponse Source #
Represents the returned data in response to a request action.
See: listFleetsResponse
smart constructor.
Instances
Response Lenses
lfrsNextToken :: Lens' ListFleetsResponse (Maybe Text) Source #
Token that indicates 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.
lfrsFleetIds :: Lens' ListFleetsResponse (Maybe (NonEmpty Text)) Source #
Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes
, DescribeFleetCapacity
, or DescribeFleetUtilization
.
lfrsResponseStatus :: Lens' ListFleetsResponse Int Source #
- - | The response status code.