AWS Storage Gateway User Guide
Error Responses
• 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
.
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 .
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.
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.
API Version 2013-06-30
417
