AWS Data Exchange を含む での製品の公開 APIs

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

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

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

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ステージ を選択 でAPI入力ボックスに を入力するか、ドロップダウンリストから次のいずれかを選択します。

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

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

詳細設定 – オプション で、既存の Amazon API Gateway 使用プランを接続して、既存の使用プランで定義されているスロットリングとクォータの制限を使用し、APIキー を入力できます。

サブスクライバーAPIのドキュメント で、サブスクライバーAPIが製品をサブスクライブした後に表示される の詳細を指定します。

1. API 名前 には、サブスクライバーがAPIアセットの識別に使用できる名前を入力します。

   注記

   これで AWS アカウント を選択した場合、API名前は自動的に入力され、必要に応じて変更できます。

   API 別の で AWS アカウント を選択した場合、API名前にはデフォルト名が入力されます。サブスクライバーが名前を簡単に理解できるように、 に変更する必要があります。

2. OpenAPI 3.0 仕様の場合、次のいずれかを実行します。

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

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

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

   3. Amazon API Gateway からインポート を選択し、インポートする仕様を選択します。

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

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

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

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

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

追加APIsする項目がある場合は、ステップ 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 コンソールの左側のナビゲーションペインにある [データを発行] で [製品] を選択します。

[製品] で [新しい製品を発行] を選択して [新しい製品を発行] ウィザードを開きます。

製品の可視性で

1. 商品の商品表示オプションを [公開] または [非公開] から選択します。

   可視性が Public に設定されているすべての AWS Data Exchange 製品には、パブリックオファーが必要です。

   詳細については、「での製品の可視性 AWS Data Exchange」を参照してください。

2. 製品の機密情報設定を選択します。

   詳細については、「の機密情報のカテゴリ AWS Data Exchange」を参照してください。

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

[データを追加] で:

1. [所有データセット] で、追加するデータセットの横にあるチェックボックスを選択し、[選択項目を追加] を選択します。

   注記

   選択するデータセットには、確定済みのリビジョンが必要です。確定済みのリビジョンがないデータセットは追加されません。

2. [選択したデータセット] に移動して、選択内容を確認します。

   データセットの 名前、データセットの タイプ、データセットの最終更新 時のタイムスタンプを確認できます。

3. [リビジョンアクセスルールを選択] にスクロールして、この製品に含まれるデータセットに設定するリビジョンアクセスルールを選択し、[次へ] を選択します。

   詳細については、「でのアクセスルールの改訂 AWS Data Exchange」を参照してください。

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

[製品を定義] では:

1. [製品概要] に、 製品名、 製品ロゴ、 お問い合わせ先 情報、 製品カテゴリ など、製品に関する情報を入力します。

   詳細については、「での製品のベストプラクティス AWS Data Exchange」を参照してください。

2. (オプション) [データディクショナリとサンプル — オプション] で、データセット名の横にあるオプションボタンを選択してデータセットを選択し、[編集] を選択します。

   1. [編集] ダイアログボックスで [アップロード] を選択し、新しいデータディクショナリをアップロードします。

      .csv 形式の最大サイズが 1 MB のデータディクショナリを 1 つ選択できます。

   2. コンピューターから保存されているデータディクショナリを選択し、[開く] を選択します。

      データディクショナリの.csv ファイルが [編集] ダイアログボックスに表示されます。

      注記

      AWS Data Exchange データディクショナリはデータディクショナリテンプレートに準拠している必要があります。アップロードするデータディクショナリが保存されていない場合は、 AWS Data Exchange コンソールで 空のデータディクショナリテンプレート リンクまたは サンプルデータディクショナリ リンクを選択できます。

   3. [データディクショナリのプレビュー] を選択してデータディクショナリをプレビューします。

   4. 「サンプル-オプション」で「サンプルをアップロード」を選択し、コンピューターからサンプルを選択して、「開く」を選択します。

      サンプルは「編集」ダイアログボックスに表示されます。

      注記

      最大 10 個のサンプルをアップロードできます。最大サイズは 50 MB です。.csv 形式のサンプルはプレビューできます。

   5. 商品詳細ページに表示される各サンプルの説明を入力します。

   6. [保存] を選択します。

[商品定義] に、商品の [簡単な説明] と [詳細な説明] を入力します。

詳細説明にテンプレートを使用する場合は、[テンプレートを適用] を選択し、テンプレートの種類を選択してから、テンプレートに特定の商品情報を入力します。

[次へ] をクリックします。

「公開オファーを追加」(公開オファー用) または「カスタムオファーを追加」(非公開オファー用)でオファーを設定します。

可視性が Public に設定されているすべての AWS Data Exchange 製品には、パブリックオファーが必要です。

1. プライベートオファーのみ:

   1. リストされているオファータイプのいずれかを選択します。プライベートオファー 、更新済みのプライベートオファー 、または Bring Your Own Subscription (BYOS）。

   2. [サブスクライバーアカウント情報] セクションで、オファーを提示するサブスクライバーアカウントを少なくとも 1 つ追加します。

2. サブスクリプションの [料金とアクセス期間] オプションを選択します。

3. 従量制料金（オプション）の場合は、[追加]を選択します。

   1. 計測コストを追加する の場合、タイプリストからAPI通話のコストのタイプを選択します。

      • APIリクエストごと

      • 成功したAPIリクエストごと

      • 転送されたデータ単位 (バイト)

      • 新しいカスタム従量制コスト

   2. 購読者の請求書に記載されているコスト表示名を入力または更新します。

   3. 事前に定義された従量制料金を使用している場合、キーは自動的に生成され、編集できないため、レスポンスヘッダーに送り返す必要もありません。

   4. 新しいカスタム計測コスト を作成する場合は、APIレスポンスヘッダーに計測コストの識別子であるキー を入力します (最大 15 文字）。

      この キー は x-amz-dataexchange-metering レスポンスヘッダーの一部として送り返す必要があります。

      例 カスタムキー

      というカスタムキーVertexCountと という別のカスタムキーがある場合EdgeCount、x-amz-dataexchange-metering「」レスポンスヘッダーの値は VertexCount=3,EdgeCount=10であるか、2 つの個別のヘッダー行を返すことができます。

      x-amz-dataexchange-metering: VertextCount=3

      x-amz-dataexchange-metering: EdgeCount=10

   5. サブスクライバーがユニットごとに請求する価格を [価格/ユニット] に入力します。

   6. (オプション) 単位数を入力すると、従量制料金計算ツール に費用の例が表示されます。

   7. (オプション) 商品詳細ページに表示される従量制コストの簡単な説明を入力します。

   8. [追加] を選択します。

   9. (オプション) 同じ手順を繰り返して、その他の従量制料金を追加します。 

      従量制費用の順序は商品詳細ページに表示されます。並べ替えることはできません。

      注記

      オファーの作成後、従量制料金の価格と説明を編集できます。詳細については、「で製品とオファーの詳細を更新する AWS Data Exchange」を参照してください。

4. [オファーの有効期限] を選択します。サブスクライバーはこの日までにオファーを受諾する必要があります。

5. 税金設定 、データサブスクリプション契約 (DSA）、および返金ポリシー を選択します。

6. (オプション) パブリック オファーの場合のみ、サブスクリプション検証 を設定します。これにより、この製品をサブスクライブできるユーザーを制御できるようになります。詳細については、「のプロバイダーのサブスクリプション検証 AWS Data Exchange」を参照してください。

7. [オファーの自動更新] オプションを選択します。詳細については、「AWS Data Exchange 製品のオファーの作成」を参照してください。

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

「レビューと公開」セクションで、商品情報を確認します。

1. 商品ページのプレビューを展開して、公開後に商品ページがどのように表示されるかを確認してください。

2. (オプション) 任意のセクションの [編集]ボタンを選択して、そのセクションを編集します。

製品とパブリックオファーをユーザー全員に表示し、利用可能にしてもよい場合は、[公開] を選択します。

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

左側のナビゲーションペインにある [データを発行] で [製品] を選択します。

[製品] で、コピーする製品の横にあるボタンをオンにします。

[アクション] ドロップダウンから [コピーを作成] を選択します。

[新しい製品を公開] ワークフローを続行します。ワークフローの詳細情報は、ステップ 3 で選択した製品に基づいて既に入力されています。詳細については、「ステップ 5: 新しい製品を公開する」を参照してください。