Publishing a product in AWS Data Exchange containing APIs

Add the following policy to your API’s resource policy:

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

Replace account-id with the account that will be creating the API data set.

The account with the API Gateway resource does not need to be in the same account that is creating the data set.

Open your web browser and sign in to the AWS Data Exchange console.

On the left side navigation pane, under My data, choose Owned data sets.

In Owned data sets, choose Create data set to open the Data set creation steps wizard.

In Select data set type, choose Amazon API Gateway API.

In Define data set, enter a Name and Description for your data set. For more information, see Data set best practices.

(Optional) Under Add tags – optional, add tags.

Choose Create.

Use the create-data-set command to create an API data set:

$ 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"
}

Note the new Asset Type of API_GATEWAY_API.

On the Data set overview section of the data set details page:

1. (Optional) Choose Edit name to edit information about your data set.

2. (Optional) Choose Delete to delete the data set.

On the Revisions section, choose Create revision.

Under Define revision, provide an optional comment for your revision that describes the purpose of the revision.

(Optional) Under Add tags – optional, add tags associated with the resource.

Choose Create revision.

Review, edit, or delete your changes from the previous step.

Use the create-revision command to create a 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"
}

Add the API assets to the revision.

Under the API assets section of the data set details page, choose Add API stage.

Under Select API stage, for Amazon API Gateway API, enter an API in the input box or choose one of the following from the drop-down list:

1. If you chose API in another AWS account, enter the API ID and the API Stage name in the input boxes.

2. If you chose In this AWS account, choose the API Stage name from the drop-down list

Under Advanced configuration – optional, you can choose to Connect existing Amazon API Gateway usage plan to use the throttling and quota limits as defined in the existing usage plan, and enter the API key.

Under Document API for subscribers, provide details about the API that the subscribers will see after they subscribe to your product.

1. For API name, enter a name that subscribers can use to identify the API asset.

   Note

   If an In this AWS account was selected, the API name is automatically populated, which you can modify if necessary.

   If a API in another AWS account was selected, the API name is populated with a default name, which you should modify to so the subscriber can easily understand what it is.

2. For OpenAPI 3.0 specification, either:

   1. Enter or copy and paste the OpenAPI 3.0 specification file.

   2. Choose Import from .JSON file, and then select the .json file from your local computer to import.

      The imported specification appears in the box.

   3. Choose Import from Amazon API Gateway, and then choose a specification to import.

      The imported specification appears in the box.

3. For Additional documentation - optional, enter any additional information that is useful for the subscriber to know about your API. Markdown is supported.

Choose Add API stage.

A job is started to import your asset (in this case, the API) into your data set.

After the job is finished, the State field in the Jobs section is updated to Completed.

If you have more APIs to add, repeat Step 2.

Under Revision overview, review your revision and its assets.

Choose Finalize.

Use the create-job command to add API assets to the revision:

$ 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"
}

Use the list-revision-assets command to confirm that the new asset was created properly:

$ 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"
    }
    ]
}

On the Revision overview, choose De-finalize.

You see a message that the revision is no longer in the finalized state.

To edit the revision, from Revision overview, choose Actions, Edit.

Make your changes, and then choose Update.

Review your changes and then choose Finalize.

On the Revision overview, choose Delete.

Type Delete in the Delete revision dialog box, and then choose Delete.

From the left navigation pane of the AWS Data Exchange console, under Publish data, choose Products.

From Products, choose Publish new product to open the Publish new product wizard.

In Product visibility:

1. Choose your product's Product visibility options as either Public or Private.

   All AWS Data Exchange products with visibility set to Public require a public offer.

   For more information, see Product visibility in AWS Data Exchange.

2. Choose your product's Sensitive information configuration.

   For more information, see Sensitive categories of information in AWS Data Exchange.

3. Choose Next.

In Add data:

1. Under Owned data sets, select the check boxes next to the data sets you want to add, and then choose Add selected.

   Note

   The data sets you choose must have a finalized revision. Data sets without finalized revisions aren't added.

2. Go to Selected data sets to review your selections.

   You can review the Name of the data set, the Type of data set, and the timestamp of when the data set was Last updated.

3. Go to Select revision access rules, and choose the revision access rules that you want to set for data sets included in this product.

   For more information, see Revision access rules in AWS Data Exchange.

4. Choose Next.

In Define product:

1. Under Product overview, enter information about your product, including the Product name, Product logo, Support contact information, and Product categories.

   For more information, see Product best practices in AWS Data Exchange.

2. (Optional) Under Data dictionaries and samples – optional, choose a data set by selecting the option button next to the data set name and then choose Edit.

   1. In the Edit dialog box, choose Upload to upload a new data dictionary.

      You can choose one data dictionary, in .csv format, with a maximum size of 1 MB.

   2. Choose a saved data dictionary from your computer and then choose Open.

      The data dictionary .csv file appears on the Edit dialog box.

      Note

      Your data dictionary must conform to the AWS Data Exchange data dictionary template. If you don’t have a saved data dictionary to upload, you can choose either the blank data dictionary template link or the example data dictionary link in the AWS Data Exchange console.

   3. Choose Data dictionary preview to preview the data dictionary.

   4. Under Samples - optional, choose Upload samples, choose a sample from your computer, and then choose Open.

      The samples appear on the Edit dialog box.

      Note

      You can upload up to 10 samples with a maximum size of 50 MB. Samples in .csv format can be previewed.

   5. Enter a description for each sample that will be visible on the product detail page.

   6. Choose Save.

Under Product definition, enter a Short description and a Long description of your product.

If you want to use a template for your long description, select Apply template, choose your template type, and then fill out the template with your specific product details.

Choose Next.

Configure your offer in either Add public offer (for public offer) or Add custom offer (for private offers):

All AWS Data Exchange products with visibility set to Public require a public offer.

1. For private offers only:

   1. Choose one of the listed Offer types: Private offer, Renewed private offer, or Bring Your Own Subscription (BYOS).

   2. In the Subscriber account information section, add at least one subscriber account to which you want to extend the offer.

2. Choose your Pricing and access duration options for the subscription.

3. For Metered costs - optional, choose Add.

   1. For Add metered cost, select the type of cost for the API call from the Type list:

      • Per API request

      • Per successful API request

      • Per unit of data transferred in bytes

      • New custom metered cost

   2. Enter or update the Cost display name, which is visible on the subscriber’s invoice.

   3. If you're using a Pre-defined metered cost, the Key is automatically generated, can’t be edited, and doesn’t need to be sent back in the response header.

   4. If you're creating a New custom metered cost, enter the Key, which is the identifier for the metered cost in the API response header (15 characters maximum).

      This Key should be sent back as part of the x-amz-dataexchange-metering response header.

      Example Custom key

      If you have a custom key called VertexCount and another custom key called EdgeCount, the “x-amz-dataexchange-metering” response header could have a value of VertexCount=3,EdgeCount=10 or you could return two separate header lines:

      x-amz-dataexchange-metering: VertextCount=3

      x-amz-dataexchange-metering: EdgeCount=10

   5. Enter the price the subscriber is charged per unit in Price / unit.

   6. (Optional) Enter the number of units to display an example of the cost in the Metered cost calculator.

   7. (Optional) Enter a brief Description of the metered cost that appears on the product detail page.

   8. Choose Add.

   9. (Optional) Repeat to add additional metered costs. 

      The order of the metered costs appears on the product detail page. You can’t reorder them.

      Note

      After the offer is created, you can edit the price and description of a metered cost. For more information, see Updating product and offer details in AWS Data Exchange.

4. For private offers only, choose the Offer expiration date by which the subscriber must accept the offer.

5. Choose your Tax settings, Data subscription agreement (DSA), and Refund policy.

6. (Optional) For public offers only, set Subscription verification, which enables you to control who can subscribe to this product. For more information, see Subscription verification for providers in AWS Data Exchange.

7. Choose your Offer auto-renewal option. For more information, see Creating an offer for AWS Data Exchange products.

8. Choose Next.

In the Review & publish section, review your product information.

1. Expand the Product page preview to see how the product page will look after publication.

2. (Optional) Choose the Edit button in any section to edit that section.

If you're sure that you want to make the product and public offer visible and available to everyone, choose Publish.

Open your web browser and sign in to the AWS Data Exchange console.

From the left navigation pane, under Publish data, choose Products.

From Products, choose the button next to the product you want to copy.

Select the Actions dropdown, and then choose Create copy.

Continue through the Publish a new product workflow, with details already filled in, based on the product you chose in Step 3. For more information, see Step 5: Publish a new product.