Class AdaptiveRetryStrategy

deprected: use AdaptiveRetryStrategy from @aws-sdk/util-retry

Hierarchy

StandardRetryStrategy
- AdaptiveRetryStrategy

Implements

Index

Constructors

constructor

Properties

mode

Methods

Constructors

constructor

new AdaptiveRetryStrategy(maxAttemptsProvider: Provider<number>, options?: AdaptiveRetryStrategyOptions): AdaptiveRetryStrategy
new AdaptiveRetryStrategy(maxAttemptsProvider: Provider<number>, options?: AdaptiveRetryStrategyOptions): AdaptiveRetryStrategy

Overrides StandardRetryStrategy.__constructor
- Defined in packages/util-retry/dist-types/AdaptiveRetryStrategy.d.ts:24
Parameters
- maxAttemptsProvider: Provider<number>
- Optional options: AdaptiveRetryStrategyOptions
Returns AdaptiveRetryStrategy
Overrides StandardRetryStrategy.__constructor
- Defined in packages/middleware-retry/dist-types/AdaptiveRetryStrategy.d.ts:14
Parameters
- maxAttemptsProvider: Provider<number>
- Optional options: AdaptiveRetryStrategyOptions
Returns AdaptiveRetryStrategy

Properties

Readonly mode

mode: string

Methods

acquireInitialRetryToken

acquireInitialRetryToken(retryTokenScope: string): Promise<RetryToken>

Implementation of RetryStrategyV2.acquireInitialRetryToken
- Defined in packages/util-retry/dist-types/AdaptiveRetryStrategy.d.ts:26
Parameters
- retryTokenScope: string
Returns Promise<RetryToken>

recordSuccess

recordSuccess(token: StandardRetryToken): void

- Defined in packages/util-retry/dist-types/AdaptiveRetryStrategy.d.ts:28
Parameters
- token: StandardRetryToken
Returns void

refreshRetryTokenForRetry

refreshRetryTokenForRetry(tokenToRenew: StandardRetryToken, errorInfo: RetryErrorInfo): Promise<RetryToken>

- Defined in packages/util-retry/dist-types/AdaptiveRetryStrategy.d.ts:27
Parameters
- tokenToRenew: StandardRetryToken
- errorInfo: RetryErrorInfo
Returns Promise<RetryToken>

retry

retry<Input, Ouput>(next: FinalizeHandler<Input, Ouput>, args: FinalizeHandlerArguments<Input>): Promise<{ output: Ouput; response: unknown }>

Overrides StandardRetryStrategy.retry
- Defined in packages/middleware-retry/dist-types/AdaptiveRetryStrategy.d.ts:16
Type parameters
- Input: object
- Ouput: MetadataBearer
Parameters
- next: FinalizeHandler<Input, Ouput>
- args: FinalizeHandlerArguments<Input>
Returns Promise<{ output: Ouput; response: unknown }>