Skip to content

Commit 39a5918

Browse files
authored
Clarification on which SdkClientException subclasses may be retryable (#3016)
1 parent afccc1e commit 39a5918

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

core/sdk-core/src/main/java/software/amazon/awssdk/core/exception/SdkClientException.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@
1616
package software.amazon.awssdk.core.exception;
1717

1818
import software.amazon.awssdk.annotations.SdkPublicApi;
19+
import software.amazon.awssdk.core.internal.retry.SdkDefaultRetrySetting;
1920

2021
/**
2122
* Base type for all client exceptions thrown by the SDK.
2223
*
2324
* This exception is thrown when service could not be contacted for a response,
2425
* or when client is unable to parse the response from service.
25-
*
26-
* All exceptions that extend {@link SdkClientException} are assumed to be
27-
* not retryable.
26+
* <p>
27+
* Exceptions that extend {@link SdkClientException} are assumed to be not retryable, with a few exceptions:
28+
* <ul>
29+
* <li>{@link RetryableException} - usable when calls should explicitly be retried</li>
30+
* <li>Exceptions mentioned as a retryable exception in {@link SdkDefaultRetrySetting}</li>
31+
* </ul>
2832
*
2933
* @see SdkServiceException
3034
*/

0 commit comments

Comments
 (0)