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

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'Amazon Mechanical Turk #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.AcceptQualificationRequest #X Amz Target=MTurkRequesterServiceV20170117.ListQualificationTypes #X Amz Target=MTurkRequesterServiceV20170117.ListQualificationTypes #X Amz Target=MTurkRequesterServiceV20170117.ListQualificationTypes 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
    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.ListQualificationTypes'
paths:
  /#X-Amz-Target=MTurkRequesterServiceV20170117.ListQualificationTypes:
    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: ListQualificationTypes
      description: ' The <code>ListQualificationTypes</code> operation returns a list of Qualification types, filtered by an optional search term. '
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQualificationTypesResponse'
        '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/ListQualificationTypesRequest'
      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.ListQualificationTypes
      summary: Amazon Mechanical Turk List Qualification Types
      tags:
      - '#X Amz Target=MTurkRequesterServiceV20170117.ListQualificationTypes'
components:
  schemas:
    QualificationType:
      type: object
      properties:
        QualificationTypeId:
          allOf:
          - $ref: '#/components/schemas/EntityId'
          - description: ' A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation. '
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: ' The date and time the Qualification type was created. '
        Name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search. '
        Description:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' A long description for the Qualification type. '
        Keywords:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search. '
        QualificationTypeStatus:
          allOf:
          - $ref: '#/components/schemas/QualificationTypeStatus'
          - description: ' The status of the Qualification type. A Qualification type''s status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive. '
        Test:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true. '
        TestDurationInSeconds:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: ' The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification. '
        AnswerKey:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The answers to the Qualification test specified in the Test parameter.
        RetryDelayInSeconds:
          allOf:
          - $ref: '#/components/schemas/Long'
          - description: ' The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once. '
        IsRequestable:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False. '
        AutoGranted:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
        AutoGrantedValue:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: ' The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default. '
      description: ' The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test. '
    EntityId:
      type: string
      pattern: ^[A-Z0-9]+$
      minLength: 1
      maxLength: 64
    Boolean:
      type: boolean
    Integer:
      type: integer
    QualificationTypeStatus:
      type: string
      enum:
      - Active
      - Inactive
    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
    ListQualificationTypesRequest:
      type: object
      required:
      - MustBeRequestable
      title: ListQualificationTypesRequest
      properties:
        Query:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' A text query against all of the searchable attributes of Qualification types. '
        MustBeRequestable:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: 'Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False. '
        MustBeOwnedByCaller:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: ' Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types. '
        NextToken:
          $ref: '#/components/schemas/PaginationToken'
        MaxResults:
          allOf:
          - $ref: '#/components/schemas/ResultSize'
          - description: ' The maximum number of results to return in a single call. '
    QualificationTypeList:
      type: array
      items:
        $ref: '#/components/schemas/QualificationType'
    String:
      type: string
    ServiceFault: {}
    ResultSize:
      type: integer
      minimum: 1
      maximum: 100
    Long:
      type: integer
    Timestamp:
      type: string
      format: date-time
    ListQualificationTypesResponse:
      type: object
      properties:
        NumResults:
          allOf:
          - $ref: '#/components/schemas/Integer'
          - description: ' The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns. '
        NextToken:
          $ref: '#/components/schemas/PaginationToken'
        QualificationTypes:
          allOf:
          - $ref: '#/components/schemas/QualificationTypeList'
          - description: ' The list of QualificationType elements returned by the query. '
    RequestError: {}
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      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
    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-Content-Sha256:
      name: X-Amz-Content-Sha256
      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