Publishing products - AWS Data Exchange User Guide

Publishing products

A product is the unit of exchange in AWS Data Exchange that is published by a provider and made available for use to subscribers. When you publish a product, that product is available on the AWS Data Exchange product catalog as well as AWS Marketplace after being reviewed by AWS against our guidelines and terms and conditions. Each product you publish is uniquely identified by its product ID.

Note

When a product is initially created and published, all pre-existing finalized revisions within its datasets are published at the same time.

You can publish and view your products using the AWS Data Exchange console. You can also list and view the details of your existing products using the AWS Marketplace Catalog API. A product has the following parts:

  • Product details – This information helps potential subscribers understand what the product is. This includes a name, descriptions (both short and long), a logo image, and contact information. For more information, see Providing product details.

  • Product offers – To make a product available on AWS Data Exchange, you must define a public offer. This includes the price, data subscription agreement, refund policy, and more. Offers define the terms that subscribers are agreeing to when they subscribe to a product. Each product must have a public offer available to all subscribers. Providers can also create custom offers to specific subscribers. For more information, see Creating an offer for AWS Data Exchange products.

  • Datasets – A product can contain one or more datasets. A dataset is a dynamic set of file-based data content. As a provider, you create owned datasets, and a subscriber can get access to entitled datasets through a product subscription. Datasets are dynamic and are versioned using revisions. You can decide which revisions within a dataset are published to a product. For more information, see Updating products.

Note

When a subscriber subscribes to your product, they get access to the product’s datasets and some or all of the revisions that have been published to that product for the duration of their subscription. For more information, see Revision access rules.

Product visibility

When you create a product, you choose its visibility. Product visibility can be either Public or Private:

  • Public – The product is visible in the public catalog in the AWS Data Exchange console and AWS Marketplace. Public products must have a public offer associated with them, and they might also have custom offers.

  • Private – The product is not publicly visible in the public catalogs of either AWS Data Exchange or AWS Marketplace, and can only have custom offers created for it. Only the specific accounts for whom you have created a custom offer can see the product and subscribe to it. Subscribers can view custom offers created for them on their My product offers tab of AWS Data Exchange.

Note

You can't modify the visibility of a product after it has been created,

For more information about creating a product (with either public or private visibility), see Publish a product.

Sensitive categories of information

When you create a product, you must specify whether your product contains any personal data or sensitive categories of data. Sensitive categories of information includes biometric or genetic data; health data; racial or ethnic origin; political opinions; religious or philosophical beliefs; sex or sexual orientation; trade union membership; personal payment or financial information (for example, credit history); or other similar categories of information. Personal data is data that can be used to identity a person.

Choose one of the following options:

  1. No personal data that is not otherwise publicly available, and no sensitive categories of information

    Choose this option if your product does not contain any personal data that is not otherwise publicly available, and no sensitive categories of information.

  2. No personal data but contains sensitive categories of information

    Choose this option if your product contains non-personal sensitive information, such as aggregated diversity data or anonymized financial data.

  3. Personal data that is not otherwise publicly available but does not include protected health information (PHI) subject to the Health Insurance Portability and Accountability Act of 1996 (HIPAA) [Preview]

    Choose this option if your product contains personal data that is not otherwise publicly available. The product must not include protected health information (PHI) subject to HIPAA. Product may contain personal information such as email addresses, social security numbers, biometrics, or mobile IDs.

  4. Protected Health Information (PHI) subject to the Health Insurance Portability and Accountability Act of 1996 (HIPAA)

    Choose this option if your product contains protected health information (PHI) subject to HIPAA. The product may contain information such as patient information disclosed by a covered entity.

    Important

    This fourth option is only available for private products. Public products may not contain such data.

Note

The third and fourth options are only available to eligible providers enrolled in the Extended Provider Program who have agreed to the Extended Provider Program Addendum to the Terms and Conditions for AWS Marketplace Providers. The Extended Provider Program is currently in preview and subject to Section 2 of the AWS Service Terms (under Betas and Previews). For information about eligibility, contact AWS Support or send an email message to dataexchangehelp@amazon.com.

The fourth option is only available to eligible providers who have agreed to the AWS Business Associate Addendum, as well as the AWS Data Exchange Addendum to the AWS Business Associate Addendum.

Indicating that your product contains sensitive categories of information or personal data results in the display of a message on the product's page on AWS Data Exchange to alert prospective customers.

Warning

If you are not enrolled in the Extended Provider Program, listing a product with data or information described in the third and fourth options is a violation of our Publishing guidelines. AWS removes any product that breaches these guidelines and can suspend the provider from future use of the service.

For more information about creating a product and setting the sensitivity status of the data, see Publish a product.

Providing product details

When you publish a product on the AWS Data Exchange console, you must provide the product's details. This section covers some best practices to consider when you're preparing product details.

Product name

Subscribers will search for the names of products, so make your product name something meaningful.

Short description

The product short description text appears on the tiles in the product catalog portion of the AWS Data Exchange console. We recommend that you provide a concise description of your product for this field.

Long description

Subscribers see the product long description in the product detail page after the product is published. We recommend that you list the product's features, benefits, usage, and other information specific to the product.

Product information in the description must accurately represent the data being provided to subscribers. This includes data coverage (for example, 30,000 financial instruments or 10,000 location coordinates) and dataset update frequency (for example, daily updates or weekly updates).

Provide additional information

In order to make your product description compelling to prospective subscribers, we recommend you add the following information to your product description:

  • Data due diligence questionnaire (DDQ) – Typically includes responses to questions regarding the firm selling a dataset. Examples of the information in a DDQ includes the process that a provider goes through to collect the data, or quality control procedures and questions regarding regulatory compliance.

  • Dataset schemas – Provide prospective users with detailed descriptions of the structure and format of your datasets. Examples of the information in a dataset schema include the identification of a primary key, field names, field definitions, expected output types for each field (for example, string, integer), and acceptable enumerations for each field (for example, 0%–100%).

  • Trial product istings – Many prospective subscribers request trials of datasets before paying for a subscription. Trial products can be published on AWS Data Exchange for subscribers to subscribe to like regular paid products.

  • Sample files – Sample files are typically smaller versions, or older, out-of-date versions of full production datasets. These sample files give prospective users insights into the outputs they can expect before purchasing a subscription.

  • Product fact sheets – These can be documents, web links, or both to provide subscribers with more granular statistics on the coverage of your datasets, typical use cases for your datasets, and any other factors that differentiate your datasets.

For information about adding links in the description, see Include links in your product description.

Revision access rules

Revision access rules specify which revisions subscribers can access when they subscribe to your product. You choose options for subscribers to get historical and future revisions.

  • Historical revision options – Historical revisions are revisions that you published prior to the subscription start date. You have three options for historical revisions:

    • All pre-existing revisions published prior to subscription – Give your subscribers access to all historical revisions.

    • A fixed number of trailing revisions published prior to subscription – You choose how many historical revisions your subscribers have access to (from 1 to 100).

    • No historical revisions – Your subscribers get no access to historical revisions. With this option, your subscribers will initially have no data available, until you publish your next revision after their subscription starts.

  • Future revision options – Future revisions are revisions that you publish after subscription start. You have two options for future revisions:

    • All future revisions published during subscription duration – Give your subscribers access to all revisions that you publish until their subscription expires.

    • No future revisions – Your subscribers get no access to future revisions.

Note

You can't choose both No historical revisions and No future revisions. That would create a product with no revisions and no data.

The product logo appears in the AWS Data Exchange product catalog on the console and on AWS Marketplace. The supported formats for the logo are .png, .jpg, and .jpeg.

Support contact

As a provider, you must include valid contact information. This can be a managed email alias or case management system link for customers to use to get help when they have questions about your product. We strongly recommend that you don't use a personal email address because the address is publicly visible.

Product categories

All products fit into one or more categories. By specifying up to two categories for your product, you help subscribers filter and find your products in AWS Data Exchange and AWS Marketplace.

The long description for an AWS Data Exchange product supports Markdown, which allows you to include links in your product's details page. The following procedure shows you how to add links to websites in your AWS Data Exchange product description.

To include embedded links in your product listing

  1. Log into the AWS console and navigate to an Amazon S3 bucket that your AWS Data Exchange user account has access to. The contents of this bucket are publicly readable.

  2. Upload the files (for example, documents such as PDF files or Microsoft Excel files) that you want to include in your product listing into the Amazon S3 bucket. After the upload is complete, make sure you set the file or files to have public read access permissions.

  3. Choose one of the uploaded files. In the Overview tab, you will see a URL for the file. Copy the URL to your clipboard.

  4. Open the AWS Data Exchange console at AWS Data Exchange console.

  5. Choose the product you want to update, and then choose Edit.

  6. From Product Description, use the following Markdown formats to link to relevant files (using the URL link you copied previously) or to another URL, like your website.

    • To link to a file stored in an Amazon S3 bucket:

      **_[File name](Object URL from Amazon S3)_**

      Description of the object.

    • To link to a trial product listing on AWS Data Exchange:

      **_[Website Title](URL)_**

      Description of the website.

  7. Choose Save Changes. After a few minutes your AWS Data Exchange product listing page should be updated with the new links.