@aws-sdk/middleware-retry

What is @aws-sdk/middleware-retry?

@aws-sdk/middleware-retry is a middleware package for the AWS SDK for JavaScript that provides retry logic for AWS service requests. It allows developers to automatically retry failed requests based on configurable retry strategies, which can help improve the reliability and resilience of applications interacting with AWS services.

What are @aws-sdk/middleware-retry's main functionalities?

Default Retry Strategy

This feature allows you to use the default retry strategy provided by the AWS SDK. The default strategy includes exponential backoff and jitter to handle transient errors.

const { S3Client } = require('@aws-sdk/client-s3');
const { defaultRetryStrategy } = require('@aws-sdk/middleware-retry');

const client = new S3Client({
  region: 'us-west-2',
  retryStrategy: defaultRetryStrategy()
});

Custom Retry Strategy

This feature allows you to define a custom retry strategy. In this example, the custom strategy retries failed requests up to 3 times.

const { S3Client } = require('@aws-sdk/client-s3');
const { StandardRetryStrategy } = require('@aws-sdk/middleware-retry');

const customRetryStrategy = new StandardRetryStrategy(async () => 3); // Retry up to 3 times

const client = new S3Client({
  region: 'us-west-2',
  retryStrategy: customRetryStrategy
});

Adaptive Retry Strategy

This feature allows you to use the adaptive retry strategy, which adjusts the retry behavior based on the current load and error rates. This can help optimize the retry logic for varying conditions.

const { S3Client } = require('@aws-sdk/client-s3');
const { AdaptiveRetryStrategy } = require('@aws-sdk/middleware-retry');

const adaptiveRetryStrategy = new AdaptiveRetryStrategy();

const client = new S3Client({
  region: 'us-west-2',
  retryStrategy: adaptiveRetryStrategy
});

Other packages similar to @aws-sdk/middleware-retry

axios-retry

axios-retry is a middleware for the Axios HTTP client that automatically retries failed requests. It provides configurable retry strategies, including exponential backoff. Compared to @aws-sdk/middleware-retry, axios-retry is more general-purpose and can be used with any HTTP requests, not just AWS SDK requests.

retry

retry is a general-purpose retry library for JavaScript that allows you to retry any asynchronous operation. It provides flexible retry strategies and can be used in various contexts, including HTTP requests, database queries, and more. Unlike @aws-sdk/middleware-retry, it is not specific to AWS SDK and can be used with any type of operation.

promise-retry

promise-retry is a library that retries failed promises with configurable retry strategies. It is useful for handling transient errors in any promise-based code. While @aws-sdk/middleware-retry is tailored for AWS SDK requests, promise-retry can be used in a broader range of scenarios involving promises.

README

@aws-sdk/middleware-retry

Changelog

3.109.0 (2022-06-13)

Bug Fixes

• s3: update endpoints for writeGetObjectResponse for object lambda (#3662) (bb9f18e)

Features

• client-outposts: This release adds API operations AWS uses to install Outpost servers. (a04c290)