4.7.5.2. Exceptions and warnings

Exceptions and warnings.

axonius_api_client.exceptions.get_exc_str(exc=None)

Pass.

Parameters

exc (typing.Optional[Exception]) –

Return type

str

exception axonius_api_client.exceptions.AxonWarning

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

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

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

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

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

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

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

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

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)

Bases: NotFoundError

Error when something is not found.

Parameters

• details (str) –

• sqs (typing.List[typing.Union[dict, object]]) –

__init__(details, sqs)

Pass.

Parameters

• details (str) –

• sqs (typing.List[typing.Union[dict, object]]) –

args

with_traceback()

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

exception axonius_api_client.exceptions.SavedQueryTagsNotFoundError(value, valid)

Bases: SavedQueryNotFoundError

Error when something is not found.

Parameters

• value (typing.List[str]) –

• valid (typing.List[str]) –

__init__(value, valid)

Pass.

Parameters

• value (typing.List[str]) –

• valid (typing.List[str]) –

args

with_traceback()

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

exception axonius_api_client.exceptions.AlreadyExists

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)

Bases: ApiError

Errors when checking responses.

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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – original exception that was thrown if any

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

Build an error message from a response.

Parameters

• response (requests.Response) – response that originated the error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – exception that was thrown if any

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)

Bases: 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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – exception that was thrown if any

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)

Bases: 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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – exception that was thrown if any

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)

Bases: 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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – exception that was thrown if any

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)

Bases: 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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (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 error

• msg (typing.Optional[str]) – error message to include in exception

• exc (typing.Optional[Exception]) – exception that was thrown if any

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

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

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

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

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

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

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)

Bases: ApiError

Pass.

Parameters

• reason (str) –

• state (dict) –

__init__(reason, state)

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)

Bases: ApiError

Pass.

__init__(obj, schema, exc, data)

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)

Bases: ApiError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestFormatError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestFormatError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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)

Bases: RequestError

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

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

Pass.

Parameters

• err (str) –

• details (typing.Optional[typing.List[str]]) –

• exc (typing.Optional[Exception]) –

args

with_traceback()

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

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

Bases: ApiError

Pass.

Parameters

• name (str) –

• extra (typing.Optional[str]) –

__init__(name, extra=None)

Pass.

Parameters

• name (str) –

• extra (typing.Optional[str]) –

args

with_traceback()

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