DataZone / Paginator / ListSubscriptionTargets

ListSubscriptionTargets

class DataZone.Paginator.ListSubscriptionTargets

paginator = client.get_paginator('list_subscription_targets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainIdentifier='string',
    environmentIdentifier='string',
    sortBy='CREATED_AT'|'UPDATED_AT',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain where you want to list subscription targets.

• environmentIdentifier (string) –

  [REQUIRED]

  The identifier of the environment where you want to list subscription targets.

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

• 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': [
        {
            'id': 'string',
            'authorizedPrincipals': [
                'string',
            ],
            'domainId': 'string',
            'projectId': 'string',
            'environmentId': 'string',
            'name': 'string',
            'type': 'string',
            'createdBy': 'string',
            'updatedBy': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'manageAccessRole': 'string',
            'applicableAssetTypes': [
                'string',
            ],
            'subscriptionTargetConfig': [
                {
                    'formName': 'string',
                    'content': 'string'
                },
            ],
            'provider': 'string',
            'subscriptionGrantCreationMode': 'AUTOMATIC'|'MANUAL'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListSubscriptionTargets action.

    • (dict) –

      The details of the subscription target.

      • id (string) –

        The identifier of the subscription target.

      • authorizedPrincipals (list) –

        The authorized principals included in the subscription target.

        • (string) –

      • domainId (string) –

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

      • projectId (string) –

        The identifier of the project specified in the subscription target.

      • environmentId (string) –

        The identifier of the environment of the subscription target.

      • name (string) –

        The name of the subscription target.

      • type (string) –

        The type of the subscription target.

      • createdBy (string) –

        The Amazon DataZone user who created the subscription target.

      • updatedBy (string) –

        The Amazon DataZone user who updated the subscription target.

      • createdAt (datetime) –

        The timestamp of when the subscription target was created.

      • updatedAt (datetime) –

        The timestamp of when the subscription target was updated.

      • manageAccessRole (string) –

        The manage access role specified in the subscription target.

      • applicableAssetTypes (list) –

        The asset types included in the subscription target.

        • (string) –

      • subscriptionTargetConfig (list) –

        The configuration of the subscription target.

        • (dict) –

          The details of the subscription target configuration.

          • formName (string) –

            The form name included in the subscription target configuration.

          • content (string) –

            The content of the subscription target configuration.

      • provider (string) –

        The provider of the subscription target.

      • subscriptionGrantCreationMode (string) –

        Determines the subscription grant creation mode for this target, defining if grants are auto-created upon subscription approval or managed manually.

  • NextToken (string) –

    A token to resume pagination.