Interface Apiv2PaginationConfiguration

interface Apiv2PaginationConfiguration {
    client: Apiv2Client;
    pageSize?: number;
    startingToken?: any;
    stopOnSameToken?: boolean;
    withCommand?: (
        command: Command<any, any, any, any, any>,
    ) => undefined | Command<any, any, any, any, any>;
}

Hierarchy

  • PaginationConfiguration
    • Apiv2PaginationConfiguration

Properties

client pageSize? startingToken? stopOnSameToken? withCommand?

Properties

client

client: Apiv2Client

OptionalpageSize

pageSize?: number

OptionalstartingToken

startingToken?: any

OptionalstopOnSameToken

stopOnSameToken?: boolean

For some APIs, such as CloudWatchLogs events, the next page token will always be present.

When true, this config field will have the paginator stop when the token doesn't change instead of when it is not present.

OptionalwithCommand

withCommand?: (
    command: Command<any, any, any, any, any>,
) => undefined | Command<any, any, any, any, any>

Type declaration

    • (
          command: Command<any, any, any, any, any>,
      ): undefined | Command<any, any, any, any, any>

    • Parameters

      • command: Command<any, any, any, any, any>

        reference to the instantiated command. This callback is executed prior to sending the command with the paginator's client.

      Returns undefined | Command<any, any, any, any, any>

      the original command or a replacement, defaulting to the original command object.

Settings

Member Visibility

On This Page

Properties