MTurk / Paginator / ListAssignmentsForHIT

ListAssignmentsForHIT

class MTurk.Paginator.ListAssignmentsForHIT

paginator = client.get_paginator('list_assignments_for_hit')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MTurk.Client.list_assignments_for_hit().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    HITId='string',
    AssignmentStatuses=[
        'Submitted'|'Approved'|'Rejected',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• HITId (string) –

  [REQUIRED]

  The ID of the HIT.

• AssignmentStatuses (list) –

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

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'NumResults': 123,
    'Assignments': [
        {
            'AssignmentId': 'string',
            'WorkerId': 'string',
            'HITId': 'string',
            'AssignmentStatus': 'Submitted'|'Approved'|'Rejected',
            'AutoApprovalTime': datetime(2015, 1, 1),
            'AcceptTime': datetime(2015, 1, 1),
            'SubmitTime': datetime(2015, 1, 1),
            'ApprovalTime': datetime(2015, 1, 1),
            'RejectionTime': datetime(2015, 1, 1),
            'Deadline': datetime(2015, 1, 1),
            'Answer': 'string',
            'RequesterFeedback': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • 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 (list) –

    The collection of Assignment data structures returned by this call.

    • (dict) –

      The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker’s efforts to complete the HIT, and contains the results for later retrieval.

      • 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.

      • AutoApprovalTime (datetime) –

        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 (datetime) –

        The date and time the Worker accepted the assignment.

      • SubmitTime (datetime) –

        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 (datetime) –

        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 (datetime) –

        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 (datetime) –

        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.