DataZone / Client / cancel_subscription

cancel_subscription#

DataZone.Client.cancel_subscription(**kwargs)#

Cancels the subscription to the specified asset.

Request Syntax

response = client.cancel_subscription(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The unique identifier of the Amazon DataZone domain where the subscription request is being cancelled.
identifier (string) –
[REQUIRED]

The unique identifier of the subscription that is being cancelled.

Return type:

dict

Returns:

Response Syntax

{
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'domainId': 'string',
    'id': 'string',
    'retainPermissions': True|False,
    'status': 'APPROVED'|'REVOKED'|'CANCELLED',
    'subscribedListing': {
        'description': 'string',
        'id': 'string',
        'item': {
            'assetListing': {
                'entityId': 'string',
                'entityRevision': 'string',
                'entityType': 'string',
                'forms': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ]
            },
            'productListing': {
                'assetListings': [
                    {
                        'entityId': 'string',
                        'entityRevision': 'string',
                        'entityType': 'string'
                    },
                ],
                'description': 'string',
                'entityId': 'string',
                'entityRevision': 'string',
                'glossaryTerms': [
                    {
                        'name': 'string',
                        'shortDescription': 'string'
                    },
                ],
                'name': 'string'
            }
        },
        'name': 'string',
        'ownerProjectId': 'string',
        'ownerProjectName': 'string',
        'revision': 'string'
    },
    'subscribedPrincipal': {
        'project': {
            'id': 'string',
            'name': 'string'
        }
    },
    'subscriptionRequestId': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string'
}

Response Structure

(dict) –
- createdAt (datetime) –
  
  The timestamp that specifies when the request to cancel the subscription was created.
- createdBy (string) –
  
  Specifies the Amazon DataZone user who is cancelling the subscription.
- domainId (string) –
  
  The unique identifier of the Amazon DataZone domain where the subscription is being cancelled.
- id (string) –
  
  The identifier of the subscription.
- retainPermissions (boolean) –
  
  Specifies whether the permissions to the asset are retained after the subscription is cancelled.
- status (string) –
  
  The status of the request to cancel the subscription.
- subscribedListing (dict) –
  
  The asset to which a subscription is being cancelled.
  - description (string) –
    
    The description of the published asset for which the subscription grant is created.
  - id (string) –
    
    The identifier of the published asset for which the subscription grant is created.
  - item (dict) –
    
    The published asset for which the subscription grant is created.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: assetListing, productListing. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - assetListing (dict) –
      
      The asset for which the subscription grant is created.
      - entityId (string) –
        
        The identifier of the published asset for which the subscription grant is created.
      - entityRevision (string) –
        
        The revision of the published asset for which the subscription grant is created.
      - entityType (string) –
        
        The type of the published asset for which the subscription grant is created.
      - forms (string) –
        
        The forms attached to the published asset for which the subscription grant is created.
      - glossaryTerms (list) –
        
        The glossary terms attached to the published asset for which the subscription grant is created.
        
        (dict) –
        
        Details of a glossary term attached to the inventory asset.
        
        name (string) –
        
        The name of a glossary term attached to the inventory asset.
        
        shortDescription (string) –
        
        The shoft description of a glossary term attached to the inventory asset.
    - productListing (dict) –
      
      The data product listing.
      - assetListings (list) –
        
        The data assets of the data product listing.
        
        (dict) –
        
        The listing of the asset in a data product.
        
        entityId (string) –
        
        The entity ID of the listing of the asset in a data product.
        
        entityRevision (string) –
        
        The entity revision of the listing of the asset in a data product.
        
        entityType (string) –
        
        The entity type of the listing of the asset in a data product.
      - description (string) –
        
        The description of the data product listing.
      - entityId (string) –
        
        The ID of the data product listing.
      - entityRevision (string) –
        
        The revision of the data product listing.
      - glossaryTerms (list) –
        
        The glossary terms of the data product listing.
        
        (dict) –
        
        Details of a glossary term attached to the inventory asset.
        
        name (string) –
        
        The name of a glossary term attached to the inventory asset.
        
        shortDescription (string) –
        
        The shoft description of a glossary term attached to the inventory asset.
      - name (string) –
        
        The name of the data product listing.
  - name (string) –
    
    The name of the published asset for which the subscription grant is created.
  - ownerProjectId (string) –
    
    The identifier of the project of the published asset for which the subscription grant is created.
  - ownerProjectName (string) –
    
    The name of the project that owns the published asset for which the subscription grant is created.
  - revision (string) –
    
    The revision of the published asset for which the subscription grant is created.
- subscribedPrincipal (dict) –
  
  The Amazon DataZone user who is made a subscriber to the specified asset by the subscription that is being cancelled.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: project. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - project (dict) –
    
    The project that has the subscription grant.
    - id (string) –
      
      The identifier of the project that has the subscription grant.
    - name (string) –
      
      The name of the project that has the subscription grant.
- subscriptionRequestId (string) –
  
  The unique ID of the subscripton request for the subscription that is being cancelled.
- updatedAt (datetime) –
  
  The timestamp that specifies when the subscription was cancelled.
- updatedBy (string) –
  
  The Amazon DataZone user that cancelled the subscription.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ConflictException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException