

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

# オートメーションのデプロイ
<a name="deploying-automations"></a>

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

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

## 前提条件
<a name="deployment-prerequisites"></a>

オートメーションをデプロイする前に、次のステップが完了していることを確認してください。
+ **自動化を徹底的にテスト**する - end-to-endのテストを通じて自動化を検証し、すべてのロジック、アクション、エージェントのインタラクションが期待どおりに機能することを確認します。
+ **デプロイにコミットされたバージョン** - デプロイできるのはコミットされたオートメーションバージョンのみです。変更を確認し、バージョンを確定してコミットしてから続行します。
+ **統合の設定** - オートメーションが APIs を介して Salesforce や Jira などの外部アプリケーションとやり取りする場合は、必要な統合がすべて設定されていることを確認してください。
  + 左パネル**の接続 → 統合**に移動して、新しい統合を作成します。
  + 現在、Amazon Quick Automate では、**アクション**タブで使用可能な統合のみがサポートされています。
  + 統合アクションが作成されたら、使用する**オートメーショングループに**関連付けます。
  + 関連付けられたアクションがキャンバスに表示されます。デプロイ中に、デプロイされたオートメーションで使用する適切な接続を選択できます。
+ **認証情報の設定** - オートメーションに必要なすべての認証情報が正しく設定されていることを確認します。

## オートメーションのデプロイ
<a name="deploying-an-automation"></a>

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

### リリース詳細
<a name="release-details"></a>

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

### 詳細設定
<a name="additional-settings"></a>

その他の設定は次のとおりです。
+ **ランタイム設定**
+ **タスク (HITL 割り当ての場合)**
+ **アクセス**

#### ランタイム設定
<a name="runtime-configuration"></a>

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

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

デプロイ時に、これらの設定を確認して上書きし、意図した環境でオートメーションが正しく実行されるようにできます。ランタイムパラメータには以下が含まれます。
+ E メールアドレスまたは通知受信者
+ 環境に固有のファイルパスまたは URLs 

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

#### タスク
<a name="tasks"></a>

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

#### アクセス (認証情報と接続)
<a name="access-credentials-connections"></a>

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

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

2 つの主なタイプの認証情報を保存して使用できます。
+ **ウェブサイト認証情報** - ウェブサイトのログイン (ユーザー名とパスワード) を必要とする UI 自動化ステップに使用されます。
+ **アクション認証情報 (統合)** - 設定された統合 (Salesforce、Jira など) を介して AWS サービス (S3 など) または外部システムを接続するために使用されます。

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

## トリガーのセットアップ
<a name="setting-up-triggers"></a>

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

### スケジュール
<a name="setting-up-triggers-schedules"></a>

事前定義されたスケジュールに基づいてオートメーションを開始するように設定できます。トリガーを設定するには:
+ デプロイページで、「トリガーの作成」をクリックし、ルールを設定します。
+ 頻度を選択する
+ 開始日時を選択します (実際の実行は、選択した開始時刻から 15 分以内に開始されることに注意してください）。
+ 終了日時を選択する
+ タイムゾーンを選択する
+ Amazon Quick Automate は、組み込みのスケーラビリティを提供します。オートメーションの並列実行の数を選択します (トリガーごとに最大 10 個の並列実行を選択し、アカウント内のすべてのオートメーションで 50 個の並列実行を選択できます。 にお問い合わせください AWS)
+ 複雑なスケジューリングが必要な場合は、cron 式を使用して正確な実行パターンを定義できます。たとえば、毎週月曜日、水曜日、金曜日の午前 2 時 30 分にオートメーションを実行するには、cron 式 を使用します`30 2 * * 1,3,5`。

### API トリガー
<a name="setting-up-triggers-api"></a>

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

自動化ジョブ APIs2 つのオペレーションが含まれています。
+ **StartAutomationJob** – オプションの入力ペイロードを使用して、デプロイされたオートメーションの新しいジョブを開始します。
+ **DescribeAutomationJob** – 指定されたジョブのステータス、タイムスタンプ、オプションの入出力ペイロードを取得します。

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

 AWS SDKs[AWS 「入門リソースセンター](https://aws.amazon.com/getting-started/tools-sdks/)」を参照してください。

#### 前提条件
<a name="api-triggers-prerequisites"></a>

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

##### 自動化識別子を検索する
<a name="api-triggers-find-identifiers"></a>

自動化ジョブ APIs を呼び出すには、次の識別子が必要です。
+ **AWS アカウント ID** – 12 桁の AWS アカウント ID。
+ **自動化グループ ID** – 自動化を含む自動化グループの一意の ID。
+ **Automation ID** – 呼び出すオートメーションの一意の ID。

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

**識別子を検索するには**
+ Amazon Quick Automate にサインインします。
+ 左側のナビゲーションペインで、**オートメーション**を選択します。
+ オートメーションを含むオートメーショングループを選択します。
+ オートメーション名を選択して、オートメーションエディタを開きます。
+ **[デプロイ]** タブを選択します。
+ **アクション (⋮)** を選択し、**デプロイの詳細を表示**して、見出しのデプロイの詳細のすぐ下にある上部にある**自動化 ID** と**グループ ID** を取得します。

##### IAM 許可を設定する
<a name="api-triggers-configure-iam"></a>

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 に各アクセス許可の範囲を設定することをお勧めします。詳細については次を参照してください:
+ [Amazon QuickSight の IAM ポリシーの例](https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html)
+ [アクション、リソース、および条件キー](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonquicksight.html)
+ [IAM JSON ポリシー要素](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html)

##### オートメーションをデプロイする
<a name="api-triggers-deploy-automation"></a>

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

#### StartAutomationJob
<a name="api-triggers-start-automation-job"></a>

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

##### リクエストの構文
<a name="start-job-request-syntax"></a>

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

{
    "InputPayload": "string"
}
```

##### リクエストパラメータ
<a name="start-job-request-parameters"></a>
+ **AwsAccountId** (文字列、必須) – AWS アカウント ID (12 桁）。
+ **AutomationGroupId** (文字列、必須) – 自動化グループ (UUID) の ID。
+ **AutomationId** (文字列、必須) – 実行するオートメーションの ID (UUID)。
+ **InputPayload** (文字列、オプション) – JSON 文字列としてのジョブの入力。

##### レスポンス要素
<a name="start-job-response-elements"></a>
+ **Arn** (文字列) — 自動化ジョブの ARN。
+ **JobId** (文字列) – 開始されたジョブの ID。ステータスを追跡`DescribeAutomationJob`するには、 でこれを使用します。
+ **ステータス** (整数) – レスポンスの HTTP ステータスコード。
+ **RequestId** (文字列) – AWS リクエスト ID。

##### エラー
<a name="start-job-errors"></a>
+ **AccessDeniedException** – アクセス許可が不十分であるか、認証情報が無効です。
+ **InvalidParameterValueException** – 1 つ以上のパラメータに無効な値があります。
+ **ResourceNotFoundException** – オートメーショングループまたはオートメーションが見つかりません。
+ **LimitExceededException** – 制限を超えています。
+ **ThrottlingException** – リクエストがスロットリングされました。
+ **InternalFailureException** – 内部サービスエラー。

詳細については、[StartAutomationJob の API リファレンスガイド](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_StartAutomationJob.html)を参照してください。

#### DescribeAutomationJob
<a name="api-triggers-describe-automation-job"></a>

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

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

##### リクエストの構文
<a name="describe-job-request-syntax"></a>

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

##### リクエストパラメータ
<a name="describe-job-request-parameters"></a>
+ **AwsAccountId** (文字列、必須) – AWS アカウント ID (12 桁）。
+ **AutomationGroupId** (文字列、必須) – 自動化グループ (UUID) の ID。
+ **AutomationId** (文字列、必須) – 自動化の ID (UUID)。
+ **JobId** (文字列、必須) – (`StartAutomationJob`UUID) によって返されるジョブの ID。
+ **IncludeInputPayload** (ブール値、オプション) – 入力ペイロードをレスポンスに含めます。デフォルト: `false`。
+ **IncludeOutputPayload** (ブール値、オプション) – レスポンスに出力ペイロードを含めます。デフォルト: `false`。

##### レスポンスフィールド
<a name="describe-job-response-fields"></a>
+ **Arn** (文字列) — 自動化ジョブの ARN。
+ **CreatedAt** (タイムスタンプ) – ジョブが作成された日時 (エポック秒）。
+ **StartedAt** (タイムスタンプ) – ジョブの実行が開始された時刻 (エポック秒）。
+ **EndedAt** (タイムスタンプ) – ジョブが終了したとき (エポック秒）。
+ **JobStatus** (文字列) – `QUEUED`、`RUNNING`、`SUCCEEDED`、`FAILED`、または `STOPPED`。
+ **InputPayload** (文字列) – 入力ペイロード。`IncludeInputPayload` が でない限り、レスポンスから省略されます`true`。
+ **OutputPayload** (文字列) – 出力ペイロード。`IncludeOutputPayload` が でない限り、レスポンスから省略されます`true`。
+ **RequestId** (文字列) – AWS リクエスト ID。

##### エラー
<a name="describe-job-errors"></a>
+ **AccessDeniedException** – アクセス許可が不十分であるか、認証情報が無効です。
+ **InvalidParameterValueException** – 1 つ以上のパラメータに無効な値があります。
+ **ResourceNotFoundException** – ジョブ、オートメーション、またはオートメーショングループが見つかりません。
+ **ThrottlingException** – リクエストがスロットリングされました。
+ **InternalFailureException** – 内部サービスエラー。

詳細については、[DescribeAutomationJob の API リファレンスガイド](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAutomationJob.html)を参照してください。

## 入力と出力を使用して API トリガーでオートメーションを実行する
<a name="run-automations-api-triggers-io"></a>

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

### 前提条件
<a name="api-triggers-io-prerequisites"></a>

API トリガーを使用してオートメーションを実行する前に、以下が設定されていることを確認してください。
+ オートメーションがデプロイされます。
+ オートメーションには、Start ノードで定義された入力スキーマがあります。
+ オートメーショングループ ID とオートメーション ID があります。

### API を介した入力値の送信
<a name="api-triggers-sending-input"></a>

入力値を含めるには、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"
}
```

**注記**  
`InputPayload` 値は、オートメーションの入力スキーマに一致する入力フィールド値を含む JSON シリアル化された文字列である必要があります。

### API を使用して出力値を取得する
<a name="api-triggers-retrieving-output"></a>

**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"
}
```

**注記**  
**OutputPayload** フィールドは、自動化が正常に完了した後 (**JobStatus** が の場合) にのみ使用できます`SUCCEEDED`。自動化が失敗するか、まだ実行されている場合、レスポンスには **OutputPayload** フィールドは含まれません。

## 入力と出力を使用してオートメーションをデプロイして実行する
<a name="deploy-run-inputs-outputs"></a>

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

### デプロイ前にスキーマ情報を表示する
<a name="view-schema-before-deployment"></a>

オートメーションをデプロイする前に、それをコミットしてバージョンを作成する必要があります。詳細については、[「オートメーションバージョンの保守](https://docs.aws.amazon.com/quicksuite/latest/userguide/building-automations.html#managing-automation-versions)」を参照してください。

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

### 入力スキーマと出力スキーマを使用してオートメーションをデプロイする
<a name="deploy-with-schemas"></a>

入力スキーマまたは出力スキーマが定義されているオートメーションをデプロイすると、デプロイダイアログボックスにデータ**モデル**セクションにスキーマ情報が表示されます。
+ 入力フィールドと出力フィールドの定義 (名前、データ型、説明、必須またはオプションのステータス、デフォルト値）。
+ API 発信者が統合に使用できる入力と出力のコピー可能な JSON スキーマ。

**重要**  
スキーマは、自動化コードとともにデプロイ時にフリーズされます。デプロイ後にスキーマを更新する場合は、変更を有効にするために自動化を再デプロイする必要があります。

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

### デプロイされたオートメーションを手動で実行する
<a name="run-deployed-manually"></a>

入力を使用してデプロイされたオートメーションを開始するには、次の手順を実行します。
+ デプロイページで、**アクション**メニュー (⋮) を選択します。
+ **今すぐ実行** を選択します。
+ **入力値を指定する**ダイアログボックスで、各入力フィールドに値を入力します。
+ **開始** を選択して自動化の実行を開始します。

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

### スケジュールされたトリガーを使用してオートメーションを実行する
<a name="run-with-scheduled-triggers"></a>

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

以下を行うことができます。
+ 同じオートメーションに対して異なる入力値を持つ複数のトリガーを作成する
+ 自動化を再デプロイせずにトリガーの入力値を編集する

スケジュールされたトリガーの入力を設定するには、次の手順を実行します。
+ オートメーションのデプロイページに移動します。
+ **トリガーの作成**を選択します。
+ **ステップ 1: トリガーを設定する**で、スケジュールを設定します。
+ **ステップ 2: 実行を定義する** で、自動生成されたフォームの各入力フィールドに値を入力します。
+ Next を選択し****、設定を確認し、**Create Trigger **を選択します。

**注記**  
特定のスキーマバージョンでトリガーを作成し、後で更新されたスキーマで自動化をデプロイする場合は、トリガーを変更する必要があります。スキーマバージョンが変更され、自動化の実行が失敗すると、トリガーに互換性がありません。

### デプロイされた実行の入力と出力の表示
<a name="viewing-inputs-outputs-deployed"></a>

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

アーティファクトは専用カードとして表示されます。
+ **入力アーティファクト** – ログパネルの上部に表示されます
+ **出力アーティファクト** – ログパネルの下部に表示されます (自動化が正常に完了した場合にのみ使用可能）。

両方のカードはデフォルトで折りたたまれます。これらを展開すると、次のことができます。
+ スキーマ全体と実際の値を表示する
+ 入力または出力に含まれるファイルオブジェクトをダウンロードする
+ 構造化データを JSON としてコピーする
+ 完全なペイロードを JSON ファイルとしてダウンロードする