Package software.amazon.awssdk.services.dynamodb.model

Class ThrottlingReason

java.lang.Object

software.amazon.awssdk.services.dynamodb.model.ThrottlingReason

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>

@Generated("software.amazon.awssdk:codegen")
public final class ThrottlingReason
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>

Represents the specific reason why a DynamoDB request was throttled and the ARN of the impacted resource. This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThrottlingReason.Builder

Method Summary

Modifier and Type	Method	Description
static ThrottlingReason.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	reason()	The reason for throttling.
String	resource()	The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ThrottlingReason.Builder>	serializableBuilderClass()
ThrottlingReason.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

reason

public final String reason()

The reason for throttling. The throttling reason follows a specific format: ResourceType+OperationType+LimitType:

• Resource Type (What is being throttled): Table or Index

• Operation Type (What kind of operation): Read or Write

• Limit Type (Why the throttling occurred):

  • ProvisionedThroughputExceeded: The request rate is exceeding the provisioned throughput capacity (read or write capacity units) configured for a table or a global secondary index (GSI) in provisioned capacity mode.

  • AccountLimitExceeded: The request rate has caused a table or global secondary index (GSI) in on-demand mode to exceed the per-table account-level service quotas for read/write throughput in the current Amazon Web Services Region.

  • KeyRangeThroughputExceeded: The request rate directed at a specific partition key value has exceeded the internal partition-level throughput limits, indicating uneven access patterns across the table's or GSI's key space.

  • MaxOnDemandThroughputExceeded: The request rate has exceeded the configured maximum throughput limits set for a table or index in on-demand capacity mode.

Examples of complete throttling reasons:

• TableReadProvisionedThroughputExceeded

• IndexWriteAccountLimitExceeded

This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.

Returns:

The reason for throttling. The throttling reason follows a specific format: ResourceType+OperationType+LimitType:

• Resource Type (What is being throttled): Table or Index

• Operation Type (What kind of operation): Read or Write

• Limit Type (Why the throttling occurred):

  • ProvisionedThroughputExceeded: The request rate is exceeding the provisioned throughput capacity (read or write capacity units) configured for a table or a global secondary index (GSI) in provisioned capacity mode.

  • AccountLimitExceeded: The request rate has caused a table or global secondary index (GSI) in on-demand mode to exceed the per-table account-level service quotas for read/write throughput in the current Amazon Web Services Region.

  • KeyRangeThroughputExceeded: The request rate directed at a specific partition key value has exceeded the internal partition-level throughput limits, indicating uneven access patterns across the table's or GSI's key space.

  • MaxOnDemandThroughputExceeded: The request rate has exceeded the configured maximum throughput limits set for a table or index in on-demand capacity mode.

Examples of complete throttling reasons:

• TableReadProvisionedThroughputExceeded

• IndexWriteAccountLimitExceeded

This helps identify exactly what resource is being throttled, what type of operation caused it, and why the throttling occurred.

resource

public final String resource()

The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.

Returns:

The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.

toBuilder

public ThrottlingReason.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>

builder

public static ThrottlingReason.Builder builder()

serializableBuilderClass

public static Class<? extends ThrottlingReason.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo