Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MechanicalTurk.UpdateQualificationType

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.

Synopsis

Creating a Request

data UpdateQualificationType Source #

See: newUpdateQualificationType smart constructor.

Constructors

UpdateQualificationType'

Fields

answerKey :: Maybe Text
The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
autoGranted :: Maybe Bool
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.
autoGrantedValue :: Maybe Int
The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
description :: Maybe Text
The new description of the Qualification type.
qualificationTypeStatus :: Maybe QualificationTypeStatus
The new status of the Qualification type - Active | Inactive
retryDelayInSeconds :: Maybe Integer
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 :: Maybe Text
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.
testDurationInSeconds :: Maybe Integer
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
qualificationTypeId :: Text
The ID of the Qualification type to update.

Instances

Instances details

ToJSON UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods toJSON :: UpdateQualificationType -> Value # toEncoding :: UpdateQualificationType -> Encoding # toJSONList :: [UpdateQualificationType] -> Value # toEncodingList :: [UpdateQualificationType] -> Encoding #
ToHeaders UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods toHeaders :: UpdateQualificationType -> [Header] #
ToPath UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods toPath :: UpdateQualificationType -> ByteString #
ToQuery UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods toQuery :: UpdateQualificationType -> QueryString #
AWSRequest UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Associated Types type AWSResponse UpdateQualificationType # Methods request :: (Service -> Service) -> UpdateQualificationType -> Request UpdateQualificationType # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateQualificationType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateQualificationType))) #
Generic UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Associated Types type Rep UpdateQualificationType :: Type -> Type # Methods from :: UpdateQualificationType -> Rep UpdateQualificationType x # to :: Rep UpdateQualificationType x -> UpdateQualificationType #
Read UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods readsPrec :: Int -> ReadS UpdateQualificationType # readList :: ReadS [UpdateQualificationType] # readPrec :: ReadPrec UpdateQualificationType # readListPrec :: ReadPrec [UpdateQualificationType] #
Show UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods showsPrec :: Int -> UpdateQualificationType -> ShowS # show :: UpdateQualificationType -> String # showList :: [UpdateQualificationType] -> ShowS #
NFData UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods rnf :: UpdateQualificationType -> () #
Eq UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods (==) :: UpdateQualificationType -> UpdateQualificationType -> Bool # (/=) :: UpdateQualificationType -> UpdateQualificationType -> Bool #
Hashable UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods hashWithSalt :: Int -> UpdateQualificationType -> Int # hash :: UpdateQualificationType -> Int #
type AWSResponse UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType type AWSResponse UpdateQualificationType = UpdateQualificationTypeResponse
type Rep UpdateQualificationType Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType type Rep UpdateQualificationType = D1 ('MetaData "UpdateQualificationType" "Amazonka.MechanicalTurk.UpdateQualificationType" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "UpdateQualificationType'" '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 "description") '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)) :: S1 ('MetaSel ('Just "qualificationTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateQualificationType Source #

Arguments

:: Text	`UpdateQualificationType`
-> UpdateQualificationType

Create a value of UpdateQualificationType 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:

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

UpdateQualificationType, updateQualificationType_autoGranted - 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.

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

UpdateQualificationType, updateQualificationType_description - The new description of the Qualification type.

UpdateQualificationType, updateQualificationType_qualificationTypeStatus - The new status of the Qualification type - Active | Inactive

UpdateQualificationType, updateQualificationType_retryDelayInSeconds - 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.

UpdateQualificationType, updateQualificationType_test - 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.

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

UpdateQualificationType, updateQualificationType_qualificationTypeId - The ID of the Qualification type to update.

Request Lenses

updateQualificationType_answerKey :: Lens' UpdateQualificationType (Maybe Text) Source #

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

updateQualificationType_autoGranted :: Lens' UpdateQualificationType (Maybe Bool) Source #

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.

updateQualificationType_autoGrantedValue :: Lens' UpdateQualificationType (Maybe Int) Source #

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

updateQualificationType_description :: Lens' UpdateQualificationType (Maybe Text) Source #

The new description of the Qualification type.

updateQualificationType_qualificationTypeStatus :: Lens' UpdateQualificationType (Maybe QualificationTypeStatus) Source #

The new status of the Qualification type - Active | Inactive

updateQualificationType_retryDelayInSeconds :: Lens' UpdateQualificationType (Maybe Integer) Source #

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.

updateQualificationType_test :: Lens' UpdateQualificationType (Maybe Text) Source #

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.

updateQualificationType_testDurationInSeconds :: Lens' UpdateQualificationType (Maybe Integer) Source #

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

updateQualificationType_qualificationTypeId :: Lens' UpdateQualificationType Text Source #

The ID of the Qualification type to update.

Destructuring the Response

data UpdateQualificationTypeResponse Source #

See: newUpdateQualificationTypeResponse smart constructor.

Constructors

UpdateQualificationTypeResponse'
Fields qualificationType :: Maybe QualificationType Contains a QualificationType data structure. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Associated Types type Rep UpdateQualificationTypeResponse :: Type -> Type # Methods from :: UpdateQualificationTypeResponse -> Rep UpdateQualificationTypeResponse x # to :: Rep UpdateQualificationTypeResponse x -> UpdateQualificationTypeResponse #
Read UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods readsPrec :: Int -> ReadS UpdateQualificationTypeResponse # readList :: ReadS [UpdateQualificationTypeResponse] # readPrec :: ReadPrec UpdateQualificationTypeResponse # readListPrec :: ReadPrec [UpdateQualificationTypeResponse] #
Show UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods showsPrec :: Int -> UpdateQualificationTypeResponse -> ShowS # show :: UpdateQualificationTypeResponse -> String # showList :: [UpdateQualificationTypeResponse] -> ShowS #
NFData UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods rnf :: UpdateQualificationTypeResponse -> () #
Eq UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType Methods (==) :: UpdateQualificationTypeResponse -> UpdateQualificationTypeResponse -> Bool # (/=) :: UpdateQualificationTypeResponse -> UpdateQualificationTypeResponse -> Bool #
type Rep UpdateQualificationTypeResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.UpdateQualificationType type Rep UpdateQualificationTypeResponse = D1 ('MetaData "UpdateQualificationTypeResponse" "Amazonka.MechanicalTurk.UpdateQualificationType" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "UpdateQualificationTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "qualificationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QualificationType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateQualificationTypeResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateQualificationTypeResponse'`
-> UpdateQualificationTypeResponse

Create a value of UpdateQualificationTypeResponse 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:qualificationType:UpdateQualificationTypeResponse', updateQualificationTypeResponse_qualificationType - Contains a QualificationType data structure.

$sel:httpStatus:UpdateQualificationTypeResponse', updateQualificationTypeResponse_httpStatus - The response's http status code.

Response Lenses

updateQualificationTypeResponse_qualificationType :: Lens' UpdateQualificationTypeResponse (Maybe QualificationType) Source #

Contains a QualificationType data structure.

updateQualificationTypeResponse_httpStatus :: Lens' UpdateQualificationTypeResponse Int Source #

The response's http status code.