Data Set - AWS Data Exchange

Data Set

A data set is an AWS resource with one or more revisions. This section defines the GetDataSet, DeleteDataSet, and UpdateDataSet operations.

URI

/v1/data-sets/DataSetId

HTTP Methods

GET

Operation ID: GetDataSet

This operation returns information about a data set.

Path Parameters
Name Type Required Description
DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
200 TaggedDataSet

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

DELETE

Operation ID: DeleteDataSet

This operation deletes a data set.

Path Parameters
Name Type Required Description
DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
204 None

204 response

400 ValidationException

400 response

403 AccessDeniedException

403 response

404 ResourceNotFoundException

404 response

409 ConflictException

409 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

PATCH

Operation ID: UpdateDataSet

This operation updates a data set.

Path Parameters
Name Type Required Description
DataSetId String True

The unique identifier for a data set.

Responses
Status Code Response Model Description
200 DataSet

200 response

400 ValidationException

400 response

403 AccessDeniedException

403 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

Schemas

Request Bodies

Example PATCH

{ "Description": "string", "Name": "string" }

Response Bodies

Example TaggedDataSet

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

Example DataSet

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

Example ValidationException

{ "Message": "string" }

Example AccessDeniedException

{ "Message": "string" }

Example ResourceNotFoundException

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

Example ConflictException

{ "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

ConflictException

The request couldn't be completed because it conflicted with the current state of the resource.

Property Type Required Description
Message

string

True

The request couldn't be completed because it conflicted with the current state of the resource.

ResourceId

string

False

The unique identifier for the resource with the conflict.

ResourceType

string

Values: DATA_SET | REVISION | ASSET | JOB

False

The type of the resource with the conflict.

DataSet

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.

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.

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.

UpdateDataSetRequest

The request to update a data set.

Property Type Required Description
Description

string

False

The description for the data set.

Name

string

False

The name of the data set.

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:

GetDataSet

DeleteDataSet

UpdateDataSet