AWS Storage Gateway
User Guide (API Version 2012-06-30)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Error Responses

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.

Exceptions

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.

ExceptionMessage HTTP Status Code
IncompleteSignatureExceptionThe specified signature is incomplete.400 Bad Request
InternalFailureThe request processing has failed due to some unknown error, exception or failure. 500 Internal Server Error
InternalServerErrorOne of the operation error code messages in Operation Error Codes.500 Internal Server Error
InvalidActionThe requested action or operation is invalid.400 Bad Request
InvalidClientTokenIdThe X.509 certificate or AWS Access Key ID provided does not exist in our records. 403 Forbidden
InvalidGatewayRequestExceptionOne of the operation error code messages in Operation Error Codes.400 Bad Request
InvalidSignatureExceptionThe request signature we calculated does not match the signature you provided. Check your AWS Access Key and signing method.400 Bad Request
MissingActionThe request is missing an action or operation parameter. 400 Bad Request
MissingAuthenticationTokenThe request must contain either a valid (registered) AWS Access Key ID or X.509 certificate. 403 Forbidden
RequestExpiredThe 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
SerializationExceptionAn error occurred during serialization. Check that your JSON payload is well-formed.400 Bad Request
ServiceUnavailableThe request has failed due to a temporary failure of the server. 503 Service Unavailable
SubscriptionRequiredExceptionThe AWS Access Key Id needs a subscription for the service.400 Bad Request
ThrottlingExceptionRate exceeded.400 Bad Request
UnknownOperationExceptionAn unknown operation was specified. Valid operations are listed in Operations in AWS Storage Gateway .400 Bad Request
UnrecognizedClientExceptionThe security token included in the request is invalid.400 Bad Request
ValidationExceptionThe value of an input parameter is bad or out of range.400 Bad Request

Operation Error Codes

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 CodeMessageOperations That Return this Error Code
ActivationKeyExpiredThe specified activation key has expired.ActivateGateway
ActivationKeyInvalidThe specified activation key is invalid.ActivateGateway
ActivationKeyNotFoundThe specified activation key was not found.ActivateGateway
BandwidthThrottleScheduleNotFoundThe specified bandwidth throttle was not found.DeleteBandwidthRateLimit
CannotExportSnapshotThe specified snapshot cannot be exported.

CreateCachediSCSIVolume

CreateStorediSCSIVolume

InitiatorNotFoundThe specified initiator was not found.DeleteChapCredentials
DiskAlreadyAllocatedThe specified disk is already allocated.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateStorediSCSIVolume

DiskDoesNotExistThe specified disk does not exist.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateStorediSCSIVolume

DiskSizeNotGigAlignedThe specified disk is not gigabyte-aligned.

CreateStorediSCSIVolume

DiskSizeGreaterThanVolumeMaxSizeThe specified disk size is greater than the maximum volume size.CreateStorediSCSIVolume
DiskSizeLessThanVolumeSizeThe specified disk size is less than the volume size.CreateStorediSCSIVolume
DuplicateCertificateInfoThe specified certificate information is a duplicate.ActivateGateway
GatewayInternalErrorA gateway internal error occurred.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateStorediSCSIVolume

CreateSnapshotFromVolumeRecoveryPoint

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

GatewayNotConnectedThe specified gateway is not connected.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateStorediSCSIVolume

CreateSnapshotFromVolumeRecoveryPoint

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

GatewayNotFoundThe specified gateway was not found.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteGateway

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

GatewayProxyNetworkConnectionBusyThe specified gateway proxy network connection is busy.

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

InternalErrorAn internal error occurred.

ActivateGateway

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteGateway

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListGateways

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewayInformation

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

InvalidParametersThe specified request contains invalid parameters.

ActivateGateway

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteGateway

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListGateways

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewayInformation

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

LocalStorageLimitExceededThe local storage limit was exceeded.

AddCache

AddUploadBuffer

AddWorkingStorage
LunInvalidThe specified LUN is invalid.CreateStorediSCSIVolume
MaximumVolumeCountExceededThe maximum volume count was exceeded.

CreateCachediSCSIVolume

CreateStorediSCSIVolume

DescribeCachediSCSIVolumes

DescribeStorediSCSIVolumes

NetworkConfigurationChangedThe gateway network configuration has changed.

CreateCachediSCSIVolume

CreateStorediSCSIVolume
NotSupportedThe specified operation is not supported.

ActivateGateway

AddCache

AddUploadBuffer

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteBandwidthRateLimit

DeleteChapCredentials

DeleteGateway

DeleteVolume

DescribeBandwidthRateLimit

DescribeCache

DescribeCachediSCSIVolumes

DescribeChapCredentials

DescribeGatewayInformation

DescribeMaintenanceStartTime

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

DescribeWorkingStorage

ListLocalDisks

ListGateways

ListVolumes

ListVolumeRecoveryPoints

ShutdownGateway

StartGateway

UpdateBandwidthRateLimit

UpdateChapCredentials

UpdateMaintenanceStartTime

UpdateGatewayInformation

UpdateGatewaySoftwareNow

UpdateSnapshotSchedule

OutdatedGatewayThe specified gateway is out of date.ActivateGateway
SnapshotInProgressExceptionThe specified snapshot is in progress.DeleteVolume
SnapshotIdInvalidThe specified snapshot is invalid.

CreateCachediSCSIVolume

CreateStorediSCSIVolume
StagingAreaFullThe staging area is full.

CreateCachediSCSIVolume

CreateStorediSCSIVolume
TargetAlreadyExistsThe specified target already exists.

CreateCachediSCSIVolume

CreateStorediSCSIVolume
TargetInvalidThe specified target is invalid.

CreateCachediSCSIVolume

CreateStorediSCSIVolume

DeleteChapCredentials

DescribeChapCredentials

UpdateChapCredentials

TargetNotFoundThe specified target was not found.

CreateCachediSCSIVolume

CreateStorediSCSIVolume

DeleteChapCredentials

DescribeChapCredentials

DeleteVolume

UpdateChapCredentials

UnsupportedOperationForGatewayTypeThe specified operation is not valid for the type of the gateway.

AddCache

AddWorkingStorage

CreateCachediSCSIVolume

CreateSnapshotFromVolumeRecoveryPoint

CreateStorediSCSIVolume

DeleteSnapshotSchedule

DescribeCache

DescribeCachediSCSIVolumes

DescribeStorediSCSIVolumes

DescribeUploadBuffer

DescribeWorkingStorage

ListVolumeRecoveryPoints

VolumeAlreadyExistsThe specified volume already exists.

CreateCachediSCSIVolume

CreateStorediSCSIVolume
VolumeIdInvalidThe specified volume is invalid.DeleteVolume
VolumeInUseThe specified volume is already in use.DeleteVolume
VolumeNotFoundThe specified volume was not found.

CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

DeleteVolume

DescribeCachediSCSIVolumes

DescribeSnapshotSchedule

DescribeStorediSCSIVolumes

UpdateSnapshotSchedule

VolumeNotReadyThe specified volume is not ready.CreateSnapshot

CreateSnapshotFromVolumeRecoveryPoint

Error Responses

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.

__type

One of the exceptions from Exceptions.

Type: String

error

Contains API-specific error details. In general errors (i.e., not specific to any API), this error information is not shown.

Type: Collection

errorCode

One of the operation error codes from Operation Error Codes.

Type: String

errorDetails

This field is not used in the current version of the API.

Type: String

message

One of the operation error code messages from Operation Error Codes.

Type: String

Error Response Examples

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." 
}