View a markdown version of this page

Comece uma corrida em HealthOmics - AWS HealthOmics

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Comece uma corrida em HealthOmics

Ao iniciar uma execução, você especifica os recursos que são HealthOmics alocados para a execução. As seguintes configurações estão disponíveis:

  1. Local de saída — Especifique um URI do Amazon S3 em que os arquivos de saída da execução sejam armazenados. Se você executar um grande volume de fluxos de trabalho simultaneamente, use URIs de saída do Amazon S3 separados para cada fluxo de trabalho para evitar a limitação do bucket. Para obter mais informações, consulte Organizar objetos usando prefixos no Guia do usuário do Amazon S3 e Dimensionar conexões de armazenamento horizontalmente no whitepaper Otimizando o desempenho do Amazon S3.

  2. Função de serviço — especifique uma função de serviço do IAM que conceda HealthOmics permissões para acessar os recursos necessários para a execução. Opcionalmente, o console pode criar a função de serviço para você. Para obter mais informações, consulte Funções de serviço para AWS HealthOmics.

  3. Executar armazenamento (opcional, o padrão é Dinâmico) — especifique o tipo de armazenamento em execução e a quantidade de armazenamento (para armazenamento estático). Para garantir o isolamento e a segurança dos dados, HealthOmics provisiona o armazenamento no início de cada execução e o desprovisiona no final da execução. Para obter mais informações, consulte Execute tipos de armazenamento em HealthOmics fluxos de trabalho.

  4. Prioridade de execução (opcional) — Atribua uma prioridade à execução. A forma como a prioridade afeta a execução depende de a execução estar associada a um grupo de corridas. Para obter mais informações, consulte Prioridade de execução.

  5. Versão do fluxo de trabalho (opcional) — Selecione uma versão específica do fluxo de trabalho para a execução. Se você não especificar uma versão, HealthOmics inicia a versão padrão do fluxo de trabalho.

  6. Configurações do mecanismo Nextflow (opcional, somente Nextflow) — Especifique as configurações do mecanismo, como analisador de versão e sintaxe para fluxos de trabalho do Nextflow durante o tempo de execução. Para obter mais informações, consulte Especifique as configurações do mecanismo Nextflow.

  7. Parâmetros de entrada (opcional) — Forneça os parâmetros de entrada do fluxo de trabalho como um arquivo JSON ou valores embutidos. Os parâmetros necessários são definidos pelo modelo de parâmetros do fluxo de trabalho. Para obter mais informações, consulte HealthOmics entradas de execução.

  8. ID da solicitação (opcional, somente API e CLI) — Forneça uma ID de solicitação exclusiva para cada execução. O ID da solicitação é um token de idempotência HealthOmics usado para identificar solicitações duplicadas e iniciar a execução somente uma vez.

Iniciando uma corrida usando o console

O assistente Start Run tem quatro etapas:

  1. Especifique os detalhes da execução

  2. Adicionar valores de parâmetros

  3. Adicionar grupo de execução, cache de execução e tags

  4. Revise e comece a executar

Para começar uma corrida

  1. Abra o console do HealthOmics .

  2. Se necessário, abra o painel de navegação esquerdo (≡). Selecione Execuções.

  3. Escolha Iniciar execução.

Etapa 1: especificar os detalhes da execução

Forneça as seguintes configurações:

# Configuração Obrigatório Description
1 Escolha a fonte do fluxo de trabalho Obrigatório Escolha Fluxo de trabalho próprio (fluxos de trabalho privados que você possui) ou Fluxo de trabalho compartilhado (fluxos de trabalho compartilhados com você).
2 ID do fluxo de trabalho Obrigatório Selecione o ID do fluxo de trabalho para essa execução.
3 Nome da execução Obrigatório (opcional em API e CLI) Um nome descritivo para essa corrida. Máximo de 127 caracteres. Uma ID de execução é gerada automaticamente quando o fluxo de trabalho é executado.
4 Configuração Opcional Escolha uma configuração para especificar as configurações de VPC (sub-redes, grupos de segurança) para conectividade com a Internet e incluir mapeamentos de registro de contêineres e conexões de repositórios Git. Não pode ser alterado após o início da execução.
5 Prioridade de execução Opcional Define a prioridade de uma execução em um grupo de execução. Um número maior significa uma prioridade maior. Somente números inteiros, no intervalo de 0 a 1.000.
6 Execute o tipo de armazenamento Opcional Escolha Armazenamento dinâmico (padrão, recomendado) ou Armazenamento estático. O armazenamento dinâmico aumenta e diminui por tarefa. O armazenamento estático fornece uma quantidade fixa. Para obter mais informações, consulte Execute tipos de armazenamento em HealthOmics fluxos de trabalho.
7 Execute a capacidade de armazenamento Condicional Somente para armazenamento estático. Especifique o valor em GiB.
8 Selecione o destino de saída S3 Obrigatório O local do Amazon S3 onde os resultados de execução são entregues. Formato: s3://bucket/prefix/object.
9 ID da conta do proprietário do bucket de saída Opcional Se sua conta não for proprietária do bucket de saída, insira o Conta da AWS ID do proprietário do bucket.
10 Execute o modo de retenção de metadados Opcional Escolha Reter metadados de execução (padrão) ou Remover os mais antigos automaticamente. RETAINé o valor padrão; nesse modo, HealthOmics não exclui os metadados de execução. Se você escolherREMOVE, exclui HealthOmics permanentemente os metadados de execução mais antigos quando a contagem de execuções atingir o máximo. Para obter mais informações, consulte Execute o modo de retenção para HealthOmics execuções.
11 Acesso à rede Opcional Escolha Restrito (padrão) ou Virtual Private Cloud (VPC). Para obter mais informações, consulte Rede VPC.
12 Perfil de serviço Obrigatório Escolha uma função de serviço existente ou crie uma nova. HealthOmics exige permissões para Amazon S3 e KMS. Para obter mais informações, consulte Funções de serviço para AWS HealthOmics.

Escolha Avançar para prosseguir para a Etapa 2.

Etapa 2: adicionar valores de parâmetros

Nessa página, insira os valores dos parâmetros para a execução ou selecione valores predefinidos fornecidos pelo autor do fluxo de trabalho.

Quando você seleciona um fluxo de trabalho do Nextflow para iniciar a execução, seções adicionais para as configurações do mecanismo Nextflow e os perfis do Nextflow aparecem na parte superior desta etapa. Para obter detalhes completos sobre essas configurações (valores suportados, comportamento e precedência de perfil), consulteEspecifique as configurações do mecanismo Nextflow.

Executar valores de parâmetros

Forneça os parâmetros de execução. Você pode fazer upload de um arquivo JSON ou inserir manualmente os valores. O arquivo JSON contém o nome exato de cada parâmetro de entrada e um valor para o parâmetro.

HealthOmics oferece suporte aos seguintes tipos de JSON para valores de parâmetros.

Tipo JSON Exemplo de chave e valor Observações
booleano “b”: verdadeiro O valor não está entre aspas e está tudo em minúsculas.
integer “eu”: 7 O valor não está entre aspas.
número “f”: 42,3 O valor não está entre aspas.
string “s”: “caracteres” O valor está entre aspas. Use o tipo string para valores de texto e URIs. O destino do URI deve ser o tipo de entrada esperado.
array “a”: [1,2,3] O valor não está entre aspas. Cada membro da matriz deve ter o tipo definido pelo parâmetro de entrada.
objeto “o”: {"left” :"a”, “right” :1} Na WDL, o objeto é mapeado para WDL Pair, Map ou Struct

Para obter mais informações, consulte HealthOmics entradas de execução e Gerenciando o tamanho dos parâmetros de execução.

Escolha Avançar para prosseguir para a Etapa 3.

Etapa 3: Adicionar grupo de execução, cache de execução e tags

Todas as configurações nesta página são opcionais.

# Configuração Obrigatório Description
1 Grupo de corrida Opcional Selecione um grupo de execução existente ou crie um novo. Grupos de execução agrupam execuções por categoria e prioridade e definem vCPUs e tempo de execução máximos. Para obter mais informações, consulte Usando grupos de HealthOmics execução.
2 Executar cache Opcional Use um cache de execução para reutilizar os resultados de tarefas concluídas em vez de recalculá-los. Para obter mais informações, consulte Configurando uma execução com cache de execução usando o console.
3 Tags Opcional Adicione até 50 tags de valores-chave para pesquisa, filtragem e controle de custos.

Escolha Avançar para prosseguir para a Etapa 4.

Etapa 4: Revise e comece a executar

Revise a configuração de execução de todas as etapas anteriores. Para modificar uma configuração, escolha Editar ao lado da etapa relevante. Quando estiver pronto, escolha Iniciar execução.

Iniciando uma corrida usando a API

Use a operação StartRun da API para criar e iniciar uma execução.

Comece uma corrida básica

O exemplo a seguir especifica o ID do fluxo de trabalho, a função de serviço e o URI de saída. Este exemplo define o modo de retenção comoREMOVE. Para obter mais informações sobre o modo de retenção, consulteExecute o modo de retenção para HealthOmics execuções.

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

Em resposta, você obtém o seguinte resultado. O uuid é exclusivo da execução e, junto com ele, outputUri pode ser usado para rastrear onde os dados de saída são gravados.

{ "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" }

Opções comuns de API

Incluir um arquivo de parâmetros

Se o modelo de parâmetro de um fluxo de trabalho declarar quaisquer parâmetros necessários, você poderá fornecer um arquivo JSON local das entradas ao iniciar a execução de um fluxo de trabalho. O arquivo JSON contém o nome exato de cada parâmetro de entrada e um valor para o parâmetro.

Consulte o arquivo JSON de entrada no AWS CLI adicionando --parameters file://<input_file.json> à sua start-run solicitação. Para obter mais informações, consulte os tipos de JSON compatíveis para valores de parâmetros em Etapa 2: adicionar valores de parâmetros e. HealthOmics entradas de execução

Forneça um ID de solicitação

Você pode fornecer um exclusivo requestId para cada corrida. O ID da solicitação é um token de idempotência HealthOmics usado para capturar solicitações duplicadas. Não iniciará uma execução se o ID da solicitação for uma duplicata de uma execução anterior.

Se você usa infraestrutura (como funções do Lambda ou funções de etapa) para orquestrar o início da execução, a melhor prática é fornecer um ID de solicitação exclusivo para cada solicitação. StartRun Isso garante que, se sua infraestrutura iniciar inadvertidamente uma execução que já começou, HealthOmics não inicie a execução duplicada.

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

Escolha uma versão do fluxo de trabalho

Você pode especificar uma versão do fluxo de trabalho para a execução. Se você não especificar uma versão, HealthOmics inicie a execução com a versão padrão do fluxo de trabalho.

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

Substitua o tipo de armazenamento de execução

Você pode substituir o tipo de armazenamento de execução padrão que foi definido no fluxo de trabalho.

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

Habilitando o armazenamento efêmero

Para ativar o armazenamento temporário para uma execução, --scratch-storage-mode defina como LOCAL quando você iniciar a execução. HealthOmics monta um volume de armazenamento local dedicado em /tmp para cada instância de tarefa do fluxo de trabalho.

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

Para desativar o armazenamento temporário para uma execução específica (por exemplo, para isolar uma falha), defina como. --scratch-storage-mode SHARED

Para obter mais informações, consulte Armazenamento temporário para tarefas de fluxo de trabalho HealthOmics.

Para as configurações do mecanismo Nextflow (versão do mecanismo, perfis, analisador de sintaxe), consulte. Especifique as configurações do mecanismo Nextflow

Especifique as configurações do mecanismo Nextflow

Para fluxos de trabalho do Nextflow, você pode passar um engineSettings mapa na solicitação da StartRun API para controlar o comportamento do mecanismo sem modificar o código-fonte do fluxo de trabalho. No console, essas configurações estão disponíveis na Etapa 2: Adicionar valores de parâmetros como uma seção separada que aparece para fluxos de trabalho do Nextflow.

nota

As configurações do mecanismo se aplicam somente aos fluxos de trabalho do Nextflow. Se você especificar as configurações do mecanismo para fluxos de trabalho WDL ou CWL na API ou CLI, elas serão ignoradas silenciosamente e não estarão disponíveis nas respostas. GetRun

Chaves compatíveis

# Chave Valores válidos Comportamento Suporte à versão
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") Fixa a versão do Nextflow para a execução. Substitui a versão detectada em. nextflow.config Os formatos de versão completa e curta são aceitos. Todas as versões do Nextflow
2 syntaxVersion "v1"(Analisador legado), "v2" (Analisador de sintaxe estrita) Seleciona o analisador de sintaxe. v26.04 e versões posteriores. Somente versões anteriores são compatíveis"v1".
3 outputFormat "json", "text", "none" Define o formato do stdout/stderr resumo do mecanismo. v26.04 e versões posteriores (ignoradas nas versões anteriores).
4 agentMode "true", "false" Controla o modo de agente Nextflow. v26.04 e versões posteriores (ignoradas nas versões anteriores).
5 profile Comma-separated nomes de perfil, por exemplo "test,docker" Ativa os perfis do Nextflow. Para obter mais informações, consulte Perfis Nextflow. Todas as versões do Nextflow

Fixação da versão do mecanismo Nextflow

Você pode selecionar uma versão específica do mecanismo Nextflow para executar seu fluxo de trabalho, permitindo a migração controlada entre as versões do mecanismo. A substituição da versão em tempo de execução garante que, mesmo quando uma definição de fluxo de trabalho especifica uma versão por meio de sua configuração ou perfil, a versão do mecanismo que você especifica em tempo de execução tenha precedência. Isso permite que você teste o mesmo fluxo de trabalho em várias versões do mecanismo sem modificar o código-fonte do fluxo de trabalho.

Versões suportadas: 22.04.0 (ou 22.04), 23.10.0 (ou 23.10), 24.10.8 (ou 24.10), 25.10.0 (ou 25.10) e 26.04.0 (ou 26.04). Os formatos de versão completa e curta são aceitos.

API e CLI

Use a engineVersion chave em--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

EmEtapa 2: adicionar valores de parâmetros, selecione a versão no menu suspenso Versão do mecanismo na seção Configurações do mecanismo Nextflow.

Perfis Nextflow

Os perfis do Nextflow são conjuntos nomeados de configurações de execução definidas no seu fluxo de trabalho. nextflow.config Você pode ativar um ou mais perfis em tempo de execução para aplicar configurações específicas do ambiente (por exemplo, desenvolvimento, teste ou produção) sem modificar o código-fonte do fluxo de trabalho.

API e CLI

Use a profile chave em--engine-settings. Especifique vários perfis como uma lista separada por vírgulas:

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

EmEtapa 2: adicionar valores de parâmetros, a seção de perfis do Nextflow aparece abaixo das configurações do mecanismo. Selecione um ou mais perfis no menu suspenso Selecionar perfis. O console exibe a ordem dos aplicativos do perfil. Para remover um perfil, escolha o × ao lado do nome.

Ordem de aplicação do perfil

Quando você especifica vários perfis, a ordem do aplicativo depende da versão do mecanismo Nextflow e do analisador de sintaxe:

  • Nextflow v26.04 e posterior com o analisador de sintaxe estrito (v2) — Os perfis são aplicados na ordem especificada no profile valor (da esquerda para a direita) ou em sua ordem de seleção no console. Perfis posteriores substituem os anteriores devido a configurações conflitantes.

  • Versões do Nextflow anteriores à v26.04 e v26.04 e posteriores com o analisador legado (v1) — Os perfis são aplicados na ordem definida no nextflow.config arquivo, independentemente da ordem especificada na solicitação de API ou na seleção do console.

Precedência de configuração

O Nextflow resolve os parâmetros na seguinte ordem, com as camadas posteriores substituindo as anteriores:

  1. nextflow.configpadrões

  2. Perfis selecionados do Nextflow

  3. Arquivo de valores predefinidos

  4. Run-time substituições de parâmetros

nota

Recomendação — Para garantir um comportamento consistente do aplicativo de perfil em todas as execuções, fixe a versão do mecanismo Nextflow usando a engineVersion chave na API ou na versão do mecanismo no console.

Rede VPC

Você pode executar fluxos de trabalho em sua nuvem privada virtual (VPC), que permite acesso à Internet pública, tráfego entre regiões e comunicação com recursos em sua VPC.

Para habilitar a rede VPC:

  1. Crie uma configuração que especifique sub-redes VPC e grupos de segurança.

  2. Ao iniciar uma execução usando o console, defina o acesso à rede como Virtual Private Cloud (VPC) e selecione sua configuração na Etapa 1.

  3. Ao iniciar uma execução usando a API, use --networking-mode VPC e referencie sua configuração com--configuration-name.

Para obter mais informações, consulte Conectando HealthOmics fluxos de trabalho a uma VPC.