:doc:`Connect <../../connect>` / Client / list_notifications

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



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

  

  Retrieves a paginated list of all notifications in the Amazon Connect instance.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListNotifications>`_  


  **Request Syntax**
  ::

    response = client.list_notifications(
        InstanceId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per page. Valid range is 1-100.

    

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

    
    ::

      {
          'NextToken': 'string',
          'NotificationSummaryList': [
              {
                  'Content': {
                      'string': 'string'
                  },
                  'Id': 'string',
                  'Arn': 'string',
                  'Priority': 'URGENT'|'HIGH'|'LOW',
                  'Recipients': [
                      'string',
                  ],
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'CreatedAt': datetime(2015, 1, 1),
                  'ExpiresAt': datetime(2015, 1, 1),
                  'LastModifiedRegion': 'string',
                  'Tags': {
                      'string': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The token for the next set of results. If present, there are more results available.

        
      

      - **NotificationSummaryList** *(list) --* 

        A list of notification summaries.

        
        

        - *(dict) --* 

          Contains information about a notification, including its content, priority, recipients, and metadata.

          
          

          - **Content** *(dict) --* 

            The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.

            
            

            - *(string) --* 

              The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.

              
              

              - *(string) --* 

                A localized string value. Maximum length is 500 characters.

                
        
      
          

          - **Id** *(string) --* 

            The unique identifier for the notification.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the notification.

            
          

          - **Priority** *(string) --* 

            The priority level of the notification. Valid values are URGENT, HIGH, and LOW.

            
          

          - **Recipients** *(list) --* 

            A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.

            
            

            - *(string) --* 
        
          

          - **LastModifiedTime** *(datetime) --* 

            The timestamp when the notification was last modified.

            
          

          - **CreatedAt** *(datetime) --* 

            The timestamp when the notification was created.

            
          

          - **ExpiresAt** *(datetime) --* 

            The timestamp when the notification expires and is no longer displayed to users.

            
          

          - **LastModifiedRegion** *(string) --* 

            The AWS Region where the notification was last modified.

            
          

          - **Tags** *(dict) --* 

            The tags used to organize, track, or control access for this resource. For example, ``{ "Tags": {"key1":"value1", "key2":"value2"} }``.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

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

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

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  