revisions

Creates, updates, deletes, gets or lists a revisions resource.

Overview

Name	revisions
Type	Resource
Id	aws.dataexchange.revisions

Fields

The following fields are returned by SELECT queries:

get_revision

Name	Datatype	Description
arn	string	The ARN for the revision.
comment	string	An optional comment about the revision.
created_at	string (date-time)	The date and time that the revision was created, in ISO 8601 format.
data_set_id	string	The unique identifier for the data set associated with the data set revision. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
finalized	boolean	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	The unique identifier for the revision. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
revocation_comment	string	A required comment to inform subscribers of the reason their access to the revision was revoked.
revoked	boolean	A status indicating that subscribers' access to the revision was revoked.
revoked_at	string (date-time)	The date and time that the revision was revoked, in ISO 8601 format.
source_id	string	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. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
tags	object	The tags for the revision.
updated_at	string (date-time)	The date and time that the revision was last updated, in ISO 8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_revision	select	data_set_id, revision_id, region		This operation returns information about a revision.
create_revision	insert	data_set_id, region		This operation creates a revision for a data set.
revoke_revision	update	data_set_id, revision_id, region, RevocationComment		This operation revokes subscribers' access to a revision.
update_revision	update	data_set_id, revision_id, region		This operation updates a revision.
delete_revision	delete	data_set_id, revision_id, region		This operation deletes a revision.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
data_set_id	string	The unique identifier for a data set.
region	string	AWS region (default: us-east-1)
revision_id	string	The unique identifier for a revision.

SELECT examples

get_revision

This operation returns information about a revision.

SELECT
arn,
comment,
created_at,
data_set_id,
finalized,
id,
revocation_comment,
revoked,
revoked_at,
source_id,
tags,
updated_at
FROM aws.dataexchange.revisions
WHERE data_set_id = '{{ data_set_id }}' -- required
AND revision_id = '{{ revision_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_revision

This operation creates a revision for a data set.

INSERT INTO aws.dataexchange.revisions (
Comment,
Tags,
data_set_id,
region
)
SELECT 
'{{ Comment }}',
'{{ Tags }}',
'{{ data_set_id }}',
'{{ region }}'
RETURNING
arn,
comment,
created_at,
data_set_id,
finalized,
id,
revocation_comment,
revoked,
revoked_at,
source_id,
tags,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: revisions
props:
  - name: data_set_id
    value: "{{ data_set_id }}"
    description: Required parameter for the revisions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the revisions resource.
  - name: Comment
    value: "{{ Comment }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

revoke_revision

This operation revokes subscribers' access to a revision.

UPDATE aws.dataexchange.revisions
SET 
RevocationComment = '{{ RevocationComment }}'
WHERE 
data_set_id = '{{ data_set_id }}' --required
AND revision_id = '{{ revision_id }}' --required
AND region = '{{ region }}' --required
AND RevocationComment = '{{ RevocationComment }}' --required
RETURNING
arn,
comment,
created_at,
data_set_id,
finalized,
id,
revocation_comment,
revoked,
revoked_at,
source_id,
updated_at;

update_revision

This operation updates a revision.

UPDATE aws.dataexchange.revisions
SET 
Comment = '{{ Comment }}',
Finalized = {{ Finalized }}
WHERE 
data_set_id = '{{ data_set_id }}' --required
AND revision_id = '{{ revision_id }}' --required
AND region = '{{ region }}' --required
RETURNING
arn,
comment,
created_at,
data_set_id,
finalized,
id,
revocation_comment,
revoked,
revoked_at,
source_id,
updated_at;

DELETE examples

delete_revision

This operation deletes a revision.

DELETE FROM aws.dataexchange.revisions
WHERE data_set_id = '{{ data_set_id }}' --required
AND revision_id = '{{ revision_id }}' --required
AND region = '{{ region }}' --required
;