RunClientAsync

Async sub-client for manipulating a single Actor run.

Index

Methods

• abort
• charge
• dataset
• delete
• get
• key_value_store
• log
• metamorph
• reboot
• request_queue
• resurrect
• update
• wait_for_finish

Methods

abort

• async abort(*, gracefully): dict

• 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

  • keyword-onlygracefully: bool | None = None

  Returns dict

charge

• async charge(event_name, count, idempotency_key): dict

• Charge for an event of a Pay-Per-Event Actor run.

  https://docs.apify.com/api/v2#/reference/actor-runs/charge-run/charge-run

  ---

  Parameters

  • event_name: str

  • count: int | None = None

  • idempotency_key: str | None = None

  Returns dict

dataset

• dataset(): DatasetClientAsync

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

delete

• async delete(): None

• Delete the run.

  https://docs.apify.com/api/v2#/reference/actor-runs/delete-run/delete-run

  ---

  Returns None

get

• async get(): dict | None

• Return information about the Actor run.

  https://docs.apify.com/api/v2#/reference/actor-runs/run-object/get-run

  ---

  Returns dict | None

key_value_store

• key_value_store(): KeyValueStoreClientAsync

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

log

• log(): LogClientAsync

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

metamorph

• async metamorph(*, target_actor_id, target_actor_build, run_input, content_type): dict

• 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

  • keyword-onlytarget_actor_id: str

  • keyword-onlytarget_actor_build: str | None = None

  • keyword-onlyrun_input: Any = None

  • keyword-onlycontent_type: str | None = None

  Returns dict

reboot

• async reboot(): dict

• 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

request_queue

• request_queue(): RequestQueueClientAsync

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

resurrect

• async resurrect(*, build, memory_mbytes, timeout_secs): dict

• 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

  • keyword-onlybuild: str | None = None

  • keyword-onlymemory_mbytes: int | None = None

  • keyword-onlytimeout_secs: int | None = None

  Returns dict

update

• async update(*, status_message, is_status_message_terminal): dict

• Update the run with the specified fields.

  https://docs.apify.com/api/v2#/reference/actor-runs/run-object/update-run

  ---

  Parameters

  • keyword-onlystatus_message: str | None = None

  • keyword-onlyis_status_message_terminal: bool | None = None

  Returns dict

wait_for_finish

• async wait_for_finish(*, wait_secs): dict | None

• Wait synchronously until the run finishes or the server times out.

  ---

  Parameters

  • keyword-onlywait_secs: int | None = None

  Returns dict | None