Enum RetryMode
- All Implemented Interfaces:
Serializable
,Comparable<RetryMode>
LEGACY
retry mode will
retry up to three times, and the STANDARD
will retry up to two times.
While the LEGACY
retry mode is specific to Java, the STANDARD
retry mode is standardized across all of the
AWS SDKs.
The retry mode can be configured:
- Directly on a client via
ClientOverrideConfiguration.Builder.retryPolicy(RetryMode)
. - Directly on a client via a combination of
RetryPolicy.builder(RetryMode)
orRetryPolicy.forRetryMode(RetryMode)
, andClientOverrideConfiguration.Builder.retryPolicy(RetryPolicy)
- On a configuration profile via the "retry_mode" profile file property.
- Globally via the "aws.retryMode" system property.
- Globally via the "AWS_RETRY_MODE" environment variable.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Allows customizing the variables used during determination of aRetryMode
. -
Enum Constant Summary
Enum ConstantDescriptionAdaptive retry mode builds onSTANDARD
mode.The LEGACY retry mode, specific to the Java SDK, and characterized by: Up to 3 retries, or more for services like DynamoDB (which has up to 8). Zero token are subtracted from theTokenBucketRetryCondition
when throttling exceptions are encountered.The STANDARD retry mode, shared by all AWS SDK implementations, and characterized by: Up to 2 retries, regardless of service. Throttling exceptions are treated the same as other exceptions for the purposes of theTokenBucketRetryCondition
. -
Method Summary
Modifier and TypeMethodDescriptionstatic RetryMode
Retrieve the default retry mode by consulting the locations described inRetryMode
, or LEGACY if no value is configured.static RetryMode.Resolver
resolver()
Create aRetryMode.Resolver
that allows customizing the variables used during determination of aRetryMode
.static RetryMode
Returns the enum constant of this type with the specified name.static RetryMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
LEGACY
The LEGACY retry mode, specific to the Java SDK, and characterized by:- Up to 3 retries, or more for services like DynamoDB (which has up to 8).
- Zero token are subtracted from the
TokenBucketRetryCondition
when throttling exceptions are encountered.
This is the retry mode that is used when no other mode is configured.
-
STANDARD
The STANDARD retry mode, shared by all AWS SDK implementations, and characterized by:- Up to 2 retries, regardless of service.
- Throttling exceptions are treated the same as other exceptions for the purposes of the
TokenBucketRetryCondition
.
-
ADAPTIVE
Adaptive retry mode builds onSTANDARD
mode.Adaptive retry mode dynamically limits the rate of AWS requests to maximize success rate. This may be at the expense of request latency. Adaptive retry mode is not recommended when predictable latency is important.
Warning: Adaptive retry mode assumes that the client is working against a single resource (e.g. one DynamoDB Table or one S3 Bucket). If you use a single client for multiple resources, throttling or outages associated with one resource will result in increased latency and failures when accessing all other resources via the same client. When using adaptive retry mode, we recommend using a single client per resource.
- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
defaultRetryMode
Retrieve the default retry mode by consulting the locations described inRetryMode
, or LEGACY if no value is configured. -
resolver
Create aRetryMode.Resolver
that allows customizing the variables used during determination of aRetryMode
.
-