Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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
- data CreateHITType = CreateHITType' {}
- newCreateHITType :: Integer -> Text -> Text -> Text -> CreateHITType
- createHITType_autoApprovalDelayInSeconds :: Lens' CreateHITType (Maybe Integer)
- createHITType_keywords :: Lens' CreateHITType (Maybe Text)
- createHITType_qualificationRequirements :: Lens' CreateHITType (Maybe [QualificationRequirement])
- createHITType_assignmentDurationInSeconds :: Lens' CreateHITType Integer
- createHITType_reward :: Lens' CreateHITType Text
- createHITType_title :: Lens' CreateHITType Text
- createHITType_description :: Lens' CreateHITType Text
- data CreateHITTypeResponse = CreateHITTypeResponse' {
- hITTypeId :: Maybe Text
- httpStatus :: Int
- newCreateHITTypeResponse :: Int -> CreateHITTypeResponse
- createHITTypeResponse_hITTypeId :: Lens' CreateHITTypeResponse (Maybe Text)
- createHITTypeResponse_httpStatus :: Lens' CreateHITTypeResponse Int
Creating a Request
data CreateHITType Source #
See: newCreateHITType
smart constructor.
CreateHITType' | |
|
Instances
:: Integer | |
-> Text | |
-> Text | |
-> Text | |
-> CreateHITType |
Create a value of CreateHITType
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:autoApprovalDelayInSeconds:CreateHITType'
, createHITType_autoApprovalDelayInSeconds
- 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.
$sel:keywords:CreateHITType'
, createHITType_keywords
- One or more words or phrases that describe the HIT, separated by commas.
These words are used in searches to find HITs.
$sel:qualificationRequirements:CreateHITType'
, createHITType_qualificationRequirements
- 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.
$sel:assignmentDurationInSeconds:CreateHITType'
, createHITType_assignmentDurationInSeconds
- 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.
$sel:reward:CreateHITType'
, createHITType_reward
- The amount of money the Requester will pay a Worker for successfully
completing the HIT.
$sel:title:CreateHITType'
, createHITType_title
- 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.
$sel:description:CreateHITType'
, createHITType_description
- 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.
Request Lenses
createHITType_autoApprovalDelayInSeconds :: 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.
createHITType_keywords :: 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.
createHITType_qualificationRequirements :: Lens' CreateHITType (Maybe [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.
createHITType_assignmentDurationInSeconds :: 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.
createHITType_reward :: Lens' CreateHITType Text Source #
The amount of money the Requester will pay a Worker for successfully completing the HIT.
createHITType_title :: 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.
createHITType_description :: 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
data CreateHITTypeResponse Source #
See: newCreateHITTypeResponse
smart constructor.
CreateHITTypeResponse' | |
|
Instances
newCreateHITTypeResponse Source #
Create a value of CreateHITTypeResponse
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:hITTypeId:CreateHITTypeResponse'
, createHITTypeResponse_hITTypeId
- The ID of the newly registered HIT type.
$sel:httpStatus:CreateHITTypeResponse'
, createHITTypeResponse_httpStatus
- The response's http status code.
Response Lenses
createHITTypeResponse_hITTypeId :: Lens' CreateHITTypeResponse (Maybe Text) Source #
The ID of the newly registered HIT type.
createHITTypeResponse_httpStatus :: Lens' CreateHITTypeResponse Int Source #
The response's http status code.