DataZone / Client / list_subscription_requests

list_subscription_requests#

DataZone.Client.list_subscription_requests(**kwargs)#

Lists Amazon DataZone subscription requests.

Request Syntax

response = client.list_subscription_requests(
    approverProjectId='string',
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    owningProjectId='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    status='PENDING'|'ACCEPTED'|'REJECTED',
    subscribedListingId='string'
)

Parameters:

approverProjectId (string) – The identifier of the subscription request approver’s project.
domainIdentifier (string) –
[REQUIRED]

The identifier of the Amazon DataZone domain.
maxResults (integer) – The maximum number of subscription requests to return in a single call to ListSubscriptionRequests. When the number of subscription requests to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
nextToken (string) – When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.
owningProjectId (string) – The identifier of the project for the subscription requests.
sortBy (string) – Specifies the way to sort the results of this action.
sortOrder (string) – Specifies the sort order for the results of this action.
status (string) –
Specifies the status of the subscription requests.

Note
This is not a required parameter, but if not specified, by default, Amazon DataZone returns only PENDING subscription requests.
subscribedListingId (string) – The identifier of the subscribed listing.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'decisionComment': 'string',
            'domainId': 'string',
            'id': 'string',
            'requestReason': 'string',
            'reviewerId': 'string',
            'status': 'PENDING'|'ACCEPTED'|'REJECTED',
            'subscribedListings': [
                {
                    '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'
                },
            ],
            'subscribedPrincipals': [
                {
                    'project': {
                        'id': 'string',
                        'name': 'string'
                    }
                },
            ],
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The results of the ListSubscriptionRequests action.
  - (dict) –
    
    The details of the subscription request.
    - createdAt (datetime) –
      
      The timestamp of when a subscription request was created.
    - createdBy (string) –
      
      The Amazon DataZone user who created the subscription request.
    - decisionComment (string) –
      
      The decision comment of the subscription request.
    - domainId (string) –
      
      The identifier of the Amazon DataZone domain in which a subscription request exists.
    - id (string) –
      
      The identifier of the subscription request.
    - requestReason (string) –
      
      The reason for the subscription request.
    - reviewerId (string) –
      
      The identifier of the subscription request reviewer.
    - status (string) –
      
      The status of the subscription request.
    - subscribedListings (list) –
      
      The listings included in the subscription request.
      - (dict) –
        
        The details of the published asset for which the subscription grant is created.
        
        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.
    - subscribedPrincipals (list) –
      
      The principals included in the subscription request.
      - (dict) –
        
        The principal that has the subscription grant for the asset.
        
        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.
    - updatedAt (datetime) –
      
      The timestamp of when the subscription request was updated.
    - updatedBy (string) –
      
      The identifier of the Amazon DataZone user who updated the subscription request.
- nextToken (string) –
  
  When the number of subscription requests is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of subscription requests, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListSubscriptionRequests to list the next set of subscription requests.

Exceptions

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