在 AWS Data Exchange 包含 APIs的 上建立資料授權

將下列政策新增至 API 的資源政策：

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

account-id 將 取代為將建立 API 資料集的帳戶。

具有 API Gateway 資源的帳戶不需要位於建立資料集的相同帳戶中。

開啟您的 Web 瀏覽器並登入 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 階段。

在選取 API 階段下，針對 Amazon API Gateway 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"
    }
    ]
}

在修訂概觀上，選擇取消最終化。

您看到修訂不再處於最終狀態的訊息。

若要編輯修訂，請從修訂概觀中，選擇動作、編輯。

進行變更，然後選擇更新。

檢閱您的變更，然後選擇完成。

在修訂概觀上，選擇刪除。

Delete 在刪除修訂對話方塊中輸入 ，然後選擇刪除。

在 AWS Data Exchange 主控台的左側導覽窗格中，在交換資料授權下，選擇傳送資料授權。

從傳送的資料授權中，選擇建立資料授權以開啟定義資料授權精靈。

在選取擁有的資料集區段中，選取您要新增之資料集旁的核取方塊。

在授予概觀區段中，輸入收件人將看到的資料授予相關資訊，包括資料授予名稱和資料授予描述。

選擇下一步。

在收件人存取資訊區段的 AWS 帳戶 ID 下，輸入應接收資料授權的收件人帳戶 AWS 帳戶 ID。

此外，在收件人存取資訊區段的存取結束日期下，選擇資料授予是否應該永久執行、選擇無結束日期，還是應該有結束日期、選擇特定結束日期，然後選擇所需的結束日期。

選擇下一步。

在檢閱和傳送區段中，檢閱您的資料授權資訊。

如果您確定要建立資料授權並將其傳送給所選的收件人，請選擇建立並傳送資料授權。