diff --git a/paws.common/R/paginate.R b/paws.common/R/paginate.R index aa3f54a72..dfd3ced00 100644 --- a/paws.common/R/paginate.R +++ b/paws.common/R/paginate.R @@ -19,7 +19,9 @@ #' @param MaxItems Limits the maximum number of total returned items returned while paginating. #' @param StartingToken Can be used to modify the starting marker or token of a paginator. #' This argument if useful for resuming pagination from a previous token or starting pagination at a known position. -#' @param StopOnSameToken Exist paginator if previous token matches current token. +#' @param StopOnSameToken Exits paginator if previous token matches current token. +#' For some APIs, such as CloudWatchLogs events, the next page token will always be present. +#' When set to \code{TRUE}, the paginator will stop when the token doesn't change. #' @param FUN the function to be applied to each response element of \code{operation}. #' @param simplify See \link[base:sapply]{base::sapply()}. #' @param ... optional arguments to \code{FUN}. diff --git a/paws.common/man/paginate.Rd b/paws.common/man/paginate.Rd index 9185f2468..8daae1a57 100644 --- a/paws.common/man/paginate.Rd +++ b/paws.common/man/paginate.Rd @@ -45,7 +45,9 @@ paginate_sapply( \item{StartingToken}{Can be used to modify the starting marker or token of a paginator. This argument if useful for resuming pagination from a previous token or starting pagination at a known position.} -\item{StopOnSameToken}{Exist paginator if previous token matches current token.} +\item{StopOnSameToken}{Exits paginator if previous token matches current token. +For some APIs, such as CloudWatchLogs events, the next page token will always be present. +When set to \code{TRUE}, the paginator will stop when the token doesn't change.} \item{FUN}{the function to be applied to each response element of \code{operation}.}