AmazonServiceException (AWS SDK for Java

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.amazonaws.SdkBaseException
      - com.amazonaws.AmazonClientException
        
        com.amazonaws.SdkClientException
        
        com.amazonaws.AmazonServiceException

All Implemented Interfaces:

Serializable
```
public class AmazonServiceException
extends SdkClientException
```
Extension of SdkClientException that represents an error response returned by an Amazon web service. Receiving an exception of this type indicates that the caller's request was correctly transmitted to the service, but for some reason, the service was not able to process it, and returned an error response instead.
AmazonServiceException provides callers several pieces of information that can be used to obtain more information about the error and why it occurred. In particular, the errorType field can be used to determine if the caller's request was invalid, or the service encountered an error on the server side while processing it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AmazonServiceException.ErrorType
Indicates who is responsible (if known) for a failed request.

Nested Classes
Modifier and Type	Class and Description
`static class`	`AmazonServiceException.ErrorType` Indicates who is responsible (if known) for a failed request.

Constructor Summary

Constructors
Constructor and Description
`AmazonServiceException(String errorMessage)` Constructs a new AmazonServiceException with the specified message.
`AmazonServiceException(String errorMessage, Exception cause)` Constructs a new AmazonServiceException with the specified message and exception indicating the root cause.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorCode()` Returns the AWS error code represented by this exception.
`String`	`getErrorMessage()`
`AmazonServiceException.ErrorType`	`getErrorType()` Indicates who is responsible for this exception (caller, service, or unknown).
`Map<String,String>`	`getHttpHeaders()`
`String`	`getMessage()`
`String`	`getProxyHost()` Returns proxy host if configured.
`byte[]`	`getRawResponse()` Returns the response payload as bytes.
`String`	`getRawResponseContent()` Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP response from a service
`String`	`getRequestId()` Returns the AWS request ID that uniquely identifies the service request the caller made.
`String`	`getServiceName()` Returns the name of the service that sent this error response.
`int`	`getStatusCode()` Returns the HTTP status code that was returned with this service exception.
`void`	`setErrorCode(String errorCode)` Sets the AWS error code represented by this exception.
`void`	`setErrorMessage(String value)` Sets the human-readable error message provided by the service.
`void`	`setErrorType(AmazonServiceException.ErrorType errorType)` Sets the type of error represented by this exception (sender, receiver, or unknown), indicating if this exception was the caller's fault, or the service's fault.
`void`	`setHttpHeaders(Map<String,String> httpHeaders)` Sets the headers present in the error response.
`void`	`setProxyHost(String proxyHost)` Sets proxy host.
`void`	`setRawResponse(byte[] rawResponse)` Sets the raw response content.
`void`	`setRawResponseContent(String rawResponseContent)` Sets the raw response content.
`void`	`setRequestId(String requestId)` Sets the AWS requestId for this exception.
`void`	`setServiceName(String serviceName)` Sets the name of the service that sent this error response.
`void`	`setStatusCode(int statusCode)` Sets the HTTP status code that was returned with this service exception.

Methods inherited from class com.amazonaws.AmazonClientException
isRetryable

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

- Constructor Detail
  - AmazonServiceException
```
public AmazonServiceException(String errorMessage)
```
    Constructs a new AmazonServiceException with the specified message.
    
    Parameters:
    
    errorMessage - An error message describing what went wrong.
  - AmazonServiceException
```
public AmazonServiceException(String errorMessage,
                              Exception cause)
```
    Constructs a new AmazonServiceException with the specified message and exception indicating the root cause.
    
    Parameters:
    
    errorMessage - An error message describing what went wrong.
    
    cause - The root exception that caused this exception to be thrown.
- Method Detail
  - setRequestId
```
public void setRequestId(String requestId)
```
    Sets the AWS requestId for this exception.
    
    Parameters:
    
    requestId - The unique identifier for the service request the caller made.
  - getRequestId
```
public String getRequestId()
```
    Returns the AWS request ID that uniquely identifies the service request the caller made.
    
    Returns:
    
    The AWS request ID that uniquely identifies the service request the caller made.
  - setServiceName
```
public void setServiceName(String serviceName)
```
    Sets the name of the service that sent this error response.
    
    Parameters:
    
    serviceName - The name of the service that sent this error response.
  - getServiceName
```
public String getServiceName()
```
    Returns the name of the service that sent this error response.
    
    Returns:
    
    The name of the service that sent this error response.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    Sets the AWS error code represented by this exception.
    
    Parameters:
    
    errorCode - The AWS error code represented by this exception.
  - getErrorCode
```
public String getErrorCode()
```
    Returns the AWS error code represented by this exception.
    
    Returns:
    
    The AWS error code represented by this exception.
  - setErrorType
```
public void setErrorType(AmazonServiceException.ErrorType errorType)
```
    Sets the type of error represented by this exception (sender, receiver, or unknown), indicating if this exception was the caller's fault, or the service's fault.
    
    Parameters:
    
    errorType - The type of error represented by this exception (sender or receiver), indicating if this exception was the caller's fault or the service's fault.
  - getErrorType
```
public AmazonServiceException.ErrorType getErrorType()
```
    Indicates who is responsible for this exception (caller, service, or unknown).
    
    Returns:
    
    A value indicating who is responsible for this exception (caller, service, or unknown).
  - getErrorMessage
```
public String getErrorMessage()
```
    Returns:
    
    the human-readable error message provided by the service
  - setErrorMessage
```
public void setErrorMessage(String value)
```
    Sets the human-readable error message provided by the service. NOTE: errorMessage by default is set to the same as the message value passed to the constructor of AmazonServiceException.
    
    See Also:
    
    AmazonServiceException(String), AmazonServiceException#AmazonServiceException(String, Exception))
  - setStatusCode
```
public void setStatusCode(int statusCode)
```
    Sets the HTTP status code that was returned with this service exception.
    
    Parameters:
    
    statusCode - The HTTP status code that was returned with this service exception.
  - getStatusCode
```
public int getStatusCode()
```
    Returns the HTTP status code that was returned with this service exception.
    
    Returns:
    
    The HTTP status code that was returned with this service exception.
  - getMessage
```
public String getMessage()
```
    Overrides:
    
    getMessage in class Throwable
  - getRawResponseContent
```
public String getRawResponseContent()
```
    Typically only useful for debugging purpose if for some reason the SDK cannot parse the HTTP response from a service
    
    Returns:
    
    The raw content of the HTTP response as a String.
  - setRawResponseContent
```
public void setRawResponseContent(String rawResponseContent)
```
    Sets the raw response content.
  - getRawResponse
```
public byte[] getRawResponse()
```
    Returns the response payload as bytes.
  - setRawResponse
```
public void setRawResponse(byte[] rawResponse)
```
    Sets the raw response content.
  - getHttpHeaders
```
public Map<String,String> getHttpHeaders()
```
    Returns:
    
    A Map of HTTP headers associated with the error response.
  - setHttpHeaders
```
public void setHttpHeaders(Map<String,String> httpHeaders)
```
    Sets the headers present in the error response.
  - getProxyHost
```
public String getProxyHost()
```
    Returns proxy host if configured. If using a proxy, then it's possible that the error response came from the proxy instead of AWS.
    
    Returns:
    
    proxy host if configured or null
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
    Sets proxy host.
    
    Parameters:
    
    proxyHost - the proxy host to set

Class AmazonServiceException

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonClientException

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Detail

AmazonServiceException

AmazonServiceException

Method Detail

setRequestId

getRequestId

setServiceName

getServiceName

setErrorCode

getErrorCode

setErrorType

getErrorType

getErrorMessage

setErrorMessage

setStatusCode

getStatusCode

getMessage

getRawResponseContent

setRawResponseContent

getRawResponse

setRawResponse

getHttpHeaders

setHttpHeaders

getProxyHost

setProxyHost