在 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. 如果您选择了 I n th i AWS 账户 s，请从下拉列表中选择 API 阶段名称

在高级配置 - 可选下，您可以选择连接现有 Amazon API Gateway 使用计划，以使用现有使用计划中定义的节流和配额限制，然后输入 API 密钥。

在面向订阅者的文档 API 下，提供有关接收者在接受数据授权后将看到的 API 的相关详细信息。

1. 在 API 名称中，输入接收者可以用来识别 API 资产的名称。

   注意

   如果选择的是在这个 AWS 账户中，则会自动填充 API 名称，您可以根据需要对其进行修改。

   如果选择的是另一个 AWS 账户中的 API，则 API 名称将会填充为默认名称。您应该修改该默认名称，以便接收者可以轻松了解这个 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。

此外，在接收者访问信息部分的访问结束日期下，选择数据授权是否应永久运行，如果是，则选择无结束日期；或者是否应具有结束日期，如果是，则选择特定结束日期，然后选择所需的结束日期。

选择下一步。

在审核并发送部分中，审核您的数据授权信息。

如果您确定要创建数据授权并将其发送给选定的接收者，请选择创建并发送数据授权。