| Copyright | (c) 2013-2021 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 |
Amazonka.RobOMaker.ListFleets
Description
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
This operation returns paginated results.
Synopsis
- data ListFleets = ListFleets' {}
- newListFleets :: ListFleets
- listFleets_filters :: Lens' ListFleets (Maybe (NonEmpty Filter))
- listFleets_nextToken :: Lens' ListFleets (Maybe Text)
- listFleets_maxResults :: Lens' ListFleets (Maybe Int)
- data ListFleetsResponse = ListFleetsResponse' {
- fleetDetails :: Maybe [Fleet]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListFleetsResponse :: Int -> ListFleetsResponse
- listFleetsResponse_fleetDetails :: Lens' ListFleetsResponse (Maybe [Fleet])
- listFleetsResponse_nextToken :: Lens' ListFleetsResponse (Maybe Text)
- listFleetsResponse_httpStatus :: Lens' ListFleetsResponse Int
Creating a Request
data ListFleets Source #
See: newListFleets smart constructor.
Constructors
| ListFleets' | |
Fields
| |
Instances
newListFleets :: ListFleets Source #
Create a value of ListFleets 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:filters:ListFleets', listFleets_filters - Optional filters to limit results.
The filter name name is supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters.
$sel:nextToken:ListFleets', listFleets_nextToken - If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a
token. To retrieve the next set of results, call ListFleets again and
assign that token to the request object's nextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
$sel:maxResults:ListFleets', listFleets_maxResults - When this parameter is used, ListFleets only returns maxResults
results in a single page along with a nextToken response element. The
remaining results of the initial request can be seen by sending another
ListFleets request with the returned nextToken value. This value can
be between 1 and 200. If this parameter is not used, then ListFleets
returns up to 200 results and a nextToken value if applicable.
Request Lenses
listFleets_filters :: Lens' ListFleets (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results.
The filter name name is supported. When filtering, you must use the
complete value of the filtered item. You can use up to three filters.
listFleets_nextToken :: Lens' ListFleets (Maybe Text) Source #
If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a
token. To retrieve the next set of results, call ListFleets again and
assign that token to the request object's nextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
listFleets_maxResults :: Lens' ListFleets (Maybe Int) Source #
When this parameter is used, ListFleets only returns maxResults
results in a single page along with a nextToken response element. The
remaining results of the initial request can be seen by sending another
ListFleets request with the returned nextToken value. This value can
be between 1 and 200. If this parameter is not used, then ListFleets
returns up to 200 results and a nextToken value if applicable.
Destructuring the Response
data ListFleetsResponse Source #
See: newListFleetsResponse smart constructor.
Constructors
| ListFleetsResponse' | |
Fields
| |
Instances
newListFleetsResponse Source #
Arguments
| :: Int | |
| -> ListFleetsResponse |
Create a value of ListFleetsResponse 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:fleetDetails:ListFleetsResponse', listFleetsResponse_fleetDetails - A list of fleet details meeting the request criteria.
$sel:nextToken:ListFleets', listFleetsResponse_nextToken - If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a
token. To retrieve the next set of results, call ListFleets again and
assign that token to the request object's nextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
$sel:httpStatus:ListFleetsResponse', listFleetsResponse_httpStatus - The response's http status code.
Response Lenses
listFleetsResponse_fleetDetails :: Lens' ListFleetsResponse (Maybe [Fleet]) Source #
A list of fleet details meeting the request criteria.
listFleetsResponse_nextToken :: Lens' ListFleetsResponse (Maybe Text) Source #
If the previous paginated request did not return all of the remaining
results, the response object's nextToken parameter value is set to a
token. To retrieve the next set of results, call ListFleets again and
assign that token to the request object's nextToken parameter. If
there are no remaining results, the previous response object's
NextToken parameter is set to null.
listFleetsResponse_httpStatus :: Lens' ListFleetsResponse Int Source #
The response's http status code.