Amazon Comprehend #X Amz Target=Comprehend 20171127.DescribeFlywheelIteration 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.DescribeFlywheelIteration 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.DescribeFlywheelIteration'
paths:
  /#X-Amz-Target=Comprehend_20171127.DescribeFlywheelIteration:
    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: DescribeFlywheelIteration
      description: Retrieve the configuration properties of a flywheel iteration. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html"> Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFlywheelIterationResponse'
              examples:
                DescribeFlywheelIteration200Example:
                  summary: Default DescribeFlywheelIteration 200
                  x-microcks-default: true
                  value:
                    FlywheelIterationProperties: example
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                DescribeFlywheelIteration480Example:
                  summary: Default DescribeFlywheelIteration 480
                  x-microcks-default: true
                  value: example
        '481':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                DescribeFlywheelIteration481Example:
                  summary: Default DescribeFlywheelIteration 481
                  x-microcks-default: true
                  value: example
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                DescribeFlywheelIteration482Example:
                  summary: Default DescribeFlywheelIteration 482
                  x-microcks-default: true
                  value: example
        '483':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DescribeFlywheelIteration483Example:
                  summary: Default DescribeFlywheelIteration 483
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFlywheelIterationRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.DescribeFlywheelIteration
      summary: Amazon Comprehend Describe Flywheel Iteration
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=Comprehend 20171127.DescribeFlywheelIteration'
components:
  schemas:
    ComprehendModelArn:
      type: string
      pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?
      maxLength: 256
    FlywheelIterationStatus:
      type: string
      enum:
      - TRAINING
      - EVALUATING
      - COMPLETED
      - FAILED
      - STOP_REQUESTED
      - STOPPED
    ResourceNotFoundException: {}
    AnyLengthString:
      type: string
    S3Uri:
      type: string
      pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?
      maxLength: 1024
    DescribeFlywheelIterationResponse:
      type: object
      properties:
        FlywheelIterationProperties:
          allOf:
          - $ref: '#/components/schemas/FlywheelIterationProperties'
          - description: The configuration properties of a flywheel iteration.
    InvalidRequestException: {}
    ComprehendFlywheelArn:
      type: string
      pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*
      maxLength: 256
    Timestamp:
      type: string
      format: date-time
    Double:
      type: number
      format: double
    TooManyRequestsException: {}
    DescribeFlywheelIterationRequest:
      type: object
      required:
      - FlywheelArn
      - FlywheelIterationId
      title: DescribeFlywheelIterationRequest
      properties:
        FlywheelArn:
          allOf:
          - $ref: '#/components/schemas/ComprehendFlywheelArn'
          - description: <p/>
        FlywheelIterationId:
          allOf:
          - $ref: '#/components/schemas/FlywheelIterationId'
          - description: <p/>
    FlywheelIterationId:
      type: string
      pattern: '[0-9]{8}T[0-9]{6}Z'
      maxLength: 63
    FlywheelIterationProperties:
      type: object
      properties:
        FlywheelArn:
          allOf:
          - $ref: '#/components/schemas/ComprehendFlywheelArn'
          - description: <p/>
        FlywheelIterationId:
          allOf:
          - $ref: '#/components/schemas/FlywheelIterationId'
          - description: <p/>
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The creation start time of the flywheel iteration.
        EndTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The completion time of this flywheel iteration.
        Status:
          allOf:
          - $ref: '#/components/schemas/FlywheelIterationStatus'
          - description: The status of the flywheel iteration.
        Message:
          allOf:
          - $ref: '#/components/schemas/AnyLengthString'
          - description: A description of the status of the flywheel iteration.
        EvaluatedModelArn:
          allOf:
          - $ref: '#/components/schemas/ComprehendModelArn'
          - description: The ARN of the evaluated model associated with this flywheel iteration.
        EvaluatedModelMetrics:
          $ref: '#/components/schemas/FlywheelModelEvaluationMetrics'
        TrainedModelArn:
          allOf:
          - $ref: '#/components/schemas/ComprehendModelArn'
          - description: The ARN of the trained model associated with this flywheel iteration.
        TrainedModelMetrics:
          allOf:
          - $ref: '#/components/schemas/FlywheelModelEvaluationMetrics'
          - description: The metrics associated with the trained model.
        EvaluationManifestS3Prefix:
          allOf:
          - $ref: '#/components/schemas/S3Uri'
          - description: <p/>
      description: The configuration properties of a flywheel iteration.
    InternalServerException: {}
    FlywheelModelEvaluationMetrics:
      type: object
      properties:
        AverageF1Score:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: The average F1 score from the evaluation metrics.
        AveragePrecision:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: Average precision metric for the model.
        AverageRecall:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: Average recall metric for the model.
        AverageAccuracy:
          allOf:
          - $ref: '#/components/schemas/Double'
          - description: Average accuracy metric for the model.
      description: The evaluation metrics associated with the evaluated model.
  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