AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::MTurk::Model::CreateHITRequest Class Reference

#include <CreateHITRequest.h>

+ Inheritance diagram for Aws::MTurk::Model::CreateHITRequest:

Public Member Functions

 CreateHITRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetMaxAssignments () const
 
bool MaxAssignmentsHasBeenSet () const
 
void SetMaxAssignments (int value)
 
CreateHITRequestWithMaxAssignments (int value)
 
long long GetAutoApprovalDelayInSeconds () const
 
bool AutoApprovalDelayInSecondsHasBeenSet () const
 
void SetAutoApprovalDelayInSeconds (long long value)
 
CreateHITRequestWithAutoApprovalDelayInSeconds (long long value)
 
long long GetLifetimeInSeconds () const
 
bool LifetimeInSecondsHasBeenSet () const
 
void SetLifetimeInSeconds (long long value)
 
CreateHITRequestWithLifetimeInSeconds (long long value)
 
long long GetAssignmentDurationInSeconds () const
 
bool AssignmentDurationInSecondsHasBeenSet () const
 
void SetAssignmentDurationInSeconds (long long value)
 
CreateHITRequestWithAssignmentDurationInSeconds (long long value)
 
const Aws::StringGetReward () const
 
bool RewardHasBeenSet () const
 
void SetReward (const Aws::String &value)
 
void SetReward (Aws::String &&value)
 
void SetReward (const char *value)
 
CreateHITRequestWithReward (const Aws::String &value)
 
CreateHITRequestWithReward (Aws::String &&value)
 
CreateHITRequestWithReward (const char *value)
 
const Aws::StringGetTitle () const
 
bool TitleHasBeenSet () const
 
void SetTitle (const Aws::String &value)
 
void SetTitle (Aws::String &&value)
 
void SetTitle (const char *value)
 
CreateHITRequestWithTitle (const Aws::String &value)
 
CreateHITRequestWithTitle (Aws::String &&value)
 
CreateHITRequestWithTitle (const char *value)
 
const Aws::StringGetKeywords () const
 
bool KeywordsHasBeenSet () const
 
void SetKeywords (const Aws::String &value)
 
void SetKeywords (Aws::String &&value)
 
void SetKeywords (const char *value)
 
CreateHITRequestWithKeywords (const Aws::String &value)
 
CreateHITRequestWithKeywords (Aws::String &&value)
 
CreateHITRequestWithKeywords (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateHITRequestWithDescription (const Aws::String &value)
 
CreateHITRequestWithDescription (Aws::String &&value)
 
CreateHITRequestWithDescription (const char *value)
 
const Aws::StringGetQuestion () const
 
bool QuestionHasBeenSet () const
 
void SetQuestion (const Aws::String &value)
 
void SetQuestion (Aws::String &&value)
 
void SetQuestion (const char *value)
 
CreateHITRequestWithQuestion (const Aws::String &value)
 
CreateHITRequestWithQuestion (Aws::String &&value)
 
CreateHITRequestWithQuestion (const char *value)
 
const Aws::StringGetRequesterAnnotation () const
 
bool RequesterAnnotationHasBeenSet () const
 
void SetRequesterAnnotation (const Aws::String &value)
 
void SetRequesterAnnotation (Aws::String &&value)
 
void SetRequesterAnnotation (const char *value)
 
CreateHITRequestWithRequesterAnnotation (const Aws::String &value)
 
CreateHITRequestWithRequesterAnnotation (Aws::String &&value)
 
CreateHITRequestWithRequesterAnnotation (const char *value)
 
const Aws::Vector< QualificationRequirement > & GetQualificationRequirements () const
 
bool QualificationRequirementsHasBeenSet () const
 
void SetQualificationRequirements (const Aws::Vector< QualificationRequirement > &value)
 
void SetQualificationRequirements (Aws::Vector< QualificationRequirement > &&value)
 
CreateHITRequestWithQualificationRequirements (const Aws::Vector< QualificationRequirement > &value)
 
CreateHITRequestWithQualificationRequirements (Aws::Vector< QualificationRequirement > &&value)
 
CreateHITRequestAddQualificationRequirements (const QualificationRequirement &value)
 
CreateHITRequestAddQualificationRequirements (QualificationRequirement &&value)
 
const Aws::StringGetUniqueRequestToken () const
 
bool UniqueRequestTokenHasBeenSet () const
 
void SetUniqueRequestToken (const Aws::String &value)
 
void SetUniqueRequestToken (Aws::String &&value)
 
void SetUniqueRequestToken (const char *value)
 
CreateHITRequestWithUniqueRequestToken (const Aws::String &value)
 
CreateHITRequestWithUniqueRequestToken (Aws::String &&value)
 
CreateHITRequestWithUniqueRequestToken (const char *value)
 
const ReviewPolicyGetAssignmentReviewPolicy () const
 
bool AssignmentReviewPolicyHasBeenSet () const
 
void SetAssignmentReviewPolicy (const ReviewPolicy &value)
 
void SetAssignmentReviewPolicy (ReviewPolicy &&value)
 
CreateHITRequestWithAssignmentReviewPolicy (const ReviewPolicy &value)
 
CreateHITRequestWithAssignmentReviewPolicy (ReviewPolicy &&value)
 
const ReviewPolicyGetHITReviewPolicy () const
 
bool HITReviewPolicyHasBeenSet () const
 
void SetHITReviewPolicy (const ReviewPolicy &value)
 
void SetHITReviewPolicy (ReviewPolicy &&value)
 
CreateHITRequestWithHITReviewPolicy (const ReviewPolicy &value)
 
CreateHITRequestWithHITReviewPolicy (ReviewPolicy &&value)
 
const Aws::StringGetHITLayoutId () const
 
bool HITLayoutIdHasBeenSet () const
 
void SetHITLayoutId (const Aws::String &value)
 
void SetHITLayoutId (Aws::String &&value)
 
void SetHITLayoutId (const char *value)
 
CreateHITRequestWithHITLayoutId (const Aws::String &value)
 
CreateHITRequestWithHITLayoutId (Aws::String &&value)
 
CreateHITRequestWithHITLayoutId (const char *value)
 
const Aws::Vector< HITLayoutParameter > & GetHITLayoutParameters () const
 
bool HITLayoutParametersHasBeenSet () const
 
void SetHITLayoutParameters (const Aws::Vector< HITLayoutParameter > &value)
 
void SetHITLayoutParameters (Aws::Vector< HITLayoutParameter > &&value)
 
CreateHITRequestWithHITLayoutParameters (const Aws::Vector< HITLayoutParameter > &value)
 
CreateHITRequestWithHITLayoutParameters (Aws::Vector< HITLayoutParameter > &&value)
 
CreateHITRequestAddHITLayoutParameters (const HITLayoutParameter &value)
 
CreateHITRequestAddHITLayoutParameters (HITLayoutParameter &&value)
 
- Public Member Functions inherited from Aws::MTurk::MTurkRequest
virtual ~MTurkRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file CreateHITRequest.h.

Constructor & Destructor Documentation

◆ CreateHITRequest()

Aws::MTurk::Model::CreateHITRequest::CreateHITRequest ( )

Member Function Documentation

◆ AddHITLayoutParameters() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::AddHITLayoutParameters ( const HITLayoutParameter value)
inline

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

Definition at line 941 of file CreateHITRequest.h.

◆ AddHITLayoutParameters() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::AddHITLayoutParameters ( HITLayoutParameter &&  value)
inline

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

Definition at line 948 of file CreateHITRequest.h.

◆ AddQualificationRequirements() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::AddQualificationRequirements ( const QualificationRequirement value)
inline

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.

Definition at line 624 of file CreateHITRequest.h.

◆ AddQualificationRequirements() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::AddQualificationRequirements ( QualificationRequirement &&  value)
inline

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.

Definition at line 633 of file CreateHITRequest.h.

◆ AssignmentDurationInSecondsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::AssignmentDurationInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 144 of file CreateHITRequest.h.

◆ AssignmentReviewPolicyHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::AssignmentReviewPolicyHasBeenSet ( ) const
inline

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.

Definition at line 761 of file CreateHITRequest.h.

◆ AutoApprovalDelayInSecondsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::AutoApprovalDelayInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 78 of file CreateHITRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::DescriptionHasBeenSet ( ) const
inline

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.

Definition at line 336 of file CreateHITRequest.h.

◆ GetAssignmentDurationInSeconds()

long long Aws::MTurk::Model::CreateHITRequest::GetAssignmentDurationInSeconds ( ) const
inline

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.

Definition at line 135 of file CreateHITRequest.h.

◆ GetAssignmentReviewPolicy()

const ReviewPolicy& Aws::MTurk::Model::CreateHITRequest::GetAssignmentReviewPolicy ( ) const
inline

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.

Definition at line 754 of file CreateHITRequest.h.

◆ GetAutoApprovalDelayInSeconds()

long long Aws::MTurk::Model::CreateHITRequest::GetAutoApprovalDelayInSeconds ( ) const
inline

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.

Definition at line 71 of file CreateHITRequest.h.

◆ GetDescription()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetDescription ( ) const
inline

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.

Definition at line 327 of file CreateHITRequest.h.

◆ GetHITLayoutId()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetHITLayoutId ( ) const
inline

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.

Definition at line 835 of file CreateHITRequest.h.

◆ GetHITLayoutParameters()

const Aws::Vector<HITLayoutParameter>& Aws::MTurk::Model::CreateHITRequest::GetHITLayoutParameters ( ) const
inline

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

Definition at line 899 of file CreateHITRequest.h.

◆ GetHITReviewPolicy()

const ReviewPolicy& Aws::MTurk::Model::CreateHITRequest::GetHITReviewPolicy ( ) const
inline

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

Definition at line 796 of file CreateHITRequest.h.

◆ GetKeywords()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetKeywords ( ) const
inline

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

Definition at line 275 of file CreateHITRequest.h.

◆ GetLifetimeInSeconds()

long long Aws::MTurk::Model::CreateHITRequest::GetLifetimeInSeconds ( ) const
inline

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.

Definition at line 101 of file CreateHITRequest.h.

◆ GetMaxAssignments()

int Aws::MTurk::Model::CreateHITRequest::GetMaxAssignments ( ) const
inline

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

Definition at line 45 of file CreateHITRequest.h.

◆ GetQualificationRequirements()

const Aws::Vector<QualificationRequirement>& Aws::MTurk::Model::CreateHITRequest::GetQualificationRequirements ( ) const
inline

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.

Definition at line 570 of file CreateHITRequest.h.

◆ GetQuestion()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetQuestion ( ) const
inline

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.

Definition at line 400 of file CreateHITRequest.h.

◆ GetRequesterAnnotation()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetRequesterAnnotation ( ) const
inline

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.

Definition at line 476 of file CreateHITRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::MTurk::Model::CreateHITRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::MTurk::MTurkRequest.

◆ GetReward()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetReward ( ) const
inline

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

Definition at line 169 of file CreateHITRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::MTurk::Model::CreateHITRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateHITRequest.h.

◆ GetTitle()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetTitle ( ) const
inline

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.

Definition at line 219 of file CreateHITRequest.h.

◆ GetUniqueRequestToken()

const Aws::String& Aws::MTurk::Model::CreateHITRequest::GetUniqueRequestToken ( ) const
inline

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.

Definition at line 648 of file CreateHITRequest.h.

◆ HITLayoutIdHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::HITLayoutIdHasBeenSet ( ) const
inline

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.

Definition at line 843 of file CreateHITRequest.h.

◆ HITLayoutParametersHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::HITLayoutParametersHasBeenSet ( ) const
inline

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

Definition at line 906 of file CreateHITRequest.h.

◆ HITReviewPolicyHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::HITReviewPolicyHasBeenSet ( ) const
inline

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

Definition at line 802 of file CreateHITRequest.h.

◆ KeywordsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::KeywordsHasBeenSet ( ) const
inline

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

Definition at line 281 of file CreateHITRequest.h.

◆ LifetimeInSecondsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::LifetimeInSecondsHasBeenSet ( ) const
inline

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.

Definition at line 109 of file CreateHITRequest.h.

◆ MaxAssignmentsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::MaxAssignmentsHasBeenSet ( ) const
inline

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

Definition at line 51 of file CreateHITRequest.h.

◆ QualificationRequirementsHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::QualificationRequirementsHasBeenSet ( ) const
inline

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.

Definition at line 579 of file CreateHITRequest.h.

◆ QuestionHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::QuestionHasBeenSet ( ) const
inline

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.

Definition at line 409 of file CreateHITRequest.h.

◆ RequesterAnnotationHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::RequesterAnnotationHasBeenSet ( ) const
inline

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.

Definition at line 488 of file CreateHITRequest.h.

◆ RewardHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::RewardHasBeenSet ( ) const
inline

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

Definition at line 175 of file CreateHITRequest.h.

◆ SerializePayload()

Aws::String Aws::MTurk::Model::CreateHITRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssignmentDurationInSeconds()

void Aws::MTurk::Model::CreateHITRequest::SetAssignmentDurationInSeconds ( long long  value)
inline

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.

Definition at line 153 of file CreateHITRequest.h.

◆ SetAssignmentReviewPolicy() [1/2]

void Aws::MTurk::Model::CreateHITRequest::SetAssignmentReviewPolicy ( const ReviewPolicy value)
inline

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.

Definition at line 768 of file CreateHITRequest.h.

◆ SetAssignmentReviewPolicy() [2/2]

void Aws::MTurk::Model::CreateHITRequest::SetAssignmentReviewPolicy ( ReviewPolicy &&  value)
inline

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.

Definition at line 775 of file CreateHITRequest.h.

◆ SetAutoApprovalDelayInSeconds()

void Aws::MTurk::Model::CreateHITRequest::SetAutoApprovalDelayInSeconds ( long long  value)
inline

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.

Definition at line 85 of file CreateHITRequest.h.

◆ SetDescription() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetDescription ( Aws::String &&  value)
inline

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.

Definition at line 354 of file CreateHITRequest.h.

◆ SetDescription() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetDescription ( const Aws::String value)
inline

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.

Definition at line 345 of file CreateHITRequest.h.

◆ SetDescription() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetDescription ( const char *  value)
inline

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.

Definition at line 363 of file CreateHITRequest.h.

◆ SetHITLayoutId() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetHITLayoutId ( Aws::String &&  value)
inline

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.

Definition at line 859 of file CreateHITRequest.h.

◆ SetHITLayoutId() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetHITLayoutId ( const Aws::String value)
inline

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.

Definition at line 851 of file CreateHITRequest.h.

◆ SetHITLayoutId() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetHITLayoutId ( const char *  value)
inline

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.

Definition at line 867 of file CreateHITRequest.h.

◆ SetHITLayoutParameters() [1/2]

void Aws::MTurk::Model::CreateHITRequest::SetHITLayoutParameters ( Aws::Vector< HITLayoutParameter > &&  value)
inline

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

Definition at line 920 of file CreateHITRequest.h.

◆ SetHITLayoutParameters() [2/2]

void Aws::MTurk::Model::CreateHITRequest::SetHITLayoutParameters ( const Aws::Vector< HITLayoutParameter > &  value)
inline

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

Definition at line 913 of file CreateHITRequest.h.

◆ SetHITReviewPolicy() [1/2]

void Aws::MTurk::Model::CreateHITRequest::SetHITReviewPolicy ( const ReviewPolicy value)
inline

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

Definition at line 808 of file CreateHITRequest.h.

◆ SetHITReviewPolicy() [2/2]

void Aws::MTurk::Model::CreateHITRequest::SetHITReviewPolicy ( ReviewPolicy &&  value)
inline

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

Definition at line 814 of file CreateHITRequest.h.

◆ SetKeywords() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetKeywords ( Aws::String &&  value)
inline

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

Definition at line 293 of file CreateHITRequest.h.

◆ SetKeywords() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetKeywords ( const Aws::String value)
inline

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

Definition at line 287 of file CreateHITRequest.h.

◆ SetKeywords() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetKeywords ( const char *  value)
inline

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

Definition at line 299 of file CreateHITRequest.h.

◆ SetLifetimeInSeconds()

void Aws::MTurk::Model::CreateHITRequest::SetLifetimeInSeconds ( long long  value)
inline

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.

Definition at line 117 of file CreateHITRequest.h.

◆ SetMaxAssignments()

void Aws::MTurk::Model::CreateHITRequest::SetMaxAssignments ( int  value)
inline

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

Definition at line 57 of file CreateHITRequest.h.

◆ SetQualificationRequirements() [1/2]

void Aws::MTurk::Model::CreateHITRequest::SetQualificationRequirements ( Aws::Vector< QualificationRequirement > &&  value)
inline

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.

Definition at line 597 of file CreateHITRequest.h.

◆ SetQualificationRequirements() [2/2]

void Aws::MTurk::Model::CreateHITRequest::SetQualificationRequirements ( const Aws::Vector< QualificationRequirement > &  value)
inline

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.

Definition at line 588 of file CreateHITRequest.h.

◆ SetQuestion() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetQuestion ( Aws::String &&  value)
inline

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.

Definition at line 427 of file CreateHITRequest.h.

◆ SetQuestion() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetQuestion ( const Aws::String value)
inline

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.

Definition at line 418 of file CreateHITRequest.h.

◆ SetQuestion() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetQuestion ( const char *  value)
inline

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.

Definition at line 436 of file CreateHITRequest.h.

◆ SetRequesterAnnotation() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetRequesterAnnotation ( Aws::String &&  value)
inline

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.

Definition at line 512 of file CreateHITRequest.h.

◆ SetRequesterAnnotation() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetRequesterAnnotation ( const Aws::String value)
inline

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.

Definition at line 500 of file CreateHITRequest.h.

◆ SetRequesterAnnotation() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetRequesterAnnotation ( const char *  value)
inline

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.

Definition at line 524 of file CreateHITRequest.h.

◆ SetReward() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetReward ( Aws::String &&  value)
inline

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

Definition at line 187 of file CreateHITRequest.h.

◆ SetReward() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetReward ( const Aws::String value)
inline

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

Definition at line 181 of file CreateHITRequest.h.

◆ SetReward() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetReward ( const char *  value)
inline

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

Definition at line 193 of file CreateHITRequest.h.

◆ SetTitle() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetTitle ( Aws::String &&  value)
inline

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.

Definition at line 240 of file CreateHITRequest.h.

◆ SetTitle() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetTitle ( const Aws::String value)
inline

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.

Definition at line 233 of file CreateHITRequest.h.

◆ SetTitle() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetTitle ( const char *  value)
inline

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.

Definition at line 247 of file CreateHITRequest.h.

◆ SetUniqueRequestToken() [1/3]

void Aws::MTurk::Model::CreateHITRequest::SetUniqueRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 690 of file CreateHITRequest.h.

◆ SetUniqueRequestToken() [2/3]

void Aws::MTurk::Model::CreateHITRequest::SetUniqueRequestToken ( const Aws::String value)
inline

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.

Definition at line 676 of file CreateHITRequest.h.

◆ SetUniqueRequestToken() [3/3]

void Aws::MTurk::Model::CreateHITRequest::SetUniqueRequestToken ( const char *  value)
inline

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.

Definition at line 704 of file CreateHITRequest.h.

◆ TitleHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::TitleHasBeenSet ( ) const
inline

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.

Definition at line 226 of file CreateHITRequest.h.

◆ UniqueRequestTokenHasBeenSet()

bool Aws::MTurk::Model::CreateHITRequest::UniqueRequestTokenHasBeenSet ( ) const
inline

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.

Definition at line 662 of file CreateHITRequest.h.

◆ WithAssignmentDurationInSeconds()

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithAssignmentDurationInSeconds ( long long  value)
inline

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.

Definition at line 162 of file CreateHITRequest.h.

◆ WithAssignmentReviewPolicy() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithAssignmentReviewPolicy ( const ReviewPolicy value)
inline

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.

Definition at line 782 of file CreateHITRequest.h.

◆ WithAssignmentReviewPolicy() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithAssignmentReviewPolicy ( ReviewPolicy &&  value)
inline

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.

Definition at line 789 of file CreateHITRequest.h.

◆ WithAutoApprovalDelayInSeconds()

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithAutoApprovalDelayInSeconds ( long long  value)
inline

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.

Definition at line 92 of file CreateHITRequest.h.

◆ WithDescription() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithDescription ( Aws::String &&  value)
inline

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.

Definition at line 381 of file CreateHITRequest.h.

◆ WithDescription() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithDescription ( const Aws::String value)
inline

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.

Definition at line 372 of file CreateHITRequest.h.

◆ WithDescription() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithDescription ( const char *  value)
inline

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.

Definition at line 390 of file CreateHITRequest.h.

◆ WithHITLayoutId() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITLayoutId ( Aws::String &&  value)
inline

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.

Definition at line 883 of file CreateHITRequest.h.

◆ WithHITLayoutId() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITLayoutId ( const Aws::String value)
inline

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.

Definition at line 875 of file CreateHITRequest.h.

◆ WithHITLayoutId() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITLayoutId ( const char *  value)
inline

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.

Definition at line 891 of file CreateHITRequest.h.

◆ WithHITLayoutParameters() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITLayoutParameters ( Aws::Vector< HITLayoutParameter > &&  value)
inline

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

Definition at line 934 of file CreateHITRequest.h.

◆ WithHITLayoutParameters() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITLayoutParameters ( const Aws::Vector< HITLayoutParameter > &  value)
inline

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

Definition at line 927 of file CreateHITRequest.h.

◆ WithHITReviewPolicy() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITReviewPolicy ( const ReviewPolicy value)
inline

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

Definition at line 820 of file CreateHITRequest.h.

◆ WithHITReviewPolicy() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithHITReviewPolicy ( ReviewPolicy &&  value)
inline

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

Definition at line 826 of file CreateHITRequest.h.

◆ WithKeywords() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithKeywords ( Aws::String &&  value)
inline

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

Definition at line 311 of file CreateHITRequest.h.

◆ WithKeywords() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithKeywords ( const Aws::String value)
inline

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

Definition at line 305 of file CreateHITRequest.h.

◆ WithKeywords() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithKeywords ( const char *  value)
inline

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

Definition at line 317 of file CreateHITRequest.h.

◆ WithLifetimeInSeconds()

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithLifetimeInSeconds ( long long  value)
inline

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.

Definition at line 125 of file CreateHITRequest.h.

◆ WithMaxAssignments()

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithMaxAssignments ( int  value)
inline

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

Definition at line 63 of file CreateHITRequest.h.

◆ WithQualificationRequirements() [1/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithQualificationRequirements ( Aws::Vector< QualificationRequirement > &&  value)
inline

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.

Definition at line 615 of file CreateHITRequest.h.

◆ WithQualificationRequirements() [2/2]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithQualificationRequirements ( const Aws::Vector< QualificationRequirement > &  value)
inline

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.

Definition at line 606 of file CreateHITRequest.h.

◆ WithQuestion() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithQuestion ( Aws::String &&  value)
inline

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.

Definition at line 454 of file CreateHITRequest.h.

◆ WithQuestion() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithQuestion ( const Aws::String value)
inline

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.

Definition at line 445 of file CreateHITRequest.h.

◆ WithQuestion() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithQuestion ( const char *  value)
inline

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.

Definition at line 463 of file CreateHITRequest.h.

◆ WithRequesterAnnotation() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithRequesterAnnotation ( Aws::String &&  value)
inline

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.

Definition at line 548 of file CreateHITRequest.h.

◆ WithRequesterAnnotation() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithRequesterAnnotation ( const Aws::String value)
inline

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.

Definition at line 536 of file CreateHITRequest.h.

◆ WithRequesterAnnotation() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithRequesterAnnotation ( const char *  value)
inline

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.

Definition at line 560 of file CreateHITRequest.h.

◆ WithReward() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithReward ( Aws::String &&  value)
inline

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

Definition at line 205 of file CreateHITRequest.h.

◆ WithReward() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithReward ( const Aws::String value)
inline

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

Definition at line 199 of file CreateHITRequest.h.

◆ WithReward() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithReward ( const char *  value)
inline

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

Definition at line 211 of file CreateHITRequest.h.

◆ WithTitle() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithTitle ( Aws::String &&  value)
inline

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.

Definition at line 261 of file CreateHITRequest.h.

◆ WithTitle() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithTitle ( const Aws::String value)
inline

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.

Definition at line 254 of file CreateHITRequest.h.

◆ WithTitle() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithTitle ( const char *  value)
inline

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.

Definition at line 268 of file CreateHITRequest.h.

◆ WithUniqueRequestToken() [1/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithUniqueRequestToken ( Aws::String &&  value)
inline

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.

Definition at line 732 of file CreateHITRequest.h.

◆ WithUniqueRequestToken() [2/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithUniqueRequestToken ( const Aws::String value)
inline

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.

Definition at line 718 of file CreateHITRequest.h.

◆ WithUniqueRequestToken() [3/3]

CreateHITRequest& Aws::MTurk::Model::CreateHITRequest::WithUniqueRequestToken ( const char *  value)
inline

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.

Definition at line 746 of file CreateHITRequest.h.


The documentation for this class was generated from the following file: