Amazon Mechanical Turk #X Amz Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT API

openapi: 3.0.0
info:
  version: '2017-01-17'
  x-release: v4
  title: 'Amazon Mechanical Turk #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT API'
  description: <fullname>Amazon Mechanical Turk API Reference</fullname>
  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: mturk-requester
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mturk-requester-2017-01-17.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://mturk-requester.{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 MTurk multi-region endpoint
- url: https://mturk-requester.{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 MTurk multi-region endpoint
- url: http://mturk-requester.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon MTurk endpoint for China (Beijing) and China (Ningxia)
- url: https://mturk-requester.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon MTurk endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT'
paths:
  /#X-Amz-Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT:
    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: ListReviewPolicyResultsForHIT
      description: ' The <code>ListReviewPolicyResultsForHIT</code> operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReviewPolicyResultsForHITResponse'
        '480':
          description: ServiceFault
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceFault'
        '481':
          description: RequestError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListReviewPolicyResultsForHITRequest'
      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:
          - MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT
      summary: Amazon Mechanical Turk List Review Policy Results for H I T
      tags:
      - '#X Amz Target=MTurkRequesterServiceV20170117.ListReviewPolicyResultsForHIT'
components:
  schemas:
    ReviewPolicy:
      type: object
      required:
      - PolicyName
      properties:
        PolicyName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01 '
        Parameters:
          allOf:
          - $ref: '#/components/schemas/PolicyParameterList'
          - description: Name of the parameter from the Review policy.
      description: ' HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT. '
    ReviewActionDetailList:
      type: array
      items:
        $ref: '#/components/schemas/ReviewActionDetail'
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/String'
    ReviewReport:
      type: object
      properties:
        ReviewResults:
          allOf:
          - $ref: '#/components/schemas/ReviewResultDetailList'
          - description: ' A list of ReviewResults objects for each action specified in the Review Policy. '
        ReviewActions:
          allOf:
          - $ref: '#/components/schemas/ReviewActionDetailList'
          - description: ' A list of ReviewAction objects for each action specified in the Review Policy. '
      description: ' Contains both ReviewResult and ReviewAction elements for a particular HIT. '
    ReviewResultDetailList:
      type: array
      items:
        $ref: '#/components/schemas/ReviewResultDetail'
    RequestError: {}
    ReviewPolicyLevelList:
      type: array
      items:
        $ref: '#/components/schemas/ReviewPolicyLevel'
    ListReviewPolicyResultsForHITResponse:
      type: object
      properties:
        HITId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The HITId of the HIT for which results have been returned.
        AssignmentReviewPolicy:
          allOf:
          - $ref: '#/components/schemas/ReviewPolicy'
          - description: ' The name of the Assignment-level Review Policy. This contains only the PolicyName element. '
        HITReviewPolicy:
          allOf:
          - $ref: '#/components/schemas/ReviewPolicy'
          - description: The name of the HIT-level Review Policy. This contains only the PolicyName element.
        AssignmentReviewReport:
          allOf:
          - $ref: '#/components/schemas/ReviewReport'
          - description: ' Contains both ReviewResult and ReviewAction elements for an Assignment. '
        HITReviewReport:
          allOf:
          - $ref: '#/components/schemas/ReviewReport'
          - description: 'Contains both ReviewResult and ReviewAction elements for a particular HIT. '
        NextToken:
          $ref: '#/components/schemas/PaginationToken'
    ReviewActionDetail:
      type: object
      properties:
        ActionId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The unique identifier for the action.
        ActionName:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary. '
        TargetId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: ' The specific HITId or AssignmentID targeted by the action.'
        TargetType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The type of object in TargetId.'
        Status:
          allOf:
          - $ref: '#/components/schemas/ReviewActionStatus'
          - description: ' The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED. '
        CompleteTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The date when the action was completed.'
        Result:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' A description of the outcome of the review.'
        ErrorCode:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' Present only when the Results have a FAILED Status.'
      description: ' Both the AssignmentReviewReport and the HITReviewReport elements contains the ReviewActionDetail data structure. This structure is returned multiple times for each action specified in the Review Policy. '
    Boolean:
      type: boolean
    PaginationToken:
      type: string
      description: 'If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results. '
      minLength: 1
      maxLength: 255
    ServiceFault: {}
    EntityId:
      type: string
      pattern: ^[A-Z0-9]+$
      minLength: 1
      maxLength: 64
    String:
      type: string
    ReviewPolicyLevel:
      type: string
      enum:
      - Assignment
      - HIT
    ListReviewPolicyResultsForHITRequest:
      type: object
      required:
      - HITId
      title: ListReviewPolicyResultsForHITRequest
      properties:
        HITId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: The unique identifier of the HIT to retrieve review results for.
        PolicyLevels:
          allOf:
          - $ref: '#/components/schemas/ReviewPolicyLevelList'
          - description: ' The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies. '
        RetrieveActions:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes. '
        RetrieveResults:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specify if the operation should retrieve a list of the results computed by the Review Policies. '
        NextToken:
          allOf:
          - $ref: '#/components/schemas/PaginationToken'
          - description: Pagination token
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/ResultSize'
          - description: Limit the number of results returned.
    PolicyParameter:
      type: object
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' Name of the parameter from the list of Review Polices. '
        Values:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' The list of values of the Parameter'
        MapEntries:
          allOf:
          - $ref: '#/components/schemas/ParameterMapEntryList'
          - description: ' List of ParameterMapEntry objects. '
      description: ' Name of the parameter from the Review policy. '
    Timestamp:
      type: string
      format: date-time
    ResultSize:
      type: integer
      minimum: 1
      maximum: 100
    ParameterMapEntryList:
      type: array
      items:
        $ref: '#/components/schemas/ParameterMapEntry'
    ReviewResultDetail:
      type: object
      properties:
        ActionId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: ' A unique identifier of the Review action result. '
        SubjectId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: 'The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself. '
        SubjectType:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The type of the object from the SubjectId field.'
        QuestionId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: ' Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker''s performance on the HIT. '
        Key:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' Key identifies the particular piece of reviewed information. '
        Value:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The values of Key provided by the review policies you have selected. '
      description: ' This data structure is returned multiple times for each result specified in the Review Policy. '
    ParameterMapEntry:
      type: object
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy. '
        Values:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly. '
      description: ' This data structure is the data type for the AnswerKey parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy. '
    PolicyParameterList:
      type: array
      items:
        $ref: '#/components/schemas/PolicyParameter'
    ReviewActionStatus:
      type: string
      enum:
      - Intended
      - Succeeded
      - Failed
      - Cancelled
  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/mturk-requester/
x-hasEquivalentPaths: true