get_ansyscloud_job_info

Desktop.get_ansyscloud_job_info(job_id=None, job_name=None)

Monitor a job submitted to Ansys Cloud.

Warning

Do not execute this function with untrusted function argument, environment variables or pyaedt global settings. See the security guide for details.

Parameters:

job_idstr, optional

Job Id. The default value is None if job name is used.

job_namestr, optional

Job name. The default value is None if job id is used.

Returns:

dict

Examples

>>> from ansys.aedt.core import Desktop

>>> d = Desktop(version="2025.2", new_desktop=False)
>>> d.select_scheduler("Ansys Cloud")
>>> out = d.get_available_cloud_config()
>>> job_id, job_name = d.submit_ansys_cloud_job(
...     "via_gsg.aedt", list(out.keys())[0], region="westeurope", job_name="MyJob"
... )
>>> o1 = d.get_ansyscloud_job_info(job_id=job_id)
>>> o2 = d.get_ansyscloud_job_info(job_name=job_name)
>>> d.download_job_results(job_id=job_id, project_path="via_gsg.aedt", results_folder="via_gsg_results")
>>> d.release_desktop(False, False)