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

***********
list_lenses
***********



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

  

  List the available lenses.

  

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


  **Request Syntax**
  ::

    response = client.list_lenses(
        NextToken='string',
        MaxResults=123,
        LensType='AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF',
        LensStatus='ALL'|'DRAFT'|'PUBLISHED',
        LensName='string'
    )
    
  :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 LensType: string
  :param LensType: 

    The type of lenses to be returned.

    

  
  :type LensStatus: string
  :param LensStatus: 

    The status of lenses to be returned.

    

  
  :type LensName: string
  :param LensName: 

    The full name of the lens.

    

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

    
    ::

      {
          'LensSummaries': [
              {
                  'LensArn': 'string',
                  'LensAlias': 'string',
                  'LensName': 'string',
                  'LensType': 'AWS_OFFICIAL'|'CUSTOM_SHARED'|'CUSTOM_SELF',
                  'Description': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1),
                  'LensVersion': 'string',
                  'Owner': 'string',
                  'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Output of a list lenses call.

      
      

      - **LensSummaries** *(list) --* 

        List of lens summaries of available lenses.

        
        

        - *(dict) --* 

          A lens summary of a lens.

          
          

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

            The ARN of the lens.

            
          

          - **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.

            
          

          - **LensName** *(string) --* 

            The full name of the lens.

            
          

          - **LensType** *(string) --* 

            The type of the lens.

            
          

          - **Description** *(string) --* 

            The description of the lens.

            
          

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

            The date and time recorded.

            
          

          - **UpdatedAt** *(datetime) --* 

            The date and time recorded.

            
          

          - **LensVersion** *(string) --* 

            The version of the lens.

            
          

          - **Owner** *(string) --* 

            An Amazon Web Services account ID.

            
          

          - **LensStatus** *(string) --* 

            The status of the lens.

            
      
    
      

      - **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`

  