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

Class: Aws::MTurk::Types::UpdateQualificationTypeRequest

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

Overview

Note:

When making an API call, you may pass UpdateQualificationTypeRequest data as a hash:

{
  qualification_type_id: "EntityId", # required
  description: "String",
  qualification_type_status: "Active", # accepts Active, Inactive
  test: "String",
  answer_key: "String",
  test_duration_in_seconds: 1,
  retry_delay_in_seconds: 1,
  auto_granted: false,
  auto_granted_value: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#answer_keyString

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

Returns:

  • (String)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#auto_grantedBoolean

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.

Returns:

  • (Boolean)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#auto_granted_valueInteger

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

Returns:

  • (Integer)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#descriptionString

The new description of the Qualification type.

Returns:

  • (String)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#qualification_type_idString

The ID of the Qualification type to update.

Returns:

  • (String)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#qualification_type_statusString

The new status of the Qualification type - Active | Inactive

Returns:

  • (String)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#retry_delay_in_secondsInteger

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.

Returns:

  • (Integer)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#testString

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.

Returns:

  • (String)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end

#test_duration_in_secondsInteger

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

Returns:

  • (Integer)


3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 3062

class UpdateQualificationTypeRequest < Struct.new(
  :qualification_type_id,
  :description,
  :qualification_type_status,
  :test,
  :answer_key,
  :test_duration_in_seconds,
  :retry_delay_in_seconds,
  :auto_granted,
  :auto_granted_value)
  include Aws::Structure
end