archive_pool_async

toloka.client.TolokaClient.archive_pool_async | Source code

archive_pool_async(self, pool_id: str)

Archives a pool. Sends an asynchronous request to Toloka.

Only closed pools can be archived.

You can't open archived pools, but you can clone them if needed.

Parameters description

ParametersTypeDescription
pool_idstr

The ID of the pool to be archived.

  • Returns:

    An object to track the progress of the operation. If the pool is already archived then None is returned.

  • Return type:

    Optional[PoolArchiveOperation]

Examples:

closed_pool = next(toloka_client.get_pools(status='CLOSED'))
archive_op = toloka_client.archive_pool_async(pool_id=closed_pool.id)
toloka_client.wait_operation(archive_op)

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming