satorbis_kit.vector_operation.wherobots_status module

Wherobots Job Status Module

This module provides functionality for checking status, viewing logs, and managing Wherobots Cloud job runs via the REST API.

satorbis_kit.vector_operation.wherobots_status.cancel_job(api_key: str, run_id: str) → None

Cancel a Wherobots job run.

Parameters:

• api_key – Wherobots API key

• run_id – Job run ID

Raises:

• ImportError – If requests library is not available

• requests.HTTPError – If the API request fails

satorbis_kit.vector_operation.wherobots_status.get_job_logs(api_key: str, run_id: str, cursor: int = 0, size: int = 100) → dict

Get logs for a Wherobots job run.

Parameters:

• api_key – Wherobots API key

• run_id – Job run ID

• cursor – Pagination cursor

• size – Number of log entries to fetch

Returns:

Logs dictionary with items, current_page, and next_page

Raises:

• ImportError – If requests library is not available

• requests.HTTPError – If the API request fails

satorbis_kit.vector_operation.wherobots_status.get_job_status(api_key: str, run_id: str) → dict

Get the status of a Wherobots job run.

Parameters:

• api_key – Wherobots API key

• run_id – Job run ID

Returns:

Job run details dictionary

Raises:

• ImportError – If requests library is not available

• requests.HTTPError – If the API request fails

satorbis_kit.vector_operation.wherobots_status.list_jobs(api_key: str, region: str | None = None, status: List[str] | None = None, name: str | None = None, size: int = 50) → dict

List Wherobots job runs.

Parameters:

• api_key – Wherobots API key

• region – Filter by region (optional)

• status – Filter by status list (optional)

• name – Filter by name pattern (optional)

• size – Number of results per page

Returns:

Dictionary with items list and pagination info

Raises:

• ImportError – If requests library is not available

• requests.HTTPError – If the API request fails

satorbis_kit.vector_operation.wherobots_status.submit_job(api_key: str, region: str, script_uri: str, script_args: List[str] | None = None, runtime: str = 'tiny', name: str = 'wherobots-job', version: str = 'latest', timeout_seconds: int = 3600, dependencies: List[dict] | None = None, spark_configs: dict | None = None) → dict

Submit a Python job to Wherobots Cloud.

Parameters:

• api_key – Wherobots API key

• region – Compute region (e.g., ‘aws-ap-south-1’, ‘aws-us-west-2’)

• script_uri – S3 URI to the Python script

• script_args – List of command-line arguments for the script

• runtime – Runtime size (tiny, small, medium, large, etc.)

• name – Job run name

• version – Wherobots version (‘latest’ or ‘preview’)

• timeout_seconds – Job timeout in seconds

• dependencies – List of dependency objects (PyPI or FILE)

• spark_configs – Dictionary of Spark configuration key-value pairs

Returns:

Response dictionary from Wherobots API

Raises:

• ImportError – If requests library is not available

• requests.HTTPError – If the API request fails