inspectorscan / Client / exceptions / ValidationException

ValidationException¶

class inspectorscan.Client.exceptions.ValidationException¶

The request has failed validation due to missing required fields or having invalid inputs.

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

{
    'message': 'string',
    'reason': 'UNKNOWN_OPERATION'|'CANNOT_PARSE'|'FIELD_VALIDATION_FAILED'|'UNSUPPORTED_SBOM_TYPE'|'OTHER',
    'fields': [
        {
            'name': 'string',
            'message': 'string'
        },
    ],
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) –

The request has failed validation due to missing required fields or having invalid inputs.
- message (string) –
- reason (string) –
  
  The reason for the validation failure.
- fields (list) –
  
  The fields that failed validation.
  - (dict) –
    
    The request has failed validation due to missing required fields or having invalid inputs.
    - name (string) –
      
      The name of the validation exception.
    - message (string) –
      
      The validation exception message.
- 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.