4.7.5.2. Exceptions and warnings

Exceptions and warnings.

axonius_api_client.exceptions.get_exc_str(exc=None)[source]

Pass.

Parameters

exc (typing.Optional[Exception]) –

Return type

str

exception axonius_api_client.exceptions.AxonWarning[source]

Bases: Warning

Base class for all warnings in this package.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiWarning[source]

Bases: AxonWarning

Warnings for API models.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.GuiQueryWizardWarning[source]

Bases: ApiWarning

Pass.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.UnknownFieldSchema[source]

Bases: ApiWarning

Warning for unknown field schema mappings.

__init__(*args, **kwargs)
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)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiError[source]

Bases: AxonError

Errors for API models.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ToolsError[source]

Bases: AxonError

Errors for tools.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.AuthError[source]

Bases: AxonError

Errors for authentication models.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.NotFoundError[source]

Bases: ApiError

Error when something is not found.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.SavedQueryNotFoundError(details, sqs)[source]

Bases: NotFoundError

Error when something is not found.

Parameters
__init__(details, sqs)[source]

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.SavedQueryTagsNotFoundError(value, valid)[source]

Bases: SavedQueryNotFoundError

Error when something is not found.

Parameters
__init__(value, valid)[source]

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.AlreadyExists[source]

Bases: ApiError

Error when something exists with same name.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.NotLoggedIn[source]

Bases: AuthError

Error when not logged in.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.AlreadyLoggedIn[source]

Bases: AuthError

Error when already logged in.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConnectError[source]

Bases: AxonError

Error in connect client.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.HttpError[source]

Bases: AxonError

Errors for HTTP client.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConfigError[source]

Bases: ApiError

Errors in a configuration.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConfigInvalidValue[source]

Bases: ConfigError

Error when a supplied configuration has a bad type or is the wrong choice.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConfigUnchanged[source]

Bases: ConfigError

Error when a supplied configuration is no different from the current configuration.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConfigUnknown[source]

Bases: ConfigError

Error when an unknown configuration key is supplied.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ConfigRequired[source]

Bases: ConfigError

Error when a required configuration key is not supplied.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.CnxError[source]

Bases: ApiError

Errors for connections.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.CnxGoneError[source]

Bases: CnxError

Errors when a connection has gone away.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.CnxUpdateError[source]

Bases: CnxError

Errors when updating a connections configuration.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.CnxTestError[source]

Bases: CnxError

Errors when testing a connections configuration.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.CnxAddError[source]

Bases: CnxError

Errors when adding a new connection.

__init__(*args, **kwargs)
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: ApiError

Errors when checking responses.

Parameters
__init__(msg=None, response=None, exc=None)[source]

Error in responses received from REST API.

Parameters
classmethod build_errmsg(response, msg=None, exc=None)[source]

Build an error message from a response.

Parameters
Return type

str

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: ResponseError

Error when credentials are invalid.

Parameters
__init__(msg=None, response=None, exc=None)

Error in responses received from REST API.

Parameters
args
classmethod build_errmsg(response, msg=None, exc=None)

Build an error message from a response.

Parameters
Return type

str

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

response: Response
exc: Exception
msg: str
errmsg: str
exception axonius_api_client.exceptions.ResponseNotOk(msg=None, response=None, exc=None)[source]

Bases: ResponseError

Error if response has a status code that is an error and error_status is True.

Parameters
__init__(msg=None, response=None, exc=None)

Error in responses received from REST API.

Parameters
args
classmethod build_errmsg(response, msg=None, exc=None)

Build an error message from a response.

Parameters
Return type

str

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

response: Response
exc: Exception
msg: str
errmsg: str
exception axonius_api_client.exceptions.JsonInvalidError(msg=None, response=None, exc=None)[source]

Bases: ResponseError

Error when response has invalid JSON.

Parameters
__init__(msg=None, response=None, exc=None)

Error in responses received from REST API.

Parameters
args
classmethod build_errmsg(response, msg=None, exc=None)

Build an error message from a response.

Parameters
Return type

str

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

response: Response
exc: Exception
msg: str
errmsg: str
exception axonius_api_client.exceptions.JsonError(msg=None, response=None, exc=None)[source]

Bases: ResponseError

Error when JSON has key:error that is not empty or key:status=error.

Parameters
__init__(msg=None, response=None, exc=None)

Error in responses received from REST API.

Parameters
args
classmethod build_errmsg(response, msg=None, exc=None)

Build an error message from a response.

Parameters
Return type

str

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

response: Response
exc: Exception
msg: str
errmsg: str
exception axonius_api_client.exceptions.WizardError[source]

Bases: ApiError

Errors in query wizards.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiAttributeExtraWarning[source]

Bases: ApiWarning

Pass.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiAttributeError[source]

Bases: ApiError

Pass.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiAttributeTypeError[source]

Bases: ApiAttributeError

Pass.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ApiAttributeMissingError[source]

Bases: ApiAttributeError

Pass.

__init__(*args, **kwargs)
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.NoTriggerDefinedError[source]

Bases: ApiError

Pass.

__init__(*args, **kwargs)
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: ApiError

Pass.

Parameters
  • reason (str) –

  • state (dict) –

__init__(reason, state)[source]

Pass.

Parameters
  • reason (str) –

  • state (dict) –

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.SchemaError(obj, schema, exc, data)[source]

Bases: ApiError

Pass.

__init__(obj, schema, exc, data)[source]

Pass.

args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestError(api_endpoint, err, details=None, exc=None)[source]

Bases: ApiError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)[source]

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestMissingArgsError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestObjectTypeError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestFormatError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestFormatPathError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestFormatError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestFormatObjectError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestFormatError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.RequestLoadObjectError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.ResponseLoadObjectError(api_endpoint, err, details=None, exc=None)[source]

Bases: RequestError

Pass.

Parameters
__init__(api_endpoint, err, details=None, exc=None)

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception axonius_api_client.exceptions.FeatureNotEnabledError(name, extra=None)[source]

Bases: ApiError

Pass.

Parameters
__init__(name, extra=None)[source]

Pass.

Parameters
args
with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.