amazonka-mechanicalturk-1.6.1: Amazon Mechanical Turk SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.MechanicalTurk.UpdateQualificationType

Contents

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

updateQualificationType Source #

Creates a value of UpdateQualificationType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • uqtTestDurationInSeconds - The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
  • uqtQualificationTypeStatus - The new status of the Qualification type - Active | Inactive
  • uqtAnswerKey - The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
  • uqtTest - 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.
  • uqtAutoGranted - 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.
  • uqtAutoGrantedValue - The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
  • uqtDescription - The new description of the Qualification type.
  • uqtRetryDelayInSeconds - 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.
  • uqtQualificationTypeId - The ID of the Qualification type to update.

data UpdateQualificationType Source #

See: updateQualificationType smart constructor.

Instances
Eq UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Data UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateQualificationType -> c UpdateQualificationType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateQualificationType #

toConstr :: UpdateQualificationType -> Constr #

dataTypeOf :: UpdateQualificationType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateQualificationType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateQualificationType) #

gmapT :: (forall b. Data b => b -> b) -> UpdateQualificationType -> UpdateQualificationType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateQualificationType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateQualificationType -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateQualificationType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateQualificationType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateQualificationType -> m UpdateQualificationType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateQualificationType -> m UpdateQualificationType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateQualificationType -> m UpdateQualificationType #

Read UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Show UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Generic UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Associated Types

type Rep UpdateQualificationType :: Type -> Type #

Hashable UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

ToJSON UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

AWSRequest UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Associated Types

type Rs UpdateQualificationType :: Type #

ToHeaders UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

ToPath UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

ToQuery UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

NFData UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Methods

rnf :: UpdateQualificationType -> () #

type Rep UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

type Rep UpdateQualificationType = D1 (MetaData "UpdateQualificationType" "Network.AWS.MechanicalTurk.UpdateQualificationType" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "UpdateQualificationType'" PrefixI True) (((S1 (MetaSel (Just "_uqtTestDurationInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_uqtQualificationTypeStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QualificationTypeStatus))) :*: (S1 (MetaSel (Just "_uqtAnswerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uqtTest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_uqtAutoGranted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_uqtAutoGrantedValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 (MetaSel (Just "_uqtDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_uqtRetryDelayInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 (MetaSel (Just "_uqtQualificationTypeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs UpdateQualificationType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Request Lenses

uqtTestDurationInSeconds :: 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.

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

The new status of the Qualification type - Active | Inactive

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

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

uqtTest :: 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.

uqtAutoGranted :: 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.

uqtAutoGrantedValue :: 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.

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

The new description of the Qualification type.

uqtRetryDelayInSeconds :: 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.

uqtQualificationTypeId :: Lens' UpdateQualificationType Text Source #

The ID of the Qualification type to update.

Destructuring the Response

updateQualificationTypeResponse Source #

Creates a value of UpdateQualificationTypeResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UpdateQualificationTypeResponse Source #

See: updateQualificationTypeResponse smart constructor.

Instances
Eq UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Data UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateQualificationTypeResponse -> c UpdateQualificationTypeResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateQualificationTypeResponse #

toConstr :: UpdateQualificationTypeResponse -> Constr #

dataTypeOf :: UpdateQualificationTypeResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateQualificationTypeResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateQualificationTypeResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateQualificationTypeResponse -> UpdateQualificationTypeResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateQualificationTypeResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateQualificationTypeResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateQualificationTypeResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateQualificationTypeResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateQualificationTypeResponse -> m UpdateQualificationTypeResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateQualificationTypeResponse -> m UpdateQualificationTypeResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateQualificationTypeResponse -> m UpdateQualificationTypeResponse #

Read UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Show UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Generic UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

Associated Types

type Rep UpdateQualificationTypeResponse :: Type -> Type #

NFData UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

type Rep UpdateQualificationTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.UpdateQualificationType

type Rep UpdateQualificationTypeResponse = D1 (MetaData "UpdateQualificationTypeResponse" "Network.AWS.MechanicalTurk.UpdateQualificationType" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "UpdateQualificationTypeResponse'" PrefixI True) (S1 (MetaSel (Just "_uqtrsQualificationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QualificationType)) :*: S1 (MetaSel (Just "_uqtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses