client.scripts.post_python3_runs

A method of the Scripts endpoint.

post_python3_runs(id: int) → Response

Start a run

API URL: POST /scripts/python3/{id}/runs

import civis
client = civis.APIClient()
response = client.scripts.post_python3_runs(...)

Parameters:

idint

The ID of the Python job.

Returns:

civis.Response

• idint

  The ID of the run.

• python_idint

  The ID of the Python job.

• statestr

  The state of the run, one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.

• is_cancel_requestedbool

  True if run cancel requested, else false.

• created_atstr (time)

  The time the run was created.

• started_atstr (time)

  The time the run started at.

• finished_atstr (time)

  The time the run completed.

• errorstr

  The error, if any, returned by the run.

• max_memory_usagefloat (float)

  If the run has finished, the maximum amount of memory used during the run, in MB.

• max_cpu_usagefloat (float)

  If the run has finished, the maximum amount of cpu used during the run, in millicores.