Step 1: Confirm your eligibility
Before you can register, you must meet the following requirements to confirm your eligibility.
Requirements for publishing data products
Whether you charge for your AWS Data Exchange data product, you're selling that product on AWS Marketplace. To create and offer data products, you must:
• Have a defined customer support process and support organization.
• Provide a means to keep data regularly updated and free of vulnerabilities.
• Follow best practices and guidelines when marketing your product.
• Be an AWS customer in good standing and meet the requirements in the terms and conditions for AWS Marketplace sellers and for AWS Data Exchange providers.
• Be a permanent resident or citizen in an eligible jurisdiction (p. 35), or a business entity organized or incorporated in one of those areas.
• To provide data products, you must also request on-boarding through the Create case wizard for AWS Support. The AWS Data Exchange team will contact you to complete the qualification and registration process.
Additionally, if you want to offer products and charge for them, you must provide the following information:
• You must provide tax and bank account information. For US-based entities, a W-9 form and a banking account from a US-based bank are required.
• Non-US sellers are required to provide a W-8 form, value-added tax (VAT) or goods and services tax (GST) registration number, and US bank information. If you don't have a US bank account, you can register for a virtual US bank account from Hyperwallet.
Eligible jurisdictions for AWS Data Exchange products
To provide data products on AWS Data Exchange, you must be a permanent resident or citizen in one of the following countries or SARs, or a business entity organized or incorporated therein:
• Australia¹
• Bahrain¹²
• European Union (EU) member state¹
• Hong Kong SAR
• Japan²³
• New Zealand¹
• Norway¹²
• Qatar
• Switzerland¹²
• United Arab Emirates (UAE)¹²
• United Kingdom (UK)¹
Step 2: Register to be a provider
• United States (US)
¹ Providers of paid products in these countries must provide VAT registration information in country of establishment.
² If the subscriber is in these countries, providers may be responsible for tax invoicing and collections.
Consult with your tax advisor.
³ Providers based in Japan have an obligation to self-account for the Japan Consumption Tax (JCT) on the listing fee charges.
For more information about VAT, invoicing, and your tax obligations as a provider, see AWS Marketplace Sellers on Amazon Web Service Tax Help.
Step 2: Register to be a provider
To use AWS Data Exchange as a provider, you must be a registered seller on AWS Marketplace and be qualified by the AWS Data Exchange team. When you register an account as an AWS Marketplace seller, the account is the seller of record for your products and is used for reporting and disbursement. All products and their public offers are discoverable on AWS Data Exchange and AWS Marketplace.
Important
You can't change the AWS account that you use to list a product on AWS Marketplace. Only data sets owned by that account can be included in products published by that account. Only AWS accounts that are registered to provide data products on AWS Marketplace and AWS Data Exchange can publish products.
To register as a provider for AWS Data Exchange and AWS Marketplace
1. From your web browser, open the AWS Marketplace Management Portal.2. Choose Sign Up as a Seller to open the registration wizard.
3. Confirm your company or full name, and review the Terms and Conditions. If you agree to them, choose I have read and agree to these terms.
4. On the Account Settings page, choose Add to add a public profile.
5. (Optional) If you want to submit paid products to AWS Marketplace or AWS Data Exchange, you must provide your tax and banking information. On the Account Settings page, from the Provide tax and banking information tab, choose Start to complete the tax and banking wizard. This submits your tax and banking information in the AWS Marketplace Management Portal.
Note
We strongly recommend that you sign and submit the tax form electronically. Otherwise, you must print, complete the signature section, and mail a hard copy of the tax form to the address provided in the tax information interview. This delays the registration process.6. In addition to being a registered AWS Marketplace seller, you must submit an AWS Data Exchange qualification request. Access the AWS Support Dashboard and create a case in the AWS Management Console. The AWS Data Exchange team will contact you to complete the qualification and
registration process.
Step 3: Confirm eligibility of your data
To confirm the eligibility of your data, review the Publishing guidelines (p. 29).
If you have questions about the eligibility of your data set, you can take any of the following actions:
• Contact AWS Support.
Publishing a new product
• Send an email message to [email protected].
• Access the AWS Support Dashboard and create a case in the AWS Management Console.
You can create your product after you've reviewed the publishing guidelines for data products on AWS Data Exchange, and you've confirmed that your data set can be listed.
Publishing a new product
The following topics describe the process of publishing a new product on AWS Data Exchange by using the AWS Data Exchange console.
Topics
• Publishing a product containing file-based data (p. 37)
• Publishing a product containing APIs (p. 41)
• Publishing a product containing Amazon Redshift datasets (p. 50)
Important
Beginning July 22, 2021, new and existing providers have the ability to automatically publish revisions to data sets. All new products on AWS Data Exchange default to automatic revision publishing. If you have created existing products on AWS Data Exchange before July 22, 2021, you need to migrate them to automatic revision publishing.
For more information, see Migrating an existing product to automatic revision publishing (p. 69).
Note
If you are an existing provider and have not yet migrated all of your products to automatic revision publishing, you will need to manually publish your revision. For more information, see Publishing a new data set revision using manual revision publishing (p. 67).Publishing a product containing file-based data
The following topics describe the process of creating a data set and publishing a new product containing file-based data on AWS Data Exchange by using the AWS Data Exchange console. The process has the following steps:
Steps
• Step 1: Create assets (p. 37)
• Step 2: Create a data set (p. 38)
• Step 3: Create a revision (p. 38)
• Step 4: Import assets to a revision (p. 38)
• Step 5: Publish a new product (p. 39)
• Step 6: (Optional) Copy a product (p. 40)
Step 1: Create assets
Assets are the data in AWS Data Exchange. For more information, see Assets (p. 78).
Before you create and publish a new file-based data product, you must:
1. Create your files.
Publishing a product containing file-based data
AWS Data Exchange supports all file types.
2. Store your files as objects in Amazon S3 or on your local computer.
For more information about storing files in Amazon S3, see the Amazon S3 User Guide.
Step 2: Create a data set
Data sets in AWS Data Exchange are dynamic and are versioned using revisions, with each revision containing at least one asset. For more information, see Data in AWS Data Exchange (p. 78).
To create a data set
1. Open your web browser and go to the AWS Data Exchange console.
2. On the left side navigation pane, under Publish data, choose Owned data sets.
3. In Owned data sets, choose Create data set to open the Data set creation steps wizard.
4. In Select data set type, choose Amazon S3 object.
5. In Define data set, enter a Name and Description for your data set. For more information, see Data set best practices (p. 83).
6. (Optional) Under Add tags – optional, add tags.
7. Choose Create.
Step 3: Create a revision
In the following procedure, you create a revision after you’ve created a data set in the AWS Data Exchange console. For more information, see Revisions (p. 80).
To create a revision
1. On the Data set overview section of the data set details page:
a. (Optional) Choose Edit name to edit information about your data set.
b. (Optional) Choose Delete to delete the data set.
2. On the Revisions section, choose Create revision.
3. Under Revision settings, provide an optional comment for your revision that describes the purpose of the revision.
4. (Optional) Under Add tags – optional, add tags associated with the resource.
5. Choose Create.
6. Review, edit, or delete your changes from the previous step.
Step 4: Import assets to a revision
In the following procedure, you import data assets, and then finalize the revision in the AWS Data Exchange console. For more information, see Assets (p. 78).
To import assets to the revision
1. Under the Imported assets section of the data set details page, choose either Import from Amazon S3 or Upload (to upload from your computer), depending on where the data assets for the data set are currently stored.
2. Follow the prompts, depending on your selection. A job is started to import your asset into your data set.
Publishing a product containing file-based data
3. After the job is finished, the State field in the Jobs section is updated to Completed.
4. If you have more data to add, repeat Step 1.
5. Under Revision overview, review your revision and its assets.
6. Choose Finalize.
You have successfully finalized a revision for a data set.
You can edit or delete a revision before you add it to a product.
Topics
• Edit a revision (p. 39)
• Delete a revision (p. 39)
Edit a revision
To edit the revision after you’ve finalized it
1. On the Revision overview, choose De-finalize.You see a message that the revision is no longer in the finalized state.
2. To edit the revision, from Revision overview, choose Actions, Edit.
3. Make your changes, and then choose Update.
4. Review your changes and then choose Finalize.
Delete a revision
To delete the revision after you’ve finalized it
1. On the Revision overview, choose Delete.2. Type Delete in the Delete revision dialog box, and then choose Delete.
Warning
This deletes the revision and all of its assets. This action cannot be undone.
Step 5: Publish a new product
After you've created at least one data set and finalized a revision with assets, you're ready to publish that data set as a part of a product. For more information, see Product details (p. 30). Make sure that you have all required details about your product and offer.
To publish a new product
1. From the left navigation pane of the AWS Data Exchange console, under Publish data, choose Products.
2. From Products, choose Publish new product to open the Publish new product wizard.
3. In the Product visibility section, choose your product's Product visibility options and
Sensitive information configuration, and then choose Next. For more information, see Product visibility (p. 31) and Sensitive categories of information (p. 31).
4. In the Define product section, enter information about your product, including name, logo, support contact, web address, categories, and descriptions, and then choose Next. For more information, see Product details (p. 30).
5. In the Add data section, select the check box next to the data sets you want to add.
Publishing a product containing file-based data
Note
The data sets you choose must have a finalized revision. Data sets without finalized revisions won't be added.a. Choose Add selected, and then scroll to Selected data sets to review your selection.
b. Scroll to Select revision access rules, choose the revision access rules that you want to set for data sets included in this product, and then choose Next. For more details, see Revision access rules (p. 34).
6. If you are creating a public offer, in the Add public offer section, configure your offer. All AWS Data Exchange products with visibility set to Public require a public offer.
a. Choose your Pricing and access duration options for the subscription.
Choose your US sales tax settings, data subscription agreement (DSA), and refund policy.
b. (Optional) Set Subscription verification, which enables you to control who can subscribe to this product. For more information, see Subscription verification for providers (p. 74).
c. Choose your Offer auto-renewal option. For more information, see Creating an offer for AWS Data Exchange products (p. 70).
d. Choose Next.
7. If you are creating a private offer, configure the offer details in the Add custom offer section.
a. In the Subscriber account information section, add at least one subscriber account to which you want to extend the offer.
b. Choose your Pricing and access duration options for the subscription.
c. Choose the Offer expiration date by which the subscriber must accept the offer.
d. Choose your US sales tax settings, data subscription agreement (DSA), and refund policy.
e. Choose your Offer auto-renewal option. For more information, see Creating an offer for AWS Data Exchange products (p. 70).
f. Choose Next.
8. In the Review & publish section, review your product information and then expand the Product page preview to see how it will look after it’s published.
9. If you're sure that you want to make the product and public offer visible and available to everyone, choose Publish.
You've now completed the manual portion of publishing a data product with a public offer. AWS Data Exchange prepares and publishes your product. On the Product overview page, the status of your product is Awaiting approval and then changes to Published after it's published.
Step 6: (Optional) Copy a product
After you have created your first product, you can copy its details and public offers to create a new product.
Note
You can copy a public, private, published, or unpublished product. Custom offers associated with the product will not be copied, but public offers will be copied.To copy a product
1. Open your web browser and go to the AWS Data Exchange console.
2. From the left navigation pane, under Publish data, choose Products.
3. From Products, choose the button next to the product you want to copy.
4. Select the Actions dropdown, and then choose Create copy.
Publishing a product containing APIs
5. 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 (p. 39).
Important
Beginning July 22, 2021, new and existing providers have the ability to automatically publish revisions to data sets. All new products on AWS Data Exchange default to automatic revision publishing. If you have created existing products on AWS Data Exchange before July 22, 2021, you need to migrate them to automatic revision publishing.
For more information, see Migrating an existing product to automatic revision publishing (p. 69).
If you are copying an existing product that you created before July 22, 2021, you will see two options under Revision publishing: Automatically publish revisions or Manually publish revisions. We recommend that you choose the first option, to automatically publish revisions.
Publishing a product containing APIs
Overview
The following topics describe the process of creating a REST API data set and publishing a new product that contains APIs on AWS Data Exchange. You can complete the process by using either the AWS Data Exchange console or the AWS Command Line Interface.
After you have set up your Amazon API Gateway REST API, you can create a new API data set in AWS Data Exchange. You can then create a revision, and add API assets.
Creating and publishing an API asset allows subscriber requests to an AWS Data Exchange endpoint to proxy through to your API Gateway API. You can then add this data set to a product and add pricing.
Then, subscribers can view your product and subscribe to it in the AWS Marketplace catalog and the AWS Data Exchange catalog.
AWS Data Exchange features are available including revision access rules, private products, private offers, and subscription verification.
The process has the following steps:
Steps
• Prerequisites (p. 41)
• Step 1: Update the API resource policy (p. 43)
• Step 2: Create an API data set (p. 43)
• Step 3: Create a revision (p. 44)
• Step 4: Add API assets to a revision (p. 45)
• Step 5: Publish a new product containing APIs (p. 49)
• Step 6: (Optional) Copy a product (p. 50)
Prerequisites
Before you can publish a product containing APIs, you must meet the following prerequisites:
• Before you can use any AWS service, including AWS Data Exchange, you must sign up for AWS and create an AWS Identity and Access Management (IAM) user account. For more information, see Setting up AWS Data Exchange (p. 5).
• To create products on AWS Data Exchange, you must register your AWS account as an AWS Marketplace Seller. Use this account so create your data sets. The account with the API Gateway resource doesn't need to be in the same account that is creating the data sets.
Publishing a product containing APIs
• Your REST API must be on Amazon API Gateway with an integration that uses an appropriate request and response model for accessing your data, such as Amazon DynamoDB or AWS Lambda. For more information, see Developing a REST API in API Gateway and Working with REST APIs in the Amazon API Gateway Developer Guide.
Note
Only public API Gateway APIs are supported.• Your API Gateway REST API must be able to authenticate and authorize calls from the AWS Data Exchange service principal. Every request from AWS Data Exchange to your API uses the Signature Version 4 (SigV4) protocol signed with AWS Data Exchange credentials. AWS Data Exchange works with custom domains and domain key mappings.
Note
AWS Data Exchange doesn't support Amazon Cognito, No-Auth, and AWS Lambda authorizers.• If your API Gateway REST API uses a custom identity system for authentication and authorization, configure it to use IAM authentication and import an OpenAPI schema describing your API. AWS Data Exchange will invoke your API Gateway REST API with its own service credentials and include subscriber information such as account ID.
• Your API Gateway REST API is responsible for integrating with your backend. To do this, do one of the following:
• Attach a long-lived authentication token to every request that comes through your API Gateway REST API that the backend can verify.
• Use API Gateway to invoke a Lambda function that can generate credentials and invoke your API.
Your API is invoked per the API integration request specification (p. 42).
For more information, see the following topics:
Topics
• API data set security (p. 42)
• API integration request specification (p. 42)
• Header forwarding (p. 43)
API data set security
AWS Data Exchange encrypts traffic end to end using Transport Layer Security (TLS) 1.2. All metadata is encrypted at rest. AWS Data Exchange will not store subscriber requests or the responses from your backend. We only extract metering metadata necessary for billing.
API integration request specification
An API on AWS Data Exchange passes through all headers (except for the headers listed in Header forwarding (p. 43)), body, http method, path, and query strings as-is from the customer request and appends the following headers.
// These headers help prevent Confused Deputy attacks. They enable the SourceAccount // and SourceArn variables in IAM policies.
'x-amz-source-account': ACCOUNT_ID,
'x-amz-source-arn': `arn:aws:dataexchange:${REGION}:${OWNER_ACCOUNT_ID}:data-sets/
${DATA_SET_ID}/revisions/${REVISION_ID}/assets/${ASSET_ID}`, // These headers identify the API Asset in Data Exchange.
'x-amzn-dataexchange-asset-id': ASSET_ID, 'x-amzn-dataexchange-data-set-id': DATA_SET_ID, 'x-amzn-dataexchange-revision-id': REVISION_ID,
Publishing a product containing APIs
// This header identifies the Data Exchange Product.
'x-amzn-dataexchange-product-id': PRODUCT_ID,
// This header identifies the caller of Data Exchange. It will contain subscriber // information.
'x-amzn-dataexchange-requester-account-id': REQUESTER_ACCOUNT_ID, // Providers can attach custom metadata in the form of key/value pairs
// to a particular subscription. We will send these key/value pairs as stringified // JSON.
'x-amz-dataexchange-subscription-metadata': STRINGIFIED_METADATA,
Header forwarding
AWS Data Exchange removes any headers related to authentication or namespaced to Amazon prior to forwarding it to a provider backend. Specifically, AWS Data Exchange removes:
• Authentication header
• Any headers that begin with x-amz
The host header will be overwritten as a consequence of the proxying.
The host header will be overwritten as a consequence of the proxying.