Saiba como começar a usar o Step Functions

Com o serviço do Step Functions, você pode orquestrar fluxos de trabalho complexos de aplicações. Para começar, você usará o Workflow Studio para criar e executar um fluxo de trabalho Hello World integrado. Você analisará a definição da Amazon States Language (ASL) gerada automaticamente no código. Por fim, você arrastará e soltará uma integração de serviços para fazer uma análise de sentimentos.

Após concluir este tutorial, você saberá como usar o Workflow Studio para criar, configurar, executar e atualizar fluxos de trabalho usando os modos Design e Código.

Duração estimada: 20 a 30 minutos

O que você desenvolverá

Sua primeira máquina de estado começará com estados de fluxo. Os estados de fluxo são usados para direcionar e controlar o fluxo de trabalho. Após aprender a executar o fluxo de trabalho, você adicionará uma Ação para integrar o serviço do Amazon Comprehend ao Estado de tarefa.

O diagrama a seguir mostra uma imagem completa da máquina de estado que você desenvolverá. Ao criar pela primeira vez a máquina de estado Hello World, ela não precisará de recursos adicionais para ser executada. O console do Step Functions criará todos os estados e um perfil do IAM com um único clique. Posteriormente, ao adicionar a integração de serviços, você precisará criar um perfil com uma política de permissão personalizada.

Etapa 1: Criar a máquina de estado

No Step Functions, os fluxos de trabalho são chamados de máquinas de estado. Usaremos ambos os termos de forma intercambiável. Os fluxos de trabalho conterão estados que atuam ou controlam o fluxo das máquinas de estado.

Visão geral do Workflow Studio

No Workflow Studio para o Step Functions, é possível arrastar e soltar visualmente estados em uma tela para criar fluxos de trabalho.

É possível adicionar e editar estados, configurar etapas, transformar resultados e configurar o tratamento de erros. A captura de tela a seguir mostra quatro áreas importantes da interface que você usará para criar as máquinas de estado.

Modos: o Workflow Studio fornece três modos de operação e usa como padrão o modo de design visual.

O navegador de estados contém as três seguintes guias:

O gráfico de tela e fluxo de trabalho é onde você arrasta e solta estados no gráfico do fluxo de trabalho, altera a ordem e seleciona estados para configurar e testar.

No painel do inspetor, é possível visualizar e editar as propriedades de qualquer ação selecionada na tela. Você pode ativar o botão Definição para mostrar o código do estado atualmente selecionado.

Visão geral da máquina de estado

O fluxo de trabalho Hello World começa com um estado de passagem que transmite a entrada para a saída, sem realizar o trabalho. Os estados de passagem podem ser usados para gerar uma saída JSON estática ou transformar a entrada JSON antes de passar os dados para o próximo estado. Os estados de passagem são úteis na construção e depuração de máquinas de estado.

O estado seguinte, um estado de escolha, usa os dados do IsHelloWorldExample para escolher a próxima ramificação do fluxo de trabalho. Se a primeira regra corresponder, o fluxo de trabalho será pausado em um estado de espera e executará duas tarefas em um estado paralelo antes de passar para um ponto de verificação e encerrar com êxito o fluxo de trabalho. Quando não há correspondência, o fluxo de trabalho assume como padrão o estado de falha antes de interromper a máquina de estado.

Os estados de espera são úteis quando você deseja adiar o início de outros trabalhos. Talvez seu fluxo de trabalho espere 30 segundos após a entrada de um pedido; assim, seu cliente terá tempo de perceber e corrigir um endereço de entrega incorreto, por exemplo.

Estados paralelos podem executar vários processos em seus dados. Talvez o fluxo de trabalho imprima um tíquete de pedido, atualize o inventário e aumente um relatório diário de vendas simultaneamente.

Exibir o código do fluxo de trabalho (ASL)

Sua primeira máquina de estado é bem detalhada, portanto, explore mais analisando o código.

As máquinas de estado são definidas usando a Amazon States Language (ASL), uma especificação de código aberto que descreve uma linguagem baseada em JSON para descrever as máquinas de estado de forma declarativa.

Como visualizar toda a definição da máquina de estado

Notou como a definição do estado é destacada na visualização do código?

Como ver o código no inspetor

Tente selecionar outros estados. Notou como o código da ASL para cada estado selecionado é exibido e destacado?

(Vamos finalmente) Criar a máquina de estado

Até agora, você estava trabalhando em um rascunho de sua máquina de estado. Nenhum recurso foi criado.

Como renomear e criar sua máquina de estado

Você receberá notificações de que sua máquina de estado e um novo perfil do IAM foram criados.

A opção de iniciar a máquina de estado será apresentada automaticamente. Faremos isso na próxima etapa.

Etapa 2: Iniciar a máquina de estado

Após a criação da máquina de estado, você poderá iniciar a execução do fluxo de trabalho.

Opcionalmente, os fluxos de trabalho recebem entradas que podem ser usadas no estado. Elas são enviadas para serviços integrados e passadas para o próximo estado.

A máquina de estado Hello World é independente e não precisa de entradas.

Como iniciar a máquina de estado

Analisar os detalhes de execução

Imediatamente após o início, você verá que os dois primeiros estados foram bem-sucedidos.

Após uma breve espera, o restante das transições de estado será executado para concluir o fluxo de trabalho.

Está se perguntando como o estado de escolha (Is Hello World Example?) decidiu migrar para o estado Wait for X Seconds?

A entrada de estado está em branco, mas a saída de estado contém o JSON que define o valor de IsHelloWorldExample como true.

Alterne da visualização do gráfico para a exibição de tabela para ver uma lista de estados por nome, tipo e status.

Há mais duas visualizações para explorar nesta página de Detalhes da execução: visualização do evento e visualização do estado.

A visualização do evento é uma visualização granular detalhada do fluxo de um estado para outro.

Expanda os primeiros eventos PassStateEntered e PassStateExited na tabela da visualização do evento para ver como o estado não recebe nenhuma entrada, atribui uma variável CheckpointCount chamada valor zero e produz a saída que você viu anteriormente.

Por fim, temos a visualização do estado, que é semelhante à exibição de tabela. Na tabela de visualização do estado, você pode expandir seletivamente os estados para ver somente as entradas e saídas de cada estado:

Etapa 3: Processar entradas externas

Definir o valor de IsHelloWorldExample como um valor constante no fluxo de trabalho não é realista. A máquina de estado deve responder a dados de entrada variáveis.

Nesta etapa, mostraremos como os dados JSON externos podem ser usados como entrada para seu fluxo de trabalho:

Remover entradas de codificação rígida

Primeiro, substitua o valor com codificação rígida na Saída do primeiro estado de passagem.

A saída de estado atualizada extrairá dados de entrada da variável $states reservada usando uma expressão JSONata. Esses valores serão transmitidos para o próximo estado como saída para se tornarem a entrada do próximo estado.

Executar o fluxo de trabalho atualizado com dados de entrada

Em seguida, execute o fluxo de trabalho e forneça dados de entrada externos como JSON.

A execução da sua máquina de estado deve esperar muito mais (20 segundos), mas, eventualmente, deverá ser bem-sucedida usando a entrada fornecida.

Na visualização do gráfico, analise a Entrada/Saída do primeiro estado de passagem. Observe como a entrada que você forneceu foi convertida em saídas. Além disso, confira a Entrada e saída de execução na parte superior da página de detalhes da execução. Ambos os locais mostram a entrada que você usou para iniciar a execução.

Analisar execuções do fluxo de trabalho

Agora que você executou seu fluxo de trabalho algumas vezes, revise os detalhes da execução para analisar as execuções do seu fluxo de trabalho.

Como analisar os detalhes da execução

Na guia Execuções, você verá uma lista de execuções, semelhante à seguinte captura de tela:

Uma observação final: os nomes de execução do fluxo de trabalho devem ser exclusivos e não podem ser reutilizados. Embora tenhamos sugerido um nome curto (hello001) neste tutorial, recomendamos usar uma convenção de nomenclatura que sempre será exclusiva para suas workloads de produção.

Etapa 4: Integrar um serviço

As máquinas de estado do Step Functions podem chamar mais de 220 serviços da AWS usando integrações do AWS SDK. Os serviços da AWS oferecem mais de 10 mil ações de API em potencial para suas máquinas de estado.

Nesta etapa, você integrará uma tarefa do Amazon Comprehend para análise de sentimentos a fim de processar a entrada da máquina de estado.

As integrações de serviços usam um dos três padrões de integração de serviços:

Para sua primeira integração, você usará o padrão de integração Resposta à solicitação (padrão).

Como funcionam as integrações?

Um estado de tarefa representa uma unidade de trabalho específica executada por uma máquina de estado. Em sua máquina de estado, todo trabalho é realizado por tarefas.

Uma tarefa normalmente executa o trabalho passando a entrada às ações de API de outros serviços, que então realizam seu próprio trabalho. Você pode especificar o desempenho de uma tarefa usando vários campos, incluindo: Credentials, Retry, Catch, TimeoutSeconds, e muito mais. Saiba mais sobre tarefas em Estado de tarefa do fluxo de trabalho.

Para usar as integrações do AWS SDK, especifique o nome do serviço e a API a ser chamada. Algumas integrações também exigem parâmetros.

Você pode usar a Amazon States Language para especificar uma ação da API da AWS no campo Recurso de um estado de tarefa. Opcionalmente, você pode adicionar um tipo de integração do serviço.

Para especificar uma ação de API, use o seguinte modelo de nome de recurso:

arn:aws:states:::aws-sdk:serviceName:apiAction.[serviceIntegrationPattern]

Exemplos de nomes de recursos

Quando o Step Functions chama outro serviço usando o estado Task, o padrão é Resposta à solicitação. Com o padrão de integração Resposta à solicitação, o Step Functions chama um serviço, recebe uma resposta e passa imediatamente para o próximo estado.

Etapa 4.1: Adicionar o estado de análise de sentimento

Etapa 4.2: Configurar o estado da análise de sentimentos

Após escolher as opções de preenchimento automático, você deve ter o seguinte JSON para os argumentos do seu estado:

{
    "LanguageCode": "en",
    "Text": "{% $states.context.Execution.Input.feedback_comment %}"
}

Etapa 4.3: Configurar uma política de identidade

Antes de executar o fluxo de trabalho, você precisa criar um perfil e uma política para permitir que a máquina de estado realize chamadas de API ao serviço externo.

Como criar um perfil do IAM para o Step Functions

Como adicionar uma política ao HelloWorldWorkflowRole do Amazon Comprehend

Se você revisar a política, verá que ela permite que todos os recursos realizem a ação "comprehend:DetectSentiment".

Como anexar o perfil do IAM à máquina de estado do Step Functions

Etapa 4.4: Executar a máquina de estado

Comece a executar sua máquina de estado com o seguinte JSON para entrada:

{
    "hello_world": false,
    "wait": 42,
    "feedback_comment" : "This getting started with Step Functions workshop is a challenge!"
}

User: arn:aws:sts::account-id:assumed-role/StepFunctions-MyStateMachine-role is not authorized
to perform: comprehend:DetectSentiment because no identity-based policy allows the comprehend:DetectSentiment
action (Service: Comprehend, Status Code: 400, Request ID: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111)
        

Pratique o que você aprendeu!

Antes de mergulhar em fluxos de trabalho mais complexos, pratique o que você aprendeu com as seguintes tarefas:

Para saber mais sobre os resultados da análise de sentimentos, consulte Amazon Comprehend: Sentimento.

Uma forma de pensar sobre a integração da Resposta à solicitação é que a resposta geralmente representa uma confirmação da solicitação. No entanto, em algumas integrações, como a análise de sentimentos, essa confirmação representa a conclusão da tarefa.

O principal ponto é que o estado Task não espera pela tarefa subjacente nas integrações de Resposta à solicitação. Para aguardar por uma resposta, você precisará explorar o padrão de integração do serviço Executar um serviço (.sync).

Limpar recursos.

Siga as seguintes etapas para limpar os recursos criados:

A máquina de estado e o perfil relacionado devem ser excluídos com sucesso.