You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MTurk::Types::QualificationType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#answer_keyString

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

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#auto_grantedBoolean

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

Returns:

  • (Boolean)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#auto_granted_valueInteger

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

Returns:

  • (Integer)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#creation_timeTime

The date and time the Qualification type was created.

Returns:

  • (Time)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#descriptionString

A long description for the Qualification type.

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#is_requestableBoolean

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.

Returns:

  • (Boolean)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#keywordsString

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

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#qualification_type_idString

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

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#qualification_type_statusString

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.

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#retry_delay_in_secondsInteger

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.

Returns:

  • (Integer)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#testString

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.

Returns:

  • (String)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#test_duration_in_secondsInteger

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

Returns:

  • (Integer)


2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2519

class QualificationType < Struct.new(
  :qualification_type_id,
  :creation_time,
  :name,
  :description,
  :keywords,
  :qualification_type_status,
  :test,
  :test_duration_in_seconds,
  :answer_key,
  :retry_delay_in_seconds,
  :is_requestable,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end