Skip to main content

RunClient

Sub-client for managing a specific Actor run.

Provides methods to manage a specific Actor run, e.g. get it, update it, abort it, or wait for it to finish. Obtain an instance via an appropriate method on the ApifyClient class.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

  • Initialize the resource client.

    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClient

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistry

      Bundle of client classes for dependency injection.

    • optionalkeyword-onlyresource_id: str | None = None

      Optional resource ID for single-resource clients.

    • optionalkeyword-onlyparams: dict | None = None

      Optional default parameters for all requests.

    Returns None

abort

  • abort(*, gracefully): Run

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

    The data of the aborted Actor run.

charge

  • 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

      The name of the event to charge for.

    • optionalcount: int | None = None

      The number of events to charge. Defaults to 1 if not provided.

    • optionalidempotency_key: str | None = None

      A unique key to ensure idempotent charging. If not provided, one will be auto-generated.

    Returns None

dataset

delete

  • delete(): None

get

  • get(): Run | None

get_status_message_watcher

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

    StatusMessageWatcher instance.

get_streamed_log

  • get_streamed_log(to_logger, *, from_start): StreamedLog

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

    StreamedLog instance for redirected logs.

key_value_store

log

metamorph

  • metamorph(*, target_actor_id, target_actor_build, run_input, content_type): Run

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

    The Actor run data.

reboot

request_queue

resurrect

  • resurrect(*, build, memory_mbytes, timeout, max_items, max_total_charge_usd, restart_on_error): Run

  • 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: timedelta | None = None

      New timeout for the resurrected run. 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.

    • optionalkeyword-onlyrestart_on_error: bool | None = None

      Determines whether the resurrected run will be restarted if it fails. By default, the resurrected run uses the same setting as before.

    Returns Run

    The Actor run data.

update

  • update(*, status_message, is_status_message_terminal, general_access): Run

  • 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: GeneralAccess | None = None

      Determines how others can access the run and its storages.

    Returns Run

    The updated run.

wait_for_finish

  • wait_for_finish(*, wait_duration): Run | None

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

    Parameters

    • optionalkeyword-onlywait_duration: timedelta | None = None

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

    Returns Run | None

    The Actor run data. If the status on the object is not one of the terminal statuses (SUCCEEDED, FAILED, TIMED_OUT, ABORTED), then the run has not yet finished.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options