:doc:`WellArchitected <../../wellarchitected>` / Client / list_notifications

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



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

  

  List lens notifications.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotifications>`_  


  **Request Syntax**
  ::

    response = client.list_notifications(
        WorkloadId='string',
        NextToken='string',
        MaxResults=123,
        ResourceArn='string'
    )
    
  :type WorkloadId: string
  :param WorkloadId: 

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return for this request.

    

  
  :type ResourceArn: string
  :param ResourceArn: 

    The ARN for the related resource for the notification.

     

    .. note::

      

      Only one of ``WorkloadID`` or ``ResourceARN`` should be specified.

      

    

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

    
    ::

      {
          'NotificationSummaries': [
              {
                  'Type': 'LENS_VERSION_UPGRADED'|'LENS_VERSION_DEPRECATED',
                  'LensUpgradeSummary': {
                      'WorkloadId': 'string',
                      'WorkloadName': 'string',
                      'LensAlias': 'string',
                      'LensArn': 'string',
                      'CurrentLensVersion': 'string',
                      'LatestLensVersion': 'string',
                      'ResourceArn': 'string',
                      'ResourceName': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NotificationSummaries** *(list) --* 

        List of lens notification summaries in a workload.

        
        

        - *(dict) --* 

          A notification summary return object.

          
          

          - **Type** *(string) --* 

            The type of notification.

            
          

          - **LensUpgradeSummary** *(dict) --* 

            Summary of lens upgrade.

            
            

            - **WorkloadId** *(string) --* 

              The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

              
            

            - **WorkloadName** *(string) --* 

              The name of the workload.

               

              The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

              
            

            - **LensAlias** *(string) --* 

              The alias of the lens.

               

              For Amazon Web Services official lenses, this is either the lens alias, such as ``serverless``, or the lens ARN, such as ``arn:aws:wellarchitected:us-east-1::lens/serverless``. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

               

              For custom lenses, this is the lens ARN, such as ``arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef``.

               

              Each lens is identified by its  LensSummary$LensAlias.

              
            

            - **LensArn** *(string) --* 

              The ARN for the lens.

              
            

            - **CurrentLensVersion** *(string) --* 

              The current version of the lens.

              
            

            - **LatestLensVersion** *(string) --* 

              The latest version of the lens.

              
            

            - **ResourceArn** *(string) --* 

              ``ResourceArn`` of the lens being upgraded

              
            

            - **ResourceName** *(string) --* 

              The name of the workload.

               

              The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

              
        
      
    
      

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

        The token to use to retrieve the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`WellArchitected.Client.exceptions.ValidationException`

  
  *   :py:class:`WellArchitected.Client.exceptions.InternalServerException`

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

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

  