| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.RobOMaker.ListWorldTemplates
Description
Lists world templates.
This operation returns paginated results.
Synopsis
- data ListWorldTemplates = ListWorldTemplates' {}
- newListWorldTemplates :: ListWorldTemplates
- listWorldTemplates_maxResults :: Lens' ListWorldTemplates (Maybe Int)
- listWorldTemplates_nextToken :: Lens' ListWorldTemplates (Maybe Text)
- data ListWorldTemplatesResponse = ListWorldTemplatesResponse' {}
- newListWorldTemplatesResponse :: Int -> ListWorldTemplatesResponse
- listWorldTemplatesResponse_nextToken :: Lens' ListWorldTemplatesResponse (Maybe Text)
- listWorldTemplatesResponse_templateSummaries :: Lens' ListWorldTemplatesResponse (Maybe [TemplateSummary])
- listWorldTemplatesResponse_httpStatus :: Lens' ListWorldTemplatesResponse Int
Creating a Request
data ListWorldTemplates Source #
See: newListWorldTemplates smart constructor.
Constructors
| ListWorldTemplates' | |
Fields
| |
Instances
newListWorldTemplates :: ListWorldTemplates Source #
Create a value of ListWorldTemplates 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:maxResults:ListWorldTemplates', listWorldTemplates_maxResults - When this parameter is used, ListWorldTemplates 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 ListWorldTemplates request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldTemplates returns up to 100
results and a nextToken value if applicable.
ListWorldTemplates, listWorldTemplates_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 ListWorldTemplates
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.
Request Lenses
listWorldTemplates_maxResults :: Lens' ListWorldTemplates (Maybe Int) Source #
When this parameter is used, ListWorldTemplates 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 ListWorldTemplates request with the returned
nextToken value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldTemplates returns up to 100
results and a nextToken value if applicable.
listWorldTemplates_nextToken :: Lens' ListWorldTemplates (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 ListWorldTemplates
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.
Destructuring the Response
data ListWorldTemplatesResponse Source #
See: newListWorldTemplatesResponse smart constructor.
Constructors
| ListWorldTemplatesResponse' | |
Fields
| |
Instances
newListWorldTemplatesResponse Source #
Create a value of ListWorldTemplatesResponse 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:
ListWorldTemplates, listWorldTemplatesResponse_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 ListWorldTemplates
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:templateSummaries:ListWorldTemplatesResponse', listWorldTemplatesResponse_templateSummaries - Summary information for templates.
$sel:httpStatus:ListWorldTemplatesResponse', listWorldTemplatesResponse_httpStatus - The response's http status code.
Response Lenses
listWorldTemplatesResponse_nextToken :: Lens' ListWorldTemplatesResponse (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 ListWorldTemplates
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.
listWorldTemplatesResponse_templateSummaries :: Lens' ListWorldTemplatesResponse (Maybe [TemplateSummary]) Source #
Summary information for templates.
listWorldTemplatesResponse_httpStatus :: Lens' ListWorldTemplatesResponse Int Source #
The response's http status code.