Module aws_lambda_powertools.utilities.validation.exceptions

Classes

class InvalidEnvelopeExpressionError (*args, **kwargs)

When JMESPath fails to parse expression

Expand source code

class InvalidEnvelopeExpressionError(Exception):
    """When JMESPath fails to parse expression"""

Ancestors

• builtins.Exception
• builtins.BaseException

class InvalidSchemaFormatError (*args, **kwargs)

When JSON Schema is in invalid format

Expand source code

class InvalidSchemaFormatError(Exception):
    """When JSON Schema is in invalid format"""

Ancestors

• builtins.Exception
• builtins.BaseException

class SchemaValidationError (message: Optional[str] = None, validation_message: Optional[str] = None, name: Optional[str] = None, path: Optional[List[~T]] = None, value: Optional[Any] = None, definition: Optional[Any] = None, rule: Optional[str] = None, rule_definition: Optional[Any] = None)

When serialization fail schema validation

Parameters

message : str, optional

Powertools formatted error message

validation_message : str, optional

Containing human-readable information what is wrong (e.g. data.property[index] must be smaller than or equal to 42)

name : str, optional

name of a path in the data structure (e.g. data.property[index])

path : List, optional

path as an array in the data structure (e.g. ['data', 'property', 'index']),

value : Any, optional

The invalid value

definition : Any, optional

The full rule definition (e.g. 42)

rule : str, optional

rule which the data is breaking (e.g. maximum)

rule_definition : Any, optional

The specific rule definition (e.g. 42)

Expand source code

class SchemaValidationError(Exception):
    """When serialization fail schema validation"""

    def __init__(
        self,
        message: Optional[str] = None,
        validation_message: Optional[str] = None,
        name: Optional[str] = None,
        path: Optional[List] = None,
        value: Optional[Any] = None,
        definition: Optional[Any] = None,
        rule: Optional[str] = None,
        rule_definition: Optional[Any] = None,
    ):
        """

        Parameters
        ----------
        message : str, optional
            Powertools formatted error message
        validation_message : str, optional
            Containing human-readable information what is wrong
            (e.g. `data.property[index] must be smaller than or equal to 42`)
        name : str, optional
            name of a path in the data structure
            (e.g. `data.property[index]`)
        path: List, optional
            `path` as an array in the data structure
            (e.g. `['data', 'property', 'index']`),
        value : Any, optional
            The invalid value
        definition : Any, optional
            The full rule `definition`
            (e.g. `42`)
        rule : str, optional
            `rule` which the `data` is breaking
            (e.g. `maximum`)
        rule_definition : Any, optional
            The specific rule `definition`
            (e.g. `42`)
        """
        super().__init__(message)
        self.message = message
        self.validation_message = validation_message
        self.name = name
        self.path = path
        self.value = value
        self.definition = definition
        self.rule = rule
        self.rule_definition = rule_definition

Ancestors

• builtins.Exception
• builtins.BaseException