AWS Step Functionsアクション

このページでは、ワークフロー自動化アクションカタログで利用可能なAWS Step Functionsアクションのリファレンスを提供します。これらのアクションを使用して、ワークフロー定義内からStep Functionsの実行とステートマシンを開始、停止、リドライブ、および検査します。

前提条件

ワークフロー自動化でAWS Step Functionsアクションを使用する前に、以下が用意されていることを確認してください。

適切な権限を持つ AWS アカウント。
設定された AWS 認証情報 (IAM ユーザー認証情報、IAM ロール ARN、またはセッション認証情報)。
Step Functionsの操作に必要なIAM権限。

IAM ユーザーおよび IAM ロールを作成する方法、およびワークフローオートメーションAWSアクションと統合するための静的 AWS 認証情報とセッションAWS認証情報を設定する方法については、 AWS認証情報のセットアップ」を参照してください。

必要なIAM権限

必要な権限は、ワークフローが呼び出すStep Functionsアクションによって異なります。以下の例を、7つのアクションすべてをカバーする最小権限ポリシーのテンプレートとして使用してください。

{
  "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>:*"
    }
  ]
}

重要

<region>と<account-id>を実際の値に置き換え、可能な場合はResourceを特定のステートマシンまたは実行ARNに制限してください。

Step Functionsの実行を開始します

アクション識別子はaws.stepFunctions.startExecutionです。

AWS Step Functionsステートマシンの実行を開始します。成功すると、新しい実行のexecutionArnを返します。これをaws.stepFunctions.describeExecutionに渡してステータスをポーリングできます。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。ステートマシンがデプロイされているAWSリージョン。	`us-east-1`
stateMachineArn	弦	必須。実行するステートマシンのARN。	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
name	弦	オプション。実行名。ステートマシンごとに一意でなければなりません。省略された場合はUUIDとして自動生成されます。 `STANDARD` ステートマシンでは、異なる入力で実行中の実行名を再利用すると `ExecutionAlreadyExists` が返されます。 `EXPRESS` ステートマシンでは、名前をすぐに再利用できます。	`incident-42`
input	弦	オプション。実行への入力として渡すJSON文字列。	`'{"instanceId": "i-0123456789abcdef0"}'`
traceHeader	弦	オプション。実行に伝播させるX-Rayトレースヘッダー。	`Root=1-5e1b2f1a-3c1a1a1a1a1a1a1a1a1a1a1a`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "executionArn", "expression": ".response.executionArn"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからのレスポンス。 `{ "executionArn": "arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42", "startDate": "2026-08-24T09:00:00.000Z" }`
success	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	実行の開始に失敗した場合のエラーメッセージ。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからのレスポンス。

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

success

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

実行の開始に失敗した場合のエラーメッセージ。成功した場合は

null

。

以下の例では、修復の実行を開始し、ダウンストリームのステップのために実行ARNをキャプチャします。

ワークフローの例
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'

ワークフローの例

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'

Step Functionsの実行を停止します

アクション識別子はaws.stepFunctions.stopExecutionです。

実行中のStep Functionsの実行を停止します。停止すると、AWSは実行をABORTEDとしてマークします。

重要

このアクションは、STANDARDステートマシンでのみサポートされています。EXPRESS実行を停止することはできません。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。実行が行われているAWSリージョン。	`us-east-1`
executionArn	弦	必須。停止する実行のARN。	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
エラー	弦	オプション。実行が停止された理由を説明する短いエラーコード。	`TimeoutFromWorkflowAutomation`
cause	弦	オプション。実行が停止された理由に関する、人間が読める形式の説明。	`Remediation exceeded 10 minute SLA, aborted by workflow`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "stopDate", "expression": ".response.stopDate"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからのレスポンス。 `{ "stopDate": "2026-08-24T09:15:30.000Z" }`
success	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	実行の停止に失敗した場合のエラーメッセージ。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからのレスポンス。

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

success

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

実行の停止に失敗した場合のエラーメッセージ。成功した場合は

null

。

次の例では、SLAを超過した実行を中止します。

ワークフローの例
`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'`

ワークフローの例

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'

Step Functions実行の再実行

アクション識別子はaws.stepFunctions.redriveExecutionです。

失敗した、タイムアウトした、または中止されたStep Functionsの実行をリドライブし、最初からやり直すことなく、最後に失敗した状態から再開します。

重要

このアクションはSTANDARDステートマシンでのみサポートされています。実行を再実行できるのは、SUCCEEDEDしておらず、完了から14日以内で、履歴イベントが24,999個未満の場合のみです。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。実行されたAWSリージョン。	`us-east-1`
executionArn	弦	必須。リドライブする実行のARN。	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
clientToken	弦	オプション。リドライブリクエストのべき等性トークン。省略された場合、SDKによって自動生成されます。	`a1b2c3d4-e5f6-7890-abcd-ef1234567890`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "redriveDate", "expression": ".response.redriveDate"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからのレスポンス。 `{ "redriveDate": "2026-08-24T09:20:00.000Z" }`
success	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	リドライブが失敗した場合のエラーメッセージ。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからのレスポンス。

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

success

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

リドライブが失敗した場合のエラーメッセージ。成功した場合は

null

。

以下の例では、失敗した実行をリドライブして、最後に失敗した状態から再開します。

ワークフローの例
`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'`

ワークフローの例

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'

Step Functionsの実行を記述する

アクション識別子はaws.stepFunctions.describeExecutionです。

Step Functionsの実行のステータス、入力、出力、およびタイムスタンプを返します。このアクションを使用して、aws.stepFunctions.startExecutionによって開始された実行の結果をポーリングします。

重要

このアクションは、STANDARDステートマシンの実行を直接サポートします。Map RunがディスパッチしたEXPRESS実行のみを記述できます。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。実行されたAWSリージョン。	`us-east-1`
executionArn	弦	必須。記述する実行のARN。	`arn:aws:states:us-east-1:123456789012:execution:RestartUnhealthyService:incident-42`
includedData	イナム	オプション。実行定義を返すかどうかを制御します。 `kms:Decrypt` 権限が利用できない場合に定義の復号をスキップするには、 `METADATA_ONLY` を使用します。デフォルトは `ALL_DATA` です。	`ALL_DATA` または `METADATA_ONLY`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "status", "expression": ".response.status"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからの実行の詳細。`FAILED`、`TIMED_OUT`、または`ABORTED`の実行では、`output`は存在せず、代わりにAPIが`error`/`cause`を設定します。`redriveStatus`は、実行をリドライブできるかどうかを示します。 `{ "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	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	リクエストが失敗した場合のエラーメッセージです。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからの実行の詳細。FAILED、TIMED_OUT、またはABORTEDの実行では、outputは存在せず、代わりにAPIがerror/causeを設定します。redriveStatusは、実行をリドライブできるかどうかを示します。

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

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

リクエストが失敗した場合のエラーメッセージです。成功した場合は

null

。

次の例では、実行のステータスをポーリングし、ダウンストリームステップ用に出力をキャプチャします。

ワークフローの例
`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'`

ワークフローの例

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'

Step Functionsの実行を一覧表示する

アクション識別子はaws.stepFunctions.listExecutionsです。

AWS Step Functionsステートマシンまたはマップ実行の実行を一覧表示し、オプションでステータスによってフィルタリングします。結果は最新のものから順にソートされます。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。実行を一覧表示するAWSリージョン。	`us-east-1`
stateMachineArn	弦	オプション。実行を一覧表示するステートマシンのARN。これまたは `mapRunArn` のいずれかを指定してください。両方は指定できません。 `EXPRESS` ステートマシンは直接一覧表示できません — 代わりに `mapRunArn` を使用して、分散マップから子実行を一覧表示してください。	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
mapRunArn	弦	オプション。子実行を一覧表示するマップ実行のARN。これまたは `stateMachineArn` のいずれかを指定してください。両方を指定することはできません。 `statusFilter: PENDING_REDRIVE` を使用する際に必須です。	`arn:aws:states:us-east-1:123456789012:mapRun:MyStateMachine/abcd1234`
statusFilter	イナム	オプション。ステータスで実行をフィルタリングします。 `PENDING_REDRIVE` には `mapRunArn` が必要です。	`RUNNING` \| `SUCCEEDED` \| `FAILED` \| `TIMED_OUT` \| `ABORTED` \| `PENDING_REDRIVE`
最大結果	Int	オプション。返す実行の最大数。デフォルトは100、最大は1,000です。	`20`
nextToken	弦	オプション。以前の呼び出しの `response.nextToken` からのページネーショントークン。24時間後に有効期限が切れます。	`AQICAHi...`
redriveFilter	イナム	オプション。再実行されたかどうかで実行をフィルタリングします。	`REDRIVEN` または `NOT_REDRIVEN`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "executions", "expression": ".response.executions"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからの実行のリスト。`nextToken`は、さらにページが利用可能な場合にのみ存在します — 次のページを取得するには、後続の呼び出しで`nextToken`として渡します。 `{ "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	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	リクエストが失敗した場合のエラーメッセージです。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからの実行のリスト。nextTokenは、さらにページが利用可能な場合にのみ存在します — 次のページを取得するには、後続の呼び出しでnextTokenとして渡します。

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

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

リクエストが失敗した場合のエラーメッセージです。成功した場合は

null

。

以下の例では、ステートマシンで現在実行されている実行を一覧表示します。

ワークフローの例
`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'`

ワークフローの例

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'

ステートマシンの記述

アクション識別子はaws.stepFunctions.describeStateMachineです。

AWS Step Functionsステートマシンの定義、IAMロール、ログ設定、タイプ（STANDARDまたはEXPRESS）、およびステータスを返します。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。ステートマシンがデプロイされているAWSリージョン。	`us-east-1`
stateMachineArn	弦	必須。記述するステートマシンのARN。バージョンARNも受け付けます。	`arn:aws:states:us-east-1:123456789012:stateMachine:RestartUnhealthyService`
includedData	イナム	オプション。ステートマシンの定義の返却をスキップし、定義がKMSで暗号化されている場合に `kms:Decrypt` を不要にするには、 `METADATA_ONLY` を使用します。デフォルトは `ALL_DATA` です。	`ALL_DATA` または `METADATA_ONLY`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "type", "expression": ".response.type"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからのステートマシンの詳細。`type`フィールド（`STANDARD`または`EXPRESS`）は、分岐ロジックに役立ちます — たとえば、`stopExecution`または`redriveExecution`が適用可能かどうかを判断するためです。 `{ "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	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	リクエストが失敗した場合のエラーメッセージです。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからのステートマシンの詳細。typeフィールド（STANDARDまたはEXPRESS）は、分岐ロジックに役立ちます — たとえば、stopExecutionまたはredriveExecutionが適用可能かどうかを判断するためです。

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

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

リクエストが失敗した場合のエラーメッセージです。成功した場合は

null

。

以下の例では、ステートマシンのタイプと定義を取得します。

ワークフローの例
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'

ワークフローの例

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'

ステートマシンの一覧

アクション識別子はaws.stepFunctions.listStateMachinesです。

アカウントおよびリージョン内のAWS Step Functionsステートマシンを一覧表示します。大きな結果セットを取得するには、ページネーション入力を使用します。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力	タイプ	説明	例
awsRoleArn	弦	オプション。引き受けるIAMロールARN。推奨。両方を指定した場合は、キーベースの認証情報よりも優先されます。	`arn:aws:iam::123456789012:role/my-workflow-role`
awsAccessKeyId	文字列（シークレット）	オプション。 AWSアクセスキーID。シークレットとして渡す必要があります。	`${{ :secrets:awsAccessKeyId }}`
awsSecretAccessKey	文字列（シークレット）	オプション。 AWSシークレットアクセスキー。シークレットとして渡す必要があります。	`${{ :secrets:awsSecretAccessKey }}`
awsSessionToken	文字列（シークレット）	オプション。一時的な認証情報のためのAWSセッショントークン。シークレットとして渡す必要があります。	`${{ :secrets:awsSessionToken }}`
リージョン	弦	必須。ステートマシンを一覧表示するAWSリージョン。	`us-east-1`
最大結果	Int	オプション。返すステートマシンの最大数。デフォルトは100、最大は1,000です。	`50`
nextToken	弦	オプション。以前の呼び出しの `response.nextToken` からのページネーショントークン。24時間後に有効期限が切れます。	`AQICAHi...`
selectors	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "stateMachines", "expression": ".response.stateMachines"}]`

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力	タイプ	説明
response	オブジェクト	AWS Step Functions APIからのステートマシンのリスト。`nextToken`は、さらにページが利用可能な場合にのみ存在します — 次のページを取得するには、後続の呼び出しで`nextToken`として渡します。 `{ "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	ブール値	`true` 成功時は、失敗時は `false` 。
errorMessage	弦	リクエストが失敗した場合のエラーメッセージです。成功した場合は `null` 。

出力

タイプ

説明

response

オブジェクト

AWS Step Functions APIからのステートマシンのリスト。nextTokenは、さらにページが利用可能な場合にのみ存在します — 次のページを取得するには、後続の呼び出しでnextTokenとして渡します。

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

ブール値

true

成功時は、失敗時は

false

。

errorMessage

弦

リクエストが失敗した場合のエラーメッセージです。成功した場合は

null

。

次の例では、アカウント内のステートマシンを一覧表示し、ダウンストリームステップのために結果をキャプチャします。

ワークフローの例
`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'`

ワークフローの例

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'

次のステップ

AWSアクションとワークフロー自動化の作業を続けるには、以下のリソースを参照してください。

AWS認証情報のセットアップ：AWSアクションで使用するIAMロールとアクセスキーを設定します。
AWS Execute API: 専用のアクションが利用できない場合に、任意のAWS APIを直接コールします。
ワークフローの例：AWSアクションを使用した実際のワークフローの例を参照してください。

この機械翻訳は、参考として提供されています。

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

必要なIAM権限

重要

Step Functionsの実行を開始します

Step Functionsの実行を停止します

重要

Step Functions実行の再実行

重要

Step Functionsの実行を記述する

重要

Step Functionsの実行を一覧表示する

ステートマシンの記述

ステートマシンの一覧

次のステップ

前提条件