Trabalhando com AWS Step Functions - AWS Kit de ferramentas para VS Code

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

Trabalhando com AWS Step Functions

Você pode usar o AWS Toolkit for Visual Studio Code (VS Code) para realizar várias operações com máquinas de estado.

Pré-requisitos

  • Verifique se o sistema atende aos pré-requisitos especificados em Instalar o kit de ferramentas para VS Code e instale o kit de ferramentas.

  • Antes de abrir o AWS Explorer, verifique se você configurou as credenciais.

Trabalhar com máquinas de estado no VS Code

Você pode usar o VS Code para interagir com máquinas de estado remotas e desenvolver máquinas de estado localmente em JSON ou YAML formatar. É possível criar ou atualizar máquinas de estado, identificar máquinas de estado existentes, executá-las e baixá-las. O VS Code também permite que você crie máquinas de estado com base em modelos e veja uma visualização da máquina de estado, além de fornecer trechos de código, preenchimento de código e validação de código.

Listar máquinas de estado existentes

Se já tiver criado máquinas de estado, você poderá visualizar uma lista delas:

  1. Abra o AWS Explorer.

  2. Selecione o Step Functions.

  3. Verifique se ele lista todas as máquinas de estado em sua conta.

    AWS Explorer menu showing regions and services, with LambdaStateMachine highlighted under Step Functions.

Baixar uma máquina de estado

Para baixar uma máquina de estado:

  1. No AWS Explorer, clique com o botão direito do mouse na máquina de estado que deseja baixar.

  2. Selecione Download (Baixar) e escolha o local onde deseja baixar a máquina de estado.

  3. Verifique se ela baixou corretamente.

    AWS Explorer menu showing LambdaStateMachine with Download Definition option highlighted.

Criar uma máquina de estado

Você mesmo pode criar uma nova máquina de estado ou pode usar um modelo. Para obter mais informações sobre como criar uma máquina de estado a partir de um modelo, consulte a seção State Machine Templates (Modelos de máquina de estado). Para criar uma nova máquina de estado:

  1. Crie um novo arquivo Amazon States Language (ASL) com sua definição de máquina de estado. Use o menu no canto inferior direito para defini-lo como Amazon States Language.

  2. Selecione Publish to Step Functions (Publicar no Step Functions).

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.
  3. Selecione Quick Create (Criação rápida), escolha uma função e nomeie sua máquina de estado.

    Quick Create option highlighted for creating a state machine with default settings.
    Dropdown menu showing execution role options, with ECSRole highlighted for selection.
    Dialog box prompting user to name their state machine, with input field and instructions.

Atualizar uma máquina de estado

Para atualizar uma máquina de estado:

  1. Edite o ASL arquivo com a definição da sua máquina de estado.

  2. Selecione Publish to Step Functions (Publicar no Step Functions).

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.
  3. Selecione Quick Update (Atualização rápida) e escolha a máquina de estado que deseja atualizar.

    Quick Update option highlighted in the Publish to AWS Step Functions menu.
    Dropdown menu showing state machine options for updating in us-east-1 region.

Executar uma máquina de estado

Como executar uma máquina de estado:

  1. No AWS Explorer, clique com o botão direito do mouse na máquina de estado que deseja executar.

  2. Forneça dados de entrada para a máquina de estado. Você pode tentar inseri-los de um arquivo ou inseri-los em uma caixa de texto.

  3. Inicie a máquina de estado e verifique se ela é executada com êxito.

    AWS Explorer menu showing LambdaStateMachine with Start Execution option highlighted.
    Start Execution interface for LambdaStateMachine with JSON input option and example.

Modelos de máquina de estado

Ao criar uma máquina de estado, você tem a opção de criá-la a partir de um modelo. O modelo contém uma definição de máquina de estado de exemplo com vários estados normalmente usados e fornece um ponto de partida. Para usar modelos de máquina de estado:

  1. Abra a paleta de comandos no VS Code.

  2. Selecione Criar uma máquina de estado do Step Functions do kit de ferramentas da AWS .

  3. Escolha o modelo que deseja usar.

    List of starter templates including Hello world, Retry failure, Wait state, and others.
  4. Escolha se você deseja usar o formato JSON ou o YAML modelo.

    Dropdown menu showing JSON and YAML options for selecting a template format.

Visualização gráfica de máquina de estado

As visualizações de gráfico permitem que você veja a aparência da sua máquina de estado no formato gráfico. Quando você cria uma visualização gráfica, outra guia se abre e exibe uma visualização da máquina JSON de estado ou. YAML Depois você poderá comparar a definição de máquina de estado que está gravando simultaneamente com sua visualização. À medida que você alterar a definição da máquina de estado, a visualização será atualizada.

nota

Para criar uma visualização de uma definição de máquina de estado, a definição deve estar aberta no editor ativo. Se você fechar ou renomear o arquivo de definição, a visualização será fechada.

Para criar uma visualização de gráfico de máquina de estado:

  1. Defina sua máquina de estado.

  2. Abra a paleta de comandos no VS Code.

  3. Para criar uma visualização, use o botão de visualização no canto superior direito ou escolha Gráfico renderizado da AWS .

    JSON code and graph visualization of Amazon States Language with choice state example.

Trechos de código

Os trechos de código permitem inserir seções curtas do código. Para usar trechos de código:

  1. Abra um arquivo e salve-o com a extensão .asl.json para JSON formatar ou .asl.yaml para YAML formatar.

  2. Crie uma nova máquina de estado com a propriedade States (Estados).

  3. Coloque o cursor dentro de States (Estados).

  4. Use a combinação de teclas Control + Space e selecione seu trecho de código preferido.

  5. Use Tab para percorrer a variável e os parâmetros no trecho de código.

  6. Teste os trechos de código Retry (Repetir) e Catch (Capturar) colocando o cursor dentro do estado relacionado.

    Code snippet for Lambda Task State with dropdown menu showing various state types.

Preenchimento e validação de código

Para ver como funciona o preenchimento de código:

  1. Crie vários estados.

  2. Coloque o cursor após uma propriedade Avançar ou Padrão. StartAt

  3. Use a combinação de teclas Control + Space para listar os preenchimentos disponíveis. É possível acessar propriedades adicionais usando Control + Space novamente, e será com base no valor Type de State.

  4. À medida que você trabalhar, a validação de código ocorrerá para:

    • Propriedades ausentes

    • Valores incorretos

    • Nenhum estado terminal

    • Estados inexistentes que forem indicados

    JSON code snippet showing state machine structure with task, choice, and default states.
    Code snippet showing AWS Lambda function properties with a tooltip describing the Catch property.