Class: AWS.MTurk

var params = {
  AssignmentId: 'STRING_VALUE', /* required */
  OverrideRejection: true || false,
  RequesterFeedback: 'STRING_VALUE'
};
mturk.approveAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AssignmentId — (String)

    The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

  • RequesterFeedback — (String)

    A message for the Worker, which the Worker can see in the Status section of the web site.

  • OverrideRejection — (Boolean)

    A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  WorkerId: 'STRING_VALUE', /* required */
  IntegerValue: 'NUMBER_VALUE',
  SendNotification: true || false
};
mturk.associateQualificationWithWorker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the Qualification type to use for the assigned Qualification.

  • WorkerId — (String)

    The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.

  • IntegerValue — (Integer)

    The value of the Qualification to assign.

  • SendNotification — (Boolean)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE', /* required */
  NumberOfAdditionalAssignments: 'NUMBER_VALUE', /* required */
  UniqueRequestToken: 'STRING_VALUE'
};
mturk.createAdditionalAssignmentsForHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The ID of the HIT to extend.

  • NumberOfAdditionalAssignments — (Integer)

    The number of additional assignments to request for this HIT.

  • UniqueRequestToken — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentDurationInSeconds: 'NUMBER_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  LifetimeInSeconds: 'NUMBER_VALUE', /* required */
  Reward: 'STRING_VALUE', /* required */
  Title: 'STRING_VALUE', /* required */
  AssignmentReviewPolicy: {
    PolicyName: 'STRING_VALUE', /* required */
    Parameters: [
      {
        Key: 'STRING_VALUE',
        MapEntries: [
          {
            Key: 'STRING_VALUE',
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  AutoApprovalDelayInSeconds: 'NUMBER_VALUE',
  HITLayoutId: 'STRING_VALUE',
  HITLayoutParameters: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HITReviewPolicy: {
    PolicyName: 'STRING_VALUE', /* required */
    Parameters: [
      {
        Key: 'STRING_VALUE',
        MapEntries: [
          {
            Key: 'STRING_VALUE',
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  Keywords: 'STRING_VALUE',
  MaxAssignments: 'NUMBER_VALUE',
  QualificationRequirements: [
    {
      Comparator: LessThan | LessThanOrEqualTo | GreaterThan | GreaterThanOrEqualTo | EqualTo | NotEqualTo | Exists | DoesNotExist | In | NotIn, /* required */
      QualificationTypeId: 'STRING_VALUE', /* required */
      ActionsGuarded: Accept | PreviewAndAccept | DiscoverPreviewAndAccept,
      IntegerValues: [
        'NUMBER_VALUE',
        /* more items */
      ],
      LocaleValues: [
        {
          Country: 'STRING_VALUE', /* required */
          Subdivision: 'STRING_VALUE'
        },
        /* more items */
      ],
      RequiredToPreview: true || false
    },
    /* more items */
  ],
  Question: 'STRING_VALUE',
  RequesterAnnotation: 'STRING_VALUE',
  UniqueRequestToken: 'STRING_VALUE'
};
mturk.createHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxAssignments — (Integer)

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

  • AutoApprovalDelayInSeconds — (Integer)

    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.

  • LifetimeInSeconds — (Integer)

    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.

  • AssignmentDurationInSeconds — (Integer)

    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.

  • Reward — (String)

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

  • Title — (String)

    The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

  • Keywords — (String)

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

  • Description — (String)

    A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

  • Question — (String)

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

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

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

  • RequesterAnnotation — (String)

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

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

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

  • QualificationRequirements — (Array<map>)

    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.

    • QualificationTypeId — required — (String)

      The ID of the Qualification type for the requirement.

    • Comparator — required — (String)

      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.

      Possible values include:
      • "LessThan"
      • "LessThanOrEqualTo"
      • "GreaterThan"
      • "GreaterThanOrEqualTo"
      • "EqualTo"
      • "NotEqualTo"
      • "Exists"
      • "DoesNotExist"
      • "In"
      • "NotIn"
    • IntegerValues — (Array<Integer>)

      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.

    • LocaleValues — (Array<map>)

      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.

      • Country — required — (String)

        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.

      • Subdivision — (String)

        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.

    • RequiredToPreview — (Boolean)

      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.

    • ActionsGuarded — (String)

      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.

      Possible values include:
      • "Accept"
      • "PreviewAndAccept"
      • "DiscoverPreviewAndAccept"
  • UniqueRequestToken — (String)

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

    Note: 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.
  • AssignmentReviewPolicy — (map)

    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.

    • PolicyName — required — (String)

      Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

    • Parameters — (Array<map>)

      Name of the parameter from the Review policy.

      • Key — (String)

        Name of the parameter from the list of Review Polices.

      • Values — (Array<String>)

        The list of values of the Parameter

      • MapEntries — (Array<map>)

        List of ParameterMapEntry objects.

        • Key — (String)

          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.

        • Values — (Array<String>)

          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.

  • HITReviewPolicy — (map)

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

    • PolicyName — required — (String)

      Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

    • Parameters — (Array<map>)

      Name of the parameter from the Review policy.

      • Key — (String)

        Name of the parameter from the list of Review Polices.

      • Values — (Array<String>)

        The list of values of the Parameter

      • MapEntries — (Array<map>)

        List of ParameterMapEntry objects.

        • Key — (String)

          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.

        • Values — (Array<String>)

          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.

  • HITLayoutId — (String)

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

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

  • HITLayoutParameters — (Array<map>)

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

    • Name — required — (String)

      The name of the parameter in the HITLayout.

    • Value — required — (String)

      The value substituted for the parameter referenced in the HITLayout.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HIT — (map)

      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.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentDurationInSeconds: 'NUMBER_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Reward: 'STRING_VALUE', /* required */
  Title: 'STRING_VALUE', /* required */
  AutoApprovalDelayInSeconds: 'NUMBER_VALUE',
  Keywords: 'STRING_VALUE',
  QualificationRequirements: [
    {
      Comparator: LessThan | LessThanOrEqualTo | GreaterThan | GreaterThanOrEqualTo | EqualTo | NotEqualTo | Exists | DoesNotExist | In | NotIn, /* required */
      QualificationTypeId: 'STRING_VALUE', /* required */
      ActionsGuarded: Accept | PreviewAndAccept | DiscoverPreviewAndAccept,
      IntegerValues: [
        'NUMBER_VALUE',
        /* more items */
      ],
      LocaleValues: [
        {
          Country: 'STRING_VALUE', /* required */
          Subdivision: 'STRING_VALUE'
        },
        /* more items */
      ],
      RequiredToPreview: true || false
    },
    /* more items */
  ]
};
mturk.createHITType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AutoApprovalDelayInSeconds — (Integer)

    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.

  • AssignmentDurationInSeconds — (Integer)

    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.

  • Reward — (String)

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

  • Title — (String)

    The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

  • Keywords — (String)

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

  • Description — (String)

    A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

  • QualificationRequirements — (Array<map>)

    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.

    • QualificationTypeId — required — (String)

      The ID of the Qualification type for the requirement.

    • Comparator — required — (String)

      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.

      Possible values include:
      • "LessThan"
      • "LessThanOrEqualTo"
      • "GreaterThan"
      • "GreaterThanOrEqualTo"
      • "EqualTo"
      • "NotEqualTo"
      • "Exists"
      • "DoesNotExist"
      • "In"
      • "NotIn"
    • IntegerValues — (Array<Integer>)

      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.

    • LocaleValues — (Array<map>)

      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.

      • Country — required — (String)

        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.

      • Subdivision — (String)

        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.

    • RequiredToPreview — (Boolean)

      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.

    • ActionsGuarded — (String)

      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.

      Possible values include:
      • "Accept"
      • "PreviewAndAccept"
      • "DiscoverPreviewAndAccept"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HITTypeId — (String)

      The ID of the newly registered HIT type.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITTypeId: 'STRING_VALUE', /* required */
  LifetimeInSeconds: 'NUMBER_VALUE', /* required */
  AssignmentReviewPolicy: {
    PolicyName: 'STRING_VALUE', /* required */
    Parameters: [
      {
        Key: 'STRING_VALUE',
        MapEntries: [
          {
            Key: 'STRING_VALUE',
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  HITLayoutId: 'STRING_VALUE',
  HITLayoutParameters: [
    {
      Name: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  HITReviewPolicy: {
    PolicyName: 'STRING_VALUE', /* required */
    Parameters: [
      {
        Key: 'STRING_VALUE',
        MapEntries: [
          {
            Key: 'STRING_VALUE',
            Values: [
              'STRING_VALUE',
              /* more items */
            ]
          },
          /* more items */
        ],
        Values: [
          'STRING_VALUE',
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  MaxAssignments: 'NUMBER_VALUE',
  Question: 'STRING_VALUE',
  RequesterAnnotation: 'STRING_VALUE',
  UniqueRequestToken: 'STRING_VALUE'
};
mturk.createHITWithHITType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITTypeId — (String)

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

  • MaxAssignments — (Integer)

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

  • LifetimeInSeconds — (Integer)

    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.

  • Question — (String)

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

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

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

  • RequesterAnnotation — (String)

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

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

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

  • UniqueRequestToken — (String)

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

    Note: 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.
  • AssignmentReviewPolicy — (map)

    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.

    • PolicyName — required — (String)

      Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

    • Parameters — (Array<map>)

      Name of the parameter from the Review policy.

      • Key — (String)

        Name of the parameter from the list of Review Polices.

      • Values — (Array<String>)

        The list of values of the Parameter

      • MapEntries — (Array<map>)

        List of ParameterMapEntry objects.

        • Key — (String)

          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.

        • Values — (Array<String>)

          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.

  • HITReviewPolicy — (map)

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

    • PolicyName — required — (String)

      Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

    • Parameters — (Array<map>)

      Name of the parameter from the Review policy.

      • Key — (String)

        Name of the parameter from the list of Review Polices.

      • Values — (Array<String>)

        The list of values of the Parameter

      • MapEntries — (Array<map>)

        List of ParameterMapEntry objects.

        • Key — (String)

          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.

        • Values — (Array<String>)

          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.

  • HITLayoutId — (String)

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

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

  • HITLayoutParameters — (Array<map>)

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

    • Name — required — (String)

      The name of the parameter in the HITLayout.

    • Value — required — (String)

      The value substituted for the parameter referenced in the HITLayout.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HIT — (map)

      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.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  QualificationTypeStatus: Active | Inactive, /* required */
  AnswerKey: 'STRING_VALUE',
  AutoGranted: true || false,
  AutoGrantedValue: 'NUMBER_VALUE',
  Keywords: 'STRING_VALUE',
  RetryDelayInSeconds: 'NUMBER_VALUE',
  Test: 'STRING_VALUE',
  TestDurationInSeconds: 'NUMBER_VALUE'
};
mturk.createQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    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.

  • Keywords — (String)

    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.

  • Description — (String)

    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.

  • QualificationTypeStatus — (String)

    The initial status of the Qualification type.

    Constraints: Valid values are: Active | Inactive

    Possible values include:
    • "Active"
    • "Inactive"
  • RetryDelayInSeconds — (Integer)

    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.

  • Test — (String)

    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.

  • AnswerKey — (String)

    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.

  • TestDurationInSeconds — (Integer)

    The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

  • AutoGranted — (Boolean)

    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.

  • AutoGrantedValue — (Integer)

    The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QualificationType — (map)

      The created Qualification type, returned as a QualificationType data structure.

      • QualificationTypeId — (String)

        A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

      • CreationTime — (Date)

        The date and time the Qualification type was created.

      • Name — (String)

        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.

      • Description — (String)

        A long description for the Qualification type.

      • Keywords — (String)

        One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

      • QualificationTypeStatus — (String)

        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.

        Possible values include:
        • "Active"
        • "Inactive"
      • Test — (String)

        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.

      • TestDurationInSeconds — (Integer)

        The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

      • AnswerKey — (String)

        The answers to the Qualification test specified in the Test parameter.

      • RetryDelayInSeconds — (Integer)

        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.

      • IsRequestable — (Boolean)

        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.

      • AutoGranted — (Boolean)

        Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

      • AutoGrantedValue — (Integer)

        The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Reason: 'STRING_VALUE', /* required */
  WorkerId: 'STRING_VALUE' /* required */
};
mturk.createWorkerBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkerId — (String)

    The ID of the Worker to block.

  • Reason — (String)

    A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE' /* required */
};
mturk.deleteHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The ID of the HIT to be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE' /* required */
};
mturk.deleteQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the QualificationType to dispose.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  WorkerId: 'STRING_VALUE', /* required */
  Reason: 'STRING_VALUE'
};
mturk.deleteWorkerBlock(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkerId — (String)

    The ID of the Worker to unblock.

  • Reason — (String)

    A message that explains the reason for unblocking the Worker. The Worker does not see this message.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  WorkerId: 'STRING_VALUE', /* required */
  Reason: 'STRING_VALUE'
};
mturk.disassociateQualificationFromWorker(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkerId — (String)

    The ID of the Worker who possesses the Qualification to be revoked.

  • QualificationTypeId — (String)

    The ID of the Qualification type of the Qualification to be revoked.

  • Reason — (String)

    A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
};
mturk.getAccountBalance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {})

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AvailableBalance — (String)

      A string representing a currency amount.

    • OnHoldBalance — (String)

      A string representing a currency amount.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentId: 'STRING_VALUE' /* required */
};
mturk.getAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AssignmentId — (String)

    The ID of the Assignment to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Assignment — (map)

      The assignment. The response includes one Assignment element.

      • AssignmentId — (String)

        A unique identifier for the assignment.

      • WorkerId — (String)

        The ID of the Worker who accepted the HIT.

      • HITId — (String)

        The ID of the HIT.

      • AssignmentStatus — (String)

        The status of the assignment.

        Possible values include:
        • "Submitted"
        • "Approved"
        • "Rejected"
      • AutoApprovalTime — (Date)

        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.

      • AcceptTime — (Date)

        The date and time the Worker accepted the assignment.

      • SubmitTime — (Date)

        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.

      • ApprovalTime — (Date)

        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.

      • RejectionTime — (Date)

        If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

      • Deadline — (Date)

        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.

      • Answer — (String)

        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.

      • RequesterFeedback — (String)

        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.

    • HIT — (map)

      The HIT associated with this assignment. The response includes one HIT element.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentId: 'STRING_VALUE', /* required */
  QuestionIdentifier: 'STRING_VALUE' /* required */
};
mturk.getFileUploadURL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AssignmentId — (String)

    The ID of the assignment that contains the question with a FileUploadAnswer.

  • QuestionIdentifier — (String)

    The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • FileUploadURL — (String)

      A temporary URL for the file that the Worker uploaded for the answer.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE' /* required */
};
mturk.getHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The ID of the HIT to be retrieved.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HIT — (map)

      Contains the requested HIT data.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  WorkerId: 'STRING_VALUE' /* required */
};
mturk.getQualificationScore(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the QualificationType.

  • WorkerId — (String)

    The ID of the Worker whose Qualification is being updated.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Qualification — (map)

      The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score).

      • QualificationTypeId — (String)

        The ID of the Qualification type for the Qualification.

      • WorkerId — (String)

        The ID of the Worker who possesses the Qualification.

      • GrantTime — (Date)

        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.

      • IntegerValue — (Integer)

        The value (score) of the Qualification, if the Qualification has an integer value.

      • LocaleValue — (map)

        The Locale data structure represents a geographical region or location.

        • Country — required — (String)

          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.

        • Subdivision — (String)

          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.

      • Status — (String)

        The status of the Qualification. Valid values are Granted | Revoked.

        Possible values include:
        • "Granted"
        • "Revoked"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE' /* required */
};
mturk.getQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the QualificationType.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QualificationType — (map)

      The returned Qualification Type

      • QualificationTypeId — (String)

        A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

      • CreationTime — (Date)

        The date and time the Qualification type was created.

      • Name — (String)

        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.

      • Description — (String)

        A long description for the Qualification type.

      • Keywords — (String)

        One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

      • QualificationTypeStatus — (String)

        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.

        Possible values include:
        • "Active"
        • "Inactive"
      • Test — (String)

        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.

      • TestDurationInSeconds — (Integer)

        The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

      • AnswerKey — (String)

        The answers to the Qualification test specified in the Test parameter.

      • RetryDelayInSeconds — (Integer)

        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.

      • IsRequestable — (Boolean)

        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.

      • AutoGranted — (Boolean)

        Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

      • AutoGrantedValue — (Integer)

        The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE', /* required */
  AssignmentStatuses: [
    Submitted | Approved | Rejected,
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mturk.listAssignmentsForHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The ID of the HIT.

  • NextToken — (String)

    Pagination token

  • MaxResults — (Integer)
  • AssignmentStatuses — (Array<String>)

    The status of the assignments to return: Submitted | Approved | Rejected

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

    • Assignments — (Array<map>)

      The collection of Assignment data structures returned by this call.

      • AssignmentId — (String)

        A unique identifier for the assignment.

      • WorkerId — (String)

        The ID of the Worker who accepted the HIT.

      • HITId — (String)

        The ID of the HIT.

      • AssignmentStatus — (String)

        The status of the assignment.

        Possible values include:
        • "Submitted"
        • "Approved"
        • "Rejected"
      • AutoApprovalTime — (Date)

        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.

      • AcceptTime — (Date)

        The date and time the Worker accepted the assignment.

      • SubmitTime — (Date)

        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.

      • ApprovalTime — (Date)

        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.

      • RejectionTime — (Date)

        If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

      • Deadline — (Date)

        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.

      • Answer — (String)

        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.

      • RequesterFeedback — (String)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentId: 'STRING_VALUE',
  HITId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mturk.listBonusPayments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    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

  • AssignmentId — (String)

    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

  • NextToken — (String)

    Pagination token

  • MaxResults — (Integer)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NumResults — (Integer)

      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.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • BonusPayments — (Array<map>)

      A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.

      • WorkerId — (String)

        The ID of the Worker to whom the bonus was paid.

      • BonusAmount — (String)

        A string representing a currency amount.

      • AssignmentId — (String)

        The ID of the assignment associated with this bonus payment.

      • Reason — (String)

        The Reason text given when the bonus was granted, if any.

      • GrantTime — (Date)

        The date and time of when the bonus was granted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mturk.listHITs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    Pagination token

  • MaxResults — (Integer)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

    • HITs — (Array<map>)

      The list of HIT elements returned by the query.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mturk.listHITsForQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the Qualification type to use when querying HITs.

  • NextToken — (String)

    Pagination Token

  • MaxResults — (Integer)

    Limit the number of results returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

    • HITs — (Array<map>)

      The list of HIT elements returned by the query.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  QualificationTypeId: 'STRING_VALUE'
};
mturk.listQualificationRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the QualificationType.

  • NextToken — (String)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • MaxResults — (Integer)

    The maximum number of results to return in a single call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NumResults — (Integer)

      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.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • QualificationRequests — (Array<map>)

      The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.

      • QualificationRequestId — (String)

        The ID of the Qualification request, a unique identifier generated when the request was submitted.

      • QualificationTypeId — (String)

        The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.

      • WorkerId — (String)

        The ID of the Worker requesting the Qualification.

      • Test — (String)

        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.

      • Answer — (String)

        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.

      • SubmitTime — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MustBeRequestable: true || false, /* required */
  MaxResults: 'NUMBER_VALUE',
  MustBeOwnedByCaller: true || false,
  NextToken: 'STRING_VALUE',
  Query: 'STRING_VALUE'
};
mturk.listQualificationTypes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Query — (String)

    A text query against all of the searchable attributes of Qualification types.

  • MustBeRequestable — (Boolean)

    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.

  • MustBeOwnedByCaller — (Boolean)

    Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

  • NextToken — (String)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

  • MaxResults — (Integer)

    The maximum number of results to return in a single call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NumResults — (Integer)

      The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • QualificationTypes — (Array<map>)

      The list of QualificationType elements returned by the query.

      • QualificationTypeId — (String)

        A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

      • CreationTime — (Date)

        The date and time the Qualification type was created.

      • Name — (String)

        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.

      • Description — (String)

        A long description for the Qualification type.

      • Keywords — (String)

        One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

      • QualificationTypeStatus — (String)

        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.

        Possible values include:
        • "Active"
        • "Inactive"
      • Test — (String)

        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.

      • TestDurationInSeconds — (Integer)

        The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

      • AnswerKey — (String)

        The answers to the Qualification test specified in the Test parameter.

      • RetryDelayInSeconds — (Integer)

        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.

      • IsRequestable — (Boolean)

        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.

      • AutoGranted — (Boolean)

        Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

      • AutoGrantedValue — (Integer)

        The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITTypeId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: Reviewable | Reviewing
};
mturk.listReviewableHITs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITTypeId — (String)

    The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered

  • Status — (String)

    Can be either Reviewable or Reviewing. Reviewable is the default value.

    Possible values include:
    • "Reviewable"
    • "Reviewing"
  • NextToken — (String)

    Pagination Token

  • MaxResults — (Integer)

    Limit the number of results returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

    • HITs — (Array<map>)

      The list of HIT elements returned by the query.

      • HITId — (String)

        A unique identifier for the HIT.

      • HITTypeId — (String)

        The ID of the HIT type of this HIT

      • HITGroupId — (String)

        The ID of the HIT Group of this HIT.

      • HITLayoutId — (String)

        The ID of the HIT Layout of this HIT.

      • CreationTime — (Date)

        The date and time the HIT was created.

      • Title — (String)

        The title of the HIT.

      • Description — (String)

        A general description of the HIT.

      • Question — (String)

        The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

      • Keywords — (String)

        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.

      • HITStatus — (String)

        The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

        Possible values include:
        • "Assignable"
        • "Unassignable"
        • "Reviewable"
        • "Reviewing"
        • "Disposed"
      • MaxAssignments — (Integer)

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

      • Reward — (String)

        A string representing a currency amount.

      • AutoApprovalDelayInSeconds — (Integer)

        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.

      • Expiration — (Date)

        The date and time the HIT expires.

      • AssignmentDurationInSeconds — (Integer)

        The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      • RequesterAnnotation — (String)

        An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

      • QualificationRequirements — (Array<map>)

        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.

        • QualificationTypeId — required — (String)

          The ID of the Qualification type for the requirement.

        • Comparator — required — (String)

          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.

          Possible values include:
          • "LessThan"
          • "LessThanOrEqualTo"
          • "GreaterThan"
          • "GreaterThanOrEqualTo"
          • "EqualTo"
          • "NotEqualTo"
          • "Exists"
          • "DoesNotExist"
          • "In"
          • "NotIn"
        • IntegerValues — (Array<Integer>)

          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.

        • LocaleValues — (Array<map>)

          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.

          • Country — required — (String)

            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.

          • Subdivision — (String)

            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.

        • RequiredToPreview — (Boolean)

          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.

        • ActionsGuarded — (String)

          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.

          Possible values include:
          • "Accept"
          • "PreviewAndAccept"
          • "DiscoverPreviewAndAccept"
      • HITReviewStatus — (String)

        Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

        Possible values include:
        • "NotReviewed"
        • "MarkedForReview"
        • "ReviewedAppropriate"
        • "ReviewedInappropriate"
      • NumberOfAssignmentsPending — (Integer)

        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.

      • NumberOfAssignmentsAvailable — (Integer)

        The number of assignments for this HIT that are available for Workers to accept.

      • NumberOfAssignmentsCompleted — (Integer)

        The number of assignments for this HIT that have been approved or rejected.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PolicyLevels: [
    Assignment | HIT,
    /* more items */
  ],
  RetrieveActions: true || false,
  RetrieveResults: true || false
};
mturk.listReviewPolicyResultsForHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The unique identifier of the HIT to retrieve review results for.

  • PolicyLevels — (Array<String>)

    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.

  • RetrieveActions — (Boolean)

    Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

  • RetrieveResults — (Boolean)

    Specify if the operation should retrieve a list of the results computed by the Review Policies.

  • NextToken — (String)

    Pagination token

  • MaxResults — (Integer)

    Limit the number of results returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HITId — (String)

      The HITId of the HIT for which results have been returned.

    • AssignmentReviewPolicy — (map)

      The name of the Assignment-level Review Policy. This contains only the PolicyName element.

      • PolicyName — required — (String)

        Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

      • Parameters — (Array<map>)

        Name of the parameter from the Review policy.

        • Key — (String)

          Name of the parameter from the list of Review Polices.

        • Values — (Array<String>)

          The list of values of the Parameter

        • MapEntries — (Array<map>)

          List of ParameterMapEntry objects.

          • Key — (String)

            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.

          • Values — (Array<String>)

            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.

    • HITReviewPolicy — (map)

      The name of the HIT-level Review Policy. This contains only the PolicyName element.

      • PolicyName — required — (String)

        Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

      • Parameters — (Array<map>)

        Name of the parameter from the Review policy.

        • Key — (String)

          Name of the parameter from the list of Review Polices.

        • Values — (Array<String>)

          The list of values of the Parameter

        • MapEntries — (Array<map>)

          List of ParameterMapEntry objects.

          • Key — (String)

            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.

          • Values — (Array<String>)

            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.

    • AssignmentReviewReport — (map)

      Contains both ReviewResult and ReviewAction elements for an Assignment.

      • ReviewResults — (Array<map>)

        A list of ReviewResults objects for each action specified in the Review Policy.

        • ActionId — (String)

          A unique identifier of the Review action result.

        • SubjectId — (String)

          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.

        • SubjectType — (String)

          The type of the object from the SubjectId field.

        • QuestionId — (String)

          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.

        • Key — (String)

          Key identifies the particular piece of reviewed information.

        • Value — (String)

          The values of Key provided by the review policies you have selected.

      • ReviewActions — (Array<map>)

        A list of ReviewAction objects for each action specified in the Review Policy.

        • ActionId — (String)

          The unique identifier for the action.

        • ActionName — (String)

          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.

        • TargetId — (String)

          The specific HITId or AssignmentID targeted by the action.

        • TargetType — (String)

          The type of object in TargetId.

        • Status — (String)

          The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

          Possible values include:
          • "Intended"
          • "Succeeded"
          • "Failed"
          • "Cancelled"
        • CompleteTime — (Date)

          The date when the action was completed.

        • Result — (String)

          A description of the outcome of the review.

        • ErrorCode — (String)

          Present only when the Results have a FAILED Status.

    • HITReviewReport — (map)

      Contains both ReviewResult and ReviewAction elements for a particular HIT.

      • ReviewResults — (Array<map>)

        A list of ReviewResults objects for each action specified in the Review Policy.

        • ActionId — (String)

          A unique identifier of the Review action result.

        • SubjectId — (String)

          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.

        • SubjectType — (String)

          The type of the object from the SubjectId field.

        • QuestionId — (String)

          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.

        • Key — (String)

          Key identifies the particular piece of reviewed information.

        • Value — (String)

          The values of Key provided by the review policies you have selected.

      • ReviewActions — (Array<map>)

        A list of ReviewAction objects for each action specified in the Review Policy.

        • ActionId — (String)

          The unique identifier for the action.

        • ActionName — (String)

          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.

        • TargetId — (String)

          The specific HITId or AssignmentID targeted by the action.

        • TargetType — (String)

          The type of object in TargetId.

        • Status — (String)

          The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

          Possible values include:
          • "Intended"
          • "Succeeded"
          • "Failed"
          • "Cancelled"
        • CompleteTime — (Date)

          The date when the action was completed.

        • Result — (String)

          A description of the outcome of the review.

        • ErrorCode — (String)

          Present only when the Results have a FAILED Status.

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mturk.listWorkerBlocks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    Pagination token

  • MaxResults — (Integer)

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

    • WorkerBlocks — (Array<map>)

      The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.

      • WorkerId — (String)

        The ID of the Worker who accepted the HIT.

      • Reason — (String)

        A message explaining the reason the Worker was blocked.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: Granted | Revoked
};
mturk.listWorkersWithQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the Qualification type of the Qualifications to return.

  • Status — (String)

    The status of the Qualifications to return. Can be Granted | Revoked.

    Possible values include:
    • "Granted"
    • "Revoked"
  • NextToken — (String)

    Pagination Token

  • MaxResults — (Integer)

    Limit the number of results returned.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

    • NumResults — (Integer)

      The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.

    • Qualifications — (Array<map>)

      The list of Qualification elements returned by this call.

      • QualificationTypeId — (String)

        The ID of the Qualification type for the Qualification.

      • WorkerId — (String)

        The ID of the Worker who possesses the Qualification.

      • GrantTime — (Date)

        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.

      • IntegerValue — (Integer)

        The value (score) of the Qualification, if the Qualification has an integer value.

      • LocaleValue — (map)

        The Locale data structure represents a geographical region or location.

        • Country — required — (String)

          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.

        • Subdivision — (String)

          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.

      • Status — (String)

        The status of the Qualification. Valid values are Granted | Revoked.

        Possible values include:
        • "Granted"
        • "Revoked"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MessageText: 'STRING_VALUE', /* required */
  Subject: 'STRING_VALUE', /* required */
  WorkerIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mturk.notifyWorkers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Subject — (String)

    The subject line of the email message to send. Can include up to 200 characters.

  • MessageText — (String)

    The text of the email message to send. Can include up to 4,096 characters

  • WorkerIds — (Array<String>)

    A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NotifyWorkersFailureStatuses — (Array<map>)

      When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.

      • NotifyWorkersFailureCode — (String)

        Encoded value for the failure type.

        Possible values include:
        • "SoftFailure"
        • "HardFailure"
      • NotifyWorkersFailureMessage — (String)

        A message detailing the reason the Worker could not be notified.

      • WorkerId — (String)

        The ID of the Worker.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentId: 'STRING_VALUE', /* required */
  RequesterFeedback: 'STRING_VALUE' /* required */
};
mturk.rejectAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AssignmentId — (String)

    The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

  • RequesterFeedback — (String)

    A message for the Worker, which the Worker can see in the Status section of the web site.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationRequestId: 'STRING_VALUE', /* required */
  Reason: 'STRING_VALUE'
};
mturk.rejectQualificationRequest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationRequestId — (String)

    The ID of the Qualification request, as returned by the ListQualificationRequests operation.

  • Reason — (String)

    A text message explaining why the request was rejected, to be shown to the Worker who made the request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AssignmentId: 'STRING_VALUE', /* required */
  BonusAmount: 'STRING_VALUE', /* required */
  Reason: 'STRING_VALUE', /* required */
  WorkerId: 'STRING_VALUE', /* required */
  UniqueRequestToken: 'STRING_VALUE'
};
mturk.sendBonus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • WorkerId — (String)

    The ID of the Worker being paid the bonus.

  • BonusAmount — (String)

    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.

  • AssignmentId — (String)

    The ID of the assignment for which this bonus is paid.

  • Reason — (String)

    A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

  • UniqueRequestToken — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Notification: { /* required */
    Destination: 'STRING_VALUE', /* required */
    EventTypes: [ /* required */
      AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExpired | HITReviewable | HITExtended | HITDisposed | Ping,
      /* more items */
    ],
    Transport: Email | SQS | SNS, /* required */
    Version: 'STRING_VALUE' /* required */
  },
  TestEventType: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExpired | HITReviewable | HITExtended | HITDisposed | Ping /* required */
};
mturk.sendTestEventNotification(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Notification — (map)

    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.

    • Destination — required — (String)

      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.

    • Transport — required — (String)

      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

      Possible values include:
      • "Email"
      • "SQS"
      • "SNS"
    • Version — required — (String)

      The version of the Notification API to use. Valid value is 2006-05-05.

    • EventTypes — required — (Array<String>)

      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.

  • TestEventType — (String)

    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.

    Possible values include:
    • "AssignmentAccepted"
    • "AssignmentAbandoned"
    • "AssignmentReturned"
    • "AssignmentSubmitted"
    • "AssignmentRejected"
    • "AssignmentApproved"
    • "HITCreated"
    • "HITExpired"
    • "HITReviewable"
    • "HITExtended"
    • "HITDisposed"
    • "Ping"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ExpireAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  HITId: 'STRING_VALUE' /* required */
};
mturk.updateExpirationForHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The HIT to update.

  • ExpireAt — (Date)

    The date and time at which you want the HIT to expire

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE', /* required */
  Revert: true || false
};
mturk.updateHITReviewStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The ID of the HIT to update.

  • Revert — (Boolean)

    Specifies how to update the HIT status. Default is False.

    • Setting this to false will only transition a HIT from Reviewable to Reviewing

    • Setting this to true will only transition a HIT from Reviewing to Reviewable

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITId: 'STRING_VALUE', /* required */
  HITTypeId: 'STRING_VALUE' /* required */
};
mturk.updateHITTypeOfHIT(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITId — (String)

    The HIT to update.

  • HITTypeId — (String)

    The ID of the new HIT type.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  HITTypeId: 'STRING_VALUE', /* required */
  Active: true || false,
  Notification: {
    Destination: 'STRING_VALUE', /* required */
    EventTypes: [ /* required */
      AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExpired | HITReviewable | HITExtended | HITDisposed | Ping,
      /* more items */
    ],
    Transport: Email | SQS | SNS, /* required */
    Version: 'STRING_VALUE' /* required */
  }
};
mturk.updateNotificationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • HITTypeId — (String)

    The ID of the HIT type whose notification specification is being updated.

  • Notification — (map)

    The notification specification for the HIT type.

    • Destination — required — (String)

      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.

    • Transport — required — (String)

      The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

      Possible values include:
      • "Email"
      • "SQS"
      • "SNS"
    • Version — required — (String)

      The version of the Notification API to use. Valid value is 2006-05-05.

    • EventTypes — required — (Array<String>)

      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.

  • Active — (Boolean)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  QualificationTypeId: 'STRING_VALUE', /* required */
  AnswerKey: 'STRING_VALUE',
  AutoGranted: true || false,
  AutoGrantedValue: 'NUMBER_VALUE',
  Description: 'STRING_VALUE',
  QualificationTypeStatus: Active | Inactive,
  RetryDelayInSeconds: 'NUMBER_VALUE',
  Test: 'STRING_VALUE',
  TestDurationInSeconds: 'NUMBER_VALUE'
};
mturk.updateQualificationType(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • QualificationTypeId — (String)

    The ID of the Qualification type to update.

  • Description — (String)

    The new description of the Qualification type.

  • QualificationTypeStatus — (String)

    The new status of the Qualification type - Active | Inactive

    Possible values include:
    • "Active"
    • "Inactive"
  • Test — (String)

    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.

  • AnswerKey — (String)

    The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

  • TestDurationInSeconds — (Integer)

    The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

  • RetryDelayInSeconds — (Integer)

    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.

  • AutoGranted — (Boolean)

    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.

  • AutoGrantedValue — (Integer)

    The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QualificationType — (map)

      Contains a QualificationType data structure.

      • QualificationTypeId — (String)

        A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

      • CreationTime — (Date)

        The date and time the Qualification type was created.

      • Name — (String)

        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.

      • Description — (String)

        A long description for the Qualification type.

      • Keywords — (String)

        One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

      • QualificationTypeStatus — (String)

        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.

        Possible values include:
        • "Active"
        • "Inactive"
      • Test — (String)

        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.

      • TestDurationInSeconds — (Integer)

        The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

      • AnswerKey — (String)

        The answers to the Qualification test specified in the Test parameter.

      • RetryDelayInSeconds — (Integer)

        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.

      • IsRequestable — (Boolean)

        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.

      • AutoGranted — (Boolean)

        Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

      • AutoGrantedValue — (Integer)

        The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.