createHITWithHITType method

Future<CreateHITWithHITTypeResponse> createHITWithHITType({ required String hITTypeId, required int lifetimeInSeconds, ReviewPolicy? assignmentReviewPolicy, String? hITLayoutId, List<HITLayoutParameter>? hITLayoutParameters, ReviewPolicy? hITReviewPolicy, int? maxAssignments, String? question, String? requesterAnnotation, String? uniqueRequestToken, })

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

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

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

May throw ServiceFault. May throw RequestError.

Parameter hITTypeId : The HIT type ID you want to create this HIT with.

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

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

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

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

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

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

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

Parameter question : The data the person completing the HIT uses to produce the results.

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

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

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

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

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

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

Implementation

Future<CreateHITWithHITTypeResponse> createHITWithHITType({
  required String hITTypeId,
  required int lifetimeInSeconds,
  ReviewPolicy? assignmentReviewPolicy,
  String? hITLayoutId,
  List<HITLayoutParameter>? hITLayoutParameters,
  ReviewPolicy? hITReviewPolicy,
  int? maxAssignments,
  String? question,
  String? requesterAnnotation,
  String? uniqueRequestToken,
}) async {
  ArgumentError.checkNotNull(hITTypeId, 'hITTypeId');
  _s.validateStringLength(
    'hITTypeId',
    hITTypeId,
    1,
    64,
    isRequired: true,
  );
  ArgumentError.checkNotNull(lifetimeInSeconds, 'lifetimeInSeconds');
  _s.validateStringLength(
    'hITLayoutId',
    hITLayoutId,
    1,
    64,
  );
  _s.validateStringLength(
    'uniqueRequestToken',
    uniqueRequestToken,
    1,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'MTurkRequesterServiceV20170117.CreateHITWithHITType'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'HITTypeId': hITTypeId,
      'LifetimeInSeconds': lifetimeInSeconds,
      if (assignmentReviewPolicy != null)
        'AssignmentReviewPolicy': assignmentReviewPolicy,
      if (hITLayoutId != null) 'HITLayoutId': hITLayoutId,
      if (hITLayoutParameters != null)
        'HITLayoutParameters': hITLayoutParameters,
      if (hITReviewPolicy != null) 'HITReviewPolicy': hITReviewPolicy,
      if (maxAssignments != null) 'MaxAssignments': maxAssignments,
      if (question != null) 'Question': question,
      if (requesterAnnotation != null)
        'RequesterAnnotation': requesterAnnotation,
      if (uniqueRequestToken != null)
        'UniqueRequestToken': uniqueRequestToken,
    },
  );

  return CreateHITWithHITTypeResponse.fromJson(jsonResponse.body);
}