4.7.5.2. Exceptions and warnings¶
Exceptions and warnings.
-
exception
axonius_api_client.exceptions.
AxonWarning
[source]¶ Bases:
Warning
Base class for all warnings in this package.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ApiWarning
[source]¶ Bases:
axonius_api_client.exceptions.AxonWarning
Warnings for API models.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
AxonError
[source]¶ Bases:
Exception
Base class for all exceptions in this package.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ApiError
[source]¶ Bases:
axonius_api_client.exceptions.AxonError
Errors for API models.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ToolsError
[source]¶ Bases:
axonius_api_client.exceptions.AxonError
Errors for tools.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
AuthError
[source]¶ Bases:
axonius_api_client.exceptions.AxonError
Errors for authentication models.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
NotFoundError
[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Error when something is not found.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
NotLoggedIn
[source]¶ Bases:
axonius_api_client.exceptions.AuthError
Error when not logged in.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
AlreadyLoggedIn
[source]¶ Bases:
axonius_api_client.exceptions.AuthError
Error when already logged in.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConnectError
[source]¶ Bases:
axonius_api_client.exceptions.AxonError
Error in connect client.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
HttpError
[source]¶ Bases:
axonius_api_client.exceptions.AxonError
Errors for HTTP client.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConfigError
[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Errors in a configuration.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConfigInvalidValue
[source]¶ Bases:
axonius_api_client.exceptions.ConfigError
Error when a supplied configuration has a bad type or is the wrong choice.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConfigUnchanged
[source]¶ Bases:
axonius_api_client.exceptions.ConfigError
Error when a supplied configuration is no different from the current configuration.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConfigUnknown
[source]¶ Bases:
axonius_api_client.exceptions.ConfigError
Error when an unknown configuration key is supplied.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ConfigRequired
[source]¶ Bases:
axonius_api_client.exceptions.ConfigError
Error when a required configuration key is not supplied.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
CnxError
[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Errors for connections.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
CnxGoneError
[source]¶ Bases:
axonius_api_client.exceptions.CnxError
Errors when a connection has gone away.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
CnxUpdateError
[source]¶ Bases:
axonius_api_client.exceptions.CnxError
Errors when updating a connections configuration.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
CnxTestError
[source]¶ Bases:
axonius_api_client.exceptions.CnxError
Errors when testing a connections configuration.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
CnxAddError
[source]¶ Bases:
axonius_api_client.exceptions.CnxError
Errors when adding a new connection.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
ResponseError
(msg=None, response=None, exc=None)[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Errors when checking responses.
- Parameters
msg (
typing.Optional
[str
]) –exc (
typing.Optional
[Exception
]) –
-
__init__
(msg=None, response=None, exc=None)[source]¶ Error in responses received from REST API.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – original exception that was thrown if any
-
classmethod
build_errmsg
(response, msg=None, exc=None)[source]¶ Build an error message from a response.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – exception that was thrown if any
- Return type
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
exception
axonius_api_client.exceptions.
InvalidCredentials
(msg=None, response=None, exc=None)[source]¶ Bases:
axonius_api_client.exceptions.ResponseError
Error when credentials are invalid.
- Parameters
msg (
typing.Optional
[str
]) –exc (
typing.Optional
[Exception
]) –
-
__init__
(msg=None, response=None, exc=None)¶ Error in responses received from REST API.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – original exception that was thrown if any
-
args
¶
-
classmethod
build_errmsg
(response, msg=None, exc=None)¶ Build an error message from a response.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – exception that was thrown if any
- Return type
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
response
: requests.models.Response¶
-
exception
axonius_api_client.exceptions.
ResponseNotOk
(msg=None, response=None, exc=None)[source]¶ Bases:
axonius_api_client.exceptions.ResponseError
Error if response has a status code that is an error and error_status is True.
- Parameters
msg (
typing.Optional
[str
]) –exc (
typing.Optional
[Exception
]) –
-
__init__
(msg=None, response=None, exc=None)¶ Error in responses received from REST API.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – original exception that was thrown if any
-
args
¶
-
classmethod
build_errmsg
(response, msg=None, exc=None)¶ Build an error message from a response.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – exception that was thrown if any
- Return type
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
response
: requests.models.Response¶
-
exception
axonius_api_client.exceptions.
JsonInvalid
(msg=None, response=None, exc=None)[source]¶ Bases:
axonius_api_client.exceptions.ResponseError
Error when response has invalid JSON.
- Parameters
msg (
typing.Optional
[str
]) –exc (
typing.Optional
[Exception
]) –
-
__init__
(msg=None, response=None, exc=None)¶ Error in responses received from REST API.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – original exception that was thrown if any
-
args
¶
-
classmethod
build_errmsg
(response, msg=None, exc=None)¶ Build an error message from a response.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – exception that was thrown if any
- Return type
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
response
: requests.models.Response¶
-
exception
axonius_api_client.exceptions.
JsonError
(msg=None, response=None, exc=None)[source]¶ Bases:
axonius_api_client.exceptions.ResponseError
Error when JSON has key:error that is not empty or key:status=error.
- Parameters
msg (
typing.Optional
[str
]) –exc (
typing.Optional
[Exception
]) –
-
__init__
(msg=None, response=None, exc=None)¶ Error in responses received from REST API.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – original exception that was thrown if any
-
args
¶
-
classmethod
build_errmsg
(response, msg=None, exc=None)¶ Build an error message from a response.
- Parameters
response (
requests.Response
) – response that originated the errormsg (
typing.Optional
[str
]) – error message to include in exceptionexc (
typing.Optional
[Exception
]) – exception that was thrown if any
- Return type
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
response
: requests.models.Response¶
-
exception
axonius_api_client.exceptions.
WizardError
[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Errors in query wizards.
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-
-
exception
axonius_api_client.exceptions.
StopFetch
(reason, state)[source]¶ Bases:
axonius_api_client.exceptions.ApiError
Pass.
-
args
¶
-
with_traceback
()¶ Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
-