:doc:`Bedrock <../../bedrock>` / Client / list_foundation_models

**********************
list_foundation_models
**********************



.. py:method:: Bedrock.Client.list_foundation_models(**kwargs)

  

  Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see `Foundation models <https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html>`__ in the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModels>`_  


  **Request Syntax**
  ::

    response = client.list_foundation_models(
        byProvider='string',
        byCustomizationType='FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION',
        byOutputModality='TEXT'|'IMAGE'|'EMBEDDING',
        byInferenceType='ON_DEMAND'|'PROVISIONED'
    )
    
  :type byProvider: string
  :param byProvider: 

    Return models belonging to the model provider that you specify.

    

  
  :type byCustomizationType: string
  :param byCustomizationType: 

    Return models that support the customization type that you specify. For more information, see `Custom models <https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html>`__ in the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html>`__.

    

  
  :type byOutputModality: string
  :param byOutputModality: 

    Return models that support the output modality that you specify.

    

  
  :type byInferenceType: string
  :param byInferenceType: 

    Return models that support the inference type that you specify. For more information, see `Provisioned Throughput <https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html>`__ in the `Amazon Bedrock User Guide <https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html>`__.

    

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

    
    ::

      {
          'modelSummaries': [
              {
                  'modelArn': 'string',
                  'modelId': 'string',
                  'modelName': 'string',
                  'providerName': 'string',
                  'inputModalities': [
                      'TEXT'|'IMAGE'|'EMBEDDING',
                  ],
                  'outputModalities': [
                      'TEXT'|'IMAGE'|'EMBEDDING',
                  ],
                  'responseStreamingSupported': True|False,
                  'customizationsSupported': [
                      'FINE_TUNING'|'CONTINUED_PRE_TRAINING'|'DISTILLATION',
                  ],
                  'inferenceTypesSupported': [
                      'ON_DEMAND'|'PROVISIONED',
                  ],
                  'modelLifecycle': {
                      'status': 'ACTIVE'|'LEGACY'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        A list of Amazon Bedrock foundation models.

        
        

        - *(dict) --* 

          Summary information for a foundation model.

          
          

          - **modelArn** *(string) --* 

            The Amazon Resource Name (ARN) of the foundation model.

            
          

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

            The model ID of the foundation model.

            
          

          - **modelName** *(string) --* 

            The name of the model.

            
          

          - **providerName** *(string) --* 

            The model's provider name.

            
          

          - **inputModalities** *(list) --* 

            The input modalities that the model supports.

            
            

            - *(string) --* 
        
          

          - **outputModalities** *(list) --* 

            The output modalities that the model supports.

            
            

            - *(string) --* 
        
          

          - **responseStreamingSupported** *(boolean) --* 

            Indicates whether the model supports streaming.

            
          

          - **customizationsSupported** *(list) --* 

            Whether the model supports fine-tuning or continual pre-training.

            
            

            - *(string) --* 
        
          

          - **inferenceTypesSupported** *(list) --* 

            The inference types that the model supports.

            
            

            - *(string) --* 
        
          

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

            Contains details about whether a model version is available or deprecated.

            
            

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

              Specifies whether a model version is available ( ``ACTIVE``) or deprecated ( ``LEGACY``.

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

  
  *   :py:class:`Bedrock.Client.exceptions.ValidationException`

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

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

  