Struct aws_sdk_mturk::client::fluent_builders::CreateHITWithHITType

pub struct CreateHITWithHITType<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to CreateHITWithHITType.

The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.

CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.

Implementations

impl<C, M, R> CreateHITWithHITType<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreateHitWithHitTypeOutput, SdkError<CreateHITWithHITTypeError>> where
    R::Policy: SmithyRetryPolicy<CreateHitWithHitTypeInputOperationOutputAlias, CreateHitWithHitTypeOutput, CreateHITWithHITTypeError, CreateHitWithHitTypeInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn hit_type_id(self, input: impl Into<String>) -> Self

The HIT type ID you want to create this HIT with.

pub fn set_hit_type_id(self, input: Option<String>) -> Self

The HIT type ID you want to create this HIT with.

pub fn max_assignments(self, input: i32) -> Self

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

pub fn set_max_assignments(self, input: Option<i32>) -> Self

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

pub fn lifetime_in_seconds(self, input: i64) -> Self

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

pub fn set_lifetime_in_seconds(self, input: Option<i64>) -> Self

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

pub fn question(self, input: impl Into<String>) -> Self

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

pub fn set_question(self, input: Option<String>) -> Self

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

pub fn requester_annotation(self, input: impl Into<String>) -> Self

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

pub fn set_requester_annotation(self, input: Option<String>) -> Self

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

pub fn unique_request_token(self, input: impl Into<String>) -> Self

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

pub fn set_unique_request_token(self, input: Option<String>) -> Self

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

pub fn assignment_review_policy(self, input: ReviewPolicy) -> Self

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

pub fn set_assignment_review_policy(self, input: Option<ReviewPolicy>) -> Self

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

pub fn hit_review_policy(self, input: ReviewPolicy) -> Self

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

pub fn set_hit_review_policy(self, input: Option<ReviewPolicy>) -> Self

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

pub fn hit_layout_id(self, input: impl Into<String>) -> Self

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

pub fn set_hit_layout_id(self, input: Option<String>) -> Self

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

pub fn hit_layout_parameters(self, input: HitLayoutParameter) -> Self

Appends an item to HITLayoutParameters.

To override the contents of this collection use set_hit_layout_parameters.

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

pub fn set_hit_layout_parameters(
    self,
    input: Option<Vec<HitLayoutParameter>>
) -> Self

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreateHITWithHITType<C, M, R>

fn clone(&self) -> CreateHITWithHITType<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreateHITWithHITType<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.