| 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.ListWorlds
Description
Lists worlds.
This operation returns paginated results.
Synopsis
- data ListWorlds = ListWorlds' {}
- newListWorlds :: ListWorlds
- listWorlds_filters :: Lens' ListWorlds (Maybe (NonEmpty Filter))
- listWorlds_nextToken :: Lens' ListWorlds (Maybe Text)
- listWorlds_maxResults :: Lens' ListWorlds (Maybe Int)
- data ListWorldsResponse = ListWorldsResponse' {
- nextToken :: Maybe Text
- worldSummaries :: Maybe [WorldSummary]
- httpStatus :: Int
- newListWorldsResponse :: Int -> ListWorldsResponse
- listWorldsResponse_nextToken :: Lens' ListWorldsResponse (Maybe Text)
- listWorldsResponse_worldSummaries :: Lens' ListWorldsResponse (Maybe [WorldSummary])
- listWorldsResponse_httpStatus :: Lens' ListWorldsResponse Int
Creating a Request
data ListWorlds Source #
See: newListWorlds smart constructor.
Constructors
| ListWorlds' | |
Fields
| |
Instances
newListWorlds :: ListWorlds Source #
Create a value of ListWorlds 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:ListWorlds', listWorlds_filters - Optional filters to limit results. You can use status.
$sel:nextToken:ListWorlds', listWorlds_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 ListWorlds 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:ListWorlds', listWorlds_maxResults - When this parameter is used, ListWorlds 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
ListWorlds request with the returned nextToken value. This value can
be between 1 and 100. If this parameter is not used, then ListWorlds
returns up to 100 results and a nextToken value if applicable.
Request Lenses
listWorlds_filters :: Lens' ListWorlds (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results. You can use status.
listWorlds_nextToken :: Lens' ListWorlds (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 ListWorlds 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.
listWorlds_maxResults :: Lens' ListWorlds (Maybe Int) Source #
When this parameter is used, ListWorlds 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
ListWorlds request with the returned nextToken value. This value can
be between 1 and 100. If this parameter is not used, then ListWorlds
returns up to 100 results and a nextToken value if applicable.
Destructuring the Response
data ListWorldsResponse Source #
See: newListWorldsResponse smart constructor.
Constructors
| ListWorldsResponse' | |
Fields
| |
Instances
newListWorldsResponse Source #
Arguments
| :: Int | |
| -> ListWorldsResponse |
Create a value of ListWorldsResponse 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:nextToken:ListWorlds', listWorldsResponse_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 ListWorlds 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:worldSummaries:ListWorldsResponse', listWorldsResponse_worldSummaries - Summary information for worlds.
$sel:httpStatus:ListWorldsResponse', listWorldsResponse_httpStatus - The response's http status code.
Response Lenses
listWorldsResponse_nextToken :: Lens' ListWorldsResponse (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 ListWorlds 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.
listWorldsResponse_worldSummaries :: Lens' ListWorldsResponse (Maybe [WorldSummary]) Source #
Summary information for worlds.
listWorldsResponse_httpStatus :: Lens' ListWorldsResponse Int Source #
The response's http status code.