summaryrefslogtreecommitdiffstats
path: root/storage/maria/libmarias3/docs/api/errors.rst
diff options
context:
space:
mode:
Diffstat (limited to 'storage/maria/libmarias3/docs/api/errors.rst')
-rw-r--r--storage/maria/libmarias3/docs/api/errors.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/storage/maria/libmarias3/docs/api/errors.rst b/storage/maria/libmarias3/docs/api/errors.rst
new file mode 100644
index 00000000..80c84372
--- /dev/null
+++ b/storage/maria/libmarias3/docs/api/errors.rst
@@ -0,0 +1,30 @@
+Error Codes
+===========
+
++------------------------+------------------------------------------------------+
+| Code | Details |
++========================+======================================================+
+| MS3_ERR_NONE | Success (always equal to ``0``) |
++------------------------+------------------------------------------------------+
+| MS3_ERR_PARAMETER | A required function parameter is missing |
++------------------------+------------------------------------------------------+
+| MS3_ERR_NO_DATA | No data is supplied to a function that requires data |
++------------------------+------------------------------------------------------+
+| MS3_ERR_URI_TOO_LONG | The generated URI for the request is too long |
++------------------------+------------------------------------------------------+
+| MS3_ERR_RESPONSE_PARSE | The API could not parse the response from S3 |
++------------------------+------------------------------------------------------+
+| MS3_ERR_REQUEST_ERROR | The API could not send the request to S3 |
++------------------------+------------------------------------------------------+
+| MS3_ERR_OOM | Could not allocate required memory |
++------------------------+------------------------------------------------------+
+| MS3_ERR_IMPOSSIBLE | A theortically impossible condition occurred |
++------------------------+------------------------------------------------------+
+| MS3_ERR_AUTH | Authentication failed |
++------------------------+------------------------------------------------------+
+| MS3_ERR_NOT_FOUND | Object not found |
++------------------------+------------------------------------------------------+
+| MS3_ERR_SERVER | Unknown error code in S3 response |
++------------------------+------------------------------------------------------+
+| MS3_ERR_TOO_BIG | PUT data is too large, 4GB maximum |
++------------------------+------------------------------------------------------+