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
- 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
details (
str
) –sqs (
typing.List
[typing.Union
[dict
,object
]]) –
- __init__(details, sqs)[source]¶
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)[source]¶
Bases:
SavedQueryNotFoundError
Error when something is not found.
- Parameters
value (
typing.List
[str
]) –valid (
typing.List
[str
]) –
- __init__(value, valid)[source]¶
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[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
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:
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.
- 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
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.
- exception axonius_api_client.exceptions.JsonInvalidError(msg=None, response=None, exc=None)[source]¶
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 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.
- 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
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.
- 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.
- 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.
- 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
err (
str
) –details (
typing.Optional
[typing.List
[str
]]) –exc (
typing.Optional
[Exception
]) –
- __init__(api_endpoint, err, details=None, exc=None)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
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)[source]¶
Bases:
ApiError
Pass.
- Parameters
name (
str
) –extra (
typing.Optional
[str
]) –
- __init__(name, extra=None)[source]¶
Pass.
- Parameters
name (
str
) –extra (
typing.Optional
[str
]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.