AWS API Changes

2022/03/15 - AWS Data Exchange - 1 new 4 updated api methods

Changes This feature enables data providers to use the RevokeRevision operation to revoke subscriber access to a given revision. Subscribers are unable to interact with assets within a revoked revision.

RevokeRevision (new)

Link ¶

This operation revokes subscribers' access to a revision.

See also: AWS API Documentation

Request Syntax

client.revoke_revision(
    DataSetId='string',
    RevisionId='string',
    RevocationComment='string'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

type RevocationComment

string

param RevocationComment

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Comment': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'DataSetId': 'string',
    'Finalized': True|False,
    'Id': 'string',
    'SourceId': 'string',
    'UpdatedAt': datetime(2015, 1, 1),
    'RevocationComment': 'string',
    'Revoked': True|False,
    'RevokedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --

200 response
- Arn (string) --
  
  The ARN for the revision.
- Comment (string) --
  
  An optional comment about the revision.
- CreatedAt (datetime) --
  
  The date and time that the revision was created, in ISO 8601 format.
- DataSetId (string) --
  
  The unique identifier for the data set associated with this revision.
- 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 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.
- SourceId (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.
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.
- RevocationComment (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.
- RevokedAt (datetime) --
  
  The date and time that the revision was revoked, in ISO 8601 format.

CreateRevision (updated)

Link ¶
Changes (response)

{'RevocationComment': 'string', 'Revoked': 'boolean', 'RevokedAt': 'timestamp'}

This operation creates a revision for a data set.

See also: AWS API Documentation

Request Syntax

client.create_revision(
    Comment='string',
    DataSetId='string',
    Tags={
        'string': 'string'
    }
)

type Comment

string

param Comment

An optional comment about the revision.

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type Tags

dict

param Tags

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.

(string) --
- (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Comment': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'DataSetId': 'string',
    'Finalized': True|False,
    'Id': 'string',
    'SourceId': 'string',
    'Tags': {
        'string': 'string'
    },
    'UpdatedAt': datetime(2015, 1, 1),
    'RevocationComment': 'string',
    'Revoked': True|False,
    'RevokedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --

201 response
- Arn (string) --
  
  The ARN for the revision.
- Comment (string) --
  
  An optional comment about the revision.
- CreatedAt (datetime) --
  
  The date and time that the revision was created, in ISO 8601 format.
- DataSetId (string) --
  
  The unique identifier for the data set associated with this revision.
- 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.
- SourceId (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.
- Tags (dict) --
  
  The tags for the revision.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.
- RevocationComment (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.
- RevokedAt (datetime) --
  
  The date and time that the revision was revoked, in ISO 8601 format.

GetRevision (updated)

Link ¶
Changes (response)

{'RevocationComment': 'string', 'Revoked': 'boolean', 'RevokedAt': 'timestamp'}

This operation returns information about a revision.

See also: AWS API Documentation

Request Syntax

client.get_revision(
    DataSetId='string',
    RevisionId='string'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Comment': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'DataSetId': 'string',
    'Finalized': True|False,
    'Id': 'string',
    'SourceId': 'string',
    'Tags': {
        'string': 'string'
    },
    'UpdatedAt': datetime(2015, 1, 1),
    'RevocationComment': 'string',
    'Revoked': True|False,
    'RevokedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --

200 response
- Arn (string) --
  
  The ARN for the revision.
- Comment (string) --
  
  An optional comment about the revision.
- CreatedAt (datetime) --
  
  The date and time that the revision was created, in ISO 8601 format.
- DataSetId (string) --
  
  The unique identifier for the data set associated with this revision.
- 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.
- SourceId (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.
- Tags (dict) --
  
  The tags for the revision.
  - (string) --
    - (string) --
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.
- RevocationComment (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.
- RevokedAt (datetime) --
  
  The date and time that the revision was revoked, in ISO 8601 format.

ListDataSetRevisions (updated)

Link ¶
Changes (response)

{'Revisions': {'RevocationComment': 'string',
               'Revoked': 'boolean',
               'RevokedAt': 'timestamp'}}

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

See also: AWS API Documentation

Request Syntax

client.list_data_set_revisions(
    DataSetId='string',
    MaxResults=123,
    NextToken='string'
)

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type MaxResults

integer

param MaxResults

The maximum number of results returned by a single call.

type NextToken

string

param NextToken

The token value retrieved from a previous call to access the next page of results.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'Revisions': [
        {
            'Arn': 'string',
            'Comment': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'DataSetId': 'string',
            'Finalized': True|False,
            'Id': 'string',
            'SourceId': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'RevocationComment': 'string',
            'Revoked': True|False,
            'RevokedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --

200 response
- NextToken (string) --
  
  The token value retrieved from a previous call to access the next page of results.
- Revisions (list) --
  
  The asset objects listed by the request.
  - (dict) --
    
    A revision is a container for one or more assets.
    - Arn (string) --
      
      The ARN for the revision.
    - Comment (string) --
      
      An optional comment about the revision.
    - CreatedAt (datetime) --
      
      The date and time that the revision was created, in ISO 8601 format.
    - DataSetId (string) --
      
      The unique identifier for the data set associated with this revision.
    - 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.
    - SourceId (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.
    - UpdatedAt (datetime) --
      
      The date and time that the revision was last updated, in ISO 8601 format.
    - RevocationComment (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.
    - RevokedAt (datetime) --
      
      The date and time that the revision was revoked, in ISO 8601 format.

UpdateRevision (updated)

Link ¶
Changes (response)

{'RevocationComment': 'string', 'Revoked': 'boolean', 'RevokedAt': 'timestamp'}

This operation updates a revision.

See also: AWS API Documentation

Request Syntax

client.update_revision(
    Comment='string',
    DataSetId='string',
    Finalized=True|False,
    RevisionId='string'
)

type Comment

string

param Comment

An optional comment about the revision.

type DataSetId

string

param DataSetId

[REQUIRED]

The unique identifier for a data set.

type Finalized

boolean

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

type RevisionId

string

param RevisionId

[REQUIRED]

The unique identifier for a revision.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'Comment': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'DataSetId': 'string',
    'Finalized': True|False,
    'Id': 'string',
    'SourceId': 'string',
    'UpdatedAt': datetime(2015, 1, 1),
    'RevocationComment': 'string',
    'Revoked': True|False,
    'RevokedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --

200 response
- Arn (string) --
  
  The ARN for the revision.
- Comment (string) --
  
  An optional comment about the revision.
- CreatedAt (datetime) --
  
  The date and time that the revision was created, in ISO 8601 format.
- DataSetId (string) --
  
  The unique identifier for the data set associated with this revision.
- 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 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.
- SourceId (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.
- UpdatedAt (datetime) --
  
  The date and time that the revision was last updated, in ISO 8601 format.
- RevocationComment (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.
- RevokedAt (datetime) --
  
  The date and time that the revision was revoked, in ISO 8601 format.