Amazon Comprehend #X Amz Target=Comprehend 20171127.ListEntityRecognizerSummaries API

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.ListEntityRecognizerSummaries 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.ListEntityRecognizerSummaries'
paths:
  /#X-Amz-Target=Comprehend_20171127.ListEntityRecognizerSummaries:
    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: ListEntityRecognizerSummaries
      description: Gets a list of summaries for the entity recognizers that you have created.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEntityRecognizerSummariesResponse'
              examples:
                ListEntityRecognizerSummaries200Example:
                  summary: Default ListEntityRecognizerSummaries 200
                  x-microcks-default: true
                  value:
                    EntityRecognizerSummariesList: example
                    NextToken: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                ListEntityRecognizerSummaries480Example:
                  summary: Default ListEntityRecognizerSummaries 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                ListEntityRecognizerSummaries481Example:
                  summary: Default ListEntityRecognizerSummaries 481
                  x-microcks-default: true
                  value: example
        '482':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListEntityRecognizerSummaries482Example:
                  summary: Default ListEntityRecognizerSummaries 482
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListEntityRecognizerSummariesRequest'
      parameters:
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.ListEntityRecognizerSummaries
      summary: Amazon Comprehend List Entity Recognizer Summaries
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=Comprehend 20171127.ListEntityRecognizerSummaries'
components:
  schemas:
    ListEntityRecognizerSummariesResponse:
      type: object
      properties:
        EntityRecognizerSummariesList:
          allOf:
          - $ref: '#/components/schemas/EntityRecognizerSummariesList'
          - description: The list entity recognizer summaries.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Identifies the next page of results to return.
    EntityRecognizerSummary:
      type: object
      properties:
        RecognizerName:
          allOf:
          - $ref: '#/components/schemas/ComprehendArnName'
          - description: ' The name that you assigned the entity recognizer.'
        NumberOfVersions:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: ' The number of versions you created.'
        LatestVersionCreatedAt:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The time that the latest entity recognizer version was submitted for processing.'
        LatestVersionName:
          allOf:
          - $ref: '#/components/schemas/VersionName'
          - description: ' The version name you assigned to the latest entity recognizer version.'
        LatestVersionStatus:
          allOf:
          - $ref: '#/components/schemas/ModelStatus'
          - description: ' Provides the status of the latest entity recognizer version.'
      description: ' Describes the information about an entity recognizer and its versions.'
    VersionName:
      type: string
      pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
      maxLength: 63
    ModelStatus:
      type: string
      enum:
      - SUBMITTED
      - TRAINING
      - DELETING
      - STOP_REQUESTED
      - STOPPED
      - IN_ERROR
      - TRAINED
      - TRAINED_WITH_WARNING
    InvalidRequestException: {}
    String:
      type: string
      minLength: 1
    Integer:
      type: integer
    Timestamp:
      type: string
      format: date-time
    ListEntityRecognizerSummariesRequest:
      type: object
      title: ListEntityRecognizerSummariesRequest
      properties:
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Identifies the next page of results to return.
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/MaxResultsInteger'
          - description: The maximum number of results to return on each page. The default is 100.
    TooManyRequestsException: {}
    InternalServerException: {}
    EntityRecognizerSummariesList:
      type: array
      items:
        $ref: '#/components/schemas/EntityRecognizerSummary'
    ComprehendArnName:
      type: string
      pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$
      maxLength: 63
    MaxResultsInteger:
      type: integer
      minimum: 1
      maximum: 500
  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