| 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.ListRobots
Description
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
This operation returns paginated results.
Synopsis
- data ListRobots = ListRobots' {}
- newListRobots :: ListRobots
- listRobots_filters :: Lens' ListRobots (Maybe (NonEmpty Filter))
- listRobots_nextToken :: Lens' ListRobots (Maybe Text)
- listRobots_maxResults :: Lens' ListRobots (Maybe Int)
- data ListRobotsResponse = ListRobotsResponse' {}
- newListRobotsResponse :: Int -> ListRobotsResponse
- listRobotsResponse_robots :: Lens' ListRobotsResponse (Maybe [Robot])
- listRobotsResponse_nextToken :: Lens' ListRobotsResponse (Maybe Text)
- listRobotsResponse_httpStatus :: Lens' ListRobotsResponse Int
Creating a Request
data ListRobots Source #
See: newListRobots smart constructor.
Constructors
| ListRobots' | |
Fields
| |
Instances
newListRobots :: ListRobots Source #
Create a value of ListRobots 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:ListRobots', listRobots_filters - Optional filters to limit results.
The filter names status and fleetName are supported. When filtering,
you must use the complete value of the filtered item. You can use up to
three filters, but they must be for the same named item. For example, if
you are looking for items with the status Registered or the status
Available.
$sel:nextToken:ListRobots', listRobots_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 ListRobots 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:maxResults:ListRobots', listRobots_maxResults - When this parameter is used, ListRobots 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
ListRobots request with the returned nextToken value. This value can
be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200 results and a nextToken value if applicable.
Request Lenses
listRobots_filters :: Lens' ListRobots (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results.
The filter names status and fleetName are supported. When filtering,
you must use the complete value of the filtered item. You can use up to
three filters, but they must be for the same named item. For example, if
you are looking for items with the status Registered or the status
Available.
listRobots_nextToken :: Lens' ListRobots (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 ListRobots 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.
listRobots_maxResults :: Lens' ListRobots (Maybe Int) Source #
When this parameter is used, ListRobots 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
ListRobots request with the returned nextToken value. This value can
be between 1 and 200. If this parameter is not used, then ListRobots
returns up to 200 results and a nextToken value if applicable.
Destructuring the Response
data ListRobotsResponse Source #
See: newListRobotsResponse smart constructor.
Constructors
| ListRobotsResponse' | |
Fields
| |
Instances
newListRobotsResponse Source #
Arguments
| :: Int | |
| -> ListRobotsResponse |
Create a value of ListRobotsResponse 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:robots:ListRobotsResponse', listRobotsResponse_robots - A list of robots that meet the criteria of the request.
$sel:nextToken:ListRobots', listRobotsResponse_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 ListRobots 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:ListRobotsResponse', listRobotsResponse_httpStatus - The response's http status code.
Response Lenses
listRobotsResponse_robots :: Lens' ListRobotsResponse (Maybe [Robot]) Source #
A list of robots that meet the criteria of the request.
listRobotsResponse_nextToken :: Lens' ListRobotsResponse (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 ListRobots 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.
listRobotsResponse_httpStatus :: Lens' ListRobotsResponse Int Source #
The response's http status code.