Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
The CreateQualificationType
operation creates a new Qualification type, which is represented by a QualificationType
data structure.
Synopsis
- createQualificationType :: Text -> Text -> QualificationTypeStatus -> CreateQualificationType
- data CreateQualificationType
- cqtTestDurationInSeconds :: Lens' CreateQualificationType (Maybe Integer)
- cqtAnswerKey :: Lens' CreateQualificationType (Maybe Text)
- cqtTest :: Lens' CreateQualificationType (Maybe Text)
- cqtKeywords :: Lens' CreateQualificationType (Maybe Text)
- cqtAutoGranted :: Lens' CreateQualificationType (Maybe Bool)
- cqtAutoGrantedValue :: Lens' CreateQualificationType (Maybe Int)
- cqtRetryDelayInSeconds :: Lens' CreateQualificationType (Maybe Integer)
- cqtName :: Lens' CreateQualificationType Text
- cqtDescription :: Lens' CreateQualificationType Text
- cqtQualificationTypeStatus :: Lens' CreateQualificationType QualificationTypeStatus
- createQualificationTypeResponse :: Int -> CreateQualificationTypeResponse
- data CreateQualificationTypeResponse
- cqtrsQualificationType :: Lens' CreateQualificationTypeResponse (Maybe QualificationType)
- cqtrsResponseStatus :: Lens' CreateQualificationTypeResponse Int
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
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:
cqtrsQualificationType
- The created Qualification type, returned as a QualificationType data structure.cqtrsResponseStatus
- -- | The response status code.
data CreateQualificationTypeResponse Source #
See: createQualificationTypeResponse
smart constructor.
Instances
Response Lenses
cqtrsQualificationType :: Lens' CreateQualificationTypeResponse (Maybe QualificationType) Source #
The created Qualification type, returned as a QualificationType data structure.
cqtrsResponseStatus :: Lens' CreateQualificationTypeResponse Int Source #
- - | The response status code.