Base exceptions¶

Base exceptions for errors returned by Vuforia Web Services or the Vuforia Cloud Recognition Web API.

exception vws.exceptions.base_exceptions.CloudRecoError(response: Response)¶

Bases: Exception

Base class for Vuforia Cloud Recognition Web API exceptions.

Parameters:

response – The response to a request to Vuforia.

property response: Response¶

The response returned by Vuforia which included this error.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.base_exceptions.VWSError(response: Response)¶

Bases: Exception

Base class for Vuforia Web Services errors.

These errors are defined at https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes.

Parameters:

response – The response to a request to Vuforia.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

property response: Response¶

The response returned by Vuforia which included this error.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

VWS exceptions¶

Exception raised when Vuforia returns a response with a result code matching one of those documented at https://developer.vuforia.com/library/web-api/cloud-targets-web-services- api#result-codes.

exception vws.exceptions.vws_exceptions.UnknownTargetError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘UnknownTarget’.

Parameters:

response – The response to a request to Vuforia.

property target_id: str¶

The unknown target ID.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.FailError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘Fail’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.BadImageError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘BadImage’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.AuthenticationFailureError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘AuthenticationFailure’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.RequestQuotaReachedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘RequestQuotaReached’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.TargetStatusProcessingError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘TargetStatusProcessing’.

Parameters:

response – The response to a request to Vuforia.

property target_id: str¶

The processing target ID.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.DateRangeError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘DateRangeError’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.TargetQuotaReachedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘TargetQuotaReached’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.ProjectSuspendedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘ProjectSuspended’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.ProjectHasNoAPIAccessError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘ProjectHasNoApiAccess’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.ProjectInactiveError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘ProjectInactive’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.MetadataTooLargeError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘MetadataTooLarge’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.RequestTimeTooSkewedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘RequestTimeTooSkewed’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.TargetNameExistError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘TargetNameExist’.

Parameters:

response – The response to a request to Vuforia.

property target_name: str¶

The target name which already exists.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.ImageTooLargeError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘ImageTooLarge’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.TargetStatusNotSuccessError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘TargetStatusNotSuccess’.

Parameters:

response – The response to a request to Vuforia.

property target_id: str¶

The unknown target ID.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.TooManyRequestsError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code ‘TooManyRequests’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.InvalidAcceptHeaderError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code InvalidAcceptHeader.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.InvalidInstanceIdError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code InvalidInstanceId.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.BadRequestError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code BadRequest.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.InvalidTargetTypeError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code InvalidTargetType.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.QuotaExceededError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code QuotaExceeded.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.LicenseCheckFailedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code LicenseCheckFailed.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.vws_exceptions.AuthorizationFailedError(response: Response)¶

Bases: VWSError

Exception raised when Vuforia returns a response with a result code AuthorizationFailed.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

classmethod from_result_code(*, result_code: str, response: Response) → VWSError¶

Create the mapped exception for a VWS result_code.

classmethod register_exceptions_by_result_code(*, exceptions_by_result_code: Mapping[str, type[VWSError]]) → None¶

Register result_code to exception mappings.

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

CloudRecoService exceptions¶

Exceptions which match errors raised by the Vuforia Cloud Recognition Web APIs.

exception vws.exceptions.cloud_reco_exceptions.MaxNumResultsOutOfRangeError(response: Response)¶

Bases: CloudRecoError

Exception raised when the max_num_results given to the Cloud Recognition Web API query endpoint is out of range.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.cloud_reco_exceptions.InactiveProjectError(response: Response)¶

Bases: CloudRecoError

Exception raised when Vuforia returns a response with a result code ‘InactiveProject’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.cloud_reco_exceptions.BadImageError(response: Response)¶

Bases: CloudRecoError

Exception raised when Vuforia returns a response with a result code ‘BadImage’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.cloud_reco_exceptions.AuthenticationFailureError(response: Response)¶

Bases: CloudRecoError

Exception raised when Vuforia returns a response with a result code ‘AuthenticationFailure’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.cloud_reco_exceptions.RequestTimeTooSkewedError(response: Response)¶

Bases: CloudRecoError

Exception raised when Vuforia returns a response with a result code ‘RequestTimeTooSkewed’.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property response: Response¶

The response returned by Vuforia which included this error.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

ModelTargetService exceptions¶

Exceptions raised by the Vuforia Model Target Web API.

See https://developer.vuforia.com/library/vuforia-engine/web-api/model-target-web-api/.

exception vws.exceptions.model_target_exceptions.ModelTargetError(response: Response)¶

Bases: Exception

Base class for Vuforia Model Target Web API exceptions.

Parameters:

response – The response to a request to Vuforia.

property response: Response¶

The response returned by Vuforia which included this error.

property code: str¶

The error code given by Vuforia, or an empty string.

property message: str¶

The error message given by Vuforia, or an empty string.

property target: str¶

The error target given by Vuforia, or an empty string.

property details: list[ModelTargetGenerationDetail]¶

The error details given by Vuforia.

Vuforia gives one detail per validation problem it found with a dataset creation request.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.ModelTargetAuthenticationError(response: Response)¶

Bases: ModelTargetError

Exception raised when a Model Target Web API request is not authenticated.

For example, the bearer token may be missing, malformed or expired.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property code: str¶

The error code given by Vuforia, or an empty string.

property details: list[ModelTargetGenerationDetail]¶

The error details given by Vuforia.

Vuforia gives one detail per validation problem it found with a dataset creation request.

property message: str¶

The error message given by Vuforia, or an empty string.

property response: Response¶

The response returned by Vuforia which included this error.

property target: str¶

The error target given by Vuforia, or an empty string.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.ModelTargetValidationError(response: Response)¶

Bases: ModelTargetError

Exception raised when Vuforia rejects a Model Target dataset creation request.

See details for the problems which Vuforia found.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property code: str¶

The error code given by Vuforia, or an empty string.

property details: list[ModelTargetGenerationDetail]¶

The error details given by Vuforia.

Vuforia gives one detail per validation problem it found with a dataset creation request.

property message: str¶

The error message given by Vuforia, or an empty string.

property response: Response¶

The response returned by Vuforia which included this error.

property target: str¶

The error target given by Vuforia, or an empty string.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.UnknownModelTargetDatasetError(response: Response)¶

Bases: ModelTargetError

Exception raised when no Model Target dataset matches a given UUID.

Standard and advanced datasets are separate resources, so this is also raised when the given UUID matches a dataset of the other type.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property code: str¶

The error code given by Vuforia, or an empty string.

property details: list[ModelTargetGenerationDetail]¶

The error details given by Vuforia.

Vuforia gives one detail per validation problem it found with a dataset creation request.

property message: str¶

The error message given by Vuforia, or an empty string.

property response: Response¶

The response returned by Vuforia which included this error.

property target: str¶

The error target given by Vuforia, or an empty string.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.ModelTargetDatasetNotDoneError(response: Response)¶

Bases: ModelTargetError

Exception raised when a Model Target dataset is downloaded before Vuforia has generated it.

Parameters:

response – The response to a request to Vuforia.

add_note(note, /)¶

Add a note to the exception

property code: str¶

The error code given by Vuforia, or an empty string.

property details: list[ModelTargetGenerationDetail]¶

The error details given by Vuforia.

Vuforia gives one detail per validation problem it found with a dataset creation request.

property message: str¶

The error message given by Vuforia, or an empty string.

property response: Response¶

The response returned by Vuforia which included this error.

property target: str¶

The error target given by Vuforia, or an empty string.

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.ModelTargetOAuth2Error(response: Response)¶

Bases: Exception

Exception raised when Vuforia does not give an access token.

For example, the given client ID and client secret may not match a set of Model Target Web API credentials.

Parameters:

response – The response to a request to Vuforia’s token endpoint.

property response: Response¶

The response returned by Vuforia which included this error.

property error: str¶

The OAuth2 error code, or an empty string.

property error_description: str¶

The OAuth2 error description, or an empty string.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.model_target_exceptions.ModelTargetDatasetTimeoutError¶

Bases: Exception

Exception raised when waiting for a Model Target dataset to be generated times out.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

Custom exceptions¶

Exceptions which do not map to errors at the following URL, or simple errors given by the cloud recognition service.

https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes

exception vws.exceptions.custom_exceptions.RequestEntityTooLargeError(response: Response)¶

Bases: Exception

Exception raised when the given image is too large.

Parameters:

response – The response returned by Vuforia.

property response: Response¶

The response returned by Vuforia which included this error.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.TargetProcessingTimeoutError¶

Bases: Exception

Exception raised when waiting for a target to be processed times out.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.DatabaseIdNotSetError¶

Bases: Exception

Exception raised when an operation which needs a database ID is used on a client which was not given one.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.RecoCountsReportNotReadyError(response: Response)¶

Bases: Exception

Exception raised when a reco counts report is downloaded before Vuforia has generated it.

Parameters:

response – The response returned by the report’s download URL.

property response: Response¶

The response returned by the download URL.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.RecoCountsReportDownloadError(response: Response)¶

Bases: Exception

Exception raised when downloading a reco counts report fails.

This is raised, for example, when the report’s URL has expired.

Parameters:

response – The response returned by the report’s download URL.

property response: Response¶

The response returned by the download URL.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.RecoCountsReportTimeoutError¶

Bases: Exception

Exception raised when waiting for a reco counts report to be generated times out.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.

exception vws.exceptions.custom_exceptions.ServerError(response: Response)¶

Bases: Exception

Exception raised when VWS returns a server error.

Parameters:

response – The response returned by Vuforia.

property response: Response¶

The response returned by Vuforia which included this error.

add_note(note, /)¶

Add a note to the exception

with_traceback(tb, /)¶

Set self.__traceback__ to tb and return self.