Revisions - AWS Data Exchange

Revisions

A revision is a container for one or more assets. As new data is available, you create revisions and add assets. This section defines the ListDataSetRevisions and CreateRevision operations.

URI

/v1/data-sets/DataSetId/revisions

HTTP Methods

GET

Operation ID: ListDataSetRevisions

This operation lists a data set's revisions sorted by CreatedAt in descending order.

Path Parameters
Name Type Required Description
DataSetId String True

The unique identifier for a data set.

Query Parameters
Name Type Required Description
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 ListOfRevisions

200 response

400 ValidationException

400 response

404 ResourceNotFoundException

404 response

429 ThrottlingException

429 response

500 InternalServerException

500 response

POST

Operation ID: CreateRevision

This operation creates a revision for 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
201 TaggedRevision

201 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 POST

{ "Comment": "string", "Tags": { } }

Response Bodies

Example ListOfRevisions

{ "NextToken": "string", "Revisions": [ { "Comment": "string", "SourceId": "string", "CreatedAt": "string", "DataSetId": "string", "Id": "string", "Arn": "string", "UpdatedAt": "string", "Finalized": boolean } ] }

Example TaggedRevision

{ "Comment": "string", "SourceId": "string", "CreatedAt": "string", "DataSetId": "string", "Id": "string", "Arn": "string", "UpdatedAt": "string", "Finalized": boolean, "Tags": { } }

Example ValidationException

{ "Message": "string" }

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.

CreateRevisionRequest

Creates a revision for a data set. When they're created, revisions are not published to products, and therefore are not available to subscribers. To publish a revision to a data set in a product, the revision must first be finalized.

Property Type Required Description
Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the revision.

Tags

object

False

A revision tag is an optional label that you can assign to a revision 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.

InternalServerException

An exception occurred with the service.

Property Type Required Description
Message

string

True

The message identifying the service exception that occurred.

ListOfRevisions

The revision 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.

Revisions

Array of type RevisionEntry

True

The asset objects listed by the request.

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.

RevisionEntry

A revision is a container for one or more assets.

Property Type Required Description
Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the revision.

SourceId

string

False

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

CreatedAt

string

True

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

DataSetId

string

True

The unique identifier for the data set associated with this revision.

Id

string

True

The unique identifier for the revision.

Arn

string

True

The ARN for the revision.

UpdatedAt

string

True

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

Finalized

boolean

False

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

TaggedRevision

A revision tag is an optional label that you can assign to a revision 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.

Property Type Required Description
Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the revision.

SourceId

string

False

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

CreatedAt

string

True

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

DataSetId

string

True

The unique identifier for the data set associated with this revision.

Id

string

True

The unique identifier for the revision.

Arn

string

True

The ARN for the revision

UpdatedAt

string

True

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

Finalized

boolean

False

To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this read-only state, you can publish the revision to your products.

Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API, using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely identified by their ARN.

Tags

object

False

The tags for the revision.

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:

ListDataSetRevisions

CreateRevision