Skip to content

Commit 773d0fc

Browse files
committed
Document Authentication failure
1 parent afd61af commit 773d0fc

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/vws/vws.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,8 @@ def add_target(
204204
The target ID of the new target.
205205
206206
Raises:
207+
~vws.exceptions.AuthenticationFailure: The secret key is not
208+
correct.
207209
~vws.exceptions.Fail: There was an error with the request. For
208210
example, the given access key does not match a known database.
209211
"""
@@ -248,6 +250,8 @@ def get_target_record(self, target_id: str) -> Dict[str, Union[str, int]]:
248250
Response details of a target from Vuforia.
249251
250252
Raises:
253+
~vws.exceptions.AuthenticationFailure: The secret key is not
254+
correct.
251255
~vws.exceptions.Fail: There was an error with the request. For
252256
example, the given access key does not match a known database.
253257
~vws.exceptions.UnknownTarget: The given target ID does not match a
@@ -272,6 +276,8 @@ def wait_for_target_processed(self, target_id: str) -> None:
272276
target_id: The ID of the target to wait for.
273277
274278
Raises:
279+
~vws.exceptions.AuthenticationFailure: The secret key is not
280+
correct.
275281
~vws.exceptions.Fail: There was an error with the request. For
276282
example, the given access key does not match a known database.
277283
TimeoutError: The target remained in the processing stage for more
@@ -300,6 +306,8 @@ def list_targets(self) -> List[str]:
300306
The IDs of all targets in the database.
301307
302308
Raises:
309+
~vws.exceptions.AuthenticationFailure: The secret key is not
310+
correct.
303311
~vws.exceptions.Fail: There was an error with the request. For
304312
example, the given access key does not match a known database.
305313
"""
@@ -329,6 +337,8 @@ def get_target_summary_report(
329337
Details of the target.
330338
331339
Raises:
340+
~vws.exceptions.AuthenticationFailure: The secret key is not
341+
correct.
332342
~vws.exceptions.Fail: There was an error with the request. For
333343
example, the given access key does not match a known database.
334344
~vws.exceptions.UnknownTarget: The given target ID does not match a
@@ -354,6 +364,8 @@ def get_database_summary_report(self) -> Dict[str, Union[str, int]]:
354364
Details of the database.
355365
356366
Raises:
367+
~vws.exceptions.AuthenticationFailure: The secret key is not
368+
correct.
357369
~vws.exceptions.Fail: There was an error with the request. For
358370
example, the given access key does not match a known database.
359371
"""
@@ -377,6 +389,8 @@ def delete_target(self, target_id: str) -> None:
377389
target_id: The ID of the target to delete.
378390
379391
Raises:
392+
~vws.exceptions.AuthenticationFailure: The secret key is not
393+
correct.
380394
~vws.exceptions.Fail: There was an error with the request. For
381395
example, the given access key does not match a known database.
382396
~vws.exceptions.UnknownTarget: The given target ID does not match a

0 commit comments

Comments
 (0)