APIs AWS Data Exchange を含む でのデータ許可の作成

API のリソースポリシーに、以下のポリシーを追加します。

{
"Effect": "Allow",
"Principal": {"Service": "dataexchange.amazonaws.com"},
"Action": "execute-api:Invoke",
"Resource": "*",
"Condition": {"StringEquals": {"aws:SourceAccount": "<account-id>"}}
}

account-id は、API データセットを作成することになるアカウントに置き換えます。

API Gateway リソースを持つアカウントが、データセットを作成しているアカウントと同じアカウントである必要はありません。

ウェブブラウザを開き、AWS Data Exchange コンソール にサインインします。

左側のナビゲーションペインで、[マイデータ] の [所有データセット] を選択します。

[所有データセット] で [データセットを作成] を選択し、[データセット作成のステップ] ウィザードを開きます。

[データセットタイプを選択] で、[Amazon API Gateway API] を選択します。

[データセットを定義] で、データセットの [名前] と [説明] を入力します。詳細については、「データセットのベストプラクティス」を参照してください。

(オプション) [タグを追加 – オプション] でタグを追加します。

[作成] を選択します。

create-data-set コマンドを使用して、API データセットを作成します。

$ AWS dataexchange create-data-set \
-\\-asset-type API_GATEWAY_API \
-\\-description 'Data Set Description' \
-\\-name 'Data Set Name'

{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID",
"AssetType": "API_GATEWAY_API",
"CreatedAt": "2021-09-11T00:16:46.349000+00:00",
"Description": "Data Set Description",
"Id": "$DATA_SET_ID",
"Name": "Data Set Name",
"Origin": "OWNED",
"UpdatedAt": "2021-09-11T00:16:46.349000+00:00"
}

新しいアセットタイプの API_GATEWAY_API に注目してください。

データセットの詳細ページの [データセットの概要] セクションで以下を実行します。

1. (オプション) [名前を編集] を選択してデータセットに関する情報を編集します。

2. (オプション) [削除] を選択してデータセットを削除します。

[リビジョン] セクションで [リビジョンを作成] を選択します。

[リビジョンを定義] で、リビジョンの目的を説明するリビジョンのオプションのコメントを入力します。

(オプション) [タグを追加 – オプション] で、リソースに関連付けられているタグを追加します。

[リビジョンを作成] を選択します。

前のステップからの変更を確認、編集、または削除します。

create-revision コマンドを使用して、リビジョンを作成します。

$ AWS dataexchange create-revision \
-\\-data-set-id $DATA_SET_ID \
-\\-comment 'First Atlas Revision'
{
"Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID",
"Comment": "First Atlas Revision",
"CreatedAt": "2021-09-11T00:18:49.160000+00:00",
"DataSetId": "$DATA_SET_ID",
"Finalized": false,
"Id": "$REVISION_ID",
"UpdatedAt": "2021-09-11T00:18:49.160000+00:00"
}

リビジョンに API アセットを追加します。

データセットの詳細ページの [API アセット] セクションで、[追加] を選択します。

[API ステージを選択] にある [Amazon API Gateway API] で、入力ボックスに API を入力するか、ドロップダウンリストから以下のいずれかを選択します。

1. 別の で API AWS アカウント を選択した場合は、入力ボックスに API ID と API ステージ名を入力します。

2. これ AWS アカウントを選択した場合は、ドロップダウンリストから API ステージ名を選択します。

[Advanced configuration – optional] (高度な設定 – オプション) では、[Connect existing Amazon API Gateway usage plan] (既存の Amazon API Gateway の使用量プランを接続) することを選択して既存の使用プランに定義されているスロットリングとクォータ制限を使用し、[API key] (API キー) を入力することができます。

[サブスクライバーのドキュメント API] で、受取人がデータ許可を承諾した後に表示する API の詳細を指定します。

1. [API 名] に、受取人が API アセットを識別するために使用できる名前を入力します。

   注記

   [この AWS アカウントの中で] が選択されている場合、[API 名] が自動入力されていますが、これは必要に応じて変更できます。

   [別の AWS アカウントの API] を選択した場合、[API 名] にはデフォルトの名前が入力されます。これを、受取人が API を簡単に理解できるような名前に変更してください。

2. [OpenAPI 3.0 specification] (OpenAPI 3.0 仕様) には、以下のいずれかを実行します。

   1. OpenAPI 3.0 仕様ファイルを入力するか、コピーして貼り付ける。

   2. [.JSON ファイルからインポート] を選択して、ローカルコンピュータからインポートする.json ファイルを選択する。

      インポートされた仕様がボックスに表示されます。

   3. [Import from Amazon API Gateway] (Amazon API Gateway からインポート) を選択して、インポートする仕様を選択する。

      インポートされた仕様がボックスに表示されます。

3. [その他のドキュメント – オプション] には、サブスクライバーが API について知っておくと役に立つ追加情報を入力します。Markdown がサポートされています。

[API ステージを追加] を選択します。

アセット (この場合は API) をデータセットにインポートするジョブが開始されます。

ジョブが終了したら、[ジョブ] セクションの [状態] フィールドが [完了] に更新されます。

追加する API がある場合は、ステップ 2 を繰り返します。

[リビジョンの概要] で、リビジョンとそのアセットを確認します。

[確定] を選択します。

create-job コマンドを使用して、リビジョンに API アセットを追加します。

$ AWS dataexchange create-job \
  -\\-type IMPORT_ASSET_FROM_API_GATEWAY_API \
  -\\-details '{"ImportAssetFromApiGatewayApi":{"DataSetId":"$DATA_SET_ID","RevisionId":"$REVISION_ID","ApiId":"$API_ID","Stage":"$API_STAGE","ProtocolType":"REST"}}'
{
    "Arn": "arn:aws:dataexchange:us-east-1:123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
        }
    },
    "Id": "$JOB_ID",
    "State": "WAITING",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:19.875000+00:00"
}

$ AWS dataexchange start-job -\\-job-id $JOB_ID
$ AWS dataexchange get-job -\\-job-id $JOB_ID
{
    "Arn": "arn:aws:dataexchange:us-east-1:0123456789012:jobs/$JOB_ID",
    "CreatedAt": "2021-09-11T00:38:19.875000+00:00",
    "Details": {
        "ImportAssetFromApiGatewayApi": {
            "ApiId": "$API_ID",
            "DataSetId": "$DATA_SET_ID",
            "ProtocolType": "REST",
            "RevisionId": "$REVISION_ID",
            "Stage": "$API_STAGE"
            "ApiEndpoint": "string",
            "ApiKey": "string",
            "ApiName": "string",            
            "ApiDescription": "string",
            "ApiSpecificationDownloadUrl": "string",
            "ApiSpecificationDownloadUrlExpiresAt": "string"
        }
    },
    "Id": "$JOB_ID",
    "State": "COMPLETED",
    "Type": "IMPORT_ASSET_FROM_API_GATEWAY_API",
    "UpdatedAt": "2021-09-11T00:38:52.538000+00:00"
}

list-revision-assets コマンドを使用して、新しいアセットが適切に作成されたことを確認します。

$ AWS dataexchange list-revision-assets \
  -\\-data-set-id $DATA_SET_ID \
  -\\-revision-id $REVISION_ID
{
    "Assets": [
    {
        "Arn": "arn:aws:dataexchange:us-east-1:123456789012:data-sets/$DATA_SET_ID/revisions/$REVISION_ID/assets/$ASSET_ID",
        "AssetDetails": {
            "ApiGatewayApiAsset": {
                "ApiEndpoint": "https://$API_ID.execute-api.us-east-1.amazonaws.com/$API_STAGE",
                "ApiId": "$API_ID",
                "ProtocolType": "REST",
                "Stage": "$API_STAGE"
            }
        },
        "AssetType": "API_GATEWAY_API",
        "CreatedAt": "2021-09-11T00:38:52.457000+00:00",
        "DataSetId": "$DATA_SET_ID",
        "Id": "$ASSET_ID",
        "Name": "$ASSET_ID/$API_STAGE",
        "RevisionId": "$REVISION_ID",
        "UpdatedAt": "2021-09-11T00:38:52.457000+00:00"
    }
    ]
}

[リビジョンの概要] で [確定解除] を選択します。

このリビジョンは確定済み状態ではなくなりましたというメッセージが表示されます。

リビジョンを編集するには、[リビジョンの概要] で、[アクション] 、[編集] の順に選択します。

変更を行ってから、[Update] (アップデート) を選択します。

変更内容を確認してから、[確定] を選択します。

[リビジョンの概要] で [削除] を選択します。

[リビジョンを削除しますか?] ダイアログボックスにDeleteを入力してから、[削除] を選択します。

AWS Data Exchange コンソールの左側のナビゲーションペインで、Exchanged data grants で、Sent data grants を選択します。

[送信されたデータ許可] から [データ許可を作成] を選択し、[データ許可を定義] ウィザードを開きます。

[所有しているデータセットを選択] セクションで、追加するデータセットの横にあるチェックボックスをオンにします。

[許可の概要] セクションに、データ許可名やデータ許可の説明など、データ許可に関して受取人に表示する情報を入力します。

次へ を選択します。

「受信者アクセス情報」セクションの AWS アカウント ID に、データ許可を受け取る受信者アカウントの AWS アカウント ID を入力します。

また、[受信者アクセス情報] セクションの [アクセスの終了日] で、[終了日なし] を選択してデータ許可を永続的に実行するか、[特定の終了日] を選択して希望の終了日を選択します。

[Next (次へ)] を選択します。

[確認して送信] セクションで、データ許可情報を確認します。

データ許可を作成して、選択した受取人に送信することを確定する場合は、[データ許可を作成して送信] を選択します。