DataZone / Paginator / ListNotifications

ListNotifications

class DataZone.Paginator.ListNotifications

paginator = client.get_paginator('list_notifications')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    afterTimestamp=datetime(2015, 1, 1),
    beforeTimestamp=datetime(2015, 1, 1),
    domainIdentifier='string',
    subjects=[
        'string',
    ],
    taskStatus='ACTIVE'|'INACTIVE',
    type='TASK'|'EVENT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• afterTimestamp (datetime) – The time after which you want to list notifications.

• beforeTimestamp (datetime) – The time before which you want to list notifications.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• subjects (list) –

  The subjects of notifications.

  • (string) –

• taskStatus (string) – The task status of notifications.

• type (string) –

  [REQUIRED]

  The type of notifications.

• 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

{
    'notifications': [
        {
            'actionLink': 'string',
            'creationTimestamp': datetime(2015, 1, 1),
            'domainIdentifier': 'string',
            'identifier': 'string',
            'lastUpdatedTimestamp': datetime(2015, 1, 1),
            'message': 'string',
            'metadata': {
                'string': 'string'
            },
            'status': 'ACTIVE'|'INACTIVE',
            'title': 'string',
            'topic': {
                'resource': {
                    'id': 'string',
                    'name': 'string',
                    'type': 'PROJECT'
                },
                'role': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_VIEWER'|'DOMAIN_OWNER'|'PROJECT_SUBSCRIBER',
                'subject': 'string'
            },
            'type': 'TASK'|'EVENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • notifications (list) –

    The results of the ListNotifications action.

    • (dict) –

      The details of a notification generated in Amazon DataZone.

      • actionLink (string) –

        The action link included in the notification.

      • creationTimestamp (datetime) –

        The timestamp of when a notification was created.

      • domainIdentifier (string) –

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

      • identifier (string) –

        The identifier of the notification.

      • lastUpdatedTimestamp (datetime) –

        The timestamp of when the notification was last updated.

      • message (string) –

        The message included in the notification.

      • metadata (dict) –

        The metadata included in the notification.

        • (string) –

          • (string) –

      • status (string) –

        The status included in the notification.

      • title (string) –

        The title of the notification.

      • topic (dict) –

        The topic of the notification.

        • resource (dict) –

          The details of the resource mentioned in a notification.

          • id (string) –

            The ID of the resource mentioned in a notification.

          • name (string) –

            The name of the resource mentioned in a notification.

          • type (string) –

            The type of the resource mentioned in a notification.

        • role (string) –

          The role of the resource mentioned in a notification.

        • subject (string) –

          The subject of the resource mentioned in a notification.

      • type (string) –

        The type of the notification.

  • NextToken (string) –

    A token to resume pagination.