翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

オートメーションのデプロイ

Amazon Quick Automate でオートメーションを作成してテストした後、次のステップは、トリガーで定期的に実行できるようにオートメーションをデプロイすることです。デプロイすると、自動化が動作し、実行の準備が整います。デプロイされたオートメーションにトリガーを追加して、事前定義されたスケジュールで実行できます。デプロイには、ランタイム設定の構成、ヒューhuman-in-the-loopタスクのユーザーの割り当て、認証情報と統合の検証が含まれます。

このセクションでは、デプロイプロセスの各ステップと、信頼性、セキュリティ、最適なパフォーマンスのためにオートメーションを設定する方法について説明します。

前提条件

オートメーションをデプロイする前に、次のステップが完了していることを確認してください。

オートメーションのデプロイ

自動化を Canvas から直接デプロイするには、デプロイをクリックするか、自動化のランディングページのデプロイタブに移動します。デプロイを開始すると、システムは設定とリリースプロセスを完了するための一連のステップをガイドします。

リリース詳細

リリースの詳細ページで、デプロイするオートメーションのバージョンを選択します。コミットされたバージョンのみがデプロイ可能で、ドロップダウンリストに表示されます。

詳細設定

その他の設定は次のとおりです。

ランタイム設定

ランタイム設定は、開発、テスト、本番稼働などの環境によって異なる可能性のあるパラメータです。

たとえば、E メールを送信する自動化ステップでは、テスト中に個人の E メールアドレスを使用する場合がありますが、本番環境の共有チームアドレスに切り替える必要があります。このような環境依存値は、オートメーションを作成するときにランタイム設定として定義できます。

デプロイ時に、これらの設定を確認して上書きし、意図した環境でオートメーションが正しく実行されるようにできます。ランタイムパラメータには以下が含まれます。

この柔軟性により、環境間で単一の自動化定義を維持しながら、必要に応じて主要なパラメータを適応させることができます。

タスク

human-in-the-loopを必要とする各タスクのリゾルバーユーザーまたはユーザーグループを選択します。

アクセス (認証情報と接続)

多くの場合、自動化は外部システム、データベース、またはサービスに接続する必要があります。Amazon Quick Automate は、オートメーションロジックに機密情報を埋め込まずに認証情報と接続を管理するための安全な方法を提供します。

接続データと認証情報データは安全に保存および暗号化され、作成者やエンドユーザーに公開することなく、実行時にワークフローで使用できます。この設計により、オートメーション定義からシークレットを強力に分離できるため、セキュリティと保守性の両方が向上します。

2 つの主なタイプの認証情報を保存して使用できます。

デプロイ時に、オートメーションが必要なすべてのシステムに安全かつ正常にアクセスできるように、正しい認証情報と接続が選択されていることを確認します。

トリガーのセットアップ

トリガーは、オートメーションがいつどのように実行されるかを決定します。オートメーションは、事前定義されたスケジュールに基づいて開始するか、Amazon QuickSight API を使用してプログラムで呼び出すように設定できます。

スケジュール

事前定義されたスケジュールに基づいてオートメーションを開始するように設定できます。トリガーを設定するには:

API トリガー

自動化ジョブ APIs を使用すると、外部アプリケーションから自動化ジョブをプログラムで起動およびモニタリングできます。これらの APIs を使用して、デプロイされたオートメーションをカスタム入力ペイロードで呼び出し、 AWS SDK と を使用して実行結果を取得できます AWS CLI。

自動化ジョブ APIs2 つのオペレーションが含まれています。

これらの APIsは Amazon QuickSight サービス名前空間の一部です。 AWS SDK および quicksightの名前空間からそれらにアクセスします AWS CLI。

AWS SDKsAWS 「入門リソースセンター」を参照してください。

前提条件

自動化ジョブ APIsを呼び出す前に、以下のセットアップステップを完了します。

自動化識別子を検索する

自動化ジョブ APIs を呼び出すには、次の識別子が必要です。

オートメーショングループ ID とオートメーション ID は、オートメーションを開いてデプロイされたバージョンがある場合、デプロイセクションにあります。

識別子を検索するには

IAM 許可を設定する

Automation Job APIs、IAM ID (ユーザー、ロール、またはグループ) にアタッチされた IAM アクセス許可が必要です。各オペレーションには個別のアクセス許可が必要です。

StartAutomationJob のアクセス許可

quicksight:StartAutomationJob アクションを付与するポリシーをアタッチします。リソース ARN を、許可する特定のオートメーションにスコープします。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowStartAutomationJob",
            "Effect": "Allow",
            "Action": [
                "quicksight:StartAutomationJob"
            ],
            "Resource": [
                "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID"
            ]
        }
    ]
}

DescribeAutomationJob のアクセス許可

quicksight:DescribeAutomationJob アクションを付与するポリシーをアタッチします。このオペレーションのリソース ARN には、ジョブ ID セグメントが含まれます。オートメーションでジョブを記述できるようにするには、ジョブセグメントにワイルドカード (*) を使用します。

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "AllowDescribeAutomationJob",
            "Effect": "Allow",
            "Action": [
                "quicksight:DescribeAutomationJob"
            ],
            "Resource": [
                "arn:aws:quicksight:us-west-2:111122223333:automation-group/EXAMPLE-GROUP-ID/automation/EXAMPLE-AUTOMATION-ID"
            ]
        }
    ]
}

AWS では、最小特権の原則に従うことができる最も具体的なリソース ARN に各アクセス許可の範囲を設定することをお勧めします。詳細については次を参照してください:

オートメーションをデプロイする

StartAutomationJob API ターゲットは、オートメーションのみをデプロイします。API を使用してオートメーションを呼び出す前に、Amazon Quick Automate コンソールでオートメーションをコミットしてデプロイする必要があります。

StartAutomationJob

デプロイされたオートメーションの新しいジョブを開始します。オペレーションは非同期 — Amazon Quick Automate はリクエストを受け入れ、ジョブをキューに入れ、すぐに JobId を返します。自動化はバックグラウンドで実行されます。オートメーションに入力スキーマが定義されている場合、Amazon Quick Automate はジョブを受け入れる前にスキーマに対して InputPayload を検証します。無効なペイロードは InvalidParameterValueException になります。

リクエストの構文

POST /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs HTTP/1.1
Content-type: application/json

{
    "InputPayload": "string"
}

リクエストパラメータ

レスポンス要素

エラー

詳細については、StartAutomationJob の API リファレンスガイドを参照してください。

DescribeAutomationJob

実行タイムスタンプやオプションの入出力ペイロードなど、指定されたオートメーションジョブのステータスと詳細を取得します。このオペレーションを使用して、StartAutomationJob を呼び出した後にジョブの完了をポーリングします。

デフォルトでは、レスポンスには入力ペイロードと出力ペイロードは含まれません。IncludeInputPayload クエリパラメータと IncludeOutputPayload クエリパラメータを に設定trueしてリクエストします。Amazon Quick Automate は、次の条件がすべて満たされた場合にのみ出力ペイロードを返します。

リクエストの構文

GET /accounts/AwsAccountId/automation-groups/AutomationGroupId/automations/AutomationId/jobs/JobId?IncludeInputPayload=boolean&IncludeOutputPayload=boolean HTTP/1.1

リクエストパラメータ

レスポンスフィールド

エラー

詳細については、DescribeAutomationJob の API リファレンスガイドを参照してください。

入力と出力を使用して API トリガーでオートメーションを実行する

API を使用してオートメーションジョブを開始するときに、入力値を JSON ペイロードとして含めることができます。Amazon Quick Automate は、実行を開始する前にオートメーションの入力スキーマに対してペイロードを検証し、ジョブが完了すると構造化された出力値を返します。

前提条件

API トリガーを使用してオートメーションを実行する前に、以下が設定されていることを確認してください。

API を介した入力値の送信

入力値を含めるには、InputPayload パラメータを使用して StartAutomationJob リクエストに JSON ペイロードを渡します。 InputPayload

Sample Request

POST /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs
{
    "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}"
}

Sample Response

{
    "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "JobId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "Status": 200,
    "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012"
}

API を使用して出力値を取得する

DescribeAutomationJob API を呼び出すことで、出力値を取得できます。レスポンスに入出力ペイロードを含めるには、includeInputPayload および includeOutputPayload クエリパラメータを に設定しますtrue。

レスポンスには、自動化が正常に完了した場合にのみ OutputPayload フィールドが含まれます。

Sample Request

GET /accounts/123456789012/automation-groups/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automations/11111111-2222-3333-4444-555555555555/jobs/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?includeInputPayload=true&includeOutputPayload=true

Sample Response

{
    "Arn": "arn:aws:quicksight:us-west-2:123456789012:automation-group/a1b2c3d4-e5f6-7890-abcd-ef1234567890/automation/11111111-2222-3333-4444-555555555555/job/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "JobStatus": "SUCCEEDED",
    "CreatedAt": "2026-03-11T09:59:50Z",
    "StartedAt": "2026-03-11T10:00:00Z",
    "EndedAt": "2026-03-11T10:05:00Z",
    "InputPayload": "{\"customer_id\":\"C-98765\",\"threshold\":100,\"region\":\"us-east-1\"}",
    "OutputPayload": "{\"result\":\"success\",\"records_processed\":42,\"summary\":{\"passed\":40,\"failed\":2}}",
    "RequestId": "req-12345678-abcd-efgh-ijkl-123456789012"
}

入力と出力を使用してオートメーションをデプロイして実行する

このセクションでは、入力スキーマと出力スキーマを使用するオートメーションをデプロイし、手動またはスケジュールで実行し、実行結果を表示する方法について説明します。

デプロイ前にスキーマ情報を表示する

オートメーションをデプロイする前に、それをコミットしてバージョンを作成する必要があります。詳細については、「オートメーションバージョンの保守」を参照してください。

入力スキーマまたは出力スキーマを使用してオートメーションをコミットすると、バージョンの詳細ページのデータモデルセクションでスキーマの詳細を表示できます。このセクションでは、入力と出力の両方の完全なフィールド定義を表示します。

入力スキーマと出力スキーマを使用してオートメーションをデプロイする

入力スキーマまたは出力スキーマが定義されているオートメーションをデプロイすると、デプロイダイアログボックスにデータモデルセクションにスキーマ情報が表示されます。

デプロイを完了するには、スキーマ情報を確認し、デプロイを選択します。

デプロイされたオートメーションを手動で実行する

入力を使用してデプロイされたオートメーションを開始するには、次の手順を実行します。

入力フォームは、Studio でテストするときに使用するものと同じです。

スケジュールされたトリガーを使用してオートメーションを実行する

スケジュールされたトリガーの場合、トリガーを作成または編集するときに入力値を指定します。保存された値は、トリガーが発生するたびにオートメーションに渡されます。

以下を行うことができます。

スケジュールされたトリガーの入力を設定するには、次の手順を実行します。

デプロイされた実行の入力と出力の表示

自動化の実行が完了すると (手動で開始するか、スケジュールされたトリガーによって開始するかにかかわらず）、入力値と出力値は、実行ページのログパネルで構造化アーティファクトとして使用できます。

アーティファクトは専用カードとして表示されます。

両方のカードはデフォルトで折りたたまれます。これらを展開すると、次のことができます。