String qualificationRequestId
The ID of the Qualification request, as returned by the GetQualificationRequests operation.
Integer integerValue
The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement.
String assignmentId
The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
String requesterFeedback
A message for the Worker, which the Worker can see in the Status section of the web site.
Boolean overrideRejection
A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to
False.
String assignmentId
A unique identifier for the assignment.
String workerId
The ID of the Worker who accepted the HIT.
String hITId
The ID of the HIT.
String assignmentStatus
The status of the assignment.
Date autoApprovalTime
If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.
Date acceptTime
The date and time the Worker accepted the assignment.
Date submitTime
If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.
Date approvalTime
If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.
Date rejectionTime
If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.
Date deadline
The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.
String answer
The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.
String requesterFeedback
The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.
String qualificationTypeId
The ID of the Qualification type to use for the assigned Qualification.
String workerId
The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.
Integer integerValue
The value of the Qualification to assign.
Boolean sendNotification
Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default.
String workerId
The ID of the Worker to whom the bonus was paid.
String bonusAmount
String assignmentId
The ID of the assignment associated with this bonus payment.
String reason
The Reason text given when the bonus was granted, if any.
Date grantTime
The date and time of when the bonus was granted.
String hITId
The ID of the HIT to extend.
Integer numberOfAdditionalAssignments
The number of additional assignments to request for this HIT.
String uniqueRequestToken
A unique identifier for this request, which allows you to retry the call on error without extending the HIT
multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call
succeeded on the server. If the extend HIT already exists in the system from a previous call using the same
UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
Integer maxAssignments
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
Long autoApprovalDelayInSeconds
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.
Long lifetimeInSeconds
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.
Long assignmentDurationInSeconds
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.
String reward
The amount of money the Requester will pay a Worker for successfully completing the HIT.
String title
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.
String keywords
One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
String description
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.
String question
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.
String requesterAnnotation
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.
List<E> qualificationRequirements
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.
String uniqueRequestToken
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.
ReviewPolicy assignmentReviewPolicy
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.
ReviewPolicy hITReviewPolicy
The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.
String hITLayoutId
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.
List<E> hITLayoutParameters
If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
HIT hIT
Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.
Long autoApprovalDelayInSeconds
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.
Long assignmentDurationInSeconds
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.
String reward
The amount of money the Requester will pay a Worker for successfully completing the HIT.
String title
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.
String keywords
One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
String description
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.
List<E> qualificationRequirements
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.
String hITTypeId
The ID of the newly registered HIT type.
String hITTypeId
The HIT type ID you want to create this HIT with.
Integer maxAssignments
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
Long lifetimeInSeconds
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.
String question
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.
String requesterAnnotation
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.
String uniqueRequestToken
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.
ReviewPolicy assignmentReviewPolicy
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.
ReviewPolicy hITReviewPolicy
The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.
String hITLayoutId
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.
List<E> hITLayoutParameters
If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
HIT hIT
Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.
String name
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.
String keywords
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.
String description
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.
String qualificationTypeStatus
The initial status of the Qualification type.
Constraints: Valid values are: Active | Inactive
Long retryDelayInSeconds
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.
String test
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.
String answerKey
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.
Long testDurationInSeconds
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
Boolean autoGranted
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.
Integer autoGrantedValue
The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
QualificationType qualificationType
The created Qualification type, returned as a QualificationType data structure.
String hITId
The ID of the HIT to be deleted.
String qualificationTypeId
The ID of the QualificationType to dispose.
String workerId
The ID of the Worker who possesses the Qualification to be revoked.
String qualificationTypeId
The ID of the Qualification type of the Qualification to be revoked.
String reason
A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.
String assignmentId
The ID of the Assignment to be retrieved.
Assignment assignment
The assignment. The response includes one Assignment element.
HIT hIT
The HIT associated with this assignment. The response includes one HIT element.
String fileUploadURL
A temporary URL for the file that the Worker uploaded for the answer.
String hITId
The ID of the HIT to be retrieved.
HIT hIT
Contains the requested HIT data.
Qualification qualification
The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score).
String qualificationTypeId
The ID of the QualificationType.
QualificationType qualificationType
The returned Qualification Type
String hITId
A unique identifier for the HIT.
String hITTypeId
The ID of the HIT type of this HIT
String hITGroupId
The ID of the HIT Group of this HIT.
String hITLayoutId
The ID of the HIT Layout of this HIT.
Date creationTime
The date and time the HIT was created.
String title
The title of the HIT.
String description
A general description of the HIT.
String question
The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.
String keywords
One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.
String hITStatus
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
Integer maxAssignments
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
String reward
Long autoApprovalDelayInSeconds
The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.
Date expiration
The date and time the HIT expires.
Long assignmentDurationInSeconds
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
String requesterAnnotation
An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
List<E> qualificationRequirements
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.
String hITReviewStatus
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
Integer numberOfAssignmentsPending
The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.
Integer numberOfAssignmentsAvailable
The number of assignments for this HIT that are available for Workers to accept.
Integer numberOfAssignmentsCompleted
The number of assignments for this HIT that have been approved or rejected.
String hITId
The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified
String assignmentId
The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified
String nextToken
Pagination token
Integer maxResults
Integer numResults
The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call.
String nextToken
List<E> bonusPayments
A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.
Integer numResults
The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.
String nextToken
List<E> qualificationRequests
The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.
String query
A text query against all of the searchable attributes of Qualification types.
Boolean mustBeRequestable
Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.
Boolean mustBeOwnedByCaller
Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.
String nextToken
Integer maxResults
The maximum number of results to return in a single call.
String hITTypeId
The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered
String status
Can be either Reviewable or Reviewing. Reviewable is the default value.
String nextToken
Pagination Token
Integer maxResults
Limit the number of results returned.
String hITId
The unique identifier of the HIT to retrieve review results for.
List<E> policyLevels
The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.
Boolean retrieveActions
Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.
Boolean retrieveResults
Specify if the operation should retrieve a list of the results computed by the Review Policies.
String nextToken
Pagination token
Integer maxResults
Limit the number of results returned.
String hITId
The HITId of the HIT for which results have been returned.
ReviewPolicy assignmentReviewPolicy
The name of the Assignment-level Review Policy. This contains only the PolicyName element.
ReviewPolicy hITReviewPolicy
The name of the HIT-level Review Policy. This contains only the PolicyName element.
ReviewReport assignmentReviewReport
Contains both ReviewResult and ReviewAction elements for an Assignment.
ReviewReport hITReviewReport
Contains both ReviewResult and ReviewAction elements for a particular HIT.
String nextToken
String nextToken
Integer numResults
The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.
List<E> workerBlocks
The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.
String qualificationTypeId
The ID of the Qualification type of the Qualifications to return.
String status
The status of the Qualifications to return. Can be Granted | Revoked.
String nextToken
Pagination Token
Integer maxResults
Limit the number of results returned.
String country
The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America.
String subdivision
The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington.
String destination
The target for notification messages. The Destination’s format is determined by the specified Transport:
When Transport is Email, the Destination is your email address.
When Transport is SQS, the Destination is your queue URL.
When Transport is SNS, the Destination is the ARN of your topic.
String transport
The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
String version
The version of the Notification API to use. Valid value is 2006-05-05.
List<E> eventTypes
The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.
String subject
The subject line of the email message to send. Can include up to 200 characters.
String messageText
The text of the email message to send. Can include up to 4,096 characters
List<E> workerIds
A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
String key
The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
List<E> values
The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly.
String qualificationTypeId
The ID of the Qualification type for the Qualification.
String workerId
The ID of the Worker who possesses the Qualification.
Date grantTime
The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation.
Integer integerValue
The value (score) of the Qualification, if the Qualification has an integer value.
Locale localeValue
String status
The status of the Qualification. Valid values are Granted | Revoked.
String qualificationRequestId
The ID of the Qualification request, a unique identifier generated when the request was submitted.
String qualificationTypeId
The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.
String workerId
The ID of the Worker requesting the Qualification.
String test
The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.
String answer
The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.
Date submitTime
The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.
String qualificationTypeId
The ID of the Qualification type for the requirement.
String comparator
The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value.
List<E> integerValues
The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.
List<E> localeValues
The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure.
Boolean requiredToPreview
DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data
for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview
the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true
in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if
there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be
allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default
is false. This should not be used in combination with the ActionsGuarded field.
String actionsGuarded
Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from
taking the specified action. Valid arguments include "Accept" (Worker cannot accept the HIT, but can preview the
HIT and see it in their search results), "PreviewAndAccept" (Worker cannot accept or preview the HIT, but can see
the HIT in their search results), and "DiscoverPreviewAndAccept" (Worker cannot accept, preview, or see the HIT
in their search results). It's possible for you to create a HIT with multiple QualificationRequirements (which
can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform
an action when they have met all QualificationRequirements guarding the action. The actions in the order of least
restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all
QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set
with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the HIT in their search result, but
will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the
RequiredToPreview field.
String qualificationTypeId
A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.
Date creationTime
The date and time the Qualification type was created.
String name
The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
String description
A long description for the Qualification type.
String keywords
One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
String qualificationTypeStatus
The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
String test
The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
Long testDurationInSeconds
The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.
String answerKey
The answers to the Qualification test specified in the Test parameter.
Long retryDelayInSeconds
The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.
Boolean isRequestable
Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.
Boolean autoGranted
Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
Integer autoGrantedValue
The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
String turkErrorCode
String actionId
The unique identifier for the action.
String actionName
The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.
String targetId
The specific HITId or AssignmentID targeted by the action.
String targetType
The type of object in TargetId.
String status
The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
Date completeTime
The date when the action was completed.
String result
A description of the outcome of the review.
String errorCode
Present only when the Results have a FAILED Status.
String actionId
A unique identifier of the Review action result.
String subjectId
The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself.
String subjectType
The type of the object from the SubjectId field.
String questionId
Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker's performance on the HIT.
String key
Key identifies the particular piece of reviewed information.
String value
The values of Key provided by the review policies you have selected.
String workerId
The ID of the Worker being paid the bonus.
String bonusAmount
The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.
String assignmentId
The ID of the assignment for which this bonus is paid.
String reason
A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.
String uniqueRequestToken
A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
NotificationSpecification notification
The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.
String testEventType
The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.
String turkErrorCode
String hITTypeId
The ID of the HIT type whose notification specification is being updated.
NotificationSpecification notification
The notification specification for the HIT type.
Boolean active
Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.
String qualificationTypeId
The ID of the Qualification type to update.
String description
The new description of the Qualification type.
String qualificationTypeStatus
The new status of the Qualification type - Active | Inactive
String test
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.
String answerKey
The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
Long testDurationInSeconds
The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
Long retryDelayInSeconds
The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. 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 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.
Boolean autoGranted
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.
Integer autoGrantedValue
The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
QualificationType qualificationType
Contains a QualificationType data structure.
Copyright © 2018. All rights reserved.