Skip to content

CreateQualificationTypeRequest

Source code in docs_src/capo_mturk/types/create_qualification_type_request.py
class CreateQualificationTypeRequest(TypedDict, closed=True):
    name: "capo_mturk.types.string.String"
    """<p> The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.</p>"""
    keywords: NotRequired["capo_mturk.types.string.String"]
    """<p>One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.</p>"""
    description: "capo_mturk.types.string.String"
    """<p>A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.</p>"""
    qualification_type_status: (
        "capo_mturk.types.qualification_type_status.QualificationTypeStatus"
    )
    """<p>The initial status of the Qualification type.</p> <p>Constraints: Valid values are: Active | Inactive</p>"""
    retry_delay_in_seconds: NotRequired["capo_mturk.types.long.Long"]
    """<p>The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.</p> <p>Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.</p>"""
    test: NotRequired["capo_mturk.types.string.String"]
    """<p> The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified. </p> <p>Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.</p> <p>Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.</p>"""
    answer_key: NotRequired["capo_mturk.types.string.String"]
    """<p>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.</p> <p>Constraints: Must not be longer than 65535 bytes.</p> <p>Constraints: None. If not specified, you must process Qualification requests manually.</p>"""
    test_duration_in_seconds: NotRequired["capo_mturk.types.long.Long"]
    """<p>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.</p>"""
    auto_granted: NotRequired["capo_mturk.types.boolean.Boolean"]
    """<p>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.</p> <p>Constraints: If the Test parameter is specified, this parameter cannot be true.</p>"""
    auto_granted_value: NotRequired["capo_mturk.types.integer.Integer"]
    """<p>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.</p>"""

answer_key instance-attribute

answer_key: NotRequired[String]

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Constraints: Must not be longer than 65535 bytes.

Constraints: None. If not specified, you must process Qualification requests manually.

auto_granted instance-attribute

auto_granted: NotRequired[Boolean]

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

auto_granted_value instance-attribute

auto_granted_value: NotRequired[Integer]

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

description instance-attribute

description: String

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

keywords instance-attribute

keywords: NotRequired[String]

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

name instance-attribute

name: String

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.

qualification_type_status instance-attribute

qualification_type_status: QualificationTypeStatus

The initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

retry_delay_in_seconds instance-attribute

retry_delay_in_seconds: NotRequired[Long]

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.

test instance-attribute

test: NotRequired[String]

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

test_duration_in_seconds instance-attribute

test_duration_in_seconds: NotRequired[Long]

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.