View a markdown version of this page

Obtenir des informations sur les courses - AWS HealthOmics
Obtenir le statut et les détails de la courseListe de toutes les coursesRépertorier les tâches en cours d'exécutionObtenir les détails des tâchesExécutez les métadonnées dans CloudWatch

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Obtenir des informations sur les courses

Après avoir démarré une exécution, vous pouvez récupérer son statut, sa configuration et les détails relatifs aux tâches à l'aide de l' HealthOmics API. Cette page explique comment :

Obtenir le statut et les détails de la course

Utilisez l'opération GetRun API pour vérifier l'état et récupérer les détails d'une exécution spécifique. Vous avez besoin de l'ID d'exécution, qui est renvoyé lorsque vous démarrez une exécution.

aws omics get-run --id run_id
Trouver l'identifiant de course

Vous pouvez trouver l'ID d'exécution de différentes manières :

  • À partir de la réponse de l'StartRunAPI, id le champ est renvoyé lorsque vous lancez une exécution.

  • Depuis la HealthOmics console : sur la page Runs, l'ID d'exécution est affiché dans la première colonne de la liste des runs.

  • Depuis l'ListRunsAPI : répertorie toutes les courses de votre compte avec leurs identifiants.

La réponse inclut l'état de l'exécution, les détails du flux de travail, les informations sur l'accélérateur et les horodatages. Les états d'exécution possibles sont les suivants :

Statut Description
PENDING La course a été soumise et attend de commencer.
STARTING HealthOmics fournit des ressources pour l'exécution.
RUNNING L'exécution exécute activement des tâches.
COMPLETED L'exécution s'est terminée avec succès. Les fichiers de sortie sont disponibles dans l'emplacement de sortie Amazon S3.
FAILED L'exécution a rencontré une erreur. Consultez Raisons d'échec de l'exécution.
CANCELLED L'exécution a été annulée par l'utilisateur.

Lorsqu'il s'agit d'une exécutionCOMPLETED, vous pouvez trouver les fichiers de sortie dans votre compartiment de sortie Amazon S3, dans un dossier nommé d'après l'ID d'exécution.

Exemple de réponse

L'exemple suivant montre la réponse à une exécution terminée d'un flux de travail WDL privé avec un accélérateur GPU :

{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/7830534",
    "id": "7830534",
    "uuid": "96c57683-74bf-9d6d-ae7e-f09b097db14a",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "status": "COMPLETED",
    "workflowId": "4074992",
    "workflowType": "PRIVATE",
    "workflowVersionName": "3.0.0",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "RunGroupMaxGpuTest",
    "runGroupId": "9938959",
    "digest": "sha256:a23a6fc54040d36784206234c02147302ab8658bed89860a...",
    "accelerators": "GPU",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/Admin/role_name",
    "creationTime": "2023-04-07T16:44:22.262471+00:00",
    "startTime": "2023-04-07T16:56:12.504000+00:00",
    "stopTime": "2023-04-07T17:22:29.908813+00:00",
    "tags": {}
}

Champs clés de la réponse

Champ Description
uuid Identifiant unique universel pour la course. En outreoutputUri, peut être utilisé pour suivre où les données de sortie sont écrites.
status État d'exécution actuel (voir le tableau précédent).
workflowType Si le flux de travail est PRIVATE ouREADY2RUN.
accelerators Type d'accélérateur utilisé (par exemple,GPU), le cas échéant.
digest SHA-256 résumé de la définition du flux de travail.
creationTime Quand la course a été soumise.
startTime Quand la course a commencé à s'exécuter.
stopTime Quand la course s'est terminée ou a été annulée.
engineSettings Paramètres du moteur appliqués à l'exécution. Ce champ est renvoyé uniquement pour les flux de travail Nextflow. Si vous spécifiez les paramètres du moteur pour les flux de travail WDL ou CWL, ils sont ignorés en silence et ce champ n'apparaît pas dans la réponse. GetRun Consultez Spécifier les paramètres du moteur Nextflow.

Exemple de réponse pour une exécution de Nextflow avec les paramètres du moteur

Pour les exécutions Nextflow démarrées avec les paramètres du moteur, la GetRun réponse inclut une engineSettings carte qui reflète les valeurs appliquées à l'exécution. L'exemple suivant montre une exécution démarrée avec une version de moteur épinglée et deux profils.

{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/9876543",
    "id": "9876543",
    "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "COMPLETED",
    "workflowId": "1122334",
    "workflowType": "PRIVATE",
    "workflowVersionName": "1.2.1",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "nextflow-rnaseq-run",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "engineSettings": {
        "engineVersion": "26.04",
        "profile": "test,docker"
    },
    "creationTime": "2024-09-10T16:44:22.262471+00:00",
    "startTime": "2024-09-10T16:56:12.504000+00:00",
    "stopTime": "2024-09-10T17:22:29.908813+00:00",
    "tags": {}
}

Le engineSettings champ est renvoyé uniquement pour les flux de travail Nextflow. Pour les flux de travail WDL et CWL, ce champ n'est pas présent dans la réponse. Pour de plus amples informations, veuillez consulter Spécifier les paramètres du moteur Nextflow.

Liste de toutes les courses

Utilisez l'opération ListRuns API pour voir toutes les exécutions de votre compte :

aws omics list-runs

La réponse renvoie une liste paginée d'exécutions avec des informations récapitulatives, notamment l'ID d'exécution, le nom, le statut et les horodatages. Utilisez le --starting-token paramètre pour récupérer des pages supplémentaires.

Répertorier les tâches en cours d'exécution

Utilisez l'opération ListRunTasks API pour voir toutes les tâches effectuées au cours d'une exécution spécifique :

aws omics list-run-tasks --id run_id

La réponse renvoie une liste de tâches avec leur statut, leur allocation de ressources et leurs informations temporelles.

Obtenir les détails des tâches

Utilisez l'opération GetRunTask API pour obtenir des informations détaillées sur une tâche spécifique au cours d'une exécution :

aws omics get-run-task --id run_id --task-id task_id

La réponse inclut des détails au niveau de la tâche, tels que le processeur, l'allocation de mémoire, l'image du conteneur et l'état de la tâche.

Exécutez les métadonnées dans CloudWatch

Une fois l'exécution terminée, HealthOmics envoie les métadonnées d'exécution à CloudWatch Logs sous le flux :

manifest/run/run_id/run_uuid

Le manifeste inclut la configuration complète de l'exécution, les paramètres d'entrée, les résumés des ressources et les détails des tâches. Voici un exemple de manifeste :

[
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "creationTime": "2022-08-24T19:53:55.284Z",
    "resourceDigests": {
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict": "etag:3884c62eb0e53fa92459ed9bff133ae6",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta": "etag:e307d81c605fb91b7720a08f00276842-388",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai": "etag:f76371b113734a56cde236bc0372de0a",
      "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals": "etag:27fdd1341246896721ec49a46a575334",
      "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt": "etag:e22f5aeed0b350a66696d8ffae453227"
    },
    "digest": "sha256:a5baaff84dd54085eb03f78766b0a367e93439486bc3f67de42bb38b93304964",
    "engine": "WDL",
    "main": "gatk4-basic-joint-genotyping-v2.wdl",
    "name": "1044-gvcfs",
    "outputUri": "s3://omics-data/workflow-output",
    "parameters": {
      "callset_name": "cohort",
      "input_gvcf_uris": "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt",
      "interval_list": "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals",
      "ref_dict": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict",
      "ref_fasta": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta",
      "ref_fasta_index": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai"
    },
    "roleArn": "arn:aws:iam::123456789012:role/OmicsServiceRole",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/admin/ahenroid-Isengard",
    "startTime": "2022-08-24T20:08:22.582Z",
    "status": "COMPLETED",
    "stopTime": "2022-08-24T20:08:22.582Z",
    "storageCapacity": 9600,
    "uuid": "a3b0ca7e-9597-4ecc-94a4-6ed45481aeab",
    "workflow": "arn:aws:omics:us-east-1:123456789012:workflow/1558364",
    "workflowType": "PRIVATE"
  },
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:task/1245938",
    "cpus": 16,
    "creationTime": "2022-08-24T20:06:32.971290",
    "image": "123456789012.dkr.ecr.us-west-2.amazonaws.com/gatk",
    "imageDigest": "sha256:8051adab0ff725e7e9c2af5997680346f3c3799b2df3785dd51d4abdd3da747b",
    "memory": 32,
    "name": "geno-123",
    "run": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "startTime": "2022-08-24T20:08:22.278Z",
    "status": "SUCCESS",
    "stopTime": "2022-08-24T20:08:22.278Z",
    "uuid": "44c1a30a-4eee-426d-88ea-1af403858f76"
  },
  ...
]

Pour plus d'informations sur les journaux disponibles CloudWatch pour les HealthOmics exécutions, consultezSurveillance à HealthOmics l'aide de CloudWatch journaux.

Note

Les métadonnées d'exécution ne sont pas supprimées CloudWatch des journaux, même lorsque vous supprimez l'exécution de HealthOmics. Vous pouvez l'utiliser CloudWatch pour accéder aux métadonnées des exécutions qui ne sont plus disponibles via l' HealthOmicsAPI.