Data Sets - AWS Data Exchange

Data Sets

A data set is an AWS resource with one or more revisions. This section defines the ListDataSets and CreateDataSet operations.

URI

/v1/data-sets

HTTP Methods

GET

Operation ID: ListDataSets

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order and the maxResults parameter is ignored.

Query Parameters
Name Type Required Description
origin String False

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

nextToken String False

The token value retrieved from a previous call to access the next page of results.

maxResults String False

The maximum number of results returned by a single call.

Responses
Status Code Response Model Description
200 ListOfDataSets

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

POST

Operation ID: CreateDataSet

This operation creates a data set.

Responses
Status Code Response Model Description
201 TaggedDataSet

201 response

400 ValidationException

400 response

402 ServiceQuotaExceededException

402 response

403 AccessDeniedException

403 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

Schemas

Request Bodies

Example POST

{ "AssetType": enum, "Description": "string", "Tags": { }, "Name": "string" }

Response Bodies

Example ListOfDataSets

{ "NextToken": "string", "DataSets": [ { "Origin": enum, "AssetType": enum, "Description": "string", "OriginDetails": { }, "SourceId": "string", "CreatedAt": "string", "Id": "string", "Arn": "string", "UpdatedAt": "string", "Name": "string" } ] }

Example TaggedDataSet

{ "Origin": enum, "AssetType": enum, "Description": "string", "OriginDetails": { }, "SourceId": "string", "CreatedAt": "string", "Id": "string", "Arn": "string", "UpdatedAt": "string", "Tags": { }, "Name": "string" }

Example ValidationException

{ "Message": "string" }

Example ServiceQuotaExceededException

{ "Message": "string", "LimitName": enum, "LimitValue": number }

Example AccessDeniedException

{ "Message": "string" }

Example ResourceNotFoundException

{ "Message": "string", "ResourceId": "string", "ResourceType": enum }

Example ThrottlingException

{ "Message": "string" }

Example InternalServerException

{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

Property Type Required Description
Message

string

True

Access to the resource is denied.

AssetType

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

  • S3_SNAPSHOT

CreateDataSetRequest

A request to create a data set that contains one or more revisions.

Property Type Required Description
AssetType

AssetType

True

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

Description

string

True

A description for the data set. This value can be up to 16,348 characters long.

Tags

object

False

A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to these data sets and revisions.

Name

string

True

The name of the data set.

DataSetEntry

A data set is an AWS resource with one or more revisions.

Property Type Required Description
Origin

Origin

True

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

AssetType

AssetType

True

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

Description

string

True

The description for the data set.

OriginDetails

object

False

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

SourceId

string

False

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

CreatedAt

string

True

The date and time that the data set was created, in ISO 8601 format.

Id

string

True

The unique identifier for the data set.

Arn

string

True

The ARN for the data set.

UpdatedAt

string

True

The date and time that the data set was last updated, in ISO 8601 format.

Name

string

True

The name of the data set.

InternalServerException

An exception occurred with the service.

Property Type Required Description
Message

string

True

The message identifying the service exception that occurred.

ListOfDataSets

The data set objects listed by the request.

Property Type Required Description
NextToken

string

False

The token value retrieved from a previous call to access the next page of results.

DataSets

Array of type DataSetEntry

True

The data set objects listed by the request.

Origin

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers). When an owned data set is published in a product, AWS Data Exchange creates a copy of the data set. Subscribers can access that copy of the data set as an entitled data set.

  • OWNED

  • ENTITLED

ResourceNotFoundException

The resource couldn't be found.

Property Type Required Description
Message

string

True

The resource couldn't be found.

ResourceId

string

False

The unique identifier for the resource that couldn't be found.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of resource that couldn't be found.

ServiceQuotaExceededException

The request has exceeded the quotas imposed by the service.

Property Type Required Description
Message

string

True

The request has exceeded the quotas imposed by the service.

LimitName

string

Values: Products per account | Data sets per account | Data sets per product | Revisions per data set | Assets per revision | products per data set | Assets per import job from Amazon S3 | Asset per export job from Amazon S3 | Asset size in GB | Concurrent in progress jobs to import assets from Amazon S3 | Concurrent in progress jobs to import assets from a signed URL | Concurrent in progress jobs to export assets to Amazon S3 | Concurrent in progress jobs to export assets to a signed URL | Revisions per change set | Private offers per account | Bring-Your-Own-Subscription offers per account

False

The name of the quota that was exceeded.

LimitValue

number

Format: float

False

The maximum value for the service-specific limit.

TaggedDataSet

A data set is an AWS resource with one or more revisions.

Property Type Required Description
Origin

Origin

True

A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for subscribers).

AssetType

AssetType

True

The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.

Description

string

True

The description for the data set.

OriginDetails

object

False

If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.

SourceId

string

False

The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is returned when a data set owner is viewing the entitled copy of its owned data set.

CreatedAt

string

True

The date and time that the data set was created, in ISO 8601 format.

Id

string

True

The unique identifier for the data set.

Arn

string

True

The ARN for the data set.

UpdatedAt

string

True

The date and time that the data set was last updated, in ISO 8601 format.

Tags

object

False

The tags for the data set.

Name

string

True

The name of the data set.

ThrottlingException

The limit on the number of requests per second was exceeded.

Property Type Required Description
Message

string

True

The limit on the number of requests per second was exceeded.

ValidationException

The request was invalid.

Property Type Required Description
Message

string

True

The message that informs you about what was invalid about the request.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListDataSets

CreateDataSet