Visão geral da interface - AWS Step Functions

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á.

Visão geral da interface

O Workflow Studio for AWS Step Functions é um designer de fluxo de trabalho visual de baixo código que permite criar fluxos de trabalho sem servidor por meio da orquestração. Serviços da AWS Com o recurso de arrastar e soltar, o Workflow Studio facilita a criação, a edição e a visualização dos protótipos de fluxo de trabalho. O Workflow Studio também oferece um editor de código integrado para escrever e editar definições de fluxo de trabalho usando Amazon States Language (ASL) no console do Step Functions.

Para ajudar você a criar e visualizar fluxos de trabalho, editar definições e gerenciar configurações, o Workflow Studio fornece três modos: Design, Código e Configuração. As seguintes seções descrevem esses casos em detalhes.

Modo de design

O modo Design do Workflow Studio fornece uma interface gráfica para visualizar fluxos de trabalho à medida que você cria protótipos. A imagem a seguir mostra os diferentes componentes disponíveis no modo Design.


            Modo design do Workflow Studio. Esse modo contém vários componentes, como o navegador de estados à esquerda, a tela no meio, o painel Inspector à direita da tela e a ajuda contextual no painel mais à direita. A imagem mostra as opções de configuração no painel Inspector para uma função do Lambda.
  1. Botões de modo — alterne entre os modos Design, Código e Configuração do Workflow Studio usando os botões de modo. Você não pode alternar entre os modos se o JSON na definição de ASL do fluxo de trabalho for inválido.

  2. O Navegador de estados contém as três guias seguintes:

    • A guia Ações fornece uma lista de AWS APIs que você pode arrastar e soltar no gráfico do fluxo de trabalho na tela. Cada ação representa um estado Tarefa.

    • A guia Fluxo fornece uma lista de estados de fluxo que você pode arrastar e soltar no gráfico do fluxo de trabalho na tela.

    • A guia Padrões fornece vários ready-to-use blocos de construção reutilizáveis que você pode usar em diversos casos de uso. Por exemplo, você pode usar esses padrões para processar dados de forma iterativa em um bucket do Amazon S3.

  3. O Canvas é onde você arrasta e solta estados no gráfico do fluxo de trabalho, altera a ordem dos estados e seleciona estados para configurar ou visualizar.

  4. O painel Inspector é onde você pode visualizar e editar as propriedades de qualquer ação selecionada na tela. Ative o botão Definição para visualizar o código do Amazon States Language para o fluxo de trabalho, com o estado atualmente selecionado destacado.

  5. Os links de Informações abrem um painel com informações contextuais quando você precisa de ajuda. Esses painéis também incluem links para tópicos relacionados na documentação do Step Functions.

  6. Barra de ferramentas de design — contém um conjunto de botões para realizar ações comuns, como desfazer, excluir e ampliar.

  7. Botões utilitários — um conjunto de botões para realizar tarefas, como salvar fluxos de trabalho ou exportar definições de ASL em um arquivo JSON ou YAML.

Navegador de estados

O navegador de estados é onde você seleciona os estados para arrastar e soltar no gráfico do fluxo de trabalho. A guia Ações fornece uma lista de AWS APIs e a guia Fluxo fornece uma lista dos estados de fluxo. Embora a guia Padrões forneça vários ready-to-use blocos de construção reutilizáveis que você pode usar em vários casos de uso. Você pode pesquisar todos os estados no Navegador de Estados usando a caixa de pesquisa na parte superior.


            Componente da interface do navegador de estados do Step Functions Workflow Studio. A imagem mostra as três guias disponíveis no navegador de estados: Ações, Fluxo e Padrões.

Há sete estados de fluxo que você pode usar para direcionar e controlar o fluxo de trabalho. Todos eles recebem entrada do estado anterior e muitos permitem filtrar a entrada do estado anterior e a saída para o estado seguinte. Os estados de fluxo são:

  • Choice: adicione uma escolha entre ramificações de execução ao fluxo de trabalho. Na guia Configuração do Inspector, você pode configurar regras para determinar para qual estado o fluxo de trabalho fará a transição.

  • Paralelo: adicione ramificações paralelas de execução ao fluxo de trabalho.

  • Mapa: itere etapas dinamicamente para cada elemento de uma matriz de entrada. Ao contrário de um estado de fluxo Parallel, um estado Map executará as mesmas etapas para várias entradas de uma matriz na entrada de estado.

  • Pass: permite que você passe a entrada para a saída. (Opcional) Você pode adicionar dados fixos na saída.

  • Aguardar: faça com que o fluxo de trabalho seja pausado por um determinado período de tempo ou até uma hora ou data especificadas.

  • Succeed: interrompe o fluxo de trabalho com sucesso.

  • Fail: interrompe o fluxo de trabalho com uma falha.

Canvas

Depois de escolher um estado para adicionar ao fluxo de trabalho, arraste-o para a tela e solte-o no gráfico do fluxo de trabalho. Você também pode arrastar e soltar estados para movê-los para lugares diferentes no fluxo de trabalho. Se o fluxo de trabalho for complexo, talvez não seja possível visualizar tudo no painel da tela. Use os controles na parte superior da tela para aumentar ou diminuir o zoom. Para visualizar diferentes partes de um gráfico do fluxo de trabalho, é possível arrastar o gráfico do fluxo de trabalho na tela.

Arraste um estado do fluxo de trabalho da guia Ações ou Fluxo e solte-o no fluxo de trabalho. Uma linha mostra onde ela será colocada no fluxo de trabalho. O novo estado do fluxo de trabalho foi adicionado ao fluxo de trabalho e o código foi gerado automaticamente.


            Tela do Workflow Studio

Para alterar a ordem de um estado, é possível arrastá-lo para um local diferente no fluxo de trabalho.


            Arrastar e soltar do Workflow Studio

Inspector

Você pode configurar qualquer estado que você adicionar ao fluxo de trabalho. Escolha o estado que deseja configurar e você verá opções de configuração no painel Inspector. Para ver a definição de ASL gerada automaticamente para o código de fluxo de trabalho, ative a opção Definição. A definição de ASL associada ao estado que você selecionou aparecerá destacada.


            Painel de configuração do inspetor do Workflow Studio

            Painel de definição do inspetor do Workflow Studio

Modo de código

O modo Código do Workflow Studio fornece um editor de código integrado para visualizar, escrever e editar a definição da Amazon States Language (ASL) dos fluxos de trabalho no console do Step Functions. A imagem a seguir mostra os diferentes componentes disponíveis no modo Código.


          Modo Código do Step Functions Workflow Studio. Esse modo mostra um exemplo de uma definição de fluxo de trabalho e uma renderização em tempo real do gráfico de fluxo de trabalho com base na definição.
  1. Botões de modo — alterne entre os modos Design, Código e Configuração do Workflow Studio usando os botões de modo. Você não pode alternar entre os modos se o JSON na definição de ASL do fluxo de trabalho for inválido.

  2. O Editor de código é onde você escreve e edita a definição da ASL dos fluxos de trabalho no Workflow Studio. O editor de código também fornece recursos, como destaque de sintaxe e preenchimento automático.

  3. Painel de visualização gráfica — Mostra uma visualização gráfica em tempo real do fluxo de trabalho.

  4. Botões utilitários — um conjunto de botões para realizar tarefas, como salvar fluxos de trabalho ou exportar definições de ASL em um arquivo JSON ou YAML.

  5. Barra de ferramentas de código — Contém um conjunto de botões para realizar ações comuns, como desfazer uma ação ou formatar o código.

  6. Barra de ferramentas do gráfico — Contém um conjunto de botões para realizar ações comuns, como ampliar e reduzir o gráfico do fluxo de trabalho.

Editor de código

O editor de código fornece uma experiência semelhante à do IDE para escrever e editar definições de fluxo de trabalho usando JSON no Workflow Studio. O editor de código inclui vários recursos, como destaque de sintaxe, sugestões de preenchimento automático, validação de definição da ASL e exibição de ajuda contextual. Conforme você atualiza a definição do fluxo de trabalho, a Painel de visualização gráfica renderiza um gráfico em tempo real do fluxo de trabalho. Você também pode ver o gráfico de fluxo de trabalho atualizado no Modo de design.

Se você selecionar um estado no painel Modo de design ou no painel de visualização gráfica, a definição de ASL desse estado aparecerá destacada no editor de código. A definição de ASL do fluxo de trabalho é atualizada automaticamente se você reordenar, excluir ou adicionar um estado no modo Design ou no painel de visualização gráfica.


            Componentes do Step Functions Workflow Studio

Coloque o cursor sobre qualquer campo na definição do fluxo de trabalho para ver a ajuda contextual como uma dica de ferramenta.


            Step Functions Workflow Studio

As sugestões de preenchimento automático exibem trechos de código dos campos ou estados que você pode incluir nos fluxos de trabalho. Para ver uma lista de campos que você pode incluir em um estado específico, pressione Ctrl+Space. Para gerar um trecho de código para um novo estado no fluxo de trabalho, pressione Ctrl+Space após a definição do estado atual. Você também pode pressionar F1 para exibir uma lista de comandos disponíveis.


            Componentes do Step Functions Workflow Studio

Painel de visualização gráfica

As visualizações de gráfico permitem que você veja a aparência do fluxo de trabalho no formato gráfico. Quando você escreve as definições de fluxo de trabalho no Editor de código do Workflow Studio, o painel de visualização gráfica renderiza um gráfico em tempo real do fluxo de trabalho. Conforme você reordena, exclui ou duplica um estado no painel de visualização gráfica, a definição do fluxo de trabalho no editor de código é atualizada automaticamente. Da mesma forma, à medida que você atualiza as definições de fluxo de trabalho, reordena, exclui ou adiciona um estado no editor de código, a visualização é atualizada automaticamente.

Se o JSON na definição da ASL do fluxo de trabalho for inválido, o painel de visualização gráfica pausará a renderização e exibirá uma mensagem de status na parte inferior do painel.

Modo de configuração

O modo Configuração do Workflow Studio permite gerenciar a configuração das máquinas de estado. Nesse modo, você pode especificar detalhes, como nome e tipo da máquina de estado, permissões do IAM e configuração de registro em log da máquina de estado. Outras configurações adicionais que você pode especificar nesse modo incluem habilitar o AWS X-Ray rastreamento e publicar uma versão ao criar a máquina de estado. Depois de criar a máquina de estado, você pode editar todas as opções de configuração da máquina de estado, exceto o nome e o tipo da máquina de estado. A imagem a seguir mostra algumas das configurações que você pode especificar no modo Configuração.


         Configurações de máquina de estado que podem ser especificadas no modo Configuração.
Gerenciar a configuração da máquina de estado

Para gerenciar a configuração da máquina de estado, faça o seguinte:

  1. Insira um nome para a máquina de estado na caixa Nome da máquina de estado.

    dica

    Como alternativa, escolha o ícone de edição ao lado do nome padrão da máquina de estado de MyStateMachine. Em Configuração da máquina de estado, especifique um nome.

    Importante

    Você não pode editar o nome da máquina de estado depois de criá-la.

  2. Em Tipo, escolha um tipo de máquina de estado Padrão ou Expresso. Para obter mais informações sobre tipos de máquinas de estado, consulte Comparação entre os fluxos de trabalho padrão e expresso.

    Importante

    Você não pode editar o tipo da máquina de estado depois de criá-la.

  3. Em Permissões, selecione o perfil do IAM a ser usado como perfil de execução para a máquina de estado.

    • Criar novo perfil (recomendado): se você selecionar essa opção, o Step Functions criará automaticamente um perfil de execução para as máquinas de estado com os privilégios mínimos necessários ao criar as máquinas de estado. Essas funções do IAM geradas automaticamente são válidas para Região da AWS as quais você cria a máquina de estado.

      dica

      Para revisar as permissões que o Step Functions gerará automaticamente para a máquina de estado, escolha Revisar permissões geradas automaticamente.

      nota

      Se você excluir o perfil do IAM criado pelo Step Functions, não será possível recriá-lo posteriormente. Da mesma forma, se você modificar a função (por exemplo, removendo o Step Functions das entidades principais na política do IAM), o Step Functions não poderá restaurar as configurações originais dela posteriormente.

    • Escolha um perfil existente: crie o próprio perfil do IAM para a máquina de estado e, em seguida, escolha-o entre as opções listadas abaixo Escolha um perfil existente. Certifique-se de que a política do perfil inclua as permissões que você gostaria que a máquina de estado assumisse.

      Para obter informações sobre a criação de políticas do IAM, consulte Criação de políticas do IAM, no Manual do usuário do IAM.

    • Inserir um ARN de função: especifique o nome do recurso da Amazon (ARN) de um perfil do IAM existente a ser usado para essa máquina de estado. Por exemplo, arn:aws:iam::123456789012:role/service-role/StepFunctions-WorkflowStudio-role-777f4027.

  4. Em Registro em log, defina o nível de log para a máquina de estado. O Step Functions registra os eventos do histórico de execução com base na seleção. Você pode selecionar uma das seguintes opções:

    • TODOS: todos os tipos de eventos são registrados.

    • ERRO: Todos os tipos de eventos de erro são registrados, como TaskFailed e. ExecutionFailed

    • FATAL: Todos os tipos de eventos de erro fatal são registrados, como ExecutionAborted e. ExecutionFailed

    • DESLIGADO: nenhum tipo de evento é registrado.

    Para mais informações sobre níveis de log, consulte Níveis de log.

  5. Em Configuração adicional, defina uma ou mais das seguintes configurações opcionais:

    • Ativar rastreamento de X-Ray: escolha essa caixa de seleção para que o Step Functions envie rastreamentos de X-Ray para execuções de máquinas de estado, mesmo quando um ID de rastreamento não for passado por um serviço upstream. Para ter mais informações, consulte AWS X-Ray e Step Functions.

    • Publicar versão na criação: uma versão é um snapshot numerado e imutável de uma máquina de estado que você pode executar. Escolha essa caixa de seleção para publicar uma versão da máquina de estado ao criar a máquina de estado. O Step Functions publica a versão 1 como a primeira revisão da máquina de estado.

      Para obter mais informações sobre versões, consulte Versões de máquina de estado.

    • Adicionar nova tag: escolha esta caixa para adicionar tags à máquina de estado. Adicionar tags pode ajudar a monitorar e gerenciar os custos associados aos recursos, além de fornecer melhor segurança nas políticas do IAM. Para obter mais informações sobre tags, consulte Marcação no Step Functions.

  6. Escolha Criar.

  7. Na caixa de diálogo Confirmar criação do perfil, selecione Confirmar para continuar.

    Você também pode clicar em Exibir configurações da função para retornar ao modo Configurar.

Atalhos de teclado

O Workflow Studio dá suporte aos seguintes atalhos de teclado:

Atalho de teclado Função
Shortcuts for the Code mode
Ctrl+space Auto-complete suggestions
F1 Display a list of available commands
Common shortcuts for the Design and Code modes
Ctrl+Z Undo the last operation
Ctrl+Shift+Z Redo the last operation
Alt+C Center the workflow in the canvas
Backspace Remove all selected states
Delete Remove all selected states
Ctrl+D Duplicate selected state