![[アップデート] Amazon Quick Automate のオートメーションを API から実行できるようになりました](https://images.ctfassets.net/ct0aopd36mqt/2x7muHjvW69fxuVNSKWZHp/b37e05a972fc8125e9214abd764928fa/amazon-quick.png?w=3840&fm=webp)
[アップデート] Amazon Quick Automate のオートメーションを API から実行できるようになりました
いわさです。
Amazon Quick Automate は、自然言語やプロセスドキュメントからエンタープライズ向けのワークフローオートメーションを構築できるサービスです。
以前、こちらの記事で共有ファイルストレージ機能を紹介しています。
以前は、デプロイしたオートメーションを実行するにはコンソールから手動で「Run now」を実行するか、スケジュールトリガーを設定する必要がありました。
外部アプリケーションやイベント駆動のアーキテクチャからオートメーションを呼び出したい場合に、プログラマティックに実行する手段がなかったわけです。
前述のブログと同じくらいのタイミングなのですが、先月末のアップデートで、Amazon Quick Automate に API トリガー機能が追加されました。
StartAutomationJob と DescribeAutomationJob の 2 つの API が追加され、AWS SDK や AWS CLI からオートメーションジョブの開始とステータス確認ができるようになっています。
今回こちらを確認してみたので紹介します。
Automation ID と Group ID を確認する
API を呼び出すには、対象オートメーションの Automation ID と Group ID（いずれも UUID）が必要です。
これらはコンソールの Deployments タブから確認できます。
対象のオートメーションを開き、Deployments タブで Actions（⋮）から「View deployment details」を選択します。
Deployment details ダイアログの上部に Automation ID と Group ID が表示されます。コピーボタンで取得できます。
IAM ポリシーの設定
API を呼び出す IAM ユーザーやロールには、quicksight:StartAutomationJob と quicksight:DescribeAutomationJob のアクションを許可するポリシーが必要です。
公式ドキュメントによると、リソース ARN は以下の形式で指定するみたいです。
arn:aws:quicksight:{region}:{account-id}:automation-group/{group-id}/automation/{automation-id}
AWS CLI から実行してみる
では早速 AWS CLI で API トリガーを試してみましょう。
今回はインプットスキーマを定義していないシンプルなオートメーションをデプロイ済みなので、入力ペイロードなしでジョブを開始してみます。
StartAutomationJob
start-automation-job サブコマンドでジョブを開始します。
% aws quicksight start-automation-job \
--aws-account-id 123456789012 \
--automation-group-id 5b16b64f-4177-457a-abd2-c8e798e33f2a \
--automation-id de65a155-3e8e-4c51-88e1-90fe3bf8cf3a \
--profile quick-sandbox \
--region ap-northeast-1
{
"Status": 200,
"Arn": "arn:aws:quicksight:ap-northeast-1:123456789012:automation-group/5b16b64f-4177-457a-abd2-c8e798e33f2a/automation/de65a155-3e8e-4c51-88e1-90fe3bf8cf3a/job/740daec3-a19e-4ee9-aea4-3e7ea24c6515",
"JobId": "740daec3-a19e-4ee9-aea4-3e7ea24c6515",
"RequestId": "7fa723f3-fcd6-4343-b218-838ff2981368"
}
レスポンスに JobId が返ってきました。非同期で実行されるので、このタイミングではジョブがキューに入っただけです。
コンソールの Monitor > Runs タブを確認すると、ステータスが「Running」になっていることが確認できます。
DescribeAutomationJob
describe-automation-job サブコマンドで、先ほど取得した JobId を指定してジョブのステータスを確認します。
% aws quicksight describe-automation-job \
--aws-account-id 123456789012 \
--automation-group-id 5b16b64f-4177-457a-abd2-c8e798e33f2a \
--automation-id de65a155-3e8e-4c51-88e1-90fe3bf8cf3a \
--job-id 740daec3-a19e-4ee9-aea4-3e7ea24c6515 \
--profile quick-sandbox \
--region ap-northeast-1
{
"Arn": "arn:aws:quicksight:ap-northeast-1:123456789012:automation-group/5b16b64f-4177-457a-abd2-c8e798e33f2a/automation/de65a155-3e8e-4c51-88e1-90fe3bf8cf3a/job/740daec3-a19e-4ee9-aea4-3e7ea24c6515",
"CreatedAt": "2026-05-29T06:40:21.308000+09:00",
"StartedAt": "2026-05-29T06:40:32.866000+09:00",
"EndedAt": "2026-05-29T06:40:34.780000+09:00",
"JobStatus": "SUCCEEDED",
"RequestId": "ef1838d4-d5fc-4004-b0ac-951f7ad6d6f2"
}
JobStatus が SUCCEEDED になっており、正常に完了したことが確認できます。
CreatedAt から EndedAt まで約 13 秒、実際の実行時間（StartedAt 〜 EndedAt）は約 2 秒で完了しています。
なお、公式ドキュメントによると DescribeAutomationJob には --include-input-payload と --include-output-payload オプションがあり、入出力ペイロードをレスポンスに含めることもできるみたいです。
今回はインプットスキーマを定義していないオートメーションなので省略していますが、入力スキーマを定義したオートメーションであれば StartAutomationJob の --input-payload パラメータで JSON を渡すこともできるとのこと。
The Automation Job APIs enable you to programmatically start and monitor automation jobs from external applications. You can use these APIs to invoke deployed automations with custom input payloads and retrieve execution results through the AWS SDK and AWS CLI.
さいごに
本日は Amazon Quick Automate にデプロイ済みオートメーションを API から実行できる API トリガー機能が追加されたので確認してみました。
これまではスケジュール実行か手動実行しかなかったので、外部アプリケーションからのイベント駆動でオートメーションを呼び出せるようになったのは活用の幅が広がりそうです。
API 自体は StartAutomationJob と DescribeAutomationJob の 2 つだけでシンプルなので、EventBridge や Lambda と組み合わせてイベント駆動で呼び出すパターンなど、色々と使い道がありそうですね。
