:doc:`DataZone <../../datazone>` / Paginator / ListNotifications

*****************
ListNotifications
*****************



.. py:class:: DataZone.Paginator.ListNotifications

  ::

    
    paginator = client.get_paginator('list_notifications')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_notifications`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListNotifications>`_    


    **Request Syntax**
    ::

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

      The identifier of the Amazon DataZone domain.

      

    
    :type type: string
    :param type: **[REQUIRED]** 

      The type of notifications.

      

    
    :type afterTimestamp: datetime
    :param afterTimestamp: 

      The time after which you want to list notifications.

      

    
    :type beforeTimestamp: datetime
    :param beforeTimestamp: 

      The time before which you want to list notifications.

      

    
    :type subjects: list
    :param subjects: 

      The subjects of notifications.

      

    
      - *(string) --* 

      
  
    :type taskStatus: string
    :param taskStatus: 

      The task status of notifications.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

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

      

      - *(dict) --* 
        

        - **notifications** *(list) --* 

          The results of the ``ListNotifications`` action.

          
          

          - *(dict) --* 

            The details of a notification generated in Amazon DataZone.

            
            

            - **identifier** *(string) --* 

              The identifier of the notification.

              
            

            - **domainIdentifier** *(string) --* 

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

              
            

            - **type** *(string) --* 

              The type of the notification.

              
            

            - **topic** *(dict) --* 

              The topic of the notification.

              
              

              - **subject** *(string) --* 

                The subject of the resource mentioned in a notification.

                
              

              - **resource** *(dict) --* 

                The details of the resource mentioned in a notification.

                
                

                - **type** *(string) --* 

                  The type 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.

                  
            
              

              - **role** *(string) --* 

                The role of the resource mentioned in a notification.

                
          
            

            - **title** *(string) --* 

              The title of the notification.

              
            

            - **message** *(string) --* 

              The message included in the notification.

              
            

            - **status** *(string) --* 

              The status included in the notification.

              
            

            - **actionLink** *(string) --* 

              The action link included in the notification.

              
            

            - **creationTimestamp** *(datetime) --* 

              The timestamp of when a notification was created.

              
            

            - **lastUpdatedTimestamp** *(datetime) --* 

              The timestamp of when the notification was last updated.

              
            

            - **metadata** *(dict) --* 

              The metadata included in the notification.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    