DataZone / Client / delete_subscription_grant
delete_subscription_grant#
- DataZone.Client.delete_subscription_grant(**kwargs)#
Deletes and subscription grant in Amazon DataZone.
See also: AWS API Documentation
Request Syntax
response = client.delete_subscription_grant( domainIdentifier='string', identifier='string' )
- Parameters:
domainIdentifier (string) –
[REQUIRED]
The ID of the Amazon DataZone domain where the subscription grant is deleted.
identifier (string) –
[REQUIRED]
The ID of the subscription grant that is deleted.
- Return type:
dict
- Returns:
Response Syntax
{ 'assets': [ { 'assetId': 'string', 'assetRevision': 'string', 'failureCause': { 'message': 'string' }, 'failureTimestamp': datetime(2015, 1, 1), 'grantedTimestamp': datetime(2015, 1, 1), 'status': 'GRANT_PENDING'|'REVOKE_PENDING'|'GRANT_IN_PROGRESS'|'REVOKE_IN_PROGRESS'|'GRANTED'|'REVOKED'|'GRANT_FAILED'|'REVOKE_FAILED', 'targetName': 'string' }, ], 'createdAt': datetime(2015, 1, 1), 'createdBy': 'string', 'domainId': 'string', 'grantedEntity': { 'listing': { 'id': 'string', 'revision': 'string' } }, 'id': 'string', 'status': 'PENDING'|'IN_PROGRESS'|'GRANT_FAILED'|'REVOKE_FAILED'|'GRANT_AND_REVOKE_FAILED'|'COMPLETED'|'INACCESSIBLE', 'subscriptionId': 'string', 'subscriptionTargetId': 'string', 'updatedAt': datetime(2015, 1, 1), 'updatedBy': 'string' }
Response Structure
(dict) –
assets (list) –
The assets for which the subsctiption grant that is deleted gave access.
(dict) –
The details of the asset for which the subscription grant is created.
assetId (string) –
The identifier of the asset for which the subscription grant is created.
assetRevision (string) –
The revision of the asset for which the subscription grant is created.
failureCause (dict) –
The failure cause included in the details of the asset for which the subscription grant is created.
message (string) –
The description of the error message.
failureTimestamp (datetime) –
The failure timestamp included in the details of the asset for which the subscription grant is created.
grantedTimestamp (datetime) –
The timestamp of when the subscription grant to the asset is created.
status (string) –
The status of the asset for which the subscription grant is created.
targetName (string) –
The target name of the asset for which the subscription grant is created.
createdAt (datetime) –
The timestamp of when the subscription grant that is deleted was created.
createdBy (string) –
The Amazon DataZone user who created the subscription grant that is deleted.
domainId (string) –
The ID of the Amazon DataZone domain in which the subscription grant is deleted.
grantedEntity (dict) –
The entity to which the subscription is deleted.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
listing
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
listing (dict) –
The listing for which a subscription is granted.
id (string) –
An identifier of a revision of an asset published in a Amazon DataZone catalog.
revision (string) –
The details of a revision of an asset published in a Amazon DataZone catalog.
id (string) –
The ID of the subscription grant that is deleted.
status (string) –
The status of the subscription grant that is deleted.
subscriptionId (string) –
The identifier of the subsctiption whose subscription grant is to be deleted.
subscriptionTargetId (string) –
The ID of the subscription target associated with the subscription grant that is deleted.
updatedAt (datetime) –
The timestamp of when the subscription grant that is deleted was updated.
updatedBy (string) –
The Amazon DataZone user who updated the subscription grant that is deleted.
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