sym.sdk.exceptions¶

Modules

`sym.sdk.exceptions.access_strategy`
`sym.sdk.exceptions.aptible`
`sym.sdk.exceptions.aws`
`sym.sdk.exceptions.boundary`
`sym.sdk.exceptions.github`
`sym.sdk.exceptions.http`
`sym.sdk.exceptions.identity`
`sym.sdk.exceptions.jira`
`sym.sdk.exceptions.knowbe4`
`sym.sdk.exceptions.okta`
`sym.sdk.exceptions.onelogin`
`sym.sdk.exceptions.pagerduty`
`sym.sdk.exceptions.sdk`
`sym.sdk.exceptions.slack`
`sym.sdk.exceptions.sym_exception`

Exceptions that can be raised by the Sym Runtime.

exception sym.sdk.exceptions.AWSError(name: str, message: str, error_type: str = 'AWS')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all AWSErrors

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. ASSUME_ROLE_FAILED)
message – The exception message to display

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

exception sym.sdk.exceptions.AWSIAMError(name: str, message: str)¶

Bases: sym.sdk.exceptions.aws.AWSError

This is the base class for all AWS IAM exceptions raised by the Sym Runtime.

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. GROUP_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.AWSLambdaError(name: str, message: str)¶

Bases: sym.sdk.exceptions.aws.AWSError

This is the base class for all AWS Lambda exceptions raised by the Sym Runtime.

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. FATAL_FUNCTION_ERROR)
message – The exception message to display

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

exception sym.sdk.exceptions.AWSSSOError(name: str, message: str)¶

Bases: sym.sdk.exceptions.aws.AWSError

This is the base class for all AWS SSO exceptions raised by the Sym Runtime.

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. GROUP_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.AccessStrategyError(name: str, message: str, error_type: str = 'AccessStrategy')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all errors that occur when initializing an AccessStrategy.

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. STRATEGY_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.AptibleError(name: str, message: str, error_type: str = 'Aptible')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all AptibleErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. ALREADY_IN_ROLE)
message – The exception message to display

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

exception sym.sdk.exceptions.BoundaryError(name: str, message: str, error_type: str = 'Boundary')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all BoundaryErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. ALREADY_IN_ROLE)
message – The exception message to display

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

exception sym.sdk.exceptions.CouldNotSaveError(message: str)¶

Bases: sym.sdk.exceptions.identity.IdentityError

This error is raised in cases where a UserIdentity was unable to be saved.

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

exception sym.sdk.exceptions.ExceptionWithHint(error_type: str, name: str, message: str)¶

Bases: sym.sdk.exceptions.sym_exception.SymException

A trait that can be mixed into Exception classes that want to have messages formatted with a hint.

Overrides the __str__ method to provide a formatted output string.

i.e. the output will look like > This is my main exception message > > Hint: This is the exception hint

Caution: This class should not be used for matching exceptions in except statements!

property hint¶: The string to be displayed in the Hint section

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

exception sym.sdk.exceptions.GitHubError(name: str, message: str, error_type: str = 'GitHub')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all GitHubErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. REPOSITORY_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.HTTPError(name: str, message: str, error_type: str = 'HTTP')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all HTTPErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. ERROR_RESPONSE)
message – The exception message to display

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

exception sym.sdk.exceptions.IdentityError(name: str, message: str, error_type: str = 'Identity')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for errors that occur when managing identities.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. COULD_NOT_SAVE)
message – The exception message to display

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

exception sym.sdk.exceptions.JiraError(name: str, message: str)¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all JiraErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. MISSING_INSTALLATION)
message – The exception message to display

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

exception sym.sdk.exceptions.KnowBe4Error(name: str, message: str)¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all KnowBe4Errors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. USER_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.MissingArgument(arg: str, method: str)¶

Bases: sym.sdk.exceptions.sdk.SDKError

This error is raised when a Sym SDK method is called without the required arguments.

Parameters

arg – The name of the missing argument
method – The name of the SDk method that was called

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

exception sym.sdk.exceptions.OktaError(name: str, message: str, error_type: str = 'Okta')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all OktaErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. GROUP_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.OneLoginError(name: str, message: str, error_type: str = 'OneLogin')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all OneLoginErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. AUTH_FAILED)
message – The exception message to display

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

exception sym.sdk.exceptions.PagerDutyError(name: str, message: str, error_type: str = 'PagerDuty')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all PagerDutyErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. USER_NOT_FOUND)
message – The exception message to display

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

exception sym.sdk.exceptions.SDKError(name: str, message: str, error_type: str = 'SymSDK')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

Generic exceptions raised by the Sym SDK at runtime.

Parameters

name – The name of the exception (used as the second part of the error_code, e.g. MISSING_ARGUMENT)
message – The exception message to display

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

exception sym.sdk.exceptions.SlackError(name: str, message: str, error_type: str = 'Slack')¶

Bases: sym.sdk.exceptions.sym_exception.SymException

This is the base class for all SlackErrors.

Parameters

name – The name of the exception (used as the second part of the error code, e.g. NOT_IN_CHANNEL)
message – The exception message to display

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

exception sym.sdk.exceptions.SymException(error_type: str, name: str, message: str)¶

Bases: Exception

This is the base class for all exceptions raised by the Sym Runtime.

Parameters

error_type – The class of exception (used as the first part of the error_code, e.g. AuthenticationError)
name – The name of the exception (used as the second part of the error_code, e.g. INVALID_JWT)
message – The exception message to display

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