| 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.ListRobotApplications
Description
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
This operation returns paginated results.
Synopsis
- data ListRobotApplications = ListRobotApplications' {}
- newListRobotApplications :: ListRobotApplications
- listRobotApplications_versionQualifier :: Lens' ListRobotApplications (Maybe Text)
- listRobotApplications_filters :: Lens' ListRobotApplications (Maybe (NonEmpty Filter))
- listRobotApplications_nextToken :: Lens' ListRobotApplications (Maybe Text)
- listRobotApplications_maxResults :: Lens' ListRobotApplications (Maybe Int)
- data ListRobotApplicationsResponse = ListRobotApplicationsResponse' {}
- newListRobotApplicationsResponse :: Int -> ListRobotApplicationsResponse
- listRobotApplicationsResponse_robotApplicationSummaries :: Lens' ListRobotApplicationsResponse (Maybe [RobotApplicationSummary])
- listRobotApplicationsResponse_nextToken :: Lens' ListRobotApplicationsResponse (Maybe Text)
- listRobotApplicationsResponse_httpStatus :: Lens' ListRobotApplicationsResponse Int
Creating a Request
data ListRobotApplications Source #
See: newListRobotApplications smart constructor.
Constructors
| ListRobotApplications' | |
Fields
| |
Instances
newListRobotApplications :: ListRobotApplications Source #
Create a value of ListRobotApplications 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:versionQualifier:ListRobotApplications', listRobotApplications_versionQualifier - The version qualifier of the robot application.
$sel:filters:ListRobotApplications', listRobotApplications_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:ListRobotApplications', listRobotApplications_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 ListRobotApplications
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:ListRobotApplications', listRobotApplications_maxResults - When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListRobotApplications returns up to 100
results and a nextToken value if applicable.
Request Lenses
listRobotApplications_versionQualifier :: Lens' ListRobotApplications (Maybe Text) Source #
The version qualifier of the robot application.
listRobotApplications_filters :: Lens' ListRobotApplications (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.
listRobotApplications_nextToken :: Lens' ListRobotApplications (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 ListRobotApplications
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.
listRobotApplications_maxResults :: Lens' ListRobotApplications (Maybe Int) Source #
When this parameter is used, ListRobotApplications 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 ListRobotApplications request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListRobotApplications returns up to 100
results and a nextToken value if applicable.
Destructuring the Response
data ListRobotApplicationsResponse Source #
See: newListRobotApplicationsResponse smart constructor.
Constructors
| ListRobotApplicationsResponse' | |
Fields
| |
Instances
newListRobotApplicationsResponse Source #
Create a value of ListRobotApplicationsResponse 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:robotApplicationSummaries:ListRobotApplicationsResponse', listRobotApplicationsResponse_robotApplicationSummaries - A list of robot application summaries that meet the criteria of the
request.
$sel:nextToken:ListRobotApplications', listRobotApplicationsResponse_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 ListRobotApplications
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:ListRobotApplicationsResponse', listRobotApplicationsResponse_httpStatus - The response's http status code.
Response Lenses
listRobotApplicationsResponse_robotApplicationSummaries :: Lens' ListRobotApplicationsResponse (Maybe [RobotApplicationSummary]) Source #
A list of robot application summaries that meet the criteria of the request.
listRobotApplicationsResponse_nextToken :: Lens' ListRobotApplicationsResponse (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 ListRobotApplications
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.
listRobotApplicationsResponse_httpStatus :: Lens' ListRobotApplicationsResponse Int Source #
The response's http status code.