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

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200TaggedDataSet

200 response

400ValidationException

400 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

DELETE

Operation ID: DeleteDataSet

This operation deletes a data set.

Path parameters
NameTypeRequiredDescription
DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
204None

204 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

409ConflictException

409 response

429ThrottlingException

429 response

500InternalServerException

500 response

PATCH

Operation ID: UpdateDataSet

This operation updates a data set.

Path parameters
NameTypeRequiredDescription
DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200DataSet

200 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

Schemas

Request bodies

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

Response bodies

{ "Name": "string", "AssetType": enum, "Description": "string", "CreatedAt": "string", "UpdatedAt": "string", "Origin": enum, "OriginDetails": { "ProductId": "string" }, "Arn": "string", "Id": "string", "SourceId": "string", "Tags": { } }
{ "Name": "string", "AssetType": enum, "Description": "string", "CreatedAt": "string", "UpdatedAt": "string", "Origin": enum, "OriginDetails": { "ProductId": "string" }, "Arn": "string", "Id": "string", "SourceId": "string" }
{ "Message": "string", "ExceptionCause": enum }
{ "Message": "string" }
{ "Message": "string", "ResourceType": enum, "ResourceId": "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

ConflictException

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

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

False

The type of the resource with the conflict.

DataSet

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.

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.

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.

UpdateDataSetRequest

The request to update a data set.

PropertyTypeRequiredDescription
Description

string

False

The description for the data set.

Name

string

False

The name of the data set.

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:

GetDataSet

DeleteDataSet

UpdateDataSet