nextToken
input property to facilitate pagination. By default, if a limit is not provided, or set as undefined/nil/null
, the default limit will be 10.nextToken
, otherwise the result will return an error. When a paginated API call is successful, the output response will contain a nextToken
property.nextToken
. Due to the nature of the data access from the service, it is possible to retrieve a result with no data but potentially have another page of information to retrieve which may contain results.nextToken
in the subsequent API call. If a successful response does not return a nextToken
, or it is set to undefined/nil/null
, the pagination results have been exhausted and there are no more pages to retrieve.limit
) is the same for each call, otherwise unexpected behavior will occur. For example, if the first call uses an input property of limit = 8
, then each subsequent call must use a limit
of 8
.getEmailAddresses
for a user with four email addresses and paginating through the results:do...while
loop will have the listOutput
return an array of items
containing two EmailAddress
objects, as well as a populated nextToken
which is used in the subsequent call in the next iteration. The second iteration will have the listOutput
return an array of items
containing two EmailAddress
objects, however the nextToken
will be undefined
as there are no more objects for the query to fetch.getEmailAddressesWithFilter
for a user with 4 email addresses:DispatchSemaphore
was used for simplifying the demonstration, we strongly recommend using GCD's Operation
for handling asynchronous code.