amazonka-mechanicalturk-1.6.0: 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.CreateQualificationType

Contents

Description

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

Synopsis

Creating a Request

createQualificationType Source #

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

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

  • cqtTestDurationInSeconds - The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
  • cqtAnswerKey - 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.
  • cqtTest - 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.
  • cqtKeywords - 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.
  • cqtAutoGranted - 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.
  • cqtAutoGrantedValue - The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
  • cqtRetryDelayInSeconds - 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.
  • cqtName - 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.
  • cqtDescription - 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.
  • cqtQualificationTypeStatus - The initial status of the Qualification type. Constraints: Valid values are: Active | Inactive

data CreateQualificationType Source #

See: createQualificationType smart constructor.

Instances

Eq CreateQualificationType Source # 
Data CreateQualificationType Source # 

Methods

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

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

toConstr :: CreateQualificationType -> Constr #

dataTypeOf :: CreateQualificationType -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateQualificationType Source # 
Show CreateQualificationType Source # 
Generic CreateQualificationType Source # 
Hashable CreateQualificationType Source # 
ToJSON CreateQualificationType Source # 
NFData CreateQualificationType Source # 

Methods

rnf :: CreateQualificationType -> () #

AWSRequest CreateQualificationType Source # 
ToHeaders CreateQualificationType Source # 
ToPath CreateQualificationType Source # 
ToQuery CreateQualificationType Source # 
type Rep CreateQualificationType Source # 
type Rep CreateQualificationType = D1 * (MetaData "CreateQualificationType" "Network.AWS.MechanicalTurk.CreateQualificationType" "amazonka-mechanicalturk-1.6.0-LJdO7bIweE9BcCI1YoYmug" False) (C1 * (MetaCons "CreateQualificationType'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtTestDurationInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer))) (S1 * (MetaSel (Just Symbol "_cqtAnswerKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtTest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtKeywords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cqtAutoGranted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtAutoGrantedValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_cqtRetryDelayInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Integer)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cqtQualificationTypeStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * QualificationTypeStatus)))))))
type Rs CreateQualificationType Source # 

Request Lenses

cqtTestDurationInSeconds :: Lens' CreateQualificationType (Maybe Integer) Source #

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

cqtAnswerKey :: Lens' CreateQualificationType (Maybe Text) Source #

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.

cqtTest :: Lens' CreateQualificationType (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.

cqtKeywords :: Lens' CreateQualificationType (Maybe Text) Source #

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.

cqtAutoGranted :: Lens' CreateQualificationType (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.

cqtAutoGrantedValue :: Lens' CreateQualificationType (Maybe Int) Source #

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

cqtRetryDelayInSeconds :: Lens' CreateQualificationType (Maybe Integer) Source #

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.

cqtName :: Lens' CreateQualificationType Text Source #

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.

cqtDescription :: Lens' CreateQualificationType Text Source #

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.

cqtQualificationTypeStatus :: Lens' CreateQualificationType QualificationTypeStatus Source #

The initial status of the Qualification type. Constraints: Valid values are: Active | Inactive

Destructuring the Response

createQualificationTypeResponse Source #

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

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

data CreateQualificationTypeResponse Source #

See: createQualificationTypeResponse smart constructor.

Instances

Eq CreateQualificationTypeResponse Source # 
Data CreateQualificationTypeResponse Source # 

Methods

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

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

toConstr :: CreateQualificationTypeResponse -> Constr #

dataTypeOf :: CreateQualificationTypeResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateQualificationTypeResponse Source # 
Show CreateQualificationTypeResponse Source # 
Generic CreateQualificationTypeResponse Source # 
NFData CreateQualificationTypeResponse Source # 
type Rep CreateQualificationTypeResponse Source # 
type Rep CreateQualificationTypeResponse = D1 * (MetaData "CreateQualificationTypeResponse" "Network.AWS.MechanicalTurk.CreateQualificationType" "amazonka-mechanicalturk-1.6.0-LJdO7bIweE9BcCI1YoYmug" False) (C1 * (MetaCons "CreateQualificationTypeResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cqtrsQualificationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe QualificationType))) (S1 * (MetaSel (Just Symbol "_cqtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cqtrsQualificationType :: Lens' CreateQualificationTypeResponse (Maybe QualificationType) Source #

The created Qualification type, returned as a QualificationType data structure.