openapi: 3.0.0
info:
  version: '2017-11-27'
  x-release: v4
  title: 'Amazon Comprehend #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.BatchDetectDominantLanguage #X Amz Target=Comprehend 20171127.DetectSyntax API'
  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
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)
security:
- hmac: []
tags:
- name: '#X Amz Target=Comprehend 20171127.DetectSyntax'
paths:
  /#X-Amz-Target=Comprehend_20171127.DetectSyntax:
    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'
    post:
      operationId: DetectSyntax
      description: 'Inspects text for syntax and the part of speech of words in the document. 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/DetectSyntaxResponse'
              examples:
                DetectSyntax200Example:
                  summary: Default DetectSyntax 200
                  x-microcks-default: true
                  value:
                    SyntaxTokens: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                DetectSyntax480Example:
                  summary: Default DetectSyntax 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TextSizeLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextSizeLimitExceededException'
              examples:
                DetectSyntax481Example:
                  summary: Default DetectSyntax 481
                  x-microcks-default: true
                  value: example
        '482':
          description: UnsupportedLanguageException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedLanguageException'
              examples:
                DetectSyntax482Example:
                  summary: Default DetectSyntax 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DetectSyntax483Example:
                  summary: Default DetectSyntax 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetectSyntaxRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.DetectSyntax
      summary: Amazon Comprehend Detect Syntax
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=Comprehend 20171127.DetectSyntax'
components:
  schemas:
    ListOfSyntaxTokens:
      type: array
      items:
        $ref: '#/components/schemas/SyntaxToken'
    UnsupportedLanguageException: {}
    TextSizeLimitExceededException: {}
    SyntaxLanguageCode:
      type: string
      enum:
      - en
      - es
      - fr
      - de
      - it
      - pt
    PartOfSpeechTag:
      type: object
      properties:
        Tag:
          allOf:
          - $ref: '#/components/schemas/PartOfSpeechTagType'
          - description: Identifies the part of speech that the token represents.
        Score:
          allOf:
          - $ref: '#/components/schemas/Float'
          - description: The confidence that Amazon Comprehend has that the part of speech was correctly identified.
      description: 'Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide. '
    InvalidRequestException: {}
    Float:
      type: number
      format: float
    String:
      type: string
      minLength: 1
    PartOfSpeechTagType:
      type: string
      enum:
      - ADJ
      - ADP
      - ADV
      - AUX
      - CONJ
      - CCONJ
      - DET
      - INTJ
      - NOUN
      - NUM
      - O
      - PART
      - PRON
      - PROPN
      - PUNCT
      - SCONJ
      - SYM
      - VERB
    Integer:
      type: integer
    DetectSyntaxResponse:
      type: object
      properties:
        SyntaxTokens:
          allOf:
          - $ref: '#/components/schemas/ListOfSyntaxTokens'
          - description: 'A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide. '
    CustomerInputString:
      type: string
      minLength: 1
      format: password
    SyntaxToken:
      type: object
      properties:
        TokenId:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: A unique identifier for a token.
        Text:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The word that was recognized in the source text.
        BeginOffset:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The zero-based offset from the beginning of the source text to the first character in the word.
        EndOffset:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: The zero-based offset from the beginning of the source text to the last character in the word.
        PartOfSpeech:
          allOf:
          - $ref: '#/components/schemas/PartOfSpeechTag'
          - description: 'Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide. '
      description: Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.
    InternalServerException: {}
    DetectSyntaxRequest:
      type: object
      required:
      - Text
      - LanguageCode
      title: DetectSyntaxRequest
      properties:
        Text:
          allOf:
          - $ref: '#/components/schemas/CustomerInputString'
          - description: A UTF-8 string. The maximum string size is 5 KB.
        LanguageCode:
          allOf:
          - $ref: '#/components/schemas/SyntaxLanguageCode'
          - description: 'The language code of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").'
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/comprehend/
x-hasEquivalentPaths: true