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

Class: Aws::MTurk::Types::CreateQualificationTypeRequest

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 CreateQualificationTypeRequest data as a hash:

{
  name: "String", # required
  keywords: "String",
  description: "String", # required
  qualification_type_status: "Active", # required, accepts Active, Inactive
  retry_delay_in_seconds: 1,
  test: "String",
  answer_key: "String",
  test_duration_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.

Constraints: Must not be longer than 65535 bytes.

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

Returns:

  • (String)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

class CreateQualificationTypeRequest < Struct.new(
  :name,
  :keywords,
  :description,
  :qualification_type_status,
  :retry_delay_in_seconds,
  :test,
  :answer_key,
  :test_duration_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)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

class CreateQualificationTypeRequest < Struct.new(
  :name,
  :keywords,
  :description,
  :qualification_type_status,
  :retry_delay_in_seconds,
  :test,
  :answer_key,
  :test_duration_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)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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

#descriptionString

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.

Returns:

  • (String)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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

#keywordsString

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.

Returns:

  • (String)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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

#nameString

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.

Returns:

  • (String)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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

#qualification_type_statusString

The initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

Returns:

  • (String)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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

#retry_delay_in_secondsInteger

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.

Returns:

  • (Integer)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

class CreateQualificationTypeRequest < Struct.new(
  :name,
  :keywords,
  :description,
  :qualification_type_status,
  :retry_delay_in_seconds,
  :test,
  :answer_key,
  :test_duration_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)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

class CreateQualificationTypeRequest < Struct.new(
  :name,
  :keywords,
  :description,
  :qualification_type_status,
  :retry_delay_in_seconds,
  :test,
  :answer_key,
  :test_duration_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)


875
876
877
878
879
880
881
882
883
884
885
886
887
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 875

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