DocDBElastic / Client / exceptions / ValidationException

ValidationException#

class DocDBElastic.Client.exceptions.ValidationException#

A structure defining a validation exception.

Example

try:
  ...
except client.exceptions.ValidationException as e:
  print(e.response)
response#

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'fieldList': [
        {
            'message': 'string',
            'name': 'string'
        },
    ],
    'message': 'string',
    'reason': 'unknownOperation'|'cannotParse'|'fieldValidationFailed'|'other',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) –

    A structure defining a validation exception.

    • fieldList (list) –

      A list of the fields in which the validation exception occurred.

      • (dict) –

        A specific field in which a given validation exception occurred.

        • message (string) –

          An error message describing the validation exception in this field.

        • name (string) –

          The name of the field where the validation exception occurred.

    • message (string) –

      An error message describing the validation exception.

    • reason (string) –

      The reason why the validation exception occurred (one of unknownOperation, cannotParse, fieldValidationFailed, or other).

    • Error (dict) – Normalized access to common exception attributes.

      • Code (string) – An identifier specifying the exception type.

      • Message (string) – A descriptive message explaining why the exception occured.