View a markdown version of this page

Commencez une course HealthOmics - AWS HealthOmics

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.

Commencez une course HealthOmics

Lorsque vous lancez une exécution, vous spécifiez les ressources HealthOmics allouées à cette exécution. Les paramètres suivants sont disponibles :

  1. Emplacement de sortie — Spécifiez un URI Amazon S3 dans lequel les fichiers de sortie de l'exécution sont stockés. Si vous exécutez un grand nombre de flux de travail simultanément, utilisez des URI de sortie Amazon S3 distincts pour chaque flux de travail afin d'éviter la limitation des compartiments. Pour plus d'informations, consultez Organiser les objets à l'aide de préfixes dans le guide de l'utilisateur Amazon S3 et Scale Storage Connections horizontalement dans le livre blanc sur l'optimisation des performances d'Amazon S3.

  2. Rôle de service — Spécifiez un rôle de service IAM qui accorde HealthOmics des autorisations pour accéder aux ressources nécessaires à l'exécution. La console peut éventuellement créer le rôle de service pour vous. Pour de plus amples informations, veuillez consulter Rôles de service pour AWS HealthOmics.

  3. Exécuter le stockage (facultatif, Dynamic par défaut) : spécifiez le type de stockage d'exécution et la quantité de stockage (pour le stockage statique). Pour garantir l'isolation et la sécurité des données, HealthOmics provisionne le stockage au début de chaque exécution et le déprovisionne à la fin de l'exécution. Pour de plus amples informations, veuillez consulter Exécuter les types de stockage dans les HealthOmics flux de travail.

  4. Priorité d'exécution (facultatif) : attribuez une priorité à l'exécution. L'impact de la priorité sur l'exécution dépend du fait que l'exécution est associée ou non à un groupe d'exécution. Pour de plus amples informations, veuillez consulter Priorité d'exécution.

  5. Version du flux de travail (facultatif) : sélectionnez une version de flux de travail spécifique pour l'exécution. Si vous ne spécifiez aucune version, HealthOmics démarre la version du flux de travail par défaut.

  6. Paramètres du moteur Nextflow (facultatif, Nextflow uniquement) : spécifiez les paramètres du moteur tels que la version et l'analyseur syntaxique pour les flux de travail Nextflow pendant l'exécution. Pour de plus amples informations, veuillez consulter Spécifier les paramètres du moteur Nextflow.

  7. Paramètres d'entrée (facultatif) — Fournissez les paramètres d'entrée du flux de travail sous forme de fichier JSON ou de valeurs intégrées. Les paramètres requis sont définis par le modèle de paramètres du flux de travail. Pour de plus amples informations, veuillez consulter HealthOmics exécuter les entrées.

  8. ID de demande (facultatif, API et CLI uniquement) : fournissez un identifiant de demande unique pour chaque exécution. L'ID de demande est un jeton d'impuissance HealthOmics utilisé pour identifier les demandes dupliquées et ne démarrer l'exécution qu'une seule fois.

Démarrer une course à l'aide de la console

L'assistant Start Run comporte quatre étapes :

  1. Spécifier les détails de l'exécution

  2. Ajouter des valeurs de paramètres

  3. Ajouter un groupe d'exécution, un cache d'exécution et des balises

  4. Vérifiez et lancez l'exécution

Pour démarrer une course

  1. Ouvrez la HealthOmics console.

  2. Si nécessaire, ouvrez le volet de navigation de gauche (≡). Choisissez Runs.

  3. Choisissez Démarrer l'exécution.

Étape 1 : Spécifier les détails de l'exécution

Indiquez les paramètres suivants :

# Paramètre Obligatoire Description
1 Choisissez la source du flux de travail Obligatoire Choisissez Flux de travail personnel (flux de travail privés que vous possédez) ou Flux de travail partagé (flux de travail partagés avec vous).
2 ID du flux de travail Obligatoire Sélectionnez l'ID du flux de travail pour cette exécution.
3 Nom de la course Obligatoire (facultatif sur l'API et la CLI) Nom descriptif de cette exécution. 127 caractères maximum. Un ID d'exécution est généré automatiquement une fois le flux de travail exécuté.
4 Configuration Facultatif Choisissez une configuration pour spécifier les paramètres VPC (sous-réseaux, groupes de sécurité) pour la connectivité Internet et pour inclure les mappages de registres de conteneurs et les connexions aux référentiels Git. Ne peut pas être modifié après le début de l'exécution.
5 Priorité d'exécution Facultatif Définit la priorité d'une exécution dans un groupe d'exécutions. Plus le nombre est élevé, plus la priorité est élevée. Entiers uniquement, compris entre 0 et 1 000.
6 Type de stockage d'exécution Facultatif Choisissez Stockage dynamique (par défaut, recommandé) ou Stockage statique. Le stockage dynamique évolue à la hausse ou à la baisse pour chaque tâche. Le stockage statique fournit un montant fixe. Pour de plus amples informations, veuillez consulter Exécuter les types de stockage dans les HealthOmics flux de travail.
7 Exécutez la capacité de stockage Conditionnel Pour le stockage statique uniquement. Spécifiez le montant en GiB.
8 Sélectionnez la destination de sortie S3 Obligatoire L'emplacement Amazon S3 où les sorties d'exécution sont fournies. Format :s3://bucket/prefix/object.
9 ID de compte du propriétaire du bucket de sortie Facultatif Si votre compte ne possède pas le bucket de sortie, entrez l' Compte AWS ID du propriétaire du bucket.
10 Exécuter le mode de conservation des métadonnées Facultatif Choisissez Conserver les métadonnées d'exécution (par défaut) ou Supprimer automatiquement les plus anciennes. RETAINest la valeur par défaut ; dans ce mode, les métadonnées d'exécution HealthOmics ne sont pas supprimées. Pour de plus amples informations, veuillez consulter Exécuter le mode de rétention pour les HealthOmics courses.
11 Accès réseau Facultatif Choisissez Restricted (par défaut) ou Virtual Private Cloud (VPC). Pour de plus amples informations, veuillez consulter Réseau VPC.
12 Rôle de service Obligatoire Choisissez un rôle de service existant ou créez-en un nouveau. HealthOmics nécessite des autorisations pour Amazon S3 et KMS. Pour de plus amples informations, veuillez consulter Rôles de service pour AWS HealthOmics.

Choisissez Next pour passer à l'étape 2.

Étape 2 : ajouter des valeurs de paramètres

Sur cette page, entrez les valeurs des paramètres pour l'exécution ou sélectionnez les valeurs prédéfinies fournies par l'auteur du flux de travail.

Lorsque vous sélectionnez un flux de travail Nextflow pour démarrer l'exécution, des sections supplémentaires relatives aux paramètres du moteur Nextflow et aux profils Nextflow apparaissent en haut de cette étape. Pour plus de détails sur ces paramètres (valeurs prises en charge, comportement et priorité du profil), consultezSpécifier les paramètres du moteur Nextflow.

Exécuter les valeurs des paramètres

Fournissez les paramètres d'exécution. Vous pouvez télécharger un fichier JSON ou saisir les valeurs manuellement. Le fichier JSON contient le nom exact de chaque paramètre d'entrée et une valeur pour le paramètre.

HealthOmics prend en charge les types JSON suivants pour les valeurs de paramètres.

Type JSON Exemple de clé et de valeur Remarques
boolean « b » : vrai La valeur n'est pas entre guillemets, elle est entièrement en minuscules.
entier « i » :7 La valeur n'est pas entre guillemets.
number « f » :42,3 La valeur n'est pas entre guillemets.
chaîne « s » ="caractères » La valeur est entre guillemets. Utilisez le type chaîne pour les valeurs de texte et les URI. L'URI cible doit être le type d'entrée attendu.
array « a » : [1,2,3] La valeur n'est pas entre guillemets. Les membres du tableau doivent chacun avoir le type défini par le paramètre d'entrée.
objet « o » : {"gauche » « a », « droite » :1} Dans WDL, l'objet correspond à une paire, une carte ou une structure WDL

Pour plus d’informations, consultez HealthOmics exécuter les entrées et Gestion de la taille des paramètres d'exécution.

Choisissez Next pour passer à l'étape 3.

Étape 3 : ajouter un groupe d'exécution, un cache d'exécution et des balises

Tous les paramètres de cette page sont facultatifs.

# Paramètre Obligatoire Description
1 Exécuter un groupe Facultatif Sélectionnez un groupe d'exécution existant ou créez-en un nouveau. Les groupes d'exécution regroupent les exécutions par catégorie et par priorité et fixent un maximum de vCPU et de durée d'exécution. Pour de plus amples informations, veuillez consulter Utilisation de groupes d' HealthOmics exécution.
2 Exécuter le cache Facultatif Utilisez un cache d'exécution pour réutiliser les résultats des tâches terminées plutôt que de les recalculer. Pour de plus amples informations, veuillez consulter Configuration d'une exécution avec cache d'exécution à l'aide de la console.
3 Balises Facultatif Ajoutez jusqu'à 50 balises clé-valeur pour la recherche, le filtrage et le suivi des coûts.

Choisissez Next pour passer à l'étape 4.

Étape 4 : Vérifiez et lancez l'exécution

Passez en revue la configuration d'exécution de toutes les étapes précédentes. Pour modifier un paramètre, choisissez Modifier à côté de l'étape correspondante. Lorsque vous êtes prêt, choisissez Start run.

Démarrer une course à l'aide de l'API

Utilisez l'opération StartRun API pour créer et démarrer une exécution.

Commencez une course de base

L'exemple suivant indique l'ID du flux de travail, le rôle du service et l'URI de sortie. Cet exemple définit le mode de rétention surREMOVE. Pour plus d'informations sur le mode de rétention, consultezExécuter le mode de rétention pour les HealthOmics courses.

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --name "my-workflow-run" \ --retention-mode REMOVE

En réponse, vous obtenez le résultat suivant. Le uuid est propre à l'exécution et outputUri peut également être utilisé pour suivre l'endroit où les données de sortie sont écrites.

{ "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "id": "123456789", "uuid": "96c57683-74bf-9d6d-ae7e-f09b097db14a", "outputUri": "s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a", "status": "PENDING" }

Options d'API communes

Inclure un fichier de paramètres

Si le modèle de paramètres d'un flux de travail déclare des paramètres obligatoires, vous pouvez fournir un fichier JSON local contenant les entrées lorsque vous démarrez l'exécution d'un flux de travail. Le fichier JSON contient le nom exact de chaque paramètre d'entrée et une valeur pour le paramètre.

Référencez le fichier JSON d'entrée dans le en l' AWS CLI ajoutant --parameters file://<input_file.json> à votre start-run demande. Pour plus d'informations, consultez les types JSON pris en charge pour les valeurs des paramètres dans Étape 2 : ajouter des valeurs de paramètres etHealthOmics exécuter les entrées.

Fournir un identifiant de demande

Vous pouvez fournir un numéro unique requestId pour chaque course. L'ID de demande est un jeton d'impuissance HealthOmics utilisé pour intercepter les demandes dupliquées. Il ne démarrera pas une exécution si l'ID de demande est un double d'une exécution précédente.

Si vous utilisez une infrastructure (telle que des fonctions Lambda ou des fonctions par étapes) pour orchestrer les démarrages, la meilleure pratique consiste à fournir un identifiant de demande unique pour chaque demande. StartRun Cela garantit que si votre infrastructure lance par inadvertance une exécution déjà lancée, HealthOmics elle ne démarrera pas l'exécution dupliquée.

aws omics start-run \ --workflow-id workflow id \ ... \ --request-id "unique-request-id-12345"

Choisissez une version du flux de travail

Vous pouvez spécifier une version du flux de travail pour l'exécution. Si vous ne spécifiez aucune version, HealthOmics lance l'exécution avec la version du flux de travail par défaut.

aws omics start-run \ --workflow-id workflow id \ ... \ --workflow-version-name '1.2.1'

Remplacer le type de stockage d'exécution

Vous pouvez remplacer le type de stockage d'exécution par défaut défini dans le flux de travail.

aws omics start-run \ --workflow-id workflow id \ ... \ --storage-type STATIC \ --storage-capacity 2400

Permettre le stockage éphémère

Pour activer le stockage éphémère pour une course, définissez ce paramètre sur --scratch-storage-mode le LOCAL moment où vous commencez l'exécution. HealthOmics monte un volume de stockage local dédié /tmp pour chaque instance de tâche de flux de travail.

aws omics start-run \ --workflow-id workflow-id \ --role-arn arn:aws:iam::123456789012:role/OmicsServiceRole \ --output-uri s3://amzn-s3-demo-bucket/output-folder/ \ --parameters file:///path/to/parameters.json \ --scratch-storage-mode LOCAL

Pour désactiver le stockage éphémère pour une exécution spécifique (par exemple, pour isoler un échec), définissez sur--scratch-storage-mode. SHARED

Pour de plus amples informations, veuillez consulter Stockage éphémère pour HealthOmics les tâches du flux de travail.

Pour les paramètres du moteur Nextflow (version du moteur, profils, analyseur syntaxique), consultez. Spécifier les paramètres du moteur Nextflow

Spécifier les paramètres du moteur Nextflow

Pour les flux de travail Nextflow, vous pouvez transmettre une engineSettings carte dans la demande d'StartRunAPI pour contrôler le comportement du moteur sans modifier le code source de votre flux de travail. Sur la console, ces paramètres sont disponibles à l'étape 2 : Ajouter des valeurs de paramètres dans une section distincte qui apparaît pour les flux de travail Nextflow.

Note

Les paramètres du moteur s'appliquent uniquement aux flux de travail Nextflow. Si vous spécifiez les paramètres du moteur pour les flux de travail WDL ou CWL dans l'API ou la CLI, ils sont ignorés en silence et ne sont pas disponibles dans les réponses. GetRun

Clés prises en charge

# Clé Valeurs valides Comportement Prise en charge des versions
1 engineVersion "22.04.0"(ou"22.04"), "23.10.0" (ou "23.10""24.10"), "24.10.8" "25.10.0" (ou"25.10"), "26.04.0" (ou"26.04") Épingle la version Nextflow pour l'exécution. Remplace la version détectée à partir de. nextflow.config Les versions complètes et courtes sont acceptées. Toutes les versions de Nextflow
2 syntaxVersion "v1"(Analyseur classique), "v2" (Analyseur syntaxique strict) Sélectionne l'analyseur syntaxique. v26.04 et versions ultérieures. Les versions antérieures ne sont prises en charge que"v1".
3 outputFormat "json", "text", "none" Définit le format du stdout/stderr résumé du moteur. v26.04 et versions ultérieures (ignorées dans les versions antérieures).
4 agentMode "true", "false" Contrôle le mode agent Nextflow. v26.04 et versions ultérieures (ignorées dans les versions antérieures).
5 profile Comma-separated noms de profil, par exemple "test,docker" Active les profils Nextflow. Pour de plus amples informations, veuillez consulter Profils Nextflow. Toutes les versions de Nextflow

Épinglage de la version du moteur Nextflow

Vous pouvez sélectionner une version du moteur Nextflow spécifique pour exécuter votre flux de travail, ce qui permet une migration contrôlée entre les versions du moteur. Le remplacement de version d'exécution garantit que même lorsqu'une définition de flux de travail spécifie une version par le biais de sa configuration ou de son profil, la version du moteur que vous spécifiez au moment de l'exécution est prioritaire. Cela vous permet de tester le même flux de travail sur plusieurs versions du moteur sans modifier le code source du flux de travail.

Versions prises en charge : 22.04.0 (ou 22.04), 23.10.0 (ou 23.10), 24.10.8 (ou 24.10), 25.10.0 (ou 25.10) et 26.04.0 (ou 26.04). Les versions complètes et courtes sont acceptées.

API et CLI

Utilisez la engineVersion clé pour --engine-settings :

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --engine-settings '{"engineVersion":"26.04"}'

Console

DansÉtape 2 : ajouter des valeurs de paramètres, sélectionnez la version dans le menu déroulant Version du moteur dans la section des paramètres du moteur Nextflow.

Profils Nextflow

Les profils Nextflow sont des ensembles nommés de paramètres d'exécution définis dans votre flux de nextflow.config travail. Vous pouvez activer un ou plusieurs profils lors de l'exécution pour appliquer des paramètres spécifiques à l'environnement (par exemple, développement, test ou production) sans modifier le code source du flux de travail.

API et CLI

Utilisez la profile clé pour entrer--engine-settings. Spécifiez plusieurs profils sous forme de liste séparée par des virgules :

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --engine-settings '{"profile":"test,docker"}'

Console

DansÉtape 2 : ajouter des valeurs de paramètres, la section des profils Nextflow apparaît sous les paramètres du moteur. Sélectionnez un ou plusieurs profils dans le menu déroulant Sélectionner les profils. La console affiche l'ordre des applications de profil. Pour supprimer un profil, cliquez sur le signe × à côté de son nom.

Ordre de demande de profil

Lorsque vous spécifiez plusieurs profils, l'ordre des applications dépend de la version du moteur Nextflow et de l'analyseur syntaxique :

  • Nextflow v26.04 et versions ultérieures avec l'analyseur syntaxique strict (v2) — Les profils sont appliqués dans l'ordre spécifié dans la profile valeur (de gauche à droite) ou dans votre ordre de sélection sur la console. Les profils ultérieurs remplacent les précédents en cas de conflit de paramètres.

  • Versions de Nextflow antérieures à v26.04, v26.04 et versions ultérieures avec l'ancien analyseur (v1) : les profils sont appliqués dans l'ordre défini dans le nextflow.config fichier, quel que soit l'ordre spécifié dans la demande d'API ou dans la sélection de la console.

Priorité de configuration

Nextflow résout les paramètres dans l'ordre suivant, les couches ultérieures remplaçant les précédentes :

  1. nextflow.configdéfauts

  2. Profils Nextflow sélectionnés

  3. Fichier de valeurs prédéfinies

  4. Run-time remplacements de paramètres

Note

Recommandation — Pour garantir un comportement cohérent de l'application de profil entre les exécutions, épinglez la version du moteur Nextflow à l'aide de la engineVersion clé de l'API ou de la version du moteur sur la console.

Réseau VPC

Vous pouvez exécuter des flux de travail dans votre Virtual Private Cloud (VPC), ce qui permet d'accéder à l'Internet public, au trafic interrégional et à la communication avec les ressources de votre VPC.

Pour activer le réseau VPC :

  1. Créez une configuration qui spécifie les sous-réseaux et les groupes de sécurité VPC.

  2. Lorsque vous lancez une exécution à l'aide de la console, définissez l'accès réseau à Virtual Private Cloud (VPC) et sélectionnez votre configuration à l'étape 1.

  3. Lorsque vous lancez une exécution à l'aide de l'API, utilisez --networking-mode VPC et référencez votre configuration avec--configuration-name.

Pour de plus amples informations, veuillez consulter Connecter HealthOmics des flux de travail à un VPC.