Retries record failures within a Kinesis batch put

KinesisRetrier will retry any failed records within a batch put, but will NOT retry the KinesisClient.send() call itself if that throws.

Hierarchy

  • KinesisRetrier

Implements

Constructors

  • Creates a new KinesisRetrier

    KinesisRetrier will retry any failed records within a batch put, but will NOT retry the KinesisClient.send() call itself if that throws.

    Parameters

    • options: {
          kinesisClient: KinesisClient;
          retries?: number;
          retryBaseDelayMS?: number;
      }

      KinesisRetrier options

      • kinesisClient: KinesisClient

        The KinesisClient instance

      • Optional retries?: number

        Max number of retries for the batch - Default 5

      • Optional retryBaseDelayMS?: number

        Delay, in milliseconds, for the first exponential backoff after a failure

    Returns KinesisRetrier

Properties

_kinesisClient: KinesisClient
_retries: number
_retryBaseDelayMS: number

Methods

  • Send a PutRecordsCommand and retry any failures with exponential backoff

    Parameters

    • command: PutRecordsCommand

    Returns Promise<PutRecordsCommandOutput>

Generated using TypeDoc