Skip to main content

RunClient

apify_client.clients.RunClient

Sub-client for manipulating a single actor run.

Index

Methods

Methods

abort

  • 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

    • gracefully: Optional[bool] = Noneoptionalkeyword-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

  • get(): Optional[Dict]

key_value_store

log

metamorph

  • 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

    • target_actor_id: strkeyword-only

      ID of the target actor that the run should be transformed into

    • target_actor_build: Optional[str] = Noneoptionalkeyword-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: Optional[Any] = Noneoptionalkeyword-only

      The input to pass to the new run.

    • content_type: Optional[str] = Noneoptionalkeyword-only

      The content type of the input.

    Returns Dict

    The actor run data.

reboot

  • reboot(): Dict

request_queue

resurrect

  • 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

    • build: Optional[str] = Noneoptionalkeyword-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: Optional[int] = Noneoptionalkeyword-only

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

    • timeout_secs: Optional[int] = Noneoptionalkeyword-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(*, 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

    • status_message: Optional[str] = Noneoptionalkeyword-only

      The new status message for the run

    • is_status_message_terminal: Optional[bool] = Noneoptionalkeyword-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_for_finish(*, wait_secs): Optional[Dict]

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

    Parameters

    • wait_secs: Optional[int] = Noneoptionalkeyword-only

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

    Returns Optional[Dict]

    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.