Bedrock / Client / list_foundation_models

list_foundation_models#

Bedrock.Client.list_foundation_models(**kwargs)#

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_foundation_models(
    byProvider='string',
    byCustomizationType='FINE_TUNING'|'CONTINUED_PRE_TRAINING',
    byOutputModality='TEXT'|'IMAGE'|'EMBEDDING',
    byInferenceType='ON_DEMAND'|'PROVISIONED'
)
Parameters:
  • byProvider (string) – A Amazon Bedrock model provider.

  • byCustomizationType (string) – List by customization type.

  • byOutputModality (string) – List by output modality type.

  • byInferenceType (string) – List by inference type.

Return type:

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',
            ],
            '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 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