Comprehend / Client / exceptions / InvalidRequestException

InvalidRequestException#

class Comprehend.Client.exceptions.InvalidRequestException#

The request is invalid.

Example

try:
  ...
except client.exceptions.InvalidRequestException 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': 'INVALID_DOCUMENT',
    'Detail': {
        'Reason': 'DOCUMENT_SIZE_EXCEEDED'|'UNSUPPORTED_DOC_TYPE'|'PAGE_LIMIT_EXCEEDED'|'TEXTRACT_ACCESS_DENIED'
    },
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

(dict) –

The request is invalid.
- Message (string) –
- Reason (string) –
- Detail (dict) –
  
  Provides additional detail about why the request failed.
  - Reason (string) –
    
    Reason codes include the following values:
    - DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your file and resubmit the request.
    - UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type and resubmit the request.
    - PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of pages in your file and resubmit the request.
    - TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your account has permission to use Amazon Textract API operations and resubmit the request.
    - NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Verify the format and resubmit the request.
    - MISMATCHED_TOTAL_PAGE_COUNT - Check the number of pages in your file and resubmit the request.
    - INVALID_DOCUMENT - Invalid document. Check the file and resubmit the request.
- 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.