PartnerCentralSellingAPI / Client / exceptions / ValidationException

ValidationException#

class PartnerCentralSellingAPI.Client.exceptions.ValidationException#

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

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

{
    'ErrorList': [
        {
            'Code': 'REQUIRED_FIELD_MISSING'|'INVALID_ENUM_VALUE'|'INVALID_STRING_FORMAT'|'INVALID_VALUE'|'TOO_MANY_VALUES'|'INVALID_RESOURCE_STATE'|'DUPLICATE_KEY_VALUE'|'VALUE_OUT_OF_RANGE'|'ACTION_NOT_PERMITTED',
            'FieldName': 'string',
            'Message': 'string'
        },
    ],
    'Message': 'string',
    'Reason': 'REQUEST_VALIDATION_FAILED'|'BUSINESS_VALIDATION_FAILED',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) –

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.
- ErrorList (list) –
  
  A list of issues that were discovered in the submitted request or the resource state.
  - (dict) –
    
    Indicates an invalid value for a field.
    - REQUIRED_FIELD_MISSING: The request is missing a required field. Fix: Verify your request payload includes all required fields.
    - INVALID_ENUM_VALUE: The enum field value isn’t an accepted values. Fix: Check the documentation for the list of valid enum values, and update your request with a valid value.
    - INVALID_STRING_FORMAT: The string format is invalid. Fix: Confirm that the string is in the expected format (For example: email address, date).
    - INVALID_VALUE: The value isn’t valid. Fix: Confirm that the value meets the expected criteria and is within the allowable range or set.
    - TOO_MANY_VALUES: There are too many values in a field that expects fewer entries. Fix: Reduce the number of values to match the expected limit.
    - ACTION_NOT_PERMITTED: The action isn’t permitted due to current state or permissions. Fix: Verify that the action is appropriate for the current state, and that you have the necessary permissions to perform it.
    - DUPLICATE_KEY_VALUE: The value in a field duplicates a value that must be unique. Fix: Verify that the value is unique and doesn’t duplicate an existing value in the system.
    - Code (string) –
      
      Specifies the error code for the invalid field value.
    - FieldName (string) –
      
      Specifies the field name with the invalid value.
    - Message (string) –
      
      Specifies the detailed error message for the invalid field value.
- Message (string) –
- Reason (string) –
  
  The primary reason for this validation exception to occur.
  - REQUEST_VALIDATION_FAILED: The request format is not valid. Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
  - BUSINESS_VALIDATION_FAILED: The requested change doesn’t pass the business validation rules. Fix: Check that your change aligns with the business rules defined by AWS Partner Central.
- 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.