:doc:`S3Control <../../s3control>` / Client / list_storage_lens_configurations

********************************
list_storage_lens_configurations
********************************



.. py:method:: S3Control.Client.list_storage_lens_configurations(**kwargs)

  

  .. note::

    

    This operation is not supported by directory buckets.

    

   

  Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see `Assessing your storage activity and usage with Amazon S3 Storage Lens <https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html>`__ in the *Amazon S3 User Guide*.

   

  .. note::

    

    To use this action, you must have permission to perform the ``s3:ListStorageLensConfigurations`` action. For more information, see `Setting permissions to use Amazon S3 Storage Lens <https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html>`__ in the *Amazon S3 User Guide*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/ListStorageLensConfigurations>`_  


  **Request Syntax**
  ::

    response = client.list_storage_lens_configurations(
        AccountId='string',
        NextToken='string'
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The account ID of the requester.

    

  
  :type NextToken: string
  :param NextToken: 

    A pagination token to request the next page of results.

    

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

    
    ::

      {
          'NextToken': 'string',
          'StorageLensConfigurationList': [
              {
                  'Id': 'string',
                  'StorageLensArn': 'string',
                  'HomeRegion': 'string',
                  'IsEnabled': True|False
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If the request produced more than the maximum number of S3 Storage Lens configuration results, you can pass this value into a subsequent request to retrieve the next page of results.

        
      

      - **StorageLensConfigurationList** *(list) --* 

        A list of S3 Storage Lens configurations.

        
        

        - *(dict) --* 

          Part of ``ListStorageLensConfigurationResult``. Each entry includes the description of the S3 Storage Lens configuration, its home Region, whether it is enabled, its Amazon Resource Name (ARN), and config ID.

          
          

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

            A container for the S3 Storage Lens configuration ID.

            
          

          - **StorageLensArn** *(string) --* 

            The ARN of the S3 Storage Lens configuration. This property is read-only.

            
          

          - **HomeRegion** *(string) --* 

            A container for the S3 Storage Lens home Region. Your metrics data is stored and retained in your designated S3 Storage Lens home Region.

            
          

          - **IsEnabled** *(boolean) --* 

            A container for whether the S3 Storage Lens configuration is enabled. This property is required.

            
      
    
  