RunClient
apify_client.clients.RunClient
Index
Methods
abort
Abort the Actor run which is starting or currently running and return its details.
https://docs.apify.com/api/v2#/reference/actor-runs/abort-run/abort-run
Parameters
gracefully: bool | None = Nonekeyword-only
If True, the Actor run will abort gracefully. It will send
`aborting`
and`persistStates`
events into the run and force-stop the run after 30 seconds. It is helpful in cases where you plan to resurrect the run later.
Returns dict
The data of the aborted Actor run
dataset
Get the client for the default dataset of the Actor run.
https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
Returns DatasetClient
A client allowing access to the default dataset of this Actor run.
delete
Returns None
get
Return information about the Actor run.
https://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run
Returns dict | None
The retrieved Actor run data
key_value_store
Get the client for the default key-value store of the Actor run.
https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
Returns KeyValueStoreClient
A client allowing access to the default key-value store of this Actor run.
log
Get the client for the log of the Actor run.
https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
Returns LogClient
A client allowing access to the log of this Actor run.
metamorph
Transform an Actor run into a run of another Actor with a new input.
https://docs.apify.com/api/v2#/reference/actor-runs/metamorph-run/metamorph-run
Parameters
target_actor_id: strkeyword-only
ID of the target Actor that the run should be transformed into
target_actor_build: str | None = Nonekeyword-only
The build of the target Actor. It can be either a build tag or build number. By default, the run uses the build specified in the default run configuration for the target Actor (typically the latest build).
run_input: Any = Nonekeyword-only
The input to pass to the new run.
content_type: str | None = Nonekeyword-only
The content type of the input.
Returns dict
The Actor run data.
reboot
Reboot an Actor run. Only runs that are running, i.e. runs with status RUNNING can be rebooted.
https://docs.apify.com/api/v2#/reference/actor-runs/reboot-run/reboot-run
Returns dict
The Actor run data.
request_queue
Get the client for the default request queue of the Actor run.
https://docs.apify.com/api/v2#/reference/actors/last-run-object-and-its-storages
Returns RequestQueueClient
A client allowing access to the default request_queue of this Actor run.
resurrect
Resurrect a finished Actor run.
Only finished runs, i.e. runs with status FINISHED, FAILED, ABORTED and TIMED-OUT can be resurrected. Run status will be updated to RUNNING and its container will be restarted with the same default storages.
https://docs.apify.com/api/v2#/reference/actor-runs/resurrect-run/resurrect-run
Parameters
build: str | None = Nonekeyword-only
Which Actor build the resurrected run should use. It can be either a build tag or build number. By default, the resurrected run uses the same build as before.
memory_mbytes: int | None = Nonekeyword-only
New memory limit for the resurrected run, in megabytes. By default, the resurrected run uses the same memory limit as before.
timeout_secs: int | None = Nonekeyword-only
New timeout for the resurrected run, in seconds. By default, the resurrected run uses the same timeout as before.
Returns dict
The Actor run data.
update
Update the run with the specified fields.
https://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run
Parameters
status_message: str | None = Nonekeyword-only
The new status message for the run
is_status_message_terminal: bool | None = Nonekeyword-only
Set this flag to True if this is the final status message of the Actor run.
Returns dict
The updated run
wait_for_finish
Wait synchronously until the run finishes or the server times out.
Parameters
wait_secs: int | None = Nonekeyword-only
how long does the client wait for run to finish. None for indefinite.
Returns dict | None
The Actor run data. If the status on the object is not one of the terminal statuses (SUCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished.
Sub-client for manipulating a single Actor run.