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 |
Lists world export jobs.
This operation returns paginated results.
Synopsis
- data ListWorldExportJobs = ListWorldExportJobs' {}
- newListWorldExportJobs :: ListWorldExportJobs
- listWorldExportJobs_filters :: Lens' ListWorldExportJobs (Maybe (NonEmpty Filter))
- listWorldExportJobs_nextToken :: Lens' ListWorldExportJobs (Maybe Text)
- listWorldExportJobs_maxResults :: Lens' ListWorldExportJobs (Maybe Int)
- data ListWorldExportJobsResponse = ListWorldExportJobsResponse' {}
- newListWorldExportJobsResponse :: Int -> ListWorldExportJobsResponse
- listWorldExportJobsResponse_nextToken :: Lens' ListWorldExportJobsResponse (Maybe Text)
- listWorldExportJobsResponse_httpStatus :: Lens' ListWorldExportJobsResponse Int
- listWorldExportJobsResponse_worldExportJobSummaries :: Lens' ListWorldExportJobsResponse [WorldExportJobSummary]
Creating a Request
data ListWorldExportJobs Source #
See: newListWorldExportJobs
smart constructor.
ListWorldExportJobs' | |
|
Instances
newListWorldExportJobs :: ListWorldExportJobs Source #
Create a value of ListWorldExportJobs
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:ListWorldExportJobs'
, listWorldExportJobs_filters
- Optional filters to limit results. You can use generationJobId
and
templateId
.
$sel:nextToken:ListWorldExportJobs'
, listWorldExportJobs_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 ListWorldExportJobs
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:ListWorldExportJobs'
, listWorldExportJobs_maxResults
- When this parameter is used, ListWorldExportJobs
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 ListWorldExportJobs
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldExportJobs
returns up to 100
results and a nextToken
value if applicable.
Request Lenses
listWorldExportJobs_filters :: Lens' ListWorldExportJobs (Maybe (NonEmpty Filter)) Source #
Optional filters to limit results. You can use generationJobId
and
templateId
.
listWorldExportJobs_nextToken :: Lens' ListWorldExportJobs (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 ListWorldExportJobs
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.
listWorldExportJobs_maxResults :: Lens' ListWorldExportJobs (Maybe Int) Source #
When this parameter is used, ListWorldExportJobs
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 ListWorldExportJobs
request with the returned
nextToken
value. This value can be between 1 and 100. If this
parameter is not used, then ListWorldExportJobs
returns up to 100
results and a nextToken
value if applicable.
Destructuring the Response
data ListWorldExportJobsResponse Source #
See: newListWorldExportJobsResponse
smart constructor.
ListWorldExportJobsResponse' | |
|
Instances
newListWorldExportJobsResponse Source #
Create a value of ListWorldExportJobsResponse
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:ListWorldExportJobs'
, listWorldExportJobsResponse_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
ListWorldExportJobsRequest
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:ListWorldExportJobsResponse'
, listWorldExportJobsResponse_httpStatus
- The response's http status code.
$sel:worldExportJobSummaries:ListWorldExportJobsResponse'
, listWorldExportJobsResponse_worldExportJobSummaries
- Summary information for world export jobs.
Response Lenses
listWorldExportJobsResponse_nextToken :: Lens' ListWorldExportJobsResponse (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
ListWorldExportJobsRequest
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.
listWorldExportJobsResponse_httpStatus :: Lens' ListWorldExportJobsResponse Int Source #
The response's http status code.
listWorldExportJobsResponse_worldExportJobSummaries :: Lens' ListWorldExportJobsResponse [WorldExportJobSummary] Source #
Summary information for world export jobs.