Revision - AWS Data Exchange

Revision

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 GetRevision, DeleteRevision, and UpdateRevision operations.

URI

/v1/data-sets/DataSetId/revisions/RevisionId

HTTP methods

GET

Operation ID: GetRevision

This operation returns information about a revision.

Path parameters
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200TaggedRevision

200 response

400ValidationException

400 response

404ResourceNotFoundException

404 response

429ThrottlingException

429 response

500InternalServerException

500 response

DELETE

Operation ID: DeleteRevision

This operation deletes a revision.

Path parameters
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

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: UpdateRevision

This operation updates a revision.

Path parameters
NameTypeRequiredDescription
RevisionIdStringTrue

The unique identifier for a revision.

DataSetIdStringTrue

The unique identifier for a data set.

Responses
Status codeResponse modelDescription
200Revision

200 response

400ValidationException

400 response

403AccessDeniedException

403 response

404ResourceNotFoundException

404 response

409ConflictException

409 response

429ThrottlingException

429 response

500InternalServerException

500 response

Schemas

Request bodies

{ "Comment": "string", "Finalized": boolean }

Response bodies

{ "DataSetId": "string", "Comment": "string", "Arn": "string", "Id": "string", "CreatedAt": "string", "UpdatedAt": "string", "Finalized": boolean, "SourceId": "string", "Revoked": boolean, "RevocationComment": "string", "RevokedAt": "string", "Tags": { } }
{ "DataSetId": "string", "Comment": "string", "Arn": "string", "Id": "string", "CreatedAt": "string", "UpdatedAt": "string", "Finalized": boolean, "SourceId": "string", "Revoked": boolean, "RevocationComment": "string", "RevokedAt": "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.

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.

InternalServerException

An exception occurred with the service.

PropertyTypeRequiredDescription
Message

string

True

The message identifying the service exception that occurred.

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.

Revision

A revision is a container for one or more assets.

PropertyTypeRequiredDescription
Arn

string

True

The ARN for the revision.

Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the 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.

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

Id

string

True

The unique identifier for the revision.

RevocationComment

string

MinLength: 10

MaxLength: 512

False

A required comment to inform subscribers of the reason their access to the revision was revoked.

Revoked

boolean

False

A status indicating that subscribers' access to the revision was revoked.

RevokedAt

string

False

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

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.

UpdatedAt

string

True

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

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.

PropertyTypeRequiredDescription
Arn

string

True

The ARN for the revision.

Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the 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.

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.

Id

string

True

The unique identifier for the revision.

RevocationComment

string

MinLength: 10

MaxLength: 512

False

A required comment to inform subscribers of the reason their access to the revision was revoked.

Revoked

boolean

False

A status indicating that subscribers' access to the revision was revoked.

RevokedAt

string

False

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

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.

Tags

object

False

The tags for the revision.

UpdatedAt

string

True

The date and time that the revision 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.

UpdateRevisionRequest

The request to update a revision.

PropertyTypeRequiredDescription
Comment

string

MinLength: 0

MaxLength: 16384

False

An optional comment about the revision.

Finalized

boolean

False

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.

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:

GetRevision

DeleteRevision

UpdateRevision