Amazon Comprehend

Amazon Comprehend API

The Amazon Comprehend API provides programmatic access to natural language processing capabilities including sentiment analysis, entity recognition, key phrase extraction, language detection, topic modeling, PII detection, and syntax analysis for text documents. The API supports real-time and batch processing with 84 operations covering detection, async jobs, custom model training, and flywheel management for continuous learning.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.aws.amazon.com/comprehend/latest/dg/
📖
APIReference
https://docs.aws.amazon.com/comprehend/latest/APIReference/
📖
GettingStarted
https://aws.amazon.com/comprehend/getting-started/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/openapi/amazon-comprehend-openapi.yml
⚙
JSON-LD
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-ld/amazon-comprehend-context.jsonld

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-schema/comprehend-entity-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/comprehend-entity-structure.json

Other Resources

🔗
Pricing
https://aws.amazon.com/comprehend/pricing/
🔗
FAQ
https://aws.amazon.com/comprehend/faqs/
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/overlays/amazon-comprehend-openapi-overlay.yaml
🔗
MCPServer
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/mcp/amazon-comprehend-mcp.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/errors/amazon-comprehend-problem-types.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/conformance/amazon-comprehend-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/lifecycle/amazon-comprehend-lifecycle.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/apis.yml

OpenAPI Specification

amazon-comprehend-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: '2017-11-27'
  x-release: v4
  title: Amazon Comprehend
  description: 'Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they
    discuss, the predominant sentiment expressed in them, the predominant language used, and more.'
  x-logo:
    url: 'https://twitter.com/awscloud/profile_image?size=original'
    backgroundColor: '#FFFFFF'
  termsOfService: 'https://aws.amazon.com/service-terms/'
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: 'https://github.com/mermade/aws2openapi'
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: 'http://www.apache.org/licenses/'
  x-providerName: amazonaws.com
  x-serviceName: comprehend
  x-aws-signingName: comprehend
  x-origin:
  - contentType: application/json
    url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/comprehend-2017-11-27.normal.json'
    converter:
      url: 'https://github.com/mermade/aws2openapi'
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
  x-apisguru-categories:
  - cloud
  x-preferred: true
externalDocs:
  description: Amazon Web Services documentation
  url: 'https://docs.aws.amazon.com/comprehend/'
servers:
- url: 'http://comprehend.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Comprehend multi-region endpoint
- url: 'https://comprehend.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Comprehend multi-region endpoint
- url: 'http://comprehend.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia)
- url: 'https://comprehend.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Comprehend endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
  /#X-Amz-Target=Comprehend_20171127.BatchDetectDominantLanguage:
    post:
      operationId: BatchDetectDominantLanguage
      description: 'Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon
        Comprehend Supported Languages</a>. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectDominantLanguageResponse'
              examples:
                BatchDetectDominantLanguage200Example:
                  summary: Default BatchDetectDominantLanguage 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectDominantLanguage480Example:
                  summary: Default BatchDetectDominantLanguage 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectDominantLanguage481Example:
                  summary: Default BatchDetectDominantLanguage 481
                  x-microcks-default: true
                  value: example
        '482':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectDominantLanguage482Example:
                  summary: Default BatchDetectDominantLanguage 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectDominantLanguage483Example:
                  summary: Default BatchDetectDominantLanguage 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectDominantLanguageRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectDominantLanguage
      summary: Amazon Comprehend Batch Detect Dominant Language
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.BatchDetectEntities:
    post:
      operationId: BatchDetectEntities
      description: 'Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a>
        in the Comprehend Developer Guide. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectEntitiesResponse'
              examples:
                BatchDetectEntities200Example:
                  summary: Default BatchDetectEntities 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectEntities480Example:
                  summary: Default BatchDetectEntities 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectEntities481Example:
                  summary: Default BatchDetectEntities 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                BatchDetectEntities482Example:
                  summary: Default BatchDetectEntities 482
                  x-microcks-default: true
                  value: example
        '483':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectEntities483Example:
                  summary: Default BatchDetectEntities 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectEntities484Example:
                  summary: Default BatchDetectEntities 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectEntitiesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectEntities
      summary: Amazon Comprehend Batch Detect Entities
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.BatchDetectKeyPhrases:
    post:
      operationId: BatchDetectKeyPhrases
      description: Detects the key noun phrases found in a batch of documents.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectKeyPhrasesResponse'
              examples:
                BatchDetectKeyPhrases200Example:
                  summary: Default BatchDetectKeyPhrases 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectKeyPhrases480Example:
                  summary: Default BatchDetectKeyPhrases 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectKeyPhrases481Example:
                  summary: Default BatchDetectKeyPhrases 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                BatchDetectKeyPhrases482Example:
                  summary: Default BatchDetectKeyPhrases 482
                  x-microcks-default: true
                  value: example
        '483':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectKeyPhrases483Example:
                  summary: Default BatchDetectKeyPhrases 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectKeyPhrases484Example:
                  summary: Default BatchDetectKeyPhrases 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectKeyPhrasesRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectKeyPhrases
      summary: Amazon Comprehend Batch Detect Key Phrases
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.BatchDetectSentiment:
    post:
      operationId: BatchDetectSentiment
      description: 'Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each
        one.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectSentimentResponse'
              examples:
                BatchDetectSentiment200Example:
                  summary: Default BatchDetectSentiment 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectSentiment480Example:
                  summary: Default BatchDetectSentiment 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectSentiment481Example:
                  summary: Default BatchDetectSentiment 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                BatchDetectSentiment482Example:
                  summary: Default BatchDetectSentiment 482
                  x-microcks-default: true
                  value: example
        '483':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectSentiment483Example:
                  summary: Default BatchDetectSentiment 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectSentiment484Example:
                  summary: Default BatchDetectSentiment 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectSentimentRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectSentiment
      summary: Amazon Comprehend Batch Detect Sentiment
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.BatchDetectSyntax:
    post:
      operationId: BatchDetectSyntax
      description: 'Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a>
        in the Comprehend Developer Guide. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectSyntaxResponse'
              examples:
                BatchDetectSyntax200Example:
                  summary: Default BatchDetectSyntax 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectSyntax480Example:
                  summary: Default BatchDetectSyntax 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectSyntax481Example:
                  summary: Default BatchDetectSyntax 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                BatchDetectSyntax482Example:
                  summary: Default BatchDetectSyntax 482
                  x-microcks-default: true
                  value: example
        '483':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectSyntax483Example:
                  summary: Default BatchDetectSyntax 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectSyntax484Example:
                  summary: Default BatchDetectSyntax 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectSyntaxRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectSyntax
      summary: Amazon Comprehend Batch Detect Syntax
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.BatchDetectTargetedSentiment:
    post:
      operationId: BatchDetectTargetedSentiment
      description: '<p>Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.</p> <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted
        sentiment</a>.</p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDetectTargetedSentimentResponse'
              examples:
                BatchDetectTargetedSentiment200Example:
                  summary: Default BatchDetectTargetedSentiment 200
                  x-microcks-default: true
                  value:
                    ResultList: example
                    ErrorList: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                BatchDetectTargetedSentiment480Example:
                  summary: Default BatchDetectTargetedSentiment 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                BatchDetectTargetedSentiment481Example:
                  summary: Default BatchDetectTargetedSentiment 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                BatchDetectTargetedSentiment482Example:
                  summary: Default BatchDetectTargetedSentiment 482
                  x-microcks-default: true
                  value: example
        '483':
          description: BatchSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSizeLimitExceededException'
              examples:
                BatchDetectTargetedSentiment483Example:
                  summary: Default BatchDetectTargetedSentiment 483
                  x-microcks-default: true
                  value: example
        '484':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                BatchDetectTargetedSentiment484Example:
                  summary: Default BatchDetectTargetedSentiment 484
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchDetectTargetedSentimentRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.BatchDetectTargetedSentiment
      summary: Amazon Comprehend Batch Detect Targeted Sentiment
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.ClassifyDocument:
    post:
      operationId: ClassifyDocument
      description: '<p>Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.</p> <p>You can input
        plain text or you can upload a single-page input document (text, PDF, Word, or image). </p> <p>If the system detects errors while processing a page in the input document, the API response includes
        an entry in <code>Errors</code> that describes the errors.</p> <p>If the system detects a document-level error in your input document, the API returns an <code>InvalidRequestException</code> error
        response. For details about this exception, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync-err.html"> Errors in semi-structured documents</a> in the Comprehend Developer
        Guide. </p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassifyDocumentResponse'
              examples:
                ClassifyDocument200Example:
                  summary: Default ClassifyDocument 200
                  x-microcks-default: true
                  value:
                    Classes: example
                    Labels: example
                    DocumentMetadata: example
                    DocumentType: example
                    Errors: example
                    Warnings: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                ClassifyDocument480Example:
                  summary: Default ClassifyDocument 480
                  x-microcks-default: true
                  value: example
        '481':
          description: ResourceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceUnavailableException'
              examples:
                ClassifyDocument481Example:
                  summary: Default ClassifyDocument 481
                  x-microcks-default: true
                  value: example
        '482':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                ClassifyDocument482Example:
                  summary: Default ClassifyDocument 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ClassifyDocument483Example:
                  summary: Default ClassifyDocument 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClassifyDocumentRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.ClassifyDocument
      summary: Amazon Comprehend Classify Document
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /#X-Amz-Target=Comprehend_20171127.ContainsPiiEntities:
    post:
      operationId: ContainsPiiEntities
      description: 'Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or
        phone number.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainsPiiEntitiesResponse'
              examples:
                ContainsPiiEntities200Example:
                  summary: Default ContainsPiiEntities 200
                  x-microcks-default: true
                  value:
                    Labels: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                ContainsPiiEntities480Example:
                  summary: Default ContainsPiiEntities 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                ContainsPiiEntities481Example:
                  summary: Default ContainsPiiEntities 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                ContainsPiiEntities482Example:
                  summary: Default ContainsPiiEntities 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ContainsPiiEntities483Example:
                  summary: Default ContainsPiiEntities 483
                  x-microcks-default: true
                  value: example
      requ

# --- truncated at 32 KB (611 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/openapi/amazon-comprehend-openapi.yml