@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.235.0 (2022-12-20)

Features

• client-batch: Adds isCancelled and isTerminated to DescribeJobs response. (765cbb9)
• client-ec2: Adds support for pagination in the EC2 DescribeImages API. (a1e5ea8)
• client-lookoutequipment: This release adds support for listing inference schedulers by status. (1d7dc07)
• client-medialive: This release adds support for two new features to AWS Elemental MediaLive. First, you can now burn-in timecodes to your MediaLive outputs. Second, we now now support the ability to decode Dolby E audio when it comes in on an input. (49b07b3)
• client-nimble: Amazon Nimble Studio now supports configuring session storage volumes and persistence, as well as backup and restore sessions through launch profiles. (858e866)
• client-resource-explorer-2: Documentation updates for AWS Resource Explorer. (798b1bf)
• client-route-53-domains: Use Route 53 domain APIs to change owner, create/delete DS record, modify IPS tag, resend authorization. New: AssociateDelegationSignerToDomain, DisassociateDelegationSignerFromDomain, PushDomain, ResendOperationAuthorization. Updated: UpdateDomainContact, ListOperations, CheckDomainTransferability. (38b6bfe)
• client-sagemaker: Amazon SageMaker Autopilot adds support for new objective metrics in CreateAutoMLJob API. (63855ae)
• client-transcribe: Enable our batch transcription jobs for Swedish and Vietnamese. (b8881a0)
• clients: update client endpoints as of 2022-12-20 (1510324)