Amazon Web Services, Inc.

AWS Data Exchange

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update,…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud. As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIs to download or copy your entitled data sets to Amazon Simple Storage Service (Amazon S3) for use across a variety of AWS analytics and machine learning services. As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide . A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object, Redshift datashare, API Gateway API, AWS Lake Formation data permission, or Amazon S3 data access. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.

Endpoints 37

  • POSTAccept data grant/v1/data-grants/:DataGrantArn/acceptThis operation accepts a data grant.
  • GETGet job/v1/jobs/:JobIdThis operation returns information about a job.
  • DELETECancel job/v1/jobs/:JobIdThis operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.
  • PATCHStart job/v1/jobs/:JobIdThis operation starts a job.
  • GETList data grants/v1/data-grants?maxResults=0&nextToken=stringThis operation returns information about all data grants.
  • POSTCreate data grant/v1/data-grantsThis operation creates a data grant.
  • GETList data sets/v1/data-sets?maxResults=0&nextToken=string&origin=stringThis operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there…
  • POSTCreate data set/v1/data-setsThis operation creates a data set.
  • GETList event actions/v1/event-actions?eventSourceId=string&maxResults=0&nextToken=stringThis operation lists your event actions.
  • POSTCreate event action/v1/event-actionsThis operation creates an event action.
  • GETList jobs/v1/jobs?dataSetId=string&maxResults=0&nextToken=string&revisionId=stringThis operation lists your jobs sorted by CreatedAt in descending order.
  • POSTCreate job/v1/jobsThis operation creates a job.
  • GETList data set revisions/v1/data-sets/:DataSetId/revisions?maxResults=0&nextToken=stringThis operation lists a data set's revisions sorted by CreatedAt in descending order.
  • POSTCreate revision/v1/data-sets/:DataSetId/revisionsThis operation creates a revision for a data set.
  • GETGet asset/v1/data-sets/:DataSetId/revisions/:RevisionId/assets/:AssetIdThis operation returns information about an asset.
  • DELETEDelete asset/v1/data-sets/:DataSetId/revisions/:RevisionId/assets/:AssetIdThis operation deletes an asset.
  • PATCHUpdate asset/v1/data-sets/:DataSetId/revisions/:RevisionId/assets/:AssetIdThis operation updates an asset.
  • GETGet data grant/v1/data-grants/:DataGrantIdThis operation returns information about a data grant.
  • DELETEDelete data grant/v1/data-grants/:DataGrantIdThis operation deletes a data grant.
  • GETGet data set/v1/data-sets/:DataSetIdThis operation returns information about a data set.
  • DELETEDelete data set/v1/data-sets/:DataSetIdThis operation deletes a data set.
  • PATCHUpdate data set/v1/data-sets/:DataSetIdThis operation updates a data set.
  • GETGet event action/v1/event-actions/:EventActionIdThis operation retrieves information about an event action.
  • DELETEDelete event action/v1/event-actions/:EventActionIdThis operation deletes the event action.
  • PATCHUpdate event action/v1/event-actions/:EventActionIdThis operation updates the event action.
  • GETGet revision/v1/data-sets/:DataSetId/revisions/:RevisionIdThis operation returns information about a revision.
  • DELETEDelete revision/v1/data-sets/:DataSetId/revisions/:RevisionIdThis operation deletes a revision.
  • PATCHUpdate revision/v1/data-sets/:DataSetId/revisions/:RevisionIdThis operation updates a revision.
  • GETGet received data grant/v1/received-data-grants/:DataGrantArnThis operation returns information about a received data grant.
  • GETList received data grants/v1/received-data-grants?maxResults=0&nextToken=string&acceptanceState=This operation returns information about all received data grants.
  • GETList revision assets/v1/data-sets/:DataSetId/revisions/:RevisionId/assets?maxResults=0&nextToken=stringThis operation lists a revision's assets sorted alphabetically in descending order.
  • GETList tags for resource/tags/:ResourceArnThis operation lists the tags on the resource.
  • POSTTag resource/tags/:ResourceArnThis operation tags a resource.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=This operation removes one or more tags from a resource.
  • POSTRevoke revision/v1/data-sets/:DataSetId/revisions/:RevisionId/revokeThis operation revokes subscribers' access to a revision.
  • POSTSend api asset/v1This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.
  • POSTSend data set notification/v1/data-sets/:DataSetId/notificationThe type of event associated with the data set.

API details

Base URL
https://dataexchange.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
37 operations on 19 pathsGET 15POST 10DELETE 7PATCH 5
Description format
AWS Smithy model, API version 2017-07-25

How to test the AWS Data Exchange in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Data Exchange collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Accept data grant” (POST /v1/data-grants/:DataGrantArn/accept), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Data Exchange?

AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update,… It is listed under Data & analytics and has 37 endpoints.

Who publishes the AWS Data Exchange?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Data Exchange?

Requests go to https://dataexchange.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Data Exchange?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Data Exchange have?

37 operations on 19 paths (15 GET, 10 POST, 7 DELETE, 5 PATCH).

Is forking the AWS Data Exchange free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.