Ações do AWS Step Functions

Esta página fornece uma referência para as ações do AWS Step Functions disponíveis no catálogo de ações de automação de fluxo de trabalho. Use essas ações para iniciar, parar, reexecutar e inspecionar execuções e máquinas de estado do Step Functions a partir das definições do seu fluxo de trabalho.

Pré-requisitos

Antes de usar as ações do AWS Step Functions na automação de fluxo de trabalho, certifique-se de ter:

Uma conta da AWS com as permissões apropriadas.
Credenciais da AWS configuradas (credenciais de usuário do IAM, ARN da função do IAM ou credenciais de sessão).
As permissões do IAM necessárias para as operações do Step Functions.

Consulte Configurar credenciais da AWS para obter informações sobre como criar usuários e funções do IAM, e configurar credenciais da AWS estáticas e de sessão para integração com ações da AWS de automação de fluxo de trabalho.

Permissões IAM necessárias

As permissões necessárias dependem de quais ações do Step Functions o seu fluxo de trabalho chama. Use o exemplo abaixo como um modelo para uma política de privilégio mínimo que abrange todas as sete ações.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "states:StartExecution",
        "states:StopExecution",
        "states:RedriveExecution",
        "states:DescribeExecution",
        "states:ListExecutions",
        "states:DescribeStateMachine",
        "states:ListStateMachines"
      ],
      "Resource": "arn:aws:states:<region>:<account-id>:*"
    }
  ]
}

Importante

Substitua <region> e <account-id> por seus valores reais e restrinja o Resource a ARNs de máquina de estado ou de execução específicos, sempre que possível.

Iniciar uma execução do Step Functions

O identificador da ação é aws.stepFunctions.startExecution.

Inicia uma execução de uma máquina de estado do AWS Step Functions. Em caso de sucesso, retorna o executionArn da nova execução, que pode ser passado para aws.stepFunctions.describeExecution para consultar seu status.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS onde a máquina de estado está implantada.	`us-east-1`
stateMachineArn	Corda	Obrigatório. ARN da máquina de estado a ser executada.	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
nome	Corda	Opcional. Nome da execução. Deve ser exclusivo por máquina de estado. Gerado automaticamente como um UUID se omitido. Nas máquinas de estado `STANDARD` , reutilizar o nome de uma execução em andamento com uma entrada diferente retorna `ExecutionAlreadyExists` . Nas máquinas de estado `EXPRESS` , os nomes podem ser reutilizados imediatamente.	`incident-42`
entrada	Corda	Opcional. String JSON para passar como entrada para a execução.	`'{"instanceId": "i-0123456789abcdef0"}'`
traceHeader	Corda	Opcional. Cabeçalho de trace do X-Ray para propagar na execução.	`Root=1-5e1b2f1a-3c1a1a1a1a1a1a1a1a1a1a1a`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "executionArn", "expression": ".response.executionArn"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Resposta da API do AWS Step Functions. `{ "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42", "startDate": "2026-08-24T09:00:00.000Z" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a execução falhar ao iniciar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Resposta da API do AWS Step Functions.

{
  "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42",
  "startDate": "2026-08-24T09:00:00.000Z"
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a execução falhar ao iniciar.

null

em caso de sucesso.

O exemplo a seguir inicia uma execução de remediação e captura o ARN da execução para as etapas posteriores.

Exemplo de fluxo de trabalho
name: start-sfn-remediation description: 'Starts a Step Functions remediation execution' workflowInputs: arnRole: type: String stateMachineArn: type: String incidentId: type: String steps: - name: startRemediation type: action action: aws.stepFunctions.startExecution version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 stateMachineArn: ${{ .workflowInputs.stateMachineArn }} name: incident-${{ .workflowInputs.incidentId }} input: '{"incidentId": "${{ .workflowInputs.incidentId }}"}' selectors: - name: executionArn expression: '.response.executionArn'

Exemplo de fluxo de trabalho

name: start-sfn-remediation
description: 'Starts a Step Functions remediation execution'

workflowInputs:
  arnRole:
    type: String
  stateMachineArn:
    type: String
  incidentId:
    type: String

steps:
  - name: startRemediation
    type: action
    action: aws.stepFunctions.startExecution
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      stateMachineArn: ${{ .workflowInputs.stateMachineArn }}
      name: incident-${{ .workflowInputs.incidentId }}
      input: '{"incidentId": "${{ .workflowInputs.incidentId }}"}'
      selectors:
        - name: executionArn
          expression: '.response.executionArn'

Interromper uma execução do Step Functions

O identificador da ação é aws.stepFunctions.stopExecution.

Interrompe uma execução do Step Functions em andamento. A AWS marca a execução como ABORTED assim que ela é interrompida.

Importante

Esta ação é compatível apenas com máquinas de estado STANDARD. Ela não pode parar execuções EXPRESS.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS onde a execução está em andamento.	`us-east-1`
executionArn	Corda	Obrigatório. ARN da execução a ser interrompida.	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
Erro	Corda	Opcional. Código de erro curto que descreve por que a execução foi interrompida.	`TimeoutFromWorkflowAutomation`
cause	Corda	Opcional. Explicação legível por humanos de por que a execução foi interrompida.	`Remediation exceeded 10 minute SLA, aborted by workflow`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "stopDate", "expression": ".response.stopDate"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Resposta da API do AWS Step Functions. `{ "stopDate": "2026-08-24T09:15:30.000Z" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a interrupção da execução falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Resposta da API do AWS Step Functions.

{
  "stopDate": "2026-08-24T09:15:30.000Z"
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a interrupção da execução falhar.

null

em caso de sucesso.

O exemplo a seguir aborta uma execução que excedeu seu SLA.

Exemplo de fluxo de trabalho
`name: abort-stuck-sfn-run description: 'Aborts a Step Functions execution that exceeded its SLA' workflowInputs: arnRole: type: String executionArn: type: String steps: - name: abortStuckRun type: action action: aws.stepFunctions.stopExecution version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 executionArn: ${{ .workflowInputs.executionArn }} error: 'TimeoutFromWorkflowAutomation' cause: 'Remediation exceeded 10 minute SLA, aborted by workflow'`

Exemplo de fluxo de trabalho

name: abort-stuck-sfn-run
description: 'Aborts a Step Functions execution that exceeded its SLA'

workflowInputs:
  arnRole:
    type: String
  executionArn:
    type: String

steps:
  - name: abortStuckRun
    type: action
    action: aws.stepFunctions.stopExecution
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      executionArn: ${{ .workflowInputs.executionArn }}
      error: 'TimeoutFromWorkflowAutomation'
      cause: 'Remediation exceeded 10 minute SLA, aborted by workflow'

Fazer o redrive de uma execução do Step Functions

O identificador da ação é aws.stepFunctions.redriveExecution.

Reexecuta uma execução do Step Functions com falha, com tempo limite esgotado ou abortada, retomando-a do último estado malsucedido sem começar do início.

Importante

Esta ação é compatível apenas com máquinas de estado STANDARD. Uma execução só pode ser reexecutada se não tiver SUCCEEDED, estiver dentro de 14 dias após a conclusão e tiver menos de 24.999 eventos de histórico.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS onde a execução ocorreu.	`us-east-1`
executionArn	Corda	Obrigatório. ARN da execução a ser reacionada.	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
clientToken	Corda	Opcional. Token de idempotência para a solicitação de redrive. Gerado automaticamente pelo SDK se omitido.	`a1b2c3d4-e5f6-7890-abcd-ef1234567890`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "redriveDate", "expression": ".response.redriveDate"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Resposta da API do AWS Step Functions. `{ "redriveDate": "2026-08-24T09:20:00.000Z" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se o redrive falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Resposta da API do AWS Step Functions.

{
  "redriveDate": "2026-08-24T09:20:00.000Z"
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se o redrive falhar.

null

em caso de sucesso.

O exemplo a seguir reexecuta uma execução com falha para retomá-la a partir de seu último estado malsucedido.

Exemplo de fluxo de trabalho
`name: retry-failed-sfn-execution description: 'Redrives a failed Step Functions execution from its last unsuccessful state' workflowInputs: arnRole: type: String executionArn: type: String steps: - name: retryFailedRemediation type: action action: aws.stepFunctions.redriveExecution version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 executionArn: ${{ .workflowInputs.executionArn }} selectors: - name: redriveDate expression: '.response.redriveDate'`

Exemplo de fluxo de trabalho

name: retry-failed-sfn-execution
description: 'Redrives a failed Step Functions execution from its last unsuccessful state'

workflowInputs:
  arnRole:
    type: String
  executionArn:
    type: String

steps:
  - name: retryFailedRemediation
    type: action
    action: aws.stepFunctions.redriveExecution
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      executionArn: ${{ .workflowInputs.executionArn }}
      selectors:
        - name: redriveDate
          expression: '.response.redriveDate'

Descrever uma execução do Step Functions

O identificador da ação é aws.stepFunctions.describeExecution.

Retorna o status, a entrada, a saída e os timestamps de uma execução do Step Functions. Use esta ação para consultar o resultado de uma execução iniciada por aws.stepFunctions.startExecution.

Importante

Esta ação oferece suporte direto a execuções de máquina de estado STANDARD. Você só pode descrever execuções EXPRESS que um Map Run despachou.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS onde a execução ocorreu.	`us-east-1`
executionArn	Corda	Obrigatório. ARN da execução a ser descrita.	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
includedData	Enum	Opcional. Controla se a definição de execução é retornada. Use `METADATA_ONLY` para ignorar a descriptografia da definição quando a permissão `kms:Decrypt` não estiver disponível. O padrão é `ALL_DATA` .	`ALL_DATA` ou `METADATA_ONLY`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "status", "expression": ".response.status"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Detalhes da execução da API do AWS Step Functions. Em execuções `FAILED`, `TIMED_OUT` ou `ABORTED`, `output` está ausente e a API preenche `error` / `cause` em vez disso. `redriveStatus` indica se a execução pode ser reacionada. `{ "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42", "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService", "name": "incident-42", "status": "SUCCEEDED", "startDate": "2026-08-24T09:00:00.000Z", "stopDate": "2026-08-24T09:02:15.000Z", "input": "{\"incidentId\": \"42\"}", "output": "{\"result\": \"resolved\"}", "redriveCount": 0, "redriveStatus": "NOT_REDRIVABLE" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Detalhes da execução da API do AWS Step Functions. Em execuções FAILED, TIMED_OUT ou ABORTED, output está ausente e a API preenche error / cause em vez disso. redriveStatus indica se a execução pode ser reacionada.

{
  "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42",
  "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService",
  "name": "incident-42",
  "status": "SUCCEEDED",
  "startDate": "2026-08-24T09:00:00.000Z",
  "stopDate": "2026-08-24T09:02:15.000Z",
  "input": "{\"incidentId\": \"42\"}",
  "output": "{\"result\": \"resolved\"}",
  "redriveCount": 0,
  "redriveStatus": "NOT_REDRIVABLE"
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir consulta o status de uma execução e captura a saída para as etapas subsequentes.

Exemplo de fluxo de trabalho
`name: check-sfn-execution-status description: 'Polls the status and output of a Step Functions execution' workflowInputs: arnRole: type: String executionArn: type: String steps: - name: checkStatus type: action action: aws.stepFunctions.describeExecution version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 executionArn: ${{ .workflowInputs.executionArn }} selectors: - name: status expression: '.response.status' - name: output expression: '.response.output'`

Exemplo de fluxo de trabalho

name: check-sfn-execution-status
description: 'Polls the status and output of a Step Functions execution'

workflowInputs:
  arnRole:
    type: String
  executionArn:
    type: String

steps:
  - name: checkStatus
    type: action
    action: aws.stepFunctions.describeExecution
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      executionArn: ${{ .workflowInputs.executionArn }}
      selectors:
        - name: status
          expression: '.response.status'
        - name: output
          expression: '.response.output'

Listar execuções do Step Functions

O identificador da ação é aws.stepFunctions.listExecutions.

Lista as execuções de uma máquina de estado do AWS Step Functions ou execução de mapa, opcionalmente filtradas por status. Os resultados são ordenados com os mais recentes primeiro.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS para listar as execuções.	`us-east-1`
stateMachineArn	Corda	Opcional. ARN da máquina de estado cujas execuções devem ser listadas. Forneça este ou `mapRunArn` , não ambos. As máquinas de estado `EXPRESS` não são diretamente listáveis — em vez disso, use `mapRunArn` para listar suas execuções filhas de um Distributed Map.	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
mapRunArn	Corda	Opcional. ARN do Map Run cujas execuções filhas devem ser listadas. Forneça este ou `stateMachineArn` , não ambos. Obrigatório ao usar `statusFilter: PENDING_REDRIVE` .	`arn:aws:states:us-east-1:123456789012:mapRun:MyStateMachine/abcd1234`
statusFilter	Enum	Opcional. Filtrar execuções por status. `PENDING_REDRIVE` requer `mapRunArn` .	`RUNNING` \| `SUCCEEDED` \| `FAILED` \| `TIMED_OUT` \| `ABORTED` \| `PENDING_REDRIVE`
maxResultados	Interno	Opcional. Número máximo de execuções a retornar. O padrão é 100, máximo de 1000.	`20`
nextToken	Corda	Opcional. Token de paginação do `response.nextToken` de uma chamada anterior. Expira após 24 horas.	`AQICAHi...`
redriveFilter	Enum	Opcional. Filtrar execuções indicando se elas foram reexecutadas.	`REDRIVEN` ou `NOT_REDRIVEN`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "executions", "expression": ".response.executions"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Lista de execuções da API do AWS Step Functions. `nextToken` está presente apenas quando mais páginas estão disponíveis — passe-o como `nextToken` em uma chamada subsequente para recuperar a próxima página. `{ "executions": [ { "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42", "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService", "name": "incident-42", "status": "RUNNING", "startDate": "2026-08-24T09:00:00.000Z" } ], "nextToken": null }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Lista de execuções da API do AWS Step Functions. nextToken está presente apenas quando mais páginas estão disponíveis — passe-o como nextToken em uma chamada subsequente para recuperar a próxima página.

{
  "executions": [
    {
      "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42",
      "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService",
      "name": "incident-42",
      "status": "RUNNING",
      "startDate": "2026-08-24T09:00:00.000Z"
    }
  ],
  "nextToken": null
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir lista as execuções em andamento no momento para uma máquina de estado.

Exemplo de fluxo de trabalho
`name: find-running-sfn-executions description: 'Lists running executions for a state machine' workflowInputs: arnRole: type: String stateMachineArn: type: String steps: - name: findRunningExecutions type: action action: aws.stepFunctions.listExecutions version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 stateMachineArn: ${{ .workflowInputs.stateMachineArn }} statusFilter: RUNNING maxResults: 20 selectors: - name: executions expression: '.response.executions'`

Exemplo de fluxo de trabalho

name: find-running-sfn-executions
description: 'Lists running executions for a state machine'

workflowInputs:
  arnRole:
    type: String
  stateMachineArn:
    type: String

steps:
  - name: findRunningExecutions
    type: action
    action: aws.stepFunctions.listExecutions
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      stateMachineArn: ${{ .workflowInputs.stateMachineArn }}
      statusFilter: RUNNING
      maxResults: 20
      selectors:
        - name: executions
          expression: '.response.executions'

Descrever uma máquina de estado

O identificador da ação é aws.stepFunctions.describeStateMachine.

Retorna a definição, a função do IAM, a configuração de logging, o tipo (STANDARD ou EXPRESS) e o status de uma máquina de estado do AWS Step Functions.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS onde a máquina de estado está implantada.	`us-east-1`
stateMachineArn	Corda	Obrigatório. ARN da máquina de estado a ser descrita. Também aceita um ARN de versão.	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
includedData	Enum	Opcional. Use `METADATA_ONLY` para ignorar o retorno da definição da máquina de estado e evitar a necessidade de `kms:Decrypt` quando a definição for criptografada pelo KMS. O padrão é `ALL_DATA` .	`ALL_DATA` ou `METADATA_ONLY`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "type", "expression": ".response.type"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Detalhes da máquina de estado da API do AWS Step Functions. O campo `type` (`STANDARD` ou `EXPRESS`) é útil para a lógica de ramificação — por exemplo, para determinar se `stopExecution` ou `redriveExecution` são aplicáveis. `{ "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService", "name": "RestartUnhealthyService", "status": "ACTIVE", "definition": "{\"StartAt\": \"RestartTask\", \"States\": {...}}", "roleArn": "arn:aws:iam::123456789012:role/StepFunctionsExecutionRole", "type": "STANDARD", "creationDate": "2026-01-15T00:00:00.000Z" }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Detalhes da máquina de estado da API do AWS Step Functions. O campo type (STANDARD ou EXPRESS) é útil para a lógica de ramificação — por exemplo, para determinar se stopExecution ou redriveExecution são aplicáveis.

{
  "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService",
  "name": "RestartUnhealthyService",
  "status": "ACTIVE",
  "definition": "{\"StartAt\": \"RestartTask\", \"States\": {...}}",
  "roleArn": "arn:aws:iam::123456789012:role/StepFunctionsExecutionRole",
  "type": "STANDARD",
  "creationDate": "2026-01-15T00:00:00.000Z"
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir recupera o tipo e a definição de uma máquina de estado.

Exemplo de fluxo de trabalho
name: get-sfn-state-machine-type description: 'Retrieves the type and definition of a state machine' workflowInputs: arnRole: type: String stateMachineArn: type: String steps: - name: getDefinition type: action action: aws.stepFunctions.describeStateMachine version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 stateMachineArn: ${{ .workflowInputs.stateMachineArn }} selectors: - name: type expression: '.response.type' - name: definition expression: '.response.definition'

Exemplo de fluxo de trabalho

name: get-sfn-state-machine-type
description: 'Retrieves the type and definition of a state machine'

workflowInputs:
  arnRole:
    type: String
  stateMachineArn:
    type: String

steps:
  - name: getDefinition
    type: action
    action: aws.stepFunctions.describeStateMachine
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      stateMachineArn: ${{ .workflowInputs.stateMachineArn }}
      selectors:
        - name: type
          expression: '.response.type'
        - name: definition
          expression: '.response.definition'

Listar máquinas de estado

O identificador da ação é aws.stepFunctions.listStateMachines.

Lista as máquinas de estado do AWS Step Functions em uma conta e região. Use entradas de paginação para recuperar grandes conjuntos de resultados.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada	Tipo	Descrição	Exemplo
awsRoleArn	Corda	Opcional. ARN da função IAM para assumir. Recomendado. Tem precedência sobre as credenciais baseadas em chaves quando você fornece ambas.	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	String (segredo)	Opcional. ID da chave de acesso da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	String (segredo)	Opcional. Chave de acesso secreta da AWS. Deve ser passado como um segredo.	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	String (segredo)	Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como um segredo.	`${{ :secrets:awsSessionToken }}`
região	Corda	Obrigatório. Região da AWS na qual listar as máquinas de estado.	`us-east-1`
maxResultados	Interno	Opcional. Número máximo de máquinas de estado a serem retornadas. O padrão é 100, máximo de 1000.	`50`
nextToken	Corda	Opcional. Token de paginação do `response.nextToken` de uma chamada anterior. Expira após 24 horas.	`AQICAHi...`
selectors	Lista	Opcional. Seletores JQ para extrair campos específicos da saída da ação.	`[{"name": "stateMachines", "expression": ".response.stateMachines"}]`

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída	Tipo	Descrição
response	Objeto	Lista de máquinas de estado da API do AWS Step Functions. `nextToken` está presente apenas quando há mais páginas disponíveis — passe-o como `nextToken` em uma chamada subsequente para recuperar a próxima página. `{ "stateMachines": [ { "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService", "name": "RestartUnhealthyService", "type": "STANDARD", "creationDate": "2026-01-15T00:00:00.000Z" } ], "nextToken": null }`
success	Boleano	`true` em caso de sucesso, `false` em caso de falha.
errorMessage	Corda	Mensagem de erro se a solicitação falhar. `null` em caso de sucesso.

Saída

Tipo

Descrição

response

Objeto

Lista de máquinas de estado da API do AWS Step Functions. nextToken está presente apenas quando há mais páginas disponíveis — passe-o como nextToken em uma chamada subsequente para recuperar a próxima página.

{
  "stateMachines": [
    {
      "stateMachineArn": "arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService",
      "name": "RestartUnhealthyService",
      "type": "STANDARD",
      "creationDate": "2026-01-15T00:00:00.000Z"
    }
  ],
  "nextToken": null
}

success

Boleano

true

em caso de sucesso,

false

em caso de falha.

errorMessage

Corda

Mensagem de erro se a solicitação falhar.

null

em caso de sucesso.

O exemplo a seguir lista as máquinas de estado na conta e captura o resultado para as etapas posteriores.

Exemplo de fluxo de trabalho
`name: discover-sfn-state-machines description: 'Lists state machines in the account' workflowInputs: arnRole: type: String steps: - name: discoverStateMachines type: action action: aws.stepFunctions.listStateMachines version: '1' inputs: awsRoleArn: ${{ .workflowInputs.arnRole }} region: us-east-1 maxResults: 50 selectors: - name: stateMachines expression: '.response.stateMachines'`

Exemplo de fluxo de trabalho

name: discover-sfn-state-machines
description: 'Lists state machines in the account'

workflowInputs:
  arnRole:
    type: String

steps:
  - name: discoverStateMachines
    type: action
    action: aws.stepFunctions.listStateMachines
    version: '1'
    inputs:
      awsRoleArn: ${{ .workflowInputs.arnRole }}
      region: us-east-1
      maxResults: 50
      selectors:
        - name: stateMachines
          expression: '.response.stateMachines'

Qual é o próximo

Para continuar trabalhando com ações da AWS e automação de fluxo de trabalho, consulte os seguintes recursos.

Configuração de credenciais da AWS: configure funções do IAM e chaves de acesso para uso com ações da AWS.
AWS Execute API: chamada de API para qualquer API da AWS diretamente quando uma ação dedicada não estiver disponível.
Exemplos de fluxo de trabalho: Veja exemplos de fluxo de trabalho do mundo real usando ações da AWS.

Esta tradução de máquina é fornecida para sua comodidade.

Pré-requisitos.css-21sua1{background:none;border:none;width:0;padding:0;}

Permissões IAM necessárias

Importante

Iniciar uma execução do Step Functions

Interromper uma execução do Step Functions

Importante

Fazer o redrive de uma execução do Step Functions

Importante

Descrever uma execução do Step Functions

Importante

Listar execuções do Step Functions

Descrever uma máquina de estado

Listar máquinas de estado

Qual é o próximo

Pré-requisitos