Class AccessDeniedException

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.signin.model.SigninException

software.amazon.awssdk.services.signin.model.AccessDeniedException

All Implemented Interfaces:

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

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

Error thrown for access denied scenarios with flexible HTTP status mapping

Runtime HTTP Status Code Mapping:

• HTTP 401 (Unauthorized): TOKEN_EXPIRED, AUTHCODE_EXPIRED
• HTTP 403 (Forbidden): USER_CREDENTIALS_CHANGED, INSUFFICIENT_PERMISSIONS

The specific HTTP status code is determined at runtime based on the error enum value. Consumers should use the error field to determine the specific access denial reason.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessDeniedException.Builder

Method Summary

Modifier and Type	Method	Description
static AccessDeniedException.Builder	builder()
OAuth2ErrorCode	error()	OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS
String	errorAsString()	OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AccessDeniedException.Builder>	serializableBuilderClass()
AccessDeniedException.Builder	toBuilder()	Create a AwsServiceException.Builder initialized with the properties of this AwsServiceException.

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, numAttempts, rawMessage, 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

equals, 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 Details

toBuilder

public AccessDeniedException.Builder toBuilder()

Description copied from class: AwsServiceException

Create a AwsServiceException.Builder initialized with the properties of this AwsServiceException.

Specified by:

toBuilder in interface ToCopyableBuilder<AccessDeniedException.Builder,AccessDeniedException>

Overrides:

toBuilder in class SigninException

Returns:

A new builder initialized with this config's properties.

builder

public static AccessDeniedException.Builder builder()

serializableBuilderClass

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

error

public OAuth2ErrorCode error()

OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS

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

Returns:

OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS

See Also:

• OAuth2ErrorCode

errorAsString

public String errorAsString()

OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS

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

Returns:

OAuth 2.0 error code indicating the specific type of access denial Can be TOKEN_EXPIRED, AUTHCODE_EXPIRED, USER_CREDENTIALS_CHANGED, or INSUFFICIENT_PERMISSIONS

See Also:

• OAuth2ErrorCode

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.