Package software.amazon.awssdk.services.shield.model

Class InvalidParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

software.amazon.awssdk.core.exception.SdkException

software.amazon.awssdk.core.exception.SdkServiceException

software.amazon.awssdk.awscore.exception.AwsServiceException

software.amazon.awssdk.services.shield.model.ShieldException

software.amazon.awssdk.services.shield.model.InvalidParameterException

All Implemented Interfaces:

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

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

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InvalidParameterException.Builder

Method Summary

Modifier and Type	Method	Description
static InvalidParameterException.Builder	builder()
List<ValidationExceptionField>	fields()	Fields that caused the exception.
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
ValidationExceptionReason	reason()	Additional information about the exception.
String	reasonAsString()	Additional information about the exception.
List<SdkField<?>>	sdkFields()
static Class<? extends InvalidParameterException.Builder>	serializableBuilderClass()
InvalidParameterException.Builder	toBuilder()

Methods inherited from class software.amazon.awssdk.awscore.exception.AwsServiceException

awsErrorDetails, getMessage, isClockSkewException, isThrottlingException

Methods inherited from class software.amazon.awssdk.core.exception.SdkServiceException

extendedRequestId, isRetryableException, requestId, statusCode

Methods inherited from class software.amazon.awssdk.core.exception.SdkException

create, retryable

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

equalsBySdkFields

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

copy

Method Detail

toBuilder

public InvalidParameterException.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InvalidParameterException.Builder,InvalidParameterException>

Overrides:

toBuilder in class ShieldException

builder

public static InvalidParameterException.Builder builder()

serializableBuilderClass

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

reason

public ValidationExceptionReason reason()

Additional information about the exception.

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

Returns:

Additional information about the exception.

See Also:

ValidationExceptionReason

reasonAsString

public String reasonAsString()

Additional information about the exception.

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

Returns:

Additional information about the exception.

See Also:

ValidationExceptionReason

hasFields

public boolean hasFields()

For responses, this returns true if the service returned a value for the Fields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fields

public List<ValidationExceptionField> fields()

Fields that caused the exception.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFields() method.

Returns:

Fields that caused the exception.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Overrides:

sdkFields in class SdkServiceException