

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

# での EventBridge の使用 AWS HealthOmics
<a name="eventbridge"></a>

HealthOmics は、リソースのステータスが変更されたときに Amazon EventBridge にイベントを送信します。リソースには、インポートジョブ、エクスポートジョブ、リソース共有、ワークフロー、タスク、実行が含まれます。リソースのタイプごとに、イベントを生成するステータス変更のリストがあります。

イベントバスは、イベントを受信して送信先に配信するルーターです。アカウントには、 AWS サービスからイベントを自動的に受信するデフォルトのイベントバスが含まれています。追加のカスタムイベントバスを作成できます。

EventBridge ルールを作成して、イベントバスがイベントを受信したときに実行するアクションを指定します。たとえば、リソースのステータス変更を通知するルールを作成できます。

イベントを使用する一般的なシナリオは次のとおりです。
+ ユーザーがリソースを共有したとき、または共有を取り消したときを監視します。
+ 実行が失敗するか、正常に完了したかをモニタリングするには。

EventBridge の使用の詳細については、[「Amazon EventBridge とは」を参照してください。](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-what-is.html)

**Topics**
+ [HealthOmics の EventBridge を設定する](#eventbridge-setup-events)
+ [HealthOmics の EventBridge イベント](#eventbridge-healthomics-events)
+ [イベントメッセージの構造](#eventbridge-message-structure)
+ [イベントメッセージの例](#eventbridge-cli-examples)

## HealthOmics の EventBridge を設定する
<a name="eventbridge-setup-events"></a>

EventBridge イベントをモニタリングする前に、EventBridge バスを作成し、目的のイベントのルールを作成します。

### EventBridge バスを設定する
<a name="eventbridge-setup-bus"></a>

のデフォルトのイベントバスを使用する AWS アカウント か、カスタムイベントバスを設定できます。カスタムイベントバスを設定するには、次の手順に従います。

1. EventBridge コンソールを開きます: [https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/)。

1. 左側のナビゲーションで、**イベントバス**を選択します。

1. [**イベントバスの作成 (Create event bus)**] を選択します。

1. **イベントバスの作成**フォームに、バスの名前を入力します。

1. **Create** を選択してバスを作成します。

### EventBridge ルールを作成します
<a name="eventbridge-create-rule"></a>

次の手順は、シンプルなルールを作成する方法を示しています。ルールの詳細については、[EventBridge のルール](https://docs.aws.amazon.com//eventbridge/latest/userguide/eb-create-rule.html)」を参照してください。

1. EventBridge コンソールを開きます: [https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/)。

1. 左のナビゲーションで、**ルール** を選択します。

1. **[‬ルールを作成]‭** を選択します。コンソールで**ルールの作成**フォームが開きます。

1. **ルールの詳細の定義**で、ルールの名前を指定します。
   + Name に****、バスの名前を入力します。
   + **イベントバス**で、このルールのバスを選択します。
   + [**次へ**] を選択します。

1. **ビルドイベントパターン**で、**イベントソース**で **AWS イベントまたは EventBridge パートナーイベント**を選択します。

1. **イベントパターン**まで下にスクロールします。

   1. **イベントソース**で、**AWS サービス**を選択します。

   1. **AWS サービス**の場合は、テキストフィルターに**オミクス**を入力し、サービス**AWS HealthOmics**として を選択します。

   1. **イベントタイプ**で、目的のイベント (または**すべてのイベント**) を選択します。

   1. [**次へ**] を選択します。

1. **Select target (s)** で、イベントのターゲットを選択します。たとえば、**AWS サービス**、選択した **CloudWatch ロググループ**を選択し、ロググループを設定します。

   多くのターゲットタイプで、EventBridge はターゲットにイベントを送信するためのアクセス許可が必要です。コンソールでは、これらのアクセス許可が自動的に作成されます。

1. (オプション) **タグの設定**で、タグをルールに関連付けます。

1. **「確認と更新**」で、設定を確認し、**ルールの作成**を選択します。

## HealthOmics の EventBridge イベント
<a name="eventbridge-healthomics-events"></a>

次の表に、HealthOmics が EventBridge に送信するイベントと、そのイベントで可能なステータス値のリストを示します。


| イベント名 | 可能なステータス値 | 
| --- | --- | 
| 注釈インポートジョブのステータスの変更 | 送信済み、進行中、キャンセル済み、完了済み、失敗、または失敗して完了 | 
| Annotation Store 共有ステータスの変更 | 保留中、アクティブ化中、アクティブ、削除中、削除済み、失敗 | 
| Annotation Store のステータス変更 | 作成、作成、更新、更新、削除、削除、または作成に失敗しました | 
| 読み取りセットのアクティベーションジョブのステータスの変更 | 送信済み、進行中、完了、失敗、または失敗して完了 | 
| 読み取りセットのエクスポートジョブのステータスの変更 | 送信済み、進行中、完了、失敗、または失敗して完了 | 
| 読み取りセットのインポートジョブのステータスの変更 | 送信済み、進行中、完了、失敗、または失敗して完了 | 
| 読み取りセットのステータス変更 | アップロード、アップロード失敗、アクティブ、アーカイブ済み、アクティブ化、または削除の処理 | 
| リファレンスインポートジョブのステータスの変更 | 送信済み、進行中、完了、失敗、または失敗して完了 | 
| リファレンスステータスの変更 | アクティブまたは削除済み | 
| リファレンスストアのステータスの変更 | 作成、更新、アクティブ、または削除済み | 
| 実行ステータスの変更 | 保留中、開始中、実行中、停止中、完了済み、削除済み、失敗、またはキャンセル済み | 
| シーケンスストアのステータスの変更 | 作成、更新、アクティブ、または削除済み | 
| タスクステータスの変更 | 保留中、開始中、実行中、停止中、完了済み、削除済み、失敗、またはキャンセル済み | 
| バリアントインポートジョブのステータスの変更 | 送信済み、進行中、キャンセル済み、完了済み、失敗、または失敗して完了 | 
| バリアントストアの共有ステータスの変更  | 保留中、アクティブ化中、アクティブ、削除中、削除済み、失敗 | 
| バリアントストアのステータスの変更 | 作成、作成、更新、更新、削除、削除、または作成に失敗しました | 
| ワークフロー共有ステータスの変更  | 保留中、アクティブ化中、アクティブ、削除中、削除済み、失敗 | 
| ワークフローステータスの変更 | 作成成功、作成失敗、削除成功、または削除失敗 | 

## イベントメッセージの構造
<a name="eventbridge-message-structure"></a>

HealthOmics は、EventBridge に状態変更イベントメッセージを送信するためのベストエフォート配信を提供します。イベントは、メタデータの詳細も含まれる JSON 構造を持つオブジェクトです。メタデータを入力として使用して、イベントを再作成したり、詳細を確認したりできます。イベントには次のフィールドが含まれます。
+  `version` — 現在、すべてのイベントで 0 (ゼロ）。
+  `id` — イベントごとに生成されるバージョン 4 UUID。
+  `detail-type` — 送信されるイベントのタイプ。
+  `account` — バケット所有者の 12 桁の AWS アカウント ID。
+  `source` — イベントを生成したサービスを識別します。
+  `time` — イベントが発生した時刻。
+  `region` — バケット AWS リージョン の を識別します。
+  `resources` — バケットの Amazon リソースネーム (ARN) を含む JSON 配列。
+  `detail` — イベントに関する情報を含む JSON オブジェクト。

実行イベントには、次のフィールドが含まれます。
+  `uuid` — 実行の汎用一意識別子。
+  `workflowId` — この実行に関連付けられたワークフローのワークフロー識別子。
+  `workflowName` — この実行に関連付けられたワークフローの名前。
+  `runId` — 実行識別子。
+  `runName` — 実行名。
+  `runOutputUri` — 実行が出力データを書き込む URI。

## イベントメッセージの例
<a name="eventbridge-cli-examples"></a>

次の例は、実行ステータスの変更に関するイベントで、追加のフィールドを示しています。

```
{
    "version":"0",
    "id":"c0e540f4-df38-b986-86c1-3e3730f971fe",
    "detail-type":"Run Status Change",
    "source":"aws.omics",
    "account":"123456789012",
    "time":"2022-10-20T22:07:35Z",
    "region":"us-west-2",
    "resources":[
        "arn:aws:omics:us-west-2:123456789012:run/2101313"
    ],
    "detail":{
        "omicsVersion":"1.0.0",
        "arn":"arn:aws:omics:us-west-2:123456789012:run/2101313",
        "status":"COMPLETED",
        "uuid":"153893cd-097a-40ec-aec7-838a97cd2b21",
        "runId": "1234567",
        "runName": "run name",
        "runOutputUri": "s3://amzn-s3-demo-bucket/run-output/2101313",
        "workflowId": "1234567",
        "workflowName": "workflow name"
    }  
}
```

次の例は、タスクステータスの変更のイベントです。

```
{
    "version": "0",
    "id": "718d6817-c868-26d3-8ef0-0dc9b2ac73f4",
    "detail-type": "Task Status Change",
    "source": "aws.omics",
    "account": "123456789012",
    "time": "2024-10-30T09:05:44Z",
    "region": "us-west-2",
    "resources": ["arn:aws:omics:us-west-2:123456789012:task/8888888"],
    "detail": {
        "omicsVersion": "1.0.0",
        "arn": "arn:aws:omics:us-west-2:123456789012:task/8888888",
        "status": "COMPLETED",
        "runArn": "arn:aws:omics:us-west-2:123456789012:run/2101313",
        "runUuid": "153893cd-097a-40ec-aec7-838a97cd2b21",
        "runId": "1234567",
        "runName": "run name",
        "workflowId": "1234567",
        "workflowName": "workflow name"
    }      
}
```

以下は、リードセットのステータス変更のイベントの例です。

```
{
  "version": "0",
  "id": "64ca0eda-9751-dc55-c41a-1bd50b4fc9b7",
  "detail-type": "Read Set Status Change",
  "source": "aws.omics",
  "account": "123456789012",
  "time": "2023-04-04T17:53:06Z",
  "region": "us-west-2",
  "resources": ["arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/3456789012"],
  "detail": {
     "omicsVersion": "1.0.0",
     "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/3456789012",
     "sequenceStoreId" : "1234567890", 
     "id": "3456789012", 
     "status": "PROCESSING_UPLOAD"
  }
}
```

バリアントストアのインポートジョブに同様のイベントが作成されます。

```
{
    "version": "0",
    "id": "6a7e8feb-b491-4cf7-a9f1-bf3703467718",
    "detail-type": "Variant Store Status Change",
    "source": "aws.omics",
    "account": "123456789012",
    "time": "2015-12-22T18:43:48Z",
    "region": "us-east-1",
    "resources": ["arn:aws:omics:us-east-1:123456789012:myvariantstore2"],
    "detail": {
       "omicsVersion": "1.0.0",
       "arn": "arn:aws:omics:us-east-1:123456789012:myvariantstore2",
       "status": "CREATED",
       "storeId": "6710c5f02610", 
       "storeName": "myvariantstore2"
    }
}
```

以下は、インポートジョブのステータスの変更に関するイベントです。

```
{
    "version": "0",
    "id": "6a7e8feb-b491-4cf7-a9f1-bf3703467718",
    "detail-type": "Variant Import Job Status Change",
    "source": "aws.omics",
    "account": "123456789012",
    "time": "2015-12-22T18:43:48Z",
    "region": "us-east-1",
    "resources": ["arn:aws:omics:us-east-1:123456789012:my_variant_store/b64ea9a3-459f-4b68-92c3-3ddb83209fe9"],
    "detail": {
       "omicsVersion": "1.0.0",
       "arn": "arn:aws:omics:us-east-1:123456789012:my_variant_store/b64ea9a3-459f-4b68-92c3-3ddb83209fe9",   
       "status": "COMPLETED",
       "jobId": "b64ea9a3-459f-4b68-92c3-3ddb83209fe9",
       "storeId": "a74869f91e20",
       "storeName": "my_variant_store"
    }
}
```