Amazonka.MechanicalTurk.Types.QualificationType

Documentation

data QualificationType

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.

See: newQualificationType smart constructor.

Constructors

QualificationType'

Fields

• answerKey :: Maybe Text

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

• autoGranted :: Maybe Bool

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

• autoGrantedValue :: Maybe Int

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

• creationTime :: Maybe POSIX

  The date and time the Qualification type was created.

• description :: Maybe Text

  A long description for the Qualification type.

• isRequestable :: Maybe Bool

  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 :: Maybe Text

  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 :: Maybe Text

  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.

• qualificationTypeId :: Maybe Text

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

• qualificationTypeStatus :: Maybe 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.

• retryDelayInSeconds :: Maybe Integer

  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 :: Maybe Text

  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.

• testDurationInSeconds :: Maybe Integer

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

Instances

FromJSON QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

parseJSON :: Value -> Parser QualificationType

parseJSONList :: Value -> Parser [QualificationType]

Generic QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Associated Types

type Rep QualificationType :: Type -> Type

Methods

from :: QualificationType -> Rep QualificationType x

to :: Rep QualificationType x -> QualificationType

Read QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

readsPrec :: Int -> ReadS QualificationType

readList :: ReadS [QualificationType]

readPrec :: ReadPrec QualificationType

readListPrec :: ReadPrec [QualificationType]

Show QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

showsPrec :: Int -> QualificationType -> ShowS

show :: QualificationType -> String

showList :: [QualificationType] -> ShowS

NFData QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

rnf :: QualificationType -> ()

Eq QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

(==) :: QualificationType -> QualificationType -> Bool

(/=) :: QualificationType -> QualificationType -> Bool

Hashable QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

Methods

hashWithSalt :: Int -> QualificationType -> Int

hash :: QualificationType -> Int

type Rep QualificationType

Defined in Amazonka.MechanicalTurk.Types.QualificationType

type Rep QualificationType = D1 ('MetaData "QualificationType" "Amazonka.MechanicalTurk.Types.QualificationType" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "QualificationType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "answerKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "autoGranted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "autoGrantedValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isRequestable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "keywords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "qualificationTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "qualificationTypeStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QualificationTypeStatus)) :*: S1 ('MetaSel ('Just "retryDelayInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "test") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "testDurationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))))))

newQualificationType :: QualificationType

Create a value of QualificationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:answerKey:QualificationType', qualificationType_answerKey - The answers to the Qualification test specified in the Test parameter.

$sel:autoGranted:QualificationType', qualificationType_autoGranted - Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

$sel:autoGrantedValue:QualificationType', qualificationType_autoGrantedValue - The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

$sel:creationTime:QualificationType', qualificationType_creationTime - The date and time the Qualification type was created.

$sel:description:QualificationType', qualificationType_description - A long description for the Qualification type.

$sel:isRequestable:QualificationType', qualificationType_isRequestable - 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.

$sel:keywords:QualificationType', qualificationType_keywords - One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

$sel:name:QualificationType', qualificationType_name - 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.

$sel:qualificationTypeId:QualificationType', qualificationType_qualificationTypeId - A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

$sel:qualificationTypeStatus:QualificationType', qualificationType_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.

$sel:retryDelayInSeconds:QualificationType', qualificationType_retryDelayInSeconds - 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.

$sel:test:QualificationType', qualificationType_test - 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.

$sel:testDurationInSeconds:QualificationType', qualificationType_testDurationInSeconds - The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

qualificationType_answerKey :: Lens' QualificationType (Maybe Text)

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

qualificationType_autoGranted :: Lens' QualificationType (Maybe Bool)

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

qualificationType_autoGrantedValue :: Lens' QualificationType (Maybe Int)

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

qualificationType_creationTime :: Lens' QualificationType (Maybe UTCTime)

The date and time the Qualification type was created.

qualificationType_description :: Lens' QualificationType (Maybe Text)

A long description for the Qualification type.

qualificationType_isRequestable :: Lens' QualificationType (Maybe Bool)

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.

qualificationType_keywords :: Lens' QualificationType (Maybe Text)

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

qualificationType_name :: Lens' QualificationType (Maybe Text)

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.

qualificationType_qualificationTypeId :: Lens' QualificationType (Maybe Text)

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

qualificationType_qualificationTypeStatus :: Lens' QualificationType (Maybe 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.

qualificationType_retryDelayInSeconds :: Lens' QualificationType (Maybe Integer)

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.

qualificationType_test :: Lens' QualificationType (Maybe Text)

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.

qualificationType_testDurationInSeconds :: Lens' QualificationType (Maybe Integer)

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