AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CreateHITInput

import "github.com/aws/aws-sdk-go/service/mturk"

type CreateHITInput struct { AssignmentDurationInSeconds *int64 `type:"long" required:"true"` AssignmentReviewPolicy *ReviewPolicy `type:"structure"` AutoApprovalDelayInSeconds *int64 `type:"long"` Description *string `type:"string" required:"true"` HITLayoutId *string `min:"1" type:"string"` HITLayoutParameters []*HITLayoutParameter `type:"list"` HITReviewPolicy *ReviewPolicy `type:"structure"` Keywords *string `type:"string"` LifetimeInSeconds *int64 `type:"long" required:"true"` MaxAssignments *int64 `type:"integer"` QualificationRequirements []*QualificationRequirement `type:"list"` Question *string `type:"string"` RequesterAnnotation *string `type:"string"` Reward *string `type:"string" required:"true"` Title *string `type:"string" required:"true"` UniqueRequestToken *string `min:"1" type:"string"` }

AssignmentDurationInSeconds

Type: *int64

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.

AssignmentDurationInSeconds is a required field

AssignmentReviewPolicy

HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.

AutoApprovalDelayInSeconds

Type: *int64

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.

Description

Type: *string

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.

Description is a required field

HITLayoutId

Type: *string

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.

HITLayoutParameters

The HITLayoutParameter data structure defines parameter values used with a HITLayout. A HITLayout is a reusable Amazon Mechanical Turk project template used to provide Human Intelligence Task (HIT) question data for CreateHIT.

HITReviewPolicy

HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.

Keywords

Type: *string

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

LifetimeInSeconds

Type: *int64

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.

LifetimeInSeconds is a required field

MaxAssignments

Type: *int64

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

QualificationRequirements

The QualificationRequirement data structure describes a Qualification that a Worker must have before the Worker is allowed to accept a HIT. A requirement may optionally state that a Worker must have the Qualification in order to preview the HIT, or see the HIT in search results.

Question

Type: *string

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.

RequesterAnnotation

Type: *string

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.

Reward

Type: *string

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

Reward is a required field

Title

Type: *string

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.

Title is a required field

UniqueRequestToken

Type: *string

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.

Method

GoString

func (s CreateHITInput) GoString() string

GoString returns the string representation

SetAssignmentDurationInSeconds

func (s *CreateHITInput) SetAssignmentDurationInSeconds(v int64) *CreateHITInput

SetAssignmentDurationInSeconds sets the AssignmentDurationInSeconds field's value.

SetAssignmentReviewPolicy

func (s *CreateHITInput) SetAssignmentReviewPolicy(v *ReviewPolicy) *CreateHITInput

SetAssignmentReviewPolicy sets the AssignmentReviewPolicy field's value.

SetAutoApprovalDelayInSeconds

func (s *CreateHITInput) SetAutoApprovalDelayInSeconds(v int64) *CreateHITInput

SetAutoApprovalDelayInSeconds sets the AutoApprovalDelayInSeconds field's value.

SetDescription

func (s *CreateHITInput) SetDescription(v string) *CreateHITInput

SetDescription sets the Description field's value.

SetHITLayoutId

func (s *CreateHITInput) SetHITLayoutId(v string) *CreateHITInput

SetHITLayoutId sets the HITLayoutId field's value.

SetHITLayoutParameters

func (s *CreateHITInput) SetHITLayoutParameters(v []*HITLayoutParameter) *CreateHITInput

SetHITLayoutParameters sets the HITLayoutParameters field's value.

SetHITReviewPolicy

func (s *CreateHITInput) SetHITReviewPolicy(v *ReviewPolicy) *CreateHITInput

SetHITReviewPolicy sets the HITReviewPolicy field's value.

SetKeywords

func (s *CreateHITInput) SetKeywords(v string) *CreateHITInput

SetKeywords sets the Keywords field's value.

SetLifetimeInSeconds

func (s *CreateHITInput) SetLifetimeInSeconds(v int64) *CreateHITInput

SetLifetimeInSeconds sets the LifetimeInSeconds field's value.

SetMaxAssignments

func (s *CreateHITInput) SetMaxAssignments(v int64) *CreateHITInput

SetMaxAssignments sets the MaxAssignments field's value.

SetQualificationRequirements

func (s *CreateHITInput) SetQualificationRequirements(v []*QualificationRequirement) *CreateHITInput

SetQualificationRequirements sets the QualificationRequirements field's value.

SetQuestion

func (s *CreateHITInput) SetQuestion(v string) *CreateHITInput

SetQuestion sets the Question field's value.

SetRequesterAnnotation

func (s *CreateHITInput) SetRequesterAnnotation(v string) *CreateHITInput

SetRequesterAnnotation sets the RequesterAnnotation field's value.

SetReward

func (s *CreateHITInput) SetReward(v string) *CreateHITInput

SetReward sets the Reward field's value.

SetTitle

func (s *CreateHITInput) SetTitle(v string) *CreateHITInput

SetTitle sets the Title field's value.

SetUniqueRequestToken

func (s *CreateHITInput) SetUniqueRequestToken(v string) *CreateHITInput

SetUniqueRequestToken sets the UniqueRequestToken field's value.

String

func (s CreateHITInput) String() string

String returns the string representation

Validate

func (s *CreateHITInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: