:doc:`NovaActService <../../nova-act>` / Client / list_models

***********
list_models
***********



.. py:method:: NovaActService.Client.list_models(**kwargs)

  

  Lists all available AI models that can be used for workflow execution, including their status and compatibility information.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/nova-act-2025-08-22/ListModels>`_  


  **Request Syntax**
  ::

    response = client.list_models(
        clientCompatibilityVersion=123
    )
    
  :type clientCompatibilityVersion: integer
  :param clientCompatibilityVersion: **[REQUIRED]** 

    The client compatibility version to filter models by compatibility.

    

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

    
    ::

      {
          'modelSummaries': [
              {
                  'modelId': 'string',
                  'modelLifecycle': {
                      'status': 'ACTIVE'|'LEGACY'|'DEPRECATED'|'PREVIEW'
                  },
                  'minimumCompatibilityVersion': 123
              },
          ],
          'modelAliases': [
              {
                  'aliasName': 'string',
                  'latestModelId': 'string',
                  'resolvedModelId': 'string'
              },
          ],
          'compatibilityInformation': {
              'clientCompatibilityVersion': 123,
              'supportedModelIds': [
                  'string',
              ],
              'message': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **modelSummaries** *(list) --* 

        A list of available AI models with their status and compatibility information.

        
        

        - *(dict) --* 

          Summary information about an available AI model.

          
          

          - **modelId** *(string) --* 

            The unique identifier of the model.

            
          

          - **modelLifecycle** *(dict) --* 

            The lifecycle information for the model.

            
            

            - **status** *(string) --* 

              The current lifecycle status of the model.

              
        
          

          - **minimumCompatibilityVersion** *(integer) --* 

            The minimum client compatibility version required to use this model.

            
      
    
      

      - **modelAliases** *(list) --* 

        A list of model aliases that provide stable references to model versions.

        
        

        - *(dict) --* 

          An alias that provides a stable reference to a model version.

          
          

          - **aliasName** *(string) --* 

            The name of the model alias.

            
          

          - **latestModelId** *(string) --* 

            The model ID that this alias currently points to.

            
          

          - **resolvedModelId** *(string) --* 

            The resolved model ID after alias resolution.

            
      
    
      

      - **compatibilityInformation** *(dict) --* 

        Information about client compatibility and supported models.

        
        

        - **clientCompatibilityVersion** *(integer) --* 

          The client compatibility version that was requested.

          
        

        - **supportedModelIds** *(list) --* 

          A list of model IDs that are supported for the client compatibility version.

          
          

          - *(string) --* 
      
        

        - **message** *(string) --* 

          Additional information about compatibility requirements or recommendations.

          
    
  
  **Exceptions**
  
  *   :py:class:`NovaActService.Client.exceptions.AccessDeniedException`

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

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

  