DataZone / Paginator / ListSubscriptions

ListSubscriptions

class DataZone.Paginator.ListSubscriptions

paginator = client.get_paginator('list_subscriptions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_subscriptions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    approverProjectId='string',
    domainIdentifier='string',
    owningProjectId='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    status='APPROVED'|'REVOKED'|'CANCELLED',
    subscribedListingId='string',
    subscriptionRequestIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• approverProjectId (string) – The identifier of the project for the subscription’s approver.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• owningProjectId (string) – The identifier of the owning project.

• sortBy (string) – Specifies the way in which the results of this action are to be sorted.

• sortOrder (string) – Specifies the sort order for the results of this action.

• status (string) –

  The status of the subscriptions that you want to list.

  Note

  This is not a required parameter, but if not provided, by default, Amazon DataZone returns only APPROVED subscriptions.

• subscribedListingId (string) – The identifier of the subscribed listing for the subscriptions that you want to list.

• subscriptionRequestIdentifier (string) – The identifier of the subscription request for the subscriptions that you want to list.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            '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': {
                        'assetScope': {
                            'assetId': 'string',
                            'errorMessage': 'string',
                            'filterIds': [
                                'string',
                            ],
                            'status': 'string'
                        },
                        '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListSubscriptions action.

    • (dict) –

      The details of the subscription.

      • createdAt (datetime) –

        The timestamp of when the subscription was created.

      • createdBy (string) –

        The Amazon DataZone user who created the subscription.

      • domainId (string) –

        The identifier of the Amazon DataZone domain in which a subscription exists.

      • id (string) –

        The identifier of the subscription.

      • retainPermissions (boolean) –

        The retain permissions included in the subscription.

      • status (string) –

        The status of the subscription.

      • subscribedListing (dict) –

        The listing included in the subscription.

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

            • assetScope (dict) –

              The asset scope of the subscribed asset listing.

              • assetId (string) –

                The asset ID of the asset scope.

              • errorMessage (string) –

                The error message of the asset scope.

              • filterIds (list) –

                The filter IDs of the asset scope.

                • (string) –

              • status (string) –

                The status of the asset scope.

            • 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 principal included in the subscription.

        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 identifier of the subscription request for the subscription.

      • updatedAt (datetime) –

        The timestamp of when the subscription was updated.

      • updatedBy (string) –

        The Amazon DataZone user who updated the subscription.

  • NextToken (string) –

    A token to resume pagination.