Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @aws-sdk/middleware-retry

@aws-sdk/middleware-retry

NPM version NPM downloads

Index

References

Enumerations

Classes

Interfaces

Variables

Functions

Object literals

References

AdaptiveRetryStrategy

Re-exports AdaptiveRetryStrategy

AdaptiveRetryStrategyOptions

Re-exports AdaptiveRetryStrategyOptions

CONFIG_MAX_ATTEMPTS

Re-exports CONFIG_MAX_ATTEMPTS

CONFIG_RETRY_MODE

Re-exports CONFIG_RETRY_MODE

DEFAULT_MAX_ATTEMPTS

Re-exports DEFAULT_MAX_ATTEMPTS

DEFAULT_RETRY_MODE

Re-exports DEFAULT_RETRY_MODE

DefaultRateLimiter

Re-exports DefaultRateLimiter

DefaultRateLimiterOptions

Re-exports DefaultRateLimiterOptions

DelayDecider

Re-exports DelayDecider

ENV_MAX_ATTEMPTS

Re-exports ENV_MAX_ATTEMPTS

ENV_RETRY_MODE

Re-exports ENV_RETRY_MODE

NODE_MAX_ATTEMPT_CONFIG_OPTIONS

Re-exports NODE_MAX_ATTEMPT_CONFIG_OPTIONS

NODE_RETRY_MODE_CONFIG_OPTIONS

Re-exports NODE_RETRY_MODE_CONFIG_OPTIONS

RETRY_MODES

Re-exports RETRY_MODES

RateLimiter

Re-exports RateLimiter

RetryDecider

Re-exports RetryDecider

RetryInputConfig

Re-exports RetryInputConfig

RetryQuota

Re-exports RetryQuota

RetryResolvedConfig

Re-exports RetryResolvedConfig

StandardRetryStrategy

Re-exports StandardRetryStrategy

StandardRetryStrategyOptions

Re-exports StandardRetryStrategyOptions

defaultDelayDecider

Re-exports defaultDelayDecider

defaultRetryDecider

Re-exports defaultRetryDecider

getOmitRetryHeadersPlugin

Re-exports getOmitRetryHeadersPlugin

getRetryPlugin

Re-exports getRetryPlugin

omitRetryHeadersMiddleware

Re-exports omitRetryHeadersMiddleware

omitRetryHeadersMiddlewareOptions

Re-exports omitRetryHeadersMiddlewareOptions

resolveRetryConfig

Re-exports resolveRetryConfig

retryMiddleware

Re-exports retryMiddleware

retryMiddlewareOptions

Re-exports retryMiddlewareOptions

Variables

Const CONFIG_MAX_ATTEMPTS

CONFIG_MAX_ATTEMPTS: "max_attempts" = "max_attempts"

Const CONFIG_RETRY_MODE

CONFIG_RETRY_MODE: "retry_mode" = "retry_mode"

Const DEFAULT_MAX_ATTEMPTS

DEFAULT_MAX_ATTEMPTS: 3 = 3

The default value for how many HTTP requests an SDK should make for a single SDK operation invocation before giving up

Const DEFAULT_RETRY_DELAY_BASE

DEFAULT_RETRY_DELAY_BASE: 100 = 100

The base number of milliseconds to use in calculating a suitable cool-down time when a retryable error is encountered.

Const DEFAULT_RETRY_MODE

DEFAULT_RETRY_MODE: STANDARD = RETRY_MODES.STANDARD

The default retry algorithm to use.

Const ENV_MAX_ATTEMPTS

ENV_MAX_ATTEMPTS: "AWS_MAX_ATTEMPTS" = "AWS_MAX_ATTEMPTS"

Const ENV_RETRY_MODE

ENV_RETRY_MODE: "AWS_RETRY_MODE" = "AWS_RETRY_MODE"

Const INITIAL_RETRY_TOKENS

INITIAL_RETRY_TOKENS: 500 = 500

Initial number of retry tokens in Retry Quota

Const INVOCATION_ID_HEADER

INVOCATION_ID_HEADER: "amz-sdk-invocation-id" = "amz-sdk-invocation-id"

Header name for SDK invocation ID

Const MAXIMUM_RETRY_DELAY

MAXIMUM_RETRY_DELAY: number = 20 * 1000

The maximum amount of time (in milliseconds) that will be used as a delay between retry attempts.

Const NO_RETRY_INCREMENT

NO_RETRY_INCREMENT: 1 = 1

The total amount of retry token to be incremented from retry token balance if an SDK operation invocation succeeds without requiring a retry request.

Const REQUEST_HEADER

REQUEST_HEADER: "amz-sdk-request" = "amz-sdk-request"

Header name for request retry information.

Const RETRY_COST

RETRY_COST: 5 = 5

The total amount of retry tokens to be decremented from retry token balance.

Const THROTTLING_RETRY_DELAY_BASE

THROTTLING_RETRY_DELAY_BASE: 500 = 500

The retry delay base (in milliseconds) to use when a throttling error is encountered.

Const TIMEOUT_RETRY_COST

TIMEOUT_RETRY_COST: 10 = 10

The total amount of retry tokens to be decremented from retry token balance when a throttling error is encountered.

Functions

Const asSdkError

Const defaultDelayDecider

  • defaultDelayDecider(delayBase: number, attempts: number): number

Const defaultRetryDecider

  • defaultRetryDecider(error: SdkError): boolean

Const getDefaultRetryQuota

Const getOmitRetryHeadersPlugin

  • getOmitRetryHeadersPlugin(options: unknown): Pluggable<any, any>

Const getRetryPlugin

Const omitRetryHeadersMiddleware

  • omitRetryHeadersMiddleware(): (Anonymous function)

Const resolveRetryConfig

Const retryMiddleware

Object literals

Const NODE_MAX_ATTEMPT_CONFIG_OPTIONS

NODE_MAX_ATTEMPT_CONFIG_OPTIONS: object

default

default: number = DEFAULT_MAX_ATTEMPTS

configFileSelector

  • configFileSelector(profile: Profile): number

environmentVariableSelector

  • environmentVariableSelector(env: ProcessEnv): number

Const NODE_RETRY_MODE_CONFIG_OPTIONS

NODE_RETRY_MODE_CONFIG_OPTIONS: object

default

default: RETRY_MODES = DEFAULT_RETRY_MODE

configFileSelector

  • configFileSelector(profile: Profile): string

environmentVariableSelector

  • environmentVariableSelector(env: ProcessEnv): string

Const omitRetryHeadersMiddlewareOptions

omitRetryHeadersMiddlewareOptions: object

name

name: string = "omitRetryHeadersMiddleware"

override

override: true = true

relation

relation: "before" = "before"

tags

tags: string[] = ["RETRY", "HEADERS", "OMIT_RETRY_HEADERS"]

toMiddleware

toMiddleware: string = "awsAuthMiddleware"

Const retryMiddlewareOptions

retryMiddlewareOptions: object

name

name: string = "retryMiddleware"

override

override: true = true

priority

priority: "high" = "high"

step

step: "finalizeRequest" = "finalizeRequest"

tags

tags: string[] = ["RETRY"]