Skip to content

QualificationType

Source code in docs_src/capo_mturk/types/qualification_type.py
class QualificationType(TypedDict, closed=True):
    qualification_type_id: NotRequired["capo_mturk.types.entity_id.EntityId"]
    """<p> A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation. </p>"""
    creation_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> The date and time the Qualification type was created. </p>"""
    name: NotRequired["capo_mturk.types.string.String"]
    """<p> 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. </p>"""
    description: NotRequired["capo_mturk.types.string.String"]
    """<p> A long description for the Qualification type. </p>"""
    keywords: NotRequired["capo_mturk.types.string.String"]
    """<p> One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search. </p>"""
    qualification_type_status: NotRequired[
        "capo_mturk.types.qualification_type_status.QualificationTypeStatus"
    ]
    """<p> 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. </p>"""
    test: NotRequired["capo_mturk.types.string.String"]
    """<p> 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. </p>"""
    test_duration_in_seconds: NotRequired["capo_mturk.types.long.Long"]
    """<p> The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification. </p>"""
    answer_key: NotRequired["capo_mturk.types.string.String"]
    """<p>The answers to the Qualification test specified in the Test parameter.</p>"""
    retry_delay_in_seconds: NotRequired["capo_mturk.types.long.Long"]
    """<p> 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. </p>"""
    is_requestable: NotRequired["capo_mturk.types.boolean.Boolean"]
    """<p> 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. </p>"""
    auto_granted: NotRequired["capo_mturk.types.boolean.Boolean"]
    """<p>Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.</p>"""
    auto_granted_value: NotRequired["capo_mturk.types.integer.Integer"]
    """<p> The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default. </p>"""

answer_key instance-attribute

answer_key: NotRequired[String]

The answers to the Qualification test specified in the Test parameter.

auto_granted instance-attribute

auto_granted: NotRequired[Boolean]

Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

auto_granted_value instance-attribute

auto_granted_value: NotRequired[Integer]

The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The date and time the Qualification type was created.

description instance-attribute

description: NotRequired[String]

A long description for the Qualification type.

is_requestable instance-attribute

is_requestable: NotRequired[Boolean]

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.

keywords instance-attribute

keywords: NotRequired[String]

One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

name instance-attribute

name: NotRequired[String]

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.

qualification_type_id instance-attribute

qualification_type_id: NotRequired[EntityId]

A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

qualification_type_status instance-attribute

qualification_type_status: NotRequired[QualificationTypeStatus]

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.

retry_delay_in_seconds instance-attribute

retry_delay_in_seconds: NotRequired[Long]

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.

test instance-attribute

test: NotRequired[String]

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.

test_duration_in_seconds instance-attribute

test_duration_in_seconds: NotRequired[Long]

The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.