list_hi_ts `async` ¶

list_hi_ts(
    *,
    config_overrides: Optional[AsyncMTurkClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[ResultSize] = None,
) -> ListHITsResponse

The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

Parameters:

next_token (Optional[PaginationToken], default: None ) –

Pagination token

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_hi_ts(
    self,
    *,
    config_overrides: Optional[AsyncMTurkClientConfig] = 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_hi_ts_response.ListHITsResponse":
    """<p> The <code>ListHITs</code> operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted. </p>

    Args:
        next_token: <p>Pagination token</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_hi_ts_request.ListHITsRequest]",
    ) -> AsyncOperationResponse[
        "capo_mturk.types.list_hi_ts_response.ListHITsResponse"
    ]:
        import capo_mturk._operations.m_turk_requester_service_v20170117.list_hi_ts

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListHITs")
    )
    input_: capo_mturk.types.list_hi_ts_request.ListHITsRequest = {}
    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_hi_ts async ¶

list_hi_ts `async` ¶