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.CreateHITType

Contents

Description

The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.

Synopsis

Creating a Request

createHITType Source #

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

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

  • chittAutoApprovalDelayInSeconds - The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.
  • chittKeywords - One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
  • chittQualificationRequirements - Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.
  • chittAssignmentDurationInSeconds - The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.
  • chittReward - The amount of money the Requester will pay a Worker for successfully completing the HIT.
  • chittTitle - The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.
  • chittDescription - A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

data CreateHITType Source #

See: createHITType smart constructor.

Instances
Eq CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Data CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Methods

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

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

toConstr :: CreateHITType -> Constr #

dataTypeOf :: CreateHITType -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Show CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Generic CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Associated Types

type Rep CreateHITType :: Type -> Type #

Hashable CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

ToJSON CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

AWSRequest CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Associated Types

type Rs CreateHITType :: Type #

ToHeaders CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

ToPath CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

ToQuery CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

NFData CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Methods

rnf :: CreateHITType -> () #

type Rep CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

type Rep CreateHITType = D1 (MetaData "CreateHITType" "Network.AWS.MechanicalTurk.CreateHITType" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "CreateHITType'" PrefixI True) ((S1 (MetaSel (Just "_chittAutoApprovalDelayInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 (MetaSel (Just "_chittKeywords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_chittQualificationRequirements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [QualificationRequirement])))) :*: ((S1 (MetaSel (Just "_chittAssignmentDurationInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Integer) :*: S1 (MetaSel (Just "_chittReward") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_chittTitle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_chittDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs CreateHITType Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Request Lenses

chittAutoApprovalDelayInSeconds :: Lens' CreateHITType (Maybe Integer) Source #

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

chittKeywords :: Lens' CreateHITType (Maybe Text) Source #

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

chittQualificationRequirements :: Lens' CreateHITType [QualificationRequirement] Source #

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

chittAssignmentDurationInSeconds :: Lens' CreateHITType Integer Source #

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

chittReward :: Lens' CreateHITType Text Source #

The amount of money the Requester will pay a Worker for successfully completing the HIT.

chittTitle :: Lens' CreateHITType Text Source #

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

chittDescription :: Lens' CreateHITType Text Source #

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

Destructuring the Response

createHITTypeResponse Source #

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

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

data CreateHITTypeResponse Source #

See: createHITTypeResponse smart constructor.

Instances
Eq CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Data CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Methods

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

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

toConstr :: CreateHITTypeResponse -> Constr #

dataTypeOf :: CreateHITTypeResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Show CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Generic CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Associated Types

type Rep CreateHITTypeResponse :: Type -> Type #

NFData CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

Methods

rnf :: CreateHITTypeResponse -> () #

type Rep CreateHITTypeResponse Source # 
Instance details

Defined in Network.AWS.MechanicalTurk.CreateHITType

type Rep CreateHITTypeResponse = D1 (MetaData "CreateHITTypeResponse" "Network.AWS.MechanicalTurk.CreateHITType" "amazonka-mechanicalturk-1.6.1-GV5ehA4FkQY3BZvWX2sEC2" False) (C1 (MetaCons "CreateHITTypeResponse'" PrefixI True) (S1 (MetaSel (Just "_chittrsHITTypeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_chittrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

chittrsHITTypeId :: Lens' CreateHITTypeResponse (Maybe Text) Source #

The ID of the newly registered HIT type.