list_reviewable_hi_ts `async` ¶

list_reviewable_hi_ts(
    *,
    config_overrides: Optional[AsyncMTurkClientConfig] = None,
    hit_type_id: Optional[EntityId] = None,
    status: Optional[ReviewableHITStatus] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ResultSize] = None,
) -> ListReviewableHITsResponse

The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

Parameters:

hit_type_id (Optional[EntityId], default: None ) –

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 (Optional[ReviewableHITStatus], default: None ) –

Can be either Reviewable or Reviewing. Reviewable is the default value.
next_token (Optional[PaginationToken], default: None ) –

Pagination Token
max_results (Optional[ResultSize], default: None ) –

Limit the number of results returned.

Raises:

RequestError –

Your request is invalid.
ServiceFault –

Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_mturk/_services/async_m_turk.py

async def list_reviewable_hi_ts(
    self,
    *,
    config_overrides: Optional[AsyncMTurkClientConfig] = None,
    hit_type_id: Optional["capo_mturk.types.entity_id.EntityId"] = None,
    status: Optional[
        "capo_mturk.types.reviewable_hit_status.ReviewableHITStatus"
    ] = None,
    next_token: Optional[
        "capo_mturk.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional["capo_mturk.types.result_size.ResultSize"] = None,
) -> "capo_mturk.types.list_reviewable_hi_ts_response.ListReviewableHITsResponse":
    """<p> The <code>ListReviewableHITs</code> operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation. </p>

    Args:
        hit_type_id: <p> The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered </p>
        status: <p> Can be either <code>Reviewable</code> or <code>Reviewing</code>. Reviewable is the default value. </p>
        next_token: <p>Pagination Token</p>
        max_results: <p> Limit the number of results returned. </p>

    Raises:
        capo_mturk.errors.request_error.RequestError: <p>Your request is invalid.</p>
        capo_mturk.errors.service_fault.ServiceFault: <p>Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.</p>
        capo_mturk.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mturk.types.list_reviewable_hi_ts_request.ListReviewableHITsRequest]",
    ) -> AsyncOperationResponse[
        "capo_mturk.types.list_reviewable_hi_ts_response.ListReviewableHITsResponse"
    ]:
        import capo_mturk._operations.m_turk_requester_service_v20170117.list_reviewable_hi_ts

        (
            output,
            http_response,
        ) = await capo_mturk._operations.m_turk_requester_service_v20170117.list_reviewable_hi_ts.async_list_reviewable_hi_ts(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReviewableHITs")
    )
    input_: capo_mturk.types.list_reviewable_hi_ts_request.ListReviewableHITsRequest = {}
    if hit_type_id is not None:
        input_["hit_type_id"] = hit_type_id
    if status is not None:
        input_["status"] = status
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_reviewable_hi_ts async ¶

list_reviewable_hi_ts `async` ¶