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

Interface ThrottlingReason.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>, SdkBuilder<ThrottlingReason.Builder,ThrottlingReason>, SdkPojo

Enclosing class:

ThrottlingReason

@Mutable
@NotThreadSafe
public static interface ThrottlingReason.Builder
extends SdkPojo, CopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>

Method Summary

Modifier and Type	Method	Description
ThrottlingReason.Builder	reason(String reason)	The reason for throttling.
ThrottlingReason.Builder	resource(String resource)	The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

reason

ThrottlingReason.Builder reason(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

resource

ThrottlingReason.Builder resource(String resource)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.