Skip to content

UpdateQualificationTypeRequest

Source code in docs_src/capo_mturk/types/update_qualification_type_request.py
class UpdateQualificationTypeRequest(TypedDict, closed=True):
    qualification_type_id: "capo_mturk.types.entity_id.EntityId"
    """<p>The ID of the Qualification type to update.</p>"""
    description: NotRequired["capo_mturk.types.string.String"]
    """<p>The new description of the Qualification type.</p>"""
    qualification_type_status: NotRequired[
        "capo_mturk.types.qualification_type_status.QualificationTypeStatus"
    ]
    """<p>The new status of the Qualification type - Active | Inactive</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>"""
    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>"""
    retry_delay_in_seconds: NotRequired["capo_mturk.types.long.Long"]
    """<p>The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.</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.

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: NotRequired[String]

The new description of the Qualification type.

qualification_type_id instance-attribute

qualification_type_id: EntityId

The ID of the Qualification type to update.

qualification_type_status instance-attribute

qualification_type_status: NotRequired[QualificationTypeStatus]

The new status of the Qualification type - Active | Inactive

retry_delay_in_seconds instance-attribute

retry_delay_in_seconds: NotRequired[Long]

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

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.