nextToken
A pagination token used to return a set of results. When the Query
API is invoked using NextToken
, that particular invocation is assumed to be a subsequent invocation of a prior call to Query
, and a result set is returned. However, if the Query
invocation only contains the ClientToken
, that invocation of Query
is assumed to be a new query run.
Note the following when using NextToken in a query:
A pagination token can be used for up to five
Query
invocations, OR for a duration of up to 1 hour – whichever comes first.Using the same
NextToken
will return the same set of records. To keep paginating through the result set, you must to use the most recentnextToken
.Suppose a
Query
invocation returns twoNextToken
values,TokenA
andTokenB
. IfTokenB
is used in a subsequentQuery
invocation, thenTokenA
is invalidated and cannot be reused.To request a previous result set from a query after pagination has begun, you must re-invoke the Query API.
The latest
NextToken
should be used to paginate untilnull
is returned, at which point a newNextToken
should be used.If the IAM principal of the query initiator and the result reader are not the same and/or the query initiator and the result reader do not have the same query string in the query requests, the query will fail with an
Invalid pagination token
error.