AWS Entity Resolution OpenAPI 仕様の使用

OpenAPI 仕様は、関連するすべてのプロトコルを定義します AWS Entity Resolution。この仕様は、統合を実装するために必要です。

OpenAPI 定義には、次の API オペレーションが含まれています。

POST AssignIdentities
POST CreateJob
GET GetJob
POST StartJob
POST MapIdentities
GET Schema

OpenAPI 仕様をリクエストするには、 AWS Entity Resolution ビジネス開発チーム <aws-entity-resolution-bd@amazon.com> にお問い合わせください。

OpenAPI 仕様は、コンシューマー識別子のバッチ処理と同期処理の両方について、エンコードとトランスコードの両方の 2 種類の統合をサポートしています。OpenAPI 仕様を取得したら、ユースケースの処理統合のタイプを実装します。

バッチ処理の統合

バッチ処理の統合は、非同期設計パターンに従います。ワークフローが開始されると AWS Data Exchange、プロバイダー統合エンドポイントを介してジョブが送信され、ワークフローはジョブのステータスを定期的にポーリングしてこのジョブの完了を待ちます。このソリューションは、時間がかかり、プロバイダーのスループットが低いジョブ実行に適しています。プロバイダーは、データセットの場所を Amazon S3 リンクとして取り込みます。Amazon S3 リンクは、プロバイダー側で処理し、結果を事前に定義された出力 S3 の場所に書き込むことができます。

バッチ処理統合は、3 つの API 定義を使用して有効 AWS Entity Resolution になります。は、を介して利用可能なプロバイダーエンドポイントを次の順序 AWS Data Exchange で呼び出します。

POST CreateJob: この API オペレーションは、処理するジョブ情報をプロバイダーに送信します。これらの情報は、エンコードまたはトランスコーディング、S3 の場所、顧客が提供するスキーマ、必要な追加のジョブプロパティなど、ジョブのタイプに関するものです。

この API はを返しJobId、ジョブのステータスは PENDING、、READY、COMPLETE、または IN_PROGRESSのいずれかになりますFAILED。

エンコードのサンプルリクエスト
```
POST /jobs
{
  "actionType": "ID_ASSIGNMENT",
  "s3SourceLocation": "string",
  "s3TargetLocation": "string",
  "jobProperties": {
    "assignmentJobProperties": {
      "fieldMappings": [
        {
          "name": "string",
          "type": "NAME"
        }
      ]
    }
  },
  "customerSpecifiedJobProperties": {
    "property1": "string",
    "property2": "string"
  },
  "outputSourceConfiguration": {
    "KMSArn": "string"
  }
}
```
レスポンス例
```
{
  "jobId": "string",
  "status": "PENDING"
}
```
POST StartJob: この API は、JobId提供されたに基づいてジョブを開始することをプロバイダーに通知します。これにより、プロバイダーはから CreateJobまで必要な検証を実行できますStartJob。

この API はJobId、、ジョブStatusの、、statusMessageおよびを返しますstatusCode。

エンコードのサンプルリクエスト
```
POST/jobs/{jobId}
{
  "customerSpecifiedJobProperties": {
    "property1": "string",
    "property2": "string"
  }
}
```
レスポンス例
```
{
  "jobId": "string",
  "status": "PENDING",
  "statusMessage": "string",
  "statusCode": 200
}
```
GET GetJob: この API は、ジョブが完了した AWS Entity Resolution か、その他のステータスになったかを通知します。

この API はJobId、、ジョブStatusの、、statusMessageおよびを返しますstatusCode。

エンコードのサンプルリクエスト
```
GET /jobs/{jobId}
```
レスポンス例
```
{
  "jobId": "string",
  "status": "PENDING",
  "statusMessage": "string",
  "statusCode": 200
}
```

これらの APIsは、 AWS Entity Resolution OpenAPI 仕様に記載されています。

同期処理の統合

同期処理ソリューションは、スループットが高く TPS が高いリアルタイム応答時間を持つほぼリアルタイムの応答時間を持つプロバイダーにとってより望ましい方法です。この AWS Entity Resolution ワークフローでは、データセットをパーティション化し、複数の API リクエストを並行して実行します。次に、 AWS Entity Resolution ワークフローは、目的の出力場所に結果を書き込む処理を行います。

このプロセスは、API 定義のいずれかを使用して有効になります。は、以下を通じて利用可能なプロバイダーエンドポイントを AWS Entity Resolution 呼び出します AWS Data Exchange。

POST AssignIdentities: この API は、source_id識別子を使用して、そのレコードrecordFieldsに関連付けられたデータをプロバイダーに送信します。

この API はを返しますassignedRecords。

エンコードのサンプルリクエスト


POST /assignment
{
  "sourceRecords": [
    {
      "sourceId": "string",
      "recordFields": [
        {
          "name": "string",
          "type": "NAME",
          "value": "string"
        }
      ]
    }
  ]
}

レスポンス例


{
  "assignedRecords": [
    {
      "sourceRecord": {
        "sourceId": "string",
        "recordFields": [
          {
            "name": "string",
            "type": "NAME",
            "value": "string"
          }
        ]
      },
      "identity": any
    }
  ]
}

これらの APIsは、 AWS Entity Resolution OpenAPI 仕様に記載されています。

プロバイダーが選択するアプローチに応じて、 AWS Entity Resolution はエンコードまたはトランスコードの開始に使用されるプロバイダーの設定を作成します。さらに、これらの設定は、が提供する APIs を使用してお客様が利用できます AWS Entity Resolution。

この設定には、のプロバイダーサービスがホストされている場所から派生した Amazon リソースネーム (ARN) と、プロバイダーサービスのタイプを使用してアクセスできます。 AWS Data Exchange はこの ARN をと AWS Entity Resolution 呼んでいますproviderServiceARN。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

要件

プロバイダー統合のテスト