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
NameTypeRequiredDescription
originStringFalse

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

nextTokenStringFalse

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

maxResultsStringFalse

The maximum number of results returned by a single call.

Responses
Status codeResponse modelDescription
200ListOfDataSets

200 response

400ValidationException

400 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

POST

Operation ID: CreateDataSet

This operation creates a data set.

Responses
Status codeResponse modelDescription
201TaggedDataSet

201 response

400ValidationException

400 response

402ServiceQuotaExceededException

402 response

403AccessDeniedException

403 response

429ThrottlingException

429 response

500InternalServerException

500 response

Schemas

Request bodies

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

Response bodies

{ "DataSets": [ { "Name": "string", "AssetType": enum, "Description": "string", "CreatedAt": "string", "UpdatedAt": "string", "Origin": enum, "OriginDetails": { "ProductId": "string" }, "Arn": "string", "Id": "string", "SourceId": "string" } ], "NextToken": "string" }
{ "Name": "string", "AssetType": enum, "Description": "string", "CreatedAt": "string", "UpdatedAt": "string", "Origin": enum, "OriginDetails": { "ProductId": "string" }, "Arn": "string", "Id": "string", "SourceId": "string", "Tags": { } }
{ "Message": "string", "ExceptionCause": enum }
{ "Message": "string", "LimitName": enum, "LimitValue": number }
{ "Message": "string" }
{ "Message": "string", "ResourceType": enum, "ResourceId": "string" }
{ "Message": "string" }
{ "Message": "string" }

Properties

AccessDeniedException

Access to the resource is denied.

PropertyTypeRequiredDescription
Message

string

True

Access to the resource is denied.

AssetType

The type of asset that is added to a data set.

  • S3_SNAPSHOT

  • REDSHIFT_DATA_SHARE

  • API_GATEWAY_API

CreateDataSetRequest

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

PropertyTypeRequiredDescription
AssetType

AssetType

True

The type of asset that is added to a data set.

Description

string

True

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

Name

string

True

The name of the data set.

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.

DataSetEntry

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

PropertyTypeRequiredDescription
Arn

string

True

The ARN for the data set.

AssetType

AssetType

True

The type of asset that is added to a data set.

CreatedAt

string

True

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

Description

string

True

The description for the data set.

Id

string

True

The unique identifier for the data set.

Name

string

True

The name of the data set.

Origin

Origin

True

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

OriginDetails

OriginDetails

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.

UpdatedAt

string

True

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

InternalServerException

An exception occurred with the service.

PropertyTypeRequiredDescription
Message

string

True

The message identifying the service exception that occurred.

ListOfDataSets

The data set objects listed by the request.

PropertyTypeRequiredDescription
DataSets

Array of type DataSetEntry

True

The data set objects listed by the request.

NextToken

string

False

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

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

OriginDetails

Information about the origin of the data set.

PropertyTypeRequiredDescription
ProductId

string

True

The product ID of the origin of the data set.

ResourceNotFoundException

The resource couldn't be found.

PropertyTypeRequiredDescription
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 | EVENT_ACTION

False

The type of resource that couldn't be found.

ServiceQuotaExceededException

The request has exceeded the quotas imposed by the service.

PropertyTypeRequiredDescription
LimitName

string

Values: Products per account | Data sets per account | Data sets per product | Revisions per data set | Assets per revision | Assets per import job from Amazon S3 | Asset per export job from Amazon S3 | Asset size in GB | Concurrent in progress jobs to export assets to Amazon S3 | Concurrent in progress jobs to export assets to a signed URL | 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 revisions to Amazon S3 | Event actions per account | Auto export event actions per data set | Amazon Redshift datashare assets per import job from Redshift | Concurrent in progress jobs to import assets from Amazon Redshift datashares | Revisions per Amazon Redshift datashare data set | Amazon Redshift datashare assets per revision | Concurrent in progress jobs to import assets from an API Gateway API | Amazon API Gateway API assets per revision | Revisions per Amazon API Gateway API data set

False

The name of the quota that was exceeded.

LimitValue

number

Format: float

False

The maximum value for the service-specific limit.

Message

string

True

The request has exceeded the quotas imposed by the service.

TaggedDataSet

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

PropertyTypeRequiredDescription
Arn

string

True

The ARN for the data set.

AssetType

AssetType

True

The type of asset that is added to a data set.

CreatedAt

string

True

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

Description

string

True

The description for the data set.

Id

string

True

The unique identifier for the data set.

Name

string

True

The name of the data set.

Origin

Origin

True

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

OriginDetails

OriginDetails

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.

Tags

object

False

The tags for the data set.

UpdatedAt

string

True

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

ThrottlingException

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

PropertyTypeRequiredDescription
Message

string

True

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

ValidationException

The request was invalid.

PropertyTypeRequiredDescription
ExceptionCause

string

Values: InsufficientS3BucketPolicy | S3AccessDenied

False

The message that informs you about what the exception was.

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