AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A retry policy specifies all aspects of retry behavior. This includes conditions when the request should be retried, checks of retry limit, preparing the request before retry and introducing delay (backoff) before retries.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.RetryPolicy

Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z

Syntax

C#
public abstract class RetryPolicy

The RetryPolicy type exposes the following members

Properties

NameTypeDescription
Public Property Logger Amazon.Runtime.Internal.Util.ILogger

The logger used to log messages.

Public Property MaxRetries System.Int32

Maximum number of retries to be performed. This does not count the initial request.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CanRetry(IExecutionContext)

Returns true if the request is in a state where it can be retried, else false.

Public Method NotifySuccess(IExecutionContext)

Virtual method that gets called on a successful request response.

Public Method OnRetry(IExecutionContext)

Virtual method that gets called before a retry request is initiated. The value returned is True by default(retry throttling feature is disabled).

Public Method Retry(IExecutionContext, Exception)

Checks if a retry should be performed with the given execution context and exception.

Public Method RetryAsync(IExecutionContext, Exception)

Checks if a retry should be performed with the given execution context and exception.

Public Method RetryForException(IExecutionContext, Exception)

Return true if the request should be retried for the given exception.

Public Method RetryForExceptionAsync(IExecutionContext, Exception)

Return true if the request should be retried for the given exception.

Public Method RetryLimitReached(IExecutionContext)

Checks if the retry limit is reached.

Public Method WaitBeforeRetry(IExecutionContext)

Waits before retrying a request.

Public Method WaitBeforeRetryAsync(IExecutionContext)

Waits before retrying a request.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone