Subscribe to and access a product - AWS Data Exchange User Guide

Subscribe to and access a product

The following topics describe the process of subscribing to and accessing a product on AWS Data Exchange using the AWS Data Exchange console.

Note

By subscribing to a product, you agree that your use of the product is subject to the provider's offer terms including pricing information and Data Subscription Agreement.

You also agree and acknowledge that AWS may share information about the transaction (including your payment terms and product usage metrics) with the respective seller, reseller, or underlying provider, as applicable, in accordance with the AWS Privacy Notice. AWS will issue invoices and collect payments from you on behalf of the provider through your AWS account. Your use of AWS services remains subject to the AWS Customer Agreement or other agreement with AWS governing your use of such services.

Subscribe to and access a product containing file-based data

The following topics describe the complete process of subscribing to and accessing a product containing file-based data on AWS Data Exchange by using the AWS Data Exchange console.

For information about how to evaluate a product before subscribing, see Evaluate products containing data dictionaries and samples.

The process has the following steps:

To practice subscribing to and accessing a product containing file-based data, see the Tutorial: Subscribe to AWS Data Exchange Heartbeat on AWS Data Exchange.

Step 1: Subscribing to a product containing the file-based data

If you subscribe to a paid product, you are billed on your AWS bill. You get access to all entitled data sets. For more information, see Subscribing to data products on AWS Data Exchange.

To subscribe to a product containing the file-based data

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left side navigation pane, under Discover data products, choose Browse catalog.

  3. Under Refine results, use the Data available through filter and select Amazon S3 to find products containing file-based data.

    For more information, see Browse the catalog.

  4. Select a data product containing an Amazon S3 object, and view its details page.

    The information on the details page includes a product description, the provider's contact information, and the details of the product's public offer. The public offer information includes price and durations, the data subscription agreement, and the refund policy. You can also view the names of the data sets included in the product and the AWS Regions in which they are available.

    If the provider has issued a custom offer to your account (for example, a private offer or Bring Your Own Subscription (BYOS) offer), you see those details, too.

  5. In the top right corner, choose Continue to subscribe.

  6. Choose your preferred price and duration combination, choose whether to enable auto-renewal for the subscription, and review the offer details, including the data subscription agreement.

    Note

    Some products require subscription verification. For more information, see Subscription verification for subscribers.

  7. Review the pricing information, choose the pricing offer, and then choose Subscribe.

    Note

    If you subscribe to a paid product, you are prompted to confirm your decision to subscribe.

  8. On the Set up your first export while your subscription processes page, select the check boxes for the data sets containing the revisions that you would like to export. Selecting a data set will prepare its most recently published revision to be exported.

  9. Choose an Amazon Simple Storage Service (Amazon S3) bucket location or configure an Amazon S3 key naming pattern. This will determine where your revisions will be exported. For more information about using key patterns, see Key patterns when exporting revisions.

  10. Choose whether to enable or disable automatic revision export. We recommend that you choose Enable automatic revision export - recommended.

  11. Choose the Encryption options, and review the Amazon S3 pricing.

    Note

    If you choose to export using AWS Key Management Service (AWS KMS) encryption, make sure your account has the correct IAM permissions to create and revoke grants on the AWS KMS key you choose. Without these permissions, automatic export will fail.

  12. Choose Export to export the data to Amazon S3, or choose Skip if you prefer to wait and export or download later. For more information about how to export data after subscribing, see (Optional) Exporting data.

    Note

    It can take a few minutes for your subscription to become active after you choose Subscribe. If you choose Export before the subscription is active, you are prompted to wait until it is complete.

    After your subscription is active, your export will begin.

    Navigating away from this page prior to your subscription becoming active will not prevent the subscription from processing. It will prevent your data export from occurring.

Step 2: Accessing a product containing file-based data

After you successfully subscribe to a product, you have access to the product data sets according to the terms of the data subscription agreement.

The following topic describes how to access a product containing file-based data.

Viewing data sets, revisions, and assets

To view the data sets, revisions, and assets

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left navigation pane, choose Subscriptions, and then choose your product.

  3. View the data sets that are part of the product under Entitled data sets.

  4. Choose a data set.

  5. View the Data set overview, Auto-export job destinations (S3 products only), the Revisions, and the Description of the data set.

    For more information, see Data in AWS Data Exchange.

  6. Choose a revision.

    Revisions are listed from latest to oldest.

  7. View the Revision overview, Assets, and the Jobs that have been performed.

    For information about exporting file-based assets, see Exporting assets to an S3 bucket as a subscriber (console).

(Optional) Exporting data

After your subscription is active, you can set up your Amazon S3 bucket to receive assets that you export.

You can export the associated assets to Amazon S3 or you can use jobs with a signed URL.

If you want export or download your data at a later time, including getting new revisions, see Exporting assets to an S3 bucket as a subscriber (console)

Important

We recommend that you consider Amazon S3 security features when exporting data to Amazon S3. See Security best practices for Amazon S3 for general guidelines and best practices.

For more information about how to export data, see Exporting assets and Exporting revisions.

Subscribe to and access a product containing APIs

The following topics describe the complete process of subscribing to and accessing a product containing APIs on AWS Data Exchange by using the AWS Data Exchange console.

For information about how to evaluate a product before subscribing, see Evaluate products containing data dictionaries and samples.

The process has the following steps:

To practice subscribing to and accessing a product containing APIs, see the Tutorial: Subscribe to AWS Data Exchange for APIs (Test Product) on AWS Data Exchange.

Step 1: Subscribing to a product containing APIs

If you subscribe to a paid product, you're billed on your AWS bill. You get access to all entitled data sets. For more information, see Subscribing to data products on AWS Data Exchange.

A provider might include metered costs to their product containing APIs. If a provider decreases metered costs, the price decrease goes into effect immediately. If the provider increases metered costs, and you're an existing subscriber, the price increase goes into effect on the first day of the month, 90 days after the price increase was submitted OR upon renewal (whichever is sooner). An email is sent to existing subscribers when the price change is submitted.

For example, assume that a provider submits a metered cost price increase on May 10. Existing subscribers receive an email about the price change. The price increase goes into effect on September 1.

To subscribe to a product containing APIs

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left side navigation pane, under Discover data products, choose Browse catalog.

    For more information, see Browse the catalog.

  3. Under Refine results, use the Data available through filter and select API to find products containing APIs.

    For more information, see Browse the catalog.

  4. Select a product containing APIs, and view its details page.

    The information on the product details page includes a product description, the provider's contact information, and the details of the product's public offer. The public offer information includes price and durations, metered costs (if included), the data subscription agreement, and the refund policy. You can also view the names of the data sets included in the product and the AWS Regions in which they are available.

    If the provider has issued a custom offer to your account (for example, a private offer or Bring Your Own Subscription (BYOS) offer), you see those details, too.

    1. Under Public offer, view the API metered costs (if included).

    2. (Optional) In the Metered cost calculator, choose Select metered cost and then enter the number of units to display an example of the cost.

  5. In the top right corner, choose Continue to subscribe.

  6. Choose your preferred price and duration combination, choose whether to enable auto-renewal for the subscription, and review the offer details, including the data subscription agreement.

    Note

    Some products require subscription verification. For more information, see Subscription verification for subscribers.

  7. Review the pricing information, choose the pricing offer, and then choose Subscribe.

    Note

    If you subscribe to a paid product, you're prompted to confirm your decision to subscribe.

Step 2: Accessing an API product

The following topics provide details about how to access a product that includes API data sets:

Viewing an API

To view an API

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left navigation pane, under My subscriptions, choose Entitled data.

  3. Choose a data set.

  4. Under the Revisions tab, choose a revision.

  5. Under API assets, choose the API.

  6. View the Asset overview.

  7. Follow the guidance in the Integration notes to call the API.

Downloading the API specification

To download the API specification

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left navigation pane, under My subscriptions, choose Entitled data.

  3. Choose a data set.

  4. Under the Revisions tab, choose a revision.

  5. Under API assets, choose the API.

  6. On the OpenAPI 3.0 specification, choose Download API specification.

    The specification is downloaded onto your local computer. You can then export the asset to a third-party tool for SDK generation.

Making an API call (console)

You can call a single endpoint in the AWS Data Exchange console.

To make an API call from the console

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left navigation pane, under My subscriptions, choose Entitled data.

  3. Choose a data set.

  4. Under the Revisions tab, choose a revision.

  5. Under API assets, choose the API.

  6. For Integration notes:

    1. Choose Copy to use the Base URL.

    2. Choose Copy to use the Code structure.

    3. Follow the information provided in the specification documentation to call the API.

Making an API call (AWS CLI)

To make an API call (AWS CLI)

  • Use the send-api-asset command to call the API.

    $ aws dataexchange send-api-asset \ --asset-id $ASSET_ID \ --data-set-id $DATA_SET_ID \ --revision-id $REVISION_ID \ --body "..." \ { "headers": { ... }, "body": "..." }

Subscribe to and access a product containing Amazon Redshift data sets

Overview for subscribers

An Amazon Redshift data set is a data set that contains AWS Data Exchange datashares for Amazon Redshift. Datashares give you read-only access to the tables, views, schemas, and user-defined functions that a data provider adds to the datashare.

As a data subscriber, you can find and subscribe to products containing Amazon Redshift data sets. After your subscription starts, you get access to query the data in Amazon Redshift without extracting, transforming, and loading data. You lose access to a product's datashares after your subscription expires.

Consider the following:

  • If you are a subscriber, you must have an encrypted Amazon Redshift cluster running on an RA3 instance to query to Amazon Redshift data on AWS Data Exchange. For more information, see the Amazon Redshift Database Developer Guide.

  • It may take a few minutes to access the datashares after your subscription starts.

The following sections describe the complete process of becoming an Amazon Redshift datashare product subscriber on AWS Data Exchange by using the AWS Data Exchange console.

For information about how to evaluate a product before subscribing, see Evaluate products containing data dictionaries and samples.

The process has the following steps:

To practice subscribing to and accessing a product containing Amazon Redshift data sets, see the Tutorial: Subscribe to Worldwide Event Attendance (Test Product) on AWS Data Exchange.

Step 1: Subscribing to products containing Amazon Redshift data sets

If you subscribe to a paid product, you're billed on your AWS bill. You get access to all data sets included in the product. For more information, see Subscribing to data products on AWS Data Exchange.

To subscribe to a product containing Amazon Redshift data sets

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left side navigation pane, under Discover data products, choose Browse catalog.

    For more information, see Browse the catalog.

  3. Under Refine results, use the Data available through filter and select Amazon Redshift to find products containing Amazon Redshift datashares.

    For more information, see Browse the catalog.

  4. Select a product and view its details page.

    The information on the details page includes a product description, the provider's contact information, and the details of the product's public offer. The public offer information includes price and duration, the data subscription agreement, and the refund policy. You can also view the names of the data sets included in the product and the AWS Regions in which they are available.

    If the provider has issued a custom offer to your account (for example, a private offer or Bring Your Own Subscription (BYOS) offer), you see those details, too.

    Important

    Be sure to review the date, time, and duration of the cluster’s maintenance window. During the maintenance window, you will not have access to the datashare.

  5. In the top right corner, choose Continue to subscribe.

  6. Review the Product offer, the Subscription terms, the Data sets that are included in the offer, and the Support information.

  7. Choose whether to enable Offer auto-renewal for the subscription

    Note

    Some products require subscription verification. For more information, see Subscription verification for subscribers.

  8. Choose Subscribe.

    Note

    If you subscribe to a paid product, you're prompted to confirm your decision to subscribe.

Step 2: Accessing the AWS Data Exchange datashares for Amazon Redshift

You have access to the product's data sets according to the terms of the data subscription agreement. As a subscriber, your subscription to a product that includes AWS Data Exchange datashares for Amazon Redshift gives you read-only access to the tables, views, schemas, and functions within the datashare.

With a subscription, you can do the following:

  • Query data without having to extract, transform, or load data.

  • Access the latest provider data as soon as the provider updates it.

For more information, see Working with AWS Data Exchange datashares in the Amazon Redshift Database Developer Guide.

Note

You lose access to a product's datashares after your subscription expires.

For more information about how to subscribe to an Amazon Redshift data set, see Tutorial: Subscribe to Worldwide Event Attendance (Test Product) on AWS Data Exchange.

Viewing and downloading a data dictionary (if included)

Providers can attach data dictionaries to products that contain file-based data, APIs, or Amazon Redshift data sets. The following procedures describe how to view and download a data dictionary if one is included in the subscribed product.

For more information about data dictionaries and samples, see Data dictionaries and samples.

To view and download a data dictionary

  1. Open and sign in to the AWS Data Exchange console.

  2. In the left navigation pane, under My subscriptions, choose Entitled data.

  3. On the Entitled data page, expand a product and choose a data set.

  4. On the data set details page, choose the Data dictionary tab.

    • View the data dictionary on the Data dictionary tab.

    • Download the data dictionary by choosing Download and then saving the file to your computer.