aws_sdk_mturk/client/
create_qualification_type.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateQualificationType`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_name):<br>required: **true**<br><p>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.</p><br>
7    ///   - [`keywords(impl Into<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::keywords) / [`set_keywords(Option<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_keywords):<br>required: **false**<br><p>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.</p><br>
8    ///   - [`description(impl Into<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_description):<br>required: **true**<br><p>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.</p><br>
9    ///   - [`qualification_type_status(QualificationTypeStatus)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::qualification_type_status) / [`set_qualification_type_status(Option<QualificationTypeStatus>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_qualification_type_status):<br>required: **true**<br><p>The initial status of the Qualification type.</p> <p>Constraints: Valid values are: Active | Inactive</p><br>
10    ///   - [`retry_delay_in_seconds(i64)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::retry_delay_in_seconds) / [`set_retry_delay_in_seconds(Option<i64>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_retry_delay_in_seconds):<br>required: **false**<br><p>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.</p> <p>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.</p><br>
11    ///   - [`test(impl Into<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::test) / [`set_test(Option<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_test):<br>required: **false**<br><p>The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, <code>TestDurationInSeconds</code> must also be specified.</p> <p>Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.</p> <p>Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.</p><br>
12    ///   - [`answer_key(impl Into<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::answer_key) / [`set_answer_key(Option<String>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_answer_key):<br>required: **false**<br><p>The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.</p> <p>Constraints: Must not be longer than 65535 bytes.</p> <p>Constraints: None. If not specified, you must process Qualification requests manually.</p><br>
13    ///   - [`test_duration_in_seconds(i64)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::test_duration_in_seconds) / [`set_test_duration_in_seconds(Option<i64>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_test_duration_in_seconds):<br>required: **false**<br><p>The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.</p><br>
14    ///   - [`auto_granted(bool)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::auto_granted) / [`set_auto_granted(Option<bool>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_auto_granted):<br>required: **false**<br><p>Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.</p> <p>Constraints: If the Test parameter is specified, this parameter cannot be true.</p><br>
15    ///   - [`auto_granted_value(i32)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::auto_granted_value) / [`set_auto_granted_value(Option<i32>)`](crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::set_auto_granted_value):<br>required: **false**<br><p>The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.</p><br>
16    /// - On success, responds with [`CreateQualificationTypeOutput`](crate::operation::create_qualification_type::CreateQualificationTypeOutput) with field(s):
17    ///   - [`qualification_type(Option<QualificationType>)`](crate::operation::create_qualification_type::CreateQualificationTypeOutput::qualification_type): <p>The created Qualification type, returned as a QualificationType data structure.</p>
18    /// - On failure, responds with [`SdkError<CreateQualificationTypeError>`](crate::operation::create_qualification_type::CreateQualificationTypeError)
19    pub fn create_qualification_type(&self) -> crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder {
20        crate::operation::create_qualification_type::builders::CreateQualificationTypeFluentBuilder::new(self.handle.clone())
21    }
22}