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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ThrottlingReason.Builder,ThrottlingReason>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.