Skip to content

docs: improve documentation for AwsRetryPolicy #1678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 11, 2025
Merged

docs: improve documentation for AwsRetryPolicy #1678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changes/13ef4936-91c8-45ec-9cb3-98f651488130.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"id": "13ef4936-91c8-45ec-9cb3-98f651488130",
"type": "documentation",
"description": "Improve documentation for [`AwsRetryPolicy`](https://docs.aws.amazon.com/sdk-for-kotlin/api/latest/aws-http/aws.sdk.kotlin.runtime.http.retries/-aws-retry-policy/)"
}
34 changes: 33 additions & 1 deletion aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/retries/AwsRetryPolicy.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,41 @@ import aws.smithy.kotlin.runtime.ServiceErrorMetadata
import aws.smithy.kotlin.runtime.ServiceException
import aws.smithy.kotlin.runtime.http.response.HttpResponse
import aws.smithy.kotlin.runtime.retries.policy.RetryDirective
import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.*
import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.Throttling
import aws.smithy.kotlin.runtime.retries.policy.RetryErrorType.Transient
import aws.smithy.kotlin.runtime.retries.policy.StandardRetryPolicy

/**
* The standard policy for AWS service clients that defines which error conditions are retryable and how. This policy
* will evaluate the following exceptions as retryable:
*
* * Any [ServiceException] with an `sdkErrorMetadata.errorCode` of:
* * `BandwidthLimitExceeded`
* * `EC2ThrottledException`
* * `IDPCommunicationError`
* * `LimitExceededException`
* * `PriorRequestNotComplete`
* * `ProvisionedThroughputExceededException`
* * `RequestLimitExceeded`
* * `RequestThrottled`
* * `RequestThrottledException`
* * `RequestTimeout`
* * `RequestTimeoutException`
* * `SlowDown`
* * `ThrottledException`
* * `Throttling`
* * `ThrottlingException`
* * `TooManyRequestsException`
* * `TransactionInProgressException`
* * Any [ServiceException] with an `sdkErrorMetadata.statusCode` of:
* * 500 (Internal Service Error)
* * 502 (Bad Gateway)
* * 503 (Service Unavailable)
* * 504 (Gateway Timeout)
*
* If none of those conditions match, this policy delegates to [StandardRetryPolicy]. See that class's documentation for
* more information about how it evaluates exceptions.
*/
public open class AwsRetryPolicy : StandardRetryPolicy() {
public companion object {
/**
Expand Down
Loading