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.ExtraAttributeWarning[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(msg)[source]¶
Bases:
Exception
Base class for all exceptions in this package.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)[source]¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.AxonTypeError(attr, value, expected, src=None, extra=None)[source]¶
Bases:
AxonError
Pass.
- Parameters
attr (
str
) –value (
typing.Any
) –expected (
typing.Any
) –src (
typing.Optional
[typing.Any
]) –extra (
typing.Optional
[typing.Any
]) –
- __init__(attr, value, expected, src=None, extra=None)[source]¶
Pass.
- Parameters
attr (
str
) –value (
typing.Any
) –expected (
typing.Any
) –src (
typing.Optional
[typing.Any
]) –extra (
typing.Optional
[typing.Any
]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ApiError(msg)[source]¶
Bases:
AxonError
Errors for API models.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfirmNotTrue(confirm=False, prompt=False, reason='', src=None, extra=None)[source]¶
Bases:
AxonError
Error for when confirm != True.
- Parameters
confirm (
typing.Any
) –prompt (
typing.Any
) –reason (
typing.Any
) –src (
typing.Optional
[typing.Any
]) –extra (
typing.Optional
[typing.Any
]) –
- __init__(confirm=False, prompt=False, reason='', src=None, extra=None)[source]¶
Pass.
- Parameters
confirm (
typing.Any
) –prompt (
typing.Any
) –reason (
typing.Any
) –src (
typing.Optional
[typing.Any
]) –extra (
typing.Optional
[typing.Any
]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.NotAllowedError(msg)[source]¶
Bases:
AxonError
Error when something not allowed.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ToolsError(msg)[source]¶
Bases:
AxonError
Errors for tools.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.AuthError(msg)[source]¶
Bases:
AxonError
Errors for authentication models.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.NotFoundError(msg)[source]¶
Bases:
ApiError
Error when something is not found.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- 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(msg)[source]¶
Bases:
ApiError
Error when something exists with same name.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.NotLoggedIn(msg)[source]¶
Bases:
AuthError
Error when not logged in.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.AlreadyLoggedIn(msg)[source]¶
Bases:
AuthError
Error when already logged in.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConnectError(msg)[source]¶
Bases:
AxonError
Error in connect client.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.HttpError(msg)[source]¶
Bases:
AxonError
Errors for HTTP client.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfigError(msg)[source]¶
Bases:
ApiError
Errors in a configuration.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfigInvalidValue(msg)[source]¶
Bases:
ConfigError
Error when a supplied configuration has a bad type or is the wrong choice.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfigUnchanged(msg)[source]¶
Bases:
ConfigError
Error when a supplied configuration is no different from the current configuration.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfigUnknown(msg)[source]¶
Bases:
ConfigError
Error when an unknown configuration key is supplied.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ConfigRequired(msg)[source]¶
Bases:
ConfigError
Error when a required configuration key is not supplied.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.CnxError(msg)[source]¶
Bases:
ApiError
Errors for connections.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.CnxGoneError(msg)[source]¶
Bases:
CnxError
Errors when a connection has gone away.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.CnxUpdateError(msg)[source]¶
Bases:
CnxError
Errors when updating a connections configuration.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.CnxTestError(msg)[source]¶
Bases:
CnxError
Errors when testing a connections configuration.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.CnxAddError(msg)[source]¶
Bases:
CnxError
Errors when adding a new connection.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
-
cnx_new:
typing.ClassVar
[typing.Optional
[dict
]] = None¶
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- 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.
-
response:
requests.models.Response
¶
- 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.
-
response:
requests.models.Response
¶
- 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.
-
response:
requests.models.Response
¶
- 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.
-
response:
requests.models.Response
¶
- exception axonius_api_client.exceptions.WizardError(msg)[source]¶
Bases:
ApiError
Errors in query wizards.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- 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(msg)[source]¶
Bases:
ApiError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ApiAttributeTypeError(msg)[source]¶
Bases:
ApiAttributeError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.ApiAttributeMissingError(msg)[source]¶
Bases:
ApiAttributeError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.NoTriggerDefinedError(msg)[source]¶
Bases:
ApiError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- 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.
- exception axonius_api_client.exceptions.RunnerError(msg)[source]¶
Bases:
ApiError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.RunnerWarning[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.GrabberError(msg)[source]¶
Bases:
ApiError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.GrabberWarning[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.FolderAlreadyExistsError(msg)[source]¶
Bases:
AlreadyExists
Error when something exists with same name.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.FolderNotFoundError(msg, folder=None)[source]¶
Bases:
NotFoundError
Error when something is not found.
- Parameters
msg (
str
) –folder (
typing.Optional
[object
]) –
- __init__(msg, folder=None)[source]¶
Pass.
- Parameters
msg (
str
) –folder (
typing.Optional
[object
]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.SearchError(msg)[source]¶
Bases:
AxonError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.SearchUnmatchedError(msg)[source]¶
Bases:
SearchError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.SearchNoMatchesError(msg)[source]¶
Bases:
SearchError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.SearchNoObjectsError(msg)[source]¶
Bases:
SearchError
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- __init__(msg)¶
Pass.
- Parameters
msg (
typing.Union
[str
,typing.List
[typing.Any
]]) –
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.DecodeError(value, encoding_format=None, encoding_errors=None)[source]¶
Bases:
ValueError
,AxonError
Raised when a byte string cannot be decoded to a valid ObjectId string.
- Parameters
value (
typing.Any
) –encoding_format (
typing.Optional
[str
]) –encoding_errors (
typing.Optional
[str
]) –
- __init__(value, encoding_format=None, encoding_errors=None)[source]¶
Initialize a new instance of the DecodeError exception.
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.InvalidObjectIdError(value)[source]¶
Bases:
ValueError
,AxonError
Raised when an input string is not a valid ObjectId.
- Parameters
value (
str
) –
- __init__(value)[source]¶
Initialize a new instance of the InvalidObjectIdError exception.
- Parameters
value (str) – The input string.
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.InvalidTypeError(value, allowed_types=())[source]¶
-
Raised when an input value is not one of the allowed types.
- value¶
The input value.
- Type
t.Any
- Parameters
value (
typing.Any
) –allowed_types (
typing.Optional
[typing.Tuple
[type
]]) –
- __init__(value, allowed_types=())[source]¶
Initialize a new instance of the InvalidTypeError exception.
- Parameters
value (t.Any) – The input value.
allowed_types (t.Optional[t.Tuple[type]], optional) – The tuple of allowed types.
- args¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.
- exception axonius_api_client.exceptions.FormatError(template, error, args=None, kwargs=None)[source]¶
-
Raised when there is a KeyError in when doing a string formatting.
- Parameters
template (
str
) –error (
Exception
) –args (
typing.Optional
[typing.Any
]) –kwargs (
typing.Optional
[typing.Dict
[str
,typing.Any
]]) –
- __init__(template, error, args=None, kwargs=None)[source]¶
Initialize a new instance of the FormatError exception.
-
args:
typing.Any
¶
- with_traceback()¶
Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.