| « PreviousNext » | |
![]() ![]() ![]() | Did this page help you? Yes | No | Tell us about it... |
This section provides reference information about AWS Storage Gateway errors. These errors are
represented by an error exception and an operation error code. For example, the
error exception InvalidSignatureException is returned by any API
response if there is a problem with the request signature. However, the operation
error code ActivationKeyInvalid is returned only for the ActivateGateway API.
Depending on the type of error, AWS Storage Gateway may return only just an exception, or it may return both an exception and an operation error code. Examples of error responses are shown in the Error Responses.
The following table lists AWS Storage Gateway API exceptions. When an AWS Storage Gateway operation
returns an error response, the response body contains one of these
exceptions. The InternalServerError and
InvalidGatewayRequestException return one of the Operation Error Codes message codes that give the
specific operation error code.
| Exception | Message | HTTP Status Code |
|---|---|---|
IncompleteSignatureException | The specified signature is incomplete. | 400 Bad Request |
InternalFailure | The request processing has failed due to some unknown error, exception or failure. | 500 Internal Server Error |
InternalServerError | One of the operation error code messages in Operation Error Codes. | 500 Internal Server Error |
InvalidAction | The requested action or operation is invalid. | 400 Bad Request |
InvalidClientTokenId | The X.509 certificate or AWS Access Key ID provided does not exist in our records. | 403 Forbidden |
InvalidGatewayRequestException | One of the operation error code messages in Operation Error Codes. | 400 Bad Request |
InvalidSignatureException | The request signature we calculated does not match the signature you provided. Check your AWS Access Key and signing method. | 400 Bad Request |
MissingAction | The request is missing an action or operation parameter. | 400 Bad Request |
MissingAuthenticationToken | The request must contain either a valid (registered) AWS Access Key ID or X.509 certificate. | 403 Forbidden |
RequestExpired | The request is past the expiration date or the request date (either with 15 minute padding), or the request date occurs more than 15 minutes in the future. | 400 Bad Request |
SerializationException | An error occurred during serialization. Check that your JSON payload is well-formed. | 400 Bad Request |
ServiceUnavailable | The request has failed due to a temporary failure of the server. | 503 Service Unavailable |
SubscriptionRequiredException | The AWS Access Key Id needs a subscription for the service. | 400 Bad Request |
ThrottlingException | Rate exceeded. | 400 Bad Request |
UnknownOperationException | An unknown operation was specified. Valid operations are listed in Operations in AWS Storage Gateway . | 400 Bad Request |
UnrecognizedClientException | The security token included in the request is invalid. | 400 Bad Request |
ValidationException | The value of an input parameter is bad or out of range. | 400 Bad Request |
The following table shows the mapping between AWS Storage Gateway operation
error codes and APIs that can return the codes. All operation error codes
are returned with one of two general exceptions -
InternalServerError and
InvalidGatewayRequestException exception - described in
Exceptions.
| Operation Error Code | Message | Operations That Return this Error Code |
|---|---|---|
ActivationKeyExpired | The specified activation key has expired. | ActivateGateway |
ActivationKeyInvalid | The specified activation key is invalid. | ActivateGateway |
ActivationKeyNotFound | The specified activation key was not found. | ActivateGateway |
BandwidthThrottleScheduleNotFound | The specified bandwidth throttle was not found. | DeleteBandwidthRateLimit |
CannotExportSnapshot | The specified snapshot cannot be exported. | |
InitiatorNotFound | The specified initiator was not found. | DeleteChapCredentials |
DiskAlreadyAllocated | The specified disk is already allocated. | |
DiskDoesNotExist | The specified disk does not exist. | AddWorkingStorage |
DiskSizeNotGigAligned | The specified disk is not gigabyte-aligned. | |
DiskSizeGreaterThanVolumeMaxSize | The specified disk size is greater than the maximum volume size. | CreateStorediSCSIVolume |
DiskSizeLessThanVolumeSize | The specified disk size is less than the volume size. | CreateStorediSCSIVolume |
DuplicateCertificateInfo | The specified certificate information is a duplicate. | ActivateGateway |
GatewayInternalError | A gateway internal error occurred. | |
GatewayNotConnected | The specified gateway is not connected. | |
GatewayNotFound | The specified gateway was not found. | |
GatewayProxyNetworkConnectionBusy | The specified gateway proxy network connection is busy. | |
InternalError | An internal error occurred. | |
InvalidParameters | The specified request contains invalid parameters. | |
LocalStorageLimitExceeded | The local storage limit was exceeded. | AddWorkingStorage |
LunInvalid | The specified LUN is invalid. | CreateStorediSCSIVolume |
MaximumVolumeCountExceeded | The maximum volume count was exceeded. | |
NetworkConfigurationChanged | The gateway network configuration has changed. | CreateStorediSCSIVolume |
NotSupported | The specified operation is not supported. | |
OutdatedGateway | The specified gateway is out of date. | ActivateGateway |
SnapshotInProgressException | The specified snapshot is in progress. | DeleteVolume |
SnapshotIdInvalid | The specified snapshot is invalid. | CreateStorediSCSIVolume |
StagingAreaFull | The staging area is full. | CreateStorediSCSIVolume |
TargetAlreadyExists | The specified target already exists. | CreateStorediSCSIVolume |
TargetInvalid | The specified target is invalid. | |
TargetNotFound | The specified target was not found. | |
UnsupportedOperationForGatewayType | The specified operation is not valid for the type of the gateway. | |
VolumeAlreadyExists | The specified volume already exists. | CreateStorediSCSIVolume |
VolumeIdInvalid | The specified volume is invalid. | DeleteVolume |
VolumeInUse | The specified volume is already in use. | DeleteVolume |
VolumeNotFound | The specified volume was not found. | CreateSnapshotFromVolumeRecoveryPoint DescribeCachediSCSIVolumes |
VolumeNotReady | The specified volume is not ready. | CreateSnapshot |
When there is an error, the response header information contains:
Content-Type: application/x-amz-json-1.1
An appropriate 4xx or 5xx HTTP status
code
The body of an error response contains information about the error that occurred. The following sample error response shows the output syntax of response elements common to all error responses.
{
"__type": "String",
"message": "String",
"error":
{ "errorCode": "String",
"errorDetails": "String"
}
}The following table explains the JSON error response fields shown in the preceding syntax.
One of the exceptions from Exceptions.
Type: String
Contains API-specific error details. In general errors (i.e., not specific to any API), this error information is not shown.
Type: Collection
One of the operation error codes from Operation Error Codes.
Type: String
This field is not used in the current version of the API.
Type: String
One of the operation error code messages from Operation Error Codes.
Type: String
The following JSON body is returned if you use the DescribeStorediSCSIVolumes API and specify a gateway ARN request input that does not exist.
{
"__type": "InvalidGatewayRequestException",
"message": "The specified volume was not found.",
"error": {
"errorCode": "VolumeNotFound"
}
}The following JSON body is returned if AWS Storage Gateway calculates a signature that does not match the signature sent with a request.
{
"__type": "InvalidSignatureException",
"message": "The request signature we calculated does not match the signature you provided."
}