RunClientAsync

Async sub-client for manipulating a single Actor run.

Index

Methods

• abort
• charge
• dataset
• delete
• get
• get_status_message_watcher
• get_streamed_log
• 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

  • optionalkeyword-onlygracefully: bool | None = None

    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

charge

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

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

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

  ---

  Parameters

  • event_name: str

  • optionalcount: int | None = None

  • optionalidempotency_key: str | None = None

  Returns None

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

get_status_message_watcher

• async get_status_message_watcher(to_logger, check_period): StatusMessageWatcherAsync

• Get StatusMessageWatcher instance that can be used to redirect status and status messages to logs.

  StatusMessageWatcher can be explicitly started and stopped or used as a context manager.

  ---

  Parameters

  • optionalto_logger: logging.Logger | None = None

    Logger used for logging the status and status messages. If not provided, a new logger is created.

  • optionalcheck_period: timedelta = timedelta(seconds=1)

    The period with which the status message will be polled.

  Returns StatusMessageWatcherAsync

get_streamed_log

• async get_streamed_log(to_logger, *, from_start): StreamedLogAsync

• Get StreamedLog instance that can be used to redirect logs.

  StreamedLog can be explicitly started and stopped or used as a context manager.

  ---

  Parameters

  • optionalto_logger: logging.Logger | None = None

    Logger used for logging the redirected messages. If not provided, a new logger is created

  • optionalkeyword-onlyfrom_start: bool = True

    If True, all logs from the start of the actor run will be redirected. If False, only newly arrived logs will be redirected. This can be useful for redirecting only a small portion of relevant logs for long-running actors in stand-by.

  Returns StreamedLogAsync

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

    ID of the target Actor that the run should be transformed into.

  • optionalkeyword-onlytarget_actor_build: str | None = None

    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).

  • optionalkeyword-onlyrun_input: Any = None

    The input to pass to the new run.

  • optionalkeyword-onlycontent_type: str | None = None

    The content type of the input.

  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, max_items, max_total_charge_usd): 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

  • optionalkeyword-onlybuild: str | None = None

    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.

  • optionalkeyword-onlymemory_mbytes: int | None = None

    New memory limit for the resurrected run, in megabytes. By default, the resurrected run uses the same memory limit as before.

  • optionalkeyword-onlytimeout_secs: int | None = None

    New timeout for the resurrected run, in seconds. By default, the resurrected run uses the same timeout as before.

  • optionalkeyword-onlymax_items: int | None = None

    Maximum number of items that the resurrected pay-per-result run will return. By default, the resurrected run uses the same limit as before. Limit can be only increased.

  • optionalkeyword-onlymax_total_charge_usd: Decimal | None = None

    Maximum cost for the resurrected pay-per-event run in USD. By default, the resurrected run uses the same limit as before. Limit can be only increased.

  Returns dict

update

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

• Update the run with the specified fields.

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

  ---

  Parameters

  • optionalkeyword-onlystatus_message: str | None = None

    The new status message for the run.

  • optionalkeyword-onlyis_status_message_terminal: bool | None = None

    Set this flag to True if this is the final status message of the Actor run.

  • optionalkeyword-onlygeneral_access: RunGeneralAccess | None = None

    Determines how others can access the run and its storages.

  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

  • optionalkeyword-onlywait_secs: int | None = None

    How long does the client wait for run to finish. None for indefinite.

  Returns dict | None