:doc:`DataZone <../../datazone>` / Client / list_notifications

******************
list_notifications
******************



.. py:method:: DataZone.Client.list_notifications(**kwargs)

  

  Lists all Amazon DataZone notifications.

  

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


  **Request Syntax**
  ::

    response = client.list_notifications(
        domainIdentifier='string',
        type='TASK'|'EVENT',
        afterTimestamp=datetime(2015, 1, 1),
        beforeTimestamp=datetime(2015, 1, 1),
        subjects=[
            'string',
        ],
        taskStatus='ACTIVE'|'INACTIVE',
        maxResults=123,
        nextToken='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 maxResults: integer
  :param maxResults: 

    The maximum number of notifications to return in a single call to ``ListNotifications``. When the number of notifications 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 ``ListNotifications`` to list the next set of notifications.

    

  
  :type nextToken: string
  :param nextToken: 

    When the number of notifications 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 notifications, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListNotifications`` to list the next set of notifications.

    

  
  
  :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) --* 

        When the number of notifications 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 notifications, the response includes a pagination token named ``NextToken``. You can specify this ``NextToken`` value in a subsequent call to ``ListNotifications`` to list the next set of notifications.

        
  
  **Exceptions**
  
  *   :py:class:`DataZone.Client.exceptions.InternalServerException`

  
  *   :py:class:`DataZone.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`DataZone.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`DataZone.Client.exceptions.ThrottlingException`

  
  *   :py:class:`DataZone.Client.exceptions.ValidationException`

  
  *   :py:class:`DataZone.Client.exceptions.UnauthorizedException`

  