:doc:`LakeFormation <../../lakeformation>` / Client / list_table_storage_optimizers

*****************************
list_table_storage_optimizers
*****************************



.. py:method:: LakeFormation.Client.list_table_storage_optimizers(**kwargs)

  

  Returns the configuration of all storage optimizers associated with a specified table.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lakeformation-2017-03-31/ListTableStorageOptimizers>`_  


  **Request Syntax**
  ::

    response = client.list_table_storage_optimizers(
        CatalogId='string',
        DatabaseName='string',
        TableName='string',
        StorageOptimizerType='COMPACTION'|'GARBAGE_COLLECTION'|'ALL',
        MaxResults=123,
        NextToken='string'
    )
    
  :type CatalogId: string
  :param CatalogId: 

    The Catalog ID of the table.

    

  
  :type DatabaseName: string
  :param DatabaseName: **[REQUIRED]** 

    Name of the database where the table is present.

    

  
  :type TableName: string
  :param TableName: **[REQUIRED]** 

    Name of the table.

    

  
  :type StorageOptimizerType: string
  :param StorageOptimizerType: 

    The specific type of storage optimizers to list. The supported value is ``compaction``.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The number of storage optimizers to return on each call.

    

  
  :type NextToken: string
  :param NextToken: 

    A continuation token, if this is a continuation call.

    

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

    
    ::

      {
          'StorageOptimizerList': [
              {
                  'StorageOptimizerType': 'COMPACTION'|'GARBAGE_COLLECTION'|'ALL',
                  'Config': {
                      'string': 'string'
                  },
                  'ErrorMessage': 'string',
                  'Warnings': 'string',
                  'LastRunDetails': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **StorageOptimizerList** *(list) --* 

        A list of the storage optimizers associated with a table.

        
        

        - *(dict) --* 

          A structure describing the configuration and details of a storage optimizer.

          
          

          - **StorageOptimizerType** *(string) --* 

            The specific type of storage optimizer. The supported value is ``compaction``.

            
          

          - **Config** *(dict) --* 

            A map of the storage optimizer configuration. Currently contains only one key-value pair: ``is_enabled`` indicates true or false for acceleration.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
          

          - **ErrorMessage** *(string) --* 

            A message that contains information about any error (if present).

             

            When an acceleration result has an enabled status, the error message is empty.

             

            When an acceleration result has a disabled status, the message describes an error or simply indicates "disabled by the user".

            
          

          - **Warnings** *(string) --* 

            A message that contains information about any warnings (if present).

            
          

          - **LastRunDetails** *(string) --* 

            When an acceleration result has an enabled status, contains the details of the last job run.

            
      
    
      

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

        A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

        
  
  **Exceptions**
  
  *   :py:class:`LakeFormation.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`LakeFormation.Client.exceptions.InvalidInputException`

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

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

  