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
Namespace: Amazon.Runtime
Assembly: AWSSDK.Core.dll
Version: 3.x.y.z
Syntax
public abstract class RetryPolicy
The RetryPolicy type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
ErrorCodesToRetryOn | System.Collections.Generic.ICollection<System.String> |
List of AWS specific error codes which are returned as part of the error response. These error codes will be retried. |
|
|
HttpStatusCodesToRetryOn | System.Collections.Generic.ICollection<System.Net.HttpStatusCode> |
The standard set of transient error, HTTP status codes to retry on. 502 and 504 are returned by proxies. These can also be returned for S3 accelerate requests which are served by CloudFront. |
|
|
Logger | Amazon.Runtime.Internal.Util.ILogger |
The logger used to log messages. |
|
|
MaxRetries | System.Int32 |
Maximum number of retries to be performed. This does not count the initial request. |
|
|
ThrottlingErrorCodes | System.Collections.Generic.ICollection<System.String> |
The standard set of throttling error codes |
|
|
TimeoutErrorCodesToRetryOn | System.Collections.Generic.ICollection<System.String> |
The standard set of timeout error codes to retry on. |
|
|
WebExceptionStatusesToRetryOn | System.Collections.Generic.ICollection<System.Net.WebExceptionStatus> |
Set of web exception status codes to retry on. |
Methods
| Name | Description | |
|---|---|---|
|
|
CanRetry(IExecutionContext) |
Returns true if the request is in a state where it can be retried, else false. |
|
|
IsServiceTimeoutError(Exception) |
Determines if the exception is a known timeout error code that should be retried under the timeout error category. |
|
|
IsThrottlingError(Exception) |
Determines if an AmazonServiceException is a throttling error |
|
|
IsTransientError(IExecutionContext, Exception) |
Determines if an AmazonServiceException is a transient error that should be retried. |
|
|
IsTransientSslError(Exception) | |
|
|
NotifySuccess(IExecutionContext) |
Virtual method that gets called on a successful request response. |
|
|
ObtainSendToken(IExecutionContext, Exception) |
This method uses a token bucket to enforce the maximum sending rate. |
|
|
ObtainSendTokenAsync(IExecutionContext, Exception) |
This method uses a token bucket to enforce the maximum sending rate. |
|
|
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). |
|
|
OnRetry(IExecutionContext, bool) |
Virtual method that gets called before a retry request is initiated. The value returned is True by default(retry throttling feature is disabled). |
|
|
OnRetry(IExecutionContext, bool, bool) |
Virtual method that gets called before a retry request is initiated. The value returned is True by default(retry throttling feature is disabled). |
|
|
Retry(IExecutionContext, Exception) |
Checks if a retry should be performed with the given execution context and exception. |
|
|
RetryAsync(IExecutionContext, Exception) |
Checks if a retry should be performed with the given execution context and exception. |
|
|
RetryForException(IExecutionContext, Exception) |
Return true if the request should be retried for the given exception. |
|
|
RetryForExceptionAsync(IExecutionContext, Exception) |
Return true if the request should be retried for the given exception. |
|
|
RetryLimitReached(IExecutionContext) |
Checks if the retry limit is reached. |
|
|
WaitBeforeRetry(IExecutionContext) |
Waits before retrying a request. |
|
|
WaitBeforeRetryAsync(IExecutionContext) |
Waits before retrying a request. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5