Class ThrottlingException

All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ThrottlingException.Builder,ThrottlingException>

@Generated("software.amazon.awssdk:codegen") public final class ThrottlingException extends IdentitystoreException implements ToCopyableBuilder<ThrottlingException.Builder,ThrottlingException>

Indicates that the principal has crossed the throttling limits of the API operations.

See Also:
  • Method Details

    • toBuilder

      public ThrottlingException.Builder toBuilder()
      Description copied from class: AwsServiceException
      Create a AwsServiceException.Builder initialized with the properties of this AwsServiceException.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ThrottlingException.Builder,ThrottlingException>
      Overrides:
      toBuilder in class IdentitystoreException
      Returns:
      A new builder initialized with this config's properties.
    • builder

      public static ThrottlingException.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ThrottlingException.Builder> serializableBuilderClass()
    • requestIdValue

      public String requestIdValue()

      The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

      Returns:
      The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
    • retryAfterSeconds

      public Integer retryAfterSeconds()

      The number of seconds to wait before retrying the next request.

      Returns:
      The number of seconds to wait before retrying the next request.
    • reason

      public ThrottlingExceptionReason reason()

      Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.

      If the service returns an enum value that is not available in the current SDK version, reason will return ThrottlingExceptionReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

      Returns:
      Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
      See Also:
    • reasonAsString

      public String reasonAsString()

      Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.

      If the service returns an enum value that is not available in the current SDK version, reason will return ThrottlingExceptionReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from reasonAsString().

      Returns:
      Indicates the reason for the throttling error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included.
      See Also:
    • isRetryableException

      public boolean isRetryableException()
      Description copied from class: SdkServiceException
      Specifies whether an exception is retryable. This method by default returns false but subclasses can override this value to signal that the specific subclass is considered retryable.
      Overrides:
      isRetryableException in class SdkServiceException
      Returns:
      true if the exception is classified as retryable, otherwise false.
      See Also:
    • isThrottlingException

      public boolean isThrottlingException()
      Description copied from class: AwsServiceException
      Checks if the exception is caused by throttling, considering both generic SDK and AWS-specific error code details.
      Overrides:
      isThrottlingException in class AwsServiceException
      Returns:
      true if the status code is 429 or if the AWS error code indicates throttling, otherwise false.
      See Also:
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Overrides:
      sdkFields in class SdkServiceException
      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.